edhoc 1.4.0 → 2.0.0

package/external/libedhoc/include/edhoc_common.h

@@ -1,289 +0,0 @@
-/**
- * \file    edhoc_common.h
- * \author  Kamil Kielbasa
- * \brief   EDHOC common implementations:
- *          - CBOR utilities.
- *          - MAC context.
- *          - MAC & Signature_or_MAC.
- * \version 0.6
- * \date    2024-08-05
- * 
- * \copyright Copyright (c) 2024
- * 
- */
-
-/* Header guard ------------------------------------------------------------ */
-#ifndef EDHOC_COMMON_H
-#define EDHOC_COMMON_H
-
-/* Include files ----------------------------------------------------------- */
-
-/* EDHOC header: */
-#include "edhoc_context.h"
-#include "edhoc_ead.h"
-#include "edhoc_credentials.h"
-
-/* Standard library headers: */
-#include <stdint.h>
-#include <stddef.h>
-#include <stdbool.h>
-
-/* Defines ----------------------------------------------------------------- */
-/* Types and type definitions ---------------------------------------------- */
-
-/** \defgroup edhoc-common-structures EDHOC common structures
- * @{
- */
-
-/**
- * \brief RFC 9528:
- *        - 5.3.2. Responder Composition of Message 2.
- *          - context_2.
- *        - 5.4.2. Initiator Composition of Message 3.
- *          - context_3.
- */
-struct mac_context {
-	/** Buffer containing cborised connection identifier. */
-	uint8_t *conn_id;
-	/** Size of the \p conn_id buffer in bytes. */
-	size_t conn_id_len;
-
-	/** Buffer containing cborised credentials identifier. */
-	uint8_t *id_cred;
-	/** Size of the \p id_cred buffer in bytes. */
-	size_t id_cred_len;
-
-	/** Is compact encoding possible? */
-	bool id_cred_is_comp_enc;
-	/** Credentials identifer encoding type. */
-	enum edhoc_encode_type id_cred_enc_type;
-	/** Buffer containing credentials identifer integer representation. */
-	int32_t id_cred_int;
-	/** Buffer containing credentials identifer byte string representation. */
-	uint8_t id_cred_bstr[CONFIG_LIBEDHOC_MAX_LEN_OF_CRED_KEY_ID + 1];
-	/** Size of the \p id_cred_bstr buffer in bytes. */
-	size_t id_cred_bstr_len;
-
-	/** Buffer containing cborised transcript hash. */
-	uint8_t *th;
-	/** Size of the \p th buffer in bytes. */
-	size_t th_len;
-
-	/** Buffer containing cborised credentials. */
-	uint8_t *cred;
-	/** Size of the \p cred buffer in bytes. */
-	size_t cred_len;
-
-	/** Is EAD attached? */
-	bool is_ead;
-	/** Buffer containing cborised EAD. */
-	uint8_t *ead;
-	/** Size of the \p ead buffer in bytes. */
-	size_t ead_len;
-
-	/** Size of the \p buf buffer in bytes. */
-	size_t buf_len;
-	/** Flexible array member buffer. */
-	uint8_t buf[];
-};
-
-/**
- * \brief RFC 9528:
- *        - 5.3.2. Responder Composition of Message 2.
- *          - PLAINTEXT_2.
- *        - 5.4.2. Initiator Composition of Message 3.
- *          - PLAINTEXT_3.
- */
-struct plaintext {
-	/** Authentication credentials. */
-	struct edhoc_auth_creds auth_cred;
-
-	/** Buffer containing cborised Signature_or_MAC (2/3). */
-	const uint8_t *sign_or_mac;
-	/** Size of the \p sign_or_mac buffer in bytes. */
-	size_t sign_or_mac_len;
-
-	/** Buffer containing cborised EAD (2/3). */
-	const uint8_t *ead;
-	/** Size of the \p ead buffer in bytes. */
-	size_t ead_len;
-};
-
-/**@}*/
-
-/* Module interface variables and constants -------------------------------- */
-/* Extern variables and constant declarations ------------------------------ */
-/* Module interface function declarations ---------------------------------- */
-
-/** \defgroup edhoc-common-cbor EDHOC common CBOR
- * @{
- */
-
-/** 
- * \brief CBOR integer memory requirements.
- *
- * \param value                         Raw integer value.
- *
- * \return Number of bytes.
- */
-size_t edhoc_cbor_int_mem_req(int32_t value);
-
-/** 
- * \brief CBOR text stream overhead.
- *
- * \param length                        Length of buffer to CBOR as tstr.
- *
- * \return Number of overhead bytes.
- */
-size_t edhoc_cbor_tstr_oh(size_t length);
-
-/** 
- * \brief CBOR byte stream overhead.
- *
- * \param length                        Length of buffer to CBOR as bstr.
- *
- * \return Number of overhead bytes.
- */
-size_t edhoc_cbor_bstr_oh(size_t length);
-
-/** 
- * \brief CBOR map overhead.
- *
- * \param items                         Number of items for map.
- *
- * \return Number of overhead bytes.
- */
-size_t edhoc_cbor_map_oh(size_t items);
-
-/** 
- * \brief CBOR array overhead.
- *
- * \param items                         Number of items for array.
- *
- * \return Number of overhead bytes.
- */
-size_t edhoc_cbor_array_oh(size_t items);
-
-/**@}*/
-
-/** \defgroup edhoc-common-mac-context EDHOC common MAC context
- * @{
- */
-
-/**
- * \brief Compute required buffer length for MAC 2/3 context.
- * 
- * \param[in] edhoc_context             EDHOC context.
- * \param[in] credentials               Authentication credentials.
- * \param[out] mac_context_length       On success, number of bytes that make up MAC context.
- *
- * \return EDHOC_SUCCESS on success, otherwise failure.
- */
-int edhoc_comp_mac_context_length(const struct edhoc_context *edhoc_context,
-				  const struct edhoc_auth_creds *credentials,
-				  size_t *mac_context_length);
-
-/**
- * \brief Cborise items required by MAC 2/3 context.
- * 
- * \param[in] edhoc_context             EDHOC context.
- * \param[in] credentials               Authentication credentials.
- * \param[out] mac_context              On success, generated MAC context.
- *
- * \return EDHOC_SUCCESS on success, otherwise failure.
- */
-int edhoc_comp_mac_context(const struct edhoc_context *edhoc_context,
-			   const struct edhoc_auth_creds *credentials,
-			   struct mac_context *mac_context);
-
-/**@}*/
-
-/** \defgroup edhoc-common-sign-or-mac EDHOC common Signature_or_MAC
- * @{
- */
-
-/**
- * \brief Compute required buffer length for MAC 2/3.
- * 
- * \param[in] edhoc_context             EDHOC context.
- * \param[out] mac_length               On success, number of bytes that make up
- *                                      MAC 2/3 length requirements.
- *
- * \return EDHOC_SUCCESS on success, otherwise failure.
- */
-int edhoc_comp_mac_length(const struct edhoc_context *edhoc_context,
-			  size_t *mac_length);
-
-/**
- * \brief Compute MAC 2/3 buffer.
- * 
- * \param[in] edhoc_context             EDHOC context.                 
- * \param[in] mac_context               MAC context.
- * \param[out] mac                      Buffer where the generated MAC 2/3 is to be written.
- * \param mac_length                    Size of the \p mac buffer in bytes.
- *
- * \return EDHOC_SUCCESS on success, otherwise failure.
- */
-int edhoc_comp_mac(const struct edhoc_context *edhoc_context,
-		   const struct mac_context *mac_context, uint8_t *mac,
-		   size_t mac_length);
-
-/**
- * \brief Compute required buffer length for Signature_or_MAC 2/3.
- * 
- * \param[in] edhoc_context             EDHOC context.
- * \param[out] sign_or_mac_length       On success, number of bytes that make up
- *                                      Signature_or_MAC 2/3 length requirements.
- *
- * \return EDHOC_SUCCESS on success, otherwise failure.
- */
-int edhoc_comp_sign_or_mac_length(const struct edhoc_context *edhoc_context,
-				  size_t *sign_or_mac_length);
-
-/**
- * \brief Compute Signature_or_MAC 2/3 buffer.
- * 
- * \param[in] edhoc_context             EDHOC context.
- * \param[in] cred                      Authentication credentials.
- * \param[in] mac_context               MAC context.
- * \param[in] mac                       Buffer containing the MAC 2/3.
- * \param[in] mac_len                   Size of the \p mac buffer in bytes.
- * \param[out] signature                Buffer where the generated 
- *                                      Signature_or_MAC 2/3 is to be written.
- * \param signature_size                Size of the \p signature buffer in bytes.
- * \param[out] signature_length         On success, the number of bytes that make
- *                                      up the Signature_or_MAC 2/3.
- *
- * \return EDHOC_SUCCESS on success, otherwise failure.
- */
-int edhoc_comp_sign_or_mac(const struct edhoc_context *edhoc_context,
-			   const struct edhoc_auth_creds *cred,
-			   const struct mac_context *mac_context,
-			   const uint8_t *mac, size_t mac_len,
-			   uint8_t *signature, size_t signature_size,
-			   size_t *signature_length);
-
-/**
- * \brief Verify Signature_or_MAC 2/3 buffer.
- * 
- * \param[in] edhoc_context             EDHOC context.
- * \param[in] mac_context               MAC context.
- * \param[in] public_key                Buffer containing authentication public key.
- * \param public_key_length             Size of the \p public_key buffer in bytes.
- * \param[in] signature                 Buffer containing Signature_or_MAC 2/3.
- * \param signature_length              Size of the \p signature buffer in bytes.
- * \param[in] mac                       Buffer containing MAC 2/3.
- * \param mac_length                    Size of the \p mac buffer in bytes.
- *
- * \return EDHOC_SUCCESS on success, otherwise failure.
- */
-int edhoc_verify_sign_or_mac(const struct edhoc_context *edhoc_context,
-			     const struct mac_context *mac_context,
-			     const uint8_t *public_key,
-			     size_t public_key_length, const uint8_t *signature,
-			     size_t signature_length, const uint8_t *mac,
-			     size_t mac_length);
-
-/**@}*/
-
-#endif /* EDHOC_COMMON_H */

