libcoap 4.3.4
oscore_cose.h
Go to the documentation of this file.
1/* -*- Mode: C; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2
3/*
4 * Copyright (c) 2018, SICS, RISE AB
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the Institute nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 *
31 */
32
46#ifndef _OSCORE_COSE_H
47#define _OSCORE_COSE_H
48
49#include <stdint.h>
50
58/* cose curves */
59
60typedef enum {
61 COSE_CURVE_P_256 = 1, /* NIST P-256 known as secp256r1 */
62 COSE_CURVE_X25519 = 4, /* used with ECDH only */
63 COSE_CURVE_X448 = 5, /* used with ECDH only */
64 COSE_CURVE_ED25519 = 6, /* used with EdDSA only */
65 COSE_CURVE_ED448 = 7, /* used with EdDSA only */
66 COSE_CURVE_SECP256K1 = 8, /* SECG secp256k1 curve */
68
69typedef enum {
76
77#define COSE_ALGORITHM_ED25519_SIG_LEN 64
78#define COSE_ALGORITHM_ED25519_PRIV_KEY_LEN 32
79#define COSE_ALGORITHM_ED25519_PUB_KEY_LEN 32
80
81#define COSE_ALGORITHM_AES_CCM_64_64_128_KEY_LEN 16
82#define COSE_ALGORITHM_AES_CCM_64_64_128_NONCE_LEN 7
83#define COSE_ALGORITHM_AES_CCM_64_64_128_TAG_LEN 8
84
85#define COSE_ALGORITHM_AES_CCM_16_64_128_KEY_LEN 16
86#define COSE_ALGORITHM_AES_CCM_16_64_128_NONCE_LEN 13
87#define COSE_ALGORITHM_AES_CCM_16_64_128_TAG_LEN 8
88
89#define COSE_ALGORITHM_AES_CCM_64_128_128_KEY_LEN 16
90#define COSE_ALGORITHM_AES_CCM_64_128_128_NONCE_LEN 7
91#define COSE_ALGORITHM_AES_CCM_64_128_128_TAG_LEN 16
92
93#define COSE_ALGORITHM_AES_CCM_16_128_128_KEY_LEN 16
94#define COSE_ALGORITHM_AES_CCM_16_128_128_NONCE_LEN 13
95#define COSE_ALGORITHM_AES_CCM_16_128_128_TAG_LEN 16
96
97#define COSE_ALGORITHM_ES256_PRIV_KEY_LEN 24
98#define COSE_ALGORITHM_ES256_PUB_KEY_LEN 32
99#define COSE_ALGORITHM_ES256_SIGNATURE_LEN 64
100#define COSE_ALGORITHM_ES256_HASH_LEN 32
101
102#define COSE_ALGORITHM_ES384_PRIV_KEY_LEN 24
103#define COSE_ALGORITHM_ES384_PUB_KEY_LEN 32
104#define COSE_ALGORITHM_ES384_SIGNATURE_LEN 64
105#define COSE_ALGORITHM_ES384_HASH_LEN 48
106
107#define COSE_ALGORITHM_ES512_PRIV_KEY_LEN 24
108#define COSE_ALGORITHM_ES512_PUB_KEY_LEN 32
109#define COSE_ALGORITHM_ES512_SIGNATURE_LEN 64
110#define COSE_ALGORITHM_ES512_HASH_LEN 64
111
112#define COSE_ALGORITHM_ECDH_PRIV_KEY_LEN 32
113#define COSE_ALGORITHM_ECDH_PUB_KEY_LEN 32
114
115#define COSE_ALGORITHM_SHA_512_LEN 64
116#define COSE_ALGORITHM_SHA_512_256_LEN 32
117#define COSE_ALGORITHM_SHA_256_256_LEN 32
118#define COSE_ALGORITHM_SHA_256_64_LEN 8
119
120#define COSE_ALGORITHM_HMAC256_64_HASH_LEN 16
121#define COSE_ALGORITHM_HMAC256_256_HASH_LEN 32
122#define COSE_ALGORITHM_HMAC384_384_HASH_LEN 48
123#define COSE_ALGORITHM_HMAC512_512_HASH_LEN 64
124
125/* cose algorithms */
126typedef enum {
127 COSE_ALGORITHM_ES256K = -47, /* with ECC known as secp256k1 */
130 COSE_ALGORITHM_ES512 = -36, /* with ECDSA */
131 COSE_ALGORITHM_ES384 = -35, /* with ECDSA */
140 COSE_ALGORITHM_ES256 = -7, /* with ECC known as secp256r1 */
141 COSE_ALGORITHM_HMAC256_64 = 4, /* truncated to 64 bits */
154} cose_alg_t;
155
156/* cose HMAC specific algorithms */
157typedef enum {
158 COSE_HMAC_ALG_HMAC256_64 = 4, /* truncated to 64 bits */
163
164/* cose HKDF specific algorithms */
165typedef enum {
169
170const char *cose_get_curve_name(cose_curve_t id, char *buffer, size_t buflen);
171cose_curve_t cose_get_curve_id(const char *name);
172
173const char *cose_get_alg_name(cose_alg_t id, char *buffer, size_t buflen);
174cose_alg_t cose_get_alg_id(const char *name);
175
176const char *cose_get_hkdf_alg_name(cose_hkdf_alg_t id, char *buffer,
177 size_t buflen);
178
180 cose_hmac_alg_t *hmac_alg);
181
182/* parameter value functions */
183
184/* return tag length belonging to cose algorithm */
185size_t cose_tag_len(cose_alg_t cose_alg);
186
187/* return hash length belonging to cose algorithm */
188size_t cose_hash_len(cose_alg_t cose_alg);
189
190/* return nonce length belonging to cose algorithm */
191size_t cose_nonce_len(cose_alg_t cose_alg);
192
193/* return key length belonging to cose algorithm */
194size_t cose_key_len(cose_alg_t cose_alg);
195
196/* COSE Encrypt0 Struct */
197typedef struct cose_encrypt0_t {
200 uint8_t partial_iv_data[8];
201 /* partial_iv.s will point back to partial_iv_data if set */
212
213/* Return length */
214size_t cose_encrypt0_encode(cose_encrypt0_t *ptr, uint8_t *buffer, size_t size);
215
216/*Return status */
217int cose_encrypt0_decode(cose_encrypt0_t *ptr, uint8_t *buffer, size_t size);
218
219/* Initiate a new COSE Encrypt0 object. */
221
222void cose_encrypt0_set_alg(cose_encrypt0_t *ptr, uint8_t alg);
223
224void cose_encrypt0_set_plaintext(cose_encrypt0_t *ptr, uint8_t *buffer, size_t size);
225
227 uint8_t *buffer,
228 size_t size);
229
230/* Return length */
232
234 coap_bin_const_t *partial_iv);
235
237
239
240/* Return length */
241size_t cose_encrypt0_get_key_id(cose_encrypt0_t *ptr, const uint8_t **buffer);
242
244 coap_bin_const_t *external_aad);
245
247
248/* Return length */
250 const uint8_t **buffer);
251
253 coap_bin_const_t *kid_context);
254
255/* Returns 1 if successfull, 0 if key is of incorrect length. */
257
259
261 uint8_t *ciphertext_buffer,
262 size_t ciphertext_len);
263
265 uint8_t *plaintext_buffer,
266 size_t plaintext_len);
267
270#endif /* _OSCORE_COSE_H */
void cose_encrypt0_set_plaintext(cose_encrypt0_t *ptr, uint8_t *buffer, size_t size)
Definition: oscore_cose.c:315
int cose_encrypt0_get_plaintext(cose_encrypt0_t *ptr, uint8_t **buffer)
const char * cose_get_hkdf_alg_name(cose_hkdf_alg_t id, char *buffer, size_t buflen)
Definition: oscore_cose.c:151
int cose_encrypt0_set_key(cose_encrypt0_t *ptr, coap_bin_const_t *key)
Definition: oscore_cose.c:401
size_t cose_nonce_len(cose_alg_t cose_alg)
Definition: oscore_cose.c:244
struct cose_encrypt0_t cose_encrypt0_t
cose_alg_t cose_get_alg_id(const char *name)
Definition: oscore_cose.c:132
void cose_encrypt0_set_kid_context(cose_encrypt0_t *ptr, coap_bin_const_t *kid_context)
Definition: oscore_cose.c:368
cose_curve_t cose_get_curve_id(const char *name)
Definition: oscore_cose.c:76
size_t cose_key_len(cose_alg_t cose_alg)
Definition: oscore_cose.c:261
size_t cose_encrypt0_get_key_id(cose_encrypt0_t *ptr, const uint8_t **buffer)
Definition: oscore_cose.c:356
const char * cose_get_alg_name(cose_alg_t id, char *buffer, size_t buflen)
Definition: oscore_cose.c:120
int cose_get_hmac_alg_for_hkdf(cose_hkdf_alg_t hkdf_alg, cose_hmac_alg_t *hmac_alg)
Definition: oscore_cose.c:179
coap_bin_const_t cose_encrypt0_get_partial_iv(cose_encrypt0_t *ptr)
Definition: oscore_cose.c:341
cose_hkdf_alg_t
Definition: oscore_cose.h:165
size_t cose_encrypt0_get_kid_context(cose_encrypt0_t *ptr, const uint8_t **buffer)
Definition: oscore_cose.c:362
void cose_encrypt0_set_ciphertext(cose_encrypt0_t *ptr, uint8_t *buffer, size_t size)
Definition: oscore_cose.c:307
size_t cose_hash_len(cose_alg_t cose_alg)
Definition: oscore_cose.c:213
int cose_encrypt0_decrypt(cose_encrypt0_t *ptr, uint8_t *plaintext_buffer, size_t plaintext_len)
Definition: oscore_cose.c:460
size_t cose_tag_len(cose_alg_t cose_alg)
Definition: oscore_cose.c:196
void cose_encrypt0_set_aad(cose_encrypt0_t *ptr, coap_bin_const_t *aad)
Definition: oscore_cose.c:390
cose_hmac_alg_t
Definition: oscore_cose.h:157
int cose_encrypt0_decode(cose_encrypt0_t *ptr, uint8_t *buffer, size_t size)
cose_curve_t
Definition: oscore_cose.h:60
int cose_encrypt0_encrypt(cose_encrypt0_t *ptr, uint8_t *ciphertext_buffer, size_t ciphertext_len)
Definition: oscore_cose.c:421
void cose_encrypt0_set_partial_iv(cose_encrypt0_t *ptr, coap_bin_const_t *partial_iv)
Definition: oscore_cose.c:325
cose_alg_t
Definition: oscore_cose.h:126
const char * cose_get_curve_name(cose_curve_t id, char *buffer, size_t buflen)
Definition: oscore_cose.c:64
cose_key_type_t
Definition: oscore_cose.h:69
size_t cose_encrypt0_encode(cose_encrypt0_t *ptr, uint8_t *buffer, size_t size)
Definition: oscore_cose.c:278
void cose_encrypt0_set_external_aad(cose_encrypt0_t *ptr, coap_bin_const_t *external_aad)
Definition: oscore_cose.c:379
void cose_encrypt0_init(cose_encrypt0_t *ptr)
Definition: oscore_cose.c:297
void cose_encrypt0_set_alg(cose_encrypt0_t *ptr, uint8_t alg)
Definition: oscore_cose.c:302
void cose_encrypt0_set_key_id(cose_encrypt0_t *ptr, coap_bin_const_t *key_id)
Definition: oscore_cose.c:346
void cose_encrypt0_set_nonce(cose_encrypt0_t *ptr, coap_bin_const_t *nonce)
Definition: oscore_cose.c:411
@ COSE_HKDF_ALG_HKDF_SHA_256
Definition: oscore_cose.h:167
@ COSE_HKDF_ALG_HKDF_SHA_512
Definition: oscore_cose.h:166
@ COSE_HMAC_ALG_HMAC384_384
Definition: oscore_cose.h:160
@ COSE_HMAC_ALG_HMAC256_256
Definition: oscore_cose.h:159
@ COSE_HMAC_ALG_HMAC512_512
Definition: oscore_cose.h:161
@ COSE_HMAC_ALG_HMAC256_64
Definition: oscore_cose.h:158
@ COSE_CURVE_X25519
Definition: oscore_cose.h:62
@ COSE_CURVE_ED448
Definition: oscore_cose.h:65
@ COSE_CURVE_P_256
Definition: oscore_cose.h:61
@ COSE_CURVE_SECP256K1
Definition: oscore_cose.h:66
@ COSE_CURVE_ED25519
Definition: oscore_cose.h:64
@ COSE_CURVE_X448
Definition: oscore_cose.h:63
@ COSE_ALGORITHM_HMAC256_256
Definition: oscore_cose.h:142
@ COSE_ALGORITHM_AES_CCM_16_128_256
Definition: oscore_cose.h:151
@ COSE_ALGORITHM_ECDH_SS_HKDF_256
Definition: oscore_cose.h:132
@ COSE_ALGORITHM_HMAC512_512
Definition: oscore_cose.h:144
@ COSE_ALGORITHM_SHA_256_64
Definition: oscore_cose.h:135
@ COSE_ALGORITHM_SHA_512_256
Definition: oscore_cose.h:133
@ COSE_ALGORITHM_ES384
Definition: oscore_cose.h:131
@ COSE_ALGORITHM_AES_CCM_64_64_128
Definition: oscore_cose.h:147
@ COSE_ALGORITHM_CHACHA20_P1035
Definition: oscore_cose.h:149
@ COSE_ALGORITHM_HKDF_SHA_512
Definition: oscore_cose.h:137
@ COSE_ALGORITHM_AES_CCM_16_128_128
Definition: oscore_cose.h:150
@ COSE_ALGORITHM_AES_CCM_64_128_256
Definition: oscore_cose.h:153
@ COSE_ALGORITHM_SHA_256_256
Definition: oscore_cose.h:134
@ COSE_ALGORITHM_SHA_1
Definition: oscore_cose.h:136
@ COSE_ALGORITHM_EDDSA
Definition: oscore_cose.h:139
@ COSE_ALGORITHM_HMAC256_64
Definition: oscore_cose.h:141
@ COSE_ALGORITHM_ES256
Definition: oscore_cose.h:140
@ COSE_ALGORITHM_AES_CCM_64_64_256
Definition: oscore_cose.h:148
@ COSE_ALGORITHM_HKDF_SHA_256
Definition: oscore_cose.h:138
@ COSE_ALGORITHM_AES_CCM_16_64_128
Definition: oscore_cose.h:145
@ COSE_ALGORITHM_ES512
Definition: oscore_cose.h:130
@ COSE_ALGORITHM_HMAC384_384
Definition: oscore_cose.h:143
@ COSE_ALGORITHM_SHA_512
Definition: oscore_cose.h:128
@ COSE_ALGORITHM_AES_CCM_64_128_128
Definition: oscore_cose.h:152
@ COSE_ALGORITHM_AES_CCM_16_64_256
Definition: oscore_cose.h:146
@ COSE_ALGORITHM_ES256K
Definition: oscore_cose.h:127
@ COSE_ALGORITHM_SHA_384
Definition: oscore_cose.h:129
@ COSE_KTY_SYMMETRIC
Definition: oscore_cose.h:74
@ COSE_KTY_OKP
Definition: oscore_cose.h:71
@ COSE_KTY_UNKNOWN
Definition: oscore_cose.h:70
@ COSE_KTY_EC2
Definition: oscore_cose.h:72
@ COSE_KTY_RSA
Definition: oscore_cose.h:73
CoAP binary data definition with const data.
Definition: coap_str.h:64
coap_bin_const_t aad
Definition: oscore_cose.h:208
coap_bin_const_t key
Definition: oscore_cose.h:199
coap_bin_const_t ciphertext
Definition: oscore_cose.h:210
coap_bin_const_t plaintext
Definition: oscore_cose.h:209
coap_bin_const_t partial_iv
Definition: oscore_cose.h:202
coap_bin_const_t kid_context
Definition: oscore_cose.h:204
coap_bin_const_t nonce
Definition: oscore_cose.h:206
coap_bin_const_t external_aad
Definition: oscore_cose.h:207
coap_bin_const_t key_id
Definition: oscore_cose.h:203
coap_bin_const_t oscore_option
Definition: oscore_cose.h:205
uint8_t partial_iv_data[8]
Definition: oscore_cose.h:200
cose_alg_t alg
Definition: oscore_cose.h:198