Add Oscore and Edhoc options #333

zalenskivolt · 2025-03-22T11:46:23Z

#	Option	RFC
9	OSCORE	[RFC8613 OSCORE (using COSE)]
21	EDHOC	[RFC9668 Ephemeral Diffie-Hellman Over COSE]

codecov · 2025-03-24T22:05:56Z

Codecov Report

Attention: Patch coverage is 55.55556% with 8 lines in your changes missing coverage. Please review.

Project coverage is 64.81%. Comparing base (3e15cd8) to head (292722d).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
koap-core/src/commonMain/kotlin/Message.kt	42.85%	6 Missing and 2 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #333      +/-   ##
==========================================
+ Coverage   63.95%   64.81%   +0.85%     
==========================================
  Files           9        9              
  Lines         774      790      +16     
  Branches      172      176       +4     
==========================================
+ Hits          495      512      +17     
+ Misses        220      218       -2     
- Partials       59       60       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

zalenski · 2025-03-24T22:10:24Z

when you have a chance, can you rebase/fix conflicts? TY!

@twyatt rebased & fixed

twyatt

Amazing job on this! 💯

I've added a unit test for "Test Vector 8", it'd be great to replicate the test for the remaining test vectors. Feel free to take that on, or I'll get to it next weekend.

twyatt · 2025-03-25T07:16:55Z

koap-core/src/commonMain/kotlin/Message.kt

@@ -384,6 +385,29 @@ sealed class Message {
            }
        }

+        /** RFC 8613 2. OSCORE */
+        data class Oscore(
+            val coseObject: ByteArray,


Reading through the spec, I can't decide if value or coseObject is more appropriate here.

What was your thinking for settling on coseObject naming?

What was your thinking for settling on coseObject naming?

Hm. I thought in section 2 it stated that the option "contains a compressed COSE object", and I just wanted a descriptive name if I could find one.

But I realize now I have probably misinterpreted this. The option just "indicates that the CoAP message is an OSCORE message", and that the message contains a COSE object.

2. The OSCORE Option

The OSCORE option defined in this section (see Figure 3, which
extends "Table 4: Options" of [RFC7252]) indicates that the CoAP
message is an OSCORE message and that it contains a compressed COSE
object (see Sections 5 and 6). The OSCORE option is critical, safe
to forward, part of the cache key, and not repeatable.

What is actually in the option value described in section 6.1:

6.1. Encoding of the OSCORE Option Value

The value of the OSCORE option SHALL contain the OSCORE flag bits,
the 'Partial IV' parameter, the 'kid context' parameter (length and
value), and the 'kid' parameter as follows:

So I think it should be renamed, maybe just to value.

For the block options I did some handling of the uint value to expand it to the block number, more flag, and block size. I guess a semantically aware OSCORE option implementation should also extract all those flags, 'Partial IV' parameter and 'kid context' parameter things. But maybe that could be left out for now, with just an opaque value?

I did a take on actually handling partialIv, kidContext and kid in
zalenskivolt#3
learning a lot about Kotlin nullables (since both kidContext and kid can have the flag set but be empty) :)

There's reserved values for partialIv length 6 and 7, and three flags reserved for future use, so there's some potential for future updates to the standard rendering the option unparseable, and such flags/values should be handled in specific ways as outlined in 8.2. Verifying the Request …

It could have a malformed flag in it, or maybe a nullable partialIv and use null there to indicate the option didn't parse? I guess these complex options are a bit trickier than the simple uint/string ones in basic CoAP.

For upgradability/backwards compatibility, kotlin just says "Avoid using data classes in your API"
https://kotlinlang.org/docs/api-guidelines-backward-compatibility.html#avoid-using-data-classes-in-your-api
and here's one suggestion for mitigation: No data:
https://jakewharton.com/public-api-challenges-in-kotlin/#mitigation-no-data

but I'll leave these considerations for the library maintainers 😉

zalenskivolt#3 looks great, but let's leave that for review after we get this PR in. So ya, I appreciate you keeping it as a separate PR for now. 👍

zalenskivolt#3 looks great, but let's leave that for review after we get this PR in. So ya, I appreciate you keeping it as a separate PR for now. 👍

-> #343

zalenski · 2025-03-25T20:26:32Z

Amazing job on this! 💯

I've added a unit test for "Test Vector 8", it'd be great to replicate the test for the remaining test vectors. Feel free to take that on, or I'll get to it next weekend.

Added test vectors 4-7. (test vector 1-3 is just key derivation, no OSCORE options)

twyatt

💯 🚀

I'll merge after we get another approval.

zalenski · 2025-03-25T20:45:55Z

Added test vectors 4-7.

…and found a bug in zalenskivolt#3 because of them! :)

zalenski · 2025-03-26T13:02:54Z

💯 🚀

I'll merge after we get another approval.

might be good to merge the block-wise ones first, if they are getting ready now. they all conflict a lot, in all the imports, and in tests if they are added in the same location… I think this one is easier to rebase! 😄

twyatt · 2025-03-26T19:47:01Z

might be good to merge the block-wise ones first

Good thinking. I'll wait to merge this PR until after #335 is merged. 👍

twyatt · 2025-03-27T20:23:07Z

