lws-cose.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	lws_cose_key
struct	lws_cose_validate_res_t
struct	lws_cose_sig_ext_pay_t
struct	lws_cose_validate_create_info
struct	lws_cose_sign_create_info

Macros
#define	LCSC_FL_ADD_CBOR_TAG   (1 << 0)
#define	LCSC_FL_ADD_CBOR_PREFER_MAC0   (1 << 1)

Typedefs
typedef int64_t	cose_param_t
typedef struct lws_cose_key	lws_cose_key_t
typedef int(*	lws_cose_key_import_callback) (struct lws_cose_key *s, void *user)
typedef int(*	lws_cose_sign_ext_pay_cb_t) (lws_cose_sig_ext_pay_t *x)
typedef int(*	lws_cose_validate_pay_cb_t) (struct lws_cose_validate_context *cps, void *opaque, const uint8_t *paychunk, size_t paychunk_len)
typedef struct lws_cose_validate_create_info	lws_cose_validate_create_info_t
typedef struct lws_cose_sign_create_info	lws_cose_sign_create_info_t

Enumerations
enum	{   LWSCOSE_WKL_ALG = 1 , LWSCOSE_WKL_CRIT , LWSCOSE_WKL_CONTENT_TYPE , LWSCOSE_WKL_KID ,   LWSCOSE_WKL_IV , LWSCOSE_WKL_IV_PARTIAL , LWSCOSE_WKL_COUNTERSIG , LWSCOSE_WKL_COUNTERSIG0 = 9 ,   LWSCOSE_WKL_KID_CONTEXT , LWSCOSE_WKL_CUPH_NONCE = 256 , LWSCOSE_WKL_CUPH_OWNER_PUBKEY = 257 , LWSCOSE_WKK_KTY = 1 ,   LWSCOSE_WKK_KID , LWSCOSE_WKK_ALG , LWSCOSE_WKK_KEY_OPS , LWSCOSE_WKK_BASE_IV ,   LWSCOSE_WKKO_SIGN = 1 , LWSCOSE_WKKO_VERIFY , LWSCOSE_WKKO_ENCRYPT , LWSCOSE_WKKO_DECRYPT ,   LWSCOSE_WKKO_WRAP_KEY , LWSCOSE_WKKO_UNWRAP_KEY , LWSCOSE_WKKO_DERIVE_KEY , LWSCOSE_WKKO_DERIVE_BITS ,   LWSCOSE_WKKO_MAC_CREATE , LWSCOSE_WKKO_MAC_VERIFY , LWSCOSE_WKAECDSA_ALG_ES256 = -7 , LWSCOSE_WKAECDSA_ALG_ES384 = -35 ,   LWSCOSE_WKAECDSA_ALG_ES512 = -36 , LWSCOSE_WKAEDDSA_ALG_EDDSA = -8 , LWSCOSE_WKAHMAC_256_64 = 4 , LWSCOSE_WKAHMAC_256_256 ,   LWSCOSE_WKAHMAC_384_384 , LWSCOSE_WKAHMAC_512_512 , LWSCOSE_WKAAES_128_64 = 14 , LWSCOSE_WKAAES_256_64 ,   LWSCOSE_WKAAES_128_128 = 25 , LWSCOSE_WKAAES_256_128 , LWSCOSE_WKAAESGCM_128 = 1 , LWSCOSE_WKAAESGCM_192 ,   LWSCOSE_WKAAESGCM_256 , LWSCOSE_WKAAESCCM_16_64_128 = 10 , LWSCOSE_WKAAESCCM_16_64_256 , LWSCOSE_WKAAESCCM_64_64_128 ,   LWSCOSE_WKAAESCCM_64_64_256 , LWSCOSE_WKAAESCCM_16_128_128 , LWSCOSE_WKAAESCCM_16_128_256 , LWSCOSE_WKAAESCCM_64_128_128 ,   LWSCOSE_WKAAESCCM_64_128_256 , LWSCOSE_WKACHACHA_POLY1305 = 24 , LWSCOSE_WKAPHKDF_SALT = -20 , LWSCOSE_WKAPCTX_PARTY_U_IDENTITY = -21 ,   LWSCOSE_WKAPCTX_PARTY_U_NONCE = -22 , LWSCOSE_WKAPCTX_PARTY_U_OTHER = -23 , LWSCOSE_WKAPCTX_PARTY_V_IDENTITY = -24 , LWSCOSE_WKAPCTX_PARTY_V_NONCE = -25 ,   LWSCOSE_WKAPCTX_PARTY_V_OTHER = -26 , LWSCOSE_WKK_DIRECT_CEK = -6 , LWSCOSE_WKK_DIRECT_HKDF_SHA_256 = -10 , LWSCOSE_WKK_DIRECT_HKDF_SHA_512 = -11 ,   LWSCOSE_WKK_DIRECT_HKDF_AES_128 = -12 , LWSCOSE_WKK_DIRECT_HKDF_AES_256 = -13 , LWSCOSE_WKK_DIRECT_HKDFKW_SHA_256 = -3 , LWSCOSE_WKK_DIRECT_HKDFKW_SHA_512 = -4 ,   LWSCOSE_WKK_DIRECT_HKDFKW_AES_128 = -5 , LWSCOSE_WKAECDH_ALG_ES_HKDF_256 = -25 , LWSCOSE_WKAECDH_ALG_ES_HKDF_512 = -26 , LWSCOSE_WKAECDH_ALG_SS_HKDF_256 = -27 ,   LWSCOSE_WKAECDH_ALG_SS_HKDF_512 = -28 , LWSCOSE_WKAPECDH_EPHEMERAL_KEY = -1 , LWSCOSE_WKAPECDH_STATIC_KEY = -2 , LWSCOSE_WKAPECDH_STATIC_KEY_ID = -3 ,   LWSCOSE_WKAPECDH_ES_A128KW = -29 , LWSCOSE_WKAPECDH_ES_A192KW = -30 , LWSCOSE_WKAPECDH_ES_A256KW = -31 , LWSCOSE_WKAPECDH_SS_A128KW = -32 ,   LWSCOSE_WKAPECDH_SS_A192KW = -33 , LWSCOSE_WKAPECDH_SS_A256KW = -34 , LWSCOSE_WKKTV_OKP = 1 , LWSCOSE_WKKTV_EC2 = 2 ,   LWSCOSE_WKKTV_RSA = 3 , LWSCOSE_WKKTV_SYMMETRIC = 4 , LWSCOSE_WKKTV_HSS_LMS = 5 , LWSCOSE_WKKTV_WALNUTDSA = 6 ,   LWSCOSE_WKEC_P256 = 1 , LWSCOSE_WKEC_P384 , LWSCOSE_WKEC_P521 , LWSCOSE_WKEC_X25519 ,   LWSCOSE_WKEC_X448 , LWSCOSE_WKEC_ED25519 , LWSCOSE_WKEC_ED448 , LWSCOSE_WKEC_SECP256K1 ,   LWSCOSE_WKECKP_CRV = -1 , LWSCOSE_WKECKP_X = -2 , LWSCOSE_WKECKP_Y = -3 , LWSCOSE_WKECKP_D = -4 ,   LWSCOSE_WKOKP_CRV = -1 , LWSCOSE_WKOKP_X = -2 , LWSCOSE_WKOKP_D = -4 , LWSCOSE_WKKPRSA_N = -1 ,   LWSCOSE_WKKPRSA_E = -2 , LWSCOSE_WKKPRSA_D = -3 , LWSCOSE_WKKPRSA_P = -4 , LWSCOSE_WKKPRSA_Q = -5 ,   LWSCOSE_WKKPRSA_DP = -6 , LWSCOSE_WKKPRSA_DQ = -7 , LWSCOSE_WKKPRSA_QINV = -8 , LWSCOSE_WKKPRSA_OTHER = -9 ,   LWSCOSE_WKKPRSA_RI = -10 , LWSCOSE_WKKPRSA_DI = -11 , LWSCOSE_WKKPRSA_TI = -12 , LWSCOSE_WKSYMKP_KEY_VALUE = 4 ,   LWSCOAP_CONTENTFORMAT_COSE_SIGN = 98 , LWSCOAP_CONTENTFORMAT_COSE_SIGN1 = 18 , LWSCOAP_CONTENTFORMAT_COSE_ENCRYPT = 96 , LWSCOAP_CONTENTFORMAT_COSE_ENCRYPT0 = 16 ,   LWSCOAP_CONTENTFORMAT_COSE_MAC = 97 , LWSCOAP_CONTENTFORMAT_COSE_MAC0 = 17 , LWSCOAP_CONTENTFORMAT_COSE_KEY = 101 , LWSCOAP_CONTENTFORMAT_COSE_KEY_SET = 102 ,   LWSCOSE_WKL_COUNTERSIGNATURE0 = 9 , LWSCOSE_WKARSA_ALG_RS256 = -257 , LWSCOSE_WKARSA_ALG_RS384 = -258 , LWSCOSE_WKARSA_ALG_RS512 = -259 }
enum	enum_cose_key_meta_tok {   COSEKEY_META_KTY , COSEKEY_META_KID , COSEKEY_META_KEY_OPS , COSEKEY_META_BASE_IV ,   COSEKEY_META_ALG , LWS_COUNT_COSE_KEY_ELEMENTS }
enum	lws_cose_sig_types {   SIGTYPE_UNKNOWN , SIGTYPE_MULTI , SIGTYPE_SINGLE , SIGTYPE_COUNTERSIGNED ,   SIGTYPE_MAC , SIGTYPE_MAC0 }
enum	{ LCOSESIGEXTCB_RET_FINISHED , LCOSESIGEXTCB_RET_AGAIN , LCOSESIGEXTCB_RET_ERROR = -1 }