package/external/libedhoc/include/edhoc_context.h

@@ -1,343 +0,0 @@
-/**
- * \file    edhoc_context.h
- * \author  Kamil Kielbasa
- * \brief   EDHOC context.
- * \version 0.6
- * \date    2024-08-05
- * 
- * \copyright Copyright (c) 2024
- * 
- */
-
-/* Header guard ------------------------------------------------------------ */
-#ifndef EDHOC_CONTEXT_H
-#define EDHOC_CONTEXT_H
-
-/* Include files ----------------------------------------------------------- */
-
-/* Standard library headers: */
-#include <stdint.h>
-#include <stddef.h>
-#include <stdbool.h>
-
-/* EDHOC headers: */
-#include "edhoc_credentials.h"
-#include "edhoc_crypto.h"
-#include "edhoc_ead.h"
-#include "edhoc_macros.h"
-#include "edhoc_values.h"
-
-/* Defines ----------------------------------------------------------------- */
-
-#ifndef CONFIG_LIBEDHOC_ENABLE
-#error "Library has not been enabled."
-#endif
-
-#ifndef CONFIG_LIBEDHOC_KEY_ID_LEN
-#error "Lack of defined key identifier length in bytes."
-#endif
-
-#ifndef CONFIG_LIBEDHOC_MAX_NR_OF_CIPHER_SUITES
-#error "Lack of defined maximum number of cipher suites in chain for negotiation."
-#endif
-
-#ifndef CONFIG_LIBEDHOC_MAX_LEN_OF_CONN_ID
-#error "Lack of defined maximum length of connection identifier in bytes."
-#endif
-
-#ifndef CONFIG_LIBEDHOC_MAX_LEN_OF_ECC_KEY
-#error "Lack of defined maximum length of ECC (Elliptic Curve Cryptography) key in bytes."
-#endif
-
-#ifndef CONFIG_LIBEDHOC_MAX_LEN_OF_MAC
-#error "Lack of defined maximum length of hash in bytes."
-#endif
-
-#ifndef CONFIG_LIBEDHOC_MAX_NR_OF_EAD_TOKENS
-#error "Lack of defined maximum number of EAD (External Authorization Data) tokens."
-#endif
-
-#ifndef CONFIG_LIBEDHOC_MAX_NR_OF_CERTS_IN_X509_CHAIN
-#error "Lack of defined maximum number of certificates in X.509 chain."
-#endif
-
-/* Types and type definitions ---------------------------------------------- */
-
-/** \defgroup edhoc-context EDHOC context
- * @{
- */
-
-/**
- * \brief RFC 9528: 2. EDHOC Outline.
- */
-enum edhoc_role {
-	/** EDHOC role - initiator. */
-	EDHOC_INITIATOR,
-	/** EDHOC role - responder. */
-	EDHOC_RESPONDER,
-};
-
-/**
- * \brief RFC 9528: Appendix I. Example Protocol State Machine.
- */
-enum edhoc_state_machine {
-	/** State machine - start. */
-	EDHOC_SM_START,
-	/** State machine - aborted. */
-	EDHOC_SM_ABORTED,
-
-	/* Responder: */
-
-	/** State machine - received message 1. */
-	EDHOC_SM_RECEIVED_M1,
-	/** State machine - verified message 1. */
-	EDHOC_SM_VERIFIED_M1,
-
-	/* Initiator: */
-
-	/** State machine - waiting for message 2. */
-	EDHOC_SM_WAIT_M2,
-	/** State machine - received message 2. */
-	EDHOC_SM_RECEIVED_M2,
-	/** State machine - verified message 2. */
-	EDHOC_SM_VERIFIED_M2,
-
-	/* Responder: */
-
-	/** State machine - waiting for message 3. */
-	EDHOC_SM_WAIT_M3,
-	/** State machine - received message 3. */
-	EDHOC_SM_RECEIVED_M3,
-
-	/* Initiator: */
-
-	/** State machine - received message 4. */
-	EDHOC_SM_RECEVIED_M4,
-
-	/** State machine - completed. */
-	EDHOC_SM_COMPLETED,
-	/** State machine - persisted. */
-	EDHOC_SM_PERSISTED,
-};
-
-/**
- * \brief RFC 9528: 3.2. Method.
- */
-enum edhoc_method {
-	/** Initiator signature Key to responder signature Key. */
-	EDHOC_METHOD_0 = 0,
-	/** Initiator signature Key to responder static DH Key. */
-	EDHOC_METHOD_1 = 1,
-	/** Initiator static DH Key to responder signature Key. */
-	EDHOC_METHOD_2 = 2,
-	/** Initiator static DH Key to responder static DH Key. */
-	EDHOC_METHOD_3 = 3,
-	/** Sanity check maximum. */
-	EDHOC_METHOD_MAX,
-};
-
-/**
- * \brief EDHOC transcript hashes states.
- */
-enum edhoc_th_state {
-	/** Transcript hash invalid. */
-	EDHOC_TH_STATE_INVALID,
-	/** Transcript hash 1. */
-	EDHOC_TH_STATE_1,
-	/** Transcript hash 2. */
-	EDHOC_TH_STATE_2,
-	/** Transcript hash 3. */
-	EDHOC_TH_STATE_3,
-	/** Transcript hash 4. */
-	EDHOC_TH_STATE_4,
-};
-
-/**
- * \brief EDHOC psuedorandom keys states.
- */
-enum edhoc_prk_state {
-	/** Psuedorandom key invalid. */
-	EDHOC_PRK_STATE_INVALID,
-	/** Psuedorandom key RFC 9528: 4.1.1.1. PRK_2e. */
-	EDHOC_PRK_STATE_2E,
-	/** Psuedorandom key RFC 9528: 4.1.1.2. PRK_3e2m. */
-	EDHOC_PRK_STATE_3E2M,
-	/** Psuedorandom key RFC 9528: 4.1.1.3. PRK_4e3m. */
-	EDHOC_PRK_STATE_4E3M,
-	/** Psuedorandom key RFC 9528: 4.1.3. PRK_out. */
-	EDHOC_PRK_STATE_OUT,
-	/** Psuedorandom key RFC 9528: 4.2.1. EDHOC_Exporter. */
-	EDHOC_PRK_STATE_EXPORTER,
-};
-
-/**
- * \brief EDHOC logger callback.
- */
-typedef void (*edhoc_logger_t)(void *user_context, const char *name,
-			       const uint8_t *buffer, size_t buffer_length);
-
-/**
- * \brief EDHOC connection identifier encoding type.
- */
-enum edhoc_connection_id_type {
-	/** Encode connection identifier as CBOR integer. */
-	EDHOC_CID_TYPE_ONE_BYTE_INTEGER,
-	/** Encode connection identifier as CBOR byte string. */
-	EDHOC_CID_TYPE_BYTE_STRING,
-};
-
-/**
- * \brief RFC 9528: 3.3.2. Representation of Byte String Identifiers.
- */
-struct edhoc_connection_id {
-	/** Encoding type of connection identifier. 
-         *
-         * It must follow representation of byte string identifiers described in RFC 9528: 3.3.2. */
-	enum edhoc_connection_id_type encode_type;
-
-	/** Connection identifier as cbor integer. */
-	int8_t int_value;
-
-	/** Connection identifier as cbor byte string buffer. */
-	uint8_t bstr_value[CONFIG_LIBEDHOC_MAX_LEN_OF_CONN_ID + 1];
-	/** Size of the \p bstr_value buffer in bytes. */
-	size_t bstr_length;
-};
-
-/**
- * \brief EDHOC error code. RFC 9528: 6. Error Handling.
- */
-enum edhoc_error_code {
-	/** RFC 9528: 6.1. Success. */
-	EDHOC_ERROR_CODE_SUCCESS = 0,
-	/** RFC 9528: 6.2. Unspecified Error. */
-	EDHOC_ERROR_CODE_UNSPECIFIED_ERROR = 1,
-	/** RFC 9528: 6.3. Wrong Selected Cipher Suite. */
-	EDHOC_ERROR_CODE_WRONG_SELECTED_CIPHER_SUITE = 2,
-	/** RFC 9528: 6.4. Unknown Credential Referenced. */
-	EDHOC_ERROR_CODE_UNKNOWN_CREDENTIAL_REFERENCED = 3,
-};
-
-/**
- * \brief EDHOC error information. RFC 9528: 6. Error Handling.
- */
-struct edhoc_error_info {
-	union {
-		/** Pointer used only for error code: \ref EDHOC_ERROR_CODE_UNSPECIFIED_ERROR. */
-		char *text_string;
-		/** Pointer used only for error code: \ref EDHOC_ERROR_CODE_WRONG_SELECTED_CIPHER_SUITE. */
-		int32_t *cipher_suites;
-	};
-
-	/** Total number of entries from: \p text_string or \p cipher_suites. */
-	size_t total_entries;
-	/** Number of written entries to: \p text_string or \p cipher_suites. */
-	size_t written_entries;
-};
-
-/**
- * \brief EDHOC context.
- */
-struct edhoc_context {
-	/** EDHOC chosen method. */
-	enum edhoc_method EDHOC_PRIVATE(chosen_method);
-
-	/** EDHOC supported methods. */
-	enum edhoc_method EDHOC_PRIVATE(method[EDHOC_METHOD_MAX]);
-	/** Length of the \p method buffer. */
-	size_t EDHOC_PRIVATE(method_len);
-
-	/** EDHOC cipher suite chosen index. */
-	size_t EDHOC_PRIVATE(chosen_csuite_idx);
-	/** EDHOC cipher suite buffer. */
-	struct edhoc_cipher_suite
-		EDHOC_PRIVATE(csuite)[CONFIG_LIBEDHOC_MAX_NR_OF_CIPHER_SUITES];
-	/** Length of the \p csuite buffer. */
-	size_t EDHOC_PRIVATE(csuite_len);
-	/** EDHOC peer cipher suite buffer. */
-	struct edhoc_cipher_suite EDHOC_PRIVATE(
-		peer_csuite)[CONFIG_LIBEDHOC_MAX_NR_OF_CIPHER_SUITES];
-	/** Length of the \p peer_csuite buffer. */
-	size_t EDHOC_PRIVATE(peer_csuite_len);
-
-	/** EDHOC connection identifier. */
-	struct edhoc_connection_id EDHOC_PRIVATE(cid);
-	/** EDHOC peer connection identifier. */
-	struct edhoc_connection_id EDHOC_PRIVATE(peer_cid);
-
-	/** EDHOC ephemeral Diffie-Hellman public key. */
-	uint8_t EDHOC_PRIVATE(dh_pub_key)[CONFIG_LIBEDHOC_MAX_LEN_OF_ECC_KEY];
-	/** Size of the \p dh_pub_key buffer in bytes. */
-	size_t EDHOC_PRIVATE(dh_pub_key_len);
-	/** EDHOC ephemeral Diffie-Hellman private key. */
-	uint8_t EDHOC_PRIVATE(dh_priv_key)[CONFIG_LIBEDHOC_MAX_LEN_OF_ECC_KEY];
-	/** Size of the \p dh_priv_key buffer in bytes. */
-	size_t EDHOC_PRIVATE(dh_priv_key_len);
-
-	/** EDHOC ephemeral Diffie-Hellman peer public key. */
-	uint8_t EDHOC_PRIVATE(
-		dh_peer_pub_key)[CONFIG_LIBEDHOC_MAX_LEN_OF_ECC_KEY];
-	/** Size of the \p dh_peer_pub_key buffer in bytes. */
-	size_t EDHOC_PRIVATE(dh_peer_pub_key_len);
-	/** EDHOC ephemeral Diffie-Hellman key agreement. */
-	uint8_t EDHOC_PRIVATE(dh_secret)[CONFIG_LIBEDHOC_MAX_LEN_OF_ECC_KEY];
-	/** Size of the \p dh_secret buffer in bytes. */
-	size_t EDHOC_PRIVATE(dh_secret_len);
-
-	/** Is context initialized? */
-	bool EDHOC_PRIVATE(is_init);
-	/** Is OSCORE security session export allowed? */
-	bool EDHOC_PRIVATE(is_oscore_export_allowed);
-	/** EDHOC context state machine. */
-	enum edhoc_state_machine EDHOC_PRIVATE(status);
-	/** Current processing EDHOC message. */
-	enum edhoc_message EDHOC_PRIVATE(message);
-	/** EDHOC role. */
-	enum edhoc_role EDHOC_PRIVATE(role);
-
-	/** EDHOC context transcript hash state. */
-	enum edhoc_th_state EDHOC_PRIVATE(th_state);
-	/** EDHOC context transcript hash buffer. */
-	uint8_t EDHOC_PRIVATE(th)[CONFIG_LIBEDHOC_MAX_LEN_OF_MAC];
-	/** Size of the \p th buffer in bytes. */
-	size_t EDHOC_PRIVATE(th_len);
-
-	/** EDHOC context pseudorandom key state. */
-	enum edhoc_prk_state EDHOC_PRIVATE(prk_state);
-	/** EDHOC context pseudorandom key buffer. */
-	uint8_t EDHOC_PRIVATE(prk)[CONFIG_LIBEDHOC_MAX_LEN_OF_MAC];
-	/** Size of the \p prk buffer in bytes. */
-	size_t EDHOC_PRIVATE(prk_len);
-
-	/** EDHOC interface for external authorization data. */
-	struct edhoc_ead EDHOC_PRIVATE(ead);
-	/** EDHOC interface for crypographics key operations. */
-	struct edhoc_keys EDHOC_PRIVATE(keys);
-	/** EDHOC interface for crypographics function operations. */
-	struct edhoc_crypto EDHOC_PRIVATE(crypto);
-	/** EDHOC interface for authentication credentials. */
-	struct edhoc_credentials EDHOC_PRIVATE(cred);
-
-	/** EDHOC EAD tokens buffer. */
-	struct edhoc_ead_token EDHOC_PRIVATE(
-		ead_token)[CONFIG_LIBEDHOC_MAX_NR_OF_EAD_TOKENS + 1];
-	/** Length of the \p ead_token buffer. */
-	size_t EDHOC_PRIVATE(nr_of_ead_tokens);
-
-	/** User context. */
-	void *EDHOC_PRIVATE(user_ctx);
-
-	/** EDHOC error code. */
-	enum edhoc_error_code EDHOC_PRIVATE(error_code);
-
-	/** User logger callback. */
-	edhoc_logger_t logger;
-};
-
-/* Module interface variables and constants -------------------------------- */
-/* Extern variables and constant declarations ------------------------------ */
-/* Module interface function declarations ---------------------------------- */
-
-/**@}*/
-
-#endif /* EDHOC_CONTEXT_H */