Add OSCORE Support #47
Conversation
…ons to add oscore conf to context for servers and to add new recipients
…on-volatile storage
…ence_number() using Option and pattern-matching
…dd_oscore_conf() is deprecated
…of OscoreConf & OscoreRecipient
…o it's raw struct)
…formation has been added to the context
…ep track of its pointer
pulsastrix
added
enhancement
Workflow Status ReportGenerated for commit 82a4039 on Mon May 26 15:14:46 UTC 2025.
In case of failure, clippy warnings and rustfmt changes (if any) will be indicated as CI check warnings in the file comparison view. Documentation: Download Coverage Report: Download Note: Online versions of documentation and coverage reports may not be available indefinitely, especially after the pull request was merged. Code Coverage ReportCoverage target is 80%. Expand to view coverage statistics
Total coverage: 53.23% |
There was a problem hiding this comment.
Hi, thanks for the contribution!
You can find my initial comments below.
Regarding the examples: Would it be possible to add an abridged version of the examples (without the EDHOC part) to the examples subdirectory or to the module-level rustdoc in oscore.rs?
That way, we can use those as (no_run) tests.
Lastly, it would also be nice if we had a runnable test case that runs both a server and a client and performs a basic request, akin to the test cases already present for UDP and DTLS.
libcoap/src/context.rs
Outdated
| // SAFETY: Properly initialized CoapContext always has a valid raw_context that is not deleted until | ||
| // the CoapContextInner is dropped. OscoreConf raw_conf should be valid, else return an error. | ||
| // | ||
| // coap_context_oscore_server will also always free the raw_conf, regardless of the result: | ||
| // [libcoap docs](https://libcoap.net/doc/reference/4.3.5/group__oscore.html#ga71ddf56bcd6d6650f8235ee252fde47f) | ||
| unsafe { | ||
| result = coap_context_oscore_server(inner_ref.raw_context, oscore_conf.as_mut_raw_conf()?); | ||
| }; | ||
|
|
||
| // Invalidate the OscoreConf raw_conf as its freed by the call above. | ||
| oscore_conf.raw_conf_valid = false; | ||
|
|
||
| // Check whether adding the config to the context failed. | ||
| if result == 0 { | ||
| return Err(OscoreServerCreationError::Unknown); | ||
| } | ||
|
|
||
| // Add the initial_recipient (if present). | ||
| if let Some(initial_recipient) = oscore_conf.initial_recipient.clone() { | ||
| let initial_recipient = OscoreRecipient::new(initial_recipient.as_str()); |
There was a problem hiding this comment.
Wouldn't this be easier to represent by having a function OscoreConf::into_raw_conf(self) -> (*mut coap_oscore_conf_t, Option<OscoreRecipient>) that consumes the config?
That way, you can avoid managing a separate field to check that the pointer is still usable (the pointer being valid would be guaranteed/an invariant for the lifetime of the OscoreConf instance.
There was a problem hiding this comment.
I still needed to revert to the a separate field because else OscoreConf instances that were never consumed can't be freed of easily as we cannot determine whether the raw_conf might have been freed before.
libcoap/src/context.rs
Outdated
| } | ||
|
|
||
| // ...or else save the recipient to keep alive the pointer to its raw struct. | ||
| inner_ref.recipients.push(recipient); |
There was a problem hiding this comment.
Raw pointers are not freed if the struct containing them is dropped, so you might not even have to keep the OscoreRecipient stored at all.
In fact, you might also get away with not having an OscoreRecipient struct at all and just taking a recipient_id: &str as arguments for this method and delete_oscore_recipient() instead.
Co-authored-by: Hugo Hakim Damer <[email protected]>
Co-authored-by: Hugo Hakim Damer <[email protected]>
This pull request aims to provide support for OSCORE in libcoap-rs.
It adds a new feature flag "oscore" which has to be activated to enable all functions regarding OSCORE under which we provide the following:
We introduced two new structs OscoreConf and OscoreRecipient which are currently located within oscore.rs.
We also added new errors to allow for error-handling by the user in errors.rs.
There is also a minimal client and server example available, deriving from the official documentation.
Security was a priority and all unsafe calls have been annotated with an appropriate security notice, as is the standard for this project.