@zalenskivolt please rebase/fix conflicts, when you have a chance. TY!

zalenski · 2025-03-27T22:11:22Z

@zalenskivolt please rebase/fix conflicts, when you have a chance. TY!

rebased & fixed

QuantumRand

Awesome to see expanded support for more of the CoAP spec! Thanks @zalenskivolt!

zalenskivolt requested review from twyatt and a team as code owners March 22, 2025 11:46

zalenskivolt requested a review from QuantumRand March 22, 2025 11:46

zalenskivolt force-pushed the oscore-and-edhoc-options branch from a55fe9f to 1704afd Compare March 22, 2025 11:51

zalenskivolt mentioned this pull request Mar 22, 2025

Add Unassigned, Reserved, and ExperimentalUse options holding opaque binary values #328

Open

This comment was marked as outdated.

Sign in to view

zalenskivolt force-pushed the oscore-and-edhoc-options branch 2 times, most recently from b07a855 to 98024ef Compare March 23, 2025 09:30

This comment was marked as outdated.

Sign in to view

zalenskivolt force-pushed the oscore-and-edhoc-options branch from 98024ef to 72d4d11 Compare March 24, 2025 21:16

twyatt added the minor Changes that should bump the MINOR version number label Mar 24, 2025

zalenskivolt force-pushed the oscore-and-edhoc-options branch 3 times, most recently from 15491f8 to 803ddbc Compare March 24, 2025 22:03

twyatt reviewed Mar 25, 2025

View reviewed changes

zalenskivolt force-pushed the oscore-and-edhoc-options branch from a92af01 to b2555ac Compare March 25, 2025 11:33

This comment was marked as outdated.

Sign in to view

zalenskivolt force-pushed the oscore-and-edhoc-options branch from b2555ac to 71903c3 Compare March 25, 2025 19:50

twyatt approved these changes Mar 25, 2025

View reviewed changes

zalenskivolt force-pushed the oscore-and-edhoc-options branch from 1d235d9 to f788b0e Compare March 25, 2025 20:48

Add missing ending parenthesis in some toString

87655e7

zalenskivolt force-pushed the oscore-and-edhoc-options branch from f788b0e to 707f681 Compare March 27, 2025 22:08

zalenskivolt and others added 5 commits March 27, 2025 23:16

Add Oscore and Edhoc options

2d23882

Add unit test for test vector 8

df342bd

Quote text from RFC

667ec4e

Rename incorrectly named coseObject to value

73905df

Add unit test for test vector 4-7

292722d

zalenskivolt force-pushed the oscore-and-edhoc-options branch from 707f681 to 292722d Compare March 27, 2025 22:16

QuantumRand approved these changes Mar 28, 2025

View reviewed changes

twyatt merged commit 60aabf2 into JuulLabs:main Mar 28, 2025
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Oscore and Edhoc options #333

Add Oscore and Edhoc options #333

zalenskivolt commented Mar 22, 2025 •

edited

Loading

This comment was marked as outdated.

This comment was marked as outdated.

codecov bot commented Mar 24, 2025 •

edited

Loading

zalenski commented Mar 24, 2025

twyatt left a comment

twyatt Mar 25, 2025

zalenski Mar 25, 2025

zalenski Mar 25, 2025

zalenski Mar 25, 2025

twyatt Mar 25, 2025

zalenski Mar 25, 2025

zalenskivolt Mar 31, 2025

This comment was marked as outdated.

zalenski commented Mar 25, 2025

twyatt left a comment •

edited

Loading

zalenski commented Mar 25, 2025

zalenski commented Mar 26, 2025

twyatt commented Mar 26, 2025

twyatt commented Mar 27, 2025

zalenski commented Mar 27, 2025

QuantumRand left a comment

Add Oscore and Edhoc options #333

Add Oscore and Edhoc options #333

Conversation

zalenskivolt commented Mar 22, 2025 • edited Loading

This comment was marked as outdated.

This comment was marked as outdated.

codecov bot commented Mar 24, 2025 • edited Loading

Codecov Report

zalenski commented Mar 24, 2025

twyatt left a comment

Choose a reason for hiding this comment

twyatt Mar 25, 2025

Choose a reason for hiding this comment

zalenski Mar 25, 2025

Choose a reason for hiding this comment

zalenski Mar 25, 2025

Choose a reason for hiding this comment

zalenski Mar 25, 2025

Choose a reason for hiding this comment

twyatt Mar 25, 2025

Choose a reason for hiding this comment

zalenski Mar 25, 2025

Choose a reason for hiding this comment

zalenskivolt Mar 31, 2025

Choose a reason for hiding this comment

This comment was marked as outdated.

zalenski commented Mar 25, 2025

twyatt left a comment • edited Loading

Choose a reason for hiding this comment

zalenski commented Mar 25, 2025

zalenski commented Mar 26, 2025

twyatt commented Mar 26, 2025

twyatt commented Mar 27, 2025

zalenski commented Mar 27, 2025

QuantumRand left a comment

Choose a reason for hiding this comment

zalenskivolt commented Mar 22, 2025 •

edited

Loading

codecov bot commented Mar 24, 2025 •

edited

Loading

twyatt left a comment •

edited

Loading