Functions
LWS_VISIBLE LWS_EXTERN const char *	lws_cose_alg_to_name (cose_param_t alg)
LWS_VISIBLE LWS_EXTERN cose_param_t	lws_cose_name_to_alg (const char *name)
LWS_VISIBLE LWS_EXTERN lws_cose_key_t *	lws_cose_key_import (lws_dll2_owner_t *pkey_set, lws_cose_key_import_callback cb, void *user, const uint8_t *in, size_t len)
LWS_VISIBLE LWS_EXTERN enum lws_lec_pctx_ret	lws_cose_key_export (lws_cose_key_t *ck, lws_lec_pctx_t *ctx, int flags)
LWS_VISIBLE LWS_EXTERN lws_cose_key_t *	lws_cose_key_generate (struct lws_context *context, cose_param_t cose_kty, int use_mask, int bits, const char *curve, const uint8_t *kid, size_t kl)
LWS_VISIBLE LWS_EXTERN lws_cose_key_t *	lws_cose_key_from_set (lws_dll2_owner_t *set, const uint8_t *kid, size_t kl)
LWS_VISIBLE LWS_EXTERN void	lws_cose_key_destroy (lws_cose_key_t **ck)
LWS_VISIBLE LWS_EXTERN void	lws_cose_key_set_destroy (lws_dll2_owner_t *o)
LWS_VISIBLE LWS_EXTERN void	lws_cose_key_dump (const lws_cose_key_t *ck)
LWS_VISIBLE LWS_EXTERN struct lws_cose_validate_context *	lws_cose_validate_create (const lws_cose_validate_create_info_t *info)
LWS_VISIBLE LWS_EXTERN int	lws_cose_validate_chunk (struct lws_cose_validate_context *cps, const uint8_t *in, size_t in_len, size_t *used_in)
LWS_VISIBLE LWS_EXTERN lws_dll2_owner_t *	lws_cose_validate_results (struct lws_cose_validate_context *cps)
LWS_VISIBLE LWS_EXTERN void	lws_cose_validate_destroy (struct lws_cose_validate_context **cps)
LWS_VISIBLE LWS_EXTERN struct lws_cose_sign_context *	lws_cose_sign_create (const lws_cose_sign_create_info_t *info)
LWS_VISIBLE LWS_EXTERN int	lws_cose_sign_add (struct lws_cose_sign_context *csc, cose_param_t alg, const lws_cose_key_t *ck)
LWS_VISIBLE LWS_EXTERN enum lws_lec_pctx_ret	lws_cose_sign_payload_chunk (struct lws_cose_sign_context *csc, const uint8_t *in, size_t in_len)
LWS_VISIBLE LWS_EXTERN void	lws_cose_sign_destroy (struct lws_cose_sign_context **csc)

