libcoap 4.3.5-develop-b61cb76
Loading...
Searching...
No Matches
coap_oscore.c
Go to the documentation of this file.
1/* -*- Mode: C; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2
3/*
4 * coap_oscore.c -- Object Security for Constrained RESTful Environments
5 * (OSCORE) support for libcoap
6 *
7 * Copyright (C) 2019-2021 Olaf Bergmann <bergmann@tzi.org>
8 * Copyright (C) 2021-2026 Jon Shallow <supjps-libcoap@jpshallow.com>
9 *
10 * SPDX-License-Identifier: BSD-2-Clause
11 *
12 * This file is part of the CoAP library libcoap. Please see README for terms
13 * of use.
14 */
15
20
21#include "coap3/coap_libcoap_build.h"
22
23#if COAP_OSCORE_SUPPORT
24#include <ctype.h>
25
26#define AAD_BUF_LEN 200 /* length of aad_buffer */
27
28static oscore_ctx_t *coap_oscore_init(coap_context_t *c_context,
29 coap_oscore_conf_t *oscore_conf);
30
31#if COAP_CLIENT_SUPPORT
32
33int
34coap_oscore_initiate(coap_session_t *session, coap_oscore_conf_t *oscore_conf) {
35 if (oscore_conf) {
36 oscore_ctx_t *osc_ctx;
37
38 if (oscore_conf->recipient_chain == NULL) {
39 coap_log_warn("OSCORE: Recipient ID must be defined for a client\n");
40 coap_delete_oscore_conf(oscore_conf);
41 return 0;
42 }
43 if (oscore_conf->rfc8613_b_2) {
44 /* Need to replace id_context with random value */
45 coap_binary_t *id_context = coap_new_binary(8);
46
47 if (id_context == NULL) {
48 coap_delete_oscore_conf(oscore_conf);
49 return 0;
50 }
51 coap_delete_bin_const(oscore_conf->id_context);
52 coap_prng_lkd(id_context->s, id_context->length);
53 oscore_conf->id_context = (coap_bin_const_t *)id_context;
54 session->b_2_step = COAP_OSCORE_B_2_STEP_1;
55 coap_log_oscore("Appendix B.2 client step 1 (Generated ID1)\n");
56 }
57
58 osc_ctx = coap_oscore_init(session->context, oscore_conf);
59 if (osc_ctx == NULL) {
60 return 0;
61 }
62 coap_oscore_session_set_recipient_ctx(session, osc_ctx->recipient_chain);
63 session->oscore_encryption = 1;
64 }
65 return 1;
66}
67
68COAP_API coap_session_t *
69coap_new_client_session_oscore(coap_context_t *ctx,
70 const coap_address_t *local_if,
71 const coap_address_t *server,
72 coap_proto_t proto,
73 coap_oscore_conf_t *oscore_conf) {
74 coap_session_t *session;
75
76 coap_lock_lock(return NULL);
77 session = coap_new_client_session_oscore3_lkd(ctx, local_if, server, proto, oscore_conf, NULL,
78 NULL, NULL);
79 coap_lock_unlock();
80 return session;
81}
82
83COAP_API coap_session_t *
84coap_new_client_session_oscore3(coap_context_t *ctx,
85 const coap_address_t *local_if,
86 const coap_address_t *server,
87 coap_proto_t proto,
88 coap_oscore_conf_t *oscore_conf,
89 void *app_data,
90 coap_app_data_free_callback_t callback,
91 coap_str_const_t *ws_host) {
92 coap_session_t *session;
93
94 coap_lock_lock(return NULL);
95 session = coap_new_client_session_oscore3_lkd(ctx, local_if, server, proto, oscore_conf, app_data,
96 callback, ws_host);
97 coap_lock_unlock();
98 return session;
99}
100
101coap_session_t *
102coap_new_client_session_oscore3_lkd(coap_context_t *ctx,
103 const coap_address_t *local_if,
104 const coap_address_t *server,
105 coap_proto_t proto,
106 coap_oscore_conf_t *oscore_conf,
107 void *app_data,
108 coap_app_data_free_callback_t callback,
109 coap_str_const_t *ws_host) {
110 coap_session_t *session =
111 coap_new_client_session3_lkd(ctx, local_if, server, proto, app_data, callback, ws_host);
112
113 if (!session)
114 return NULL;
115
116 if (coap_oscore_initiate(session, oscore_conf) == 0) {
117 coap_session_release_lkd(session);
118 return NULL;
119 }
120 return session;
121}
122
123COAP_API coap_session_t *
124coap_new_client_session_oscore_psk(coap_context_t *ctx,
125 const coap_address_t *local_if,
126 const coap_address_t *server,
127 coap_proto_t proto,
128 coap_dtls_cpsk_t *psk_data,
129 coap_oscore_conf_t *oscore_conf) {
130 coap_session_t *session;
131
132 coap_lock_lock(return NULL);
133 session = coap_new_client_session_oscore_psk3_lkd(ctx, local_if, server, proto, psk_data,
134 oscore_conf, NULL, NULL, NULL);
135 coap_lock_unlock();
136 return session;
137}
138
139COAP_API coap_session_t *
140coap_new_client_session_oscore_psk3(coap_context_t *ctx,
141 const coap_address_t *local_if,
142 const coap_address_t *server,
143 coap_proto_t proto,
144 coap_dtls_cpsk_t *psk_data,
145 coap_oscore_conf_t *oscore_conf,
146 void *app_data,
147 coap_app_data_free_callback_t callback,
148 coap_str_const_t *ws_host) {
149 coap_session_t *session;
150
151 coap_lock_lock(return NULL);
152 session = coap_new_client_session_oscore_psk3_lkd(ctx, local_if, server, proto, psk_data,
153 oscore_conf, app_data, callback, ws_host);
154 coap_lock_unlock();
155 return session;
156}
157
158coap_session_t *
159coap_new_client_session_oscore_psk3_lkd(coap_context_t *ctx,
160 const coap_address_t *local_if,
161 const coap_address_t *server,
162 coap_proto_t proto,
163 coap_dtls_cpsk_t *psk_data,
164 coap_oscore_conf_t *oscore_conf,
165 void *app_data,
166 coap_app_data_free_callback_t callback,
167 coap_str_const_t *ws_host) {
168 coap_session_t *session;
169
170 coap_lock_check_locked();
171 session = coap_new_client_session_psk3_lkd(ctx, local_if, server, proto, psk_data,
172 app_data, callback, ws_host);
173
174 if (!session)
175 return NULL;
176
177 if (coap_oscore_initiate(session, oscore_conf) == 0) {
178 coap_session_release_lkd(session);
179 return NULL;
180 }
181 return session;
182}
183
184COAP_API coap_session_t *
185coap_new_client_session_oscore_pki(coap_context_t *ctx,
186 const coap_address_t *local_if,
187 const coap_address_t *server,
188 coap_proto_t proto,
189 coap_dtls_pki_t *pki_data,
190 coap_oscore_conf_t *oscore_conf) {
191 coap_session_t *session;
192
193 coap_lock_lock(return NULL);
194 session = coap_new_client_session_oscore_pki3_lkd(ctx, local_if, server, proto, pki_data,
195 oscore_conf, NULL, NULL, NULL);
196 coap_lock_unlock();
197 return session;
198}
199
200COAP_API coap_session_t *
201coap_new_client_session_oscore_pki3(coap_context_t *ctx,
202 const coap_address_t *local_if,
203 const coap_address_t *server,
204 coap_proto_t proto,
205 coap_dtls_pki_t *pki_data,
206 coap_oscore_conf_t *oscore_conf,
207 void *app_data,
208 coap_app_data_free_callback_t callback,
209 coap_str_const_t *ws_host) {
210 coap_session_t *session;
211
212 coap_lock_lock(return NULL);
213 session = coap_new_client_session_oscore_pki3_lkd(ctx, local_if, server, proto, pki_data,
214 oscore_conf, app_data, callback, ws_host);
215 coap_lock_unlock();
216 return session;
217}
218
219coap_session_t *
220coap_new_client_session_oscore_pki3_lkd(coap_context_t *ctx,
221 const coap_address_t *local_if,
222 const coap_address_t *server,
223 coap_proto_t proto,
224 coap_dtls_pki_t *pki_data,
225 coap_oscore_conf_t *oscore_conf,
226 void *app_data,
227 coap_app_data_free_callback_t callback,
228 coap_str_const_t *ws_host) {
229 coap_session_t *session;
230
231 coap_lock_check_locked();
232 session = coap_new_client_session_pki3_lkd(ctx, local_if, server, proto, pki_data,
233 app_data, callback, ws_host);
234
235 if (!session)
236 return NULL;
237
238 if (coap_oscore_initiate(session, oscore_conf) == 0) {
239 coap_session_release_lkd(session);
240 return NULL;
241 }
242 return session;
243}
244#endif /* COAP_CLIENT_SUPPORT */
245#if COAP_SERVER_SUPPORT
246
247COAP_API int
248coap_context_oscore_server(coap_context_t *context,
249 coap_oscore_conf_t *oscore_conf) {
250 int ret;
251
252 coap_lock_lock(return 0);
253 ret = coap_context_oscore_server_lkd(context, oscore_conf);
254 coap_lock_unlock();
255 return ret;
256}
257
258int
259coap_context_oscore_server_lkd(coap_context_t *context,
260 coap_oscore_conf_t *oscore_conf) {
261 oscore_ctx_t *osc_ctx;
262
263 coap_lock_check_locked();
264 osc_ctx = coap_oscore_init(context, oscore_conf);
265 /* osc_ctx already added to context->osc_ctx */
266 if (osc_ctx)
267 return 1;
268 return 0;
269}
270
271#endif /* COAP_SERVER_SUPPORT */
272
273int
274coap_rebuild_pdu_for_proxy(coap_pdu_t *pdu) {
275 coap_uri_t uri;
276 coap_opt_iterator_t opt_iter;
277 coap_opt_t *option;
278 uint8_t option_value_buffer[15];
279 coap_optlist_t *optlist_chain = NULL;
280
281 if ((option =
282 coap_check_option(pdu, COAP_OPTION_PROXY_URI, &opt_iter)) == NULL)
283 return 1;
284
285 /* Need to break down into the component parts, but keep data safe */
286 memset(&uri, 0, sizeof(uri));
287
288 if (coap_split_proxy_uri(coap_opt_value(option),
289 coap_opt_length(option),
290 &uri) < 0 || uri.scheme >= COAP_URI_SCHEME_LAST) {
291 coap_log_warn("Proxy URI '%.*s' not decodable\n",
292 coap_opt_length(option),
293 (const char *)coap_opt_value(option));
294 goto error;
295 }
296 if (!coap_remove_option(pdu, COAP_OPTION_PROXY_URI))
297 goto error;
298
299 if (!coap_insert_option(pdu,
300 COAP_OPTION_URI_HOST,
301 uri.host.length,
302 uri.host.s))
303 goto error;
304 if (uri.port != (coap_uri_scheme_is_secure(&uri) ? COAPS_DEFAULT_PORT : COAP_DEFAULT_PORT) &&
305 !coap_insert_option(pdu,
306 COAP_OPTION_URI_PORT,
307 coap_encode_var_safe(option_value_buffer,
308 sizeof(option_value_buffer),
309 uri.port & 0xffff),
310 option_value_buffer))
311 goto error;
312 if (uri.path.length) {
313 /* Add in the Uri-Path options */
314 if (!coap_path_into_optlist(uri.path.s, uri.path.length, COAP_OPTION_URI_PATH,
315 &optlist_chain))
316 goto error;
317 }
318 if (uri.query.length) {
319 /* Add in the Uri-Query options */
320 if (!coap_query_into_optlist(uri.query.s, uri.query.length, COAP_OPTION_URI_QUERY,
321 &optlist_chain))
322 goto error;
323 }
324 if (!coap_add_optlist_pdu(pdu, &optlist_chain))
325 goto error;
326
327 if (!coap_insert_option(pdu,
328 COAP_OPTION_PROXY_SCHEME,
329 strlen(coap_uri_scheme[uri.scheme].name),
330 (const uint8_t *)coap_uri_scheme[uri.scheme].name))
331 goto error;
332
333 coap_delete_optlist(optlist_chain);
334 return 1;
335
336error:
337 coap_delete_optlist(optlist_chain);
338 return 0;
339}
340
341static void
342dump_cose(cose_encrypt0_t *cose, const char *message) {
343#if COAP_MAX_LOGGING_LEVEL < _COAP_LOG_OSCORE
344 (void)cose;
345 (void)message;
346#else /* COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_OSCORE */
347 if (coap_get_log_level() >= COAP_LOG_OSCORE) {
348 char buffer[30];
349
350 coap_log_oscore("%s COSE information\n", message);
351 oscore_log_char_value(COAP_LOG_OSCORE, "alg",
352 cose_get_alg_name(cose->alg, buffer, sizeof(buffer)));
353 oscore_log_hex_value(COAP_LOG_OSCORE, "key", &cose->key);
354 oscore_log_hex_value(COAP_LOG_OSCORE, "partial_iv", &cose->partial_iv);
355 oscore_log_hex_value(COAP_LOG_OSCORE, "key_id", &cose->key_id);
356 oscore_log_hex_value(COAP_LOG_OSCORE, "kid_context", &cose->kid_context);
357 oscore_log_hex_value(COAP_LOG_OSCORE,
358 "oscore_option",
359 &cose->oscore_option);
360 oscore_log_hex_value(COAP_LOG_OSCORE, "nonce", &cose->nonce);
361 oscore_log_hex_value(COAP_LOG_OSCORE, "external_aad", &cose->external_aad);
362 oscore_log_hex_value(COAP_LOG_OSCORE, "aad", &cose->aad);
363 }
364#endif /* COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_OSCORE */
365}
366
367COAP_API coap_pdu_t *
368coap_oscore_new_pdu_encrypted(coap_session_t *session,
369 coap_pdu_t *pdu,
370 coap_bin_const_t *kid_context,
371 oscore_partial_iv_t send_partial_iv) {
372 coap_pdu_t *ret_pdu;
373
374 coap_lock_lock(return NULL);
375 ret_pdu = coap_oscore_new_pdu_encrypted_lkd(session, pdu, kid_context, send_partial_iv);
376 coap_lock_unlock();
377
378 return ret_pdu;
379}
380
381/*
382 * Take current PDU, create a new one appropriately separated as per RFC8613
383 * and then encrypt / integrity check the OSCORE data
384 */
385coap_pdu_t *
386coap_oscore_new_pdu_encrypted_lkd(coap_session_t *session,
387 coap_pdu_t *pdu,
388 coap_bin_const_t *kid_context,
389 oscore_partial_iv_t send_partial_iv) {
390 uint8_t coap_request = COAP_PDU_IS_REQUEST(pdu) || COAP_PDU_IS_PING(pdu);
391 coap_pdu_code_t code =
392 coap_request ? COAP_REQUEST_CODE_POST : COAP_RESPONSE_CODE(204);
393 coap_pdu_t *osc_pdu;
394 coap_pdu_t *plain_pdu = NULL;
395 coap_bin_const_t pdu_token;
396 coap_opt_iterator_t opt_iter;
397 coap_opt_t *option;
398 uint8_t pdu_code = pdu->code;
399 size_t length;
400 const uint8_t *data;
401 uint8_t *ciphertext_buffer = NULL;
402 size_t ciphertext_len = 0;
403 uint8_t aad_buffer[AAD_BUF_LEN];
404 uint8_t nonce_buffer[13];
405 coap_bin_const_t aad;
406 coap_bin_const_t nonce;
407 oscore_recipient_ctx_t *rcp_ctx;
408 oscore_ctx_t *osc_ctx;
409 cose_encrypt0_t cose[1];
410 uint8_t group_flag = 0;
411 int show_pdu = 0;
412 int doing_observe = 0;
413 uint32_t observe_value = 0;
414 oscore_association_t *association = NULL;
415 oscore_sender_ctx_t *snd_ctx;
416 uint8_t external_aad_buffer[200];
417 coap_bin_const_t external_aad;
418 uint8_t oscore_option[255];
419 ssize_t oscore_option_len;
420
421 /* Check that OSCORE has not already been done */
422 if (coap_check_option(pdu, COAP_OPTION_OSCORE, &opt_iter))
423 return NULL;
424
425 if (coap_check_option(pdu, COAP_OPTION_OBSERVE, &opt_iter))
426 doing_observe = 1;
427
428 coap_log_debug("PDU to encrypt\n");
429 coap_show_pdu(COAP_LOG_DEBUG, pdu);
430 osc_pdu = coap_pdu_init(pdu->type == COAP_MESSAGE_NON &&
431 session->b_2_step != COAP_OSCORE_B_2_NONE ?
432 COAP_MESSAGE_CON : pdu->type,
433 code,
434 pdu->mid,
435 pdu->used_size + coap_oscore_overhead(session, pdu));
436 if (osc_pdu == NULL)
437 return NULL;
438
439 cose_encrypt0_init(cose); /* clears cose memory */
440 pdu_token = coap_pdu_get_token(pdu);
441 if (coap_request) {
442 /*
443 * RFC8613 8.1 Step 1. Protecting the client's request
444 * Get the Sender Context
445 */
446 rcp_ctx = session->recipient_ctx;
447 if (rcp_ctx == NULL)
448 goto error;
449 osc_ctx = rcp_ctx->osc_ctx;
450 assert(osc_ctx);
451 snd_ctx = osc_ctx->sender_context;
452 } else {
453 /*
454 * RFC8613 8.3 Step 1. Protecting the server's response
455 * Get the Sender Context
456 */
457 association = oscore_find_association(session, &pdu_token);
458 if (association == NULL)
459 goto error;
460
461 rcp_ctx = association->recipient_ctx;
462 osc_ctx = rcp_ctx->osc_ctx;
463 snd_ctx = osc_ctx->sender_context;
464 cose_encrypt0_set_partial_iv(cose, association->partial_iv);
465 cose_encrypt0_set_aad(cose, association->aad);
466 }
467
468 cose_encrypt0_set_alg(cose, osc_ctx->aead_alg);
469
470 if (coap_request || doing_observe ||
471 send_partial_iv == OSCORE_SEND_PARTIAL_IV) {
472 uint8_t partial_iv_buffer[8];
473 size_t partial_iv_len;
474 coap_bin_const_t partial_iv;
475 partial_iv_len = coap_encode_var_safe8(partial_iv_buffer,
476 sizeof(partial_iv_buffer),
477 snd_ctx->seq);
478 if (snd_ctx->seq == 0) {
479 /* Need to special case */
480 partial_iv_buffer[0] = '\000';
481 partial_iv_len = 1;
482 }
483 partial_iv.s = partial_iv_buffer;
484 partial_iv.length = partial_iv_len;
485 cose_encrypt0_set_partial_iv(cose, &partial_iv);
486 }
487
488 if (coap_request)
489 cose_encrypt0_set_kid_context(cose, osc_ctx->id_context);
490
491 cose_encrypt0_set_key_id(cose, snd_ctx->sender_id);
492
493 /* nonce (needs to have sender information correctly set up) */
494
495 if (coap_request || doing_observe ||
496 send_partial_iv == OSCORE_SEND_PARTIAL_IV) {
497 /*
498 * 8.1 Step 3 or RFC8613 8.3.1 Step A
499 * Compose the AEAD nonce
500 *
501 * Requires in COSE object as appropriate
502 * key_id (kid) (sender)
503 * partial_iv (sender)
504 * common_iv (already in osc_ctx)
505 */
506 nonce.s = nonce_buffer;
507 nonce.length = 13;
508 oscore_generate_nonce(cose, osc_ctx, nonce_buffer, 13);
509 cose_encrypt0_set_nonce(cose, &nonce);
510 if (!oscore_increment_sender_seq(osc_ctx))
511 goto error;
512 if (osc_ctx->save_seq_num_func) {
513 if (osc_ctx->sender_context->seq > osc_ctx->sender_context->next_seq) {
514 /* Only update at ssn_freq rate */
515 osc_ctx->sender_context->next_seq += osc_ctx->ssn_freq;
516 osc_ctx->save_seq_num_func(osc_ctx->sender_context->next_seq,
517 osc_ctx->save_seq_num_func_param);
518 }
519 }
520 } else {
521 /*
522 * 8.3 Step 3.
523 * Use nonce from request
524 */
525 cose_encrypt0_set_nonce(cose, association->nonce);
526 }
527
528 /* OSCORE_option (needs to be before AAD as included in AAD if group) */
529
530 /* cose is modified for encode option in response message */
531 if (!coap_request) {
532 /* no kid on response */
533 cose_encrypt0_set_key_id(cose, NULL);
534 if (!doing_observe && send_partial_iv == OSCORE_SEND_NO_IV)
535 cose_encrypt0_set_partial_iv(cose, NULL);
536 }
537 if (kid_context) {
538 cose_encrypt0_set_kid_context(cose, kid_context);
539 }
540 oscore_option_len =
541 oscore_encode_option_value(oscore_option, sizeof(oscore_option), cose,
542 group_flag,
543 session->b_2_step != COAP_OSCORE_B_2_NONE);
544 if (oscore_option_len < 0) {
545 coap_log_oscore("Invalid parameters for creating OSCORE option\n");
546 goto error;
547 }
548 if (!coap_request) {
549 /* Reset what was just unset as appropriate for AAD */
550 cose_encrypt0_set_key_id(cose, rcp_ctx->recipient_id);
551 cose_encrypt0_set_partial_iv(cose, association->partial_iv);
552 }
553 if (kid_context)
554 cose_encrypt0_set_kid_context(cose, osc_ctx->id_context);
555
556 /*
557 * RFC8613 8.1/8.3 Step 2(a) (5.4).
558 * Compose the External AAD and then AAD
559 *
560 * OSCORE_option requires
561 * partial_iv (cose partial_iv)
562 * kid_context (cose kid_context)
563 * key_id (cose key_id)
564 * group_flag
565 *
566 * Non Group requires the following
567 * RFC8613 5.4
568 * oscore_version 1
569 * algorithms [
570 * aead_alg (osc_ctx)
571 * ]
572 * request_kid (request key_id using cose)
573 * request_piv (request partial_iv using cose)
574 * options (none at present)
575 *
576 * Note: No I options at present
577 */
578 if (coap_request || send_partial_iv == OSCORE_SEND_PARTIAL_IV) {
579 /* External AAD */
580 external_aad.s = external_aad_buffer;
581 external_aad.length = oscore_prepare_e_aad(osc_ctx,
582 cose,
583 NULL,
584 0,
585 NULL,
586 external_aad_buffer,
587 sizeof(external_aad_buffer));
588 if (external_aad.length == 0)
589 goto error;
590 cose_encrypt0_set_external_aad(cose, &external_aad);
591
592 /* AAD */
593 aad.s = aad_buffer;
594 aad.length = oscore_prepare_aad(external_aad_buffer,
595 external_aad.length,
596 aad_buffer,
597 sizeof(aad_buffer));
598 if (aad.length == 0)
599 goto error;
600 assert(aad.length < AAD_BUF_LEN);
601 cose_encrypt0_set_aad(cose, &aad);
602 }
603
604 /*
605 * RFC8613 8.1/8.3 Step 2(b) (5.3).
606 *
607 * Set up temp plaintext pdu, the data including token, options and
608 * optional payload will get encrypted as COSE ciphertext.
609 */
610 plain_pdu = coap_pdu_init(pdu->type,
611 pdu->code,
612 pdu->mid,
613 pdu->used_size + 1 /* pseudo-token with actual code */);
614 if (plain_pdu == NULL)
615 goto error;
616
617 coap_add_token(osc_pdu, pdu_token.length, pdu_token.s);
618
619 /* First byte of plain is real CoAP code. Pretend it is token */
620 coap_add_token(plain_pdu, 1, &pdu_code);
621
622 /* Copy across the Outer/Inner Options to respective PDUs */
623 coap_option_iterator_init(pdu, &opt_iter, COAP_OPT_ALL);
624 while ((option = coap_option_next(&opt_iter))) {
625 switch ((coap_code_opt_num_t)opt_iter.number) {
626 case COAP_OPTION_URI_HOST:
627 case COAP_OPTION_URI_PORT:
628 case COAP_OPTION_PROXY_SCHEME:
629 case COAP_OPTION_HOP_LIMIT:
630 case COAP_OPTION_EDHOC:
631 /* Outer only */
632 if (!coap_insert_option(osc_pdu,
633 opt_iter.number,
634 coap_opt_length(option),
635 coap_opt_value(option)))
636 goto error;
637 break;
638 case COAP_OPTION_OBSERVE:
639 /* Make as Outer option as-is */
640 if (!coap_insert_option(osc_pdu,
641 opt_iter.number,
642 coap_opt_length(option),
643 coap_opt_value(option)))
644 goto error;
645 if (coap_request) {
646 /* Make as Inner option (unchanged) */
647 if (!coap_insert_option(plain_pdu,
648 opt_iter.number,
649 coap_opt_length(option),
650 coap_opt_value(option)))
651 goto error;
652 osc_pdu->code = COAP_REQUEST_CODE_FETCH;
653 } else {
654 /* Make as Inner option but empty */
655 if (!coap_insert_option(plain_pdu, opt_iter.number, 0, NULL))
656 goto error;
657 osc_pdu->code = COAP_RESPONSE_CODE(205);
658 }
659 show_pdu = 1;
660 doing_observe = 1;
661 observe_value = coap_decode_var_bytes(coap_opt_value(option),
662 coap_opt_length(option));
663 break;
664 case COAP_OPTION_PROXY_URI:
665 /*
666 * Should have already been caught by doing
667 * coap_rebuild_pdu_for_proxy() before calling
668 * coap_oscore_new_pdu_encrypted_lkd()
669 */
670 assert(0);
671 break;
672 case COAP_OPTION_OSCORE:
673 /* Dealt with separately */
674 break;
675 case COAP_OPTION_IF_MATCH:
676 case COAP_OPTION_ETAG:
677 case COAP_OPTION_IF_NONE_MATCH:
678 case COAP_OPTION_LOCATION_PATH:
679 case COAP_OPTION_URI_PATH:
680 case COAP_OPTION_URI_PATH_ABB:
681 case COAP_OPTION_CONTENT_FORMAT:
682 case COAP_OPTION_MAXAGE:
683 case COAP_OPTION_URI_QUERY:
684 case COAP_OPTION_ACCEPT:
685 case COAP_OPTION_Q_BLOCK1:
686 case COAP_OPTION_LOCATION_QUERY:
687 case COAP_OPTION_BLOCK2:
688 case COAP_OPTION_BLOCK1:
689 case COAP_OPTION_SIZE2:
690 case COAP_OPTION_Q_BLOCK2:
691 case COAP_OPTION_SIZE1:
692 case COAP_OPTION_NORESPONSE:
693 case COAP_OPTION_ECHO:
694 case COAP_OPTION_RTAG:
695 default:
696 /* Make as Inner option */
697 if (!coap_insert_option(plain_pdu,
698 opt_iter.number,
699 coap_opt_length(option),
700 coap_opt_value(option)))
701 goto error;
702 break;
703 }
704 }
705 /* Add in data to plain */
706 if (coap_get_data(pdu, &length, &data)) {
707 if (!coap_add_data(plain_pdu, length, data))
708 goto error;
709 }
710 if (show_pdu) {
711 coap_log_oscore("OSCORE payload\n");
712 coap_show_pdu(COAP_LOG_OSCORE, plain_pdu);
713 }
714
715 /*
716 * 8.1/8.3 Step 4.
717 * Encrypt the COSE object.
718 *
719 * Requires in COSE object as appropriate
720 * alg (already set)
721 * key (sender key)
722 * nonce (already set)
723 * aad (already set)
724 * plaintext
725 */
726 cose_encrypt0_set_key(cose, snd_ctx->sender_key);
727 cose_encrypt0_set_plaintext(cose, plain_pdu->token, plain_pdu->used_size);
728 dump_cose(cose, "Pre encrypt");
729 ciphertext_buffer =
730 coap_malloc_type(COAP_OSCORE_BUF, OSCORE_CRYPTO_BUFFER_SIZE);
731 if (ciphertext_buffer == NULL)
732 goto error;
733 ciphertext_len = cose_encrypt0_encrypt(cose,
734 ciphertext_buffer,
735 plain_pdu->used_size + AES_CCM_TAG);
736 if ((int)ciphertext_len <= 0) {
737 coap_log_warn("OSCORE: Encryption Failure, result code: %d \n",
738 (int)ciphertext_len);
739 goto error;
740 }
741 assert(ciphertext_len < OSCORE_CRYPTO_BUFFER_SIZE);
742
743 /* Add in OSCORE option (previously computed) */
744 if (!coap_insert_option(osc_pdu,
745 COAP_OPTION_OSCORE,
746 oscore_option_len,
747 oscore_option))
748 goto error;
749
750 /* Add now encrypted payload */
751 if (!coap_add_data(osc_pdu, ciphertext_len, ciphertext_buffer))
752 goto error;
753
754 coap_free_type(COAP_OSCORE_BUF, ciphertext_buffer);
755 ciphertext_buffer = NULL;
756
757 coap_delete_pdu_lkd(plain_pdu);
758 plain_pdu = NULL;
759
760 if (association && association->is_observe == 0)
761 oscore_delete_association(session, association);
762 association = NULL;
763
764 if (!coap_pdu_encode_header(osc_pdu, session->proto)) {
765 goto error;
766 }
767
768 /*
769 * Set up an association for handling a response if this is a request
770 */
771 if (coap_request) {
772 association = oscore_find_association(session, &pdu_token);
773 if (association) {
774 /* Refresh the association */
775 coap_delete_bin_const(association->nonce);
776 association->nonce =
777 coap_new_bin_const(cose->nonce.s, cose->nonce.length);
778 if (association->nonce == NULL)
779 goto error;
780 coap_delete_bin_const(association->aad);
781 association->aad = coap_new_bin_const(cose->aad.s, cose->aad.length);
782 if (association->aad == NULL)
783 goto error;
784 if (doing_observe && observe_value == 1) {
785 coap_delete_bin_const(association->obs_partial_iv);
786 association->obs_partial_iv = association->partial_iv;
787 } else {
788 coap_delete_bin_const(association->partial_iv);
789 }
790 association->partial_iv =
791 coap_new_bin_const(cose->partial_iv.s, cose->partial_iv.length);
792 if (association->partial_iv == NULL)
793 goto error;
794 coap_oscore_association_set_recipient_ctx(association, rcp_ctx);
795 coap_delete_pdu_lkd(association->sent_pdu);
796 if (session->b_2_step != COAP_OSCORE_B_2_NONE || association->just_set_up) {
797 size_t size;
798
799 association->sent_pdu = coap_pdu_duplicate_lkd(pdu, session,
800 pdu_token.length,
801 pdu_token.s, NULL,
802 COAP_BOOL_FALSE);
803 if (association->sent_pdu == NULL)
804 goto error;
805 if (coap_get_data(pdu, &size, &data)) {
806 coap_add_data(association->sent_pdu, size, data);
807 }
808 association->just_set_up = 0;
809 } else {
810 association->sent_pdu = NULL;
811 }
812 } else if (!oscore_new_association(session,
813 pdu,
814 &pdu_token,
815 rcp_ctx,
816 &cose->aad,
817 &cose->nonce,
818 &cose->partial_iv,
819 doing_observe)) {
820 goto error;
821 }
822 }
823 return osc_pdu;
824
825error:
826 if (ciphertext_buffer)
827 coap_free_type(COAP_OSCORE_BUF, ciphertext_buffer);
828 coap_delete_pdu_lkd(osc_pdu);
829 coap_delete_pdu_lkd(plain_pdu);
830 return NULL;
831}
832
833static void
834build_and_send_error_pdu(coap_session_t *session,
835 coap_pdu_t *rcvd,
836 coap_pdu_code_t code,
837 const char *diagnostic,
838 uint8_t *echo_data,
839 coap_bin_const_t *kid_context,
840 int encrypt_oscore) {
841 coap_pdu_t *err_pdu = NULL;
842 coap_bin_const_t token;
843 int oscore_encryption = session->oscore_encryption;
844 unsigned char buf[4];
845
846 token = coap_pdu_get_token(rcvd);
847 err_pdu = coap_pdu_init(rcvd->type == COAP_MESSAGE_NON ? COAP_MESSAGE_NON :
848 COAP_MESSAGE_ACK,
849 code,
850 rcvd->mid,
851 token.length + 2 + 8 +
852 (diagnostic ? strlen(diagnostic) : 0));
853 if (!err_pdu)
854 return;
855 coap_add_token(err_pdu, token.length, token.s);
856 if (echo_data) {
857 coap_add_option_internal(err_pdu, COAP_OPTION_ECHO, 8, echo_data);
858 } else if (kid_context == NULL) {
859 coap_add_option_internal(err_pdu,
860 COAP_OPTION_MAXAGE,
861 coap_encode_var_safe(buf, sizeof(buf), 0),
862 buf);
863 }
864 if (diagnostic)
865 coap_add_data(err_pdu, strlen(diagnostic), (const uint8_t *)diagnostic);
866 session->oscore_encryption = encrypt_oscore;
867
868 if ((echo_data || kid_context) && encrypt_oscore) {
869 coap_pdu_t *osc_pdu;
870
871 osc_pdu =
872 coap_oscore_new_pdu_encrypted_lkd(session, err_pdu, kid_context,
873 echo_data ? 1 : 0);
874 if (!osc_pdu)
875 goto fail_resp;
876 session->oscore_encryption = 0;
877 coap_send_internal(session, osc_pdu, NULL);
878 coap_delete_pdu_lkd(err_pdu);
879 err_pdu = NULL;
880 } else {
881 coap_send_internal(session, err_pdu, NULL);
882 err_pdu = NULL;
883 }
884fail_resp:
885 session->oscore_encryption = oscore_encryption;
886 coap_delete_pdu_lkd(err_pdu);
887 return;
888}
889
890oscore_ctx_t *
891coap_init_oscore_context_from_conf(coap_oscore_conf_t *oscore_conf) {
892 oscore_ctx_t *oscore_ctx = oscore_derive_ctx_from_conf(oscore_conf);
893
894 if (oscore_ctx == NULL) {
895 goto error;
896 }
897
898 /* As all is stored in osc_ctx, oscore_conf is no longer needed */
899 coap_free_type(COAP_STRING, oscore_conf);
900
901 return oscore_ctx;
902error:
903 coap_delete_oscore_conf(oscore_conf);
904 return NULL;
905}
906
907/* pdu contains incoming message with encrypted COSE ciphertext payload
908 * function returns decrypted message
909 * and verifies signature, if present
910 * returns NULL when decryption,verification fails
911 */
912coap_pdu_t *
913coap_oscore_decrypt_pdu(coap_session_t *session,
914 coap_pdu_t *pdu) {
915 coap_pdu_t *decrypt_pdu = NULL;
916 coap_pdu_t *plain_pdu = NULL;
917 const uint8_t *osc_value; /* value of OSCORE option */
918 uint8_t osc_size; /* size of OSCORE OPTION */
919 coap_opt_iterator_t opt_iter;
920 coap_opt_t *opt = NULL;
921 cose_encrypt0_t cose[1];
922 oscore_ctx_t *osc_ctx = NULL;
923 uint8_t aad_buffer[AAD_BUF_LEN];
924 uint8_t nonce_buffer[13];
925 coap_bin_const_t aad;
926 coap_bin_const_t nonce;
927 int pltxt_size = 0;
928 int got_resp_piv = 0;
929 int doing_resp_observe = 0;
930 uint8_t coap_request = COAP_PDU_IS_REQUEST(pdu);
931 coap_bin_const_t pdu_token;
932 uint8_t *st_encrypt;
933 size_t encrypt_len;
934 size_t tag_len;
935 oscore_recipient_ctx_t *rcp_ctx = NULL;
936 oscore_association_t *association = NULL;
937 uint8_t external_aad_buffer[100];
938 coap_bin_const_t external_aad;
939 oscore_sender_ctx_t *snd_ctx = NULL;
940#if COAP_CLIENT_SUPPORT
941 coap_pdu_t *sent_pdu = NULL;
942#endif /* COAP_CLIENT_SUPPORT */
943
944 opt = coap_check_option(pdu, COAP_OPTION_OSCORE, &opt_iter);
945 assert(opt);
946 if (opt == NULL)
947 return NULL;
948
949 if (session->context->p_osc_ctx == NULL && session->context->oscore_find_cb == NULL) {
950 coap_log_warn("OSCORE: Not enabled\n");
951 if (!coap_request)
952 coap_handle_event_lkd(session->context,
953 COAP_EVENT_OSCORE_NOT_ENABLED,
954 session);
955 return NULL;
956 }
957
958 if (pdu->data == NULL) {
959 coap_log_warn("OSCORE: No protected payload\n");
960 if (!coap_request)
961 coap_handle_event_lkd(session->context,
962 COAP_EVENT_OSCORE_NO_PROTECTED_PAYLOAD,
963 session);
964 return NULL;
965 }
966
967 osc_size = coap_opt_length(opt);
968 osc_value = coap_opt_value(opt);
969
970 cose_encrypt0_init(cose); /* clear cose memory */
971
972 /* PDU code will be filled in after decryption */
973 decrypt_pdu =
974 coap_pdu_init(pdu->type, 0, pdu->mid, pdu->used_size);
975 if (decrypt_pdu == NULL) {
976 if (!coap_request)
977 coap_handle_event_lkd(session->context,
978 COAP_EVENT_OSCORE_INTERNAL_ERROR,
979 session);
980 goto error;
981 }
982
983 /* Copy across the Token */
984 pdu_token = coap_pdu_get_token(pdu);
985 coap_add_token(decrypt_pdu, pdu_token.length, pdu_token.s);
986
987 /*
988 * 8.2/8.4 Step 1.
989 * Copy outer options across, except E and OSCORE options
990 */
991 coap_option_iterator_init(pdu, &opt_iter, COAP_OPT_ALL);
992 while ((opt = coap_option_next(&opt_iter))) {
993 switch ((coap_code_opt_num_t)opt_iter.number) {
994 /* 'E' options skipped */
995 case COAP_OPTION_IF_MATCH:
996 case COAP_OPTION_ETAG:
997 case COAP_OPTION_IF_NONE_MATCH:
998 case COAP_OPTION_OBSERVE:
999 case COAP_OPTION_LOCATION_PATH:
1000 case COAP_OPTION_URI_PATH:
1001 case COAP_OPTION_URI_PATH_ABB:
1002 case COAP_OPTION_CONTENT_FORMAT:
1003 case COAP_OPTION_MAXAGE:
1004 case COAP_OPTION_URI_QUERY:
1005 case COAP_OPTION_ACCEPT:
1006 case COAP_OPTION_Q_BLOCK1:
1007 case COAP_OPTION_LOCATION_QUERY:
1008 case COAP_OPTION_BLOCK2:
1009 case COAP_OPTION_BLOCK1:
1010 case COAP_OPTION_SIZE2:
1011 case COAP_OPTION_Q_BLOCK2:
1012 case COAP_OPTION_SIZE1:
1013 case COAP_OPTION_NORESPONSE:
1014 case COAP_OPTION_ECHO:
1015 case COAP_OPTION_RTAG:
1016 /* OSCORE does not get copied across */
1017 case COAP_OPTION_OSCORE:
1018 break;
1019 /* 'U' options included */
1020 case COAP_OPTION_URI_HOST:
1021 case COAP_OPTION_URI_PORT:
1022 case COAP_OPTION_HOP_LIMIT:
1023 case COAP_OPTION_EDHOC:
1024 case COAP_OPTION_PROXY_URI:
1025 case COAP_OPTION_PROXY_SCHEME:
1026 default:
1027 if (!coap_add_option_internal(decrypt_pdu,
1028 opt_iter.number,
1029 coap_opt_length(opt),
1030 coap_opt_value(opt))) {
1031 if (!coap_request)
1032 coap_handle_event_lkd(session->context,
1033 COAP_EVENT_OSCORE_INTERNAL_ERROR,
1034 session);
1035 goto error;
1036 }
1037 break;
1038 }
1039 }
1040
1041 if (coap_request) {
1042 uint64_t incoming_seq;
1043 /*
1044 * 8.2 Step 2
1045 * Decompress COSE object
1046 * Get Recipient Context based on kid and optional kid_context
1047 */
1048 if (oscore_decode_option_value(osc_value, osc_size, cose) == 0) {
1049 coap_log_warn("OSCORE: OSCORE Option cannot be decoded.\n");
1050 build_and_send_error_pdu(session,
1051 pdu,
1052 COAP_RESPONSE_CODE(402),
1053 "Failed to decode COSE",
1054 NULL,
1055 NULL,
1056 0);
1057 goto error_no_ack;
1058 }
1059 osc_ctx = oscore_find_context(session,
1060 cose->key_id,
1061 &cose->kid_context,
1062 NULL,
1063 &rcp_ctx);
1064 if (!osc_ctx) {
1065 if (cose->kid_context.length > 0) {
1066 const uint8_t *ptr;
1067 size_t length;
1068 /* Appendix B.2 protocol check - Is the recipient key_id known */
1069 osc_ctx = oscore_find_context(session,
1070 cose->key_id,
1071 NULL,
1072 session->oscore_r2 != 0 ? (uint8_t *)&session->oscore_r2 : NULL,
1073 &rcp_ctx);
1074 ptr = cose->kid_context.s;
1075 length = cose->kid_context.length;
1076 if (ptr && osc_ctx && osc_ctx->rfc8613_b_2) {
1077 /* Processing Appendix B.2 protocol */
1078 /* Need to CBOR unwrap kid_context */
1079 coap_bin_const_t kid_context;
1080
1081 kid_context.length = oscore_cbor_get_element_size(&ptr, &length);
1082 if (kid_context.length > length)
1083 goto error;
1084 /* This has to fit into an OSCORE option max 255.
1085 * Initial byte, kid_context size, partial IV size and kid size have to be there
1086 */
1087 if (kid_context.length >= 255 - 1 - 1 - cose->partial_iv.length - cose->key_id.length)
1088 goto error;
1089 kid_context.s = ptr;
1090 cose_encrypt0_set_kid_context(cose, (coap_bin_const_t *)&kid_context);
1091
1092 if (session->oscore_r2 != 0) {
1093 /* B.2 step 4 */
1094 coap_bin_const_t *kc = coap_new_bin_const(cose->kid_context.s,
1095 cose->kid_context.length);
1096
1097 if (kc == NULL)
1098 goto error;
1099
1100 session->b_2_step = COAP_OSCORE_B_2_STEP_4;
1101 coap_log_oscore("Appendix B.2 server step 4 (R2 || R3)\n");
1102 oscore_update_ctx(osc_ctx, kc);
1103 } else {
1104 session->b_2_step = COAP_OSCORE_B_2_STEP_2;
1105 coap_log_oscore("Appendix B.2 server step 2 (ID1)\n");
1106 osc_ctx = oscore_duplicate_ctx(session->context,
1107 osc_ctx,
1108 osc_ctx->sender_context->sender_id,
1109 &cose->key_id,
1110 &cose->kid_context);
1111 if (osc_ctx == NULL)
1112 goto error;
1113 /*
1114 * Complete the Verify (B.2 step 2)
1115 * before sending back the response
1116 */
1117 rcp_ctx = osc_ctx->recipient_chain;
1118 }
1119 } else {
1120 osc_ctx = NULL;
1121 }
1122 }
1123 } else if (session->b_2_step != COAP_OSCORE_B_2_NONE) {
1124 session->b_2_step = COAP_OSCORE_B_2_NONE;
1125 coap_log_oscore("Appendix B.2 server finished\n");
1126 }
1127 if (!osc_ctx) {
1128 coap_log_err("OSCORE: Security Context not found\n");
1129 oscore_log_hex_value(COAP_LOG_OSCORE, "key_id", &cose->key_id);
1130 oscore_log_hex_value(COAP_LOG_OSCORE, "kid_context", &cose->kid_context);
1131 build_and_send_error_pdu(session,
1132 pdu,
1133 COAP_RESPONSE_CODE(401),
1134 "Security context not found",
1135 NULL,
1136 NULL,
1137 0);
1138 goto error_no_ack;
1139 }
1140 /* to be used for encryption of returned response later */
1141 coap_oscore_session_set_recipient_ctx(session, rcp_ctx);
1142 snd_ctx = osc_ctx->sender_context;
1143
1144 /*
1145 * 8.2 Step 3.
1146 * Verify Partial IV is not duplicated.
1147 *
1148 * Requires in COSE object as appropriate
1149 * partial_iv (as received)
1150 */
1151 if ((rcp_ctx->initial_state == 0 || osc_ctx->rfc8613_b_1_2 == 0) &&
1152 !oscore_validate_sender_seq(rcp_ctx, cose)) {
1153 coap_log_warn("OSCORE: Replayed or old message\n");
1154 build_and_send_error_pdu(session,
1155 pdu,
1156 COAP_RESPONSE_CODE(401),
1157 "Replay detected",
1158 NULL,
1159 NULL,
1160 0);
1161 goto error_no_ack;
1162 }
1163 if (rcp_ctx->initial_state == 1) {
1164 incoming_seq =
1165 coap_decode_var_bytes8(cose->partial_iv.s, cose->partial_iv.length);
1166 rcp_ctx->last_seq = incoming_seq;
1167 } else if (session->context->oscore_update_seq_num_cb != NULL) {
1168 /* notify custom credential storage */
1169 coap_lock_callback(session->context->oscore_update_seq_num_cb(session,
1170 rcp_ctx->recipient_id,
1171 osc_ctx->id_context,
1172 rcp_ctx->last_seq,
1173 rcp_ctx->sliding_window));
1174 }
1175 } else { /* !coap_request */
1176 /*
1177 * 8.4 Step 2
1178 * Decompress COSE object
1179 * Get Recipient Context based on token
1180 */
1181 if (oscore_decode_option_value(osc_value, osc_size, cose) == 0) {
1182 coap_log_warn("OSCORE: OSCORE Option cannot be decoded.\n");
1183 coap_handle_event_lkd(session->context,
1184 COAP_EVENT_OSCORE_DECODE_ERROR,
1185 session);
1186 goto error;
1187 }
1188 got_resp_piv = cose->partial_iv.length ? 1 : 0;
1189
1190 association = oscore_find_association(session, &pdu_token);
1191 if (association) {
1192 rcp_ctx = association->recipient_ctx;
1193 osc_ctx = rcp_ctx->osc_ctx;
1194 snd_ctx = osc_ctx->sender_context;
1195#if COAP_CLIENT_SUPPORT
1196 sent_pdu = association->sent_pdu;
1197 if (session->b_2_step != COAP_OSCORE_B_2_NONE) {
1198 const uint8_t *ptr = cose->kid_context.s;
1199 size_t length = cose->kid_context.length;
1200
1201 if (ptr) {
1202 /* Need to CBOR unwrap kid_context */
1203 coap_bin_const_t kid_context;
1204
1205 kid_context.length = oscore_cbor_get_element_size(&ptr, &length);
1206 if (kid_context.length > length)
1207 goto error;
1208 /* This has to fit into an OSCORE option max 255.
1209 * Initial byte, kid_context size, partial IV size and kid size have to be there
1210 */
1211 if (kid_context.length >= 255 - 1 - 1 - cose->partial_iv.length - cose->key_id.length)
1212 goto error;
1213 kid_context.s = ptr;
1214 cose_encrypt0_set_kid_context(cose, &kid_context);
1215 }
1216 if (ptr && !coap_binary_equal(osc_ctx->id_context, &cose->kid_context)) {
1217 /* If Appendix B.2 step 3 is in operation */
1218 /* Need to update Security Context with new (R2 || ID1) ID Context */
1219 coap_binary_t *kc = coap_new_binary(cose->kid_context.length +
1220 osc_ctx->id_context->length);
1221
1222 if (kc == NULL) {
1223 coap_handle_event_lkd(session->context,
1224 COAP_EVENT_OSCORE_INTERNAL_ERROR,
1225 session);
1226 goto error;
1227 }
1228
1229 memcpy(kc->s, cose->kid_context.s, cose->kid_context.length);
1230 memcpy(&kc->s[cose->kid_context.length],
1231 osc_ctx->id_context->s,
1232 osc_ctx->id_context->length);
1233
1234 session->b_2_step = COAP_OSCORE_B_2_STEP_3;
1235 coap_log_oscore("Appendix B.2 client step 3 (R2 || ID1)\n");
1236 oscore_update_ctx(osc_ctx, (coap_bin_const_t *)kc);
1237 } else {
1238 session->b_2_step = COAP_OSCORE_B_2_STEP_5;
1239 coap_log_oscore("Appendix B.2 client step 5 (R2 || R3)\n");
1240 }
1241 }
1242#endif /* COAP_CLIENT_SUPPORT */
1243 } else {
1244 coap_log_crit("OSCORE: Security Context association not found\n");
1245 coap_handle_event_lkd(session->context,
1246 COAP_EVENT_OSCORE_NO_SECURITY,
1247 session);
1248 goto error;
1249 }
1250 }
1251
1252 cose_encrypt0_set_alg(cose, osc_ctx->aead_alg);
1253
1254 if (coap_request) {
1255 /*
1256 * RFC8613 8.2 Step 4.
1257 * Compose the External AAD and then AAD
1258 *
1259 * OSCORE_option requires
1260 * partial_iv (cose partial_iv)
1261 * kid_context (cose kid_context)
1262 * key_id (cose key_id)
1263 * group_flag
1264 *
1265 * Non Group requires the following
1266 * RFC8613 5.4
1267 * oscore_version 1
1268 * algorithms [
1269 * aead_alg (osc_ctx)
1270 * ]
1271 * request_kid (request key_id using cose)
1272 * request_piv (request partial_iv using cose)
1273 * options (none at present)
1274 *
1275 * Note: No I options at present
1276 */
1277
1278 /* External AAD */
1279 external_aad.s = external_aad_buffer;
1280 external_aad.length = oscore_prepare_e_aad(osc_ctx,
1281 cose,
1282 osc_value,
1283 osc_size,
1284 NULL,
1285 external_aad_buffer,
1286 sizeof(external_aad_buffer));
1287 if (external_aad.length == 0)
1288 goto error;
1289 cose_encrypt0_set_external_aad(cose, &external_aad);
1290
1291 /* AAD */
1292 aad.s = aad_buffer;
1293 aad.length = oscore_prepare_aad(external_aad_buffer,
1294 external_aad.length,
1295 aad_buffer,
1296 sizeof(aad_buffer));
1297 if (aad.length == 0)
1298 goto error;
1299 assert(aad.length < AAD_BUF_LEN);
1300 cose_encrypt0_set_aad(cose, &aad);
1301
1302 /*
1303 * RFC8613 8.2 Step 5.
1304 * Compute the AEAD nonce.
1305 *
1306 * Requires in COSE object as appropriate
1307 * key_id (kid) (Recipient ID)
1308 * partial_iv (as received in request)
1309 * common_iv (already in osc_ctx)
1310 */
1311 nonce.s = nonce_buffer;
1312 nonce.length = 13;
1313 oscore_generate_nonce(cose, osc_ctx, nonce_buffer, 13);
1314 cose_encrypt0_set_nonce(cose, &nonce);
1315 /*
1316 * Set up an association for use in the response
1317 */
1318 association = oscore_find_association(session, &pdu_token);
1319 if (association) {
1320 /* Refresh the association */
1321 coap_delete_bin_const(association->nonce);
1322 association->nonce =
1323 coap_new_bin_const(cose->nonce.s, cose->nonce.length);
1324 if (association->nonce == NULL)
1325 goto error;
1326 coap_delete_bin_const(association->partial_iv);
1327 association->partial_iv =
1328 coap_new_bin_const(cose->partial_iv.s, cose->partial_iv.length);
1329 if (association->partial_iv == NULL)
1330 goto error;
1331 coap_delete_bin_const(association->aad);
1332 association->aad = coap_new_bin_const(cose->aad.s, cose->aad.length);
1333 if (association->aad == NULL)
1334 goto error;
1335 coap_oscore_association_set_recipient_ctx(association, rcp_ctx);
1336 /* So association is not released when handling decrypt */
1337 association = NULL;
1338 } else if (!oscore_new_association(session,
1339 NULL,
1340 &pdu_token,
1341 rcp_ctx,
1342 &cose->aad,
1343 &cose->nonce,
1344 &cose->partial_iv,
1345 0)) {
1346 goto error;
1347 }
1348 /* So association is not released when handling decrypt */
1349 association = NULL;
1350 } else { /* ! coap_request */
1351 /* Need to do nonce before AAD because of different partial_iv */
1352 /*
1353 * 8.4 Step 4.
1354 * Compose the AEAD nonce.
1355 */
1356 cose_encrypt0_set_key_id(cose, rcp_ctx->recipient_id);
1357 if (cose->partial_iv.length == 0) {
1358 cose_encrypt0_set_partial_iv(cose, association->partial_iv);
1359 cose_encrypt0_set_nonce(cose, association->nonce);
1360 } else {
1361 uint64_t last_seq;
1362
1363 if ((rcp_ctx->initial_state == 0 || osc_ctx->rfc8613_b_1_2 == 0) &&
1364 !oscore_validate_sender_seq(rcp_ctx, cose)) {
1365 coap_log_warn("OSCORE: Replayed or old message\n");
1366 goto error;
1367 }
1368 last_seq =
1369 coap_decode_var_bytes8(cose->partial_iv.s, cose->partial_iv.length);
1370 if (rcp_ctx->last_seq>= OSCORE_SEQ_MAX) {
1371 coap_log_warn("OSCORE Replay protection, SEQ larger than SEQ_MAX.\n");
1372 goto error;
1373 }
1374 if (last_seq > rcp_ctx->last_seq)
1375 rcp_ctx->last_seq = last_seq;
1376 /*
1377 * Requires in COSE object as appropriate
1378 * kid (set above)
1379 * partial_iv (as received)
1380 * common_iv (already in osc_ctx)
1381 */
1382 oscore_generate_nonce(cose, osc_ctx, nonce_buffer, 13);
1383 nonce.s = nonce_buffer;
1384 nonce.length = 13;
1385 cose_encrypt0_set_nonce(cose, &nonce);
1386 }
1387#ifdef OSCORE_EXTRA_DEBUG
1388 dump_cose(cose, "!req post set nonce");
1389#endif /* OSCORE_EXTRA_DEBUG */
1390 /*
1391 * 8.4 Step 3.
1392 * Compose the External AAD and then AAD
1393 *
1394 * OSCORE_option requires
1395 * partial_iv (cose partial_iv)
1396 * kid_context (cose kid_context)
1397 * key_id (cose key_id)
1398 * group_flag
1399 *
1400 * Non Group requires the following
1401 * RFC8613 5.4
1402 * oscore_version 1
1403 * algorithms [
1404 * aead_alg (osc_ctx)
1405 * ]
1406 * request_kid (request key_id using cose)
1407 * request_piv (request partial_iv using cose)
1408 * options (none at present)
1409 *
1410 * Note: No I options at present
1411 */
1412
1413 /* External AAD */
1414 cose_encrypt0_set_key_id(cose, snd_ctx->sender_id);
1415 if (association->is_observe && association->obs_partial_iv && got_resp_piv) {
1416 cose_encrypt0_set_partial_iv(cose, association->obs_partial_iv);
1417 } else {
1418 cose_encrypt0_set_partial_iv(cose, association->partial_iv);
1419 }
1420#ifdef OSCORE_EXTRA_DEBUG
1421 dump_cose(cose, "!req pre aad");
1422#endif /* OSCORE_EXTRA_DEBUG */
1423 external_aad.s = external_aad_buffer;
1424 external_aad.length = oscore_prepare_e_aad(osc_ctx,
1425 cose,
1426 NULL,
1427 0,
1428 NULL,
1429 external_aad_buffer,
1430 sizeof(external_aad_buffer));
1431 if (external_aad.length == 0)
1432 goto error;
1433 cose_encrypt0_set_external_aad(cose, &external_aad);
1434
1435 /* AAD */
1436 aad.s = aad_buffer;
1437 aad.length = oscore_prepare_aad(external_aad_buffer,
1438 external_aad.length,
1439 aad_buffer,
1440 sizeof(aad_buffer));
1441 if (aad.length == 0)
1442 goto error;
1443 assert(aad.length < AAD_BUF_LEN);
1444 cose_encrypt0_set_aad(cose, &aad);
1445#ifdef OSCORE_EXTRA_DEBUG
1446 dump_cose(cose, "!req post set aad");
1447#endif /* OSCORE_EXTRA_DEBUG */
1448 }
1449
1450 /*
1451 * 8.2 Step 6 / 8.4 Step 5.
1452 * Decrypt the COSE object.
1453 *
1454 * Requires in COSE object as appropriate
1455 * alg (already set)
1456 * key
1457 * nonce (already set)
1458 * aad (already set)
1459 * ciphertext
1460 */
1461 st_encrypt = pdu->data;
1462 encrypt_len = pdu->used_size - (pdu->data - pdu->token);
1463 if (encrypt_len <= 0) {
1464 coap_log_warn("OSCORE: No protected payload\n");
1465 if (!coap_request)
1466 coap_handle_event_lkd(session->context,
1467 COAP_EVENT_OSCORE_NO_PROTECTED_PAYLOAD,
1468 session);
1469 goto error;
1470 }
1471 cose_encrypt0_set_key(cose, rcp_ctx->recipient_key);
1472 cose_encrypt0_set_ciphertext(cose, st_encrypt, encrypt_len);
1473
1474 tag_len = cose_tag_len(cose->alg);
1475 /* Decrypt into plain_pdu, so code (token), options and data are in place */
1476 plain_pdu = coap_pdu_init(pdu->type, 0, 0, encrypt_len /* - tag_len */);
1477 if (plain_pdu == NULL) {
1478 if (!coap_request)
1479 coap_handle_event_lkd(session->context,
1480 COAP_EVENT_OSCORE_INTERNAL_ERROR,
1481 session);
1482 goto error;
1483 }
1484
1485 /* need the tag_len on the end for TinyDTLS to do its work - yuk */
1486 if (!coap_pdu_resize(plain_pdu, encrypt_len /* - tag_len */)) {
1487 if (!coap_request)
1488 coap_handle_event_lkd(session->context,
1489 COAP_EVENT_OSCORE_INTERNAL_ERROR,
1490 session);
1491 goto error;
1492 }
1493
1494 /* Account for 1 byte 'code' used as token */
1495 plain_pdu->e_token_length = 1;
1496 plain_pdu->actual_token.length = 1;
1497 /* Account for the decrypted data */
1498 plain_pdu->used_size = encrypt_len - tag_len;
1499
1500 dump_cose(cose, "Pre decrypt");
1501 pltxt_size =
1502 cose_encrypt0_decrypt(cose, plain_pdu->token, encrypt_len - tag_len);
1503 if (pltxt_size <= 0) {
1504 coap_log_warn("OSCORE: Decryption Failure, result code: %d \n",
1505 (int)pltxt_size);
1506 if (coap_request) {
1507 build_and_send_error_pdu(session,
1508 pdu,
1509 COAP_RESPONSE_CODE(400),
1510 "Decryption failed",
1511 NULL,
1512 NULL,
1513 0);
1514 oscore_roll_back_seq(rcp_ctx);
1515 goto error_no_ack;
1516 } else {
1517 coap_handle_event_lkd(session->context,
1518 COAP_EVENT_OSCORE_DECRYPTION_FAILURE,
1519 session);
1520 }
1521 goto error;
1522 }
1523
1524 assert((size_t)pltxt_size < pdu->alloc_size + pdu->max_hdr_size);
1525
1526 /* Appendix B.2 Trap */
1527 if (session->b_2_step == COAP_OSCORE_B_2_STEP_2) {
1528 /* Need to update Security Context with new (R2 || ID1) ID Context */
1529 coap_binary_t *kc =
1530 coap_new_binary(sizeof(session->oscore_r2) + cose->kid_context.length);
1531 coap_bin_const_t oscore_r2;
1532
1533 if (kc == NULL) {
1534 if (!coap_request)
1535 coap_handle_event_lkd(session->context,
1536 COAP_EVENT_OSCORE_INTERNAL_ERROR,
1537 session);
1538 goto error;
1539 }
1540
1541 coap_prng_lkd(&session->oscore_r2, sizeof(session->oscore_r2));
1542 memcpy(kc->s, &session->oscore_r2, sizeof(session->oscore_r2));
1543 memcpy(&kc->s[sizeof(session->oscore_r2)],
1544 cose->kid_context.s,
1545 cose->kid_context.length);
1546
1547 coap_log_oscore("Appendix B.2 server step 2 (R2 || ID1)\n");
1548 oscore_update_ctx(osc_ctx, (coap_bin_const_t *)kc);
1549
1550 oscore_r2.length = sizeof(session->oscore_r2);
1551 oscore_r2.s = (const uint8_t *)&session->oscore_r2;
1552 coap_log_oscore("Appendix B.2 server step 2 plain response\n");
1553 build_and_send_error_pdu(session,
1554 pdu,
1555 COAP_RESPONSE_CODE(401),
1556 NULL,
1557 NULL,
1558 &oscore_r2,
1559 1);
1560 goto error_no_ack;
1561 }
1562#if COAP_CLIENT_SUPPORT
1563 if (session->b_2_step == COAP_OSCORE_B_2_STEP_3) {
1564 coap_log_oscore("Appendix B.2 client step 3 (R2 || R3)\n");
1565 coap_pdu_encode_header(plain_pdu, session->proto);
1566 plain_pdu->actual_token.s = plain_pdu->token;
1567 plain_pdu->code = plain_pdu->token[0];
1568 if (plain_pdu->code != COAP_RESPONSE_CODE(401)) {
1569 coap_log_warn("OSCORE Appendix B.2: Expected 4.01 response\n");
1570 }
1571 /* Skip the options */
1572 coap_option_iterator_init(plain_pdu, &opt_iter, COAP_OPT_ALL);
1573 while (coap_option_next(&opt_iter)) {
1574 }
1575 if (opt_iter.length > 0 && opt_iter.next_option &&
1576 opt_iter.next_option[0] == COAP_PAYLOAD_START) {
1577 plain_pdu->data = &opt_iter.next_option[1];
1578 }
1579 coap_log_oscore("Inner Response PDU (plaintext)\n");
1580 coap_show_pdu(COAP_LOG_OSCORE, plain_pdu);
1581 /*
1582 * Need to update Security Context with new (R2 || R3) ID Context
1583 * and retransmit the request
1584 */
1585 coap_binary_t *kc = coap_new_binary(cose->kid_context.length + 8);
1586
1587 if (kc == NULL) {
1588 if (!coap_request)
1589 coap_handle_event_lkd(session->context,
1590 COAP_EVENT_OSCORE_INTERNAL_ERROR,
1591 session);
1592 goto error;
1593 }
1594 memcpy(kc->s, cose->kid_context.s, cose->kid_context.length);
1595 coap_prng_lkd(&kc->s[cose->kid_context.length], 8);
1596
1597 oscore_update_ctx(osc_ctx, (coap_bin_const_t *)kc);
1598
1599 coap_cancel_all_messages(session->context,
1600 session,
1601 &pdu->actual_token);
1602 if (session->con_active)
1603 session->con_active--;
1604 coap_send_ack_lkd(session, pdu);
1605 if (sent_pdu) {
1606 coap_log_oscore("Appendix B.2 retransmit pdu\n");
1607 if (!session->b_2_retransmit_token) {
1608 session->b_2_retransmit_token = coap_new_str_const(sent_pdu->actual_token.s,
1609 sent_pdu->actual_token.length);
1610 }
1611 if (coap_retransmit_oscore_pdu(session, sent_pdu, NULL) ==
1612 COAP_INVALID_MID)
1613 goto error_no_ack;
1614 }
1615 goto error_no_ack;
1616 }
1617#endif /* COAP_CLIENT_SUPPORT */
1618
1619#if COAP_SERVER_SUPPORT
1620 /* Appendix B.1.2 request Trap */
1621 if (coap_request && osc_ctx->rfc8613_b_1_2) {
1622 if (rcp_ctx->initial_state == 1) {
1623 opt = coap_check_option(plain_pdu, COAP_OPTION_ECHO, &opt_iter);
1624 if (opt) {
1625 /* Verify Client is genuine */
1626 if (coap_opt_length(opt) == 8 &&
1627 memcmp(coap_opt_value(opt), rcp_ctx->echo_value, 8) == 0) {
1628 /* This clears rcp_ctx->initial_state */
1629 if (!oscore_validate_sender_seq(rcp_ctx, cose)) {
1630 coap_log_warn("OSCORE: Replayed or old message\n");
1631 build_and_send_error_pdu(session,
1632 pdu,
1633 COAP_RESPONSE_CODE(401),
1634 "Replay detected",
1635 NULL,
1636 NULL,
1637 0);
1638 goto error_no_ack;
1639 } else {
1640 if (session->context->oscore_update_seq_num_cb != NULL) {
1641 /* notify echo challenge changed */
1642 coap_lock_callback(session->context->oscore_update_seq_num_cb(session,
1643 rcp_ctx->recipient_id,
1644 osc_ctx->id_context,
1645 rcp_ctx->last_seq,
1646 rcp_ctx->sliding_window));
1647 }
1648 }
1649 } else
1650 goto error;
1651 } else {
1652 /* RFC 8163 Appendix B.1.2 */
1653 if (session->b_2_step == COAP_OSCORE_B_2_STEP_4) {
1654 session->b_2_step = COAP_OSCORE_B_2_NONE;
1655 coap_log_oscore("Appendix B.2 server finished\n");
1656 }
1657 coap_prng_lkd(rcp_ctx->echo_value, sizeof(rcp_ctx->echo_value));
1658 coap_log_oscore("Appendix B.1.2 server plain response\n");
1659
1660 build_and_send_error_pdu(session,
1661 pdu,
1662 COAP_RESPONSE_CODE(401),
1663 NULL,
1664 rcp_ctx->echo_value,
1665 NULL,
1666 1);
1667 goto error_no_ack;
1668 }
1669 }
1670 }
1671#endif /* COAP_SERVER_SUPPORT */
1672
1673 /*
1674 * 8.2 Step 7 / 8.4 Step 6.
1675 * Add decrypted Code, options and payload
1676 * [OSCORE option not copied across previously]
1677 */
1678
1679 /* PDU code is pseudo plain_pdu token */
1680 decrypt_pdu->code = plain_pdu->token[0];
1681
1682 /* Copy inner decrypted options across */
1683 coap_option_iterator_init(plain_pdu, &opt_iter, COAP_OPT_ALL);
1684 while ((opt = coap_option_next(&opt_iter))) {
1685 size_t len;
1686 size_t bias;
1687
1688 switch (opt_iter.number) {
1689 case COAP_OPTION_OSCORE:
1690 break;
1691 case COAP_OPTION_OBSERVE:
1692 if (!coap_request) {
1693 bias = cose->partial_iv.length > 3 ? cose->partial_iv.length - 3 : 0;
1694 len = cose->partial_iv.length > 3 ? 3 : cose->partial_iv.length;
1695 /* Make Observe option reflect last 3 bytes of partial_iv */
1696 if (!coap_add_option_internal(
1697 decrypt_pdu,
1698 opt_iter.number,
1699 len,
1700 cose->partial_iv.s ? &cose->partial_iv.s[bias] : NULL)) {
1701 coap_handle_event_lkd(session->context,
1702 COAP_EVENT_OSCORE_INTERNAL_ERROR,
1703 session);
1704 goto error;
1705 }
1706 doing_resp_observe = 1;
1707 break;
1708 }
1709 association = oscore_find_association(session, &pdu_token);
1710 if (association) {
1711 association->is_observe = 1;
1712 association = NULL;
1713 }
1714 /* Fall Through */
1715 default:
1716 if (!coap_insert_option(decrypt_pdu,
1717 opt_iter.number,
1718 coap_opt_length(opt),
1719 coap_opt_value(opt))) {
1720 if (!coap_request)
1721 coap_handle_event_lkd(session->context,
1722 COAP_EVENT_OSCORE_INTERNAL_ERROR,
1723 session);
1724 goto error;
1725 }
1726 break;
1727 }
1728 }
1729 if (!coap_request && !doing_resp_observe) {
1730 if (association) {
1731 association->is_observe = 0;
1732 }
1733 }
1734 /* Need to copy across any data */
1735 if (opt_iter.length > 0 && opt_iter.next_option &&
1736 opt_iter.next_option[0] == COAP_PAYLOAD_START) {
1737 plain_pdu->data = &opt_iter.next_option[1];
1738 if (!coap_add_data(decrypt_pdu,
1739 plain_pdu->used_size -
1740 (plain_pdu->data - plain_pdu->token),
1741 plain_pdu->data)) {
1742 if (!coap_request)
1743 coap_handle_event_lkd(session->context,
1744 COAP_EVENT_OSCORE_INTERNAL_ERROR,
1745 session);
1746 goto error;
1747 }
1748 }
1749 coap_delete_pdu_lkd(plain_pdu);
1750 plain_pdu = NULL;
1751
1752 /* Make sure headers are correctly set up */
1753 if (!coap_pdu_encode_header(decrypt_pdu, session->proto)) {
1754 if (!coap_request)
1755 coap_handle_event_lkd(session->context,
1756 COAP_EVENT_OSCORE_INTERNAL_ERROR,
1757 session);
1758 goto error;
1759 }
1760
1761 if (session->b_2_step != COAP_OSCORE_B_2_NONE) {
1762 session->b_2_step = COAP_OSCORE_B_2_NONE;
1763 coap_log_oscore("Appendix B.2 client finished\n");
1764 if (session->b_2_retransmit_token) {
1765 coap_update_token(decrypt_pdu, session->b_2_retransmit_token->length,
1766 session->b_2_retransmit_token->s);
1767 coap_delete_str_const(session->b_2_retransmit_token);
1768 session->b_2_retransmit_token = NULL;
1769 }
1770 }
1771#if COAP_CLIENT_SUPPORT
1772 if (decrypt_pdu->code == COAP_RESPONSE_CODE(401) &&
1773 (opt = coap_check_option(decrypt_pdu, COAP_OPTION_ECHO, &opt_iter))) {
1774 /* Server is requesting Echo refresh check */
1775 coap_cancel_all_messages(session->context,
1776 session,
1777 &pdu->actual_token);
1778 if (session->con_active)
1779 session->con_active--;
1780 if (!sent_pdu) {
1781 coap_lg_crcv_t *lg_crcv = coap_find_lg_crcv(session, pdu);
1782
1783 if (lg_crcv)
1784 sent_pdu = lg_crcv->sent_pdu;
1785 }
1786 if (sent_pdu) {
1787 coap_send_ack_lkd(session, pdu);
1788 coap_log_debug("PDU requesting re-transmit\n");
1789 coap_show_pdu(COAP_LOG_DEBUG, decrypt_pdu);
1790 coap_log_oscore("RFC9175 retransmit pdu\n");
1791 /* Do not care if this fails */
1792 if (coap_retransmit_oscore_pdu(session, sent_pdu, opt) != COAP_INVALID_MID) {
1793 session->doing_b_1_2 = 1;
1794 }
1795 goto error_no_ack;
1796 }
1797 } else if (session->doing_b_1_2) {
1798 coap_lg_crcv_t *lg_crcv = coap_find_lg_crcv(session, pdu);
1799
1800 if (lg_crcv) {
1801 if (!coap_binary_equal(&decrypt_pdu->actual_token, lg_crcv->app_token)) {
1802 coap_update_token(decrypt_pdu, lg_crcv->app_token->length, lg_crcv->app_token->s);
1803 }
1804 }
1805 session->doing_b_1_2 = 0;
1806 }
1807#endif /* COAP_CLIENT_SUPPORT */
1808 if (association && association->is_observe == 0)
1809 oscore_delete_association(session, association);
1810 return decrypt_pdu;
1811
1812error:
1813 coap_send_ack_lkd(session, pdu);
1814error_no_ack:
1815 if (association && association->is_observe == 0)
1816 oscore_delete_association(session, association);
1817 coap_delete_pdu_lkd(decrypt_pdu);
1818 coap_delete_pdu_lkd(plain_pdu);
1819 return NULL;
1820}
1821
1822typedef enum {
1823 COAP_ENC_ASCII = 0x001,
1824 COAP_ENC_HEX = 0x002,
1825 COAP_ENC_CONFIG = 0x0200,
1826 COAP_ENC_INTEGER = 0x400,
1827 COAP_ENC_TEXT = 0x800,
1828 COAP_ENC_BOOL = 0x1000,
1829 COAP_ENC_UNSIGNED64 = 0x2000,
1830 COAP_ENC_LAST
1831} coap_oscore_coding_t;
1832
1833#undef TEXT_MAPPING
1834#define TEXT_MAPPING(t, v) \
1835 { { sizeof(#t)-1, (const uint8_t *)#t }, v }
1836
1837static struct coap_oscore_encoding_t {
1838 coap_str_const_t name;
1839 coap_oscore_coding_t encoding;
1840} oscore_encoding[] = {
1841 TEXT_MAPPING(ascii, COAP_ENC_ASCII),
1842 TEXT_MAPPING(hex, COAP_ENC_HEX),
1843 TEXT_MAPPING(config, COAP_ENC_CONFIG),
1844 TEXT_MAPPING(integer, COAP_ENC_INTEGER),
1845 TEXT_MAPPING(unsigned64, COAP_ENC_UNSIGNED64),
1846 TEXT_MAPPING(text, COAP_ENC_TEXT),
1847 TEXT_MAPPING(bool, COAP_ENC_BOOL),
1848 {{0, NULL}, COAP_ENC_LAST}
1849};
1850
1851typedef struct {
1852 coap_oscore_coding_t encoding;
1853 const char *encoding_name;
1854 union {
1855 int value_int;
1856 uint64_t value_int64;
1857 coap_bin_const_t *value_bin;
1858 coap_str_const_t value_str;
1859 } u;
1860} oscore_value_t;
1861
1862/*
1863 * Return 1 if hex character
1864 * 0 not hex character
1865 */
1866static int
1867hex_to_char(char c, uint8_t *value) {
1868 if ('a' <= c && c <= 'f') {
1869 *value = c - 'a' + 10;
1870 } else if ('A' <= c && c <= 'F') {
1871 *value = c - 'A' + 10;
1872 } else if ('0' <= c && c <= '9') {
1873 *value = c - '0';
1874 } else {
1875 *value = 0;
1876 return 0;
1877 }
1878 return 1;
1879}
1880
1881/* Parse the hex into binary */
1882static coap_bin_const_t *
1883parse_hex_bin(const char *begin, const char *end) {
1884 coap_binary_t *binary = NULL;
1885 size_t i;
1886 size_t o = 0;
1887
1888 binary = coap_new_binary((end - begin) / 2);
1889 if (binary == NULL)
1890 goto bad_entry;
1891 for (i = 0; (i < (size_t)(end - begin)); i++) {
1892 while ((i < (size_t)(end - begin)) &&
1893 (begin[i] == '\r' || begin[i] == '\n' || begin[i] == ' ')) {
1894 i++;
1895 }
1896 if (i == (size_t)(end - begin))
1897 break;
1898 if (isxdigit((uint8_t)begin[i])) {
1899 uint8_t value;
1900
1901 if (!hex_to_char(begin[i], &value)) {
1902 goto bad_entry;
1903 }
1904 binary->s[o] = value << 4;
1905 i++;
1906 while ((i < (size_t)(end - begin)) &&
1907 (begin[i] == '\r' || begin[i] == '\n' || begin[i] == ' ')) {
1908 i++;
1909 }
1910 if (i == (size_t)(end - begin))
1911 goto bad_entry;
1912 if (!hex_to_char(begin[i], &value)) {
1913 goto bad_entry;
1914 }
1915 binary->s[o++] += value;
1916 } else {
1917 break;
1918 }
1919 }
1920 if (i != (size_t)(end - begin))
1921 goto bad_entry;
1922 return (coap_bin_const_t *)binary;
1923
1924bad_entry:
1925 coap_delete_binary(binary);
1926 return NULL;
1927}
1928
1929/*
1930 * Break up each OSCORE Configuration line entry into the 3 parts which
1931 * are comma separated
1932 *
1933 * keyword,encoding,value
1934 */
1935static int
1936get_split_entry(const char **start,
1937 size_t size,
1938 coap_str_const_t *keyword,
1939 oscore_value_t *value,
1940 cose_curve_t sign_curve) {
1941 const char *begin = *start;
1942 const char *keep_start = *start;
1943 const char *end;
1944 const char *kend;
1945 const char *tend;
1946 const char *split;
1947 size_t i;
1948 size_t len;
1949 (void)sign_curve;
1950
1951retry:
1952 kend = end = memchr(begin, '\n', size);
1953 if (end == NULL)
1954 return 0;
1955
1956 /* Check for multi-line */
1957 if ((tend = memchr(begin, '"', end - begin))) {
1958 /* See if " terminator is on the same line */
1959 if (!memchr(tend + 1, '"', end - tend -1)) {
1960 /* Over multiple lines */
1961 kend = end = memchr(end, '"', size - (end - begin));
1962 if (end == NULL)
1963 return 0;
1964 kend = end = memchr(kend, '\n', size - (kend - begin));
1965 if (end == NULL)
1966 return 0;
1967 }
1968 }
1969
1970 /* Track beginning of next line */
1971 *start = end + 1;
1972 if (end > begin && end[-1] == '\r')
1973 end--;
1974
1975 if (begin[0] == '#' || (end - begin) == 0) {
1976 /* Skip comment / blank line */
1977 size -= kend - begin + 1;
1978 begin = *start;
1979 keep_start = *start;
1980 goto retry;
1981 }
1982
1983 /* Get in the keyword */
1984 split = memchr(begin, ',', end - begin);
1985 if (split == NULL)
1986 goto bad_entry;
1987
1988 keyword->s = (const uint8_t *)begin;
1989 keyword->length = split - begin;
1990
1991 begin = split + 1;
1992 if ((end - begin) == 0)
1993 goto bad_entry;
1994 /* Get in the encoding */
1995 split = memchr(begin, ',', end - begin);
1996 if (split == NULL)
1997 goto bad_entry;
1998
1999 for (i = 0; oscore_encoding[i].name.s; i++) {
2000 coap_str_const_t temp = { split - begin, (const uint8_t *)begin };
2001
2002 if (coap_string_equal(&temp, &oscore_encoding[i].name)) {
2003 value->encoding = oscore_encoding[i].encoding;
2004 value->encoding_name = (const char *)oscore_encoding[i].name.s;
2005 break;
2006 }
2007 }
2008 if (oscore_encoding[i].name.s == NULL)
2009 goto bad_entry;
2010
2011 begin = split + 1;
2012 if ((end - begin) == 0)
2013 goto bad_entry;
2014 /* Get in the keyword's value */
2015 if (value->encoding == COAP_ENC_CONFIG && begin[0] == '\'') {
2016 split = memchr(&begin[1], '\'', size - (begin - keep_start) - 1);
2017 if (split == NULL)
2018 goto bad_entry;
2019 end = memchr(split, '\n', size - (split - keep_start));
2020 if (end == NULL)
2021 return 0;
2022 *start = end + 1;
2023 end = split;
2024 begin++;
2025 } else {
2026 if (begin[0] == '"') {
2027 split = memchr(&begin[1], '"', end - split - 1);
2028 if (split == NULL)
2029 goto bad_entry;
2030 end = split;
2031 begin++;
2032 }
2033 }
2034 switch (value->encoding) {
2035 case COAP_ENC_CONFIG:
2036 case COAP_ENC_ASCII:
2037 value->u.value_bin =
2038 coap_new_bin_const((const uint8_t *)begin, end - begin);
2039 if (value->u.value_bin == NULL)
2040 goto bad_entry;
2041 break;
2042 case COAP_ENC_HEX:
2043 /* Parse the hex into binary */
2044 value->u.value_bin = parse_hex_bin(begin, end);
2045 if (value->u.value_bin == NULL)
2046 goto bad_entry;
2047 break;
2048 case COAP_ENC_INTEGER:
2049 value->u.value_int = atoi(begin);
2050 break;
2051 case COAP_ENC_UNSIGNED64: {
2052 value->u.value_int64 = strtoull(begin, NULL, 10);
2053 break;
2054 }
2055 case COAP_ENC_TEXT:
2056 value->u.value_str.s = (const uint8_t *)begin;
2057 value->u.value_str.length = end - begin;
2058 break;
2059 case COAP_ENC_BOOL:
2060 len = (size_t)(end - begin);
2061 if (len == 4 && memcmp("true", begin, len) == 0)
2062 value->u.value_int = 1;
2063 else if (len == 5 && memcmp("false", begin, len) == 0)
2064 value->u.value_int = 0;
2065 else
2066 goto bad_entry;
2067 break;
2068 case COAP_ENC_LAST:
2069 default:
2070 goto bad_entry;
2071 }
2072 return 1;
2073
2074bad_entry:
2075 coap_log_warn("oscore_conf: Unrecognized configuration entry '%.*s'\n",
2076 (int)(end - begin),
2077 begin);
2078 return -1;
2079
2080}
2081
2082#undef CONFIG_ENTRY
2083#define CONFIG_ENTRY(n, e, t) \
2084 { { sizeof(#n)-1, (const uint8_t *)#n }, e, \
2085 offsetof(coap_oscore_conf_t, n), t }
2086
2087#undef CONFIG_SND_ENTRY
2088#define CONFIG_SND_ENTRY(n, e, t) \
2089 { { sizeof(#n)-1, (const uint8_t *)#n }, e, \
2090 offsetof(coap_oscore_snd_conf_t, n), t }
2091
2092#undef CONFIG_RCP_ENTRY
2093#define CONFIG_RCP_ENTRY(n, e, t) \
2094 { { sizeof(#n)-1, (const uint8_t *)#n }, e, \
2095 offsetof(coap_oscore_rcp_conf_t, n), t }
2096
2097#undef CONFIG_DUMMY_ENTRY
2098#define CONFIG_DUMMY_ENTRY(n, e, t) \
2099 { { sizeof(#n)-1, (const uint8_t *)#n }, e, 0, t }
2100
2101typedef struct oscore_text_mapping_t {
2102 coap_str_const_t text;
2103 int value;
2104} oscore_text_mapping_t;
2105
2106/* Naming as per https://www.iana.org/assignments/cose/cose.xhtml#algorithms */
2107static oscore_text_mapping_t text_aead_alg[] = {
2108 TEXT_MAPPING(AES-CCM-16-64-128, COSE_ALGORITHM_AES_CCM_16_64_128),
2109 TEXT_MAPPING(AES-CCM-16-64-256, COSE_ALGORITHM_AES_CCM_16_64_256),
2110 {{0, NULL}, 0}
2111};
2112
2113static oscore_text_mapping_t text_hkdf_alg[] = {
2114 TEXT_MAPPING(direct+HKDF-SHA-256, COSE_HKDF_ALG_HKDF_SHA_256),
2115 {{0, NULL}, 0}
2116};
2117
2118typedef struct oscore_config_t {
2119 coap_str_const_t str_keyword;
2120 coap_oscore_coding_t encoding;
2121 size_t offset;
2122 oscore_text_mapping_t *text_mapping;
2123} oscore_config_t;
2124
2125static oscore_config_t oscore_config[] = {
2126 CONFIG_ENTRY(aead_alg, COAP_ENC_INTEGER | COAP_ENC_TEXT, text_aead_alg),
2127 CONFIG_ENTRY(hkdf_alg, COAP_ENC_INTEGER | COAP_ENC_TEXT, text_hkdf_alg),
2128 CONFIG_ENTRY(master_secret, COAP_ENC_HEX | COAP_ENC_ASCII, NULL),
2129 CONFIG_ENTRY(master_salt, COAP_ENC_HEX | COAP_ENC_ASCII, NULL),
2130 CONFIG_ENTRY(id_context, COAP_ENC_HEX | COAP_ENC_ASCII, NULL),
2131
2132 CONFIG_DUMMY_ENTRY(sender_id, COAP_ENC_HEX | COAP_ENC_ASCII, NULL),
2133
2134 CONFIG_DUMMY_ENTRY(recipient_id, COAP_ENC_HEX | COAP_ENC_ASCII, NULL),
2135
2136 CONFIG_ENTRY(replay_window, COAP_ENC_INTEGER, NULL),
2137 CONFIG_ENTRY(ssn_freq, COAP_ENC_INTEGER, NULL),
2138 CONFIG_ENTRY(rfc8613_b_1_2, COAP_ENC_BOOL, NULL),
2139 CONFIG_ENTRY(rfc8613_b_2, COAP_ENC_BOOL, NULL),
2140 CONFIG_ENTRY(break_sender_key, COAP_ENC_BOOL, NULL),
2141 CONFIG_ENTRY(break_recipient_key, COAP_ENC_BOOL, NULL),
2142 CONFIG_DUMMY_ENTRY(complex_sender, COAP_ENC_CONFIG, NULL),
2143 CONFIG_DUMMY_ENTRY(complex_recipient, COAP_ENC_CONFIG, NULL),
2144};
2145
2146static oscore_config_t oscore_snd_config[] = {
2147 CONFIG_SND_ENTRY(sender_id, COAP_ENC_HEX | COAP_ENC_ASCII, NULL),
2148};
2149
2150static oscore_config_t oscore_rcp_config[] = {
2151 CONFIG_RCP_ENTRY(recipient_id, COAP_ENC_HEX | COAP_ENC_ASCII, NULL),
2152 CONFIG_RCP_ENTRY(silent_server, COAP_ENC_BOOL, NULL),
2153 CONFIG_DUMMY_ENTRY(last_seq, COAP_ENC_UNSIGNED64, NULL),
2154 CONFIG_DUMMY_ENTRY(sliding_window, COAP_ENC_UNSIGNED64, NULL),
2155};
2156
2157
2158int
2159coap_delete_oscore_snd_conf(coap_oscore_snd_conf_t *snd_conf) {
2160 if (snd_conf == NULL)
2161 return 0;
2162
2163 coap_delete_bin_const(snd_conf->sender_id);
2164 coap_free_type(COAP_STRING, snd_conf);
2165 return 1;
2166}
2167
2168int
2169coap_delete_oscore_rcp_conf(coap_oscore_rcp_conf_t *rcp_conf) {
2170 if (rcp_conf == NULL)
2171 return 0;
2172
2173 coap_delete_bin_const(rcp_conf->recipient_id);
2174 coap_free_type(COAP_STRING, rcp_conf);
2175 return 1;
2176}
2177
2178int
2179coap_delete_oscore_conf(coap_oscore_conf_t *oscore_conf) {
2180 coap_oscore_rcp_conf_t *rcp_conf;
2181 if (oscore_conf == NULL)
2182 return 0;
2183
2184 coap_delete_bin_const(oscore_conf->master_secret);
2185 coap_delete_bin_const(oscore_conf->master_salt);
2186 coap_delete_bin_const(oscore_conf->id_context);
2187 coap_delete_oscore_snd_conf(oscore_conf->sender);
2188
2189 rcp_conf = oscore_conf->recipient_chain;
2190 while (rcp_conf) {
2191 coap_oscore_rcp_conf_t *rcp_next = rcp_conf->next_recipient;
2192
2193 coap_delete_oscore_rcp_conf(rcp_conf);
2194 rcp_conf = rcp_next;
2195 }
2196
2197 coap_free_type(COAP_STRING, oscore_conf);
2198 return 1;
2199}
2200
2201static coap_oscore_snd_conf_t *
2202coap_parse_oscore_snd_conf_mem(coap_bin_const_t conf_mem) {
2203 const char *start = (const char *)conf_mem.s;
2204 const char *end = start + conf_mem.length;
2205 coap_str_const_t keyword;
2206 oscore_value_t value;
2207 coap_oscore_snd_conf_t *snd_conf;
2208
2209 snd_conf = coap_malloc_type(COAP_STRING, sizeof(coap_oscore_snd_conf_t));
2210 if (snd_conf == NULL)
2211 return NULL;
2212 memset(snd_conf, 0, sizeof(coap_oscore_snd_conf_t));
2213
2214 memset(&value, 0, sizeof(value));
2215
2216 while (end > start &&
2217 get_split_entry(&start, end - start, &keyword, &value, 0) > 0) {
2218 size_t i;
2219 size_t j;
2220
2221 for (i = 0; i < sizeof(oscore_snd_config) / sizeof(oscore_snd_config[0]); i++) {
2222 if (coap_string_equal(&oscore_snd_config[i].str_keyword, &keyword) != 0 &&
2223 value.encoding & oscore_snd_config[i].encoding) {
2224 coap_bin_const_t *unused_check;
2225
2226 switch (value.encoding) {
2227 case COAP_ENC_HEX:
2228 case COAP_ENC_ASCII:
2229 memcpy(&unused_check,
2230 &(((char *)snd_conf)[oscore_snd_config[i].offset]),
2231 sizeof(unused_check));
2232 if (unused_check != NULL) {
2233 coap_log_warn("oscore_snd_conf: Keyword '%.*s' duplicated\n",
2234 (int)keyword.length,
2235 (const char *)keyword.s);
2236 coap_delete_bin_const(value.u.value_bin);
2237 goto error;
2238 }
2239 memcpy(&(((char *)snd_conf)[oscore_snd_config[i].offset]),
2240 &value.u.value_bin,
2241 sizeof(value.u.value_bin));
2242 break;
2243 case COAP_ENC_INTEGER:
2244 case COAP_ENC_BOOL:
2245 memcpy(&(((char *)snd_conf)[oscore_snd_config[i].offset]),
2246 &value.u.value_int,
2247 sizeof(value.u.value_int));
2248 break;
2249 case COAP_ENC_TEXT:
2250 for (j = 0; oscore_snd_config[i].text_mapping[j].text.s != NULL; j++) {
2251 if (memcmp(value.u.value_str.s,
2252 oscore_snd_config[i].text_mapping[j].text.s,
2253 value.u.value_str.length) == 0) {
2254 memcpy(&(((char *)snd_conf)[oscore_snd_config[i].offset]),
2255 &oscore_snd_config[i].text_mapping[j].value,
2256 sizeof(oscore_snd_config[i].text_mapping[j].value));
2257 break;
2258 }
2259 }
2260 if (oscore_snd_config[i].text_mapping[j].text.s == NULL) {
2261 coap_log_warn("oscore_snd_conf: Keyword '%.*s': value '%.*s' unknown\n",
2262 (int)keyword.length,
2263 (const char *)keyword.s,
2264 (int)value.u.value_str.length,
2265 (const char *)value.u.value_str.s);
2266 goto error;
2267 }
2268 break;
2269 case COAP_ENC_CONFIG:
2270 case COAP_ENC_UNSIGNED64:
2271 case COAP_ENC_LAST:
2272 default:
2273 assert(0);
2274 break;
2275 }
2276 break;
2277 }
2278 }
2279 if (i == sizeof(oscore_snd_config) / sizeof(oscore_snd_config[0])) {
2280 coap_log_warn("oscore_snd_conf: Keyword '%.*s', type '%s' unknown\n",
2281 (int)keyword.length,
2282 (const char *)keyword.s,
2283 value.encoding_name);
2284 if (value.encoding == COAP_ENC_HEX || value.encoding == COAP_ENC_ASCII ||
2285 value.encoding == COAP_ENC_CONFIG)
2286 coap_delete_bin_const(value.u.value_bin);
2287 goto error;
2288 }
2289 }
2290 if (!snd_conf->sender_id) {
2291 coap_log_warn("oscore_snd_conf: sender_id not defined\n");
2292 goto error;
2293 }
2294 if (snd_conf->sender_id->length > 7) {
2295 coap_log_warn("oscore_snd_conf: Maximum size of sender_id is 7 bytes\n");
2296 goto error;
2297 }
2298 return snd_conf;
2299
2300error:
2301 coap_delete_oscore_snd_conf(snd_conf);
2302 return NULL;
2303}
2304
2305static coap_oscore_rcp_conf_t *
2306coap_parse_oscore_rcp_conf_mem(coap_bin_const_t conf_mem) {
2307 const char *start = (const char *)conf_mem.s;
2308 const char *end = start + conf_mem.length;
2309 coap_str_const_t keyword;
2310 oscore_value_t value;
2311 coap_oscore_rcp_conf_t *rcp_conf;
2312
2313 rcp_conf = coap_malloc_type(COAP_STRING, sizeof(coap_oscore_rcp_conf_t));
2314 if (rcp_conf == NULL)
2315 return NULL;
2316 memset(rcp_conf, 0, sizeof(coap_oscore_rcp_conf_t));
2317
2318 memset(&value, 0, sizeof(value));
2319
2320 while (end > start &&
2321 get_split_entry(&start, end - start, &keyword, &value, 0) > 0) {
2322 size_t i;
2323 size_t j;
2324
2325 for (i = 0; i < sizeof(oscore_rcp_config) / sizeof(oscore_rcp_config[0]); i++) {
2326 if (coap_string_equal(&oscore_rcp_config[i].str_keyword, &keyword) != 0 &&
2327 value.encoding & oscore_rcp_config[i].encoding) {
2328 if (coap_string_equal(coap_make_str_const("last_seq"), &keyword)) {
2329 rcp_conf->last_seq = value.u.value_int64;
2330 rcp_conf->window_initialized = 1;
2331 } else if (coap_string_equal(coap_make_str_const("sliding_window"), &keyword)) {
2332 rcp_conf->sliding_window = value.u.value_int64;
2333 rcp_conf->window_initialized = 1;
2334 } else {
2335 coap_bin_const_t *unused_check;
2336
2337 switch (value.encoding) {
2338 case COAP_ENC_HEX:
2339 case COAP_ENC_ASCII:
2340 memcpy(&unused_check,
2341 &(((char *)rcp_conf)[oscore_rcp_config[i].offset]),
2342 sizeof(unused_check));
2343 if (unused_check != NULL) {
2344 coap_log_warn("oscore_rcp_conf: Keyword '%.*s' duplicated\n",
2345 (int)keyword.length,
2346 (const char *)keyword.s);
2347 coap_delete_bin_const(value.u.value_bin);
2348 goto error;
2349 }
2350 memcpy(&(((char *)rcp_conf)[oscore_rcp_config[i].offset]),
2351 &value.u.value_bin,
2352 sizeof(value.u.value_bin));
2353 break;
2354 case COAP_ENC_INTEGER:
2355 case COAP_ENC_BOOL:
2356 memcpy(&(((char *)rcp_conf)[oscore_rcp_config[i].offset]),
2357 &value.u.value_int,
2358 sizeof(value.u.value_int));
2359 break;
2360 case COAP_ENC_TEXT:
2361 for (j = 0; oscore_rcp_config[i].text_mapping[j].text.s != NULL; j++) {
2362 if (memcmp(value.u.value_str.s,
2363 oscore_rcp_config[i].text_mapping[j].text.s,
2364 value.u.value_str.length) == 0) {
2365 memcpy(&(((char *)rcp_conf)[oscore_rcp_config[i].offset]),
2366 &oscore_rcp_config[i].text_mapping[j].value,
2367 sizeof(oscore_rcp_config[i].text_mapping[j].value));
2368 break;
2369 }
2370 }
2371 if (oscore_rcp_config[i].text_mapping[j].text.s == NULL) {
2372 coap_log_warn("oscore_rcp_conf: Keyword '%.*s': value '%.*s' unknown\n",
2373 (int)keyword.length,
2374 (const char *)keyword.s,
2375 (int)value.u.value_str.length,
2376 (const char *)value.u.value_str.s);
2377 goto error;
2378 }
2379 break;
2380 case COAP_ENC_CONFIG:
2381 case COAP_ENC_UNSIGNED64:
2382 case COAP_ENC_LAST:
2383 default:
2384 assert(0);
2385 break;
2386 }
2387 }
2388 break;
2389 }
2390 }
2391 if (i == sizeof(oscore_rcp_config) / sizeof(oscore_rcp_config[0])) {
2392 coap_log_warn("oscore_rcp_conf: Keyword '%.*s', type '%s' unknown\n",
2393 (int)keyword.length,
2394 (const char *)keyword.s,
2395 value.encoding_name);
2396 if (value.encoding == COAP_ENC_HEX || value.encoding == COAP_ENC_ASCII ||
2397 value.encoding == COAP_ENC_CONFIG)
2398 coap_delete_bin_const(value.u.value_bin);
2399 goto error;
2400 }
2401 }
2402 if (!rcp_conf->recipient_id) {
2403 coap_log_warn("oscore_rcp_conf: recipient_id not defined\n");
2404 goto error;
2405 }
2406 if (rcp_conf->recipient_id->length > 7) {
2407 coap_log_warn("oscore_rcp_conf: Maximum size of recipient_id is 7 bytes\n");
2408 goto error;
2409 }
2410 return rcp_conf;
2411
2412error:
2413 coap_delete_oscore_rcp_conf(rcp_conf);
2414 return NULL;
2415}
2416
2417static coap_oscore_conf_t *
2418coap_parse_oscore_conf_mem(coap_str_const_t conf_mem) {
2419 const char *start = (const char *)conf_mem.s;
2420 const char *end = start + conf_mem.length;
2421 coap_str_const_t keyword;
2422 oscore_value_t value;
2423 coap_oscore_conf_t *oscore_conf;
2424 int split_ok = -1;
2425
2426 oscore_conf = coap_malloc_type(COAP_STRING, sizeof(coap_oscore_conf_t));
2427 if (oscore_conf == NULL)
2428 return NULL;
2429 memset(oscore_conf, 0, sizeof(coap_oscore_conf_t));
2430
2431 memset(&value, 0, sizeof(value));
2432 /* Preset with defaults RFC8612 3.2 */
2433 oscore_conf->replay_window = COAP_OSCORE_DEFAULT_REPLAY_WINDOW;
2434 oscore_conf->ssn_freq = 1;
2435 oscore_conf->aead_alg = COSE_ALGORITHM_AES_CCM_16_64_128;
2436 oscore_conf->hkdf_alg = COSE_HKDF_ALG_HKDF_SHA_256;
2437
2438 oscore_conf->rfc8613_b_1_2 = 1;
2439 oscore_conf->rfc8613_b_2 = 0;
2440 /* For debugging only */
2441 oscore_conf->break_sender_key = 0;
2442 oscore_conf->break_recipient_key = 0;
2443
2444 while (end > start &&
2445 (split_ok = get_split_entry(&start, end - start, &keyword, &value, 0)) > 0) {
2446 size_t i;
2447 size_t j;
2448
2449 for (i = 0; i < sizeof(oscore_config) / sizeof(oscore_config[0]); i++) {
2450 if (coap_string_equal(&oscore_config[i].str_keyword, &keyword) != 0 &&
2451 value.encoding & oscore_config[i].encoding) {
2452 if (coap_string_equal(coap_make_str_const("sender_id"), &keyword)) {
2453 if (value.u.value_bin->length > 7) {
2454 coap_log_warn("oscore_conf: Maximum size of sender_id is 7 bytes\n");
2455 goto error_free_value_bin;
2456 }
2457 if (oscore_conf->sender) {
2458 coap_log_warn("oscore_conf: sender_id duplicated\n");
2459 goto error_free_value_bin;
2460 }
2461 oscore_conf->sender = coap_malloc_type(COAP_STRING, sizeof(coap_oscore_snd_conf_t));
2462 if (!oscore_conf->sender)
2463 goto error_free_value_bin;
2464
2465 memset(oscore_conf->sender, 0, sizeof(coap_oscore_snd_conf_t));
2466 oscore_conf->sender->sender_id = value.u.value_bin;
2467 } else if (coap_string_equal(coap_make_str_const("recipient_id"), &keyword)) {
2468 coap_oscore_rcp_conf_t *rcp_conf;
2469
2470 if (value.u.value_bin->length > 7) {
2471 coap_log_warn("oscore_conf: Maximum size of recipient_id is 7 bytes\n");
2472 goto error_free_value_bin;
2473 }
2474 /* Special case as there are potentially multiple entries */
2475 rcp_conf = coap_malloc_type(COAP_STRING, sizeof(coap_oscore_rcp_conf_t));
2476 if (!rcp_conf)
2477 goto error_free_value_bin;
2478
2479 memset(rcp_conf, 0, sizeof(coap_oscore_rcp_conf_t));
2480 rcp_conf->recipient_id = value.u.value_bin;
2481 rcp_conf->next_recipient = oscore_conf->recipient_chain;
2482 oscore_conf->recipient_chain = rcp_conf;
2483 } else {
2484 coap_bin_const_t *unused_check;
2485
2486 switch (value.encoding) {
2487 case COAP_ENC_CONFIG:
2488 if (keyword.length == sizeof("complex_sender") - 1 &&
2489 memcmp(keyword.s, "complex_sender", keyword.length) == 0) {
2490 coap_oscore_snd_conf_t *snd_conf =
2491 coap_parse_oscore_snd_conf_mem(*value.u.value_bin);
2492
2493 if (!snd_conf) {
2494 coap_log_warn("oscore_conf: Keyword '%.*s' invalid\n",
2495 (int)keyword.length,
2496 (const char *)keyword.s);
2497 goto error_free_value_bin;
2498 }
2499 if (oscore_conf->sender) {
2500 coap_log_warn("oscore_conf: complex_sender duplicated\n");
2501 coap_delete_oscore_snd_conf(snd_conf);
2502 goto error_free_value_bin;
2503 }
2504 oscore_conf->sender = snd_conf;
2505 coap_delete_bin_const(value.u.value_bin);
2506 break;
2507 }
2508 if (keyword.length == sizeof("complex_recipient") - 1 &&
2509 memcmp(keyword.s, "complex_recipient", keyword.length) == 0) {
2510 coap_oscore_rcp_conf_t *rcp_conf =
2511 coap_parse_oscore_rcp_conf_mem(*value.u.value_bin);
2512
2513 if (!rcp_conf) {
2514 coap_log_warn("oscore_conf: Keyword '%.*s' invalid\n",
2515 (int)keyword.length,
2516 (const char *)keyword.s);
2517 goto error_free_value_bin;
2518 }
2519 rcp_conf->next_recipient = oscore_conf->recipient_chain;
2520 oscore_conf->recipient_chain = rcp_conf;
2521 coap_delete_bin_const(value.u.value_bin);
2522 }
2523 break;
2524 case COAP_ENC_ASCII:
2525 case COAP_ENC_HEX:
2526 memcpy(&unused_check,
2527 &(((char *)oscore_conf)[oscore_config[i].offset]),
2528 sizeof(unused_check));
2529 if (unused_check != NULL) {
2530 coap_log_warn("oscore_conf: Keyword '%.*s' duplicated\n",
2531 (int)keyword.length,
2532 (const char *)keyword.s);
2533 goto error_free_value_bin;
2534 }
2535 memcpy(&(((char *)oscore_conf)[oscore_config[i].offset]),
2536 &value.u.value_bin,
2537 sizeof(value.u.value_bin));
2538 break;
2539 case COAP_ENC_INTEGER:
2540 case COAP_ENC_BOOL:
2541 memcpy(&(((char *)oscore_conf)[oscore_config[i].offset]),
2542 &value.u.value_int,
2543 sizeof(value.u.value_int));
2544 break;
2545 case COAP_ENC_TEXT:
2546 for (j = 0; oscore_config[i].text_mapping[j].text.s != NULL; j++) {
2547 if (coap_string_equal(&value.u.value_str,
2548 &oscore_config[i].text_mapping[j].text)) {
2549 memcpy(&(((char *)oscore_conf)[oscore_config[i].offset]),
2550 &oscore_config[i].text_mapping[j].value,
2551 sizeof(oscore_config[i].text_mapping[j].value));
2552 break;
2553 }
2554 }
2555 if (oscore_config[i].text_mapping[j].text.s == NULL) {
2556 coap_log_warn("oscore_conf: Keyword '%.*s': value '%.*s' unknown\n",
2557 (int)keyword.length,
2558 (const char *)keyword.s,
2559 (int)value.u.value_str.length,
2560 (const char *)value.u.value_str.s);
2561 goto error;
2562 }
2563 break;
2564 case COAP_ENC_UNSIGNED64:
2565 case COAP_ENC_LAST:
2566 default:
2567 assert(0);
2568 break;
2569 }
2570 }
2571 break;
2572 }
2573 }
2574 if (i == sizeof(oscore_config) / sizeof(oscore_config[0])) {
2575 coap_log_warn("oscore_conf: Keyword '%.*s', type '%s' unknown\n",
2576 (int)keyword.length,
2577 (const char *)keyword.s,
2578 value.encoding_name);
2579 if (value.encoding == COAP_ENC_HEX || value.encoding == COAP_ENC_ASCII ||
2580 value.encoding == COAP_ENC_CONFIG) {
2581 coap_delete_bin_const(value.u.value_bin);
2582 }
2583 goto error;
2584 }
2585 }
2586 if (split_ok == -1)
2587 goto error;
2588 if (!oscore_conf->master_secret) {
2589 coap_log_warn("oscore_conf: master_secret not defined\n");
2590 goto error;
2591 }
2592 if (!oscore_conf->sender) {
2593 coap_log_warn("oscore_conf: sender_id not defined\n");
2594 goto error;
2595 }
2596 return oscore_conf;
2597
2598error_free_value_bin:
2599 coap_delete_bin_const(value.u.value_bin);
2600error:
2601 coap_delete_oscore_conf(oscore_conf);
2602 return NULL;
2603}
2604
2605static oscore_ctx_t *
2606coap_oscore_init(coap_context_t *c_context, coap_oscore_conf_t *oscore_conf) {
2607 oscore_ctx_t *osc_ctx = NULL;
2608
2609 if (!coap_crypto_check_cipher_alg(oscore_conf->aead_alg)) {
2610 coap_log_warn("COSE: Cipher Algorithm %d not supported\n",
2611 oscore_conf->aead_alg);
2612 goto error;
2613 }
2614 if (!coap_crypto_check_hkdf_alg(oscore_conf->hkdf_alg)) {
2615 coap_log_warn("COSE: HKDF Algorithm %d not supported\n",
2616 oscore_conf->hkdf_alg);
2617 goto error;
2618 }
2619
2620 osc_ctx = oscore_derive_ctx(c_context, oscore_conf);
2621 if (!osc_ctx) {
2622 coap_log_crit("OSCORE: Could not create Security Context!\n");
2623 coap_free_type(COAP_STRING, oscore_conf);
2624 return NULL;
2625 }
2626
2627 /* As all is stored in osc_ctx, oscore_conf is no longer needed */
2628 coap_free_type(COAP_STRING, oscore_conf);
2629
2630 /* return default first context */
2631 return osc_ctx;
2632
2633error:
2634 /* Remove from linked chain */
2635 oscore_remove_context(c_context, osc_ctx);
2636
2637 coap_delete_oscore_conf(oscore_conf);
2638 return NULL;
2639}
2640
2641void
2642coap_delete_all_oscore(coap_context_t *c_context) {
2643 oscore_free_contexts(c_context);
2644}
2645
2646void
2647coap_delete_oscore_associations(coap_session_t *session) {
2648 oscore_delete_server_associations(session);
2649}
2650
2651void
2652coap_oscore_session_set_recipient_ctx(coap_session_t *session,
2653 oscore_recipient_ctx_t *recipient_ctx) {
2654 oscore_recipient_ctx_t *old_ctx;
2655
2656 if (session == NULL || recipient_ctx == NULL)
2657 return;
2658
2659 if (session->recipient_ctx == recipient_ctx) {
2660 /* already attached */
2661 return;
2662 }
2663
2664 old_ctx = session->recipient_ctx;
2665
2666 /* attach recipient context */
2667 session->recipient_ctx = recipient_ctx;
2668 session->recipient_ctx->ref++;
2669
2670 if (old_ctx != NULL) {
2671 oscore_release_recipient_ctx(&old_ctx);
2672 }
2673}
2674
2675void
2676coap_oscore_association_set_recipient_ctx(oscore_association_t *association,
2677 oscore_recipient_ctx_t *recipient_ctx) {
2678 if (association == NULL)
2679 return;
2680
2681 if (association->recipient_ctx == recipient_ctx)
2682 return;
2683
2684 if (association->recipient_ctx != NULL) {
2685 association->recipient_ctx->ref--;
2686 }
2687
2688 association->recipient_ctx = recipient_ctx;
2689 association->recipient_ctx->ref++;
2690}
2691
2692coap_oscore_conf_t *
2693coap_new_oscore_conf(coap_str_const_t conf_mem,
2694 coap_oscore_save_seq_num_t save_seq_num_func,
2695 void *save_seq_num_func_param,
2696 uint64_t start_seq_num) {
2697 coap_oscore_conf_t *oscore_conf = coap_parse_oscore_conf_mem(conf_mem);
2698
2699 if (oscore_conf == NULL)
2700 return NULL;
2701
2702 oscore_conf->save_seq_num_func = save_seq_num_func;
2703 oscore_conf->save_seq_num_func_param = save_seq_num_func_param;
2704 oscore_conf->start_seq_num = start_seq_num;
2705 coap_log_oscore("Start Seq no %" PRIu64 "\n", start_seq_num);
2706 return oscore_conf;
2707}
2708
2709/*
2710 * Compute the size of the potential OSCORE overhead
2711 */
2712size_t
2713coap_oscore_overhead(coap_session_t *session, coap_pdu_t *pdu) {
2714 size_t overhead = 0;
2715 oscore_recipient_ctx_t *rcp_ctx = session->recipient_ctx;
2716 oscore_ctx_t *osc_ctx = rcp_ctx ? rcp_ctx->osc_ctx : NULL;
2717 coap_opt_iterator_t opt_iter;
2718 coap_opt_t *option;
2719
2720 if (osc_ctx == NULL)
2721 return 0;
2722
2723 /* Protected code held in inner PDU as token */
2724 overhead += 1;
2725
2726 /* Observe option (creates inner and outer */
2727 option = coap_check_option(pdu, COAP_OPTION_OBSERVE, &opt_iter);
2728 if (option) {
2729 /* Assume delta is small */
2730 overhead += 2 + coap_opt_length(option);
2731 }
2732
2733 /* Proxy URI option Split - covered by coap_rebuild_pdu_for_proxy () */
2734
2735 /* OSCORE option */
2736 /* Option header */
2737 overhead += 1 +
2738 /* Partial IV (64 bits max)*/
2739 8 +
2740 /* kid context */
2741 (osc_ctx->id_context ? osc_ctx->id_context->length : 0) +
2742 /* kid */
2743 osc_ctx->sender_context->sender_id->length;
2744
2745 /* AAD overhead */
2746 overhead += AES_CCM_TAG;
2747
2748 /* Extended Token Overhead */
2749 if (session->max_token_size)
2750 overhead += session->max_token_size - pdu->actual_token.length;
2751
2752 /* End of options marker */
2753 overhead += 1;
2754
2755 return overhead;
2756}
2757
2758COAP_API int
2759coap_new_oscore_recipient(coap_context_t *context,
2760 coap_bin_const_t *recipient_id) {
2761 int ret;
2762
2763 coap_lock_lock(return 0);
2764 ret = coap_new_oscore_recipient_lkd(context, recipient_id);
2765 coap_lock_unlock();
2766 return ret;
2767}
2768
2769int
2770coap_new_oscore_recipient_lkd(coap_context_t *context,
2771 coap_bin_const_t *recipient_id) {
2772 coap_oscore_rcp_conf_t *rcp_conf;
2773 oscore_recipient_ctx_t *rcp_ctx;
2774
2775 coap_lock_check_locked();
2776
2777 if (context->p_osc_ctx == NULL) {
2778 coap_delete_bin_const(recipient_id);
2779 return 0;
2780 }
2781 rcp_conf = coap_malloc_type(COAP_STRING, sizeof(coap_oscore_rcp_conf_t));
2782 if (rcp_conf == NULL) {
2783 coap_delete_bin_const(recipient_id);
2784 return 0;
2785 }
2786 memset(rcp_conf, 0, sizeof(coap_oscore_rcp_conf_t));
2787 rcp_conf->recipient_id = recipient_id;
2788 /* rcp_conf is released in oscore_add_recipient() */
2789 rcp_ctx = oscore_add_recipient(context->p_osc_ctx, rcp_conf, 0);
2790 if (rcp_ctx == NULL)
2791 return 0;
2792 return 1;
2793}
2794
2795COAP_API int
2796coap_delete_oscore_recipient(coap_context_t *context,
2797 coap_bin_const_t *recipient_id) {
2798 int ret;
2799
2800 if (!context || !recipient_id)
2801 return 0;
2802 coap_lock_lock(return 0);
2803 ret = coap_delete_oscore_recipient_lkd(context, recipient_id);
2804 coap_lock_unlock();
2805 return ret;
2806}
2807
2808int
2809coap_delete_oscore_recipient_lkd(coap_context_t *context,
2810 coap_bin_const_t *recipient_id) {
2811 coap_lock_check_locked();
2812 if (context->p_osc_ctx == NULL)
2813 return 0;
2814 return oscore_delete_recipient(context->p_osc_ctx, recipient_id);
2815}
2816
2817void
2818coap_oscore_register_external_handlers(coap_context_t *context,
2819 coap_oscore_find_handler_t find_handler,
2820 coap_oscore_update_seq_num_handler_t update_seq_num_handler) {
2821 if (context == NULL)
2822 return;
2823
2824 coap_lock_lock(return);
2825 context->oscore_find_cb = find_handler;
2826 context->oscore_update_seq_num_cb = update_seq_num_handler;
2827 coap_lock_unlock();
2828}
2829
2830static coap_oscore_rcp_conf_t *
2831coap_oscore_get_recipient_conf(coap_oscore_conf_t *oscore_conf,
2832 const coap_bin_const_t *rid) {
2833 coap_oscore_rcp_conf_t *next = oscore_conf->recipient_chain;
2834
2835 while (next) {
2836 if (coap_binary_equal(next->recipient_id, rid)) {
2837 return next;
2838 }
2839 next = next->next_recipient;
2840 }
2841 return NULL;
2842}
2843
2844
2845COAP_API int
2846coap_oscore_recipient_set_latest_seq(coap_oscore_conf_t *oscore_conf,
2847 const coap_bin_const_t *recipient_id,
2848 uint64_t last_seq, uint64_t seq_window) {
2849 int ret;
2850
2851 coap_lock_lock(return 0);
2852 ret = coap_oscore_recipient_set_latest_seq_lkd(oscore_conf, recipient_id, last_seq,
2853 seq_window);
2854 coap_lock_unlock();
2855 return ret;
2856}
2857
2858int
2859coap_oscore_recipient_set_latest_seq_lkd(coap_oscore_conf_t *oscore_conf,
2860 const coap_bin_const_t *recipient_id,
2861 uint64_t last_seq, uint64_t seq_window) {
2862 coap_oscore_rcp_conf_t *rcp_conf;
2863
2864 rcp_conf = coap_oscore_get_recipient_conf(oscore_conf, recipient_id);
2865 if (rcp_conf) {
2866 rcp_conf->last_seq = last_seq;
2867 rcp_conf->sliding_window = seq_window;
2868 return 1;
2869 }
2870 return 0;
2871}
2872
2874
2875#else /* !COAP_OSCORE_SUPPORT */
2876int
2877coap_oscore_is_supported(void) {
2878 return 0;
2879}
2880
2881coap_session_t *
2882coap_new_client_session_oscore(coap_context_t *ctx,
2883 const coap_address_t *local_if,
2884 const coap_address_t *server,
2885 coap_proto_t proto,
2886 coap_oscore_conf_t *oscore_conf) {
2887 (void)ctx;
2888 (void)local_if;
2889 (void)server;
2890 (void)proto;
2891 (void)oscore_conf;
2892 return NULL;
2893}
2894
2895coap_session_t *
2896coap_new_client_session_oscore3(coap_context_t *ctx,
2897 const coap_address_t *local_if,
2898 const coap_address_t *server,
2899 coap_proto_t proto,
2900 coap_oscore_conf_t *oscore_conf,
2901 void *app_data,
2902 coap_app_data_free_callback_t callback,
2903 coap_str_const_t *ws_host) {
2904 (void)ctx;
2905 (void)local_if;
2906 (void)server;
2907 (void)proto;
2908 (void)oscore_conf;
2909 (void)app_data;
2910 (void)callback;
2911 (void)ws_host;
2912 return NULL;
2913}
2914
2915coap_session_t *
2916coap_new_client_session_oscore_psk(coap_context_t *ctx,
2917 const coap_address_t *local_if,
2918 const coap_address_t *server,
2919 coap_proto_t proto,
2920 coap_dtls_cpsk_t *psk_data,
2921 coap_oscore_conf_t *oscore_conf) {
2922 (void)ctx;
2923 (void)local_if;
2924 (void)server;
2925 (void)proto;
2926 (void)psk_data;
2927 (void)oscore_conf;
2928 return NULL;
2929}
2930
2931coap_session_t *
2932coap_new_client_session_oscore_psk3(coap_context_t *ctx,
2933 const coap_address_t *local_if,
2934 const coap_address_t *server,
2935 coap_proto_t proto,
2936 coap_dtls_cpsk_t *psk_data,
2937 coap_oscore_conf_t *oscore_conf,
2938 void *app_data,
2939 coap_app_data_free_callback_t callback,
2940 coap_str_const_t *ws_host) {
2941 (void)ctx;
2942 (void)local_if;
2943 (void)server;
2944 (void)proto;
2945 (void)psk_data;
2946 (void)oscore_conf;
2947 (void)app_data;
2948 (void)callback;
2949 (void)ws_host;
2950 return NULL;
2951}
2952
2953coap_session_t *
2954coap_new_client_session_oscore_pki(coap_context_t *ctx,
2955 const coap_address_t *local_if,
2956 const coap_address_t *server,
2957 coap_proto_t proto,
2958 coap_dtls_pki_t *pki_data,
2959 coap_oscore_conf_t *oscore_conf) {
2960 (void)ctx;
2961 (void)local_if;
2962 (void)server;
2963 (void)proto;
2964 (void)pki_data;
2965 (void)oscore_conf;
2966 return NULL;
2967}
2968
2969coap_session_t *
2970coap_new_client_session_oscore_pki3(coap_context_t *ctx,
2971 const coap_address_t *local_if,
2972 const coap_address_t *server,
2973 coap_proto_t proto,
2974 coap_dtls_pki_t *pki_data,
2975 coap_oscore_conf_t *oscore_conf,
2976 void *app_data,
2977 coap_app_data_free_callback_t callback,
2978 coap_str_const_t *ws_host) {
2979 (void)ctx;
2980 (void)local_if;
2981 (void)server;
2982 (void)proto;
2983 (void)pki_data;
2984 (void)oscore_conf;
2985 (void)app_data;
2986 (void)callback;
2987 (void)ws_host;
2988 return NULL;
2989}
2990
2991int
2992coap_context_oscore_server(coap_context_t *context,
2993 coap_oscore_conf_t *oscore_conf) {
2994 (void)context;
2995 (void)oscore_conf;
2996 return 0;
2997}
2998
2999coap_oscore_conf_t *
3000coap_new_oscore_conf(coap_str_const_t conf_mem,
3001 coap_oscore_save_seq_num_t save_seq_num_func,
3002 void *save_seq_num_func_param,
3003 uint64_t start_seq_num) {
3004 (void)conf_mem;
3005 (void)save_seq_num_func;
3006 (void)save_seq_num_func_param;
3007 (void)start_seq_num;
3008 return NULL;
3009}
3010
3011int
3012coap_delete_oscore_conf(coap_oscore_conf_t *oscore_conf) {
3013 (void)oscore_conf;
3014 return 0;
3015}
3016
3017int
3018coap_new_oscore_recipient(coap_context_t *context,
3019 coap_bin_const_t *recipient_id) {
3020 (void)context;
3021 (void)recipient_id;
3022 return 0;
3023}
3024
3025int
3026coap_delete_oscore_recipient(coap_context_t *context,
3027 coap_bin_const_t *recipient_id) {
3028 (void)context;
3029 (void)recipient_id;
3030 return 0;
3031}
3032
3033void
3034coap_oscore_register_external_handlers(coap_context_t *context,
3035 coap_oscore_find_handler_t find_handler,
3036 coap_oscore_update_seq_num_handler_t update_seq_num_handler) {
3037 (void)context;
3038 (void)find_handler;
3039 (void)update_seq_num_handler;
3040}
3041
3042COAP_API int
3043coap_oscore_recipient_set_latest_seq(coap_oscore_conf_t *oscore_conf,
3044 const coap_bin_const_t *recipient_id,
3045 uint64_t last_seq, uint64_t seq_window) {
3046 (void)oscore_conf;
3047 (void)recipient_id;
3048 (void)last_seq;
3049 (void)seq_window;
3050 return 0;
3051}
3052
3053#endif /* !COAP_OSCORE_SUPPORT */
coap_lg_crcv_t
struct coap_lg_crcv_t coap_lg_crcv_t
Definition coap_forward_decls.h:55
PRIu64
#define PRIu64
Definition coap_internal.h:59
coap_libcoap_build.h
Library specific build wrapper for coap_internal.h.
COAP_API
#define COAP_API
Definition coap_libcoap_build.h:41
COAP_OSCORE_BUF
@ COAP_OSCORE_BUF
Definition coap_mem.h:60
COAP_STRING
@ COAP_STRING
Definition coap_mem.h:33
coap_malloc_type
void * coap_malloc_type(coap_memory_tag_t type, size_t size)
Allocates a chunk of size bytes and returns a pointer to the newly allocated memory.
coap_free_type
void coap_free_type(coap_memory_tag_t type, void *p)
Releases the memory that was allocated by coap_malloc_type().
NULL
#define NULL
Definition coap_option.h:30
coap_opt_t
uint8_t coap_opt_t
Use byte-oriented access methods here because sliding a complex struct coap_opt_t over the data buffe...
Definition coap_option.h:148
coap_code_opt_num_t
coap_code_opt_num_t
Definition coap_option.h:70
COAP_OPTION_OBSERVE
@ COAP_OPTION_OBSERVE
Definition coap_option.h:75
COAP_OPTION_IF_NONE_MATCH
@ COAP_OPTION_IF_NONE_MATCH
Definition coap_option.h:74
COAP_OPTION_ETAG
@ COAP_OPTION_ETAG
Definition coap_option.h:73
COAP_OPTION_EDHOC
@ COAP_OPTION_EDHOC
Definition coap_option.h:89
COAP_OPTION_NORESPONSE
@ COAP_OPTION_NORESPONSE
Definition coap_option.h:98
COAP_OPTION_MAXAGE
@ COAP_OPTION_MAXAGE
Definition coap_option.h:83
COAP_OPTION_SIZE2
@ COAP_OPTION_SIZE2
Definition coap_option.h:92
COAP_OPTION_Q_BLOCK2
@ COAP_OPTION_Q_BLOCK2
Definition coap_option.h:93
COAP_OPTION_PROXY_SCHEME
@ COAP_OPTION_PROXY_SCHEME
Definition coap_option.h:95
COAP_OPTION_HOP_LIMIT
@ COAP_OPTION_HOP_LIMIT
Definition coap_option.h:85
COAP_OPTION_URI_PORT
@ COAP_OPTION_URI_PORT
Definition coap_option.h:76
COAP_OPTION_URI_HOST
@ COAP_OPTION_URI_HOST
Definition coap_option.h:72
COAP_OPTION_BLOCK2
@ COAP_OPTION_BLOCK2
Definition coap_option.h:90
COAP_OPTION_IF_MATCH
@ COAP_OPTION_IF_MATCH
Definition coap_option.h:71
COAP_OPTION_SIZE1
@ COAP_OPTION_SIZE1
Definition coap_option.h:96
COAP_OPTION_ECHO
@ COAP_OPTION_ECHO
Definition coap_option.h:97
COAP_OPTION_RTAG
@ COAP_OPTION_RTAG
Definition coap_option.h:99
COAP_OPTION_BLOCK1
@ COAP_OPTION_BLOCK1
Definition coap_option.h:91
COAP_OPTION_URI_PATH
@ COAP_OPTION_URI_PATH
Definition coap_option.h:79
COAP_OPTION_Q_BLOCK1
@ COAP_OPTION_Q_BLOCK1
Definition coap_option.h:87
COAP_OPTION_OSCORE
@ COAP_OPTION_OSCORE
Definition coap_option.h:78
COAP_OPTION_CONTENT_FORMAT
@ COAP_OPTION_CONTENT_FORMAT
Definition coap_option.h:80
COAP_OPTION_LOCATION_QUERY
@ COAP_OPTION_LOCATION_QUERY
Definition coap_option.h:88
COAP_OPTION_URI_QUERY
@ COAP_OPTION_URI_QUERY
Definition coap_option.h:84
COAP_OPTION_PROXY_URI
@ COAP_OPTION_PROXY_URI
Definition coap_option.h:94
COAP_OPTION_LOCATION_PATH
@ COAP_OPTION_LOCATION_PATH
Definition coap_option.h:77
COAP_OPTION_URI_PATH_ABB
@ COAP_OPTION_URI_PATH_ABB
Definition coap_option.h:81
COAP_OPTION_ACCEPT
@ COAP_OPTION_ACCEPT
Definition coap_option.h:86
coap_uri_scheme_is_secure
static int coap_uri_scheme_is_secure(const coap_uri_t *uri)
Definition coap_uri.h:92
COAP_URI_SCHEME_LAST
@ COAP_URI_SCHEME_LAST
Definition coap_uri.h:39
coap_send_ack_lkd
coap_mid_t coap_send_ack_lkd(coap_session_t *session, const coap_pdu_t *request)
Sends an ACK message with code 0 for the specified request to dst.
Definition coap_net.c:1220
coap_prng_lkd
int coap_prng_lkd(void *buf, size_t len)
Fills buf with len random bytes using the default pseudo random number generator.
Definition coap_prng.c:192
coap_handle_event_lkd
int coap_handle_event_lkd(coap_context_t *context, coap_event_t event, coap_session_t *session)
Invokes the event handler of context for the given event and data.
Definition coap_net.c:5269
coap_send_internal
coap_mid_t coap_send_internal(coap_session_t *session, coap_pdu_t *pdu, coap_pdu_t *request_pdu)
Sends a CoAP message to given peer.
Definition coap_net.c:2097
coap_cancel_all_messages
void coap_cancel_all_messages(coap_context_t *context, coap_session_t *session, coap_bin_const_t *token)
Cancels all outstanding messages for session session that have the specified token.
Definition coap_net.c:3310
COAP_OSCORE_DEFAULT_REPLAY_WINDOW
#define COAP_OSCORE_DEFAULT_REPLAY_WINDOW
Definition coap_crypto_internal.h:42
coap_crypto_check_hkdf_alg
int coap_crypto_check_hkdf_alg(cose_hkdf_alg_t hkdf_alg)
Check whether the defined hkdf algorithm is supported by the underlying crypto library.
coap_crypto_check_cipher_alg
int coap_crypto_check_cipher_alg(cose_alg_t alg)
Check whether the defined cipher algorithm is supported by the underlying crypto library.
coap_encode_var_safe
unsigned int coap_encode_var_safe(uint8_t *buf, size_t length, unsigned int val)
Encodes multiple-length byte sequences.
Definition coap_encode.c:47
coap_decode_var_bytes
unsigned int coap_decode_var_bytes(const uint8_t *buf, size_t len)
Decodes multiple-length byte sequences.
Definition coap_encode.c:38
coap_decode_var_bytes8
uint64_t coap_decode_var_bytes8(const uint8_t *buf, size_t len)
Decodes multiple-length byte sequences.
Definition coap_encode.c:71
coap_encode_var_safe8
unsigned int coap_encode_var_safe8(uint8_t *buf, size_t length, uint64_t val)
Encodes multiple-length byte sequences.
Definition coap_encode.c:81
COAP_EVENT_OSCORE_DECODE_ERROR
@ COAP_EVENT_OSCORE_DECODE_ERROR
Triggered when there is an OSCORE decode of OSCORE option failure.
Definition coap_event.h:130
COAP_EVENT_OSCORE_INTERNAL_ERROR
@ COAP_EVENT_OSCORE_INTERNAL_ERROR
Triggered when there is an OSCORE internal error i.e malloc failed.
Definition coap_event.h:128
COAP_EVENT_OSCORE_NOT_ENABLED
@ COAP_EVENT_OSCORE_NOT_ENABLED
Triggered when trying to use OSCORE to decrypt, but it is not enabled.
Definition coap_event.h:122
COAP_EVENT_OSCORE_NO_SECURITY
@ COAP_EVENT_OSCORE_NO_SECURITY
Triggered when there is no OSCORE security definition found.
Definition coap_event.h:126
COAP_EVENT_OSCORE_NO_PROTECTED_PAYLOAD
@ COAP_EVENT_OSCORE_NO_PROTECTED_PAYLOAD
Triggered when there is no OSCORE encrypted payload provided.
Definition coap_event.h:124
COAP_EVENT_OSCORE_DECRYPTION_FAILURE
@ COAP_EVENT_OSCORE_DECRYPTION_FAILURE
Triggered when there is an OSCORE decryption failure.
Definition coap_event.h:120
coap_lock_callback
#define coap_lock_callback(func)
Dummy for no thread-safe code.
Definition coap_threadsafe_internal.h:651
coap_lock_unlock
#define coap_lock_unlock()
Dummy for no thread-safe code.
Definition coap_threadsafe_internal.h:612
coap_lock_check_locked
#define coap_lock_check_locked()
Dummy for no thread-safe code.
Definition coap_threadsafe_internal.h:638
coap_lock_lock
#define coap_lock_lock(failed)
Dummy for no thread-safe code.
Definition coap_threadsafe_internal.h:582
coap_log_debug
#define coap_log_debug(...)
Definition coap_debug.h:126
coap_get_log_level
coap_log_t coap_get_log_level(void)
Get the current logging level.
Definition coap_debug.c:103
coap_show_pdu
void coap_show_pdu(coap_log_t level, const coap_pdu_t *pdu)
Display the contents of the specified pdu.
Definition coap_debug.c:812
coap_log_oscore
#define coap_log_oscore(...)
Definition coap_debug.h:132
coap_log_warn
#define coap_log_warn(...)
Definition coap_debug.h:108
coap_log_err
#define coap_log_err(...)
Definition coap_debug.h:102
coap_log_crit
#define coap_log_crit(...)
Definition coap_debug.h:96
COAP_LOG_OSCORE
@ COAP_LOG_OSCORE
Definition coap_debug.h:65
COAP_LOG_DEBUG
@ COAP_LOG_DEBUG
Definition coap_debug.h:64
coap_option_next
coap_opt_t * coap_option_next(coap_opt_iterator_t *oi)
Updates the iterator oi to point to the next option.
Definition coap_option.c:153
coap_opt_length
uint32_t coap_opt_length(const coap_opt_t *opt)
Returns the length of the given option.
Definition coap_option.c:212
coap_option_iterator_init
coap_opt_iterator_t * coap_option_iterator_init(const coap_pdu_t *pdu, coap_opt_iterator_t *oi, const coap_opt_filter_t *filter)
Initializes the given option iterator oi to point to the beginning of the pdu's option list.
Definition coap_option.c:117
coap_delete_optlist
void coap_delete_optlist(coap_optlist_t *queue)
Removes all entries from the optlist_chain, freeing off their memory usage.
Definition coap_option.c:605
COAP_OPT_ALL
#define COAP_OPT_ALL
Pre-defined filter that includes all options.
Definition coap_option.h:230
coap_add_optlist_pdu
int coap_add_optlist_pdu(coap_pdu_t *pdu, coap_optlist_t **options)
The current optlist of optlist_chain is first sorted (as per RFC7272 ordering requirements) and then ...
Definition coap_option.c:554
coap_check_option
coap_opt_t * coap_check_option(const coap_pdu_t *pdu, coap_option_num_t number, coap_opt_iterator_t *oi)
Retrieves the first option of number number from pdu.
Definition coap_option.c:199
coap_opt_value
const uint8_t * coap_opt_value(const coap_opt_t *opt)
Returns a pointer to the value of the given option.
Definition coap_option.c:249
oscore_cbor_get_element_size
uint64_t oscore_cbor_get_element_size(const uint8_t **buffer, size_t *buf_size)
cose_encrypt0_set_plaintext
void cose_encrypt0_set_plaintext(cose_encrypt0_t *ptr, uint8_t *buffer, size_t size)
cose_encrypt0_set_key
int cose_encrypt0_set_key(cose_encrypt0_t *ptr, coap_bin_const_t *key)
cose_encrypt0_set_kid_context
void cose_encrypt0_set_kid_context(cose_encrypt0_t *ptr, coap_bin_const_t *kid_context)
cose_get_alg_name
const char * cose_get_alg_name(cose_alg_t id, char *buffer, size_t buflen)
cose_encrypt0_set_ciphertext
void cose_encrypt0_set_ciphertext(cose_encrypt0_t *ptr, uint8_t *buffer, size_t size)
cose_encrypt0_decrypt
int cose_encrypt0_decrypt(cose_encrypt0_t *ptr, uint8_t *plaintext_buffer, size_t plaintext_len)
cose_tag_len
size_t cose_tag_len(cose_alg_t cose_alg)
cose_encrypt0_set_aad
void cose_encrypt0_set_aad(cose_encrypt0_t *ptr, coap_bin_const_t *aad)
cose_curve_t
cose_curve_t
Definition oscore_cose.h:62
cose_encrypt0_encrypt
int cose_encrypt0_encrypt(cose_encrypt0_t *ptr, uint8_t *ciphertext_buffer, size_t ciphertext_len)
cose_encrypt0_set_partial_iv
void cose_encrypt0_set_partial_iv(cose_encrypt0_t *ptr, coap_bin_const_t *partial_iv)
cose_encrypt0_set_external_aad
void cose_encrypt0_set_external_aad(cose_encrypt0_t *ptr, coap_bin_const_t *external_aad)
cose_encrypt0_init
void cose_encrypt0_init(cose_encrypt0_t *ptr)
cose_encrypt0_set_alg
void cose_encrypt0_set_alg(cose_encrypt0_t *ptr, uint8_t alg)
cose_encrypt0_set_key_id
void cose_encrypt0_set_key_id(cose_encrypt0_t *ptr, coap_bin_const_t *key_id)
cose_encrypt0_set_nonce
void cose_encrypt0_set_nonce(cose_encrypt0_t *ptr, coap_bin_const_t *nonce)
COSE_HKDF_ALG_HKDF_SHA_256
@ COSE_HKDF_ALG_HKDF_SHA_256
Definition oscore_cose.h:169
COSE_ALGORITHM_AES_CCM_16_64_128
@ COSE_ALGORITHM_AES_CCM_16_64_128
Definition oscore_cose.h:147
COSE_ALGORITHM_AES_CCM_16_64_256
@ COSE_ALGORITHM_AES_CCM_16_64_256
Definition oscore_cose.h:148
oscore_prepare_aad
size_t oscore_prepare_aad(const uint8_t *external_aad_buffer, size_t external_aad_len, uint8_t *aad_buffer, size_t aad_size)
coap_oscore_association_set_recipient_ctx
void coap_oscore_association_set_recipient_ctx(oscore_association_t *association, oscore_recipient_ctx_t *recipient_ctx)
Set the recipient context of an association.
oscore_derive_ctx_from_conf
oscore_ctx_t * oscore_derive_ctx_from_conf(coap_oscore_conf_t *oscore_conf)
oscore_derive_ctx_from_conf - derive a osc_ctx from oscore_conf information
coap_delete_oscore_recipient_lkd
int coap_delete_oscore_recipient_lkd(coap_context_t *context, coap_bin_const_t *recipient_id)
Release all the information associated for the specific Recipient ID (and hence and stop any further ...
oscore_delete_association
int oscore_delete_association(coap_session_t *session, oscore_association_t *association)
coap_new_client_session_oscore3_lkd
coap_session_t * coap_new_client_session_oscore3_lkd(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto, coap_oscore_conf_t *oscore_conf, void *app_data, coap_app_data_free_callback_t callback, coap_str_const_t *ws_host)
Creates a new client session to the designated server, protecting the data using OSCORE,...
oscore_validate_sender_seq
uint8_t oscore_validate_sender_seq(oscore_recipient_ctx_t *ctx, cose_encrypt0_t *cose)
oscore_add_recipient
oscore_recipient_ctx_t * oscore_add_recipient(oscore_ctx_t *ctx, coap_oscore_rcp_conf_t *rcp_conf, uint32_t break_key)
oscore_add_recipient - add in recipient information
OSCORE_SEQ_MAX
#define OSCORE_SEQ_MAX
Definition oscore_context.h:74
coap_init_oscore_context_from_conf
oscore_ctx_t * coap_init_oscore_context_from_conf(coap_oscore_conf_t *oscore_conf)
Initializes an OSCORE context from the given configuration.
AES_CCM_TAG
#define AES_CCM_TAG
Definition oscore_crypto.h:63
coap_oscore_session_set_recipient_ctx
void coap_oscore_session_set_recipient_ctx(coap_session_t *session, oscore_recipient_ctx_t *recipient_ctx)
Attach the OSCORE recipient context information to the session.
oscore_decode_option_value
int oscore_decode_option_value(const uint8_t *option_value, size_t option_len, cose_encrypt0_t *cose)
coap_delete_oscore_snd_conf
int coap_delete_oscore_snd_conf(coap_oscore_snd_conf_t *oscore_snd_conf)
Release all the information associated with the OSCORE complex Sender configuration.
coap_oscore_new_pdu_encrypted_lkd
coap_pdu_t * coap_oscore_new_pdu_encrypted_lkd(coap_session_t *session, coap_pdu_t *pdu, coap_bin_const_t *kid_context, oscore_partial_iv_t send_partial_iv)
Encrypts the specified pdu when OSCORE encryption is required on session.
oscore_delete_recipient
int oscore_delete_recipient(oscore_ctx_t *osc_ctx, coap_bin_const_t *rid)
oscore_increment_sender_seq
uint8_t oscore_increment_sender_seq(oscore_ctx_t *ctx)
oscore_update_ctx
void oscore_update_ctx(oscore_ctx_t *osc_ctx, coap_bin_const_t *id_context)
oscore_update_ctx - update a osc_ctx with a new id_context
coap_new_client_session_oscore_psk3_lkd
coap_session_t * coap_new_client_session_oscore_psk3_lkd(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto, coap_dtls_cpsk_t *psk_data, coap_oscore_conf_t *oscore_conf, void *app_data, coap_app_data_free_callback_t callback, coap_str_const_t *ws_host)
Creates a new client session to the designated server, with PSK credentials protecting the data using...
oscore_derive_ctx
oscore_ctx_t * oscore_derive_ctx(coap_context_t *c_context, coap_oscore_conf_t *oscore_conf)
oscore_derive_ctx - derive a osc_ctx from oscore_conf information
coap_oscore_new_pdu_encrypted
COAP_API coap_pdu_t * coap_oscore_new_pdu_encrypted(coap_session_t *session, coap_pdu_t *pdu, coap_bin_const_t *kid_context, oscore_partial_iv_t send_partial_iv)
Encrypts the specified pdu when OSCORE encryption is required on session.
oscore_roll_back_seq
void oscore_roll_back_seq(oscore_recipient_ctx_t *ctx)
oscore_new_association
int oscore_new_association(coap_session_t *session, coap_pdu_t *sent_pdu, coap_bin_const_t *token, oscore_recipient_ctx_t *recipient_ctx, coap_bin_const_t *aad, coap_bin_const_t *nonce, coap_bin_const_t *partial_iv, int is_observe)
oscore_prepare_e_aad
size_t oscore_prepare_e_aad(oscore_ctx_t *ctx, cose_encrypt0_t *cose, const uint8_t *oscore_option, size_t oscore_option_len, coap_bin_const_t *sender_public_key, uint8_t *external_aad_ptr, size_t external_aad_size)
oscore_delete_server_associations
void oscore_delete_server_associations(coap_session_t *session)
oscore_log_char_value
void oscore_log_char_value(coap_log_t level, const char *name, const char *value)
oscore_find_context
oscore_ctx_t * oscore_find_context(coap_session_t *session, const coap_bin_const_t rcpkey_id, const coap_bin_const_t *ctxkey_id, uint8_t *oscore_r2, oscore_recipient_ctx_t **recipient_ctx)
oscore_find_context - Locate recipient context (and hence OSCORE context)
coap_oscore_decrypt_pdu
struct coap_pdu_t * coap_oscore_decrypt_pdu(coap_session_t *session, coap_pdu_t *pdu)
Decrypts the OSCORE-encrypted parts of pdu when OSCORE is used.
coap_oscore_recipient_set_latest_seq_lkd
int coap_oscore_recipient_set_latest_seq_lkd(coap_oscore_conf_t *oscore_conf, const coap_bin_const_t *recipient_id, uint64_t last_seq, uint64_t seq_window)
Set the latest sequence number and sliding window for the specified recipient id in the compiled conf...
coap_rebuild_pdu_for_proxy
int coap_rebuild_pdu_for_proxy(coap_pdu_t *pdu)
Convert PDU to use Proxy-Scheme option if Proxy-Uri option is present.
oscore_free_contexts
void oscore_free_contexts(coap_context_t *c_context)
oscore_log_hex_value
void oscore_log_hex_value(coap_log_t level, const char *name, coap_bin_const_t *value)
coap_delete_oscore_associations
void coap_delete_oscore_associations(coap_session_t *session)
Cleanup all allocated OSCORE association information.
coap_oscore_initiate
int coap_oscore_initiate(coap_session_t *session, coap_oscore_conf_t *oscore_conf)
Initiate an OSCORE session.
coap_new_oscore_recipient_lkd
int coap_new_oscore_recipient_lkd(coap_context_t *context, coap_bin_const_t *recipient_id)
Add in the specific Recipient ID into the OSCORE context (server only).
oscore_duplicate_ctx
oscore_ctx_t * oscore_duplicate_ctx(coap_context_t *c_context, oscore_ctx_t *o_osc_ctx, coap_bin_const_t *sender_id, coap_bin_const_t *recipient_id, coap_bin_const_t *id_context)
oscore_duplicate_ctx - duplicate a osc_ctx
oscore_partial_iv_t
oscore_partial_iv_t
Definition coap_oscore_internal.h:87
coap_delete_all_oscore
void coap_delete_all_oscore(coap_context_t *context)
Cleanup all allocated OSCORE information.
oscore_generate_nonce
void oscore_generate_nonce(cose_encrypt0_t *ptr, oscore_ctx_t *ctx, uint8_t *buffer, uint8_t size)
oscore_remove_context
int oscore_remove_context(coap_context_t *c_context, oscore_ctx_t *osc_ctx)
oscore_find_association
oscore_association_t * oscore_find_association(coap_session_t *session, coap_bin_const_t *token)
coap_context_oscore_server_lkd
int coap_context_oscore_server_lkd(coap_context_t *context, coap_oscore_conf_t *oscore_conf)
Set the context's default OSCORE configuration for a server.
coap_delete_oscore_rcp_conf
int coap_delete_oscore_rcp_conf(coap_oscore_rcp_conf_t *oscore_rcp_conf)
Release all the information associated with the OSCORE complex Recipient configuration.
oscore_release_recipient_ctx
void oscore_release_recipient_ctx(oscore_recipient_ctx_t **recipient_ctx)
Cleanup recipient context, including releasing the oscore context if the oscore context referenced is...
coap_new_client_session_oscore_pki3_lkd
coap_session_t * coap_new_client_session_oscore_pki3_lkd(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto, coap_dtls_pki_t *pki_data, coap_oscore_conf_t *oscore_conf, void *app_data, coap_app_data_free_callback_t callback, coap_str_const_t *ws_host)
Creates a new client session to the designated server, with PKI credentials protecting the data using...
oscore_encode_option_value
ssize_t oscore_encode_option_value(uint8_t *option_buffer, size_t option_buf_len, cose_encrypt0_t *cose, uint8_t group_flag, uint8_t appendix_b_2)
Encode the OSCORE option.
coap_oscore_overhead
size_t coap_oscore_overhead(coap_session_t *session, coap_pdu_t *pdu)
Determine the additional data size requirements for adding in OSCORE.
OSCORE_SEND_PARTIAL_IV
@ OSCORE_SEND_PARTIAL_IV
Send partial IV with encrypted PDU.
Definition coap_oscore_internal.h:89
OSCORE_SEND_NO_IV
@ OSCORE_SEND_NO_IV
Do not send partial IV unless added by a response.
Definition coap_oscore_internal.h:88
coap_oscore_recipient_set_latest_seq
COAP_API int coap_oscore_recipient_set_latest_seq(coap_oscore_conf_t *oscore_conf, const coap_bin_const_t *recipient_id, uint64_t last_seq, uint64_t seq_window)
Set the latest sequence number and sliding window for the specified recipient id in the compiled conf...
Definition coap_oscore.c:3043
coap_new_oscore_conf
coap_oscore_conf_t * coap_new_oscore_conf(coap_str_const_t conf_mem, coap_oscore_save_seq_num_t save_seq_num_func, void *save_seq_num_func_param, uint64_t start_seq_num)
Parse an OSCORE configuration (held in memory) and populate a OSCORE configuration structure.
Definition coap_oscore.c:3000
coap_new_client_session_oscore_psk
coap_session_t * coap_new_client_session_oscore_psk(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto, coap_dtls_cpsk_t *psk_data, coap_oscore_conf_t *oscore_conf)
Creates a new client session to the designated server with PSK credentials as well as protecting the ...
Definition coap_oscore.c:2916
coap_new_client_session_oscore_psk3
coap_session_t * coap_new_client_session_oscore_psk3(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto, coap_dtls_cpsk_t *psk_data, coap_oscore_conf_t *oscore_conf, void *app_data, coap_app_data_free_callback_t callback, coap_str_const_t *ws_host)
Creates a new client session to the designated server, with PSK credentials protecting the data using...
Definition coap_oscore.c:2932
coap_oscore_update_seq_num_handler_t
int(* coap_oscore_update_seq_num_handler_t)(const coap_session_t *session, const coap_bin_const_t *rcpkey_id, const coap_bin_const_t *ctxkey_id, uint64_t receiver_seq_num, uint64_t seq_num_window)
Callback function type for persisting the OSCORE receiver sequence number and anti-replay sliding win...
Definition coap_oscore.h:77
coap_delete_oscore_conf
int coap_delete_oscore_conf(coap_oscore_conf_t *oscore_conf)
Release all the information associated with the OSCORE configuration.
Definition coap_oscore.c:3012
coap_new_client_session_oscore
coap_session_t * coap_new_client_session_oscore(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto, coap_oscore_conf_t *oscore_conf)
Creates a new client session to the designated server, protecting the data using OSCORE.
Definition coap_oscore.c:2882
coap_context_oscore_server
int coap_context_oscore_server(coap_context_t *context, coap_oscore_conf_t *oscore_conf)
Set the context's default OSCORE configuration for a server.
Definition coap_oscore.c:2992
coap_oscore_find_handler_t
coap_oscore_conf_t *(* coap_oscore_find_handler_t)(const coap_session_t *session, const coap_bin_const_t *rcpkey_id, const coap_bin_const_t *ctxkey_id)
Callback function type for overriding oscore_find_context().
Definition coap_oscore.h:54
coap_new_client_session_oscore_pki
coap_session_t * coap_new_client_session_oscore_pki(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto, coap_dtls_pki_t *pki_data, coap_oscore_conf_t *oscore_conf)
Creates a new client session to the designated server with PKI credentials as well as protecting the ...
Definition coap_oscore.c:2954
coap_new_client_session_oscore3
coap_session_t * coap_new_client_session_oscore3(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto, coap_oscore_conf_t *oscore_conf, void *app_data, coap_app_data_free_callback_t callback, coap_str_const_t *ws_host)
Creates a new client session to the designated server, protecting the data using OSCORE,...
Definition coap_oscore.c:2896
coap_new_oscore_recipient
int coap_new_oscore_recipient(coap_context_t *context, coap_bin_const_t *recipient_id)
Add in the specific Recipient ID into the OSCORE context (server only).
Definition coap_oscore.c:3018
coap_oscore_save_seq_num_t
int(* coap_oscore_save_seq_num_t)(uint64_t sender_seq_num, void *param)
Definition of the function used to save the current Sender Sequence Number.
Definition coap_oscore.h:314
coap_delete_oscore_recipient
int coap_delete_oscore_recipient(coap_context_t *context, coap_bin_const_t *recipient_id)
Release all the information associated for the specific Recipient ID (and hence stop any further OSCO...
Definition coap_oscore.c:3026
coap_oscore_register_external_handlers
void coap_oscore_register_external_handlers(coap_context_t *context, coap_oscore_find_handler_t find_handler, coap_oscore_update_seq_num_handler_t update_seq_num_handler)
Register external storage handlers for OSCORE session state.
Definition coap_oscore.c:3034
coap_new_client_session_oscore_pki3
coap_session_t * coap_new_client_session_oscore_pki3(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto, coap_dtls_pki_t *pki_data, coap_oscore_conf_t *oscore_conf, void *app_data, coap_app_data_free_callback_t callback, coap_str_const_t *ws_host)
Creates a new client session to the designated server, with PKI credentials protecting the data using...
Definition coap_oscore.c:2970
coap_delete_pdu_lkd
void coap_delete_pdu_lkd(coap_pdu_t *pdu)
Dispose of an CoAP PDU and free off associated storage.
Definition coap_pdu.c:197
coap_insert_option
size_t coap_insert_option(coap_pdu_t *pdu, coap_option_num_t number, size_t len, const uint8_t *data)
Inserts option of given number in the pdu with the appropriate data.
Definition coap_pdu.c:692
coap_remove_option
int coap_remove_option(coap_pdu_t *pdu, coap_option_num_t number)
Removes (first) option of given number from the pdu.
Definition coap_pdu.c:546
coap_update_token
int coap_update_token(coap_pdu_t *pdu, size_t len, const uint8_t *data)
Updates token in pdu with length len and data.
Definition coap_pdu.c:470
COAP_PDU_IS_PING
#define COAP_PDU_IS_PING(pdu)
Definition coap_pdu_internal.h:103
coap_pdu_duplicate_lkd
coap_pdu_t * coap_pdu_duplicate_lkd(const coap_pdu_t *old_pdu, coap_session_t *session, size_t token_length, const uint8_t *token, coap_opt_filter_t *drop_options, coap_bool_t expand_opt_abb)
Duplicate an existing PDU.
Definition coap_pdu.c:237
coap_pdu_encode_header
size_t coap_pdu_encode_header(coap_pdu_t *pdu, coap_proto_t proto)
Compose the protocol specific header for the specified PDU.
Definition coap_pdu.c:1618
COAP_PAYLOAD_START
#define COAP_PAYLOAD_START
Definition coap_pdu_internal.h:96
coap_pdu_resize
int coap_pdu_resize(coap_pdu_t *pdu, size_t new_size)
Dynamically grows the size of pdu to new_size.
Definition coap_pdu.c:341
COAP_PDU_IS_REQUEST
#define COAP_PDU_IS_REQUEST(pdu)
Definition coap_pdu_internal.h:99
coap_add_option_internal
size_t coap_add_option_internal(coap_pdu_t *pdu, coap_option_num_t number, size_t len, const uint8_t *data)
Adds option of given number to pdu that is passed as first parameter.
Definition coap_pdu.c:859
COAP_DEFAULT_PORT
#define COAP_DEFAULT_PORT
Definition coap_pdu.h:39
COAP_RESPONSE_CODE
#define COAP_RESPONSE_CODE(N)
Definition coap_pdu.h:96
coap_proto_t
coap_proto_t
CoAP protocol types Note: coap_layers_coap[] needs updating if extended.
Definition coap_pdu.h:234
coap_pdu_code_t
coap_pdu_code_t
Set of codes available for a PDU.
Definition coap_pdu.h:248
coap_add_token
int coap_add_token(coap_pdu_t *pdu, size_t len, const uint8_t *data)
Adds token of length len to pdu.
Definition coap_pdu.c:413
COAPS_DEFAULT_PORT
#define COAPS_DEFAULT_PORT
Definition coap_pdu.h:40
coap_get_data
int coap_get_data(const coap_pdu_t *pdu, size_t *len, const uint8_t **data)
Retrieves the length and data pointer of specified PDU.
Definition coap_pdu.c:962
coap_pdu_init
coap_pdu_t * coap_pdu_init(coap_pdu_type_t type, coap_pdu_code_t code, coap_mid_t mid, size_t size)
Creates a new CoAP PDU with at least enough storage space for the given size maximum message size.
Definition coap_pdu.c:104
COAP_INVALID_MID
#define COAP_INVALID_MID
Indicates an invalid message id.
Definition coap_pdu.h:187
coap_add_data
int coap_add_data(coap_pdu_t *pdu, size_t len, const uint8_t *data)
Adds given data to the pdu that is passed as first parameter.
Definition coap_pdu.c:931
coap_pdu_get_token
coap_bin_const_t coap_pdu_get_token(const coap_pdu_t *pdu)
Gets the token associated with pdu.
Definition coap_pdu.c:1738
COAP_BOOL_FALSE
@ COAP_BOOL_FALSE
Definition coap_pdu.h:295
COAP_REQUEST_CODE_POST
@ COAP_REQUEST_CODE_POST
Definition coap_pdu.h:252
COAP_REQUEST_CODE_FETCH
@ COAP_REQUEST_CODE_FETCH
Definition coap_pdu.h:255
COAP_MESSAGE_NON
@ COAP_MESSAGE_NON
Definition coap_pdu.h:72
COAP_MESSAGE_ACK
@ COAP_MESSAGE_ACK
Definition coap_pdu.h:73
COAP_MESSAGE_CON
@ COAP_MESSAGE_CON
Definition coap_pdu.h:71
coap_new_client_session_pki3_lkd
coap_session_t * coap_new_client_session_pki3_lkd(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto, coap_dtls_pki_t *setup_data, void *app_data, coap_app_data_free_callback_t callback, coap_str_const_t *ws_host)
Creates a new client session to the designated server, with PKI credentials along with app_data infor...
coap_new_client_session_psk3_lkd
coap_session_t * coap_new_client_session_psk3_lkd(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto, coap_dtls_cpsk_t *setup_data, void *app_data, coap_app_data_free_callback_t callback, coap_str_const_t *ws_host)
Creates a new client session to the designated server, with PSK credentials along with app_data infor...
coap_session_release_lkd
void coap_session_release_lkd(coap_session_t *session)
Decrement reference counter on a session.
Definition coap_session.c:378
coap_new_client_session3_lkd
coap_session_t * coap_new_client_session3_lkd(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto, void *app_data, coap_app_data_free_callback_t callback, coap_str_const_t *ws_host)
Creates a new client session to the designated server, with PSK credentials along with app_data infor...
COAP_OSCORE_B_2_NONE
@ COAP_OSCORE_B_2_NONE
Definition coap_session_internal.h:52
COAP_OSCORE_B_2_STEP_3
@ COAP_OSCORE_B_2_STEP_3
Definition coap_session_internal.h:55
COAP_OSCORE_B_2_STEP_1
@ COAP_OSCORE_B_2_STEP_1
Definition coap_session_internal.h:53
COAP_OSCORE_B_2_STEP_4
@ COAP_OSCORE_B_2_STEP_4
Definition coap_session_internal.h:56
COAP_OSCORE_B_2_STEP_5
@ COAP_OSCORE_B_2_STEP_5
Definition coap_session_internal.h:57
COAP_OSCORE_B_2_STEP_2
@ COAP_OSCORE_B_2_STEP_2
Definition coap_session_internal.h:54
coap_app_data_free_callback_t
void(* coap_app_data_free_callback_t)(void *data)
Callback to free off the app data when the entry is being deleted / freed off.
Definition coap_session.h:124
coap_delete_bin_const
void coap_delete_bin_const(coap_bin_const_t *s)
Deletes the given const binary data and releases any memory allocated.
Definition coap_str.c:130
coap_delete_str_const
void coap_delete_str_const(coap_str_const_t *s)
Deletes the given const string and releases any memory allocated.
Definition coap_str.c:65
coap_new_binary
coap_binary_t * coap_new_binary(size_t size)
Returns a new binary object with at least size bytes storage allocated.
Definition coap_str.c:81
coap_make_str_const
coap_str_const_t * coap_make_str_const(const char *string)
Take the specified byte array (text) and create a coap_str_const_t *.
Definition coap_str.c:70
coap_new_bin_const
coap_bin_const_t * coap_new_bin_const(const uint8_t *data, size_t size)
Take the specified byte array (text) and create a coap_bin_const_t * Returns a new const binary objec...
Definition coap_str.c:119
coap_str_const_t
struct coap_str_const_t coap_str_const_t
CoAP string data definition with const data.
coap_delete_binary
void coap_delete_binary(coap_binary_t *s)
Deletes the given coap_binary_t object and releases any memory allocated.
Definition coap_str.c:114
coap_binary_equal
#define coap_binary_equal(binary1, binary2)
Compares the two binary data for equality.
Definition coap_str.h:222
coap_string_equal
#define coap_string_equal(string1, string2)
Compares the two strings for equality.
Definition coap_str.h:208
coap_new_str_const
coap_str_const_t * coap_new_str_const(const uint8_t *data, size_t size)
Returns a new const string object with at least size+1 bytes storage allocated, and the provided data...
Definition coap_str.c:55
coap_oscore_is_supported
int coap_oscore_is_supported(void)
Check whether OSCORE is available.
Definition coap_oscore.c:2877
coap_query_into_optlist
int coap_query_into_optlist(const uint8_t *s, size_t length, coap_option_num_t optnum, coap_optlist_t **optlist_chain)
Splits the given URI query into '&' separate segments, and then adds the Uri-Query / Location-Query o...
Definition coap_uri.c:985
coap_path_into_optlist
int coap_path_into_optlist(const uint8_t *s, size_t length, coap_option_num_t optnum, coap_optlist_t **optlist_chain)
Splits the given URI path into '/' separate segments, and then adds the Uri-Path / Location-Path opti...
Definition coap_uri.c:865
coap_split_proxy_uri
int coap_split_proxy_uri(const uint8_t *str_var, size_t len, coap_uri_t *uri)
Parses a given string into URI components.
Definition coap_uri.c:351
coap_uri_scheme
coap_uri_info_t coap_uri_scheme[COAP_URI_SCHEME_LAST]
Definition coap_uri.c:59
coap_address_t
Multi-purpose address abstraction.
Definition coap_address.h:185
coap_bin_const_t
CoAP binary data definition with const data.
Definition coap_str.h:65
coap_bin_const_t::length
size_t length
length of binary data
Definition coap_str.h:66
coap_bin_const_t::s
const uint8_t * s
read-only binary data
Definition coap_str.h:67
coap_binary_t
CoAP binary data definition.
Definition coap_str.h:57
coap_binary_t::length
size_t length
length of binary data
Definition coap_str.h:58
coap_binary_t::s
uint8_t * s
binary data
Definition coap_str.h:59
coap_context_t
The CoAP stack's global state is stored in a coap_context_t object.
Definition coap_net_internal.h:55
coap_dtls_cpsk_t
The structure used for defining the Client PSK setup data to be used.
Definition coap_dtls.h:418
coap_dtls_pki_t
The structure used for defining the PKI setup data to be used.
Definition coap_dtls.h:317
coap_opt_iterator_t
Iterator to run through PDU options.
Definition coap_option.h:290
coap_opt_iterator_t::next_option
coap_opt_t * next_option
pointer to the unparsed next option
Definition coap_option.h:295
coap_opt_iterator_t::length
size_t length
remaining length of PDU
Definition coap_option.h:291
coap_opt_iterator_t::number
coap_option_num_t number
decoded option number
Definition coap_option.h:292
coap_optlist_t
Representation of chained list of CoAP options to install.
Definition coap_option.h:447
coap_oscore_conf_t
The structure used to hold the OSCORE configuration information.
Definition coap_oscore_internal.h:62
coap_oscore_conf_t::save_seq_num_func_param
void * save_seq_num_func_param
Passed to save_seq_num_func().
Definition coap_oscore_internal.h:83
coap_oscore_conf_t::rfc8613_b_2
uint32_t rfc8613_b_2
1 if rfc8613 B.2 protocol else 0
Definition coap_oscore_internal.h:74
coap_oscore_conf_t::hkdf_alg
cose_hkdf_alg_t hkdf_alg
Set to one of COSE_HKDF_ALG_*.
Definition coap_oscore_internal.h:72
coap_oscore_conf_t::break_sender_key
uint32_t break_sender_key
1 if sender key to be broken, else 0
Definition coap_oscore_internal.h:77
coap_oscore_conf_t::sender
coap_oscore_snd_conf_t * sender
The sender - i.e.
Definition coap_oscore_internal.h:66
coap_oscore_conf_t::recipient_chain
coap_oscore_rcp_conf_t * recipient_chain
The recipients as a chain.
Definition coap_oscore_internal.h:67
coap_oscore_conf_t::ssn_freq
uint32_t ssn_freq
Sender Seq Num update frequency.
Definition coap_oscore_internal.h:70
coap_oscore_conf_t::save_seq_num_func
coap_oscore_save_seq_num_t save_seq_num_func
Called every seq num change.
Definition coap_oscore_internal.h:81
coap_oscore_conf_t::rfc8613_b_1_2
uint32_t rfc8613_b_1_2
1 if rfc8613 B.1.2 enabled else 0
Definition coap_oscore_internal.h:73
coap_oscore_conf_t::start_seq_num
uint64_t start_seq_num
Used for ssn_freq updating.
Definition coap_oscore_internal.h:84
coap_oscore_conf_t::break_recipient_key
uint32_t break_recipient_key
1 if recipient key to be broken, else 0
Definition coap_oscore_internal.h:78
coap_oscore_conf_t::master_secret
coap_bin_const_t * master_secret
Common Master Secret.
Definition coap_oscore_internal.h:63
coap_oscore_conf_t::aead_alg
cose_alg_t aead_alg
Set to one of COSE_ALGORITHM_AES*.
Definition coap_oscore_internal.h:71
coap_oscore_conf_t::master_salt
coap_bin_const_t * master_salt
Common Master Salt.
Definition coap_oscore_internal.h:64
coap_oscore_conf_t::replay_window
uint32_t replay_window
Replay window size Use COAP_OSCORE_DEFAULT_REPLAY_WINDOW.
Definition coap_oscore_internal.h:68
coap_oscore_conf_t::id_context
coap_bin_const_t * id_context
Common ID context.
Definition coap_oscore_internal.h:65
coap_oscore_rcp_conf_t
The structure used to hold the OSCORE Recipient configuration.
Definition coap_oscore_internal.h:45
coap_oscore_rcp_conf_t::recipient_id
coap_bin_const_t * recipient_id
Recipient ID (i.e.
Definition coap_oscore_internal.h:48
coap_oscore_rcp_conf_t::last_seq
uint64_t last_seq
Highest sequence number used for this recipient.
Definition coap_oscore_internal.h:55
coap_oscore_rcp_conf_t::window_initialized
uint8_t window_initialized
Contains if the sliding window is initialized 1 if initialized, 0 otherwise.
Definition coap_oscore_internal.h:53
coap_oscore_rcp_conf_t::next_recipient
struct coap_oscore_rcp_conf_t * next_recipient
Used to maintain the chain.
Definition coap_oscore_internal.h:46
coap_oscore_rcp_conf_t::sliding_window
uint64_t sliding_window
bitfield sequence counter window
Definition coap_oscore_internal.h:56
coap_oscore_snd_conf_t
The structure used to hold the OSCORE Sender configuration information.
Definition coap_oscore_internal.h:38
coap_oscore_snd_conf_t::sender_id
coap_bin_const_t * sender_id
Sender ID (i.e.
Definition coap_oscore_internal.h:39
coap_pdu_t
structure for CoAP PDUs
Definition coap_pdu_internal.h:132
coap_pdu_t::max_hdr_size
uint8_t max_hdr_size
space reserved for protocol-specific header
Definition coap_pdu_internal.h:139
coap_pdu_t::token
uint8_t * token
first byte of token (or extended length bytes prefix), if any, or options
Definition coap_pdu_internal.h:154
coap_pdu_t::code
coap_pdu_code_t code
request method (value 1–31) or response code (value 64-255)
Definition coap_pdu_internal.h:135
coap_pdu_t::actual_token
coap_bin_const_t actual_token
Actual token in pdu.
Definition coap_pdu_internal.h:147
coap_pdu_t::data
uint8_t * data
first byte of payload, if any
Definition coap_pdu_internal.h:156
coap_pdu_t::mid
coap_mid_t mid
message id, if any, in regular host byte order
Definition coap_pdu_internal.h:137
coap_pdu_t::e_token_length
uint32_t e_token_length
length of Token space (includes leading extended bytes
Definition coap_pdu_internal.h:144
coap_pdu_t::used_size
size_t used_size
used bytes of storage for token, options and payload
Definition coap_pdu_internal.h:150
coap_pdu_t::type
coap_pdu_type_t type
message type
Definition coap_pdu_internal.h:134
coap_session_t
Abstraction of virtual session that can be attached to coap_context_t (client) or coap_endpoint_t (se...
Definition coap_session_internal.h:77
coap_session_t::max_token_size
uint32_t max_token_size
Largest token size supported RFC8974.
Definition coap_session_internal.h:239
coap_session_t::proto
coap_proto_t proto
protocol used
Definition coap_session_internal.h:78
coap_session_t::ref
unsigned ref
reference count from queues
Definition coap_session_internal.h:82
coap_session_t::con_active
uint8_t con_active
Active CON request sent.
Definition coap_session_internal.h:106
coap_session_t::context
coap_context_t * context
session's context
Definition coap_session_internal.h:102
coap_str_const_t
CoAP string data definition with const data.
Definition coap_str.h:47
coap_str_const_t::s
const uint8_t * s
read-only string data
Definition coap_str.h:49
coap_str_const_t::length
size_t length
length of string
Definition coap_str.h:48
coap_uri_t
Representation of parsed URI.
Definition coap_uri.h:70
coap_uri_t::scheme
enum coap_uri_scheme_t scheme
The parsed scheme specifier.
Definition coap_uri.h:82
coap_uri_t::path
coap_str_const_t path
The complete path if present or {0, NULL}.
Definition coap_uri.h:73
coap_uri_t::port
uint16_t port
The port in host byte order.
Definition coap_uri.h:72
coap_uri_t::query
coap_str_const_t query
The complete query if present or {0, NULL}.
Definition coap_uri.h:77
coap_uri_t::host
coap_str_const_t host
The host part of the URI.
Definition coap_uri.h:71
cose_encrypt0_t
Definition oscore_cose.h:199
cose_encrypt0_t::aad
coap_bin_const_t aad
Definition oscore_cose.h:210
cose_encrypt0_t::key
coap_bin_const_t key
Definition oscore_cose.h:201
cose_encrypt0_t::partial_iv
coap_bin_const_t partial_iv
Definition oscore_cose.h:204
cose_encrypt0_t::kid_context
coap_bin_const_t kid_context
Definition oscore_cose.h:206
cose_encrypt0_t::nonce
coap_bin_const_t nonce
Definition oscore_cose.h:208
cose_encrypt0_t::external_aad
coap_bin_const_t external_aad
Definition oscore_cose.h:209
cose_encrypt0_t::key_id
coap_bin_const_t key_id
Definition oscore_cose.h:205
cose_encrypt0_t::oscore_option
coap_bin_const_t oscore_option
Definition oscore_cose.h:207
cose_encrypt0_t::alg
cose_alg_t alg
Definition oscore_cose.h:200
oscore_association_t
Definition oscore_context.h:152
oscore_association_t::obs_partial_iv
coap_bin_const_t * obs_partial_iv
Definition oscore_context.h:160
oscore_association_t::partial_iv
coap_bin_const_t * partial_iv
Definition oscore_context.h:159
oscore_association_t::sent_pdu
coap_pdu_t * sent_pdu
Definition oscore_context.h:155
oscore_association_t::aad
coap_bin_const_t * aad
Definition oscore_context.h:157
oscore_association_t::nonce
coap_bin_const_t * nonce
Definition oscore_context.h:158
oscore_association_t::recipient_ctx
oscore_recipient_ctx_t * recipient_ctx
Definition oscore_context.h:154
oscore_association_t::is_observe
uint8_t is_observe
Definition oscore_context.h:162
oscore_association_t::just_set_up
uint8_t just_set_up
Definition oscore_context.h:163
oscore_ctx_t
Definition oscore_context.h:86
oscore_ctx_t::rfc8613_b_1_2
uint8_t rfc8613_b_1_2
1 if rfc8613 B.1.2 enabled else 0
Definition oscore_context.h:99
oscore_ctx_t::save_seq_num_func_param
void * save_seq_num_func_param
Passed to save_seq_num_func().
Definition oscore_context.h:107
oscore_ctx_t::sender_context
oscore_sender_ctx_t * sender_context
Definition oscore_context.h:96
oscore_ctx_t::aead_alg
cose_alg_t aead_alg
Set to one of COSE_ALGORITHM_AES*.
Definition oscore_context.h:88
oscore_ctx_t::rfc8613_b_2
uint8_t rfc8613_b_2
1 if rfc8613 B.2 protocol else 0
Definition oscore_context.h:101
oscore_ctx_t::save_seq_num_func
coap_oscore_save_seq_num_t save_seq_num_func
Called every seq num change.
Definition oscore_context.h:105
oscore_ctx_t::recipient_chain
oscore_recipient_ctx_t * recipient_chain
Definition oscore_context.h:97
oscore_ctx_t::id_context
coap_bin_const_t * id_context
contains GID in case of group
Definition oscore_context.h:93
oscore_ctx_t::ssn_freq
uint32_t ssn_freq
Sender Seq Num update frequency.
Definition oscore_context.h:104
oscore_recipient_ctx_t
Definition oscore_context.h:119
oscore_recipient_ctx_t::sliding_window
uint64_t sliding_window
Definition oscore_context.h:129
oscore_recipient_ctx_t::ref
unsigned ref
Reference counter to keep track of linked associations / active sessions.
Definition oscore_context.h:120
oscore_recipient_ctx_t::echo_value
uint8_t echo_value[8]
Definition oscore_context.h:132
oscore_recipient_ctx_t::last_seq
uint64_t last_seq
Definition oscore_context.h:127
oscore_recipient_ctx_t::recipient_key
coap_bin_const_t * recipient_key
Definition oscore_context.h:126
oscore_recipient_ctx_t::recipient_id
coap_bin_const_t * recipient_id
Definition oscore_context.h:125
oscore_recipient_ctx_t::initial_state
uint8_t initial_state
Definition oscore_context.h:133
oscore_recipient_ctx_t::osc_ctx
oscore_ctx_t * osc_ctx
Definition oscore_context.h:123
oscore_sender_ctx_t
Definition oscore_context.h:110
oscore_sender_ctx_t::sender_id
coap_bin_const_t * sender_id
Definition oscore_context.h:112
oscore_sender_ctx_t::seq
uint64_t seq
Sender Sequence Number.
Definition oscore_context.h:114
oscore_sender_ctx_t::sender_key
coap_bin_const_t * sender_key
Definition oscore_context.h:113
oscore_sender_ctx_t::next_seq
uint64_t next_seq
Used for ssn_freq updating.
Definition oscore_context.h:116