37#if COAP_WITH_LIBMBEDTLS || COAP_WITH_LIBMBEDTLS_OSCORE
53#include <mbedtls/version.h>
56#if (MBEDTLS_VERSION_NUMBER < 0x03000000)
57#define MBEDTLS_2_X_COMPAT
60#ifndef MBEDTLS_ALLOW_PRIVATE_ACCESS
61#define MBEDTLS_ALLOW_PRIVATE_ACCESS
65#include <mbedtls/platform.h>
66#include <mbedtls/net_sockets.h>
67#include <mbedtls/ssl.h>
68#include <mbedtls/version.h>
71#if MBEDTLS_VERSION_NUMBER >= 0x04000000
72#define COAP_USE_PSA_CRYPTO 1
74#define COAP_USE_PSA_CRYPTO 0
77#if COAP_USE_PSA_CRYPTO
78#include <psa/crypto.h>
80#include <mbedtls/entropy.h>
81#include <mbedtls/ctr_drbg.h>
82#include <mbedtls/sha256.h>
83#include <mbedtls/md.h>
84#include <mbedtls/cipher.h>
87#include <mbedtls/error.h>
88#include <mbedtls/timing.h>
89#include <mbedtls/ssl_cookie.h>
90#include <mbedtls/oid.h>
91#include <mbedtls/debug.h>
92#if defined(ESPIDF_VERSION) && defined(CONFIG_MBEDTLS_DEBUG)
93#include <mbedtls/esp_debug.h>
95#if !COAP_USE_PSA_CRYPTO && defined(MBEDTLS_PSA_CRYPTO_C)
96#include <psa/crypto.h>
102#if COAP_USE_PSA_CRYPTO
103typedef psa_hash_operation_t coap_crypto_sha256_ctx_t;
104typedef psa_algorithm_t coap_crypto_md_type_t;
106#define COAP_CRYPTO_MD_SHA1 PSA_ALG_SHA_1
107#define COAP_CRYPTO_MD_SHA256 PSA_ALG_SHA_256
108#define COAP_CRYPTO_MD_SHA384 PSA_ALG_SHA_384
109#define COAP_CRYPTO_MD_SHA512 PSA_ALG_SHA_512
110#define COAP_CRYPTO_MD_NONE PSA_ALG_NONE
113typedef mbedtls_sha256_context coap_crypto_sha256_ctx_t;
114typedef mbedtls_md_type_t coap_crypto_md_type_t;
116#define COAP_CRYPTO_MD_SHA1 MBEDTLS_MD_SHA1
117#define COAP_CRYPTO_MD_SHA256 MBEDTLS_MD_SHA256
118#define COAP_CRYPTO_MD_SHA384 MBEDTLS_MD_SHA384
119#define COAP_CRYPTO_MD_SHA512 MBEDTLS_MD_SHA512
120#define COAP_CRYPTO_MD_NONE MBEDTLS_MD_NONE
126 version.
version = mbedtls_version_get_number();
132#if COAP_WITH_LIBMBEDTLS_OSCORE
135#if COAP_USE_PSA_CRYPTO || defined(MBEDTLS_PSA_CRYPTO_C)
143#if COAP_USE_PSA_CRYPTO || defined(MBEDTLS_PSA_CRYPTO_C)
144 mbedtls_psa_crypto_free();
164#ifndef mbedtls_malloc
165#define mbedtls_malloc(a) malloc(a)
167#ifndef mbedtls_realloc
168#define mbedtls_realloc(a, b) realloc((a), (b))
171#define mbedtls_free(a) free(a)
174#if ! COAP_WITH_LIBMBEDTLS_OSCORE
176coap_mbedtls_strdup_alloc(
const char *s) {
184 copy = (
char *)mbedtls_malloc(len);
186 memcpy(copy, s, len);
192coap_mbedtls_strndup_alloc(
const char *s,
size_t n) {
200 copy = (
char *)mbedtls_malloc(len + 1);
202 memcpy(copy, s, len);
209#ifndef mbedtls_strdup
210#define mbedtls_strdup(a) coap_mbedtls_strdup_alloc(a)
212#ifndef mbedtls_strndup
213#define mbedtls_strndup(a, b) coap_mbedtls_strndup_alloc((a), (b))
216#ifndef MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED
218#ifdef MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED
219#define MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED
223#if ! COAP_SERVER_SUPPORT
224#undef MBEDTLS_SSL_SRV_C
226#if ! COAP_CLIENT_SUPPORT
227#undef MBEDTLS_SSL_CLI_C
231#define strcasecmp _stricmp
239#if COAP_SERVER_SUPPORT
243coap_crypto_sha256_init(coap_crypto_sha256_ctx_t *ctx) {
244#if COAP_USE_PSA_CRYPTO
245 *ctx = psa_hash_operation_init();
246 return (psa_hash_setup(ctx, PSA_ALG_SHA_256) == PSA_SUCCESS) ? 0 : -1;
248 mbedtls_sha256_init(ctx);
249#if (MBEDTLS_VERSION_NUMBER < 0x03000000)
250 return mbedtls_sha256_starts_ret(ctx, 0);
252 return mbedtls_sha256_starts(ctx, 0);
258coap_crypto_sha256_update(coap_crypto_sha256_ctx_t *ctx,
259 const uint8_t *data,
size_t len) {
260#if COAP_USE_PSA_CRYPTO
261 return (psa_hash_update(ctx, data, len) == PSA_SUCCESS) ? 0 : -1;
263#if (MBEDTLS_VERSION_NUMBER < 0x03000000)
264 return mbedtls_sha256_update_ret(ctx, data, len);
266 return mbedtls_sha256_update(ctx, data, len);
272coap_crypto_sha256_finish(coap_crypto_sha256_ctx_t *ctx, uint8_t *output) {
273#if COAP_USE_PSA_CRYPTO
275 return (psa_hash_finish(ctx, output, 32, &hash_len) == PSA_SUCCESS) ? 0 : -1;
277#if (MBEDTLS_VERSION_NUMBER < 0x03000000)
278 return mbedtls_sha256_finish_ret(ctx, output);
280 return mbedtls_sha256_finish(ctx, output);
286coap_crypto_sha256_free(coap_crypto_sha256_ctx_t *ctx) {
287#if COAP_USE_PSA_CRYPTO
290 mbedtls_sha256_free(ctx);
298coap_crypto_hash_size(coap_crypto_md_type_t md_type) {
299#if COAP_USE_PSA_CRYPTO
300 switch ((
int)md_type) {
303 case PSA_ALG_SHA_256:
305 case PSA_ALG_SHA_384:
307 case PSA_ALG_SHA_512:
313 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_type);
314 return md_info ? mbedtls_md_get_size(md_info) : 0;
319coap_crypto_hash_compute(coap_crypto_md_type_t md_type,
320 const uint8_t *input,
size_t ilen,
321 uint8_t *output,
size_t output_size,
322 size_t *output_len) {
323#if COAP_USE_PSA_CRYPTO
325 psa_status_t status = psa_hash_compute(md_type, input, ilen,
326 output, output_size, &actual_len);
328 *output_len = actual_len;
329 return (status == PSA_SUCCESS) ? 0 : -1;
331 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_type);
334 size_t hash_len = mbedtls_md_get_size(md_info);
335 if (hash_len > output_size)
338 *output_len = hash_len;
339 return mbedtls_md(md_info, input, ilen, output);
347#if COAP_WITH_LIBMBEDTLS
349#define IS_PSK (1 << 0)
350#define IS_PKI (1 << 1)
351#define IS_CLIENT (1 << 6)
352#define IS_SERVER (1 << 7)
354typedef struct coap_ssl_t {
365typedef struct coap_mbedtls_env_t {
366 mbedtls_ssl_context ssl;
367#if !COAP_USE_PSA_CRYPTO
368 mbedtls_entropy_context entropy;
369 mbedtls_ctr_drbg_context ctr_drbg;
371 mbedtls_ssl_config conf;
372 mbedtls_timing_delay_context timer;
373 mbedtls_x509_crt cacert;
374 mbedtls_x509_crt public_cert;
375 mbedtls_pk_context private_key;
376 mbedtls_ssl_cookie_ctx cookie_ctx;
380 int seen_client_hello;
383 unsigned int retry_scalar;
384 coap_ssl_t coap_ssl_data;
385 uint32_t server_hello_cnt;
388typedef struct pki_sni_entry {
391 mbedtls_x509_crt cacert;
392 mbedtls_x509_crt public_cert;
393 mbedtls_pk_context private_key;
396typedef struct psk_sni_entry {
401typedef struct coap_mbedtls_context_t {
403 size_t pki_sni_count;
404 pki_sni_entry *pki_sni_entry_list;
405 size_t psk_sni_count;
406 psk_sni_entry *psk_sni_entry_list;
409 int trust_store_defined;
411} coap_mbedtls_context_t;
413typedef enum coap_enc_method_t {
425} zephyr_timing_delay_context;
428zephyr_timing_set_delay(
void *data, uint32_t int_ms, uint32_t fin_ms) {
429 zephyr_timing_delay_context *ctx = (zephyr_timing_delay_context *)data;
435 ctx->start_time = k_uptime_get_32();
438 ctx->int_time = ctx->start_time + int_ms;
439 ctx->fin_time = ctx->start_time + fin_ms;
447zephyr_timing_get_delay(
void *data) {
448 zephyr_timing_delay_context *ctx = (zephyr_timing_delay_context *)data;
451 if (ctx ==
NULL || ctx->fin_time == 0) {
455 now = k_uptime_get_32();
457 if (now >= ctx->fin_time) {
461 if (now >= ctx->int_time) {
470#if !COAP_USE_PSA_CRYPTO
471#ifndef MBEDTLS_2_X_COMPAT
476coap_rng(
void *ctx
COAP_UNUSED,
unsigned char *buf,
size_t len) {
477 return coap_prng_lkd(buf, len) ? 0 : MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED;
483coap_dgram_read(
void *ctx,
unsigned char *out,
size_t outl) {
488 if (!c_session->
tls) {
490 return MBEDTLS_ERR_SSL_WANT_READ;
492 data = &((coap_mbedtls_env_t *)c_session->
tls)->coap_ssl_data;
495 if (data->pdu_len > 0) {
496 if (outl < data->pdu_len) {
497 memcpy(out, data->pdu, outl);
500 data->pdu_len -= outl;
502 memcpy(out, data->pdu, data->pdu_len);
504 if (!data->peekmode) {
510 ret = MBEDTLS_ERR_SSL_WANT_READ;
524coap_dgram_write(
void *ctx,
const unsigned char *send_buffer,
525 size_t send_buffer_length) {
530 coap_mbedtls_env_t *m_env = (coap_mbedtls_env_t *)c_session->
tls;
534 && c_session->endpoint ==
NULL
542 send_buffer, send_buffer_length);
543 if (result != (ssize_t)send_buffer_length) {
544 int keep_errno = errno;
547 result, send_buffer_length);
550 if (errno == ENOTCONN || errno == ECONNREFUSED)
559 m_env->last_timeout = now;
567#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED) && defined(MBEDTLS_SSL_SRV_C)
572psk_server_callback(
void *p_info, mbedtls_ssl_context *ssl,
573 const unsigned char *identity,
size_t identity_len) {
576 coap_mbedtls_env_t *m_env;
580 if (c_session ==
NULL)
584 lidentity.
s = identity ? (
const uint8_t *)identity : (const uint8_t *)
"";
585 lidentity.
length = identity ? identity_len : 0;
589 (
int)lidentity.
length, (
const char *)lidentity.
s);
591 m_env = (coap_mbedtls_env_t *)c_session->
tls;
592 setup_data = &c_session->
context->spsk_setup_data;
606 mbedtls_ssl_set_hs_psk(ssl, psk_key->
s, psk_key->
length);
607 m_env->seen_client_hello = 1;
613get_san_or_cn_from_cert(mbedtls_x509_crt *crt) {
615 const mbedtls_asn1_named_data *cn_data;
617 if (crt->ext_types & MBEDTLS_X509_EXT_SUBJECT_ALT_NAME) {
618 mbedtls_asn1_sequence *seq = &crt->subject_alt_names;
619 while (seq && seq->buf.p ==
NULL) {
624 return mbedtls_strndup((
const char *)seq->buf.p,
629 cn_data = mbedtls_asn1_find_named_data(&crt->subject,
631 MBEDTLS_OID_SIZE(MBEDTLS_OID_AT_CN));
634 return mbedtls_strndup((
const char *)cn_data->val.p,
641#if COAP_MAX_LOGGING_LEVEL > 0
643get_error_string(
int ret) {
644 static char buf[128] = {0};
645 mbedtls_strerror(ret, buf,
sizeof(buf)-1);
651self_signed_cert_verify_callback_mbedtls(
void *data,
656 const coap_mbedtls_context_t *m_context =
660 if (*flags & MBEDTLS_X509_BADCERT_EXPIRED) {
662 *flags &= ~MBEDTLS_X509_BADCERT_EXPIRED;
673cert_verify_callback_mbedtls(
void *data, mbedtls_x509_crt *crt,
674 int depth, uint32_t *flags) {
676 coap_mbedtls_context_t *m_context =
681 cn = get_san_or_cn_from_cert(crt);
685 if (*flags & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
686 *flags &= ~MBEDTLS_X509_BADCERT_CN_MISMATCH;
697 *flags |= MBEDTLS_X509_BADCERT_CN_MISMATCH;
706 if (*flags & MBEDTLS_X509_BADCERT_EXPIRED) {
708 *flags &= ~MBEDTLS_X509_BADCERT_EXPIRED;
711 "The certificate has expired", cn ? cn :
"?", depth);
714 if (*flags & MBEDTLS_X509_BADCERT_FUTURE) {
716 *flags &= ~MBEDTLS_X509_BADCERT_FUTURE;
719 "The certificate has a future date", cn ? cn :
"?", depth);
722 if (*flags & MBEDTLS_X509_BADCERT_BAD_MD) {
724 *flags &= ~MBEDTLS_X509_BADCERT_BAD_MD;
727 "The certificate has a bad MD hash", cn ? cn :
"?", depth);
730 if (*flags & MBEDTLS_X509_BADCERT_BAD_KEY) {
732 *flags &= ~MBEDTLS_X509_BADCERT_BAD_KEY;
735 "The certificate has a short RSA length", cn ? cn :
"?", depth);
738 if (*flags & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
740 int self_signed = !mbedtls_x509_crt_verify(crt, crt,
NULL,
NULL, &lflags,
741 self_signed_cert_verify_callback_mbedtls,
743 if (self_signed && depth == 0) {
746 *flags &= ~MBEDTLS_X509_BADCERT_NOT_TRUSTED;
750 cn ? cn :
"?", depth);
752 }
else if (self_signed) {
754 *flags &= ~MBEDTLS_X509_BADCERT_NOT_TRUSTED;
757 "Self-signed", cn ? cn :
"?", depth);
761 *flags &= ~MBEDTLS_X509_BADCERT_NOT_TRUSTED;
764 "The certificate's CA is not trusted", cn ? cn :
"?", depth);
768 if (*flags & MBEDTLS_X509_BADCRL_EXPIRED) {
770 *flags &= ~MBEDTLS_X509_BADCRL_EXPIRED;
773 "The certificate's CRL has expired", cn ? cn :
"?", depth);
775 *flags &= ~MBEDTLS_X509_BADCRL_EXPIRED;
778 if (*flags & MBEDTLS_X509_BADCRL_FUTURE) {
780 *flags &= ~MBEDTLS_X509_BADCRL_FUTURE;
783 "The certificate's CRL has a future date", cn ? cn :
"?", depth);
785 *flags &= ~MBEDTLS_X509_BADCRL_FUTURE;
790 *flags |= MBEDTLS_X509_BADCERT_OTHER;
793 "The certificate's verify depth is too long",
794 cn ? cn :
"?", depth);
800 int ret = mbedtls_x509_crt_verify_info(buf,
sizeof(buf),
"", *flags);
803 tcp = strchr(buf,
'\n');
808 buf, *flags, cn ? cn :
"?", depth);
809 tcp = strchr(tcp+1,
'\n');
812 coap_log_err(
"mbedtls_x509_crt_verify_info returned -0x%x: '%s'\n",
813 -ret, get_error_string(ret));
824setup_pki_credentials(mbedtls_x509_crt *cacert,
825 mbedtls_x509_crt *public_cert,
826 mbedtls_pk_context *private_key,
827 coap_mbedtls_env_t *m_env,
828 coap_mbedtls_context_t *m_context,
834 int done_private_key = 0;
835 int done_public_cert = 0;
853#if defined(MBEDTLS_FS_IO)
854 mbedtls_pk_init(private_key);
855#if COAP_USE_PSA_CRYPTO
856 ret = mbedtls_pk_parse_keyfile(private_key,
858#elif defined(MBEDTLS_2_X_COMPAT)
859 ret = mbedtls_pk_parse_keyfile(private_key,
862 ret = mbedtls_pk_parse_keyfile(private_key,
864 NULL, coap_rng, (
void *)&m_env->ctr_drbg);
871 done_private_key = 1;
879 mbedtls_pk_init(private_key);
883 buffer = mbedtls_malloc(length + 1);
889 buffer[length] =
'\000';
891#if COAP_USE_PSA_CRYPTO
892 ret = mbedtls_pk_parse_key(private_key, buffer, length,
NULL, 0);
893#elif defined(MBEDTLS_2_X_COMPAT)
894 ret = mbedtls_pk_parse_key(private_key, buffer, length,
NULL, 0);
896 ret = mbedtls_pk_parse_key(private_key, buffer, length,
897 NULL, 0, coap_rng, (
void *)&m_env->ctr_drbg);
899 mbedtls_free(buffer);
901#if COAP_USE_PSA_CRYPTO
902 ret = mbedtls_pk_parse_key(private_key,
905#elif defined(MBEDTLS_2_X_COMPAT)
906 ret = mbedtls_pk_parse_key(private_key,
910 ret = mbedtls_pk_parse_key(private_key,
913 NULL, 0, coap_rng, (
void *)&m_env->ctr_drbg);
921 done_private_key = 1;
924 mbedtls_pk_init(private_key);
925#if COAP_USE_PSA_CRYPTO
926 ret = mbedtls_pk_parse_key(private_key,
929#elif defined(MBEDTLS_2_X_COMPAT)
930 ret = mbedtls_pk_parse_key(private_key,
934 ret = mbedtls_pk_parse_key(private_key,
937 (
void *)&m_env->ctr_drbg);
944 done_private_key = 1;
972#if defined(MBEDTLS_FS_IO)
973 mbedtls_x509_crt_init(public_cert);
974 ret = mbedtls_x509_crt_parse_file(public_cert,
981 done_public_cert = 1;
989 mbedtls_x509_crt_init(public_cert);
994 buffer = mbedtls_malloc(length + 1);
1000 buffer[length] =
'\000';
1002 ret = mbedtls_x509_crt_parse(public_cert, buffer, length);
1003 mbedtls_free(buffer);
1005 ret = mbedtls_x509_crt_parse(public_cert,
1014 done_public_cert = 1;
1021 mbedtls_x509_crt_init(public_cert);
1022 ret = mbedtls_x509_crt_parse(public_cert,
1030 done_public_cert = 1;
1048 if (done_private_key && done_public_cert) {
1049 ret = mbedtls_ssl_conf_own_cert(&m_env->conf, public_cert, private_key);
1051 coap_log_err(
"mbedtls_ssl_conf_own_cert returned -0x%x: '%s'\n",
1052 -ret, get_error_string(ret));
1067#if defined(MBEDTLS_FS_IO)
1068 mbedtls_x509_crt_init(cacert);
1069 ret = mbedtls_x509_crt_parse_file(cacert,
1076 mbedtls_ssl_conf_ca_chain(&m_env->conf, cacert,
NULL);
1084 mbedtls_x509_crt_init(cacert);
1088 buffer = mbedtls_malloc(length + 1);
1094 buffer[length] =
'\000';
1096 ret = mbedtls_x509_crt_parse(cacert, buffer, length);
1097 mbedtls_free(buffer);
1099 ret = mbedtls_x509_crt_parse(cacert,
1108 mbedtls_ssl_conf_ca_chain(&m_env->conf, cacert,
NULL);
1115 mbedtls_x509_crt_init(cacert);
1116 ret = mbedtls_x509_crt_parse(cacert,
1124 mbedtls_ssl_conf_ca_chain(&m_env->conf, cacert,
NULL);
1138#if defined(MBEDTLS_FS_IO)
1139 if (m_context->root_ca_file) {
1140 ret = mbedtls_x509_crt_parse_file(cacert, m_context->root_ca_file);
1147 mbedtls_ssl_conf_ca_chain(&m_env->conf, cacert,
NULL);
1149 if (m_context->root_ca_path) {
1150 ret = mbedtls_x509_crt_parse_path(cacert, m_context->root_ca_path);
1157 mbedtls_ssl_conf_ca_chain(&m_env->conf, cacert,
NULL);
1159#if MBEDTLS_VERSION_NUMBER >= 0x04000000
1160 if (m_context->trust_store_defined)
1162 if (m_context->trust_store_defined ||
1167 const char *trust_list[] = {
1168 "/etc/ssl/ca-bundle.pem",
1169 "/etc/ssl/certs/ca-certificates.crt",
1170 "/etc/pki/tls/cert.pem",
1171 "/usr/local/share/certs/ca-root-nss.crt",
1174 static const char *trust_file_found =
NULL;
1175 static int trust_file_done = 0;
1178 if (trust_file_found) {
1179 ret = mbedtls_x509_crt_parse_file(cacert, trust_file_found);
1181 mbedtls_ssl_conf_ca_chain(&m_env->conf, cacert,
NULL);
1186 }
else if (!trust_file_done) {
1187 trust_file_done = 1;
1188 for (i = 0; i <
sizeof(trust_list)/
sizeof(trust_list[0]); i++) {
1189 ret = mbedtls_x509_crt_parse_file(cacert, trust_list[i]);
1191 mbedtls_ssl_conf_ca_chain(&m_env->conf, cacert,
NULL);
1192 trust_file_found = trust_list[i];
1196 if (i ==
sizeof(trust_list)/
sizeof(trust_list[0])) {
1202 if (m_context->root_ca_file || m_context->root_ca_path ||
1203 m_context->trust_store_defined) {
1211#if defined(MBEDTLS_SSL_SRV_C)
1212 mbedtls_ssl_conf_cert_req_ca_list(&m_env->conf,
1214 MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED :
1215 MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED);
1218 MBEDTLS_SSL_VERIFY_REQUIRED :
1219 MBEDTLS_SSL_VERIFY_NONE);
1224 mbedtls_ssl_conf_verify(&m_env->conf,
1225 cert_verify_callback_mbedtls, c_session);
1230#if defined(MBEDTLS_SSL_SRV_C)
1235pki_sni_callback(
void *p_info, mbedtls_ssl_context *ssl,
1236 const unsigned char *uname,
size_t name_len) {
1240 coap_mbedtls_env_t *m_env = (coap_mbedtls_env_t *)c_session->
tls;
1241 coap_mbedtls_context_t *m_context =
1245 name = mbedtls_malloc(name_len+1);
1249 memcpy(name, uname, name_len);
1250 name[name_len] =
'\000';
1253 for (i = 0; i < m_context->pki_sni_count; i++) {
1254 if (strcasecmp(name, m_context->pki_sni_entry_list[i].sni) == 0) {
1258 if (i == m_context->pki_sni_count) {
1263 pki_sni_entry *pki_sni_entry_list;
1266 m_context->setup_data.validate_sni_call_back(name,
1267 m_context->setup_data.sni_call_back_arg));
1273 pki_sni_entry_list = mbedtls_realloc(m_context->pki_sni_entry_list,
1274 (i+1)*
sizeof(pki_sni_entry));
1276 if (pki_sni_entry_list ==
NULL) {
1280 m_context->pki_sni_entry_list = pki_sni_entry_list;
1281 memset(&m_context->pki_sni_entry_list[i], 0,
1282 sizeof(m_context->pki_sni_entry_list[i]));
1283 m_context->pki_sni_entry_list[i].sni = name;
1284 m_context->pki_sni_entry_list[i].pki_key = *new_entry;
1285 sni_setup_data = m_context->setup_data;
1286 sni_setup_data.pki_key = *new_entry;
1287 if (setup_pki_credentials(&m_context->pki_sni_entry_list[i].cacert,
1288 &m_context->pki_sni_entry_list[i].public_cert,
1289 &m_context->pki_sni_entry_list[i].private_key,
1298 m_context->pki_sni_count++;
1303 mbedtls_ssl_set_hs_ca_chain(ssl, &m_context->pki_sni_entry_list[i].cacert,
1305 return mbedtls_ssl_set_hs_own_cert(ssl,
1306 &m_context->pki_sni_entry_list[i].public_cert,
1307 &m_context->pki_sni_entry_list[i].private_key);
1310#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
1315psk_sni_callback(
void *p_info, mbedtls_ssl_context *ssl,
1316 const unsigned char *uname,
size_t name_len) {
1319 coap_mbedtls_context_t *m_context =
1323 name = mbedtls_malloc(name_len+1);
1327 memcpy(name, uname, name_len);
1328 name[name_len] =
'\000';
1331 for (i = 0; i < m_context->psk_sni_count; i++) {
1332 if (strcasecmp(name, m_context->psk_sni_entry_list[i].sni) == 0) {
1336 if (i == m_context->psk_sni_count) {
1341 psk_sni_entry *psk_sni_entry_list;
1344 c_session->
context->spsk_setup_data.validate_sni_call_back(name,
1346 c_session->
context->spsk_setup_data.sni_call_back_arg));
1352 psk_sni_entry_list = mbedtls_realloc(m_context->psk_sni_entry_list,
1353 (i+1)*
sizeof(psk_sni_entry));
1355 if (psk_sni_entry_list ==
NULL) {
1359 m_context->psk_sni_entry_list = psk_sni_entry_list;
1360 m_context->psk_sni_entry_list[i].sni = name;
1361 m_context->psk_sni_entry_list[i].psk_info = *new_entry;
1363 m_context->psk_sni_count++;
1369 &m_context->psk_sni_entry_list[i].psk_info.hint);
1371 &m_context->psk_sni_entry_list[i].psk_info.key);
1372#if MBEDTLS_VERSION_NUMBER >= 0x04000000
1376 return mbedtls_ssl_set_hs_psk(ssl,
1377 m_context->psk_sni_entry_list[i].psk_info.key.s,
1378 m_context->psk_sni_entry_list[i].psk_info.key.length);
1385 coap_mbedtls_env_t *m_env) {
1386 coap_mbedtls_context_t *m_context =
1389 m_context->psk_pki_enabled |= IS_SERVER;
1391 mbedtls_ssl_cookie_init(&m_env->cookie_ctx);
1392 if ((ret = mbedtls_ssl_config_defaults(&m_env->conf,
1393 MBEDTLS_SSL_IS_SERVER,
1395 MBEDTLS_SSL_TRANSPORT_DATAGRAM :
1396 MBEDTLS_SSL_TRANSPORT_STREAM,
1397 MBEDTLS_SSL_PRESET_DEFAULT)) != 0) {
1398 coap_log_err(
"mbedtls_ssl_config_defaults returned -0x%x: '%s'\n",
1399 -ret, get_error_string(ret));
1403#if !COAP_USE_PSA_CRYPTO
1404 mbedtls_ssl_conf_rng(&m_env->conf, mbedtls_ctr_drbg_random, &m_env->ctr_drbg);
1407#if defined(MBEDTLS_SSL_PROTO_DTLS)
1412 if (m_context->psk_pki_enabled & IS_PSK) {
1413#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
1414 mbedtls_ssl_conf_psk_cb(&m_env->conf, psk_server_callback, c_session);
1415 if (c_session->
context->spsk_setup_data.validate_sni_call_back) {
1416 mbedtls_ssl_conf_sni(&m_env->conf, psk_sni_callback, c_session);
1418#ifdef MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1419 m_env->ec_jpake = c_session->
context->spsk_setup_data.ec_jpake;
1426 if (m_context->psk_pki_enabled & IS_PKI) {
1427 ret = setup_pki_credentials(&m_env->cacert, &m_env->public_cert,
1428 &m_env->private_key, m_env, m_context,
1429 c_session, &m_context->setup_data,
1435 if (m_context->setup_data.validate_sni_call_back) {
1436 mbedtls_ssl_conf_sni(&m_env->conf, pki_sni_callback, c_session);
1440#if COAP_USE_PSA_CRYPTO
1441 if ((ret = mbedtls_ssl_cookie_setup(&m_env->cookie_ctx)) != 0) {
1443 if ((ret = mbedtls_ssl_cookie_setup(&m_env->cookie_ctx,
1444 mbedtls_ctr_drbg_random,
1445 &m_env->ctr_drbg)) != 0) {
1447 coap_log_err(
"mbedtls_ssl_cookie_setup: returned -0x%x: '%s'\n",
1448 -ret, get_error_string(ret));
1452#if defined(MBEDTLS_SSL_PROTO_DTLS)
1453 mbedtls_ssl_conf_dtls_cookies(&m_env->conf, mbedtls_ssl_cookie_write,
1454 mbedtls_ssl_cookie_check,
1455 &m_env->cookie_ctx);
1456#if MBEDTLS_VERSION_NUMBER >= 0x02100100
1457 mbedtls_ssl_set_mtu(&m_env->ssl, (uint16_t)c_session->
mtu);
1460#ifdef MBEDTLS_SSL_DTLS_CONNECTION_ID
1475#if COAP_CLIENT_SUPPORT
1476static int *psk_ciphers =
NULL;
1477static int *pki_ciphers =
NULL;
1478static int *ecjpake_ciphers =
NULL;
1479static int processed_ciphers = 0;
1481#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
1483coap_ssl_ciphersuite_uses_psk(
const mbedtls_ssl_ciphersuite_t *info) {
1484#if COAP_USE_PSA_CRYPTO
1485 switch (info->key_exchange) {
1486 case MBEDTLS_KEY_EXCHANGE_PSK:
1487 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
1489 case MBEDTLS_KEY_EXCHANGE_NONE:
1490 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
1491 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
1492 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
1496#elif MBEDTLS_VERSION_NUMBER >= 0x03060000
1497 switch (info->key_exchange) {
1498 case MBEDTLS_KEY_EXCHANGE_PSK:
1499 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
1500 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
1501 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
1503 case MBEDTLS_KEY_EXCHANGE_NONE:
1504 case MBEDTLS_KEY_EXCHANGE_RSA:
1505 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
1506 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
1507 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
1508 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
1509 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
1510 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
1515 return mbedtls_ssl_ciphersuite_uses_psk(info);
1521set_ciphersuites(mbedtls_ssl_config *conf, coap_enc_method_t method) {
1522 if (!processed_ciphers) {
1523 const int *list = mbedtls_ssl_list_ciphersuites();
1524 const int *base = list;
1527#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
1529 int ecjpake_count = 1;
1535 const mbedtls_ssl_ciphersuite_t *cur =
1536 mbedtls_ssl_ciphersuite_from_id(*list);
1539#if MBEDTLS_VERSION_NUMBER >= 0x03020000
1540 if (cur->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2) {
1544 if (cur->max_minor_ver < MBEDTLS_SSL_MINOR_VERSION_3) {
1548#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
1549 else if (cur->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
1553#if MBEDTLS_VERSION_NUMBER >= 0x03060000
1554 else if (cur->min_tls_version >= MBEDTLS_SSL_VERSION_TLS1_3) {
1559#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
1560 else if (coap_ssl_ciphersuite_uses_psk(cur)) {
1572 psk_ciphers = mbedtls_malloc(psk_count *
sizeof(psk_ciphers[0]));
1573 if (psk_ciphers ==
NULL) {
1574 coap_log_err(
"set_ciphers: mbedtls_malloc with count %d failed\n", psk_count);
1577 pki_ciphers = mbedtls_malloc(pki_count *
sizeof(pki_ciphers[0]));
1578 if (pki_ciphers ==
NULL) {
1579 coap_log_err(
"set_ciphers: mbedtls_malloc with count %d failed\n", pki_count);
1580 mbedtls_free(psk_ciphers);
1584#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
1585 ecjpake_ciphers = mbedtls_malloc(ecjpake_count *
sizeof(ecjpake_ciphers[0]));
1586 if (ecjpake_ciphers ==
NULL) {
1587 coap_log_err(
"set_ciphers: mbedtls_malloc with count %d failed\n", pki_count);
1588 mbedtls_free(psk_ciphers);
1589 mbedtls_free(pki_ciphers);
1596 psk_list = psk_ciphers;
1597 pki_list = pki_ciphers;
1598#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
1599 ecjpake_list = ecjpake_ciphers;
1603 const mbedtls_ssl_ciphersuite_t *cur =
1604 mbedtls_ssl_ciphersuite_from_id(*list);
1606#if MBEDTLS_VERSION_NUMBER >= 0x03020000
1607 if (cur->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2) {
1611 if (cur->max_minor_ver < MBEDTLS_SSL_MINOR_VERSION_3) {
1615#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
1616 else if (cur->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
1617 *ecjpake_list = *list;
1621#if MBEDTLS_VERSION_NUMBER >= 0x03060000
1622 else if (cur->min_tls_version >= MBEDTLS_SSL_VERSION_TLS1_3) {
1629#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
1630 else if (coap_ssl_ciphersuite_uses_psk(cur)) {
1645 processed_ciphers = 1;
1649 mbedtls_ssl_conf_ciphersuites(conf, psk_ciphers);
1652 mbedtls_ssl_conf_ciphersuites(conf, pki_ciphers);
1654 case COAP_ENC_ECJPAKE:
1655 mbedtls_ssl_conf_ciphersuites(conf, ecjpake_ciphers);
1665 coap_mbedtls_env_t *m_env) {
1668 coap_mbedtls_context_t *m_context =
1671 m_context->psk_pki_enabled |= IS_CLIENT;
1673 if ((ret = mbedtls_ssl_config_defaults(&m_env->conf,
1674 MBEDTLS_SSL_IS_CLIENT,
1676 MBEDTLS_SSL_TRANSPORT_DATAGRAM :
1677 MBEDTLS_SSL_TRANSPORT_STREAM,
1678 MBEDTLS_SSL_PRESET_DEFAULT)) != 0) {
1679 coap_log_err(
"mbedtls_ssl_config_defaults returned -0x%x: '%s'\n",
1680 -ret, get_error_string(ret));
1684#if defined(MBEDTLS_SSL_PROTO_DTLS)
1689 mbedtls_ssl_conf_authmode(&m_env->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
1690#if !COAP_USE_PSA_CRYPTO
1691 mbedtls_ssl_conf_rng(&m_env->conf, mbedtls_ctr_drbg_random, &m_env->ctr_drbg);
1694 if (m_context->psk_pki_enabled & IS_PSK) {
1695#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
1703 if (psk_key ==
NULL || psk_identity ==
NULL) {
1704 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
1708 if ((ret = mbedtls_ssl_conf_psk(&m_env->conf, psk_key->
s,
1709 psk_key->
length, psk_identity->
s,
1710 psk_identity->
length)) != 0) {
1711 coap_log_err(
"mbedtls_ssl_conf_psk returned -0x%x: '%s'\n",
1712 -ret, get_error_string(ret));
1716 if ((ret = mbedtls_ssl_set_hostname(&m_env->ssl,
1718 coap_log_err(
"mbedtls_ssl_set_hostname returned -0x%x: '%s'\n",
1719 -ret, get_error_string(ret));
1725#ifdef MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1727 m_env->ec_jpake = 1;
1728 set_ciphersuites(&m_env->conf, COAP_ENC_ECJPAKE);
1729#if MBEDTLS_VERSION_NUMBER >= 0x03020000
1730 mbedtls_ssl_conf_max_tls_version(&m_env->conf, MBEDTLS_SSL_VERSION_TLS1_2);
1733 set_ciphersuites(&m_env->conf, COAP_ENC_PSK);
1736 set_ciphersuites(&m_env->conf, COAP_ENC_PSK);
1741 }
else if ((m_context->psk_pki_enabled & IS_PKI) ||
1742 (m_context->psk_pki_enabled & (IS_PSK | IS_PKI)) == 0) {
1749 if (!(m_context->psk_pki_enabled & IS_PKI)) {
1763 mbedtls_ssl_conf_authmode(&m_env->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
1764 ret = setup_pki_credentials(&m_env->cacert, &m_env->public_cert,
1765 &m_env->private_key, m_env, m_context,
1766 c_session, setup_data,
1772#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN)
1775 static const char *alpn_list[] = {
"coap",
NULL };
1777 ret = mbedtls_ssl_conf_alpn_protocols(&m_env->conf, alpn_list);
1783 mbedtls_ssl_set_hostname(&m_env->ssl, m_context->setup_data.client_sni);
1784#if defined(MBEDTLS_SSL_PROTO_DTLS)
1785#if MBEDTLS_VERSION_NUMBER >= 0x02100100
1786 mbedtls_ssl_set_mtu(&m_env->ssl, (uint16_t)c_session->
mtu);
1789 set_ciphersuites(&m_env->conf, COAP_ENC_PKI);
1799mbedtls_cleanup(coap_mbedtls_env_t *m_env) {
1804 mbedtls_x509_crt_free(&m_env->cacert);
1805 mbedtls_x509_crt_free(&m_env->public_cert);
1806 mbedtls_pk_free(&m_env->private_key);
1807#if !COAP_USE_PSA_CRYPTO
1808 mbedtls_entropy_free(&m_env->entropy);
1809 mbedtls_ctr_drbg_free(&m_env->ctr_drbg);
1811 mbedtls_ssl_config_free(&m_env->conf);
1812 mbedtls_ssl_free(&m_env->ssl);
1813 mbedtls_ssl_cookie_free(&m_env->cookie_ctx);
1817coap_dtls_free_mbedtls_env(coap_mbedtls_env_t *m_env) {
1819 if (!m_env->sent_alert)
1820 mbedtls_ssl_close_notify(&m_env->ssl);
1821 mbedtls_cleanup(m_env);
1822 mbedtls_free(m_env);
1826#if COAP_MAX_LOGGING_LEVEL > 0
1828report_mbedtls_alert(
unsigned char alert) {
1830 case MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC:
1831 return ": Bad Record MAC";
1832 case MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE:
1833 return ": Handshake failure";
1834 case MBEDTLS_SSL_ALERT_MSG_NO_CERT:
1835 return ": No Certificate provided";
1836 case MBEDTLS_SSL_ALERT_MSG_BAD_CERT:
1837 return ": Certificate is bad";
1838 case MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN:
1839 return ": Certificate is unknown";
1840 case MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA:
1841 return ": CA is unknown";
1842 case MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED:
1843 return ": Access was denied";
1844 case MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR:
1845 return ": Decrypt error";
1859 coap_mbedtls_env_t *m_env) {
1863 ret = mbedtls_ssl_handshake(&m_env->ssl);
1866 m_env->established = 1;
1870#ifdef MBEDTLS_SSL_DTLS_CONNECTION_ID
1871#if COAP_CLIENT_SUPPORT
1874 coap_mbedtls_context_t *m_context;
1878 m_context->setup_data.use_cid) {
1879 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX];
1881 size_t peer_cid_len;
1884 if (mbedtls_ssl_get_peer_cid(&m_env->ssl, &enabled, peer_cid, &peer_cid_len) == 0 &&
1885 enabled == MBEDTLS_SSL_CID_ENABLED) {
1886 c_session->negotiated_cid = 1;
1889 c_session->negotiated_cid = 0;
1898 case MBEDTLS_ERR_SSL_WANT_READ:
1899 case MBEDTLS_ERR_SSL_WANT_WRITE:
1900 if (m_env->ssl.state == MBEDTLS_SSL_SERVER_HELLO
1901#
if MBEDTLS_VERSION_NUMBER >= 0x03030000
1902 || m_env->ssl.state == MBEDTLS_SSL_NEW_SESSION_TICKET
1905 if (++m_env->server_hello_cnt > 10) {
1913 case MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED:
1916 case MBEDTLS_ERR_SSL_INVALID_MAC:
1918#ifdef MBEDTLS_2_X_COMPAT
1919 case MBEDTLS_ERR_SSL_UNKNOWN_CIPHER:
1921 case MBEDTLS_ERR_SSL_DECODE_ERROR:
1924 case MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE:
1925 alert = MBEDTLS_SSL_ALERT_MSG_NO_CERT;
1927#ifdef MBEDTLS_2_X_COMPAT
1928 case MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO:
1929 case MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO:
1930 alert = MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE;
1933 case MBEDTLS_ERR_X509_CERT_VERIFY_FAILED:
1935 case MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE:
1936 if (m_env->ssl.in_msg[1] != MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY)
1939 report_mbedtls_alert(m_env->ssl.in_msg[1]));
1941 case MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY:
1942 case MBEDTLS_ERR_SSL_CONN_EOF:
1943 case MBEDTLS_ERR_NET_CONN_RESET:
1949 "returned -0x%x: '%s'\n",
1950 -ret, get_error_string(ret));
1957 mbedtls_ssl_send_alert_message(&m_env->ssl,
1958 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
1960 m_env->sent_alert = 1;
1965 get_error_string(ret));
1967 mbedtls_ssl_session_reset(&m_env->ssl);
1968#ifdef MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1969 if (m_env->ec_jpake) {
1972#if COAP_CLIENT_SUPPORT && COAP_SERVER_SUPPORT
1978#elif COAP_CLIENT_SUPPORT
1984 mbedtls_ssl_set_hs_ecjpake_password(&m_env->ssl, psk_key->
s, psk_key->
length);
1992mbedtls_debug_out(
void *ctx
COAP_UNUSED,
int level,
2025#if !COAP_DISABLE_TCP
2033coap_sock_read(
void *ctx,
unsigned char *out,
size_t outl) {
2034 int ret = MBEDTLS_ERR_SSL_CONN_EOF;
2041 if (errno == ECONNRESET) {
2043 ret = MBEDTLS_ERR_SSL_CONN_EOF;
2045 ret = MBEDTLS_ERR_NET_RECV_FAILED;
2047 }
else if (ret == 0) {
2049 ret = MBEDTLS_ERR_SSL_WANT_READ;
2062coap_sock_write(
void *context,
const unsigned char *in,
size_t inl) {
2067 (
const uint8_t *)in,
2073 (errno == EPIPE || errno == ECONNRESET)) {
2088 int lasterror = WSAGetLastError();
2090 if (lasterror == WSAEWOULDBLOCK) {
2091 ret = MBEDTLS_ERR_SSL_WANT_WRITE;
2092 }
else if (lasterror == WSAECONNRESET) {
2093 ret = MBEDTLS_ERR_NET_CONN_RESET;
2096 if (errno == EAGAIN || errno == EINTR) {
2097 ret = MBEDTLS_ERR_SSL_WANT_WRITE;
2098 }
else if (errno == EPIPE || errno == ECONNRESET) {
2099 ret = MBEDTLS_ERR_NET_CONN_RESET;
2103 ret = MBEDTLS_ERR_NET_SEND_FAILED;
2112 ret = MBEDTLS_ERR_SSL_WANT_WRITE;
2118static coap_mbedtls_env_t *
2122#if !COAP_USE_PSA_CRYPTO
2125 coap_mbedtls_env_t *m_env = (coap_mbedtls_env_t *)c_session->
tls;
2130 m_env = (coap_mbedtls_env_t *)mbedtls_malloc(
sizeof(coap_mbedtls_env_t));
2134 memset(m_env, 0,
sizeof(coap_mbedtls_env_t));
2136 mbedtls_ssl_init(&m_env->ssl);
2137#if !COAP_USE_PSA_CRYPTO
2138 mbedtls_ctr_drbg_init(&m_env->ctr_drbg);
2139 mbedtls_entropy_init(&m_env->entropy);
2141 mbedtls_ssl_config_init(&m_env->conf);
2143#if defined(ESPIDF_VERSION) && defined(CONFIG_MBEDTLS_DEBUG)
2144 mbedtls_esp_enable_debug_log(&m_env->conf, CONFIG_MBEDTLS_DEBUG_LEVEL);
2147#if !COAP_USE_PSA_CRYPTO
2148 if ((ret = mbedtls_ctr_drbg_seed(&m_env->ctr_drbg,
2149 mbedtls_entropy_func, &m_env->entropy,
NULL, 0)) != 0) {
2150 if (ret != MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED) {
2151 coap_log_info(
"mbedtls_ctr_drbg_seed returned -0x%x: '%s'\n",
2152 -ret, get_error_string(ret));
2155 coap_log_err(
"mbedtls_ctr_drbg_seed returned -0x%x: '%s'\n",
2156 -ret, get_error_string(ret));
2161#if COAP_CLIENT_SUPPORT
2162 if (setup_client_ssl_session(c_session, m_env) != 0) {
2169#if defined(MBEDTLS_SSL_SRV_C)
2170 if (setup_server_ssl_session(c_session, m_env) != 0) {
2180#if MBEDTLS_VERSION_NUMBER >= 0x03020000
2181 mbedtls_ssl_conf_min_tls_version(&m_env->conf, MBEDTLS_SSL_VERSION_TLS1_2);
2183 mbedtls_ssl_conf_min_version(&m_env->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
2184 MBEDTLS_SSL_MINOR_VERSION_3);
2187 if (mbedtls_ssl_setup(&m_env->ssl, &m_env->conf) != 0) {
2191 mbedtls_ssl_set_bio(&m_env->ssl, c_session, coap_dgram_write,
2192 coap_dgram_read,
NULL);
2193#ifdef MBEDTLS_SSL_DTLS_CONNECTION_ID
2196#if COAP_CLIENT_SUPPORT
2197 coap_mbedtls_context_t *m_context =
2201 m_context->setup_data.use_cid) {
2209 mbedtls_ssl_set_cid(&m_env->ssl, MBEDTLS_SSL_CID_ENABLED,
NULL, 0);
2213#if COAP_SERVER_SUPPORT
2223 mbedtls_ssl_set_cid(&m_env->ssl, MBEDTLS_SSL_CID_ENABLED, cid,
2231#if !COAP_DISABLE_TCP
2234 mbedtls_ssl_set_bio(&m_env->ssl, c_session, coap_sock_write,
2235 coap_sock_read,
NULL);
2238#ifdef MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2239 coap_mbedtls_context_t *m_context =
2241 if ((m_context->psk_pki_enabled & IS_PSK) &&
2245#if COAP_CLIENT_SUPPORT && COAP_SERVER_SUPPORT
2251#elif COAP_CLIENT_SUPPORT
2256 mbedtls_ssl_set_hs_ecjpake_password(&m_env->ssl, psk_key->
s, psk_key->
length);
2260 mbedtls_ssl_set_timer_cb(&m_env->ssl, &m_env->timer,
2261 zephyr_timing_set_delay,
2262 zephyr_timing_get_delay);
2264 mbedtls_ssl_set_timer_cb(&m_env->ssl, &m_env->timer,
2265 mbedtls_timing_set_delay,
2266 mbedtls_timing_get_delay);
2269 mbedtls_ssl_conf_dbg(&m_env->conf, mbedtls_debug_out, stdout);
2274 mbedtls_free(m_env);
2281#if defined(MBEDTLS_SSL_PROTO_DTLS)
2284 static int reported = 0;
2288 " - update Mbed TLS to include DTLS\n");
2296#if !COAP_DISABLE_TCP
2345#ifdef MBEDTLS_SSL_DTLS_CONNECTION_ID
2352#if COAP_CLIENT_SUPPORT
2355#ifdef MBEDTLS_SSL_DTLS_CONNECTION_ID
2356 c_context->testing_cids = every;
2368 coap_mbedtls_context_t *m_context;
2371 m_context = (coap_mbedtls_context_t *)mbedtls_malloc(
sizeof(coap_mbedtls_context_t));
2373 memset(m_context, 0,
sizeof(coap_mbedtls_context_t));
2378#if COAP_SERVER_SUPPORT
2387 coap_mbedtls_context_t *m_context =
2390#if !defined(MBEDTLS_SSL_SRV_C)
2392 " libcoap not compiled for Server Mode for Mbed TLS"
2393 " - update Mbed TLS to include Server Mode\n");
2396 if (!m_context || !setup_data)
2400#ifndef MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2401 coap_log_warn(
"Mbed TLS not compiled for EC-JPAKE support\n");
2404 m_context->psk_pki_enabled |= IS_PSK;
2409#if COAP_CLIENT_SUPPORT
2418#if !defined(MBEDTLS_SSL_CLI_C)
2423 " libcoap not compiled for Client Mode for Mbed TLS"
2424 " - update Mbed TLS to include Client Mode\n");
2427 coap_mbedtls_context_t *m_context =
2430 if (!m_context || !setup_data)
2434 coap_log_warn(
"CoAP Client with Mbed TLS does not support Identity Hint selection\n");
2437#ifndef MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2438 coap_log_warn(
"Mbed TLS not compiled for EC-JPAKE support\n");
2442#ifndef MBEDTLS_SSL_DTLS_CONNECTION_ID
2443 coap_log_warn(
"Mbed TLS not compiled for Connection-ID support\n");
2446 m_context->psk_pki_enabled |= IS_PSK;
2456 coap_mbedtls_context_t *m_context =
2459 m_context->setup_data = *setup_data;
2460 if (!m_context->setup_data.verify_peer_cert) {
2462 m_context->setup_data.check_common_ca = 0;
2464 m_context->setup_data.allow_self_signed = 1;
2465 m_context->setup_data.allow_expired_certs = 1;
2466 m_context->setup_data.cert_chain_validation = 1;
2467 m_context->setup_data.cert_chain_verify_depth = 10;
2468 m_context->setup_data.check_cert_revocation = 1;
2469 m_context->setup_data.allow_no_crl = 1;
2470 m_context->setup_data.allow_expired_crl = 1;
2471 m_context->setup_data.allow_bad_md_hash = 1;
2472 m_context->setup_data.allow_short_rsa_length = 1;
2474 m_context->psk_pki_enabled |= IS_PKI;
2476#ifndef MBEDTLS_SSL_DTLS_CONNECTION_ID
2477 coap_log_warn(
"Mbed TLS not compiled for Connection-ID support\n");
2485 const char *ca_file,
2486 const char *ca_path) {
2487 coap_mbedtls_context_t *m_context =
2491 coap_log_warn(
"coap_context_set_pki_root_cas: (D)TLS environment "
2496 if (ca_file ==
NULL && ca_path ==
NULL) {
2497 coap_log_warn(
"coap_context_set_pki_root_cas: ca_file and/or ca_path "
2501 if (m_context->root_ca_file) {
2502 mbedtls_free(m_context->root_ca_file);
2503 m_context->root_ca_file =
NULL;
2507 m_context->root_ca_file = mbedtls_strdup(ca_file);
2510 if (m_context->root_ca_path) {
2511 mbedtls_free(m_context->root_ca_path);
2512 m_context->root_ca_path =
NULL;
2516 m_context->root_ca_path = mbedtls_strdup(ca_path);
2527 coap_mbedtls_context_t *m_context =
2531 coap_log_warn(
"coap_context_load_pki_trust_store: (D)TLS environment "
2535 m_context->trust_store_defined = 1;
2544 coap_mbedtls_context_t *m_context =
2546 return m_context->psk_pki_enabled ? 1 : 0;
2551 coap_mbedtls_context_t *m_context = (coap_mbedtls_context_t *)dtls_context;
2554 for (i = 0; i < m_context->pki_sni_count; i++) {
2555 mbedtls_free(m_context->pki_sni_entry_list[i].sni);
2557 mbedtls_x509_crt_free(&m_context->pki_sni_entry_list[i].public_cert);
2559 mbedtls_pk_free(&m_context->pki_sni_entry_list[i].private_key);
2561 mbedtls_x509_crt_free(&m_context->pki_sni_entry_list[i].cacert);
2563 if (m_context->pki_sni_entry_list)
2564 mbedtls_free(m_context->pki_sni_entry_list);
2566 for (i = 0; i < m_context->psk_sni_count; i++) {
2567 mbedtls_free(m_context->psk_sni_entry_list[i].sni);
2569 if (m_context->psk_sni_entry_list)
2570 mbedtls_free(m_context->psk_sni_entry_list);
2572 if (m_context->root_ca_path)
2573 mbedtls_free(m_context->root_ca_path);
2574 if (m_context->root_ca_file)
2575 mbedtls_free(m_context->root_ca_file);
2577 mbedtls_free(m_context);
2580#if COAP_CLIENT_SUPPORT
2583#if !defined(MBEDTLS_SSL_CLI_C)
2586 " libcoap not compiled for Client Mode for Mbed TLS"
2587 " - update Mbed TLS to include Client Mode\n");
2590 coap_mbedtls_env_t *m_env = coap_dtls_new_mbedtls_env(c_session,
2599 m_env->last_timeout = now;
2600 ret = do_mbedtls_handshake(c_session, m_env);
2602 coap_dtls_free_mbedtls_env(m_env);
2611#if COAP_SERVER_SUPPORT
2614#if !defined(MBEDTLS_SSL_SRV_C)
2617 " libcoap not compiled for Server Mode for Mbed TLS"
2618 " - update Mbed TLS to include Server Mode\n");
2621 coap_mbedtls_env_t *m_env =
2622 (coap_mbedtls_env_t *)c_session->
tls;
2624#if defined(MBEDTLS_SSL_PROTO_DTLS)
2625#if MBEDTLS_VERSION_NUMBER >= 0x02100100
2626 mbedtls_ssl_set_mtu(&m_env->ssl, (uint16_t)c_session->
mtu);
2637 if (c_session && c_session->
context && c_session->
tls) {
2638 coap_dtls_free_mbedtls_env(c_session->
tls);
2647#if defined(MBEDTLS_SSL_PROTO_DTLS)
2648 coap_mbedtls_env_t *m_env =
2649 (coap_mbedtls_env_t *)c_session->
tls;
2651#if MBEDTLS_VERSION_NUMBER >= 0x02100100
2652 mbedtls_ssl_set_mtu(&m_env->ssl, (uint16_t)c_session->
mtu);
2662 const uint8_t *data,
size_t data_len) {
2664 coap_mbedtls_env_t *m_env = (coap_mbedtls_env_t *)c_session->
tls;
2666 assert(m_env !=
NULL);
2674 if (m_env->established) {
2675 ret = mbedtls_ssl_write(&m_env->ssl, (
const unsigned char *) data, data_len);
2678 case MBEDTLS_ERR_SSL_WANT_READ:
2679 case MBEDTLS_ERR_SSL_WANT_WRITE:
2682 case MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE:
2688 "returned -0x%x: '%s'\n",
2689 -ret, get_error_string(ret));
2698 ret = do_mbedtls_handshake(c_session, m_env);
2728 coap_mbedtls_env_t *m_env = (coap_mbedtls_env_t *)c_session->
tls;
2730 int ret = zephyr_timing_get_delay(&m_env->timer);
2732 int ret = mbedtls_timing_get_delay(&m_env->timer);
2734 unsigned int scalar = 1 << m_env->retry_scalar;
2744 m_env->last_timeout = now;
2757 m_env->last_timeout = now;
2775 coap_mbedtls_env_t *m_env = (coap_mbedtls_env_t *)c_session->
tls;
2778 m_env->retry_scalar++;
2780 (do_mbedtls_handshake(c_session, m_env) < 0)) {
2795 const uint8_t *data,
2800 coap_mbedtls_env_t *m_env = (coap_mbedtls_env_t *)c_session->
tls;
2801 coap_ssl_t *ssl_data;
2803 assert(m_env !=
NULL);
2805 ssl_data = &m_env->coap_ssl_data;
2806 if (ssl_data->pdu_len) {
2807 coap_log_err(
"** %s: Previous data not read %u bytes\n",
2810 ssl_data->pdu = data;
2811 ssl_data->pdu_len = (unsigned)data_len;
2813 if (m_env->established) {
2814#if COAP_CONSTRAINED_STACK
2821 ret = mbedtls_ssl_read(&m_env->ssl, pdu,
sizeof(pdu));
2826 if (!c_session->
tls) {
2834 case MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY:
2835 case MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE:
2838 case MBEDTLS_ERR_SSL_WANT_READ:
2842 "returned -0x%x: '%s' (length %" PRIdS ")\n",
2843 -ret, get_error_string(ret), data_len);
2848 ret = do_mbedtls_handshake(c_session, m_env);
2853 if (ssl_data->pdu_len) {
2855 ret = do_mbedtls_handshake(c_session, m_env);
2874 if (ssl_data && ssl_data->pdu_len) {
2876 coap_log_debug(
"coap_dtls_receive: ret %d: remaining data %u\n", ret, ssl_data->pdu_len);
2877 ssl_data->pdu_len = 0;
2878 ssl_data->pdu =
NULL;
2883#if COAP_SERVER_SUPPORT
2891 const uint8_t *data,
2893#if !defined(MBEDTLS_SSL_PROTO_DTLS) || !defined(MBEDTLS_SSL_SRV_C)
2898 " libcoap not compiled for DTLS or Server Mode for Mbed TLS"
2899 " - update Mbed TLS to include DTLS and Server Mode\n");
2902 coap_mbedtls_env_t *m_env = (coap_mbedtls_env_t *)c_session->
tls;
2903 coap_ssl_t *ssl_data;
2910 c_session->
tls = m_env;
2917 if ((ret = mbedtls_ssl_set_client_transport_id(&m_env->ssl,
2920 coap_log_err(
"mbedtls_ssl_set_client_transport_id() returned -0x%x: '%s'\n",
2921 -ret, get_error_string(ret));
2925 ssl_data = &m_env->coap_ssl_data;
2926 if (ssl_data->pdu_len) {
2927 coap_log_err(
"** %s: Previous data not read %u bytes\n",
2930 ssl_data->pdu = data;
2931 ssl_data->pdu_len = (unsigned)data_len;
2933 ret = do_mbedtls_handshake(c_session, m_env);
2934 if (ret == 0 || m_env->seen_client_hello) {
2940 m_env->seen_client_hello = 0;
2946 if (ssl_data->pdu_len) {
2948 coap_log_debug(
"coap_dtls_hello: ret %d: remaining data %u\n", ret, ssl_data->pdu_len);
2949 ssl_data->pdu_len = 0;
2950 ssl_data->pdu =
NULL;
2959 coap_mbedtls_env_t *m_env = (coap_mbedtls_env_t *)c_session->
tls;
2960 int expansion = mbedtls_ssl_get_record_expansion(&m_env->ssl);
2962 if (expansion == MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE) {
2968#if !COAP_DISABLE_TCP
2969#if COAP_CLIENT_SUPPORT
2972#if !defined(MBEDTLS_SSL_CLI_C)
2976 " libcoap not compiled for Client Mode for Mbed TLS"
2977 " - update Mbed TLS to include Client Mode\n");
2980 coap_mbedtls_env_t *m_env = coap_dtls_new_mbedtls_env(c_session,
2989 m_env->last_timeout = now;
2990 c_session->
tls = m_env;
2991 do_mbedtls_handshake(c_session, m_env);
2997#if COAP_SERVER_SUPPORT
3000#if !defined(MBEDTLS_SSL_SRV_C)
3005 " libcoap not compiled for Server Mode for Mbed TLS"
3006 " - update Mbed TLS to include Server Mode\n");
3009 coap_mbedtls_env_t *m_env = coap_dtls_new_mbedtls_env(c_session,
3016 c_session->
tls = m_env;
3017 do_mbedtls_handshake(c_session, m_env);
3038 coap_mbedtls_env_t *m_env = (coap_mbedtls_env_t *)c_session->
tls;
3039 size_t amount_sent = 0;
3041 assert(m_env !=
NULL);
3048 if (m_env->established) {
3049 while (amount_sent < data_len) {
3050 ret = mbedtls_ssl_write(&m_env->ssl, &data[amount_sent],
3051 data_len - amount_sent);
3054 case MBEDTLS_ERR_SSL_WANT_READ:
3055 case MBEDTLS_ERR_SSL_WANT_WRITE:
3062 case MBEDTLS_ERR_NET_CONN_RESET:
3063 case MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE:
3068 "returned -0x%x: '%s'\n",
3069 -ret, get_error_string(ret));
3081 ret = do_mbedtls_handshake(c_session, m_env);
3095 if (ret == (ssize_t)data_len)
3114 coap_mbedtls_env_t *m_env = (coap_mbedtls_env_t *)c_session->
tls;
3123 if (!m_env->established && !m_env->sent_alert) {
3124 ret = do_mbedtls_handshake(c_session, m_env);
3128 ret = mbedtls_ssl_read(&m_env->ssl, data, data_len);
3132 case MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY:
3136 case MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE:
3138 m_env->sent_alert = 1;
3141#if MBEDTLS_VERSION_NUMBER >= 0x03060000
3142 case MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET:
3144 case MBEDTLS_ERR_SSL_WANT_READ:
3150 "returned -0x%x: '%s' (length %" PRIdS ")\n",
3151 -ret, get_error_string(ret), data_len);
3155 }
else if (ret < (
int)data_len) {
3178#if COAP_USE_PSA_CRYPTO || defined(MBEDTLS_PSA_CRYPTO_C)
3185#if COAP_CLIENT_SUPPORT
3186 mbedtls_free(psk_ciphers);
3187 mbedtls_free(pki_ciphers);
3188 mbedtls_free(ecjpake_ciphers);
3191 ecjpake_ciphers =
NULL;
3192 processed_ciphers = 0;
3195#if COAP_USE_PSA_CRYPTO || defined(MBEDTLS_PSA_CRYPTO_C)
3196 mbedtls_psa_crypto_free();
3206 if (c_session && c_session->
tls) {
3207 coap_mbedtls_env_t *m_env;
3210 memcpy(&m_env, &c_session->
tls,
sizeof(m_env));
3212 return (
void *)&m_env->ssl;
3221#if !defined(ESPIDF_VERSION)
3231 switch ((
int)level) {
3252 mbedtls_debug_set_threshold(use_level);
3254 keep_log_level = level;
3259 return keep_log_level;
3264#if COAP_WITH_LIBMBEDTLS || COAP_WITH_LIBMBEDTLS_OSCORE
3266#if COAP_SERVER_SUPPORT
3268coap_digest_setup(
void) {
3269 coap_crypto_sha256_ctx_t *digest_ctx = mbedtls_malloc(
sizeof(coap_crypto_sha256_ctx_t));
3272 if (coap_crypto_sha256_init(digest_ctx) != 0) {
3273 coap_digest_free(digest_ctx);
3281coap_digest_free(coap_digest_ctx_t *digest_ctx) {
3283 coap_crypto_sha256_free(digest_ctx);
3284 mbedtls_free(digest_ctx);
3289coap_digest_update(coap_digest_ctx_t *digest_ctx,
3290 const uint8_t *data,
3292 return coap_crypto_sha256_update(digest_ctx, data, data_len) == 0;
3296coap_digest_final(coap_digest_ctx_t *digest_ctx,
3297 coap_digest_t *digest_buffer) {
3298 int ret = coap_crypto_sha256_finish(digest_ctx, (uint8_t *)digest_buffer) == 0;
3299 coap_digest_free(digest_ctx);
3309 coap_crypto_md_type_t md_type;
3314 md_type = COAP_CRYPTO_MD_SHA1;
3317 md_type = COAP_CRYPTO_MD_SHA256;
3320 md_type = COAP_CRYPTO_MD_SHA512;
3323 coap_log_debug(
"coap_crypto_hash: algorithm %d not supported\n", alg);
3327 hash_len = coap_crypto_hash_size(md_type);
3335 if (coap_crypto_hash_compute(md_type, data->
s, data->
length,
3348#if COAP_OSCORE_SUPPORT
3350coap_crypto_hmac_compute(coap_crypto_md_type_t md_type,
3351 const uint8_t *key,
size_t key_len,
3352 const uint8_t *input,
size_t ilen,
3353 uint8_t *output,
size_t output_size,
3354 size_t *output_len) {
3355#if COAP_USE_PSA_CRYPTO
3356 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3357 psa_key_id_t key_id;
3358 psa_algorithm_t psa_alg = PSA_ALG_HMAC(md_type);
3360 psa_status_t status;
3362 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
3363 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
3364 psa_set_key_algorithm(&attributes, psa_alg);
3366 if (psa_import_key(&attributes, key, key_len, &key_id) != PSA_SUCCESS) {
3370 status = psa_mac_compute(key_id, psa_alg, input, ilen,
3371 output, output_size, &mac_len);
3372 psa_destroy_key(key_id);
3375 *output_len = mac_len;
3376 return (status == PSA_SUCCESS) ? 0 : -1;
3378 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_type);
3381 size_t mac_size = mbedtls_md_get_size(md_info);
3382 if (mac_size > output_size)
3385 *output_len = mac_size;
3386 return mbedtls_md_hmac(md_info, key, key_len, input, ilen, output);
3393coap_crypto_aead_encrypt_ccm(
const uint8_t *key,
size_t key_len,
3394 const uint8_t *nonce,
size_t nonce_len,
3395 const uint8_t *aad,
size_t aad_len,
3396 const uint8_t *plaintext,
size_t plaintext_len,
3397 uint8_t *ciphertext,
size_t ciphertext_size,
3398 size_t *ciphertext_len,
size_t tag_len) {
3399#if COAP_USE_PSA_CRYPTO
3400 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3401 psa_key_id_t key_id;
3402 psa_algorithm_t psa_alg = PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, tag_len);
3404 psa_status_t status;
3406 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
3407 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
3408 psa_set_key_algorithm(&attributes, psa_alg);
3409 psa_set_key_bits(&attributes, key_len * 8);
3411 if (psa_import_key(&attributes, key, key_len, &key_id) != PSA_SUCCESS) {
3415 status = psa_aead_encrypt(key_id, psa_alg,
3418 plaintext, plaintext_len,
3419 ciphertext, ciphertext_size, &output_len);
3420 psa_destroy_key(key_id);
3423 *ciphertext_len = output_len;
3424 return (status == PSA_SUCCESS) ? 0 : -1;
3426 mbedtls_cipher_context_t ctx;
3427 const mbedtls_cipher_info_t *cipher_info;
3428 mbedtls_cipher_type_t cipher_type;
3430 size_t result_len = ciphertext_size;
3432 if (key_len == 16) {
3433 cipher_type = MBEDTLS_CIPHER_AES_128_CCM;
3434 }
else if (key_len == 32) {
3435 cipher_type = MBEDTLS_CIPHER_AES_256_CCM;
3440 cipher_info = mbedtls_cipher_info_from_type(cipher_type);
3444 mbedtls_cipher_init(&ctx);
3445 if (mbedtls_cipher_setup(&ctx, cipher_info) != 0)
3447 if (mbedtls_cipher_setkey(&ctx, key, key_len * 8, MBEDTLS_ENCRYPT) != 0)
3450#if (MBEDTLS_VERSION_NUMBER < 0x02150000)
3452 unsigned char tag[16];
3453 if (mbedtls_cipher_auth_encrypt(&ctx,
3456 plaintext, plaintext_len,
3457 ciphertext, &result_len,
3458 tag, tag_len) != 0) {
3461 if ((result_len + tag_len) > ciphertext_size)
3463 memcpy(ciphertext + result_len, tag, tag_len);
3464 result_len += tag_len;
3467 if (mbedtls_cipher_auth_encrypt_ext(&ctx,
3470 plaintext, plaintext_len,
3471 ciphertext, ciphertext_size,
3472 &result_len, tag_len) != 0) {
3478 *ciphertext_len = result_len;
3482 mbedtls_cipher_free(&ctx);
3488coap_crypto_aead_decrypt_ccm(
const uint8_t *key,
size_t key_len,
3489 const uint8_t *nonce,
size_t nonce_len,
3490 const uint8_t *aad,
size_t aad_len,
3491 const uint8_t *ciphertext,
size_t ciphertext_len,
3492 uint8_t *plaintext,
size_t plaintext_size,
3493 size_t *plaintext_len,
size_t tag_len) {
3494#if COAP_USE_PSA_CRYPTO
3495 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3496 psa_key_id_t key_id;
3497 psa_algorithm_t psa_alg = PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, tag_len);
3499 psa_status_t status;
3501 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
3502 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
3503 psa_set_key_algorithm(&attributes, psa_alg);
3504 psa_set_key_bits(&attributes, key_len * 8);
3506 if (psa_import_key(&attributes, key, key_len, &key_id) != PSA_SUCCESS) {
3510 status = psa_aead_decrypt(key_id, psa_alg,
3513 ciphertext, ciphertext_len,
3514 plaintext, plaintext_size, &output_len);
3515 psa_destroy_key(key_id);
3518 *plaintext_len = output_len;
3519 return (status == PSA_SUCCESS) ? 0 : -1;
3521 mbedtls_cipher_context_t ctx;
3522 const mbedtls_cipher_info_t *cipher_info;
3523 mbedtls_cipher_type_t cipher_type;
3525 size_t result_len = plaintext_size;
3527 if (key_len == 16) {
3528 cipher_type = MBEDTLS_CIPHER_AES_128_CCM;
3529 }
else if (key_len == 32) {
3530 cipher_type = MBEDTLS_CIPHER_AES_256_CCM;
3535 cipher_info = mbedtls_cipher_info_from_type(cipher_type);
3539 mbedtls_cipher_init(&ctx);
3540 if (mbedtls_cipher_setup(&ctx, cipher_info) != 0)
3542 if (mbedtls_cipher_setkey(&ctx, key, key_len * 8, MBEDTLS_DECRYPT) != 0)
3545#if (MBEDTLS_VERSION_NUMBER < 0x02150000)
3547 const unsigned char *tag = ciphertext + ciphertext_len - tag_len;
3548 if (mbedtls_cipher_auth_decrypt(&ctx,
3551 ciphertext, ciphertext_len - tag_len,
3552 plaintext, &result_len,
3553 tag, tag_len) != 0) {
3558 if (mbedtls_cipher_auth_decrypt_ext(&ctx,
3561 ciphertext, ciphertext_len,
3562 plaintext, plaintext_size,
3563 &result_len, tag_len) != 0) {
3569 *plaintext_len = result_len;
3573 mbedtls_cipher_free(&ctx);
3589get_cipher_key_size(
cose_alg_t alg,
size_t *key_size) {
3600 coap_log_debug(
"get_cipher_key_size: COSE cipher %d not supported\n", alg);
3610 coap_crypto_md_type_t *md_type,
3612 switch ((
int)hmac_alg) {
3615 *md_type = COAP_CRYPTO_MD_SHA256;
3621 *md_type = COAP_CRYPTO_MD_SHA384;
3627 *md_type = COAP_CRYPTO_MD_SHA512;
3632 coap_log_debug(
"get_hmac_params: COSE HMAC %d not supported\n", hmac_alg);
3639 return get_cipher_key_size(alg,
NULL);
3648 return get_hmac_params(hmac_alg,
NULL,
NULL);
3656 size_t *max_result_len) {
3662 assert(params !=
NULL);
3668 if (!get_cipher_key_size(params->
alg,
NULL)) {
3669 coap_log_debug(
"coap_crypto_aead_encrypt: algorithm %d not supported\n",
3676 if (coap_crypto_aead_encrypt_ccm(ccm->
key.
s, ccm->
key.
length,
3680 result, *max_result_len, max_result_len,
3694 size_t *max_result_len) {
3700 assert(params !=
NULL);
3706 if (!get_cipher_key_size(params->
alg,
NULL)) {
3707 coap_log_debug(
"coap_crypto_aead_decrypt: algorithm %d not supported\n",
3719 if (coap_crypto_aead_decrypt_ccm(ccm->
key.
s, ccm->
key.
length,
3723 result, *max_result_len, max_result_len,
3737 coap_crypto_md_type_t md_type;
3745 if (!get_hmac_params(hmac_alg, &md_type, &mac_len)) {
3746 coap_log_debug(
"coap_crypto_hmac: algorithm %d not supported\n", hmac_alg);
3754 if (coap_crypto_hmac_compute(md_type, key->
s, key->
length,
3774#pragma GCC diagnostic ignored "-Wunused-function"
static size_t strnlen(const char *s, size_t maxlen)
A length-safe strlen() fake.
#define COAP_SERVER_SUPPORT
const char * coap_socket_strerror(void)
#define COAP_RXBUFFER_SIZE
#define COAP_SOCKET_WANT_WRITE
non blocking socket is waiting for writing
#define COAP_SOCKET_CAN_READ
non blocking socket can now read without blocking
Library specific build wrapper for coap_internal.h.
int coap_dtls_context_set_pki(coap_context_t *ctx COAP_UNUSED, const coap_dtls_pki_t *setup_data COAP_UNUSED, const coap_dtls_role_t role COAP_UNUSED)
coap_tick_t coap_dtls_get_timeout(coap_session_t *session COAP_UNUSED, coap_tick_t now COAP_UNUSED)
ssize_t coap_tls_read(coap_session_t *session COAP_UNUSED, uint8_t *data COAP_UNUSED, size_t data_len COAP_UNUSED)
coap_tick_t coap_dtls_get_context_timeout(void *dtls_context COAP_UNUSED)
int coap_dtls_receive(coap_session_t *session COAP_UNUSED, const uint8_t *data COAP_UNUSED, size_t data_len COAP_UNUSED)
void * coap_dtls_get_tls(const coap_session_t *c_session COAP_UNUSED, coap_tls_library_t *tls_lib)
unsigned int coap_dtls_get_overhead(coap_session_t *session COAP_UNUSED)
int coap_dtls_context_load_pki_trust_store(coap_context_t *ctx COAP_UNUSED)
int coap_dtls_context_check_keys_enabled(coap_context_t *ctx COAP_UNUSED)
ssize_t coap_dtls_send(coap_session_t *session COAP_UNUSED, const uint8_t *data COAP_UNUSED, size_t data_len COAP_UNUSED)
ssize_t coap_tls_write(coap_session_t *session COAP_UNUSED, const uint8_t *data COAP_UNUSED, size_t data_len COAP_UNUSED)
void coap_dtls_session_update_mtu(coap_session_t *session COAP_UNUSED)
int coap_dtls_context_set_pki_root_cas(coap_context_t *ctx COAP_UNUSED, const char *ca_file COAP_UNUSED, const char *ca_path COAP_UNUSED)
int coap_dtls_handle_timeout(coap_session_t *session COAP_UNUSED)
void coap_dtls_free_context(void *handle COAP_UNUSED)
void coap_dtls_free_session(coap_session_t *coap_session COAP_UNUSED)
void * coap_dtls_new_context(coap_context_t *coap_context COAP_UNUSED)
void coap_tls_free_session(coap_session_t *coap_session COAP_UNUSED)
uint64_t coap_tick_t
This data type represents internal timer ticks with COAP_TICKS_PER_SECOND resolution.
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.
int coap_handle_dgram(coap_context_t *ctx, coap_session_t *session, uint8_t *msg, size_t msg_len)
Parses and interprets a CoAP datagram with context ctx.
void coap_ticks(coap_tick_t *t)
Returns the current value of an internal tick counter.
int coap_crypto_hmac(cose_hmac_alg_t hmac_alg, coap_bin_const_t *key, coap_bin_const_t *data, coap_bin_const_t **hmac)
Create a HMAC hash of the provided data.
int coap_crypto_aead_decrypt(const coap_crypto_param_t *params, coap_bin_const_t *data, coap_bin_const_t *aad, uint8_t *result, size_t *max_result_len)
Decrypt the provided encrypted data into plaintext.
int coap_crypto_aead_encrypt(const coap_crypto_param_t *params, coap_bin_const_t *data, coap_bin_const_t *aad, uint8_t *result, size_t *max_result_len)
Encrypt the provided plaintext data.
int coap_crypto_hash(cose_alg_t alg, const coap_bin_const_t *data, coap_bin_const_t **hash)
Create a hash of the provided data.
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.
const coap_bin_const_t * coap_get_session_client_psk_identity(const coap_session_t *coap_session)
Get the current client's PSK identity.
void coap_dtls_startup(void)
Initialize the underlying (D)TLS Library layer.
#define COAP_DTLS_RETRANSMIT_MS
int coap_dtls_define_issue(coap_define_issue_key_t type, coap_define_issue_fail_t fail, coap_dtls_key_t *key, const coap_dtls_role_t role, int ret)
Report PKI DEFINE type issue.
void coap_dtls_thread_shutdown(void)
Close down the underlying (D)TLS Library layer.
int coap_dtls_set_cid_tuple_change(coap_context_t *context, uint8_t every)
Set the Connection ID client tuple frequency change for testing CIDs.
#define COAP_DTLS_CID_LENGTH
int coap_dtls_is_context_timeout(void)
Check if timeout is handled per CoAP session or per CoAP context.
void coap_dtls_shutdown(void)
Close down the underlying (D)TLS Library layer.
const coap_bin_const_t * coap_get_session_client_psk_key(const coap_session_t *coap_session)
Get the current client's PSK key.
#define COAP_DTLS_RETRANSMIT_COAP_TICKS
void coap_dtls_map_key_type_to_define(const coap_dtls_pki_t *setup_data, coap_dtls_key_t *key)
Map the PKI key definitions to the new DEFINE format.
const coap_bin_const_t * coap_get_session_server_psk_key(const coap_session_t *coap_session)
Get the current server's PSK key.
#define COAP_DTLS_RETRANSMIT_TOTAL_MS
@ COAP_DEFINE_KEY_PRIVATE
@ COAP_DEFINE_KEY_ROOT_CA
@ COAP_DEFINE_FAIL_NOT_SUPPORTED
coap_tls_version_t * coap_get_tls_library_version(void)
Determine the type and version of the underlying (D)TLS library.
struct coap_dtls_key_t coap_dtls_key_t
The structure that holds the PKI key information.
struct coap_dtls_spsk_info_t coap_dtls_spsk_info_t
The structure that holds the Server Pre-Shared Key and Identity Hint information.
struct coap_dtls_pki_t coap_dtls_pki_t
@ COAP_PKI_KEY_DEF_PKCS11
The PKI key type is PKCS11 (pkcs11:...).
@ COAP_PKI_KEY_DEF_DER_BUF
The PKI key type is DER buffer (ASN.1).
@ COAP_PKI_KEY_DEF_PEM_BUF
The PKI key type is PEM buffer.
@ COAP_PKI_KEY_DEF_PEM
The PKI key type is PEM file.
@ COAP_PKI_KEY_DEF_ENGINE
The PKI key type is to be passed to ENGINE.
@ COAP_PKI_KEY_DEF_RPK_BUF
The PKI key type is RPK in buffer.
@ COAP_PKI_KEY_DEF_DER
The PKI key type is DER file.
@ COAP_PKI_KEY_DEF_PKCS11_RPK
The PKI key type is PKCS11 w/ RPK (pkcs11:...).
@ COAP_DTLS_ROLE_SERVER
Internal function invoked for server.
@ COAP_DTLS_ROLE_CLIENT
Internal function invoked for client.
@ COAP_PKI_KEY_DEFINE
The individual PKI key types are Definable.
@ COAP_TLS_LIBRARY_MBEDTLS
Using Mbed TLS library.
@ COAP_EVENT_DTLS_CLOSED
Triggerred when (D)TLS session closed.
@ COAP_EVENT_DTLS_CONNECTED
Triggered when (D)TLS session connected.
@ COAP_EVENT_DTLS_ERROR
Triggered when (D)TLS error occurs.
#define coap_lock_callback_ret(r, func)
Dummy for no thread-safe code.
#define coap_log_debug(...)
#define coap_log_emerg(...)
coap_log_t coap_dtls_get_log_level(void)
Get the current (D)TLS logging.
#define coap_dtls_log(level,...)
Logging function.
void coap_dtls_set_log_level(coap_log_t level)
Sets the (D)TLS logging level to the specified level.
const char * coap_session_str(const coap_session_t *session)
Get session description.
#define coap_log_info(...)
#define coap_log_warn(...)
#define coap_log_err(...)
int coap_netif_available(coap_session_t *session)
Function interface to check whether netif for session is still available.
int cose_get_hmac_alg_for_hkdf(cose_hkdf_alg_t hkdf_alg, cose_hmac_alg_t *hmac_alg)
@ COSE_HMAC_ALG_HMAC384_384
@ COSE_HMAC_ALG_HMAC256_256
@ COSE_HMAC_ALG_HMAC512_512
@ COSE_ALGORITHM_SHA_256_256
@ COSE_ALGORITHM_AES_CCM_16_64_128
@ COSE_ALGORITHM_AES_CCM_16_64_256
coap_proto_t
CoAP protocol types Note: coap_layers_coap[] needs updating if extended.
int coap_session_refresh_psk_hint(coap_session_t *session, const coap_bin_const_t *psk_hint)
Refresh the session's current Identity Hint (PSK).
int coap_session_refresh_psk_key(coap_session_t *session, const coap_bin_const_t *psk_key)
Refresh the session's current pre-shared key (PSK).
void coap_session_connected(coap_session_t *session)
Notify session that it has just connected or reconnected.
int coap_session_refresh_psk_identity(coap_session_t *session, const coap_bin_const_t *psk_identity)
Refresh the session's current pre-shared identity (PSK).
void coap_session_disconnected_lkd(coap_session_t *session, coap_nack_reason_t reason)
Notify session that it has failed.
#define COAP_PROTO_NOT_RELIABLE(p)
@ COAP_SESSION_TYPE_CLIENT
client-side
@ COAP_SESSION_STATE_HANDSHAKE
@ COAP_SESSION_STATE_NONE
coap_binary_t * coap_new_binary(size_t size)
Returns a new binary object with at least size bytes storage allocated.
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...
void coap_delete_binary(coap_binary_t *s)
Deletes the given coap_binary_t object and releases any memory allocated.
int coap_dtls_cid_is_supported(void)
Check whether (D)TLS CID is available.
int coap_dtls_psk_is_supported(void)
Check whether (D)TLS PSK is available.
int coap_tls_is_supported(void)
Check whether TLS is available.
int coap_oscore_is_supported(void)
Check whether OSCORE is available.
int coap_dtls_is_supported(void)
Check whether DTLS is available.
int coap_dtls_pki_is_supported(void)
Check whether (D)TLS PKI is available.
int coap_dtls_rpk_is_supported(void)
Check whether (D)TLS RPK is available.
int coap_dtls_pkcs11_is_supported(void)
Check whether (D)TLS PKCS11 is available.
coap_address_t remote
remote address and port
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.
The CoAP stack's global state is stored in a coap_context_t object.
The structure that holds the AES Crypto information.
size_t l
The number of bytes in the length field.
const uint8_t * nonce
must be exactly 15 - l bytes
coap_crypto_key_t key
The Key to use.
size_t tag_len
The size of the Tag.
The common structure that holds the Crypto information.
union coap_crypto_param_t::@013342365277111013141357350166222244241273034362 params
coap_crypto_aes_ccm_t aes
Used if AES type encryption.
cose_alg_t alg
The COSE algorith to use.
The structure used for defining the Client PSK setup data to be used.
uint8_t use_cid
Set to 1 if DTLS Connection ID is to be used.
char * client_sni
If not NULL, SNI to use in client TLS setup.
coap_dtls_ih_callback_t validate_ih_call_back
Identity Hint check callback function.
uint8_t ec_jpake
Set to COAP_DTLS_CPSK_SETUP_VERSION to support this version of the struct.
The structure that holds the PKI key information.
coap_pki_key_define_t define
for definable type keys
union coap_dtls_key_t::@063257166335312256117260270312367251270130034073 key
coap_pki_key_t key_type
key format type
The structure used for defining the PKI setup data to be used.
uint8_t allow_no_crl
1 ignore if CRL not there
void * cn_call_back_arg
Passed in to the CN callback function.
uint8_t allow_short_rsa_length
1 if small RSA keysizes are allowed
uint8_t cert_chain_validation
1 if to check cert_chain_verify_depth
uint8_t allow_bad_md_hash
1 if unsupported MD hashes are allowed
uint8_t use_cid
1 if DTLS Connection ID is to be used (Client only, server always enabled) if supported
uint8_t check_cert_revocation
1 if revocation checks wanted
uint8_t cert_chain_verify_depth
recommended depth is 3
uint8_t allow_expired_certs
1 if expired certs are allowed
uint8_t verify_peer_cert
Set to COAP_DTLS_PKI_SETUP_VERSION to support this version of the struct.
uint8_t allow_self_signed
1 if self-signed certs are allowed.
coap_dtls_cn_callback_t validate_cn_call_back
CN check callback function.
uint8_t allow_expired_crl
1 if expired crl is allowed
uint8_t is_rpk_not_cert
1 is RPK instead of Public Certificate.
uint8_t check_common_ca
1 if peer cert is to be signed by the same CA as the local cert
The structure that holds the Server Pre-Shared Key and Identity Hint information.
The structure used for defining the Server PSK setup data to be used.
coap_dtls_id_callback_t validate_id_call_back
Identity check callback function.
void * id_call_back_arg
Passed in to the Identity callback function.
uint8_t ec_jpake
Set to COAP_DTLS_SPSK_SETUP_VERSION to support this version of the struct.
coap_layer_write_t l_write
coap_layer_establish_t l_establish
coap_const_char_ptr_t public_cert
define: Public Cert
coap_const_char_ptr_t private_key
define: Private Key
coap_const_char_ptr_t ca
define: Common CA Certificate
size_t public_cert_len
define Public Cert length (if needed)
size_t ca_len
define CA Cert length (if needed)
coap_pki_define_t private_key_def
define: Private Key type definition
size_t private_key_len
define Private Key length (if needed)
coap_pki_define_t ca_def
define: Common CA type definition
coap_pki_define_t public_cert_def
define: Public Cert type definition
Abstraction of virtual session that can be attached to coap_context_t (client) or coap_endpoint_t (se...
unsigned int dtls_timeout_count
dtls setup retry counter
coap_socket_t sock
socket object for the session, if any
coap_session_state_t state
current state of relationship with peer
coap_addr_tuple_t addr_info
remote/local address info
coap_proto_t proto
protocol used
coap_dtls_cpsk_t cpsk_setup_data
client provided PSK initial setup data
size_t mtu
path or CSM mtu (xmt)
int dtls_event
Tracking any (D)TLS events on this session.
void * tls
security parameters
uint16_t max_retransmit
maximum re-transmit count (default 4)
coap_session_type_t type
client or server side socket
coap_context_t * context
session's context
coap_layer_func_t lfunc[COAP_LAYER_LAST]
Layer functions to use.
coap_socket_flags_t flags
1 or more of COAP_SOCKET* flag values
The structure used for returning the underlying (D)TLS library information.
uint64_t built_version
(D)TLS Built against Library Version
coap_tls_library_t type
Library type.
uint64_t version
(D)TLS runtime Library Version
const char * s_byte
signed char ptr
const uint8_t * u_byte
unsigned char ptr