---

Data Structure Documentation

lws_cose_key

struct lws_cose_key

Definition at line 271 of file lws-cose.h.

Collaboration diagram for lws_cose_key:

Data Fields
struct lws_gencrypto_keyelem	e[LWS_GENCRYPTO_MAX_KEYEL_COUNT]
struct lws_gencrypto_keyelem	meta[LWS_COUNT_COSE_KEY_ELEMENTS]
lws_dll2_t	list
int	gencrypto_kty	one of LWS_GENCRYPTO_KTY_
cose_param_t	kty
cose_param_t	cose_alg
cose_param_t	cose_curve
char	private_key

lws_cose_validate_res_t

struct lws_cose_validate_res_t

Definition at line 366 of file lws-cose.h.

Collaboration diagram for lws_cose_validate_res_t:

Data Fields
lws_dll2_t	list
const lws_cose_key_t *	cose_key
cose_param_t	cose_alg
int	result

lws_cose_sig_ext_pay_t

struct lws_cose_sig_ext_pay_t

Definition at line 382 of file lws-cose.h.

Collaboration diagram for lws_cose_sig_ext_pay_t:

Data Fields
struct lws_cose_validate_context *	cps
const uint8_t *	ext
size_t	xl

lws_cose_validate_create_info

struct lws_cose_validate_create_info

Definition at line 393 of file lws-cose.h.

Collaboration diagram for lws_cose_validate_create_info:

Data Fields
struct lws_context *	cx	REQUIRED: the lws context
lws_dll2_owner_t *	keyset	REQUIRED: one or more cose_keys
enum lws_cose_sig_types	sigtype	0 if a CBOR tag is in the sig, else one of SIGTYPE_MULTI, SIGTYPE_SINGLE, etc
lws_cose_validate_pay_cb_t	pay_cb	optional: called back with unvalidated payload pieces
void *	pay_opaque	optional: passed into pay_cb callback along with payload chunk
lws_cose_sign_ext_pay_cb_t	ext_cb	optional extra application data provision callback
void *	ext_opaque	optional extra application data provision callback opaque
size_t	ext_len	if we have extra app data, this must be set to the length of it

lws_cose_sign_create_info

struct lws_cose_sign_create_info

Definition at line 456 of file lws-cose.h.

Collaboration diagram for lws_cose_sign_create_info:

Data Fields
struct lws_context *	cx	REQUIRED: the lws context
lws_dll2_owner_t *	keyset	REQUIRED: one or more cose_keys
lws_lec_pctx_t *	lec	REQUIRED: the cbor output context to emit to, user must initialize with lws_lec_init() beforehand
lws_cose_sign_ext_pay_cb_t	ext_cb	optional extra application data provision callback
void *	ext_opaque	optional extra application data provision callback opaque
size_t	ext_len	if we have extra app data, this must be set to the length of it
size_t	inline_payload_len	REQUIRED: size of the inline payload we will provide
int	flags	bitmap of LCSC_FL_*
enum lws_cose_sig_types	sigtype	0, or sign type hint

Macro Definition Documentation

LCSC_FL_ADD_CBOR_TAG

#define LCSC_FL_ADD_CBOR_TAG   (1 << 0)

Definition at line 453 of file lws-cose.h.

LCSC_FL_ADD_CBOR_PREFER_MAC0

#define LCSC_FL_ADD_CBOR_PREFER_MAC0   (1 << 1)

Definition at line 454 of file lws-cose.h.

Typedef Documentation

cose_param_t

typedef int64_t cose_param_t

Definition at line 259 of file lws-cose.h.

lws_cose_key_t

typedef struct lws_cose_key lws_cose_key_t

lws_cose_key_import_callback

typedef int(* lws_cose_key_import_callback) (struct lws_cose_key *s, void *user)

Definition at line 284 of file lws-cose.h.

lws_cose_sign_ext_pay_cb_t

