Package-level declarations
Types
An authentication credential, CRED_I or CRED_R (RFC 9528 §3.5.2): the exact CBOR item EDHOC hashes and MACs, together with the authentication public key it carries.
How one party proves possession of its authentication key (RFC 9528 §3.2, §3.5.1).
An EDHOC cipher suite, RFC 9528 §3.6 and §10.2 (IANA "EDHOC Cipher Suites").
An EDHOC connection identifier, C_I or C_R (RFC 9528 §3.3). Connection identifiers are byte strings; on the wire, a one-byte string that equals the one-byte CBOR encoding of an integer in -24..23 is sent as that integer, any other string as a CBOR byte string (RFC 9528 §3.3.2). With OSCORE the bytes become a Recipient ID unchanged (RFC 9528 §3.3.3).
Chooses the connection identifier an endpoint asks its peer to use (RFC 9528 §3.3.1). The Initiator calls it once per message_1 with peer = null; the Responder calls it with C_I and must not return C_I, because with OSCORE both would become the same Recipient ID (RFC 9528 §3.3.3).
ID_CRED_I or ID_CRED_R (RFC 9528 §3.5.3): a COSE header map that identifies a credential by reference or carries it by value.
Turns a received ID_CRED_x into the peer's authentication credential (RFC 9528 §5.3.3 step 5, §5.4.3 step 5). This is where the application decides whom it trusts: return only credentials it is willing to authenticate (RFC 9528 Appendix D).
Produces and consumes External Authorization Data for a security application (RFC 9528 §3.8, Appendix E). Both methods have defaults, so a handler overrides only what it uses.
An EDHOC error message, RFC 9528 §6: the CBOR sequence ( ERR_CODE : int, ERR_INFO : any ).
An EDHOC session failed. error is what RFC 9528 §6 says to tell the peer, and errorMessage is that error message encoded, ready to send, or null when nothing may be sent. Like the exceptions of kcoap's other protocols, it is a KcoapException.
The EDHOC Initiator (RFC 9528 §5), as a sans-IO state machine: it takes and returns message bytes and leaves transport, correlation and deduplication (RFC 9528 §3.4, §7) to the caller.
The application profile (RFC 9528 §3.9) of an EdhocInitiator.
The four EDHOC messages that carry EAD fields (RFC 9528 §3.8).
The EDHOC authentication methods, RFC 9528 §3.2 Table 2. The name reads Initiator, then Responder.
The peer sent an EDHOC error message instead of the expected message. No error is sent back (errorMessage is null): error messages are never answered (RFC 9528 §6, §6.1).
Where an EDHOC state machine stands, with the state names of RFC 9528 Appendix I.
The EDHOC Responder (RFC 9528 §5), as a sans-IO state machine for one session.
The application profile (RFC 9528 §3.9) of an EdhocResponder.
The output of a completed EDHOC session (RFC 9528 §4.1.3, §4.2): PRK_out, the EDHOC_Exporter for application keys, EDHOC_KeyUpdate, and what was negotiated and authenticated.
Where ephemeral key pairs come from: fresh ones for every session by default (RFC 9528 §9.2 requires that), or fixed ones to replay the RFC 9529 traces. Called for X (Initiator, Diffie-Hellman and KEM suites) and Y (Responder, Diffie-Hellman suites; a KEM Responder encapsulates instead).
The EDHOC key exchange algorithm of a cipher suite (RFC 9528 §3.6).
This endpoint's own authentication material: CRED_x, how the peer is told about it (ID_CRED_x), and the handle of the private authentication key, which never leaves its dev.kcoap.crypto.CryptoBackend.
What EdhocInitiator.createMessage3 returns: message_3 to send (RFC 9528 §5.4.2) and the session it completes, so no caller has to read a nullable EdhocInitiator.session.
A CredentialResolver over a fixed set of trusted credentials: