libcoap 4.3.5-develop-b208419
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 || (COAP_RESPONSE_CLASS(pdu->code) != 2 &&
761 pdu->code != COAP_RESPONSE_CODE(401))))
762 oscore_delete_association(session, association);
763 association = NULL;
764
765 if (!coap_pdu_encode_header(osc_pdu, session->proto)) {
766 goto error;
767 }
768
769 /*
770 * Set up an association for handling a response if this is a request
771 */
772 if (coap_request) {
773 association = oscore_find_association(session, &pdu_token);
774 if (association) {
775 /* Refresh the association */
776 coap_delete_bin_const(association->nonce);
777 association->nonce =
778 coap_new_bin_const(cose->nonce.s, cose->nonce.length);
779 if (association->nonce == NULL)
780 goto error;
781 coap_delete_bin_const(association->aad);
782 association->aad = coap_new_bin_const(cose->aad.s, cose->aad.length);
783 if (association->aad == NULL)
784 goto error;
785 if (doing_observe && observe_value == 1) {
786 coap_delete_bin_const(association->obs_partial_iv);
787 association->obs_partial_iv = association->partial_iv;
788 } else {
789 coap_delete_bin_const(association->partial_iv);
790 }
791 association->partial_iv =
792 coap_new_bin_const(cose->partial_iv.s, cose->partial_iv.length);
793 if (association->partial_iv == NULL)
794 goto error;
795 coap_oscore_association_set_recipient_ctx(association, rcp_ctx);
796 coap_delete_pdu_lkd(association->sent_pdu);
797 if (session->b_2_step != COAP_OSCORE_B_2_NONE || association->just_set_up) {
798 size_t size;
799
800 association->sent_pdu = coap_pdu_duplicate_lkd(pdu, session,
801 pdu_token.length,
802 pdu_token.s, NULL,
803 COAP_BOOL_FALSE);
804 if (association->sent_pdu == NULL)
805 goto error;
806 if (coap_get_data(pdu, &size, &data)) {
807 coap_add_data(association->sent_pdu, size, data);
808 }
809 association->just_set_up = 0;
810 } else {
811 association->sent_pdu = NULL;
812 }
813 } else if (!oscore_new_association(session,
814 pdu,
815 &pdu_token,
816 rcp_ctx,
817 &cose->aad,
818 &cose->nonce,
819 &cose->partial_iv,
820 doing_observe)) {
821 goto error;
822 }
823 }
824 return osc_pdu;
825
826error:
827 if (association && (association->is_observe == 0 || (COAP_RESPONSE_CLASS(pdu->code) != 2 &&
828 pdu->code != COAP_RESPONSE_CODE(401))))
829 oscore_delete_association(session, association);
830 if (ciphertext_buffer)
831 coap_free_type(COAP_OSCORE_BUF, ciphertext_buffer);
832 coap_delete_pdu_lkd(osc_pdu);
833 coap_delete_pdu_lkd(plain_pdu);
834 return NULL;
835}
836
837static void
838build_and_send_error_pdu(coap_session_t *session,
839 coap_pdu_t *rcvd,
840 coap_pdu_code_t code,
841 const char *diagnostic,
842 uint8_t *echo_data,
843 coap_bin_const_t *kid_context,
844 int encrypt_oscore) {
845 coap_pdu_t *err_pdu = NULL;
846 coap_bin_const_t token;
847 int oscore_encryption = session->oscore_encryption;
848 unsigned char buf[4];
849
850 token = coap_pdu_get_token(rcvd);
851 err_pdu = coap_pdu_init(rcvd->type == COAP_MESSAGE_NON ? COAP_MESSAGE_NON :
852 COAP_MESSAGE_ACK,
853 code,
854 rcvd->mid,
855 token.length + 2 + 8 +
856 (diagnostic ? strlen(diagnostic) : 0));
857 if (!err_pdu)
858 return;
859 coap_add_token(err_pdu, token.length, token.s);
860 if (echo_data) {
861 coap_add_option_internal(err_pdu, COAP_OPTION_ECHO, 8, echo_data);
862 } else if (kid_context == NULL) {
863 coap_add_option_internal(err_pdu,
864 COAP_OPTION_MAXAGE,
865 coap_encode_var_safe(buf, sizeof(buf), 0),
866 buf);
867 }
868 if (diagnostic)
869 coap_add_data(err_pdu, strlen(diagnostic), (const uint8_t *)diagnostic);
870 session->oscore_encryption = encrypt_oscore;
871
872 if ((echo_data || kid_context) && encrypt_oscore) {
873 coap_pdu_t *osc_pdu;
874
875 osc_pdu =
876 coap_oscore_new_pdu_encrypted_lkd(session, err_pdu, kid_context,
877 echo_data ? 1 : 0);
878 if (!osc_pdu)
879 goto fail_resp;
880 session->oscore_encryption = 0;
881 coap_send_internal(session, osc_pdu, NULL);
882 coap_delete_pdu_lkd(err_pdu);
883 err_pdu = NULL;
884 } else {
885 coap_send_internal(session, err_pdu, NULL);
886 err_pdu = NULL;
887 }
888fail_resp:
889 session->oscore_encryption = oscore_encryption;
890 coap_delete_pdu_lkd(err_pdu);
891 return;
892}
893
894oscore_ctx_t *
895coap_init_oscore_context_from_conf(coap_oscore_conf_t *oscore_conf) {
896 oscore_ctx_t *oscore_ctx = oscore_derive_ctx_from_conf(oscore_conf);
897
898 if (oscore_ctx == NULL) {
899 goto error;
900 }
901
902 /* As all is stored in osc_ctx, oscore_conf is no longer needed */
903 coap_free_type(COAP_STRING, oscore_conf);
904
905 return oscore_ctx;
906error:
907 coap_delete_oscore_conf(oscore_conf);
908 return NULL;
909}
910
911/* pdu contains incoming message with encrypted COSE ciphertext payload
912 * function returns decrypted message
913 * and verifies signature, if present
914 * returns NULL when decryption,verification fails
915 */
916coap_pdu_t *
917coap_oscore_decrypt_pdu(coap_session_t *session,
918 coap_pdu_t *pdu) {
919 coap_pdu_t *decrypt_pdu = NULL;
920 coap_pdu_t *plain_pdu = NULL;
921 const uint8_t *osc_value; /* value of OSCORE option */
922 uint8_t osc_size; /* size of OSCORE OPTION */
923 coap_opt_iterator_t opt_iter;
924 coap_opt_t *opt = NULL;
925 cose_encrypt0_t cose[1];
926 oscore_ctx_t *osc_ctx = NULL;
927 uint8_t aad_buffer[AAD_BUF_LEN];
928 uint8_t nonce_buffer[13];
929 coap_bin_const_t aad;
930 coap_bin_const_t nonce;
931 int pltxt_size = 0;
932 int got_resp_piv = 0;
933 int doing_resp_observe = 0;
934 uint8_t coap_request = COAP_PDU_IS_REQUEST(pdu);
935 coap_bin_const_t pdu_token;
936 uint8_t *st_encrypt;
937 size_t encrypt_len;
938 size_t tag_len;
939 oscore_recipient_ctx_t *rcp_ctx = NULL;
940 oscore_association_t *association = NULL;
941 uint8_t external_aad_buffer[100];
942 coap_bin_const_t external_aad;
943 oscore_sender_ctx_t *snd_ctx = NULL;
944#if COAP_CLIENT_SUPPORT
945 coap_pdu_t *sent_pdu = NULL;
946#endif /* COAP_CLIENT_SUPPORT */
947
948 opt = coap_check_option(pdu, COAP_OPTION_OSCORE, &opt_iter);
949 assert(opt);
950 if (opt == NULL)
951 return NULL;
952
953 if (session->context->p_osc_ctx == NULL && session->context->oscore_find_cb == NULL) {
954 coap_log_warn("OSCORE: Not enabled\n");
955 if (!coap_request)
956 coap_handle_event_lkd(session->context,
957 COAP_EVENT_OSCORE_NOT_ENABLED,
958 session);
959 return NULL;
960 }
961
962 if (pdu->data == NULL) {
963 coap_log_warn("OSCORE: No protected payload\n");
964 if (!coap_request)
965 coap_handle_event_lkd(session->context,
966 COAP_EVENT_OSCORE_NO_PROTECTED_PAYLOAD,
967 session);
968 return NULL;
969 }
970
971 osc_size = coap_opt_length(opt);
972 osc_value = coap_opt_value(opt);
973
974 cose_encrypt0_init(cose); /* clear cose memory */
975
976 /* PDU code will be filled in after decryption */
977 decrypt_pdu =
978 coap_pdu_init(pdu->type, 0, pdu->mid, pdu->used_size);
979 if (decrypt_pdu == NULL) {
980 if (!coap_request)
981 coap_handle_event_lkd(session->context,
982 COAP_EVENT_OSCORE_INTERNAL_ERROR,
983 session);
984 goto error;
985 }
986
987 /* Copy across the Token */
988 pdu_token = coap_pdu_get_token(pdu);
989 coap_add_token(decrypt_pdu, pdu_token.length, pdu_token.s);
990
991 /*
992 * 8.2/8.4 Step 1.
993 * Copy outer options across, except E and OSCORE options
994 */
995 coap_option_iterator_init(pdu, &opt_iter, COAP_OPT_ALL);
996 while ((opt = coap_option_next(&opt_iter))) {
997 switch ((coap_code_opt_num_t)opt_iter.number) {
998 /* 'E' options skipped */
999 case COAP_OPTION_IF_MATCH:
1000 case COAP_OPTION_ETAG:
1001 case COAP_OPTION_IF_NONE_MATCH:
1002 case COAP_OPTION_OBSERVE:
1003 case COAP_OPTION_LOCATION_PATH:
1004 case COAP_OPTION_URI_PATH:
1005 case COAP_OPTION_URI_PATH_ABB:
1006 case COAP_OPTION_CONTENT_FORMAT:
1007 case COAP_OPTION_MAXAGE:
1008 case COAP_OPTION_URI_QUERY:
1009 case COAP_OPTION_ACCEPT:
1010 case COAP_OPTION_Q_BLOCK1:
1011 case COAP_OPTION_LOCATION_QUERY:
1012 case COAP_OPTION_BLOCK2:
1013 case COAP_OPTION_BLOCK1:
1014 case COAP_OPTION_SIZE2:
1015 case COAP_OPTION_Q_BLOCK2:
1016 case COAP_OPTION_SIZE1:
1017 case COAP_OPTION_NORESPONSE:
1018 case COAP_OPTION_ECHO:
1019 case COAP_OPTION_RTAG:
1020 /* OSCORE does not get copied across */
1021 case COAP_OPTION_OSCORE:
1022 break;
1023 /* 'U' options included */
1024 case COAP_OPTION_URI_HOST:
1025 case COAP_OPTION_URI_PORT:
1026 case COAP_OPTION_HOP_LIMIT:
1027 case COAP_OPTION_EDHOC:
1028 case COAP_OPTION_PROXY_URI:
1029 case COAP_OPTION_PROXY_SCHEME:
1030 default:
1031 if (!coap_add_option_internal(decrypt_pdu,
1032 opt_iter.number,
1033 coap_opt_length(opt),
1034 coap_opt_value(opt))) {
1035 if (!coap_request)
1036 coap_handle_event_lkd(session->context,
1037 COAP_EVENT_OSCORE_INTERNAL_ERROR,
1038 session);
1039 goto error;
1040 }
1041 break;
1042 }
1043 }
1044
1045 if (coap_request) {
1046 uint64_t incoming_seq;
1047 /*
1048 * 8.2 Step 2
1049 * Decompress COSE object
1050 * Get Recipient Context based on kid and optional kid_context
1051 */
1052 if (oscore_decode_option_value(osc_value, osc_size, cose) == 0) {
1053 coap_log_warn("OSCORE: OSCORE Option cannot be decoded.\n");
1054 build_and_send_error_pdu(session,
1055 pdu,
1056 COAP_RESPONSE_CODE(402),
1057 "Failed to decode COSE",
1058 NULL,
1059 NULL,
1060 0);
1061 goto error_no_ack;
1062 }
1063 osc_ctx = oscore_find_context(session,
1064 cose->key_id,
1065 &cose->kid_context,
1066 NULL,
1067 &rcp_ctx);
1068 if (!osc_ctx) {
1069 if (cose->kid_context.length > 0) {
1070 const uint8_t *ptr;
1071 size_t length;
1072 /* Appendix B.2 protocol check - Is the recipient key_id known */
1073 osc_ctx = oscore_find_context(session,
1074 cose->key_id,
1075 NULL,
1076 session->oscore_r2 != 0 ? (uint8_t *)&session->oscore_r2 : NULL,
1077 &rcp_ctx);
1078 ptr = cose->kid_context.s;
1079 length = cose->kid_context.length;
1080 if (ptr && osc_ctx && osc_ctx->rfc8613_b_2) {
1081 /* Processing Appendix B.2 protocol */
1082 /* Need to CBOR unwrap kid_context */
1083 coap_bin_const_t kid_context;
1084
1085 kid_context.length = oscore_cbor_get_element_size(&ptr, &length);
1086 if (kid_context.length > length)
1087 goto error;
1088 /* This has to fit into an OSCORE option max 255.
1089 * Initial byte, kid_context size, partial IV size and kid size have to be there
1090 */
1091 if (kid_context.length >= 255 - 1 - 1 - cose->partial_iv.length - cose->key_id.length)
1092 goto error;
1093 kid_context.s = ptr;
1094 cose_encrypt0_set_kid_context(cose, (coap_bin_const_t *)&kid_context);
1095
1096 if (session->oscore_r2 != 0) {
1097 /* B.2 step 4 */
1098 coap_bin_const_t *kc = coap_new_bin_const(cose->kid_context.s,
1099 cose->kid_context.length);
1100
1101 if (kc == NULL)
1102 goto error;
1103
1104 session->b_2_step = COAP_OSCORE_B_2_STEP_4;
1105 coap_log_oscore("Appendix B.2 server step 4 (R2 || R3)\n");
1106 oscore_update_ctx(osc_ctx, kc);
1107 } else {
1108 session->b_2_step = COAP_OSCORE_B_2_STEP_2;
1109 coap_log_oscore("Appendix B.2 server step 2 (ID1)\n");
1110 osc_ctx = oscore_duplicate_ctx(session->context,
1111 osc_ctx,
1112 osc_ctx->sender_context->sender_id,
1113 &cose->key_id,
1114 &cose->kid_context);
1115 if (osc_ctx == NULL)
1116 goto error;
1117 /*
1118 * Complete the Verify (B.2 step 2)
1119 * before sending back the response
1120 */
1121 rcp_ctx = osc_ctx->recipient_chain;
1122 }
1123 } else {
1124 osc_ctx = NULL;
1125 }
1126 }
1127 } else if (session->b_2_step != COAP_OSCORE_B_2_NONE) {
1128 session->b_2_step = COAP_OSCORE_B_2_NONE;
1129 coap_log_oscore("Appendix B.2 server finished\n");
1130 }
1131 if (!osc_ctx) {
1132 coap_log_err("OSCORE: Security Context not found\n");
1133 oscore_log_hex_value(COAP_LOG_OSCORE, "key_id", &cose->key_id);
1134 oscore_log_hex_value(COAP_LOG_OSCORE, "kid_context", &cose->kid_context);
1135 build_and_send_error_pdu(session,
1136 pdu,
1137 COAP_RESPONSE_CODE(401),
1138 "Security context not found",
1139 NULL,
1140 NULL,
1141 0);
1142 goto error_no_ack;
1143 }
1144 /* to be used for encryption of returned response later */
1145 coap_oscore_session_set_recipient_ctx(session, rcp_ctx);
1146 snd_ctx = osc_ctx->sender_context;
1147
1148 /*
1149 * 8.2 Step 3.
1150 * Verify Partial IV is not duplicated.
1151 *
1152 * Requires in COSE object as appropriate
1153 * partial_iv (as received)
1154 */
1155 if ((rcp_ctx->initial_state == 0 || osc_ctx->rfc8613_b_1_2 == 0) &&
1156 !oscore_validate_sender_seq(rcp_ctx, cose)) {
1157 coap_log_warn("OSCORE: Replayed or old message\n");
1158 build_and_send_error_pdu(session,
1159 pdu,
1160 COAP_RESPONSE_CODE(401),
1161 "Replay detected",
1162 NULL,
1163 NULL,
1164 0);
1165 goto error_no_ack;
1166 }
1167 if (rcp_ctx->initial_state == 1) {
1168 incoming_seq =
1169 coap_decode_var_bytes8(cose->partial_iv.s, cose->partial_iv.length);
1170 rcp_ctx->last_seq = incoming_seq;
1171 } else if (session->context->oscore_update_seq_num_cb != NULL) {
1172 /* notify custom credential storage */
1173 coap_lock_callback(session->context->oscore_update_seq_num_cb(session,
1174 rcp_ctx->recipient_id,
1175 osc_ctx->id_context,
1176 rcp_ctx->last_seq,
1177 rcp_ctx->sliding_window));
1178 }
1179 } else { /* !coap_request */
1180 /*
1181 * 8.4 Step 2
1182 * Decompress COSE object
1183 * Get Recipient Context based on token
1184 */
1185 if (oscore_decode_option_value(osc_value, osc_size, cose) == 0) {
1186 coap_log_warn("OSCORE: OSCORE Option cannot be decoded.\n");
1187 coap_handle_event_lkd(session->context,
1188 COAP_EVENT_OSCORE_DECODE_ERROR,
1189 session);
1190 goto error;
1191 }
1192 got_resp_piv = cose->partial_iv.length ? 1 : 0;
1193
1194 association = oscore_find_association(session, &pdu_token);
1195 if (association) {
1196 rcp_ctx = association->recipient_ctx;
1197 osc_ctx = rcp_ctx->osc_ctx;
1198 snd_ctx = osc_ctx->sender_context;
1199#if COAP_CLIENT_SUPPORT
1200 sent_pdu = association->sent_pdu;
1201 if (session->b_2_step != COAP_OSCORE_B_2_NONE) {
1202 const uint8_t *ptr = cose->kid_context.s;
1203 size_t length = cose->kid_context.length;
1204
1205 if (ptr) {
1206 /* Need to CBOR unwrap kid_context */
1207 coap_bin_const_t kid_context;
1208
1209 kid_context.length = oscore_cbor_get_element_size(&ptr, &length);
1210 if (kid_context.length > length)
1211 goto error;
1212 /* This has to fit into an OSCORE option max 255.
1213 * Initial byte, kid_context size, partial IV size and kid size have to be there
1214 */
1215 if (kid_context.length >= 255 - 1 - 1 - cose->partial_iv.length - cose->key_id.length)
1216 goto error;
1217 kid_context.s = ptr;
1218 cose_encrypt0_set_kid_context(cose, &kid_context);
1219 }
1220 if (ptr && !coap_binary_equal(osc_ctx->id_context, &cose->kid_context)) {
1221 /* If Appendix B.2 step 3 is in operation */
1222 /* Need to update Security Context with new (R2 || ID1) ID Context */
1223 coap_binary_t *kc = coap_new_binary(cose->kid_context.length +
1224 osc_ctx->id_context->length);
1225
1226 if (kc == NULL) {
1227 coap_handle_event_lkd(session->context,
1228 COAP_EVENT_OSCORE_INTERNAL_ERROR,
1229 session);
1230 goto error;
1231 }
1232
1233 memcpy(kc->s, cose->kid_context.s, cose->kid_context.length);
1234 memcpy(&kc->s[cose->kid_context.length],
1235 osc_ctx->id_context->s,
1236 osc_ctx->id_context->length);
1237
1238 session->b_2_step = COAP_OSCORE_B_2_STEP_3;
1239 coap_log_oscore("Appendix B.2 client step 3 (R2 || ID1)\n");
1240 oscore_update_ctx(osc_ctx, (coap_bin_const_t *)kc);
1241 } else {
1242 session->b_2_step = COAP_OSCORE_B_2_STEP_5;
1243 coap_log_oscore("Appendix B.2 client step 5 (R2 || R3)\n");
1244 }
1245 }
1246#endif /* COAP_CLIENT_SUPPORT */
1247 } else {
1248 coap_log_crit("OSCORE: Security Context association not found\n");
1249 coap_handle_event_lkd(session->context,
1250 COAP_EVENT_OSCORE_NO_SECURITY,
1251 session);
1252 goto error;
1253 }
1254 }
1255
1256 cose_encrypt0_set_alg(cose, osc_ctx->aead_alg);
1257
1258 if (coap_request) {
1259 /*
1260 * RFC8613 8.2 Step 4.
1261 * Compose the External AAD and then AAD
1262 *
1263 * OSCORE_option requires
1264 * partial_iv (cose partial_iv)
1265 * kid_context (cose kid_context)
1266 * key_id (cose key_id)
1267 * group_flag
1268 *
1269 * Non Group requires the following
1270 * RFC8613 5.4
1271 * oscore_version 1
1272 * algorithms [
1273 * aead_alg (osc_ctx)
1274 * ]
1275 * request_kid (request key_id using cose)
1276 * request_piv (request partial_iv using cose)
1277 * options (none at present)
1278 *
1279 * Note: No I options at present
1280 */
1281
1282 /* External AAD */
1283 external_aad.s = external_aad_buffer;
1284 external_aad.length = oscore_prepare_e_aad(osc_ctx,
1285 cose,
1286 osc_value,
1287 osc_size,
1288 NULL,
1289 external_aad_buffer,
1290 sizeof(external_aad_buffer));
1291 if (external_aad.length == 0)
1292 goto error;
1293 cose_encrypt0_set_external_aad(cose, &external_aad);
1294
1295 /* AAD */
1296 aad.s = aad_buffer;
1297 aad.length = oscore_prepare_aad(external_aad_buffer,
1298 external_aad.length,
1299 aad_buffer,
1300 sizeof(aad_buffer));
1301 if (aad.length == 0)
1302 goto error;
1303 assert(aad.length < AAD_BUF_LEN);
1304 cose_encrypt0_set_aad(cose, &aad);
1305
1306 /*
1307 * RFC8613 8.2 Step 5.
1308 * Compute the AEAD nonce.
1309 *
1310 * Requires in COSE object as appropriate
1311 * key_id (kid) (Recipient ID)
1312 * partial_iv (as received in request)
1313 * common_iv (already in osc_ctx)
1314 */
1315 nonce.s = nonce_buffer;
1316 nonce.length = 13;
1317 oscore_generate_nonce(cose, osc_ctx, nonce_buffer, 13);
1318 cose_encrypt0_set_nonce(cose, &nonce);
1319 /*
1320 * Set up an association for use in the response
1321 */
1322 association = oscore_find_association(session, &pdu_token);
1323 if (association) {
1324 /* Refresh the association */
1325 coap_delete_bin_const(association->nonce);
1326 association->nonce =
1327 coap_new_bin_const(cose->nonce.s, cose->nonce.length);
1328 if (association->nonce == NULL)
1329 goto error;
1330 coap_delete_bin_const(association->partial_iv);
1331 association->partial_iv =
1332 coap_new_bin_const(cose->partial_iv.s, cose->partial_iv.length);
1333 if (association->partial_iv == NULL)
1334 goto error;
1335 coap_delete_bin_const(association->aad);
1336 association->aad = coap_new_bin_const(cose->aad.s, cose->aad.length);
1337 if (association->aad == NULL)
1338 goto error;
1339 coap_oscore_association_set_recipient_ctx(association, rcp_ctx);
1340 /* So association is not released when handling decrypt */
1341 association = NULL;
1342 } else if (!oscore_new_association(session,
1343 NULL,
1344 &pdu_token,
1345 rcp_ctx,
1346 &cose->aad,
1347 &cose->nonce,
1348 &cose->partial_iv,
1349 0)) {
1350 goto error;
1351 }
1352 /* So association is not released when handling decrypt */
1353 association = NULL;
1354 } else { /* ! coap_request */
1355 /* Need to do nonce before AAD because of different partial_iv */
1356 /*
1357 * 8.4 Step 4.
1358 * Compose the AEAD nonce.
1359 */
1360 cose_encrypt0_set_key_id(cose, rcp_ctx->recipient_id);
1361 if (cose->partial_iv.length == 0) {
1362 cose_encrypt0_set_partial_iv(cose, association->partial_iv);
1363 cose_encrypt0_set_nonce(cose, association->nonce);
1364 } else {
1365 uint64_t last_seq;
1366
1367 if ((rcp_ctx->initial_state == 0 || osc_ctx->rfc8613_b_1_2 == 0) &&
1368 !oscore_validate_sender_seq(rcp_ctx, cose)) {
1369 coap_log_warn("OSCORE: Replayed or old message\n");
1370 goto error;
1371 }
1372 last_seq =
1373 coap_decode_var_bytes8(cose->partial_iv.s, cose->partial_iv.length);
1374 if (rcp_ctx->last_seq>= OSCORE_SEQ_MAX) {
1375 coap_log_warn("OSCORE Replay protection, SEQ larger than SEQ_MAX.\n");
1376 goto error;
1377 }
1378 if (last_seq > rcp_ctx->last_seq)
1379 rcp_ctx->last_seq = last_seq;
1380 /*
1381 * Requires in COSE object as appropriate
1382 * kid (set above)
1383 * partial_iv (as received)
1384 * common_iv (already in osc_ctx)
1385 */
1386 oscore_generate_nonce(cose, osc_ctx, nonce_buffer, 13);
1387 nonce.s = nonce_buffer;
1388 nonce.length = 13;
1389 cose_encrypt0_set_nonce(cose, &nonce);
1390 }
1391#ifdef OSCORE_EXTRA_DEBUG
1392 dump_cose(cose, "!req post set nonce");
1393#endif /* OSCORE_EXTRA_DEBUG */
1394 /*
1395 * 8.4 Step 3.
1396 * Compose the External AAD and then AAD
1397 *
1398 * OSCORE_option requires
1399 * partial_iv (cose partial_iv)
1400 * kid_context (cose kid_context)
1401 * key_id (cose key_id)
1402 * group_flag
1403 *
1404 * Non Group requires the following
1405 * RFC8613 5.4
1406 * oscore_version 1
1407 * algorithms [
1408 * aead_alg (osc_ctx)
1409 * ]
1410 * request_kid (request key_id using cose)
1411 * request_piv (request partial_iv using cose)
1412 * options (none at present)
1413 *
1414 * Note: No I options at present
1415 */
1416
1417 /* External AAD */
1418 cose_encrypt0_set_key_id(cose, snd_ctx->sender_id);
1419 if (association->is_observe && association->obs_partial_iv && got_resp_piv) {
1420 cose_encrypt0_set_partial_iv(cose, association->obs_partial_iv);
1421 } else {
1422 cose_encrypt0_set_partial_iv(cose, association->partial_iv);
1423 }
1424#ifdef OSCORE_EXTRA_DEBUG
1425 dump_cose(cose, "!req pre aad");
1426#endif /* OSCORE_EXTRA_DEBUG */
1427 external_aad.s = external_aad_buffer;
1428 external_aad.length = oscore_prepare_e_aad(osc_ctx,
1429 cose,
1430 NULL,
1431 0,
1432 NULL,
1433 external_aad_buffer,
1434 sizeof(external_aad_buffer));
1435 if (external_aad.length == 0)
1436 goto error;
1437 cose_encrypt0_set_external_aad(cose, &external_aad);
1438
1439 /* AAD */
1440 aad.s = aad_buffer;
1441 aad.length = oscore_prepare_aad(external_aad_buffer,
1442 external_aad.length,
1443 aad_buffer,
1444 sizeof(aad_buffer));
1445 if (aad.length == 0)
1446 goto error;
1447 assert(aad.length < AAD_BUF_LEN);
1448 cose_encrypt0_set_aad(cose, &aad);
1449#ifdef OSCORE_EXTRA_DEBUG
1450 dump_cose(cose, "!req post set aad");
1451#endif /* OSCORE_EXTRA_DEBUG */
1452 }
1453
1454 /*
1455 * 8.2 Step 6 / 8.4 Step 5.
1456 * Decrypt the COSE object.
1457 *
1458 * Requires in COSE object as appropriate
1459 * alg (already set)
1460 * key
1461 * nonce (already set)
1462 * aad (already set)
1463 * ciphertext
1464 */
1465 st_encrypt = pdu->data;
1466 encrypt_len = pdu->used_size - (pdu->data - pdu->token);
1467 if (encrypt_len <= 0) {
1468 coap_log_warn("OSCORE: No protected payload\n");
1469 if (!coap_request)
1470 coap_handle_event_lkd(session->context,
1471 COAP_EVENT_OSCORE_NO_PROTECTED_PAYLOAD,
1472 session);
1473 goto error;
1474 }
1475 cose_encrypt0_set_key(cose, rcp_ctx->recipient_key);
1476 cose_encrypt0_set_ciphertext(cose, st_encrypt, encrypt_len);
1477
1478 tag_len = cose_tag_len(cose->alg);
1479 /* Decrypt into plain_pdu, so code (token), options and data are in place */
1480 plain_pdu = coap_pdu_init(pdu->type, 0, 0, encrypt_len /* - tag_len */);
1481 if (plain_pdu == NULL) {
1482 if (!coap_request)
1483 coap_handle_event_lkd(session->context,
1484 COAP_EVENT_OSCORE_INTERNAL_ERROR,
1485 session);
1486 goto error;
1487 }
1488
1489 /* need the tag_len on the end for TinyDTLS to do its work - yuk */
1490 if (!coap_pdu_resize(plain_pdu, encrypt_len /* - tag_len */)) {
1491 if (!coap_request)
1492 coap_handle_event_lkd(session->context,
1493 COAP_EVENT_OSCORE_INTERNAL_ERROR,
1494 session);
1495 goto error;
1496 }
1497
1498 /* Account for 1 byte 'code' used as token */
1499 plain_pdu->e_token_length = 1;
1500 plain_pdu->actual_token.length = 1;
1501 /* Account for the decrypted data */
1502 plain_pdu->used_size = encrypt_len - tag_len;
1503
1504 dump_cose(cose, "Pre decrypt");
1505 pltxt_size =
1506 cose_encrypt0_decrypt(cose, plain_pdu->token, encrypt_len - tag_len);
1507 if (pltxt_size <= 0) {
1508 coap_log_warn("OSCORE: Decryption Failure, result code: %d \n",
1509 (int)pltxt_size);
1510 if (coap_request) {
1511 build_and_send_error_pdu(session,
1512 pdu,
1513 COAP_RESPONSE_CODE(400),
1514 "Decryption failed",
1515 NULL,
1516 NULL,
1517 0);
1518 oscore_roll_back_seq(rcp_ctx);
1519 goto error_no_ack;
1520 } else {
1521 coap_handle_event_lkd(session->context,
1522 COAP_EVENT_OSCORE_DECRYPTION_FAILURE,
1523 session);
1524 }
1525 goto error;
1526 }
1527
1528 assert((size_t)pltxt_size < pdu->alloc_size + pdu->max_hdr_size);
1529
1530 /* Appendix B.2 Trap */
1531 if (session->b_2_step == COAP_OSCORE_B_2_STEP_2) {
1532 /* Need to update Security Context with new (R2 || ID1) ID Context */
1533 coap_binary_t *kc =
1534 coap_new_binary(sizeof(session->oscore_r2) + cose->kid_context.length);
1535 coap_bin_const_t oscore_r2;
1536
1537 if (kc == NULL) {
1538 if (!coap_request)
1539 coap_handle_event_lkd(session->context,
1540 COAP_EVENT_OSCORE_INTERNAL_ERROR,
1541 session);
1542 goto error;
1543 }
1544
1545 coap_prng_lkd(&session->oscore_r2, sizeof(session->oscore_r2));
1546 memcpy(kc->s, &session->oscore_r2, sizeof(session->oscore_r2));
1547 memcpy(&kc->s[sizeof(session->oscore_r2)],
1548 cose->kid_context.s,
1549 cose->kid_context.length);
1550
1551 coap_log_oscore("Appendix B.2 server step 2 (R2 || ID1)\n");
1552 oscore_update_ctx(osc_ctx, (coap_bin_const_t *)kc);
1553
1554 oscore_r2.length = sizeof(session->oscore_r2);
1555 oscore_r2.s = (const uint8_t *)&session->oscore_r2;
1556 coap_log_oscore("Appendix B.2 server step 2 plain response\n");
1557 build_and_send_error_pdu(session,
1558 pdu,
1559 COAP_RESPONSE_CODE(401),
1560 NULL,
1561 NULL,
1562 &oscore_r2,
1563 1);
1564 goto error_no_ack;
1565 }
1566#if COAP_CLIENT_SUPPORT
1567 if (session->b_2_step == COAP_OSCORE_B_2_STEP_3) {
1568 coap_log_oscore("Appendix B.2 client step 3 (R2 || R3)\n");
1569 coap_pdu_encode_header(plain_pdu, session->proto);
1570 plain_pdu->actual_token.s = plain_pdu->token;
1571 plain_pdu->code = plain_pdu->token[0];
1572 if (plain_pdu->code != COAP_RESPONSE_CODE(401)) {
1573 coap_log_warn("OSCORE Appendix B.2: Expected 4.01 response\n");
1574 }
1575 /* Skip the options */
1576 coap_option_iterator_init(plain_pdu, &opt_iter, COAP_OPT_ALL);
1577 while (coap_option_next(&opt_iter)) {
1578 }
1579 if (opt_iter.length > 0 && opt_iter.next_option &&
1580 opt_iter.next_option[0] == COAP_PAYLOAD_START) {
1581 plain_pdu->data = &opt_iter.next_option[1];
1582 }
1583 coap_log_oscore("Inner Response PDU (plaintext)\n");
1584 coap_show_pdu(COAP_LOG_OSCORE, plain_pdu);
1585 /*
1586 * Need to update Security Context with new (R2 || R3) ID Context
1587 * and retransmit the request
1588 */
1589 coap_binary_t *kc = coap_new_binary(cose->kid_context.length + 8);
1590
1591 if (kc == NULL) {
1592 if (!coap_request)
1593 coap_handle_event_lkd(session->context,
1594 COAP_EVENT_OSCORE_INTERNAL_ERROR,
1595 session);
1596 goto error;
1597 }
1598 memcpy(kc->s, cose->kid_context.s, cose->kid_context.length);
1599 coap_prng_lkd(&kc->s[cose->kid_context.length], 8);
1600
1601 oscore_update_ctx(osc_ctx, (coap_bin_const_t *)kc);
1602
1603 coap_cancel_all_messages(session->context,
1604 session,
1605 &pdu->actual_token);
1606 if (session->con_active)
1607 session->con_active--;
1608 coap_send_ack_lkd(session, pdu);
1609 if (sent_pdu) {
1610 coap_log_oscore("Appendix B.2 retransmit pdu\n");
1611 if (!session->b_2_retransmit_token) {
1612 session->b_2_retransmit_token = coap_new_str_const(sent_pdu->actual_token.s,
1613 sent_pdu->actual_token.length);
1614 }
1615 if (coap_retransmit_oscore_pdu(session, sent_pdu, NULL) ==
1616 COAP_INVALID_MID)
1617 goto error_no_ack;
1618 }
1619 goto error_no_ack;
1620 }
1621#endif /* COAP_CLIENT_SUPPORT */
1622
1623#if COAP_SERVER_SUPPORT
1624 /* Appendix B.1.2 request Trap */
1625 if (coap_request && osc_ctx->rfc8613_b_1_2) {
1626 if (rcp_ctx->initial_state == 1) {
1627 opt = coap_check_option(plain_pdu, COAP_OPTION_ECHO, &opt_iter);
1628 if (opt) {
1629 /* Verify Client is genuine */
1630 if (coap_opt_length(opt) == 8 &&
1631 memcmp(coap_opt_value(opt), rcp_ctx->echo_value, 8) == 0) {
1632 /* This clears rcp_ctx->initial_state */
1633 if (!oscore_validate_sender_seq(rcp_ctx, cose)) {
1634 coap_log_warn("OSCORE: Replayed or old message\n");
1635 build_and_send_error_pdu(session,
1636 pdu,
1637 COAP_RESPONSE_CODE(401),
1638 "Replay detected",
1639 NULL,
1640 NULL,
1641 0);
1642 goto error_no_ack;
1643 } else {
1644 if (session->context->oscore_update_seq_num_cb != NULL) {
1645 /* notify echo challenge changed */
1646 coap_lock_callback(session->context->oscore_update_seq_num_cb(session,
1647 rcp_ctx->recipient_id,
1648 osc_ctx->id_context,
1649 rcp_ctx->last_seq,
1650 rcp_ctx->sliding_window));
1651 }
1652 }
1653 } else
1654 goto error;
1655 } else {
1656 /* RFC 8163 Appendix B.1.2 */
1657 if (session->b_2_step == COAP_OSCORE_B_2_STEP_4) {
1658 session->b_2_step = COAP_OSCORE_B_2_NONE;
1659 coap_log_oscore("Appendix B.2 server finished\n");
1660 }
1661 coap_prng_lkd(rcp_ctx->echo_value, sizeof(rcp_ctx->echo_value));
1662 coap_log_oscore("Appendix B.1.2 server plain response\n");
1663
1664 build_and_send_error_pdu(session,
1665 pdu,
1666 COAP_RESPONSE_CODE(401),
1667 NULL,
1668 rcp_ctx->echo_value,
1669 NULL,
1670 1);
1671 goto error_no_ack;
1672 }
1673 }
1674 }
1675#endif /* COAP_SERVER_SUPPORT */
1676
1677 /*
1678 * 8.2 Step 7 / 8.4 Step 6.
1679 * Add decrypted Code, options and payload
1680 * [OSCORE option not copied across previously]
1681 */
1682
1683 /* PDU code is pseudo plain_pdu token */
1684 decrypt_pdu->code = plain_pdu->token[0];
1685
1686 /* Copy inner decrypted options across */
1687 coap_option_iterator_init(plain_pdu, &opt_iter, COAP_OPT_ALL);
1688 while ((opt = coap_option_next(&opt_iter))) {
1689 size_t len;
1690 size_t bias;
1691
1692 switch (opt_iter.number) {
1693 case COAP_OPTION_OSCORE:
1694 break;
1695 case COAP_OPTION_OBSERVE:
1696 if (!coap_request) {
1697 bias = cose->partial_iv.length > 3 ? cose->partial_iv.length - 3 : 0;
1698 len = cose->partial_iv.length > 3 ? 3 : cose->partial_iv.length;
1699 /* Make Observe option reflect last 3 bytes of partial_iv */
1700 if (!coap_add_option_internal(
1701 decrypt_pdu,
1702 opt_iter.number,
1703 len,
1704 cose->partial_iv.s ? &cose->partial_iv.s[bias] : NULL)) {
1705 coap_handle_event_lkd(session->context,
1706 COAP_EVENT_OSCORE_INTERNAL_ERROR,
1707 session);
1708 goto error;
1709 }
1710 doing_resp_observe = 1;
1711 break;
1712 }
1713 association = oscore_find_association(session, &pdu_token);
1714 if (association) {
1715 association->is_observe = 1;
1716 association = NULL;
1717 }
1718 /* Fall Through */
1719 default:
1720 if (!coap_insert_option(decrypt_pdu,
1721 opt_iter.number,
1722 coap_opt_length(opt),
1723 coap_opt_value(opt))) {
1724 if (!coap_request)
1725 coap_handle_event_lkd(session->context,
1726 COAP_EVENT_OSCORE_INTERNAL_ERROR,
1727 session);
1728 goto error;
1729 }
1730 break;
1731 }
1732 }
1733 if (!coap_request && !doing_resp_observe) {
1734 if (association) {
1735 association->is_observe = 0;
1736 }
1737 }
1738 /* Need to copy across any data */
1739 if (opt_iter.length > 0 && opt_iter.next_option &&
1740 opt_iter.next_option[0] == COAP_PAYLOAD_START) {
1741 plain_pdu->data = &opt_iter.next_option[1];
1742 if (!coap_add_data(decrypt_pdu,
1743 plain_pdu->used_size -
1744 (plain_pdu->data - plain_pdu->token),
1745 plain_pdu->data)) {
1746 if (!coap_request)
1747 coap_handle_event_lkd(session->context,
1748 COAP_EVENT_OSCORE_INTERNAL_ERROR,
1749 session);
1750 goto error;
1751 }
1752 }
1753 coap_delete_pdu_lkd(plain_pdu);
1754 plain_pdu = NULL;
1755
1756 /* Make sure headers are correctly set up */
1757 if (!coap_pdu_encode_header(decrypt_pdu, session->proto)) {
1758 if (!coap_request)
1759 coap_handle_event_lkd(session->context,
1760 COAP_EVENT_OSCORE_INTERNAL_ERROR,
1761 session);
1762 goto error;
1763 }
1764
1765 if (session->b_2_step != COAP_OSCORE_B_2_NONE) {
1766 session->b_2_step = COAP_OSCORE_B_2_NONE;
1767 coap_log_oscore("Appendix B.2 client finished\n");
1768 if (session->b_2_retransmit_token) {
1769 coap_update_token(decrypt_pdu, session->b_2_retransmit_token->length,
1770 session->b_2_retransmit_token->s);
1771 coap_delete_str_const(session->b_2_retransmit_token);
1772 session->b_2_retransmit_token = NULL;
1773 }
1774 }
1775#if COAP_CLIENT_SUPPORT
1776 if (decrypt_pdu->code == COAP_RESPONSE_CODE(401) &&
1777 (opt = coap_check_option(decrypt_pdu, COAP_OPTION_ECHO, &opt_iter))) {
1778 /* Server is requesting Echo refresh check */
1779 coap_cancel_all_messages(session->context,
1780 session,
1781 &pdu->actual_token);
1782 if (session->con_active)
1783 session->con_active--;
1784 if (!sent_pdu) {
1785 coap_lg_crcv_t *lg_crcv = coap_find_lg_crcv(session, pdu);
1786
1787 if (lg_crcv)
1788 sent_pdu = lg_crcv->sent_pdu;
1789 }
1790 if (sent_pdu) {
1791 coap_send_ack_lkd(session, pdu);
1792 coap_log_debug("PDU requesting re-transmit\n");
1793 coap_show_pdu(COAP_LOG_DEBUG, decrypt_pdu);
1794 coap_log_oscore("RFC9175 retransmit pdu\n");
1795 /* Do not care if this fails */
1796 if (coap_retransmit_oscore_pdu(session, sent_pdu, opt) != COAP_INVALID_MID) {
1797 session->doing_b_1_2 = 1;
1798 }
1799 goto error_no_ack;
1800 }
1801 } else if (session->doing_b_1_2) {
1802 coap_lg_crcv_t *lg_crcv = coap_find_lg_crcv(session, pdu);
1803
1804 if (lg_crcv) {
1805 if (!coap_binary_equal(&decrypt_pdu->actual_token, lg_crcv->app_token)) {
1806 coap_update_token(decrypt_pdu, lg_crcv->app_token->length, lg_crcv->app_token->s);
1807 }
1808 }
1809 session->doing_b_1_2 = 0;
1810 }
1811#endif /* COAP_CLIENT_SUPPORT */
1812 if (association && association->is_observe == 0)
1813 oscore_delete_association(session, association);
1814 return decrypt_pdu;
1815
1816error:
1817 coap_send_ack_lkd(session, pdu);
1818error_no_ack:
1819 if (association && association->is_observe == 0)
1820 oscore_delete_association(session, association);
1821 coap_delete_pdu_lkd(decrypt_pdu);
1822 coap_delete_pdu_lkd(plain_pdu);
1823 return NULL;
1824}
1825
1826typedef enum {
1827 COAP_ENC_ASCII = 0x001,
1828 COAP_ENC_HEX = 0x002,
1829 COAP_ENC_CONFIG = 0x0200,
1830 COAP_ENC_INTEGER = 0x400,
1831 COAP_ENC_TEXT = 0x800,
1832 COAP_ENC_BOOL = 0x1000,
1833 COAP_ENC_UNSIGNED64 = 0x2000,
1834 COAP_ENC_LAST
1835} coap_oscore_coding_t;
1836
1837#undef TEXT_MAPPING
1838#define TEXT_MAPPING(t, v) \
1839 { { sizeof(#t)-1, (const uint8_t *)#t }, v }
1840
1841static struct coap_oscore_encoding_t {
1842 coap_str_const_t name;
1843 coap_oscore_coding_t encoding;
1844} oscore_encoding[] = {
1845 TEXT_MAPPING(ascii, COAP_ENC_ASCII),
1846 TEXT_MAPPING(hex, COAP_ENC_HEX),
1847 TEXT_MAPPING(config, COAP_ENC_CONFIG),
1848 TEXT_MAPPING(integer, COAP_ENC_INTEGER),
1849 TEXT_MAPPING(unsigned64, COAP_ENC_UNSIGNED64),
1850 TEXT_MAPPING(text, COAP_ENC_TEXT),
1851 TEXT_MAPPING(bool, COAP_ENC_BOOL),
1852 {{0, NULL}, COAP_ENC_LAST}
1853};
1854
1855typedef struct {
1856 coap_oscore_coding_t encoding;
1857 const char *encoding_name;
1858 union {
1859 int value_int;
1860 uint64_t value_int64;
1861 coap_bin_const_t *value_bin;
1862 coap_str_const_t value_str;
1863 } u;
1864} oscore_value_t;
1865
1866/*
1867 * Return 1 if hex character
1868 * 0 not hex character
1869 */
1870static int
1871hex_to_char(char c, uint8_t *value) {
1872 if ('a' <= c && c <= 'f') {
1873 *value = c - 'a' + 10;
1874 } else if ('A' <= c && c <= 'F') {
1875 *value = c - 'A' + 10;
1876 } else if ('0' <= c && c <= '9') {
1877 *value = c - '0';
1878 } else {
1879 *value = 0;
1880 return 0;
1881 }
1882 return 1;
1883}
1884
1885/* Parse the hex into binary */
1886static coap_bin_const_t *
1887parse_hex_bin(const char *begin, const char *end) {
1888 coap_binary_t *binary = NULL;
1889 size_t i;
1890 size_t o = 0;
1891
1892 binary = coap_new_binary((end - begin) / 2);
1893 if (binary == NULL)
1894 goto bad_entry;
1895 for (i = 0; (i < (size_t)(end - begin)); i++) {
1896 while ((i < (size_t)(end - begin)) &&
1897 (begin[i] == '\r' || begin[i] == '\n' || begin[i] == ' ')) {
1898 i++;
1899 }
1900 if (i == (size_t)(end - begin))
1901 break;
1902 if (isxdigit((uint8_t)begin[i])) {
1903 uint8_t value;
1904
1905 if (!hex_to_char(begin[i], &value)) {
1906 goto bad_entry;
1907 }
1908 binary->s[o] = value << 4;
1909 i++;
1910 while ((i < (size_t)(end - begin)) &&
1911 (begin[i] == '\r' || begin[i] == '\n' || begin[i] == ' ')) {
1912 i++;
1913 }
1914 if (i == (size_t)(end - begin))
1915 goto bad_entry;
1916 if (!hex_to_char(begin[i], &value)) {
1917 goto bad_entry;
1918 }
1919 binary->s[o++] += value;
1920 } else {
1921 break;
1922 }
1923 }
1924 if (i != (size_t)(end - begin))
1925 goto bad_entry;
1926 return (coap_bin_const_t *)binary;
1927
1928bad_entry:
1929 coap_delete_binary(binary);
1930 return NULL;
1931}
1932
1933/*
1934 * Break up each OSCORE Configuration line entry into the 3 parts which
1935 * are comma separated
1936 *
1937 * keyword,encoding,value
1938 */
1939static int
1940get_split_entry(const char **start,
1941 size_t size,
1942 coap_str_const_t *keyword,
1943 oscore_value_t *value,
1944 cose_curve_t sign_curve) {
1945 const char *begin = *start;
1946 const char *keep_start = *start;
1947 const char *end;
1948 const char *kend;
1949 const char *tend;
1950 const char *split;
1951 size_t i;
1952 size_t len;
1953 (void)sign_curve;
1954
1955retry:
1956 kend = end = memchr(begin, '\n', size);
1957 if (end == NULL)
1958 return 0;
1959
1960 /* Check for multi-line */
1961 if ((tend = memchr(begin, '"', end - begin))) {
1962 /* See if " terminator is on the same line */
1963 if (!memchr(tend + 1, '"', end - tend -1)) {
1964 /* Over multiple lines */
1965 kend = end = memchr(end, '"', size - (end - begin));
1966 if (end == NULL)
1967 return 0;
1968 kend = end = memchr(kend, '\n', size - (kend - begin));
1969 if (end == NULL)
1970 return 0;
1971 }
1972 }
1973
1974 /* Track beginning of next line */
1975 *start = end + 1;
1976 if (end > begin && end[-1] == '\r')
1977 end--;
1978
1979 if (begin[0] == '#' || (end - begin) == 0) {
1980 /* Skip comment / blank line */
1981 size -= kend - begin + 1;
1982 begin = *start;
1983 keep_start = *start;
1984 goto retry;
1985 }
1986
1987 /* Get in the keyword */
1988 split = memchr(begin, ',', end - begin);
1989 if (split == NULL)
1990 goto bad_entry;
1991
1992 keyword->s = (const uint8_t *)begin;
1993 keyword->length = split - begin;
1994
1995 begin = split + 1;
1996 if ((end - begin) == 0)
1997 goto bad_entry;
1998 /* Get in the encoding */
1999 split = memchr(begin, ',', end - begin);
2000 if (split == NULL)
2001 goto bad_entry;
2002
2003 for (i = 0; oscore_encoding[i].name.s; i++) {
2004 coap_str_const_t temp = { split - begin, (const uint8_t *)begin };
2005
2006 if (coap_string_equal(&temp, &oscore_encoding[i].name)) {
2007 value->encoding = oscore_encoding[i].encoding;
2008 value->encoding_name = (const char *)oscore_encoding[i].name.s;
2009 break;
2010 }
2011 }
2012 if (oscore_encoding[i].name.s == NULL)
2013 goto bad_entry;
2014
2015 begin = split + 1;
2016 if ((end - begin) == 0)
2017 goto bad_entry;
2018 /* Get in the keyword's value */
2019 if (value->encoding == COAP_ENC_CONFIG && begin[0] == '\'') {
2020 split = memchr(&begin[1], '\'', size - (begin - keep_start) - 1);
2021 if (split == NULL)
2022 goto bad_entry;
2023 end = memchr(split, '\n', size - (split - keep_start));
2024 if (end == NULL)
2025 return 0;
2026 *start = end + 1;
2027 end = split;
2028 begin++;
2029 } else {
2030 if (begin[0] == '"') {
2031 split = memchr(&begin[1], '"', end - split - 1);
2032 if (split == NULL)
2033 goto bad_entry;
2034 end = split;
2035 begin++;
2036 }
2037 }
2038 switch (value->encoding) {
2039 case COAP_ENC_CONFIG:
2040 case COAP_ENC_ASCII:
2041 value->u.value_bin =
2042 coap_new_bin_const((const uint8_t *)begin, end - begin);
2043 if (value->u.value_bin == NULL)
2044 goto bad_entry;
2045 break;
2046 case COAP_ENC_HEX:
2047 /* Parse the hex into binary */
2048 value->u.value_bin = parse_hex_bin(begin, end);
2049 if (value->u.value_bin == NULL)
2050 goto bad_entry;
2051 break;
2052 case COAP_ENC_INTEGER:
2053 value->u.value_int = atoi(begin);
2054 break;
2055 case COAP_ENC_UNSIGNED64: {
2056 value->u.value_int64 = strtoull(begin, NULL, 10);
2057 break;
2058 }
2059 case COAP_ENC_TEXT:
2060 value->u.value_str.s = (const uint8_t *)begin;
2061 value->u.value_str.length = end - begin;
2062 break;
2063 case COAP_ENC_BOOL:
2064 len = (size_t)(end - begin);
2065 if (len == 4 && memcmp("true", begin, len) == 0)
2066 value->u.value_int = 1;
2067 else if (len == 5 && memcmp("false", begin, len) == 0)
2068 value->u.value_int = 0;
2069 else
2070 goto bad_entry;
2071 break;
2072 case COAP_ENC_LAST:
2073 default:
2074 goto bad_entry;
2075 }
2076 return 1;
2077
2078bad_entry:
2079 coap_log_warn("oscore_conf: Unrecognized configuration entry '%.*s'\n",
2080 (int)(end - begin),
2081 begin);
2082 return -1;
2083
2084}
2085
2086#undef CONFIG_ENTRY
2087#define CONFIG_ENTRY(n, e, t) \
2088 { { sizeof(#n)-1, (const uint8_t *)#n }, e, \
2089 offsetof(coap_oscore_conf_t, n), t }
2090
2091#undef CONFIG_SND_ENTRY
2092#define CONFIG_SND_ENTRY(n, e, t) \
2093 { { sizeof(#n)-1, (const uint8_t *)#n }, e, \
2094 offsetof(coap_oscore_snd_conf_t, n), t }
2095
2096#undef CONFIG_RCP_ENTRY
2097#define CONFIG_RCP_ENTRY(n, e, t) \
2098 { { sizeof(#n)-1, (const uint8_t *)#n }, e, \
2099 offsetof(coap_oscore_rcp_conf_t, n), t }
2100
2101#undef CONFIG_DUMMY_ENTRY
2102#define CONFIG_DUMMY_ENTRY(n, e, t) \
2103 { { sizeof(#n)-1, (const uint8_t *)#n }, e, 0, t }
2104
2105typedef struct oscore_text_mapping_t {
2106 coap_str_const_t text;
2107 int value;
2108} oscore_text_mapping_t;
2109
2110/* Naming as per https://www.iana.org/assignments/cose/cose.xhtml#algorithms */
2111static oscore_text_mapping_t text_aead_alg[] = {
2112 TEXT_MAPPING(AES-CCM-16-64-128, COSE_ALGORITHM_AES_CCM_16_64_128),
2113 TEXT_MAPPING(AES-CCM-16-64-256, COSE_ALGORITHM_AES_CCM_16_64_256),
2114 {{0, NULL}, 0}
2115};
2116
2117static oscore_text_mapping_t text_hkdf_alg[] = {
2118 TEXT_MAPPING(direct+HKDF-SHA-256, COSE_HKDF_ALG_HKDF_SHA_256),
2119 {{0, NULL}, 0}
2120};
2121
2122typedef struct oscore_config_t {
2123 coap_str_const_t str_keyword;
2124 coap_oscore_coding_t encoding;
2125 size_t offset;
2126 oscore_text_mapping_t *text_mapping;
2127} oscore_config_t;
2128
2129static oscore_config_t oscore_config[] = {
2130 CONFIG_ENTRY(aead_alg, COAP_ENC_INTEGER | COAP_ENC_TEXT, text_aead_alg),
2131 CONFIG_ENTRY(hkdf_alg, COAP_ENC_INTEGER | COAP_ENC_TEXT, text_hkdf_alg),
2132 CONFIG_ENTRY(master_secret, COAP_ENC_HEX | COAP_ENC_ASCII, NULL),
2133 CONFIG_ENTRY(master_salt, COAP_ENC_HEX | COAP_ENC_ASCII, NULL),
2134 CONFIG_ENTRY(id_context, COAP_ENC_HEX | COAP_ENC_ASCII, NULL),
2135
2136 CONFIG_DUMMY_ENTRY(sender_id, COAP_ENC_HEX | COAP_ENC_ASCII, NULL),
2137
2138 CONFIG_DUMMY_ENTRY(recipient_id, COAP_ENC_HEX | COAP_ENC_ASCII, NULL),
2139
2140 CONFIG_ENTRY(replay_window, COAP_ENC_INTEGER, NULL),
2141 CONFIG_ENTRY(ssn_freq, COAP_ENC_INTEGER, NULL),
2142 CONFIG_ENTRY(rfc8613_b_1_2, COAP_ENC_BOOL, NULL),
2143 CONFIG_ENTRY(rfc8613_b_2, COAP_ENC_BOOL, NULL),
2144 CONFIG_ENTRY(break_sender_key, COAP_ENC_BOOL, NULL),
2145 CONFIG_ENTRY(break_recipient_key, COAP_ENC_BOOL, NULL),
2146 CONFIG_DUMMY_ENTRY(complex_sender, COAP_ENC_CONFIG, NULL),
2147 CONFIG_DUMMY_ENTRY(complex_recipient, COAP_ENC_CONFIG, NULL),
2148};
2149
2150static oscore_config_t oscore_snd_config[] = {
2151 CONFIG_SND_ENTRY(sender_id, COAP_ENC_HEX | COAP_ENC_ASCII, NULL),
2152};
2153
2154static oscore_config_t oscore_rcp_config[] = {
2155 CONFIG_RCP_ENTRY(recipient_id, COAP_ENC_HEX | COAP_ENC_ASCII, NULL),
2156 CONFIG_RCP_ENTRY(silent_server, COAP_ENC_BOOL, NULL),
2157 CONFIG_DUMMY_ENTRY(last_seq, COAP_ENC_UNSIGNED64, NULL),
2158 CONFIG_DUMMY_ENTRY(sliding_window, COAP_ENC_UNSIGNED64, NULL),
2159};
2160
2161
2162int
2163coap_delete_oscore_snd_conf(coap_oscore_snd_conf_t *snd_conf) {
2164 if (snd_conf == NULL)
2165 return 0;
2166
2167 coap_delete_bin_const(snd_conf->sender_id);
2168 coap_free_type(COAP_STRING, snd_conf);
2169 return 1;
2170}
2171
2172int
2173coap_delete_oscore_rcp_conf(coap_oscore_rcp_conf_t *rcp_conf) {
2174 if (rcp_conf == NULL)
2175 return 0;
2176
2177 coap_delete_bin_const(rcp_conf->recipient_id);
2178 coap_free_type(COAP_STRING, rcp_conf);
2179 return 1;
2180}
2181
2182int
2183coap_delete_oscore_conf(coap_oscore_conf_t *oscore_conf) {
2184 coap_oscore_rcp_conf_t *rcp_conf;
2185 if (oscore_conf == NULL)
2186 return 0;
2187
2188 coap_delete_bin_const(oscore_conf->master_secret);
2189 coap_delete_bin_const(oscore_conf->master_salt);
2190 coap_delete_bin_const(oscore_conf->id_context);
2191 coap_delete_oscore_snd_conf(oscore_conf->sender);
2192
2193 rcp_conf = oscore_conf->recipient_chain;
2194 while (rcp_conf) {
2195 coap_oscore_rcp_conf_t *rcp_next = rcp_conf->next_recipient;
2196
2197 coap_delete_oscore_rcp_conf(rcp_conf);
2198 rcp_conf = rcp_next;
2199 }
2200
2201 coap_free_type(COAP_STRING, oscore_conf);
2202 return 1;
2203}
2204
2205static coap_oscore_snd_conf_t *
2206coap_parse_oscore_snd_conf_mem(coap_bin_const_t conf_mem) {
2207 const char *start = (const char *)conf_mem.s;
2208 const char *end = start + conf_mem.length;
2209 coap_str_const_t keyword;
2210 oscore_value_t value;
2211 coap_oscore_snd_conf_t *snd_conf;
2212
2213 snd_conf = coap_malloc_type(COAP_STRING, sizeof(coap_oscore_snd_conf_t));
2214 if (snd_conf == NULL)
2215 return NULL;
2216 memset(snd_conf, 0, sizeof(coap_oscore_snd_conf_t));
2217
2218 memset(&value, 0, sizeof(value));
2219
2220 while (end > start &&
2221 get_split_entry(&start, end - start, &keyword, &value, 0) > 0) {
2222 size_t i;
2223 size_t j;
2224
2225 for (i = 0; i < sizeof(oscore_snd_config) / sizeof(oscore_snd_config[0]); i++) {
2226 if (coap_string_equal(&oscore_snd_config[i].str_keyword, &keyword) != 0 &&
2227 value.encoding & oscore_snd_config[i].encoding) {
2228 coap_bin_const_t *unused_check;
2229
2230 switch (value.encoding) {
2231 case COAP_ENC_HEX:
2232 case COAP_ENC_ASCII:
2233 memcpy(&unused_check,
2234 &(((char *)snd_conf)[oscore_snd_config[i].offset]),
2235 sizeof(unused_check));
2236 if (unused_check != NULL) {
2237 coap_log_warn("oscore_snd_conf: Keyword '%.*s' duplicated\n",
2238 (int)keyword.length,
2239 (const char *)keyword.s);
2240 coap_delete_bin_const(value.u.value_bin);
2241 goto error;
2242 }
2243 memcpy(&(((char *)snd_conf)[oscore_snd_config[i].offset]),
2244 &value.u.value_bin,
2245 sizeof(value.u.value_bin));
2246 break;
2247 case COAP_ENC_INTEGER:
2248 case COAP_ENC_BOOL:
2249 memcpy(&(((char *)snd_conf)[oscore_snd_config[i].offset]),
2250 &value.u.value_int,
2251 sizeof(value.u.value_int));
2252 break;
2253 case COAP_ENC_TEXT:
2254 for (j = 0; oscore_snd_config[i].text_mapping[j].text.s != NULL; j++) {
2255 if (memcmp(value.u.value_str.s,
2256 oscore_snd_config[i].text_mapping[j].text.s,
2257 value.u.value_str.length) == 0) {
2258 memcpy(&(((char *)snd_conf)[oscore_snd_config[i].offset]),
2259 &oscore_snd_config[i].text_mapping[j].value,
2260 sizeof(oscore_snd_config[i].text_mapping[j].value));
2261 break;
2262 }
2263 }
2264 if (oscore_snd_config[i].text_mapping[j].text.s == NULL) {
2265 coap_log_warn("oscore_snd_conf: Keyword '%.*s': value '%.*s' unknown\n",
2266 (int)keyword.length,
2267 (const char *)keyword.s,
2268 (int)value.u.value_str.length,
2269 (const char *)value.u.value_str.s);
2270 goto error;
2271 }
2272 break;
2273 case COAP_ENC_CONFIG:
2274 case COAP_ENC_UNSIGNED64:
2275 case COAP_ENC_LAST:
2276 default:
2277 assert(0);
2278 break;
2279 }
2280 break;
2281 }
2282 }
2283 if (i == sizeof(oscore_snd_config) / sizeof(oscore_snd_config[0])) {
2284 coap_log_warn("oscore_snd_conf: Keyword '%.*s', type '%s' unknown\n",
2285 (int)keyword.length,
2286 (const char *)keyword.s,
2287 value.encoding_name);
2288 if (value.encoding == COAP_ENC_HEX || value.encoding == COAP_ENC_ASCII ||
2289 value.encoding == COAP_ENC_CONFIG)
2290 coap_delete_bin_const(value.u.value_bin);
2291 goto error;
2292 }
2293 }
2294 if (!snd_conf->sender_id) {
2295 coap_log_warn("oscore_snd_conf: sender_id not defined\n");
2296 goto error;
2297 }
2298 if (snd_conf->sender_id->length > 7) {
2299 coap_log_warn("oscore_snd_conf: Maximum size of sender_id is 7 bytes\n");
2300 goto error;
2301 }
2302 return snd_conf;
2303
2304error:
2305 coap_delete_oscore_snd_conf(snd_conf);
2306 return NULL;
2307}
2308
2309static coap_oscore_rcp_conf_t *
2310coap_parse_oscore_rcp_conf_mem(coap_bin_const_t conf_mem) {
2311 const char *start = (const char *)conf_mem.s;
2312 const char *end = start + conf_mem.length;
2313 coap_str_const_t keyword;
2314 oscore_value_t value;
2315 coap_oscore_rcp_conf_t *rcp_conf;
2316
2317 rcp_conf = coap_malloc_type(COAP_STRING, sizeof(coap_oscore_rcp_conf_t));
2318 if (rcp_conf == NULL)
2319 return NULL;
2320 memset(rcp_conf, 0, sizeof(coap_oscore_rcp_conf_t));
2321
2322 memset(&value, 0, sizeof(value));
2323
2324 while (end > start &&
2325 get_split_entry(&start, end - start, &keyword, &value, 0) > 0) {
2326 size_t i;
2327 size_t j;
2328
2329 for (i = 0; i < sizeof(oscore_rcp_config) / sizeof(oscore_rcp_config[0]); i++) {
2330 if (coap_string_equal(&oscore_rcp_config[i].str_keyword, &keyword) != 0 &&
2331 value.encoding & oscore_rcp_config[i].encoding) {
2332 if (coap_string_equal(coap_make_str_const("last_seq"), &keyword)) {
2333 rcp_conf->last_seq = value.u.value_int64;
2334 rcp_conf->window_initialized = 1;
2335 } else if (coap_string_equal(coap_make_str_const("sliding_window"), &keyword)) {
2336 rcp_conf->sliding_window = value.u.value_int64;
2337 rcp_conf->window_initialized = 1;
2338 } else {
2339 coap_bin_const_t *unused_check;
2340
2341 switch (value.encoding) {
2342 case COAP_ENC_HEX:
2343 case COAP_ENC_ASCII:
2344 memcpy(&unused_check,
2345 &(((char *)rcp_conf)[oscore_rcp_config[i].offset]),
2346 sizeof(unused_check));
2347 if (unused_check != NULL) {
2348 coap_log_warn("oscore_rcp_conf: Keyword '%.*s' duplicated\n",
2349 (int)keyword.length,
2350 (const char *)keyword.s);
2351 coap_delete_bin_const(value.u.value_bin);
2352 goto error;
2353 }
2354 memcpy(&(((char *)rcp_conf)[oscore_rcp_config[i].offset]),
2355 &value.u.value_bin,
2356 sizeof(value.u.value_bin));
2357 break;
2358 case COAP_ENC_INTEGER:
2359 case COAP_ENC_BOOL:
2360 memcpy(&(((char *)rcp_conf)[oscore_rcp_config[i].offset]),
2361 &value.u.value_int,
2362 sizeof(value.u.value_int));
2363 break;
2364 case COAP_ENC_TEXT:
2365 for (j = 0; oscore_rcp_config[i].text_mapping[j].text.s != NULL; j++) {
2366 if (memcmp(value.u.value_str.s,
2367 oscore_rcp_config[i].text_mapping[j].text.s,
2368 value.u.value_str.length) == 0) {
2369 memcpy(&(((char *)rcp_conf)[oscore_rcp_config[i].offset]),
2370 &oscore_rcp_config[i].text_mapping[j].value,
2371 sizeof(oscore_rcp_config[i].text_mapping[j].value));
2372 break;
2373 }
2374 }
2375 if (oscore_rcp_config[i].text_mapping[j].text.s == NULL) {
2376 coap_log_warn("oscore_rcp_conf: Keyword '%.*s': value '%.*s' unknown\n",
2377 (int)keyword.length,
2378 (const char *)keyword.s,
2379 (int)value.u.value_str.length,
2380 (const char *)value.u.value_str.s);
2381 goto error;
2382 }
2383 break;
2384 case COAP_ENC_CONFIG:
2385 case COAP_ENC_UNSIGNED64:
2386 case COAP_ENC_LAST:
2387 default:
2388 assert(0);
2389 break;
2390 }
2391 }
2392 break;
2393 }
2394 }
2395 if (i == sizeof(oscore_rcp_config) / sizeof(oscore_rcp_config[0])) {
2396 coap_log_warn("oscore_rcp_conf: Keyword '%.*s', type '%s' unknown\n",
2397 (int)keyword.length,
2398 (const char *)keyword.s,
2399 value.encoding_name);
2400 if (value.encoding == COAP_ENC_HEX || value.encoding == COAP_ENC_ASCII ||
2401 value.encoding == COAP_ENC_CONFIG)
2402 coap_delete_bin_const(value.u.value_bin);
2403 goto error;
2404 }
2405 }
2406 if (!rcp_conf->recipient_id) {
2407 coap_log_warn("oscore_rcp_conf: recipient_id not defined\n");
2408 goto error;
2409 }
2410 if (rcp_conf->recipient_id->length > 7) {
2411 coap_log_warn("oscore_rcp_conf: Maximum size of recipient_id is 7 bytes\n");
2412 goto error;
2413 }
2414 return rcp_conf;
2415
2416error:
2417 coap_delete_oscore_rcp_conf(rcp_conf);
2418 return NULL;
2419}
2420
2421static coap_oscore_conf_t *
2422coap_parse_oscore_conf_mem(coap_str_const_t conf_mem) {
2423 const char *start = (const char *)conf_mem.s;
2424 const char *end = start + conf_mem.length;
2425 coap_str_const_t keyword;
2426 oscore_value_t value;
2427 coap_oscore_conf_t *oscore_conf;
2428 int split_ok = -1;
2429
2430 oscore_conf = coap_malloc_type(COAP_STRING, sizeof(coap_oscore_conf_t));
2431 if (oscore_conf == NULL)
2432 return NULL;
2433 memset(oscore_conf, 0, sizeof(coap_oscore_conf_t));
2434
2435 memset(&value, 0, sizeof(value));
2436 /* Preset with defaults RFC8612 3.2 */
2437 oscore_conf->replay_window = COAP_OSCORE_DEFAULT_REPLAY_WINDOW;
2438 oscore_conf->ssn_freq = 1;
2439 oscore_conf->aead_alg = COSE_ALGORITHM_AES_CCM_16_64_128;
2440 oscore_conf->hkdf_alg = COSE_HKDF_ALG_HKDF_SHA_256;
2441
2442 oscore_conf->rfc8613_b_1_2 = 1;
2443 oscore_conf->rfc8613_b_2 = 0;
2444 /* For debugging only */
2445 oscore_conf->break_sender_key = 0;
2446 oscore_conf->break_recipient_key = 0;
2447
2448 while (end > start &&
2449 (split_ok = get_split_entry(&start, end - start, &keyword, &value, 0)) > 0) {
2450 size_t i;
2451 size_t j;
2452
2453 for (i = 0; i < sizeof(oscore_config) / sizeof(oscore_config[0]); i++) {
2454 if (coap_string_equal(&oscore_config[i].str_keyword, &keyword) != 0 &&
2455 value.encoding & oscore_config[i].encoding) {
2456 if (coap_string_equal(coap_make_str_const("sender_id"), &keyword)) {
2457 if (value.u.value_bin->length > 7) {
2458 coap_log_warn("oscore_conf: Maximum size of sender_id is 7 bytes\n");
2459 goto error_free_value_bin;
2460 }
2461 if (oscore_conf->sender) {
2462 coap_log_warn("oscore_conf: sender_id duplicated\n");
2463 goto error_free_value_bin;
2464 }
2465 oscore_conf->sender = coap_malloc_type(COAP_STRING, sizeof(coap_oscore_snd_conf_t));
2466 if (!oscore_conf->sender)
2467 goto error_free_value_bin;
2468
2469 memset(oscore_conf->sender, 0, sizeof(coap_oscore_snd_conf_t));
2470 oscore_conf->sender->sender_id = value.u.value_bin;
2471 } else if (coap_string_equal(coap_make_str_const("recipient_id"), &keyword)) {
2472 coap_oscore_rcp_conf_t *rcp_conf;
2473
2474 if (value.u.value_bin->length > 7) {
2475 coap_log_warn("oscore_conf: Maximum size of recipient_id is 7 bytes\n");
2476 goto error_free_value_bin;
2477 }
2478 /* Special case as there are potentially multiple entries */
2479 rcp_conf = coap_malloc_type(COAP_STRING, sizeof(coap_oscore_rcp_conf_t));
2480 if (!rcp_conf)
2481 goto error_free_value_bin;
2482
2483 memset(rcp_conf, 0, sizeof(coap_oscore_rcp_conf_t));
2484 rcp_conf->recipient_id = value.u.value_bin;
2485 rcp_conf->next_recipient = oscore_conf->recipient_chain;
2486 oscore_conf->recipient_chain = rcp_conf;
2487 } else {
2488 coap_bin_const_t *unused_check;
2489
2490 switch (value.encoding) {
2491 case COAP_ENC_CONFIG:
2492 if (keyword.length == sizeof("complex_sender") - 1 &&
2493 memcmp(keyword.s, "complex_sender", keyword.length) == 0) {
2494 coap_oscore_snd_conf_t *snd_conf =
2495 coap_parse_oscore_snd_conf_mem(*value.u.value_bin);
2496
2497 if (!snd_conf) {
2498 coap_log_warn("oscore_conf: Keyword '%.*s' invalid\n",
2499 (int)keyword.length,
2500 (const char *)keyword.s);
2501 goto error_free_value_bin;
2502 }
2503 if (oscore_conf->sender) {
2504 coap_log_warn("oscore_conf: complex_sender duplicated\n");
2505 coap_delete_oscore_snd_conf(snd_conf);
2506 goto error_free_value_bin;
2507 }
2508 oscore_conf->sender = snd_conf;
2509 coap_delete_bin_const(value.u.value_bin);
2510 break;
2511 }
2512 if (keyword.length == sizeof("complex_recipient") - 1 &&
2513 memcmp(keyword.s, "complex_recipient", keyword.length) == 0) {
2514 coap_oscore_rcp_conf_t *rcp_conf =
2515 coap_parse_oscore_rcp_conf_mem(*value.u.value_bin);
2516
2517 if (!rcp_conf) {
2518 coap_log_warn("oscore_conf: Keyword '%.*s' invalid\n",
2519 (int)keyword.length,
2520 (const char *)keyword.s);
2521 goto error_free_value_bin;
2522 }
2523 rcp_conf->next_recipient = oscore_conf->recipient_chain;
2524 oscore_conf->recipient_chain = rcp_conf;
2525 coap_delete_bin_const(value.u.value_bin);
2526 }
2527 break;
2528 case COAP_ENC_ASCII:
2529 case COAP_ENC_HEX:
2530 memcpy(&unused_check,
2531 &(((char *)oscore_conf)[oscore_config[i].offset]),
2532 sizeof(unused_check));
2533 if (unused_check != NULL) {
2534 coap_log_warn("oscore_conf: Keyword '%.*s' duplicated\n",
2535 (int)keyword.length,
2536 (const char *)keyword.s);
2537 goto error_free_value_bin;
2538 }
2539 memcpy(&(((char *)oscore_conf)[oscore_config[i].offset]),
2540 &value.u.value_bin,
2541 sizeof(value.u.value_bin));
2542 break;
2543 case COAP_ENC_INTEGER:
2544 case COAP_ENC_BOOL:
2545 memcpy(&(((char *)oscore_conf)[oscore_config[i].offset]),
2546 &value.u.value_int,
2547 sizeof(value.u.value_int));
2548 break;
2549 case COAP_ENC_TEXT:
2550 for (j = 0; oscore_config[i].text_mapping[j].text.s != NULL; j++) {
2551 if (coap_string_equal(&value.u.value_str,
2552 &oscore_config[i].text_mapping[j].text)) {
2553 memcpy(&(((char *)oscore_conf)[oscore_config[i].offset]),
2554 &oscore_config[i].text_mapping[j].value,
2555 sizeof(oscore_config[i].text_mapping[j].value));
2556 break;
2557 }
2558 }
2559 if (oscore_config[i].text_mapping[j].text.s == NULL) {
2560 coap_log_warn("oscore_conf: Keyword '%.*s': value '%.*s' unknown\n",
2561 (int)keyword.length,
2562 (const char *)keyword.s,
2563 (int)value.u.value_str.length,
2564 (const char *)value.u.value_str.s);
2565 goto error;
2566 }
2567 break;
2568 case COAP_ENC_UNSIGNED64:
2569 case COAP_ENC_LAST:
2570 default:
2571 assert(0);
2572 break;
2573 }
2574 }
2575 break;
2576 }
2577 }
2578 if (i == sizeof(oscore_config) / sizeof(oscore_config[0])) {
2579 coap_log_warn("oscore_conf: Keyword '%.*s', type '%s' unknown\n",
2580 (int)keyword.length,
2581 (const char *)keyword.s,
2582 value.encoding_name);
2583 if (value.encoding == COAP_ENC_HEX || value.encoding == COAP_ENC_ASCII ||
2584 value.encoding == COAP_ENC_CONFIG) {
2585 coap_delete_bin_const(value.u.value_bin);
2586 }
2587 goto error;
2588 }
2589 }
2590 if (split_ok == -1)
2591 goto error;
2592 if (!oscore_conf->master_secret) {
2593 coap_log_warn("oscore_conf: master_secret not defined\n");
2594 goto error;
2595 }
2596 if (!oscore_conf->sender) {
2597 coap_log_warn("oscore_conf: sender_id not defined\n");
2598 goto error;
2599 }
2600 return oscore_conf;
2601
2602error_free_value_bin:
2603 coap_delete_bin_const(value.u.value_bin);
2604error:
2605 coap_delete_oscore_conf(oscore_conf);
2606 return NULL;
2607}
2608
2609static oscore_ctx_t *
2610coap_oscore_init(coap_context_t *c_context, coap_oscore_conf_t *oscore_conf) {
2611 oscore_ctx_t *osc_ctx = NULL;
2612
2613 if (!coap_crypto_check_cipher_alg(oscore_conf->aead_alg)) {
2614 coap_log_warn("COSE: Cipher Algorithm %d not supported\n",
2615 oscore_conf->aead_alg);
2616 goto error;
2617 }
2618 if (!coap_crypto_check_hkdf_alg(oscore_conf->hkdf_alg)) {
2619 coap_log_warn("COSE: HKDF Algorithm %d not supported\n",
2620 oscore_conf->hkdf_alg);
2621 goto error;
2622 }
2623
2624 osc_ctx = oscore_derive_ctx(c_context, oscore_conf);
2625 if (!osc_ctx) {
2626 coap_log_crit("OSCORE: Could not create Security Context!\n");
2627 coap_free_type(COAP_STRING, oscore_conf);
2628 return NULL;
2629 }
2630
2631 /* As all is stored in osc_ctx, oscore_conf is no longer needed */
2632 coap_free_type(COAP_STRING, oscore_conf);
2633
2634 /* return default first context */
2635 return osc_ctx;
2636
2637error:
2638 /* Remove from linked chain */
2639 oscore_remove_context(c_context, osc_ctx);
2640
2641 coap_delete_oscore_conf(oscore_conf);
2642 return NULL;
2643}
2644
2645void
2646coap_delete_all_oscore(coap_context_t *c_context) {
2647 oscore_free_contexts(c_context);
2648}
2649
2650void
2651coap_delete_oscore_associations(coap_session_t *session) {
2652 oscore_delete_server_associations(session);
2653}
2654
2655void
2656coap_oscore_session_set_recipient_ctx(coap_session_t *session,
2657 oscore_recipient_ctx_t *recipient_ctx) {
2658 oscore_recipient_ctx_t *old_ctx;
2659
2660 if (session == NULL || recipient_ctx == NULL)
2661 return;
2662
2663 if (session->recipient_ctx == recipient_ctx) {
2664 /* already attached */
2665 return;
2666 }
2667
2668 old_ctx = session->recipient_ctx;
2669
2670 /* attach recipient context */
2671 session->recipient_ctx = recipient_ctx;
2672 session->recipient_ctx->ref++;
2673
2674 if (old_ctx != NULL) {
2675 oscore_release_recipient_ctx(&old_ctx);
2676 }
2677}
2678
2679void
2680coap_oscore_association_set_recipient_ctx(oscore_association_t *association,
2681 oscore_recipient_ctx_t *recipient_ctx) {
2682 if (association == NULL)
2683 return;
2684
2685 if (association->recipient_ctx == recipient_ctx)
2686 return;
2687
2688 if (association->recipient_ctx != NULL) {
2689 association->recipient_ctx->ref--;
2690 }
2691
2692 association->recipient_ctx = recipient_ctx;
2693 association->recipient_ctx->ref++;
2694}
2695
2696coap_oscore_conf_t *
2697coap_new_oscore_conf(coap_str_const_t conf_mem,
2698 coap_oscore_save_seq_num_t save_seq_num_func,
2699 void *save_seq_num_func_param,
2700 uint64_t start_seq_num) {
2701 coap_oscore_conf_t *oscore_conf = coap_parse_oscore_conf_mem(conf_mem);
2702
2703 if (oscore_conf == NULL)
2704 return NULL;
2705
2706 oscore_conf->save_seq_num_func = save_seq_num_func;
2707 oscore_conf->save_seq_num_func_param = save_seq_num_func_param;
2708 oscore_conf->start_seq_num = start_seq_num;
2709 coap_log_oscore("Start Seq no %" PRIu64 "\n", start_seq_num);
2710 return oscore_conf;
2711}
2712
2713/*
2714 * Compute the size of the potential OSCORE overhead
2715 */
2716size_t
2717coap_oscore_overhead(coap_session_t *session, coap_pdu_t *pdu) {
2718 size_t overhead = 0;
2719 oscore_recipient_ctx_t *rcp_ctx = session->recipient_ctx;
2720 oscore_ctx_t *osc_ctx = rcp_ctx ? rcp_ctx->osc_ctx : NULL;
2721 coap_opt_iterator_t opt_iter;
2722 coap_opt_t *option;
2723
2724 if (osc_ctx == NULL)
2725 return 0;
2726
2727 /* Protected code held in inner PDU as token */
2728 overhead += 1;
2729
2730 /* Observe option (creates inner and outer */
2731 option = coap_check_option(pdu, COAP_OPTION_OBSERVE, &opt_iter);
2732 if (option) {
2733 /* Assume delta is small */
2734 overhead += 2 + coap_opt_length(option);
2735 }
2736
2737 /* Proxy URI option Split - covered by coap_rebuild_pdu_for_proxy () */
2738
2739 /* OSCORE option */
2740 /* Option header */
2741 overhead += 1 +
2742 /* Partial IV (64 bits max)*/
2743 8 +
2744 /* kid context */
2745 (osc_ctx->id_context ? osc_ctx->id_context->length : 0) +
2746 /* kid */
2747 osc_ctx->sender_context->sender_id->length;
2748
2749 /* AAD overhead */
2750 overhead += AES_CCM_TAG;
2751
2752 /* Extended Token Overhead */
2753 if (session->max_token_size)
2754 overhead += session->max_token_size - pdu->actual_token.length;
2755
2756 /* End of options marker */
2757 overhead += 1;
2758
2759 return overhead;
2760}
2761
2762COAP_API int
2763coap_new_oscore_recipient(coap_context_t *context,
2764 coap_bin_const_t *recipient_id) {
2765 int ret;
2766
2767 coap_lock_lock(return 0);
2768 ret = coap_new_oscore_recipient_lkd(context, recipient_id);
2769 coap_lock_unlock();
2770 return ret;
2771}
2772
2773int
2774coap_new_oscore_recipient_lkd(coap_context_t *context,
2775 coap_bin_const_t *recipient_id) {
2776 coap_oscore_rcp_conf_t *rcp_conf;
2777 oscore_recipient_ctx_t *rcp_ctx;
2778
2779 coap_lock_check_locked();
2780
2781 if (context->p_osc_ctx == NULL) {
2782 coap_delete_bin_const(recipient_id);
2783 return 0;
2784 }
2785 rcp_conf = coap_malloc_type(COAP_STRING, sizeof(coap_oscore_rcp_conf_t));
2786 if (rcp_conf == NULL) {
2787 coap_delete_bin_const(recipient_id);
2788 return 0;
2789 }
2790 memset(rcp_conf, 0, sizeof(coap_oscore_rcp_conf_t));
2791 rcp_conf->recipient_id = recipient_id;
2792 /* rcp_conf is released in oscore_add_recipient() */
2793 rcp_ctx = oscore_add_recipient(context->p_osc_ctx, rcp_conf, 0);
2794 if (rcp_ctx == NULL)
2795 return 0;
2796 return 1;
2797}
2798
2799COAP_API int
2800coap_delete_oscore_recipient(coap_context_t *context,
2801 coap_bin_const_t *recipient_id) {
2802 int ret;
2803
2804 if (!context || !recipient_id)
2805 return 0;
2806 coap_lock_lock(return 0);
2807 ret = coap_delete_oscore_recipient_lkd(context, recipient_id);
2808 coap_lock_unlock();
2809 return ret;
2810}
2811
2812int
2813coap_delete_oscore_recipient_lkd(coap_context_t *context,
2814 coap_bin_const_t *recipient_id) {
2815 coap_lock_check_locked();
2816 if (context->p_osc_ctx == NULL)
2817 return 0;
2818 return oscore_delete_recipient(context->p_osc_ctx, recipient_id);
2819}
2820
2821void
2822coap_oscore_register_external_handlers(coap_context_t *context,
2823 coap_oscore_find_handler_t find_handler,
2824 coap_oscore_update_seq_num_handler_t update_seq_num_handler) {
2825 if (context == NULL)
2826 return;
2827
2828 coap_lock_lock(return);
2829 context->oscore_find_cb = find_handler;
2830 context->oscore_update_seq_num_cb = update_seq_num_handler;
2831 coap_lock_unlock();
2832}
2833
2834static coap_oscore_rcp_conf_t *
2835coap_oscore_get_recipient_conf(coap_oscore_conf_t *oscore_conf,
2836 const coap_bin_const_t *rid) {
2837 coap_oscore_rcp_conf_t *next = oscore_conf->recipient_chain;
2838
2839 while (next) {
2840 if (coap_binary_equal(next->recipient_id, rid)) {
2841 return next;
2842 }
2843 next = next->next_recipient;
2844 }
2845 return NULL;
2846}
2847
2848
2849COAP_API int
2850coap_oscore_recipient_set_latest_seq(coap_oscore_conf_t *oscore_conf,
2851 const coap_bin_const_t *recipient_id,
2852 uint64_t last_seq, uint64_t seq_window) {
2853 int ret;
2854
2855 coap_lock_lock(return 0);
2856 ret = coap_oscore_recipient_set_latest_seq_lkd(oscore_conf, recipient_id, last_seq,
2857 seq_window);
2858 coap_lock_unlock();
2859 return ret;
2860}
2861
2862int
2863coap_oscore_recipient_set_latest_seq_lkd(coap_oscore_conf_t *oscore_conf,
2864 const coap_bin_const_t *recipient_id,
2865 uint64_t last_seq, uint64_t seq_window) {
2866 coap_oscore_rcp_conf_t *rcp_conf;
2867
2868 rcp_conf = coap_oscore_get_recipient_conf(oscore_conf, recipient_id);
2869 if (rcp_conf) {
2870 rcp_conf->last_seq = last_seq;
2871 rcp_conf->sliding_window = seq_window;
2872 return 1;
2873 }
2874 return 0;
2875}
2876
2878
2879#else /* !COAP_OSCORE_SUPPORT */
2880int
2881coap_oscore_is_supported(void) {
2882 return 0;
2883}
2884
2885coap_session_t *
2886coap_new_client_session_oscore(coap_context_t *ctx,
2887 const coap_address_t *local_if,
2888 const coap_address_t *server,
2889 coap_proto_t proto,
2890 coap_oscore_conf_t *oscore_conf) {
2891 (void)ctx;
2892 (void)local_if;
2893 (void)server;
2894 (void)proto;
2895 (void)oscore_conf;
2896 return NULL;
2897}
2898
2899coap_session_t *
2900coap_new_client_session_oscore3(coap_context_t *ctx,
2901 const coap_address_t *local_if,
2902 const coap_address_t *server,
2903 coap_proto_t proto,
2904 coap_oscore_conf_t *oscore_conf,
2905 void *app_data,
2906 coap_app_data_free_callback_t callback,
2907 coap_str_const_t *ws_host) {
2908 (void)ctx;
2909 (void)local_if;
2910 (void)server;
2911 (void)proto;
2912 (void)oscore_conf;
2913 (void)app_data;
2914 (void)callback;
2915 (void)ws_host;
2916 return NULL;
2917}
2918
2919coap_session_t *
2920coap_new_client_session_oscore_psk(coap_context_t *ctx,
2921 const coap_address_t *local_if,
2922 const coap_address_t *server,
2923 coap_proto_t proto,
2924 coap_dtls_cpsk_t *psk_data,
2925 coap_oscore_conf_t *oscore_conf) {
2926 (void)ctx;
2927 (void)local_if;
2928 (void)server;
2929 (void)proto;
2930 (void)psk_data;
2931 (void)oscore_conf;
2932 return NULL;
2933}
2934
2935coap_session_t *
2936coap_new_client_session_oscore_psk3(coap_context_t *ctx,
2937 const coap_address_t *local_if,
2938 const coap_address_t *server,
2939 coap_proto_t proto,
2940 coap_dtls_cpsk_t *psk_data,
2941 coap_oscore_conf_t *oscore_conf,
2942 void *app_data,
2943 coap_app_data_free_callback_t callback,
2944 coap_str_const_t *ws_host) {
2945 (void)ctx;
2946 (void)local_if;
2947 (void)server;
2948 (void)proto;
2949 (void)psk_data;
2950 (void)oscore_conf;
2951 (void)app_data;
2952 (void)callback;
2953 (void)ws_host;
2954 return NULL;
2955}
2956
2957coap_session_t *
2958coap_new_client_session_oscore_pki(coap_context_t *ctx,
2959 const coap_address_t *local_if,
2960 const coap_address_t *server,
2961 coap_proto_t proto,
2962 coap_dtls_pki_t *pki_data,
2963 coap_oscore_conf_t *oscore_conf) {
2964 (void)ctx;
2965 (void)local_if;
2966 (void)server;
2967 (void)proto;
2968 (void)pki_data;
2969 (void)oscore_conf;
2970 return NULL;
2971}
2972
2973coap_session_t *
2974coap_new_client_session_oscore_pki3(coap_context_t *ctx,
2975 const coap_address_t *local_if,
2976 const coap_address_t *server,
2977 coap_proto_t proto,
2978 coap_dtls_pki_t *pki_data,
2979 coap_oscore_conf_t *oscore_conf,
2980 void *app_data,
2981 coap_app_data_free_callback_t callback,
2982 coap_str_const_t *ws_host) {
2983 (void)ctx;
2984 (void)local_if;
2985 (void)server;
2986 (void)proto;
2987 (void)pki_data;
2988 (void)oscore_conf;
2989 (void)app_data;
2990 (void)callback;
2991 (void)ws_host;
2992 return NULL;
2993}
2994
2995int
2996coap_context_oscore_server(coap_context_t *context,
2997 coap_oscore_conf_t *oscore_conf) {
2998 (void)context;
2999 (void)oscore_conf;
3000 return 0;
3001}
3002
3003coap_oscore_conf_t *
3004coap_new_oscore_conf(coap_str_const_t conf_mem,
3005 coap_oscore_save_seq_num_t save_seq_num_func,
3006 void *save_seq_num_func_param,
3007 uint64_t start_seq_num) {
3008 (void)conf_mem;
3009 (void)save_seq_num_func;
3010 (void)save_seq_num_func_param;
3011 (void)start_seq_num;
3012 return NULL;
3013}
3014
3015int
3016coap_delete_oscore_conf(coap_oscore_conf_t *oscore_conf) {
3017 (void)oscore_conf;
3018 return 0;
3019}
3020
3021int
3022coap_new_oscore_recipient(coap_context_t *context,
3023 coap_bin_const_t *recipient_id) {
3024 (void)context;
3025 (void)recipient_id;
3026 return 0;
3027}
3028
3029int
3030coap_delete_oscore_recipient(coap_context_t *context,
3031 coap_bin_const_t *recipient_id) {
3032 (void)context;
3033 (void)recipient_id;
3034 return 0;
3035}
3036
3037void
3038coap_oscore_register_external_handlers(coap_context_t *context,
3039 coap_oscore_find_handler_t find_handler,
3040 coap_oscore_update_seq_num_handler_t update_seq_num_handler) {
3041 (void)context;
3042 (void)find_handler;
3043 (void)update_seq_num_handler;
3044}
3045
3046COAP_API int
3047coap_oscore_recipient_set_latest_seq(coap_oscore_conf_t *oscore_conf,
3048 const coap_bin_const_t *recipient_id,
3049 uint64_t last_seq, uint64_t seq_window) {
3050 (void)oscore_conf;
3051 (void)recipient_id;
3052 (void)last_seq;
3053 (void)seq_window;
3054 return 0;
3055}
3056
3057#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:3047
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:3004
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:2920
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:2936
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:3016
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:2886
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:2996
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:2958
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:2900
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:3022
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:3030
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:3038
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:2974
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:696
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:550
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:474
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:1622
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:340
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:863
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_RESPONSE_CLASS
#define COAP_RESPONSE_CLASS(C)
Definition coap_pdu.h:99
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:417
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:966
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:935
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:1742
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:2881
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