typedef int(* lws_cose_sign_ext_pay_cb_t) (lws_cose_sig_ext_pay_t *x)

Definition at line 388 of file lws-cose.h.

lws_cose_validate_pay_cb_t

typedef int(* lws_cose_validate_pay_cb_t) (struct lws_cose_validate_context *cps, void *opaque, const uint8_t *paychunk, size_t paychunk_len)

Definition at line 389 of file lws-cose.h.

lws_cose_validate_create_info_t

typedef struct lws_cose_validate_create_info lws_cose_validate_create_info_t

lws_cose_sign_create_info_t

typedef struct lws_cose_sign_create_info lws_cose_sign_create_info_t

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
LWSCOSE_WKL_ALG
LWSCOSE_WKL_CRIT
LWSCOSE_WKL_CONTENT_TYPE
LWSCOSE_WKL_KID
LWSCOSE_WKL_IV
LWSCOSE_WKL_IV_PARTIAL
LWSCOSE_WKL_COUNTERSIG
LWSCOSE_WKL_COUNTERSIG0
LWSCOSE_WKL_KID_CONTEXT
LWSCOSE_WKL_CUPH_NONCE
LWSCOSE_WKL_CUPH_OWNER_PUBKEY
LWSCOSE_WKK_KTY
LWSCOSE_WKK_KID
LWSCOSE_WKK_ALG
LWSCOSE_WKK_KEY_OPS
LWSCOSE_WKK_BASE_IV
LWSCOSE_WKKO_SIGN
LWSCOSE_WKKO_VERIFY
LWSCOSE_WKKO_ENCRYPT
LWSCOSE_WKKO_DECRYPT
LWSCOSE_WKKO_WRAP_KEY
LWSCOSE_WKKO_UNWRAP_KEY
LWSCOSE_WKKO_DERIVE_KEY
LWSCOSE_WKKO_DERIVE_BITS
LWSCOSE_WKKO_MAC_CREATE
LWSCOSE_WKKO_MAC_VERIFY
LWSCOSE_WKAECDSA_ALG_ES256
LWSCOSE_WKAECDSA_ALG_ES384
LWSCOSE_WKAECDSA_ALG_ES512
LWSCOSE_WKAEDDSA_ALG_EDDSA
LWSCOSE_WKAHMAC_256_64
LWSCOSE_WKAHMAC_256_256
LWSCOSE_WKAHMAC_384_384
LWSCOSE_WKAHMAC_512_512
LWSCOSE_WKAAES_128_64
LWSCOSE_WKAAES_256_64
LWSCOSE_WKAAES_128_128
LWSCOSE_WKAAES_256_128
LWSCOSE_WKAAESGCM_128
LWSCOSE_WKAAESGCM_192
LWSCOSE_WKAAESGCM_256
LWSCOSE_WKAAESCCM_16_64_128
LWSCOSE_WKAAESCCM_16_64_256
LWSCOSE_WKAAESCCM_64_64_128
LWSCOSE_WKAAESCCM_64_64_256
LWSCOSE_WKAAESCCM_16_128_128
LWSCOSE_WKAAESCCM_16_128_256
LWSCOSE_WKAAESCCM_64_128_128
LWSCOSE_WKAAESCCM_64_128_256
LWSCOSE_WKACHACHA_POLY1305
LWSCOSE_WKAPHKDF_SALT
LWSCOSE_WKAPCTX_PARTY_U_IDENTITY
LWSCOSE_WKAPCTX_PARTY_U_NONCE
LWSCOSE_WKAPCTX_PARTY_U_OTHER
LWSCOSE_WKAPCTX_PARTY_V_IDENTITY
LWSCOSE_WKAPCTX_PARTY_V_NONCE
LWSCOSE_WKAPCTX_PARTY_V_OTHER
LWSCOSE_WKK_DIRECT_CEK
LWSCOSE_WKK_DIRECT_HKDF_SHA_256
LWSCOSE_WKK_DIRECT_HKDF_SHA_512
LWSCOSE_WKK_DIRECT_HKDF_AES_128
LWSCOSE_WKK_DIRECT_HKDF_AES_256
LWSCOSE_WKK_DIRECT_HKDFKW_SHA_256
LWSCOSE_WKK_DIRECT_HKDFKW_SHA_512
LWSCOSE_WKK_DIRECT_HKDFKW_AES_128
LWSCOSE_WKAECDH_ALG_ES_HKDF_256
LWSCOSE_WKAECDH_ALG_ES_HKDF_512
LWSCOSE_WKAECDH_ALG_SS_HKDF_256
LWSCOSE_WKAECDH_ALG_SS_HKDF_512
LWSCOSE_WKAPECDH_EPHEMERAL_KEY
LWSCOSE_WKAPECDH_STATIC_KEY
LWSCOSE_WKAPECDH_STATIC_KEY_ID
LWSCOSE_WKAPECDH_ES_A128KW
LWSCOSE_WKAPECDH_ES_A192KW
LWSCOSE_WKAPECDH_ES_A256KW
LWSCOSE_WKAPECDH_SS_A128KW
LWSCOSE_WKAPECDH_SS_A192KW
LWSCOSE_WKAPECDH_SS_A256KW
LWSCOSE_WKKTV_OKP
LWSCOSE_WKKTV_EC2
LWSCOSE_WKKTV_RSA
LWSCOSE_WKKTV_SYMMETRIC
LWSCOSE_WKKTV_HSS_LMS
LWSCOSE_WKKTV_WALNUTDSA
LWSCOSE_WKEC_P256
LWSCOSE_WKEC_P384
LWSCOSE_WKEC_P521
LWSCOSE_WKEC_X25519
LWSCOSE_WKEC_X448
LWSCOSE_WKEC_ED25519
LWSCOSE_WKEC_ED448
LWSCOSE_WKEC_SECP256K1
LWSCOSE_WKECKP_CRV
LWSCOSE_WKECKP_X
LWSCOSE_WKECKP_Y
LWSCOSE_WKECKP_D
LWSCOSE_WKOKP_CRV
LWSCOSE_WKOKP_X
LWSCOSE_WKOKP_D
LWSCOSE_WKKPRSA_N
LWSCOSE_WKKPRSA_E
LWSCOSE_WKKPRSA_D
LWSCOSE_WKKPRSA_P
LWSCOSE_WKKPRSA_Q
LWSCOSE_WKKPRSA_DP
LWSCOSE_WKKPRSA_DQ
LWSCOSE_WKKPRSA_QINV
LWSCOSE_WKKPRSA_OTHER
LWSCOSE_WKKPRSA_RI
LWSCOSE_WKKPRSA_DI
LWSCOSE_WKKPRSA_TI
LWSCOSE_WKSYMKP_KEY_VALUE
LWSCOAP_CONTENTFORMAT_COSE_SIGN
LWSCOAP_CONTENTFORMAT_COSE_SIGN1
LWSCOAP_CONTENTFORMAT_COSE_ENCRYPT
LWSCOAP_CONTENTFORMAT_COSE_ENCRYPT0
LWSCOAP_CONTENTFORMAT_COSE_MAC
LWSCOAP_CONTENTFORMAT_COSE_MAC0
LWSCOAP_CONTENTFORMAT_COSE_KEY
LWSCOAP_CONTENTFORMAT_COSE_KEY_SET
LWSCOSE_WKL_COUNTERSIGNATURE0
LWSCOSE_WKARSA_ALG_RS256
LWSCOSE_WKARSA_ALG_RS384
LWSCOSE_WKARSA_ALG_RS512

