23#if COAP_OSCORE_SUPPORT
26#define AAD_BUF_LEN 200
31#if COAP_CLIENT_SUPPORT
39 coap_log_warn(
"OSCORE: Recipient ID must be defined for a client\n");
47 if (id_context ==
NULL) {
58 osc_ctx = coap_oscore_init(session->
context, oscore_conf);
59 if (osc_ctx ==
NULL) {
63 session->oscore_encryption = 1;
153 oscore_conf, app_data, callback, ws_host);
172 app_data, callback, ws_host);
214 oscore_conf, app_data, callback, ws_host);
233 app_data, callback, ws_host);
245#if COAP_SERVER_SUPPORT
264 osc_ctx = coap_oscore_init(context, oscore_conf);
278 uint8_t option_value_buffer[15];
286 memset(&uri, 0,
sizeof(uri));
308 sizeof(option_value_buffer),
310 option_value_buffer))
343#if COAP_MAX_LOGGING_LEVEL < _COAP_LOG_OSCORE
398 uint8_t pdu_code = pdu->
code;
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];
410 uint8_t group_flag = 0;
412 int doing_observe = 0;
413 uint32_t observe_value = 0;
416 uint8_t external_aad_buffer[200];
418 uint8_t oscore_option[48];
419 size_t oscore_option_len;
446 rcp_ctx = session->recipient_ctx;
458 if (association ==
NULL)
470 if (coap_request || doing_observe ||
472 uint8_t partial_iv_buffer[8];
473 size_t partial_iv_len;
476 sizeof(partial_iv_buffer),
478 if (snd_ctx->
seq == 0) {
480 partial_iv_buffer[0] =
'\000';
483 partial_iv.
s = partial_iv_buffer;
484 partial_iv.
length = partial_iv_len;
495 if (coap_request || doing_observe ||
506 nonce.
s = nonce_buffer;
576 external_aad.
s = external_aad_buffer;
583 sizeof(external_aad_buffer));
592 assert(aad.
length < AAD_BUF_LEN);
606 if (plain_pdu ==
NULL)
720 dump_cose(cose,
"Pre encrypt");
723 if (ciphertext_buffer ==
NULL)
728 if ((
int)ciphertext_len <= 0) {
729 coap_log_warn(
"OSCORE: Encryption Failure, result code: %d \n",
730 (
int)ciphertext_len);
733 assert(ciphertext_len < OSCORE_CRYPTO_BUFFER_SIZE);
743 if (!
coap_add_data(osc_pdu, ciphertext_len, ciphertext_buffer))
747 ciphertext_buffer =
NULL;
752 if (association && association->
is_observe == 0)
798 if (doing_observe && observe_value == 1) {
840 if (ciphertext_buffer)
851 const char *diagnostic,
854 int encrypt_oscore) {
857 int oscore_encryption = session->oscore_encryption;
858 unsigned char buf[4];
866 (diagnostic ? strlen(diagnostic) : 0));
872 }
else if (kid_context ==
NULL) {
879 coap_add_data(err_pdu, strlen(diagnostic), (
const uint8_t *)diagnostic);
880 session->oscore_encryption = encrypt_oscore;
882 if ((echo_data || kid_context) && encrypt_oscore) {
890 session->oscore_encryption = 0;
899 session->oscore_encryption = oscore_encryption;
908 if (oscore_ctx ==
NULL) {
931 const uint8_t *osc_value;
937 uint8_t aad_buffer[AAD_BUF_LEN];
938 uint8_t nonce_buffer[13];
942 int got_resp_piv = 0;
943 int doing_resp_observe = 0;
951 uint8_t external_aad_buffer[100];
954#if COAP_CLIENT_SUPPORT
989 if (decrypt_pdu ==
NULL) {
1056 uint64_t incoming_seq;
1063 coap_log_warn(
"OSCORE: OSCORE Option cannot be decoded.\n");
1064 build_and_send_error_pdu(session,
1067 "Failed to decode COSE",
1086 session->oscore_r2 != 0 ? (uint8_t *)&session->oscore_r2 :
NULL,
1096 if (kid_context.
length > length)
1103 kid_context.
s = ptr;
1106 if (session->oscore_r2 != 0) {
1125 if (osc_ctx ==
NULL)
1145 build_and_send_error_pdu(session,
1148 "Security context not found",
1168 build_and_send_error_pdu(session,
1181 }
else if (session->
context->oscore_update_seq_num_cb !=
NULL) {
1196 coap_log_warn(
"OSCORE: OSCORE Option cannot be decoded.\n");
1209#if COAP_CLIENT_SUPPORT
1220 if (kid_context.
length > length)
1227 kid_context.
s = ptr;
1258 coap_log_crit(
"OSCORE: Security Context association not found\n");
1293 external_aad.
s = external_aad_buffer;
1299 external_aad_buffer,
1300 sizeof(external_aad_buffer));
1308 sizeof(aad_buffer));
1309 assert(aad.
length < AAD_BUF_LEN);
1321 nonce.
s = nonce_buffer;
1332 association->
nonce =
1381 coap_log_warn(
"OSCORE Replay protection, SEQ larger than SEQ_MAX.\n");
1393 nonce.
s = nonce_buffer;
1397#ifdef OSCORE_EXTRA_DEBUG
1398 dump_cose(cose,
"!req post set nonce");
1430#ifdef OSCORE_EXTRA_DEBUG
1431 dump_cose(cose,
"!req pre aad");
1433 external_aad.
s = external_aad_buffer;
1439 external_aad_buffer,
1440 sizeof(external_aad_buffer));
1448 sizeof(aad_buffer));
1449 assert(aad.
length < AAD_BUF_LEN);
1451#ifdef OSCORE_EXTRA_DEBUG
1452 dump_cose(cose,
"!req post set aad");
1467 st_encrypt = pdu->
data;
1469 if (encrypt_len <= 0) {
1483 if (plain_pdu ==
NULL) {
1504 plain_pdu->
used_size = encrypt_len - tag_len;
1506 dump_cose(cose,
"Pre decrypt");
1509 if (pltxt_size <= 0) {
1510 coap_log_warn(
"OSCORE: Decryption Failure, result code: %d \n",
1513 build_and_send_error_pdu(session,
1516 "Decryption failed",
1530 assert((
size_t)pltxt_size < pdu->alloc_size + pdu->
max_hdr_size);
1547 coap_prng_lkd(&session->oscore_r2,
sizeof(session->oscore_r2));
1548 memcpy(kc->
s, &session->oscore_r2,
sizeof(session->oscore_r2));
1549 memcpy(&kc->
s[
sizeof(session->oscore_r2)],
1556 oscore_r2.
length =
sizeof(session->oscore_r2);
1557 oscore_r2.
s = (
const uint8_t *)&session->oscore_r2;
1559 build_and_send_error_pdu(session,
1568#if COAP_CLIENT_SUPPORT
1575 coap_log_warn(
"OSCORE Appendix B.2: Expected 4.01 response\n");
1613 if (!session->b_2_retransmit_token) {
1617 if (coap_retransmit_oscore_pdu(session, sent_pdu,
NULL) ==
1625#if COAP_SERVER_SUPPORT
1637 build_and_send_error_pdu(session,
1646 if (session->
context->oscore_update_seq_num_cb !=
NULL) {
1666 build_and_send_error_pdu(session,
1686 decrypt_pdu->
code = plain_pdu->
token[0];
1694 switch (opt_iter.
number) {
1698 if (!coap_request) {
1712 doing_resp_observe = 1;
1735 if (!coap_request && !doing_resp_observe) {
1770 if (session->b_2_retransmit_token) {
1772 session->b_2_retransmit_token->s);
1774 session->b_2_retransmit_token =
NULL;
1777#if COAP_CLIENT_SUPPORT
1790 sent_pdu = lg_crcv->sent_pdu;
1798 if (coap_retransmit_oscore_pdu(session, sent_pdu, opt) !=
COAP_INVALID_MID) {
1799 session->doing_b_1_2 = 1;
1803 }
else if (session->doing_b_1_2) {
1808 coap_update_token(decrypt_pdu, lg_crcv->app_token->length, lg_crcv->app_token->s);
1811 session->doing_b_1_2 = 0;
1814 if (association && association->
is_observe == 0)
1821 if (association && association->
is_observe == 0)
1829 COAP_ENC_ASCII = 0x001,
1830 COAP_ENC_HEX = 0x002,
1831 COAP_ENC_CONFIG = 0x0200,
1832 COAP_ENC_INTEGER = 0x400,
1833 COAP_ENC_TEXT = 0x800,
1834 COAP_ENC_BOOL = 0x1000,
1835 COAP_ENC_UNSIGNED64 = 0x2000,
1837} coap_oscore_coding_t;
1840#define TEXT_MAPPING(t, v) \
1841 { { sizeof(#t)-1, (const uint8_t *)#t }, v }
1843static struct coap_oscore_encoding_t {
1845 coap_oscore_coding_t encoding;
1846} oscore_encoding[] = {
1847 TEXT_MAPPING(ascii, COAP_ENC_ASCII),
1848 TEXT_MAPPING(hex, COAP_ENC_HEX),
1849 TEXT_MAPPING(config, COAP_ENC_CONFIG),
1850 TEXT_MAPPING(integer, COAP_ENC_INTEGER),
1851 TEXT_MAPPING(unsigned64, COAP_ENC_UNSIGNED64),
1852 TEXT_MAPPING(text, COAP_ENC_TEXT),
1853 TEXT_MAPPING(
bool, COAP_ENC_BOOL),
1854 {{0,
NULL}, COAP_ENC_LAST}
1858 coap_oscore_coding_t encoding;
1859 const char *encoding_name;
1862 uint64_t value_int64;
1873hex_to_char(
char c, uint8_t *value) {
1874 if (
'a' <= c && c <=
'f') {
1875 *value = c -
'a' + 10;
1876 }
else if (
'A' <= c && c <=
'F') {
1877 *value = c -
'A' + 10;
1878 }
else if (
'0' <= c && c <=
'9') {
1889parse_hex_bin(
const char *begin,
const char *end) {
1897 for (i = 0; (i < (size_t)(end - begin)); i++) {
1898 while ((i < (
size_t)(end - begin)) &&
1899 (begin[i] ==
'\r' || begin[i] ==
'\n' || begin[i] ==
' ')) {
1902 if (i == (
size_t)(end - begin))
1904 if (isxdigit((uint8_t)begin[i])) {
1907 if (!hex_to_char(begin[i], &value)) {
1910 binary->
s[o] = value << 4;
1912 while ((i < (
size_t)(end - begin)) &&
1913 (begin[i] ==
'\r' || begin[i] ==
'\n' || begin[i] ==
' ')) {
1916 if (i == (
size_t)(end - begin))
1918 if (!hex_to_char(begin[i], &value)) {
1921 binary->
s[o++] += value;
1926 if (i != (
size_t)(end - begin))
1942get_split_entry(
const char **start,
1945 oscore_value_t *value,
1947 const char *begin = *start;
1948 const char *keep_start = *start;
1958 kend = end = memchr(begin,
'\n', size);
1963 if ((tend = memchr(begin,
'"', end - begin))) {
1965 if (!memchr(tend + 1,
'"', end - tend -1)) {
1967 kend = end = memchr(end,
'"', size - (end - begin));
1970 kend = end = memchr(kend,
'\n', size - (kend - begin));
1978 if (end > begin && end[-1] ==
'\r')
1981 if (begin[0] ==
'#' || (end - begin) == 0) {
1983 size -= kend - begin + 1;
1985 keep_start = *start;
1990 split = memchr(begin,
',', end - begin);
1994 keyword->
s = (
const uint8_t *)begin;
1995 keyword->
length = split - begin;
1998 if ((end - begin) == 0)
2001 split = memchr(begin,
',', end - begin);
2005 for (i = 0; oscore_encoding[i].name.s; i++) {
2009 value->encoding = oscore_encoding[i].encoding;
2010 value->encoding_name = (
const char *)oscore_encoding[i].name.s;
2014 if (oscore_encoding[i].name.s ==
NULL)
2018 if ((end - begin) == 0)
2021 if (value->encoding == COAP_ENC_CONFIG && begin[0] ==
'\'') {
2022 split = memchr(&begin[1],
'\'', size - (begin - keep_start) - 1);
2025 end = memchr(split,
'\n', size - (split - keep_start));
2032 if (begin[0] ==
'"') {
2033 split = memchr(&begin[1],
'"', end - split - 1);
2040 switch (value->encoding) {
2041 case COAP_ENC_CONFIG:
2042 case COAP_ENC_ASCII:
2043 value->u.value_bin =
2045 if (value->u.value_bin ==
NULL)
2050 value->u.value_bin = parse_hex_bin(begin, end);
2051 if (value->u.value_bin ==
NULL)
2054 case COAP_ENC_INTEGER:
2055 value->u.value_int = atoi(begin);
2057 case COAP_ENC_UNSIGNED64: {
2058 value->u.value_int64 = strtoull(begin,
NULL, 10);
2062 value->u.value_str.s = (
const uint8_t *)begin;
2063 value->u.value_str.length = end - begin;
2066 len = (size_t)(end - begin);
2067 if (len == 4 && memcmp(
"true", begin, len) == 0)
2068 value->u.value_int = 1;
2069 else if (len == 5 && memcmp(
"false", begin, len) == 0)
2070 value->u.value_int = 0;
2081 coap_log_warn(
"oscore_conf: Unrecognized configuration entry '%.*s'\n",
2089#define CONFIG_ENTRY(n, e, t) \
2090 { { sizeof(#n)-1, (const uint8_t *)#n }, e, \
2091 offsetof(coap_oscore_conf_t, n), t }
2093#undef CONFIG_SND_ENTRY
2094#define CONFIG_SND_ENTRY(n, e, t) \
2095 { { sizeof(#n)-1, (const uint8_t *)#n }, e, \
2096 offsetof(coap_oscore_snd_conf_t, n), t }
2098#undef CONFIG_RCP_ENTRY
2099#define CONFIG_RCP_ENTRY(n, e, t) \
2100 { { sizeof(#n)-1, (const uint8_t *)#n }, e, \
2101 offsetof(coap_oscore_rcp_conf_t, n), t }
2103#undef CONFIG_DUMMY_ENTRY
2104#define CONFIG_DUMMY_ENTRY(n, e, t) \
2105 { { sizeof(#n)-1, (const uint8_t *)#n }, e, 0, t }
2107typedef struct oscore_text_mapping_t {
2110} oscore_text_mapping_t;
2113static oscore_text_mapping_t text_aead_alg[] = {
2119static oscore_text_mapping_t text_hkdf_alg[] = {
2124typedef struct oscore_config_t {
2126 coap_oscore_coding_t encoding;
2128 oscore_text_mapping_t *text_mapping;
2131static oscore_config_t oscore_config[] = {
2132 CONFIG_ENTRY(aead_alg, COAP_ENC_INTEGER | COAP_ENC_TEXT, text_aead_alg),
2133 CONFIG_ENTRY(hkdf_alg, COAP_ENC_INTEGER | COAP_ENC_TEXT, text_hkdf_alg),
2134 CONFIG_ENTRY(master_secret, COAP_ENC_HEX | COAP_ENC_ASCII,
NULL),
2135 CONFIG_ENTRY(master_salt, COAP_ENC_HEX | COAP_ENC_ASCII,
NULL),
2136 CONFIG_ENTRY(id_context, COAP_ENC_HEX | COAP_ENC_ASCII,
NULL),
2138 CONFIG_DUMMY_ENTRY(sender_id, COAP_ENC_HEX | COAP_ENC_ASCII,
NULL),
2140 CONFIG_DUMMY_ENTRY(recipient_id, COAP_ENC_HEX | COAP_ENC_ASCII,
NULL),
2142 CONFIG_ENTRY(replay_window, COAP_ENC_INTEGER,
NULL),
2143 CONFIG_ENTRY(ssn_freq, COAP_ENC_INTEGER,
NULL),
2144 CONFIG_ENTRY(rfc8613_b_1_2, COAP_ENC_BOOL,
NULL),
2145 CONFIG_ENTRY(rfc8613_b_2, COAP_ENC_BOOL,
NULL),
2146 CONFIG_ENTRY(break_sender_key, COAP_ENC_BOOL,
NULL),
2147 CONFIG_ENTRY(break_recipient_key, COAP_ENC_BOOL,
NULL),
2148 CONFIG_DUMMY_ENTRY(complex_sender, COAP_ENC_CONFIG,
NULL),
2149 CONFIG_DUMMY_ENTRY(complex_recipient, COAP_ENC_CONFIG,
NULL),
2152static oscore_config_t oscore_snd_config[] = {
2153 CONFIG_SND_ENTRY(sender_id, COAP_ENC_HEX | COAP_ENC_ASCII,
NULL),
2156static oscore_config_t oscore_rcp_config[] = {
2157 CONFIG_RCP_ENTRY(recipient_id, COAP_ENC_HEX | COAP_ENC_ASCII,
NULL),
2158 CONFIG_RCP_ENTRY(silent_server, COAP_ENC_BOOL,
NULL),
2159 CONFIG_DUMMY_ENTRY(last_seq, COAP_ENC_UNSIGNED64,
NULL),
2160 CONFIG_DUMMY_ENTRY(sliding_window, COAP_ENC_UNSIGNED64,
NULL),
2166 if (snd_conf ==
NULL)
2176 if (rcp_conf ==
NULL)
2187 if (oscore_conf ==
NULL)
2200 rcp_conf = rcp_next;
2209 const char *start = (
const char *)conf_mem.
s;
2210 const char *end = start + conf_mem.length;
2212 oscore_value_t value;
2216 if (snd_conf ==
NULL)
2220 memset(&value, 0,
sizeof(value));
2222 while (end > start &&
2223 get_split_entry(&start, end - start, &keyword, &value, 0) > 0) {
2227 for (i = 0; i <
sizeof(oscore_snd_config) /
sizeof(oscore_snd_config[0]); i++) {
2229 value.encoding & oscore_snd_config[i].encoding) {
2232 switch (value.encoding) {
2234 case COAP_ENC_ASCII:
2235 memcpy(&unused_check,
2236 &(((
char *)snd_conf)[oscore_snd_config[i].offset]),
2237 sizeof(unused_check));
2238 if (unused_check !=
NULL) {
2239 coap_log_warn(
"oscore_snd_conf: Keyword '%.*s' duplicated\n",
2241 (
const char *)keyword.
s);
2245 memcpy(&(((
char *)snd_conf)[oscore_snd_config[i].offset]),
2247 sizeof(value.u.value_bin));
2249 case COAP_ENC_INTEGER:
2251 memcpy(&(((
char *)snd_conf)[oscore_snd_config[i].offset]),
2253 sizeof(value.u.value_int));
2256 for (j = 0; oscore_snd_config[i].text_mapping[j].text.s !=
NULL; j++) {
2257 if (memcmp(value.u.value_str.s,
2258 oscore_snd_config[i].text_mapping[j].text.s,
2259 value.u.value_str.length) == 0) {
2260 memcpy(&(((
char *)snd_conf)[oscore_snd_config[i].offset]),
2261 &oscore_snd_config[i].text_mapping[j].value,
2262 sizeof(oscore_snd_config[i].text_mapping[j].value));
2266 if (oscore_snd_config[i].text_mapping[j].text.s ==
NULL) {
2267 coap_log_warn(
"oscore_snd_conf: Keyword '%.*s': value '%.*s' unknown\n",
2269 (
const char *)keyword.
s,
2270 (
int)value.u.value_str.length,
2271 (
const char *)value.u.value_str.s);
2275 case COAP_ENC_CONFIG:
2276 case COAP_ENC_UNSIGNED64:
2285 if (i ==
sizeof(oscore_snd_config) /
sizeof(oscore_snd_config[0])) {
2286 coap_log_warn(
"oscore_snd_conf: Keyword '%.*s', type '%s' unknown\n",
2288 (
const char *)keyword.
s,
2289 value.encoding_name);
2290 if (value.encoding == COAP_ENC_HEX || value.encoding == COAP_ENC_ASCII ||
2291 value.encoding == COAP_ENC_CONFIG)
2296 if (!snd_conf->sender_id) {
2300 if (snd_conf->sender_id->length > 7) {
2301 coap_log_warn(
"oscore_snd_conf: Maximum size of sender_id is 7 bytes\n");
2313 const char *start = (
const char *)conf_mem.
s;
2314 const char *end = start + conf_mem.length;
2316 oscore_value_t value;
2320 if (rcp_conf ==
NULL)
2324 memset(&value, 0,
sizeof(value));
2326 while (end > start &&
2327 get_split_entry(&start, end - start, &keyword, &value, 0) > 0) {
2331 for (i = 0; i <
sizeof(oscore_rcp_config) /
sizeof(oscore_rcp_config[0]); i++) {
2333 value.encoding & oscore_rcp_config[i].encoding) {
2335 rcp_conf->
last_seq = value.u.value_int64;
2343 switch (value.encoding) {
2345 case COAP_ENC_ASCII:
2346 memcpy(&unused_check,
2347 &(((
char *)rcp_conf)[oscore_rcp_config[i].offset]),
2348 sizeof(unused_check));
2349 if (unused_check !=
NULL) {
2350 coap_log_warn(
"oscore_rcp_conf: Keyword '%.*s' duplicated\n",
2352 (
const char *)keyword.
s);
2356 memcpy(&(((
char *)rcp_conf)[oscore_rcp_config[i].offset]),
2358 sizeof(value.u.value_bin));
2360 case COAP_ENC_INTEGER:
2362 memcpy(&(((
char *)rcp_conf)[oscore_rcp_config[i].offset]),
2364 sizeof(value.u.value_int));
2367 for (j = 0; oscore_rcp_config[i].text_mapping[j].text.s !=
NULL; j++) {
2368 if (memcmp(value.u.value_str.s,
2369 oscore_rcp_config[i].text_mapping[j].text.s,
2370 value.u.value_str.length) == 0) {
2371 memcpy(&(((
char *)rcp_conf)[oscore_rcp_config[i].offset]),
2372 &oscore_rcp_config[i].text_mapping[j].value,
2373 sizeof(oscore_rcp_config[i].text_mapping[j].value));
2377 if (oscore_rcp_config[i].text_mapping[j].text.s ==
NULL) {
2378 coap_log_warn(
"oscore_rcp_conf: Keyword '%.*s': value '%.*s' unknown\n",
2380 (
const char *)keyword.
s,
2381 (
int)value.u.value_str.length,
2382 (
const char *)value.u.value_str.s);
2386 case COAP_ENC_CONFIG:
2387 case COAP_ENC_UNSIGNED64:
2397 if (i ==
sizeof(oscore_rcp_config) /
sizeof(oscore_rcp_config[0])) {
2398 coap_log_warn(
"oscore_rcp_conf: Keyword '%.*s', type '%s' unknown\n",
2400 (
const char *)keyword.
s,
2401 value.encoding_name);
2402 if (value.encoding == COAP_ENC_HEX || value.encoding == COAP_ENC_ASCII ||
2403 value.encoding == COAP_ENC_CONFIG)
2408 if (!rcp_conf->recipient_id) {
2409 coap_log_warn(
"oscore_rcp_conf: recipient_id not defined\n");
2412 if (rcp_conf->recipient_id->length > 7) {
2413 coap_log_warn(
"oscore_rcp_conf: Maximum size of recipient_id is 7 bytes\n");
2425 const char *start = (
const char *)conf_mem.
s;
2426 const char *end = start + conf_mem.length;
2428 oscore_value_t value;
2433 if (oscore_conf ==
NULL)
2437 memset(&value, 0,
sizeof(value));
2450 while (end > start &&
2451 (split_ok = get_split_entry(&start, end - start, &keyword, &value, 0)) > 0) {
2455 for (i = 0; i <
sizeof(oscore_config) /
sizeof(oscore_config[0]); i++) {
2457 value.encoding & oscore_config[i].encoding) {
2459 if (value.u.value_bin->length > 7) {
2460 coap_log_warn(
"oscore_conf: Maximum size of sender_id is 7 bytes\n");
2461 goto error_free_value_bin;
2463 if (oscore_conf->
sender) {
2465 goto error_free_value_bin;
2468 if (!oscore_conf->
sender)
2469 goto error_free_value_bin;
2476 if (value.u.value_bin->length > 7) {
2477 coap_log_warn(
"oscore_conf: Maximum size of recipient_id is 7 bytes\n");
2478 goto error_free_value_bin;
2483 goto error_free_value_bin;
2492 switch (value.encoding) {
2493 case COAP_ENC_CONFIG:
2494 if (keyword.
length ==
sizeof(
"complex_sender") - 1 &&
2495 memcmp(keyword.
s,
"complex_sender", keyword.
length) == 0) {
2497 coap_parse_oscore_snd_conf_mem(*value.u.value_bin);
2502 (
const char *)keyword.
s);
2503 goto error_free_value_bin;
2505 if (oscore_conf->
sender) {
2508 goto error_free_value_bin;
2510 oscore_conf->
sender = snd_conf;
2514 if (keyword.
length ==
sizeof(
"complex_recipient") - 1 &&
2515 memcmp(keyword.
s,
"complex_recipient", keyword.
length) == 0) {
2517 coap_parse_oscore_rcp_conf_mem(*value.u.value_bin);
2522 (
const char *)keyword.
s);
2523 goto error_free_value_bin;
2530 case COAP_ENC_ASCII:
2532 memcpy(&unused_check,
2533 &(((
char *)oscore_conf)[oscore_config[i].offset]),
2534 sizeof(unused_check));
2535 if (unused_check !=
NULL) {
2538 (
const char *)keyword.
s);
2539 goto error_free_value_bin;
2541 memcpy(&(((
char *)oscore_conf)[oscore_config[i].offset]),
2543 sizeof(value.u.value_bin));
2545 case COAP_ENC_INTEGER:
2547 memcpy(&(((
char *)oscore_conf)[oscore_config[i].offset]),
2549 sizeof(value.u.value_int));
2552 for (j = 0; oscore_config[i].text_mapping[j].text.s !=
NULL; j++) {
2554 &oscore_config[i].text_mapping[j].text)) {
2555 memcpy(&(((
char *)oscore_conf)[oscore_config[i].offset]),
2556 &oscore_config[i].text_mapping[j].value,
2557 sizeof(oscore_config[i].text_mapping[j].value));
2561 if (oscore_config[i].text_mapping[j].text.s ==
NULL) {
2562 coap_log_warn(
"oscore_conf: Keyword '%.*s': value '%.*s' unknown\n",
2564 (
const char *)keyword.
s,
2565 (
int)value.u.value_str.length,
2566 (
const char *)value.u.value_str.s);
2570 case COAP_ENC_UNSIGNED64:
2580 if (i ==
sizeof(oscore_config) /
sizeof(oscore_config[0])) {
2581 coap_log_warn(
"oscore_conf: Keyword '%.*s', type '%s' unknown\n",
2583 (
const char *)keyword.
s,
2584 value.encoding_name);
2585 if (value.encoding == COAP_ENC_HEX || value.encoding == COAP_ENC_ASCII ||
2586 value.encoding == COAP_ENC_CONFIG) {
2594 if (!oscore_conf->master_secret) {
2598 if (!oscore_conf->sender) {
2604error_free_value_bin:
2628 coap_log_crit(
"OSCORE: Could not create Security Context!\n");
2662 if (session ==
NULL || recipient_ctx ==
NULL)
2665 if (session->recipient_ctx == recipient_ctx) {
2670 old_ctx = session->recipient_ctx;
2673 session->recipient_ctx = recipient_ctx;
2674 session->recipient_ctx->
ref++;
2676 if (old_ctx !=
NULL) {
2684 if (association ==
NULL)
2701 void *save_seq_num_func_param,
2702 uint64_t start_seq_num) {
2705 if (oscore_conf ==
NULL)
2720 size_t overhead = 0;
2726 if (osc_ctx ==
NULL)
2779 if (context->p_osc_ctx ==
NULL) {
2784 if (rcp_conf ==
NULL) {
2792 if (rcp_ctx ==
NULL)
2802 if (!context || !recipient_id)
2814 if (context->p_osc_ctx ==
NULL)
2823 if (context ==
NULL)
2827 context->oscore_find_cb = find_handler;
2828 context->oscore_update_seq_num_cb = update_seq_num_handler;
2850 uint64_t last_seq, uint64_t seq_window) {
2863 uint64_t last_seq, uint64_t seq_window) {
2866 rcp_conf = coap_oscore_get_recipient_conf(oscore_conf, recipient_id);
3004 void *save_seq_num_func_param,
3005 uint64_t start_seq_num) {
3007 (void)save_seq_num_func;
3008 (void)save_seq_num_func_param;
3009 (void)start_seq_num;
3041 (void)update_seq_num_handler;
3047 uint64_t last_seq) {
3057 uint64_t seq_window) {
struct coap_lg_crcv_t coap_lg_crcv_t
Library specific build wrapper for coap_internal.h.
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.
void coap_free_type(coap_memory_tag_t type, void *p)
Releases the memory that was allocated by coap_malloc_type().
uint8_t coap_opt_t
Use byte-oriented access methods here because sliding a complex struct coap_opt_t over the data buffe...
@ COAP_OPTION_IF_NONE_MATCH
@ COAP_OPTION_PROXY_SCHEME
@ COAP_OPTION_CONTENT_FORMAT
@ COAP_OPTION_LOCATION_QUERY
@ COAP_OPTION_LOCATION_PATH
@ COAP_OPTION_URI_PATH_ABB
COAP_API int coap_oscore_recipient_set_seq_window(coap_oscore_conf_t *oscore_conf, const coap_bin_const_t *recipient_id, uint64_t seq_window)
COAP_API int coap_oscore_recipient_set_last_seq(coap_oscore_conf_t *oscore_conf, const coap_bin_const_t *recipient_id, uint64_t last_seq)
static int coap_uri_scheme_is_secure(const coap_uri_t *uri)
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.
#define COAP_BLOCK_CACHE_RESPONSE
int coap_prng_lkd(void *buf, size_t len)
Fills buf with len random bytes using the default pseudo random number generator.
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.
uint16_t coap_new_message_id_lkd(coap_session_t *session)
Returns a new message id and updates session->tx_mid accordingly.
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.
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.
#define COAP_OSCORE_DEFAULT_REPLAY_WINDOW
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.
int coap_crypto_check_cipher_alg(cose_alg_t alg)
Check whether the defined cipher algorithm is supported by the underlying crypto library.
unsigned int coap_encode_var_safe(uint8_t *buf, size_t length, unsigned int val)
Encodes multiple-length byte sequences.
unsigned int coap_decode_var_bytes(const uint8_t *buf, size_t len)
Decodes multiple-length byte sequences.
uint64_t coap_decode_var_bytes8(const uint8_t *buf, size_t len)
Decodes multiple-length byte sequences.
unsigned int coap_encode_var_safe8(uint8_t *buf, size_t length, uint64_t val)
Encodes multiple-length byte sequences.
@ COAP_EVENT_OSCORE_DECODE_ERROR
Triggered when there is an OSCORE decode of OSCORE option failure.
@ COAP_EVENT_OSCORE_INTERNAL_ERROR
Triggered when there is an OSCORE internal error i.e malloc failed.
@ COAP_EVENT_OSCORE_NOT_ENABLED
Triggered when trying to use OSCORE to decrypt, but it is not enabled.
@ COAP_EVENT_OSCORE_NO_SECURITY
Triggered when there is no OSCORE security definition found.
@ COAP_EVENT_OSCORE_NO_PROTECTED_PAYLOAD
Triggered when there is no OSCORE encrypted payload provided.
@ COAP_EVENT_OSCORE_DECRYPTION_FAILURE
Triggered when there is an OSCORE decryption failure.
#define coap_lock_callback(func)
Dummy for no thread-safe code.
#define coap_lock_unlock()
Dummy for no thread-safe code.
#define coap_lock_check_locked()
Dummy for no thread-safe code.
#define coap_lock_lock(failed)
Dummy for no thread-safe code.
#define coap_log_debug(...)
coap_log_t coap_get_log_level(void)
Get the current logging level.
void coap_show_pdu(coap_log_t level, const coap_pdu_t *pdu)
Display the contents of the specified pdu.
#define coap_log_oscore(...)
#define coap_log_warn(...)
#define coap_log_err(...)
#define coap_log_crit(...)
coap_opt_t * coap_option_next(coap_opt_iterator_t *oi)
Updates the iterator oi to point to the next option.
uint32_t coap_opt_length(const coap_opt_t *opt)
Returns the length of the given option.
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.
void coap_delete_optlist(coap_optlist_t *queue)
Removes all entries from the optlist_chain, freeing off their memory usage.
#define COAP_OPT_ALL
Pre-defined filter that includes all options.
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 ...
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.
const uint8_t * coap_opt_value(const coap_opt_t *opt)
Returns a pointer to the value of the given option.
size_t oscore_cbor_get_element_size(const uint8_t **buffer, size_t *buf_size)
void cose_encrypt0_set_plaintext(cose_encrypt0_t *ptr, uint8_t *buffer, size_t size)
int cose_encrypt0_set_key(cose_encrypt0_t *ptr, coap_bin_const_t *key)
void cose_encrypt0_set_kid_context(cose_encrypt0_t *ptr, coap_bin_const_t *kid_context)
const char * cose_get_alg_name(cose_alg_t id, char *buffer, size_t buflen)
void cose_encrypt0_set_ciphertext(cose_encrypt0_t *ptr, uint8_t *buffer, size_t size)
int cose_encrypt0_decrypt(cose_encrypt0_t *ptr, uint8_t *plaintext_buffer, size_t plaintext_len)
size_t cose_tag_len(cose_alg_t cose_alg)
void cose_encrypt0_set_aad(cose_encrypt0_t *ptr, coap_bin_const_t *aad)
int cose_encrypt0_encrypt(cose_encrypt0_t *ptr, uint8_t *ciphertext_buffer, size_t ciphertext_len)
void cose_encrypt0_set_partial_iv(cose_encrypt0_t *ptr, coap_bin_const_t *partial_iv)
void cose_encrypt0_set_external_aad(cose_encrypt0_t *ptr, coap_bin_const_t *external_aad)
void cose_encrypt0_init(cose_encrypt0_t *ptr)
void cose_encrypt0_set_alg(cose_encrypt0_t *ptr, uint8_t alg)
void cose_encrypt0_set_key_id(cose_encrypt0_t *ptr, coap_bin_const_t *key_id)
void cose_encrypt0_set_nonce(cose_encrypt0_t *ptr, coap_bin_const_t *nonce)
@ COSE_HKDF_ALG_HKDF_SHA_256
@ COSE_ALGORITHM_AES_CCM_16_64_128
@ COSE_ALGORITHM_AES_CCM_16_64_256
size_t oscore_prepare_aad(const uint8_t *external_aad_buffer, size_t external_aad_len, uint8_t *aad_buffer, size_t aad_size)
size_t oscore_encode_option_value(uint8_t *option_buffer, size_t option_buf_len, cose_encrypt0_t *cose, uint8_t group, uint8_t appendix_b_2)
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_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
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 ...
int oscore_delete_association(coap_session_t *session, oscore_association_t *association)
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,...
uint8_t oscore_validate_sender_seq(oscore_recipient_ctx_t *ctx, cose_encrypt0_t *cose)
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_ctx_t * coap_init_oscore_context_from_conf(coap_oscore_conf_t *oscore_conf)
Initializes an OSCORE context from the given configuration.
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.
int oscore_decode_option_value(const uint8_t *option_value, size_t option_len, cose_encrypt0_t *cose)
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_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.
int oscore_delete_recipient(oscore_ctx_t *osc_ctx, coap_bin_const_t *rid)
uint8_t oscore_increment_sender_seq(oscore_ctx_t *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_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_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_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.
void oscore_roll_back_seq(oscore_recipient_ctx_t *ctx)
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)
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)
void oscore_delete_server_associations(coap_session_t *session)
void oscore_log_char_value(coap_log_t level, const char *name, const char *value)
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)
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.
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...
int coap_rebuild_pdu_for_proxy(coap_pdu_t *pdu)
Convert PDU to use Proxy-Scheme option if Proxy-Uri option is present.
void oscore_free_contexts(coap_context_t *c_context)
void oscore_log_hex_value(coap_log_t level, const char *name, coap_bin_const_t *value)
void coap_delete_oscore_associations(coap_session_t *session)
Cleanup all allocated OSCORE association information.
int coap_oscore_initiate(coap_session_t *session, coap_oscore_conf_t *oscore_conf)
Initiate an OSCORE session.
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_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
void coap_delete_all_oscore(coap_context_t *context)
Cleanup all allocated OSCORE information.
void oscore_generate_nonce(cose_encrypt0_t *ptr, oscore_ctx_t *ctx, uint8_t *buffer, uint8_t size)
int oscore_remove_context(coap_context_t *c_context, oscore_ctx_t *osc_ctx)
oscore_association_t * oscore_find_association(coap_session_t *session, coap_bin_const_t *token)
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.
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.
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_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...
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
Send partial IV with encrypted PDU.
@ OSCORE_SEND_NO_IV
Do not send partial IV unless added by a response.
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...
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.
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 ...
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...
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...
int coap_delete_oscore_conf(coap_oscore_conf_t *oscore_conf)
Release all the information associated with the OSCORE configuration.
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.
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.
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().
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 ...
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,...
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).
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.
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...
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.
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...
void coap_delete_pdu_lkd(coap_pdu_t *pdu)
Dispose of an CoAP PDU and free off associated storage.
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.
int coap_remove_option(coap_pdu_t *pdu, coap_option_num_t number)
Removes (first) option of given number from the pdu.
int coap_update_token(coap_pdu_t *pdu, size_t len, const uint8_t *data)
Updates token in pdu with length len and data.
#define COAP_PDU_IS_PING(pdu)
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.
size_t coap_pdu_encode_header(coap_pdu_t *pdu, coap_proto_t proto)
Compose the protocol specific header for the specified PDU.
#define COAP_PAYLOAD_START
int coap_pdu_resize(coap_pdu_t *pdu, size_t new_size)
Dynamically grows the size of pdu to new_size.
#define COAP_PDU_IS_REQUEST(pdu)
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.
#define COAP_DEFAULT_PORT
#define COAP_RESPONSE_CODE(N)
#define COAP_RESPONSE_CLASS(C)
coap_proto_t
CoAP protocol types Note: coap_layers_coap[] needs updating if extended.
coap_pdu_code_t
Set of codes available for a PDU.
int coap_add_token(coap_pdu_t *pdu, size_t len, const uint8_t *data)
Adds token of length len to pdu.
#define COAPS_DEFAULT_PORT
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.
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.
#define COAP_INVALID_MID
Indicates an invalid message id.
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.
coap_bin_const_t coap_pdu_get_token(const coap_pdu_t *pdu)
Gets the token associated with pdu.
@ COAP_REQUEST_CODE_FETCH
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_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...
void coap_session_release_lkd(coap_session_t *session)
Decrement reference counter on a session.
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...
#define COAP_PROTO_NOT_RELIABLE(p)
void(* coap_app_data_free_callback_t)(void *data)
Callback to free off the app data when the entry is being deleted / freed off.
void coap_delete_bin_const(coap_bin_const_t *s)
Deletes the given const binary data and releases any memory allocated.
void coap_delete_str_const(coap_str_const_t *s)
Deletes the given const string and releases any memory allocated.
coap_binary_t * coap_new_binary(size_t size)
Returns a new binary object with at least size bytes storage allocated.
coap_str_const_t * coap_make_str_const(const char *string)
Take the specified byte array (text) and create a coap_str_const_t *.
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...
struct coap_str_const_t coap_str_const_t
CoAP string data definition with const data.
void coap_delete_binary(coap_binary_t *s)
Deletes the given coap_binary_t object and releases any memory allocated.
#define coap_binary_equal(binary1, binary2)
Compares the two binary data for equality.
#define coap_string_equal(string1, string2)
Compares the two strings for equality.
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...
int coap_oscore_is_supported(void)
Check whether OSCORE is available.
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...
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...
int coap_split_proxy_uri(const uint8_t *str_var, size_t len, coap_uri_t *uri)
Parses a given string into URI components.
coap_uri_info_t coap_uri_scheme[COAP_URI_SCHEME_LAST]
Multi-purpose address abstraction.
CoAP binary data definition with const data.
size_t length
length of binary data
const uint8_t * s
read-only binary data
CoAP binary data definition.
size_t length
length of binary data
The CoAP stack's global state is stored in a coap_context_t object.
The structure used for defining the Client PSK setup data to be used.
The structure used for defining the PKI setup data to be used.
Iterator to run through PDU options.
coap_opt_t * next_option
pointer to the unparsed next option
size_t length
remaining length of PDU
coap_option_num_t number
decoded option number
Representation of chained list of CoAP options to install.
The structure used to hold the OSCORE configuration information.
void * save_seq_num_func_param
Passed to save_seq_num_func().
uint32_t rfc8613_b_2
1 if rfc8613 B.2 protocol else 0
cose_hkdf_alg_t hkdf_alg
Set to one of COSE_HKDF_ALG_*.
uint32_t break_sender_key
1 if sender key to be broken, else 0
coap_oscore_snd_conf_t * sender
The sender - i.e.
coap_oscore_rcp_conf_t * recipient_chain
The recipients as a chain.
uint32_t ssn_freq
Sender Seq Num update frequency.
coap_oscore_save_seq_num_t save_seq_num_func
Called every seq num change.
uint32_t rfc8613_b_1_2
1 if rfc8613 B.1.2 enabled else 0
uint64_t start_seq_num
Used for ssn_freq updating.
uint32_t break_recipient_key
1 if recipient key to be broken, else 0
coap_bin_const_t * master_secret
Common Master Secret.
cose_alg_t aead_alg
Set to one of COSE_ALGORITHM_AES*.
coap_bin_const_t * master_salt
Common Master Salt.
uint32_t replay_window
Replay window size Use COAP_OSCORE_DEFAULT_REPLAY_WINDOW.
coap_bin_const_t * id_context
Common ID context.
The structure used to hold the OSCORE Recipient configuration.
coap_bin_const_t * recipient_id
Recipient ID (i.e.
uint64_t last_seq
Highest sequence number used for this recipient.
uint8_t window_initialized
Contains if the sliding window is initialized 1 if initialized, 0 otherwise.
struct coap_oscore_rcp_conf_t * next_recipient
Used to maintain the chain.
uint64_t sliding_window
bitfield sequence counter window
The structure used to hold the OSCORE Sender configuration information.
coap_bin_const_t * sender_id
Sender ID (i.e.
uint8_t max_hdr_size
space reserved for protocol-specific header
uint8_t * token
first byte of token (or extended length bytes prefix), if any, or options
coap_pdu_code_t code
request method (value 1–31) or response code (value 64-255)
coap_bin_const_t actual_token
Actual token in pdu.
uint8_t * data
first byte of payload, if any
coap_mid_t mid
message id, if any, in regular host byte order
uint32_t e_token_length
length of Token space (includes leading extended bytes
size_t used_size
used bytes of storage for token, options and payload
coap_pdu_type_t type
message type
Abstraction of virtual session that can be attached to coap_context_t (client) or coap_endpoint_t (se...
uint32_t block_mode
Zero or more COAP_BLOCK_ or'd options.
coap_proto_t proto
protocol used
unsigned ref
reference count from queues
uint8_t con_active
Active CON request sent.
coap_context_t * context
session's context
CoAP string data definition with const data.
const uint8_t * s
read-only string data
size_t length
length of string
Representation of parsed URI.
enum coap_uri_scheme_t scheme
The parsed scheme specifier.
coap_str_const_t path
The complete path if present or {0, NULL}.
uint16_t port
The port in host byte order.
coap_str_const_t query
The complete query if present or {0, NULL}.
coap_str_const_t host
The host part of the URI.
coap_bin_const_t partial_iv
coap_bin_const_t kid_context
coap_bin_const_t external_aad
coap_bin_const_t oscore_option
coap_bin_const_t * obs_partial_iv
coap_bin_const_t * partial_iv
oscore_recipient_ctx_t * recipient_ctx
uint8_t rfc8613_b_1_2
1 if rfc8613 B.1.2 enabled else 0
void * save_seq_num_func_param
Passed to save_seq_num_func().
oscore_sender_ctx_t * sender_context
cose_alg_t aead_alg
Set to one of COSE_ALGORITHM_AES*.
uint8_t rfc8613_b_2
1 if rfc8613 B.2 protocol else 0
coap_oscore_save_seq_num_t save_seq_num_func
Called every seq num change.
oscore_recipient_ctx_t * recipient_chain
coap_bin_const_t * id_context
contains GID in case of group
uint32_t ssn_freq
Sender Seq Num update frequency.
unsigned ref
Reference counter to keep track of linked associations / active sessions.
coap_bin_const_t * recipient_key
coap_bin_const_t * recipient_id
coap_bin_const_t * sender_id
uint64_t seq
Sender Sequence Number.
coap_bin_const_t * sender_key
uint64_t next_seq
Used for ssn_freq updating.