OSCORE security context derivation parameters (RFC 8613 Section 3.2). More...

#include <coap_oscore.h>

Data Fields
const uint8_t *	master_secret
	Master Secret (required, typically 16 bytes for AES-CCM-16-64-128).
size_t	master_secret_len
	Length of master_secret in bytes.
const uint8_t *	sender_id
	Sender ID (required).
size_t	sender_id_len
	Length of sender_id in bytes.
const uint8_t *	recipient_id
	Recipient ID (required).
size_t	recipient_id_len
	Length of recipient_id in bytes.
const uint8_t *	master_salt
	Master Salt (optional, set to NULL if unused).
size_t	master_salt_len
	Length of master_salt in bytes (0 if unused).
const uint8_t *	id_context
	ID Context (optional, set to NULL if unused).
size_t	id_context_len
	Length of id_context in bytes (0 if unused).
enum coap_oscore_aead_alg	aead_alg
	AEAD algorithm (use COAP_OSCORE_AEAD_AES_CCM_16_64_128 for the default).
enum coap_oscore_hkdf	hkdf
	KDF algorithm (use COAP_OSCORE_HKDF_SHA_256 for the default).
bool	fresh_master_secret_salt
	True if the combination of Master Secret and Master Salt is unique at every boot (e.g.

Detailed Description

OSCORE security context derivation parameters (RFC 8613 Section 3.2).

Note: The buffers referenced by master_secret, master_salt, id_context and sender_id must remain valid for the entire lifetime of the derived context (until coap_oscore_context_free()). recipient_id is copied internally.

Attention

Available only when the following Kconfig option is enabled:

CONFIG_COAP_OSCORE

.

Field Documentation

◆ aead_alg

enum coap_oscore_aead_alg coap_oscore_init_params::aead_alg

AEAD algorithm (use COAP_OSCORE_AEAD_AES_CCM_16_64_128 for the default).

◆ fresh_master_secret_salt

bool coap_oscore_init_params::fresh_master_secret_salt

True if the combination of Master Secret and Master Salt is unique at every boot (e.g.

derived with EDHOC). Reuse of the master secret and master salt is currently not supported. Setting this to false will result in an error.

◆ hkdf

enum coap_oscore_hkdf coap_oscore_init_params::hkdf

KDF algorithm (use COAP_OSCORE_HKDF_SHA_256 for the default).

◆ id_context

const uint8_t* coap_oscore_init_params::id_context

ID Context (optional, set to NULL if unused).

◆ id_context_len

size_t coap_oscore_init_params::id_context_len

Length of id_context in bytes (0 if unused).

◆ master_salt

const uint8_t* coap_oscore_init_params::master_salt

Master Salt (optional, set to NULL if unused).

◆ master_salt_len

size_t coap_oscore_init_params::master_salt_len

Length of master_salt in bytes (0 if unused).

◆ master_secret

const uint8_t* coap_oscore_init_params::master_secret

Master Secret (required, typically 16 bytes for AES-CCM-16-64-128).

◆ master_secret_len

size_t coap_oscore_init_params::master_secret_len

Length of master_secret in bytes.

◆ recipient_id

const uint8_t* coap_oscore_init_params::recipient_id

Recipient ID (required).

◆ recipient_id_len

size_t coap_oscore_init_params::recipient_id_len

Length of recipient_id in bytes.

◆ sender_id

const uint8_t* coap_oscore_init_params::sender_id

Sender ID (required).

◆ sender_id_len

size_t coap_oscore_init_params::sender_id_len

Length of sender_id in bytes.

The documentation for this struct was generated from the following file:

include/zephyr/net/coap_oscore.h

Data Fields