Definition at line 33 of file lws-cose.h.

     {
        /*  RFC8152: Table 2: Common Header Parameters
         * https://www.iana.org/assignments/cose/cose.xhtml#header-parameters
         */
 
        LWSCOSE_WKL_ALG                          = 1,   /* int / tstr */
        LWSCOSE_WKL_CRIT,                              /* [+ label ] */
        LWSCOSE_WKL_CONTENT_TYPE,                      /* tstr / uint */
        LWSCOSE_WKL_KID,                        /* bstr */
        LWSCOSE_WKL_IV,                                  /* bstr */
        LWSCOSE_WKL_IV_PARTIAL,                          /* bstr */
        LWSCOSE_WKL_COUNTERSIG,                          /* COSE sig(s) */
        LWSCOSE_WKL_COUNTERSIG0                  = 9,   /* bstr */
        LWSCOSE_WKL_KID_CONTEXT,                /* bstr */
        LWSCOSE_WKL_CUPH_NONCE                    = 256, /* bstr */
        LWSCOSE_WKL_CUPH_OWNER_PUBKEY              = 257, /* array */
 
        /*  RFC8152: Table 3: key map labels */
 
        LWSCOSE_WKK_KTY                          = 1, /* int / tstr */
        LWSCOSE_WKK_KID,                      /* bstr */
        LWSCOSE_WKK_ALG,                      /* int / tstr */
        LWSCOSE_WKK_KEY_OPS,                      /* [ + (int / tstr) ] */
        LWSCOSE_WKK_BASE_IV,                      /* bstr */
 
        /*  RFC8152: Table 4: Key Operation Values */
 
        LWSCOSE_WKKO_SIGN                      = 1,
        LWSCOSE_WKKO_VERIFY,
        LWSCOSE_WKKO_ENCRYPT,
        LWSCOSE_WKKO_DECRYPT,
        LWSCOSE_WKKO_WRAP_KEY,
        LWSCOSE_WKKO_UNWRAP_KEY,
        LWSCOSE_WKKO_DERIVE_KEY,
        LWSCOSE_WKKO_DERIVE_BITS,
        LWSCOSE_WKKO_MAC_CREATE,
        LWSCOSE_WKKO_MAC_VERIFY,
 
        /*  RFC8152: Table 5: ECDSA algs */
 
        LWSCOSE_WKAECDSA_ALG_ES256            = -7,
        LWSCOSE_WKAECDSA_ALG_ES384            = -35,
        LWSCOSE_WKAECDSA_ALG_ES512            = -36,
 
        /*  RFC8152: Table 6: EDDSA algs */
 
        LWSCOSE_WKAEDDSA_ALG_EDDSA            = -8,
 
        /*  RFC8152: Table 7: HMAC algs */
 
        LWSCOSE_WKAHMAC_256_64                    = 4,
        LWSCOSE_WKAHMAC_256_256,
        LWSCOSE_WKAHMAC_384_384,
        LWSCOSE_WKAHMAC_512_512,
 
        /*  RFC8152: Table 8: AES algs */
 
        LWSCOSE_WKAAES_128_64                      = 14,
        LWSCOSE_WKAAES_256_64,
        LWSCOSE_WKAAES_128_128                    = 25,
        LWSCOSE_WKAAES_256_128,
 
        /*  RFC8152: Table 9: AES GCM algs */
 
        LWSCOSE_WKAAESGCM_128                      = 1,
        LWSCOSE_WKAAESGCM_192,
        LWSCOSE_WKAAESGCM_256,
 
        /*  RFC8152: Table 10: AES CCM algs */
 
        LWSCOSE_WKAAESCCM_16_64_128          = 10,
        LWSCOSE_WKAAESCCM_16_64_256,
        LWSCOSE_WKAAESCCM_64_64_128,
        LWSCOSE_WKAAESCCM_64_64_256,
        LWSCOSE_WKAAESCCM_16_128_128,
        LWSCOSE_WKAAESCCM_16_128_256,
        LWSCOSE_WKAAESCCM_64_128_128,
        LWSCOSE_WKAAESCCM_64_128_256,
 
        /*  RFC8152: Table 11: CHACHA20 / Poly1305 */
 
        LWSCOSE_WKACHACHA_POLY1305            = 24,
 
        /*  RFC8152: Table 13: HKDF param */
 
        LWSCOSE_WKAPHKDF_SALT                      = -20,
 
        /* RFC8152: Table 14: Context Algorithm Parameters */
 
        LWSCOSE_WKAPCTX_PARTY_U_IDENTITY        = -21,
        LWSCOSE_WKAPCTX_PARTY_U_NONCE              = -22,
        LWSCOSE_WKAPCTX_PARTY_U_OTHER              = -23,
        LWSCOSE_WKAPCTX_PARTY_V_IDENTITY        = -24,
        LWSCOSE_WKAPCTX_PARTY_V_NONCE              = -25,
        LWSCOSE_WKAPCTX_PARTY_V_OTHER              = -26,
 
        /* RFC8152: Table 15: Direct key */
 
        LWSCOSE_WKK_DIRECT_CEK                    = -6,
 
        /* RFC8152: Table 16: Direct key with KDF */
 
        LWSCOSE_WKK_DIRECT_HKDF_SHA_256          = -10,
        LWSCOSE_WKK_DIRECT_HKDF_SHA_512          = -11,
        LWSCOSE_WKK_DIRECT_HKDF_AES_128          = -12,
        LWSCOSE_WKK_DIRECT_HKDF_AES_256          = -13,
 
        /* RFC8152: Table 17: AES Key Wrap Algorithm Values */
 
        LWSCOSE_WKK_DIRECT_HKDFKW_SHA_256      = -3,
        LWSCOSE_WKK_DIRECT_HKDFKW_SHA_512      = -4,
        LWSCOSE_WKK_DIRECT_HKDFKW_AES_128      = -5,
 
        /* RFC8152: Table 18: ECDH Algorithm Values */
 
        LWSCOSE_WKAECDH_ALG_ES_HKDF_256          = -25,
        LWSCOSE_WKAECDH_ALG_ES_HKDF_512          = -26,
        LWSCOSE_WKAECDH_ALG_SS_HKDF_256          = -27,
        LWSCOSE_WKAECDH_ALG_SS_HKDF_512          = -28,
 
        /* RFC8152: Table 19: ECDH Algorithm Parameters */
 
        LWSCOSE_WKAPECDH_EPHEMERAL_KEY            = -1,
        LWSCOSE_WKAPECDH_STATIC_KEY          = -2,
        LWSCOSE_WKAPECDH_STATIC_KEY_ID            = -3,
 
        /* RFC8152: Table 20: ECDH Algorithm Parameters with key wrap */
 
        LWSCOSE_WKAPECDH_ES_A128KW            = -29,
        LWSCOSE_WKAPECDH_ES_A192KW            = -30,
        LWSCOSE_WKAPECDH_ES_A256KW            = -31,
        LWSCOSE_WKAPECDH_SS_A128KW            = -32,
        LWSCOSE_WKAPECDH_SS_A192KW            = -33,
        LWSCOSE_WKAPECDH_SS_A256KW            = -34,
 
        /* RFC8152: Table 21: Key Type Values
         *  https://www.iana.org/assignments/cose/cose.xhtml#key-type
         */
 
        LWSCOSE_WKKTV_OKP                      = 1,
        LWSCOSE_WKKTV_EC2                      = 2,
        LWSCOSE_WKKTV_RSA                      = 3,
        LWSCOSE_WKKTV_SYMMETRIC                  = 4,
        LWSCOSE_WKKTV_HSS_LMS                      = 5,
        LWSCOSE_WKKTV_WALNUTDSA                  = 6,
 
 
        /* RFC8152: Table 22: Elliptic Curves
         * https://www.iana.org/assignments/cose/cose.xhtml#elliptic-curves
         */
 
        LWSCOSE_WKEC_P256                      = 1,
        LWSCOSE_WKEC_P384,
        LWSCOSE_WKEC_P521,
        LWSCOSE_WKEC_X25519,
        LWSCOSE_WKEC_X448,
        LWSCOSE_WKEC_ED25519,
        LWSCOSE_WKEC_ED448,
        LWSCOSE_WKEC_SECP256K1,
 
        /* RFC8152: Table 23: EC Key Parameters */
 
        LWSCOSE_WKECKP_CRV                    = -1,
        LWSCOSE_WKECKP_X                        = -2,
        LWSCOSE_WKECKP_Y                        = -3,
        LWSCOSE_WKECKP_D                        = -4,
 
        /* RFC8152: Table 24: Octet Key Pair (OKP) Parameters */
 
        LWSCOSE_WKOKP_CRV                      = -1,
        LWSCOSE_WKOKP_X                          = -2,
        LWSCOSE_WKOKP_D                          = -4,
 
        /* Additional from
         * https://www.iana.org/assignments/cose/cose.xhtml#key-type-parameters
         */
 
        LWSCOSE_WKKPRSA_N                      = -1,
        LWSCOSE_WKKPRSA_E                      = -2,
        LWSCOSE_WKKPRSA_D                      = -3,
        LWSCOSE_WKKPRSA_P                      = -4,
        LWSCOSE_WKKPRSA_Q                      = -5,
        LWSCOSE_WKKPRSA_DP                    = -6,
        LWSCOSE_WKKPRSA_DQ                    = -7,
        LWSCOSE_WKKPRSA_QINV                        = -8,
        LWSCOSE_WKKPRSA_OTHER                      = -9,
        LWSCOSE_WKKPRSA_RI                    = -10,
        LWSCOSE_WKKPRSA_DI                    = -11,
        LWSCOSE_WKKPRSA_TI                    = -12,
 
        /* RFC8152: Table 25: Symmetric Key Parameters */
 
        LWSCOSE_WKSYMKP_KEY_VALUE              = 4,
 
        /* RFC8152: Table 26: CoAP Content-Formats for COSE */
 
        LWSCOAP_CONTENTFORMAT_COSE_SIGN          = 98,
        LWSCOAP_CONTENTFORMAT_COSE_SIGN1        = 18,
        LWSCOAP_CONTENTFORMAT_COSE_ENCRYPT    = 96,
        LWSCOAP_CONTENTFORMAT_COSE_ENCRYPT0  = 16,
        LWSCOAP_CONTENTFORMAT_COSE_MAC            = 97,
        LWSCOAP_CONTENTFORMAT_COSE_MAC0          = 17,
        LWSCOAP_CONTENTFORMAT_COSE_KEY            = 101,
        LWSCOAP_CONTENTFORMAT_COSE_KEY_SET    = 102,
 
        /* RFC8152: Table 27: Header Parameter for CounterSignature0 */
 
        LWSCOSE_WKL_COUNTERSIGNATURE0              = 9, /* bstr */
 
        /* RFC8812: Table 1: RSASSA-PKCS1-v1_5 Algorithm Values */
 
        LWSCOSE_WKARSA_ALG_RS256                = -257, /* + SHA-256 */
        LWSCOSE_WKARSA_ALG_RS384                = -258, /* + SHA-384 */
        LWSCOSE_WKARSA_ALG_RS512                = -259, /* + SHA-512 */
};

enum_cose_key_meta_tok

enum enum_cose_key_meta_tok

Enumerator
COSEKEY_META_KTY
COSEKEY_META_KID
COSEKEY_META_KEY_OPS
COSEKEY_META_BASE_IV
COSEKEY_META_ALG
LWS_COUNT_COSE_KEY_ELEMENTS

Definition at line 249 of file lws-cose.h.

                            {
        COSEKEY_META_KTY,
        COSEKEY_META_KID,
        COSEKEY_META_KEY_OPS,
        COSEKEY_META_BASE_IV,
        COSEKEY_META_ALG,
 
        LWS_COUNT_COSE_KEY_ELEMENTS
};

lws_cose_sig_types

enum lws_cose_sig_types

Enumerator
SIGTYPE_UNKNOWN
SIGTYPE_MULTI
SIGTYPE_SINGLE
SIGTYPE_COUNTERSIGNED
SIGTYPE_MAC
SIGTYPE_MAC0

Definition at line 355 of file lws-cose.h.

                        {
        SIGTYPE_UNKNOWN,
        SIGTYPE_MULTI,
        SIGTYPE_SINGLE,
        SIGTYPE_COUNTERSIGNED, /* not yet supported */
        SIGTYPE_MAC, /* only supported for validation */
        SIGTYPE_MAC0,
};

anonymous enum

anonymous enum

Enumerator
LCOSESIGEXTCB_RET_FINISHED
LCOSESIGEXTCB_RET_AGAIN
LCOSESIGEXTCB_RET_ERROR

Definition at line 376 of file lws-cose.h.

     {
        LCOSESIGEXTCB_RET_FINISHED,
        LCOSESIGEXTCB_RET_AGAIN,
        LCOSESIGEXTCB_RET_ERROR          = -1
};

Function Documentation

lws_cose_alg_to_name()

LWS_VISIBLE LWS_EXTERN const char * lws_cose_alg_to_name

(

cose_param_t

alg

)

References LWS_EXTERN, and LWS_VISIBLE.

lws_cose_name_to_alg()

LWS_VISIBLE LWS_EXTERN cose_param_t lws_cose_name_to_alg

(

const char *

name

)

lws_cose_key_import()

LWS_VISIBLE LWS_EXTERN lws_cose_key_t * lws_cose_key_import	(	lws_dll2_owner_t *	pkey_set,
		lws_cose_key_import_callback	cb,
		void *	user,
		const uint8_t *	in,
		size_t	len )

lws_cose_jwk_import() - Create an lws_cose_key_t object from cose_key CBOR

Parameters

pkey_set	NULL, or a pointer to an lws_dll2_owner_t for a cose_key set
cb	callback for each jwk-processed key, or NULL if importing a single key with no parent "keys" JSON
user	pointer to be passed to the callback, otherwise ignored by lws. NULL if importing a single key with no parent "keys" JSON
in	a single cose_key
len	the length of the cose_key in bytes

Creates a single lws_cose_key_t if pkey_set is NULL or if the incoming CBOR doesn't start with an array, otherwise expects a CBOR array containing zero or more cose_key CBOR, and adds each to the pkey_set lws_dll2_owner_t struct. Created lws_cose_key_t are filled with data from the COSE representation and can be used with other COSE crypto ops.

References LWS_EXTERN, and LWS_VISIBLE.

lws_cose_key_export()

LWS_VISIBLE LWS_EXTERN enum lws_lec_pctx_ret lws_cose_key_export	(	lws_cose_key_t *	ck,
		lws_lec_pctx_t *	ctx,
		int	flags )

lws_cose_key_export() - Create cose_key CBOR from an lws_cose_key_t

Parameters

ck	the lws_cose_key_t to export to CBOR
ctx	the CBOR writing context (same as for lws_lec_printf())
flags	0 to export only public elements, or LWSJWKF_EXPORT_PRIVATE

Creates an lws_jwk struct filled with data from the COSE representation.

References LWS_EXTERN, and LWS_VISIBLE.

lws_cose_key_generate()

LWS_VISIBLE LWS_EXTERN lws_cose_key_t * lws_cose_key_generate	(	struct lws_context *	context,
		cose_param_t	cose_kty,
		int	use_mask,
		int	bits,
		const char *	curve,
		const uint8_t *	kid,
		size_t	kl )

lws_cose_key_generate() - generate a fresh key

Parameters

context	the lws_context used to get random
cose_kty	one of LWSCOSE_WKKTV_ indicating the well-known key type
use_mask	0, or a bitfield where (1 << LWSCOSE_WKKO_...) set means valid for use
bits	key bits for RSA
curve	for EC keys, one of "P-256", "P-384" or "P-521" currently
kid	string describing the key, or NULL

Create an lws_cose_key_t of the specified type and return it

References LWS_EXTERN, and LWS_VISIBLE.

lws_cose_key_from_set()

LWS_VISIBLE LWS_EXTERN lws_cose_key_t * lws_cose_key_from_set	(	lws_dll2_owner_t *	set,
		const uint8_t *	kid,
		size_t	kl )

References LWS_EXTERN, and LWS_VISIBLE.

lws_cose_key_destroy()

LWS_VISIBLE LWS_EXTERN void lws_cose_key_destroy

(

lws_cose_key_t **

ck

)

References LWS_EXTERN, and LWS_VISIBLE.

lws_cose_key_set_destroy()

LWS_VISIBLE LWS_EXTERN void lws_cose_key_set_destroy

(

lws_dll2_owner_t *

o

)

References LWS_EXTERN, and LWS_VISIBLE.

lws_cose_key_dump()

LWS_VISIBLE LWS_EXTERN void lws_cose_key_dump

(

const lws_cose_key_t *

ck

)

lws_cose_validate_create()

LWS_VISIBLE LWS_EXTERN struct lws_cose_validate_context * lws_cose_validate_create

(

const lws_cose_validate_create_info_t *

info

)

lws_cose_validate_create() - create a signature validation context

Parameters

info	struct describing the validation context to create

Creates a signature validation context set up as described in info.

You can then pass the signature cbor chunks to it using lws_cose_validate_chunk(), finialize and get the results list using lws_cose_validate_results() and destroy with lws_cose_validate_destroy().

References LWS_EXTERN, and LWS_VISIBLE.

lws_cose_validate_chunk()

LWS_VISIBLE LWS_EXTERN int lws_cose_validate_chunk	(	struct lws_cose_validate_context *	cps,
		const uint8_t *	in,
		size_t	in_len,
		size_t *	used_in )

lws_cose_validate_chunk() - passes chunks of CBOR into the signature validator

Parameters

cps	the validation context
in	the chunk of CBOR (does not have to be logically complete)
in_len	number of bytes available at in

Parses signature CBOR to produce a list of result objects.

References LWS_EXTERN, and LWS_VISIBLE.

lws_cose_validate_results()

LWS_VISIBLE LWS_EXTERN lws_dll2_owner_t * lws_cose_validate_results

(

struct lws_cose_validate_context *

cps

)

References LWS_EXTERN, and LWS_VISIBLE.

lws_cose_validate_destroy()

LWS_VISIBLE LWS_EXTERN void lws_cose_validate_destroy

(

struct lws_cose_validate_context **

cps

)

lws_cose_sign_create()

LWS_VISIBLE LWS_EXTERN struct lws_cose_sign_context * lws_cose_sign_create

(

const lws_cose_sign_create_info_t *

info

)

lws_cose_sign_create() - Create a signing context

Parameters

info	a structure describing the signing context you want to create

This allocates and returns a signing context created according to what is in the info parameter.

info must be prepared with the lws_context, a keyset to use, a CBOR output context, and the inline payload length.

Returns NULL on failure or the created signing context ready to add alg(s) to.

References LWS_EXTERN, and LWS_VISIBLE.

lws_cose_sign_add()

LWS_VISIBLE LWS_EXTERN int lws_cose_sign_add	(	struct lws_cose_sign_context *	csc,
		cose_param_t	alg,
		const lws_cose_key_t *	ck )

References LWS_EXTERN, and LWS_VISIBLE.

lws_cose_sign_payload_chunk()

LWS_VISIBLE LWS_EXTERN enum lws_lec_pctx_ret lws_cose_sign_payload_chunk	(	struct lws_cose_sign_context *	csc,
		const uint8_t *	in,
		size_t	in_len )

References LWS_EXTERN, and LWS_VISIBLE.

lws_cose_sign_destroy()

LWS_VISIBLE LWS_EXTERN void lws_cose_sign_destroy

(

struct lws_cose_sign_context **

csc

)