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;
405 pki_sni_entry **pki_sni_entry_list;
406 size_t psk_sni_count;
407 psk_sni_entry *psk_sni_entry_list;
410 int trust_store_defined;
412} coap_mbedtls_context_t;
414typedef enum coap_enc_method_t {
426} zephyr_timing_delay_context;
429zephyr_timing_set_delay(
void *data, uint32_t int_ms, uint32_t fin_ms) {
430 zephyr_timing_delay_context *ctx = (zephyr_timing_delay_context *)data;
436 ctx->start_time = k_uptime_get_32();
439 ctx->int_time = ctx->start_time + int_ms;
440 ctx->fin_time = ctx->start_time + fin_ms;
448zephyr_timing_get_delay(
void *data) {
449 zephyr_timing_delay_context *ctx = (zephyr_timing_delay_context *)data;
452 if (ctx ==
NULL || ctx->fin_time == 0) {
456 now = k_uptime_get_32();
458 if (now >= ctx->fin_time) {
462 if (now >= ctx->int_time) {
471#if !COAP_USE_PSA_CRYPTO
472#ifndef MBEDTLS_2_X_COMPAT
477coap_rng(
void *ctx
COAP_UNUSED,
unsigned char *buf,
size_t len) {
478 return coap_prng_lkd(buf, len) ? 0 : MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED;
484coap_dgram_read(
void *ctx,
unsigned char *out,
size_t outl) {
489 if (!c_session->
tls) {
491 return MBEDTLS_ERR_SSL_WANT_READ;
493 data = &((coap_mbedtls_env_t *)c_session->
tls)->coap_ssl_data;
496 if (data->pdu_len > 0) {
497 if (outl < data->pdu_len) {
498 memcpy(out, data->pdu, outl);
501 data->pdu_len -= outl;
503 memcpy(out, data->pdu, data->pdu_len);
505 if (!data->peekmode) {
511 ret = MBEDTLS_ERR_SSL_WANT_READ;
525coap_dgram_write(
void *ctx,
const unsigned char *send_buffer,
526 size_t send_buffer_length) {
531 coap_mbedtls_env_t *m_env = (coap_mbedtls_env_t *)c_session->
tls;
535 && c_session->endpoint ==
NULL
543 send_buffer, send_buffer_length);
544 if (result != (ssize_t)send_buffer_length) {
545 int keep_errno = errno;
548 result, send_buffer_length);
551 if (errno == ENOTCONN || errno == ECONNREFUSED)
560 m_env->last_timeout = now;
568#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED) && defined(MBEDTLS_SSL_SRV_C)
573psk_server_callback(
void *p_info, mbedtls_ssl_context *ssl,
574 const unsigned char *identity,
size_t identity_len) {
577 coap_mbedtls_env_t *m_env;
581 if (c_session ==
NULL)
585 lidentity.
s = identity ? (
const uint8_t *)identity : (const uint8_t *)
"";
586 lidentity.
length = identity ? identity_len : 0;
590 (
int)lidentity.
length, (
const char *)lidentity.
s);
592 m_env = (coap_mbedtls_env_t *)c_session->
tls;
593 setup_data = &c_session->
context->spsk_setup_data;
607 mbedtls_ssl_set_hs_psk(ssl, psk_key->
s, psk_key->
length);
608 m_env->seen_client_hello = 1;
614get_san_or_cn_from_cert(
coap_session_t *session, mbedtls_x509_crt *crt,
const char *sni_match) {
616 const mbedtls_asn1_named_data *cn_data;
619 if (crt->ext_types & MBEDTLS_X509_EXT_SUBJECT_ALT_NAME) {
620 mbedtls_asn1_sequence *seq = &crt->subject_alt_names;
622 while (seq->buf.p ==
NULL) {
627 if (strlen(sni_match) != seq->buf.len ||
628 memcmp(seq->buf.p, sni_match, seq->buf.len)) {
634 return mbedtls_strndup((
const char *)seq->buf.p,
640 cn_data = mbedtls_asn1_find_named_data(&crt->subject,
642 MBEDTLS_OID_SIZE(MBEDTLS_OID_AT_CN));
648 (
int)cn_data->val.len, cn_data->val.p);
653 return mbedtls_strndup((
const char *)cn_data->val.p,
660 if (crt->ext_types & MBEDTLS_X509_EXT_SUBJECT_ALT_NAME) {
661 mbedtls_asn1_sequence *seq = &crt->subject_alt_names;
665 while (seq->buf.p ==
NULL) {
671 (
int)seq->buf.len, seq->buf.p);
682#if COAP_MAX_LOGGING_LEVEL > 0
684get_error_string(
int ret) {
685 static char buf[128] = {0};
686 mbedtls_strerror(ret, buf,
sizeof(buf)-1);
692self_signed_cert_verify_callback_mbedtls(
void *data,
697 const coap_mbedtls_context_t *m_context =
701 if (*flags & MBEDTLS_X509_BADCERT_EXPIRED) {
703 *flags &= ~MBEDTLS_X509_BADCERT_EXPIRED;
714cert_verify_callback_mbedtls(
void *data, mbedtls_x509_crt *crt,
715 int depth, uint32_t *flags) {
717 coap_mbedtls_context_t *m_context =
725 cn = get_san_or_cn_from_cert(c_session, crt, setup_data->
client_sni);
729 *flags |= MBEDTLS_X509_BADCERT_CN_MISMATCH;
733 cn = get_san_or_cn_from_cert(c_session, crt,
NULL);
749 *flags |= MBEDTLS_X509_BADCERT_CN_MISMATCH;
754 *flags |= MBEDTLS_X509_BADCERT_OTHER;
757 "The certificate's verify depth is too long",
758 cn ? cn :
"?", depth);
766 if (*flags & MBEDTLS_X509_BADCERT_EXPIRED) {
768 *flags &= ~MBEDTLS_X509_BADCERT_EXPIRED;
771 "The certificate has expired", cn ? cn :
"?", depth);
774 if (*flags & MBEDTLS_X509_BADCERT_FUTURE) {
776 *flags &= ~MBEDTLS_X509_BADCERT_FUTURE;
779 "The certificate has a future date", cn ? cn :
"?", depth);
782 if (*flags & MBEDTLS_X509_BADCERT_BAD_MD) {
784 *flags &= ~MBEDTLS_X509_BADCERT_BAD_MD;
787 "The certificate has a bad MD hash", cn ? cn :
"?", depth);
790 if (*flags & MBEDTLS_X509_BADCERT_BAD_KEY) {
792 *flags &= ~MBEDTLS_X509_BADCERT_BAD_KEY;
795 "The certificate has a short RSA length", cn ? cn :
"?", depth);
798 if (*flags & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
800 *flags &= ~MBEDTLS_X509_BADCERT_CN_MISMATCH;
803 "The SNI does not match the returned CN",
805 cn ? cn :
"?", depth);
808 if (*flags & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
810 int self_signed = !mbedtls_x509_crt_verify(crt, crt,
NULL,
NULL, &lflags,
811 self_signed_cert_verify_callback_mbedtls,
813 if (self_signed && depth == 0) {
816 *flags &= ~MBEDTLS_X509_BADCERT_NOT_TRUSTED;
820 cn ? cn :
"?", depth);
822 }
else if (self_signed) {
824 *flags &= ~MBEDTLS_X509_BADCERT_NOT_TRUSTED;
827 "Self-signed", cn ? cn :
"?", depth);
831 *flags &= ~MBEDTLS_X509_BADCERT_NOT_TRUSTED;
834 "The certificate's CA is not trusted", cn ? cn :
"?", depth);
838 if (*flags & MBEDTLS_X509_BADCRL_EXPIRED) {
840 *flags &= ~MBEDTLS_X509_BADCRL_EXPIRED;
843 "The certificate's CRL has expired", cn ? cn :
"?", depth);
845 *flags &= ~MBEDTLS_X509_BADCRL_EXPIRED;
848 if (*flags & MBEDTLS_X509_BADCRL_FUTURE) {
850 *flags &= ~MBEDTLS_X509_BADCRL_FUTURE;
853 "The certificate's CRL has a future date", cn ? cn :
"?", depth);
855 *flags &= ~MBEDTLS_X509_BADCRL_FUTURE;
862 int ret = mbedtls_x509_crt_verify_info(buf,
sizeof(buf),
"", *flags);
865 tcp = strchr(buf,
'\n');
870 buf, *flags, cn ? cn :
"?", depth);
871 tcp = strchr(tcp+1,
'\n');
874 coap_log_err(
"mbedtls_x509_crt_verify_info returned -0x%x: '%s'\n",
875 -ret, get_error_string(ret));
886setup_pki_credentials(mbedtls_x509_crt *cacert,
887 mbedtls_x509_crt *public_cert,
888 mbedtls_pk_context *private_key,
889 coap_mbedtls_env_t *m_env,
890 coap_mbedtls_context_t *m_context,
896 int done_private_key = 0;
897 int done_public_cert = 0;
915#if defined(MBEDTLS_FS_IO)
916 mbedtls_pk_init(private_key);
917#if COAP_USE_PSA_CRYPTO
918 ret = mbedtls_pk_parse_keyfile(private_key,
920#elif defined(MBEDTLS_2_X_COMPAT)
921 ret = mbedtls_pk_parse_keyfile(private_key,
924 ret = mbedtls_pk_parse_keyfile(private_key,
926 NULL, coap_rng, (
void *)&m_env->ctr_drbg);
933 done_private_key = 1;
941 mbedtls_pk_init(private_key);
945 buffer = mbedtls_malloc(length + 1);
951 buffer[length] =
'\000';
953#if COAP_USE_PSA_CRYPTO
954 ret = mbedtls_pk_parse_key(private_key, buffer, length,
NULL, 0);
955#elif defined(MBEDTLS_2_X_COMPAT)
956 ret = mbedtls_pk_parse_key(private_key, buffer, length,
NULL, 0);
958 ret = mbedtls_pk_parse_key(private_key, buffer, length,
959 NULL, 0, coap_rng, (
void *)&m_env->ctr_drbg);
961 mbedtls_free(buffer);
963#if COAP_USE_PSA_CRYPTO
964 ret = mbedtls_pk_parse_key(private_key,
967#elif defined(MBEDTLS_2_X_COMPAT)
968 ret = mbedtls_pk_parse_key(private_key,
972 ret = mbedtls_pk_parse_key(private_key,
975 NULL, 0, coap_rng, (
void *)&m_env->ctr_drbg);
983 done_private_key = 1;
986 mbedtls_pk_init(private_key);
987#if COAP_USE_PSA_CRYPTO
988 ret = mbedtls_pk_parse_key(private_key,
991#elif defined(MBEDTLS_2_X_COMPAT)
992 ret = mbedtls_pk_parse_key(private_key,
996 ret = mbedtls_pk_parse_key(private_key,
999 (
void *)&m_env->ctr_drbg);
1006 done_private_key = 1;
1034#if defined(MBEDTLS_FS_IO)
1035 mbedtls_x509_crt_init(public_cert);
1036 ret = mbedtls_x509_crt_parse_file(public_cert,
1043 done_public_cert = 1;
1051 mbedtls_x509_crt_init(public_cert);
1056 buffer = mbedtls_malloc(length + 1);
1062 buffer[length] =
'\000';
1064 ret = mbedtls_x509_crt_parse(public_cert, buffer, length);
1065 mbedtls_free(buffer);
1067 ret = mbedtls_x509_crt_parse(public_cert,
1076 done_public_cert = 1;
1083 mbedtls_x509_crt_init(public_cert);
1084 ret = mbedtls_x509_crt_parse(public_cert,
1092 done_public_cert = 1;
1110 if (done_private_key && done_public_cert) {
1111 ret = mbedtls_ssl_conf_own_cert(&m_env->conf, public_cert, private_key);
1113 coap_log_err(
"mbedtls_ssl_conf_own_cert returned -0x%x: '%s'\n",
1114 -ret, get_error_string(ret));
1129#if defined(MBEDTLS_FS_IO)
1130 mbedtls_x509_crt_init(cacert);
1131 ret = mbedtls_x509_crt_parse_file(cacert,
1138 mbedtls_ssl_conf_ca_chain(&m_env->conf, cacert,
NULL);
1146 mbedtls_x509_crt_init(cacert);
1150 buffer = mbedtls_malloc(length + 1);
1156 buffer[length] =
'\000';
1158 ret = mbedtls_x509_crt_parse(cacert, buffer, length);
1159 mbedtls_free(buffer);
1161 ret = mbedtls_x509_crt_parse(cacert,
1170 mbedtls_ssl_conf_ca_chain(&m_env->conf, cacert,
NULL);
1177 mbedtls_x509_crt_init(cacert);
1178 ret = mbedtls_x509_crt_parse(cacert,
1186 mbedtls_ssl_conf_ca_chain(&m_env->conf, cacert,
NULL);
1200#if defined(MBEDTLS_FS_IO)
1201 if (m_context->root_ca_file) {
1202 ret = mbedtls_x509_crt_parse_file(cacert, m_context->root_ca_file);
1209 mbedtls_ssl_conf_ca_chain(&m_env->conf, cacert,
NULL);
1211 if (m_context->root_ca_path) {
1212 ret = mbedtls_x509_crt_parse_path(cacert, m_context->root_ca_path);
1219 mbedtls_ssl_conf_ca_chain(&m_env->conf, cacert,
NULL);
1221#if MBEDTLS_VERSION_NUMBER >= 0x04000000
1222 if (m_context->trust_store_defined)
1224 if (m_context->trust_store_defined ||
1229 const char *trust_list[] = {
1230 "/etc/ssl/ca-bundle.pem",
1231 "/etc/ssl/certs/ca-certificates.crt",
1232 "/etc/pki/tls/cert.pem",
1233 "/usr/local/share/certs/ca-root-nss.crt",
1236 static const char *trust_file_found =
NULL;
1237 static int trust_file_done = 0;
1240 if (trust_file_found) {
1241 ret = mbedtls_x509_crt_parse_file(cacert, trust_file_found);
1243 mbedtls_ssl_conf_ca_chain(&m_env->conf, cacert,
NULL);
1248 }
else if (!trust_file_done) {
1249 trust_file_done = 1;
1250 for (i = 0; i <
sizeof(trust_list)/
sizeof(trust_list[0]); i++) {
1251 ret = mbedtls_x509_crt_parse_file(cacert, trust_list[i]);
1253 mbedtls_ssl_conf_ca_chain(&m_env->conf, cacert,
NULL);
1254 trust_file_found = trust_list[i];
1258 if (i ==
sizeof(trust_list)/
sizeof(trust_list[0])) {
1264 if (m_context->root_ca_file || m_context->root_ca_path ||
1265 m_context->trust_store_defined) {
1273#if defined(MBEDTLS_SSL_SRV_C)
1274 mbedtls_ssl_conf_cert_req_ca_list(&m_env->conf,
1276 MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED :
1277 MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED);
1280 MBEDTLS_SSL_VERIFY_REQUIRED :
1281 MBEDTLS_SSL_VERIFY_NONE);
1286 mbedtls_ssl_conf_verify(&m_env->conf,
1287 cert_verify_callback_mbedtls, c_session);
1292#if defined(MBEDTLS_SSL_SRV_C)
1297pki_sni_callback(
void *p_info, mbedtls_ssl_context *ssl,
1298 const unsigned char *uname,
size_t name_len) {
1302 coap_mbedtls_env_t *m_env = (coap_mbedtls_env_t *)c_session->
tls;
1303 coap_mbedtls_context_t *m_context =
1307 name = mbedtls_malloc(name_len+1);
1311 memcpy(name, uname, name_len);
1312 name[name_len] =
'\000';
1315 for (i = 0; i < m_context->pki_sni_count; i++) {
1316 if (strcasecmp(name, m_context->pki_sni_entry_list[i]->sni) == 0) {
1320 if (i == m_context->pki_sni_count) {
1325 pki_sni_entry **pki_sni_entry_list;
1326 pki_sni_entry *entry;
1329 m_context->setup_data.validate_sni_call_back(name,
1330 m_context->setup_data.sni_call_back_arg));
1336 pki_sni_entry_list = mbedtls_realloc(m_context->pki_sni_entry_list,
1337 (i+1)*
sizeof(pki_sni_entry *));
1339 if (pki_sni_entry_list ==
NULL) {
1343 m_context->pki_sni_entry_list = pki_sni_entry_list;
1344 entry = mbedtls_malloc(
sizeof(pki_sni_entry));
1345 if (entry ==
NULL) {
1349 memset(entry, 0,
sizeof(*entry));
1350 mbedtls_x509_crt_init(&entry->cacert);
1351 mbedtls_x509_crt_init(&entry->public_cert);
1352 mbedtls_pk_init(&entry->private_key);
1353 entry->pki_key = *new_entry;
1354 sni_setup_data = m_context->setup_data;
1355 sni_setup_data.pki_key = *new_entry;
1356 if (setup_pki_credentials(&entry->cacert,
1357 &entry->public_cert,
1358 &entry->private_key,
1363 mbedtls_x509_crt_free(&entry->public_cert);
1364 mbedtls_pk_free(&entry->private_key);
1365 mbedtls_x509_crt_free(&entry->cacert);
1366 mbedtls_free(entry);
1372 m_context->pki_sni_entry_list[i] = entry;
1373 m_context->pki_sni_count++;
1378 mbedtls_ssl_set_hs_ca_chain(ssl, &m_context->pki_sni_entry_list[i]->cacert,
1380 return mbedtls_ssl_set_hs_own_cert(ssl,
1381 &m_context->pki_sni_entry_list[i]->public_cert,
1382 &m_context->pki_sni_entry_list[i]->private_key);
1385#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
1390psk_sni_callback(
void *p_info, mbedtls_ssl_context *ssl,
1391 const unsigned char *uname,
size_t name_len) {
1394 coap_mbedtls_context_t *m_context =
1398 name = mbedtls_malloc(name_len+1);
1402 memcpy(name, uname, name_len);
1403 name[name_len] =
'\000';
1406 for (i = 0; i < m_context->psk_sni_count; i++) {
1407 if (strcasecmp(name, m_context->psk_sni_entry_list[i].sni) == 0) {
1411 if (i == m_context->psk_sni_count) {
1416 psk_sni_entry *psk_sni_entry_list;
1419 c_session->
context->spsk_setup_data.validate_sni_call_back(name,
1421 c_session->
context->spsk_setup_data.sni_call_back_arg));
1427 psk_sni_entry_list = mbedtls_realloc(m_context->psk_sni_entry_list,
1428 (i+1)*
sizeof(psk_sni_entry));
1430 if (psk_sni_entry_list ==
NULL) {
1434 m_context->psk_sni_entry_list = psk_sni_entry_list;
1435 m_context->psk_sni_entry_list[i].sni = name;
1436 m_context->psk_sni_entry_list[i].psk_info = *new_entry;
1438 m_context->psk_sni_count++;
1444 &m_context->psk_sni_entry_list[i].psk_info.hint);
1446 &m_context->psk_sni_entry_list[i].psk_info.key);
1447#if MBEDTLS_VERSION_NUMBER >= 0x04000000
1451 return mbedtls_ssl_set_hs_psk(ssl,
1452 m_context->psk_sni_entry_list[i].psk_info.key.s,
1453 m_context->psk_sni_entry_list[i].psk_info.key.length);
1460 coap_mbedtls_env_t *m_env) {
1461 coap_mbedtls_context_t *m_context =
1464 m_context->psk_pki_enabled |= IS_SERVER;
1466 if ((ret = mbedtls_ssl_config_defaults(&m_env->conf,
1467 MBEDTLS_SSL_IS_SERVER,
1469 MBEDTLS_SSL_TRANSPORT_DATAGRAM :
1470 MBEDTLS_SSL_TRANSPORT_STREAM,
1471 MBEDTLS_SSL_PRESET_DEFAULT)) != 0) {
1472 coap_log_err(
"mbedtls_ssl_config_defaults returned -0x%x: '%s'\n",
1473 -ret, get_error_string(ret));
1477#if !COAP_USE_PSA_CRYPTO
1478 mbedtls_ssl_conf_rng(&m_env->conf, mbedtls_ctr_drbg_random, &m_env->ctr_drbg);
1481#if defined(MBEDTLS_SSL_PROTO_DTLS)
1486 if (m_context->psk_pki_enabled & IS_PSK) {
1487#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
1488 mbedtls_ssl_conf_psk_cb(&m_env->conf, psk_server_callback, c_session);
1489 if (c_session->
context->spsk_setup_data.validate_sni_call_back) {
1490 mbedtls_ssl_conf_sni(&m_env->conf, psk_sni_callback, c_session);
1492#ifdef MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1493 m_env->ec_jpake = c_session->
context->spsk_setup_data.ec_jpake;
1500 if (m_context->psk_pki_enabled & IS_PKI) {
1501 ret = setup_pki_credentials(&m_env->cacert, &m_env->public_cert,
1502 &m_env->private_key, m_env, m_context,
1503 c_session, &m_context->setup_data,
1509 if (m_context->setup_data.validate_sni_call_back) {
1510 mbedtls_ssl_conf_sni(&m_env->conf, pki_sni_callback, c_session);
1514#if COAP_USE_PSA_CRYPTO
1515 if ((ret = mbedtls_ssl_cookie_setup(&m_env->cookie_ctx)) != 0) {
1517 if ((ret = mbedtls_ssl_cookie_setup(&m_env->cookie_ctx,
1518 mbedtls_ctr_drbg_random,
1519 &m_env->ctr_drbg)) != 0) {
1521 coap_log_err(
"mbedtls_ssl_cookie_setup: returned -0x%x: '%s'\n",
1522 -ret, get_error_string(ret));
1526#if defined(MBEDTLS_SSL_PROTO_DTLS)
1527 mbedtls_ssl_conf_dtls_cookies(&m_env->conf, mbedtls_ssl_cookie_write,
1528 mbedtls_ssl_cookie_check,
1529 &m_env->cookie_ctx);
1530#if MBEDTLS_VERSION_NUMBER >= 0x02100100
1531 mbedtls_ssl_set_mtu(&m_env->ssl, (uint16_t)c_session->
mtu);
1534#ifdef MBEDTLS_SSL_DTLS_CONNECTION_ID
1549#if COAP_CLIENT_SUPPORT
1550static int *psk_ciphers =
NULL;
1551static int *pki_ciphers =
NULL;
1552static int *ecjpake_ciphers =
NULL;
1553static int processed_ciphers = 0;
1555#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
1557coap_ssl_ciphersuite_uses_psk(
const mbedtls_ssl_ciphersuite_t *info) {
1558#if COAP_USE_PSA_CRYPTO
1559 switch (info->key_exchange) {
1560 case MBEDTLS_KEY_EXCHANGE_PSK:
1561 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
1563 case MBEDTLS_KEY_EXCHANGE_NONE:
1564 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
1565 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
1566 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
1570#elif MBEDTLS_VERSION_NUMBER >= 0x03060000
1571 switch (info->key_exchange) {
1572 case MBEDTLS_KEY_EXCHANGE_PSK:
1573 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
1574 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
1575 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
1577 case MBEDTLS_KEY_EXCHANGE_NONE:
1578 case MBEDTLS_KEY_EXCHANGE_RSA:
1579 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
1580 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
1581 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
1582 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
1583 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
1584 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
1589 return mbedtls_ssl_ciphersuite_uses_psk(info);
1595#define COAP_CIPHER_IN_PSK 0x01
1596#define COAP_CIPHER_IN_PKI 0x02
1597#define COAP_CIPHER_IN_ECJPAKE 0x04
1605coap_ciphersuite_lists(
int id) {
1606 const mbedtls_ssl_ciphersuite_t *cur = mbedtls_ssl_ciphersuite_from_id(
id);
1610#if MBEDTLS_VERSION_NUMBER >= 0x03020000
1611 if (cur->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2) {
1616 if (cur->max_minor_ver < MBEDTLS_SSL_MINOR_VERSION_3) {
1621#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
1622 if (cur->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE)
1623 return COAP_CIPHER_IN_ECJPAKE;
1625#if MBEDTLS_VERSION_NUMBER >= 0x03060000
1626 if (cur->min_tls_version >= MBEDTLS_SSL_VERSION_TLS1_3)
1627 return COAP_CIPHER_IN_PSK | COAP_CIPHER_IN_PKI;
1629#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
1630 if (coap_ssl_ciphersuite_uses_psk(cur))
1631 return COAP_CIPHER_IN_PSK;
1633 return COAP_CIPHER_IN_PKI;
1637set_ciphersuites(mbedtls_ssl_config *conf, coap_enc_method_t method) {
1638 if (!processed_ciphers) {
1639 const int *base = mbedtls_ssl_list_ciphersuites();
1646 int ecjpake_count = 1;
1648 for (list = base; *list; list++) {
1649 int in = coap_ciphersuite_lists(*list);
1651 if (in & COAP_CIPHER_IN_PSK)
1653 if (in & COAP_CIPHER_IN_PKI)
1655 if (in & COAP_CIPHER_IN_ECJPAKE)
1659 psk_ciphers = mbedtls_malloc(psk_count *
sizeof(psk_ciphers[0]));
1660 pki_ciphers = mbedtls_malloc(pki_count *
sizeof(pki_ciphers[0]));
1661 ecjpake_ciphers = mbedtls_malloc(ecjpake_count *
sizeof(ecjpake_ciphers[0]));
1662 if (psk_ciphers ==
NULL || pki_ciphers ==
NULL || ecjpake_ciphers ==
NULL) {
1664 mbedtls_free(psk_ciphers);
1665 mbedtls_free(pki_ciphers);
1666 mbedtls_free(ecjpake_ciphers);
1669 ecjpake_ciphers =
NULL;
1673 psk_list = psk_ciphers;
1674 pki_list = pki_ciphers;
1675 ecjpake_list = ecjpake_ciphers;
1677 for (list = base; *list; list++) {
1678 int in = coap_ciphersuite_lists(*list);
1680 if (in & COAP_CIPHER_IN_PSK)
1681 *psk_list++ = *list;
1682 if (in & COAP_CIPHER_IN_PKI)
1683 *pki_list++ = *list;
1684 if (in & COAP_CIPHER_IN_ECJPAKE)
1685 *ecjpake_list++ = *list;
1691 processed_ciphers = 1;
1695 mbedtls_ssl_conf_ciphersuites(conf, psk_ciphers);
1698 mbedtls_ssl_conf_ciphersuites(conf, pki_ciphers);
1700 case COAP_ENC_ECJPAKE:
1701 mbedtls_ssl_conf_ciphersuites(conf, ecjpake_ciphers);
1711 coap_mbedtls_env_t *m_env) {
1714 coap_mbedtls_context_t *m_context =
1717 m_context->psk_pki_enabled |= IS_CLIENT;
1719 if ((ret = mbedtls_ssl_config_defaults(&m_env->conf,
1720 MBEDTLS_SSL_IS_CLIENT,
1722 MBEDTLS_SSL_TRANSPORT_DATAGRAM :
1723 MBEDTLS_SSL_TRANSPORT_STREAM,
1724 MBEDTLS_SSL_PRESET_DEFAULT)) != 0) {
1725 coap_log_err(
"mbedtls_ssl_config_defaults returned -0x%x: '%s'\n",
1726 -ret, get_error_string(ret));
1730#if defined(MBEDTLS_SSL_PROTO_DTLS)
1735 mbedtls_ssl_conf_authmode(&m_env->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
1736#if !COAP_USE_PSA_CRYPTO
1737 mbedtls_ssl_conf_rng(&m_env->conf, mbedtls_ctr_drbg_random, &m_env->ctr_drbg);
1740 if (m_context->psk_pki_enabled & IS_PSK) {
1741#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
1749 if (psk_key ==
NULL || psk_identity ==
NULL) {
1750 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
1754 if ((ret = mbedtls_ssl_conf_psk(&m_env->conf, psk_key->
s,
1755 psk_key->
length, psk_identity->
s,
1756 psk_identity->
length)) != 0) {
1757 coap_log_err(
"mbedtls_ssl_conf_psk returned -0x%x: '%s'\n",
1758 -ret, get_error_string(ret));
1762 if ((ret = mbedtls_ssl_set_hostname(&m_env->ssl,
1764 coap_log_err(
"mbedtls_ssl_set_hostname returned -0x%x: '%s'\n",
1765 -ret, get_error_string(ret));
1771#ifdef MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1773 m_env->ec_jpake = 1;
1774 set_ciphersuites(&m_env->conf, COAP_ENC_ECJPAKE);
1775#if MBEDTLS_VERSION_NUMBER >= 0x03020000
1776 mbedtls_ssl_conf_max_tls_version(&m_env->conf, MBEDTLS_SSL_VERSION_TLS1_2);
1779 set_ciphersuites(&m_env->conf, COAP_ENC_PSK);
1782 set_ciphersuites(&m_env->conf, COAP_ENC_PSK);
1787 }
else if ((m_context->psk_pki_enabled & IS_PKI) ||
1788 (m_context->psk_pki_enabled & (IS_PSK | IS_PKI)) == 0) {
1795 if (!(m_context->psk_pki_enabled & IS_PKI)) {
1809 mbedtls_ssl_conf_authmode(&m_env->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
1810 ret = setup_pki_credentials(&m_env->cacert, &m_env->public_cert,
1811 &m_env->private_key, m_env, m_context,
1812 c_session, setup_data,
1818#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN)
1821 static const char *alpn_list[] = {
"coap",
NULL };
1823 ret = mbedtls_ssl_conf_alpn_protocols(&m_env->conf, alpn_list);
1829 mbedtls_ssl_set_hostname(&m_env->ssl, m_context->setup_data.client_sni);
1830#if defined(MBEDTLS_SSL_PROTO_DTLS)
1831#if MBEDTLS_VERSION_NUMBER >= 0x02100100
1832 mbedtls_ssl_set_mtu(&m_env->ssl, (uint16_t)c_session->
mtu);
1835 set_ciphersuites(&m_env->conf, COAP_ENC_PKI);
1845mbedtls_cleanup(coap_mbedtls_env_t *m_env) {
1850 mbedtls_x509_crt_free(&m_env->cacert);
1851 mbedtls_x509_crt_free(&m_env->public_cert);
1852 mbedtls_pk_free(&m_env->private_key);
1853#if !COAP_USE_PSA_CRYPTO
1854 mbedtls_entropy_free(&m_env->entropy);
1855 mbedtls_ctr_drbg_free(&m_env->ctr_drbg);
1857 mbedtls_ssl_config_free(&m_env->conf);
1858 mbedtls_ssl_free(&m_env->ssl);
1859 mbedtls_ssl_cookie_free(&m_env->cookie_ctx);
1863coap_dtls_free_mbedtls_env(coap_mbedtls_env_t *m_env) {
1865 if (!m_env->sent_alert)
1866 mbedtls_ssl_close_notify(&m_env->ssl);
1867 mbedtls_cleanup(m_env);
1868 mbedtls_free(m_env);
1872#if COAP_MAX_LOGGING_LEVEL > 0
1874report_mbedtls_alert(
unsigned char alert) {
1876 case MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC:
1877 return ": Bad Record MAC";
1878 case MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE:
1879 return ": Handshake failure";
1880 case MBEDTLS_SSL_ALERT_MSG_NO_CERT:
1881 return ": No Certificate provided";
1882 case MBEDTLS_SSL_ALERT_MSG_BAD_CERT:
1883 return ": Certificate is bad";
1884 case MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN:
1885 return ": Certificate is unknown";
1886 case MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA:
1887 return ": CA is unknown";
1888 case MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED:
1889 return ": Access was denied";
1890 case MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR:
1891 return ": Decrypt error";
1905 coap_mbedtls_env_t *m_env) {
1909 ret = mbedtls_ssl_handshake(&m_env->ssl);
1912 m_env->established = 1;
1916#ifdef MBEDTLS_SSL_DTLS_CONNECTION_ID
1917#if COAP_CLIENT_SUPPORT
1920 coap_mbedtls_context_t *m_context;
1924 m_context->setup_data.use_cid) {
1925 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX];
1927 size_t peer_cid_len;
1930 if (mbedtls_ssl_get_peer_cid(&m_env->ssl, &enabled, peer_cid, &peer_cid_len) == 0 &&
1931 enabled == MBEDTLS_SSL_CID_ENABLED) {
1932 c_session->negotiated_cid = 1;
1935 c_session->negotiated_cid = 0;
1944 case MBEDTLS_ERR_SSL_WANT_READ:
1945 case MBEDTLS_ERR_SSL_WANT_WRITE:
1946 if (m_env->ssl.state == MBEDTLS_SSL_SERVER_HELLO
1947#
if MBEDTLS_VERSION_NUMBER >= 0x03030000
1948 || m_env->ssl.state == MBEDTLS_SSL_NEW_SESSION_TICKET
1951 if (++m_env->server_hello_cnt > 10) {
1959 case MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED:
1962 case MBEDTLS_ERR_SSL_INVALID_MAC:
1964#ifdef MBEDTLS_2_X_COMPAT
1965 case MBEDTLS_ERR_SSL_UNKNOWN_CIPHER:
1967 case MBEDTLS_ERR_SSL_DECODE_ERROR:
1970 case MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE:
1971 alert = MBEDTLS_SSL_ALERT_MSG_NO_CERT;
1973#ifdef MBEDTLS_2_X_COMPAT
1974 case MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO:
1975 case MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO:
1976 alert = MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE;
1979 case MBEDTLS_ERR_X509_CERT_VERIFY_FAILED:
1981 case MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE:
1982 if (m_env->ssl.in_msg[1] != MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY)
1985 report_mbedtls_alert(m_env->ssl.in_msg[1]));
1987 case MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY:
1988 case MBEDTLS_ERR_SSL_CONN_EOF:
1989 case MBEDTLS_ERR_NET_CONN_RESET:
1995 "returned -0x%x: '%s'\n",
1996 -ret, get_error_string(ret));
2003 mbedtls_ssl_send_alert_message(&m_env->ssl,
2004 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
2006 m_env->sent_alert = 1;
2011 get_error_string(ret));
2013 mbedtls_ssl_session_reset(&m_env->ssl);
2014#ifdef MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2015 if (m_env->ec_jpake) {
2018#if COAP_CLIENT_SUPPORT && COAP_SERVER_SUPPORT
2024#elif COAP_CLIENT_SUPPORT
2030 mbedtls_ssl_set_hs_ecjpake_password(&m_env->ssl, psk_key->
s, psk_key->
length);
2038mbedtls_debug_out(
void *ctx
COAP_UNUSED,
int level,
2071#if !COAP_DISABLE_TCP
2079coap_sock_read(
void *ctx,
unsigned char *out,
size_t outl) {
2080 int ret = MBEDTLS_ERR_SSL_CONN_EOF;
2087 if (errno == ECONNRESET) {
2089 ret = MBEDTLS_ERR_SSL_CONN_EOF;
2091 ret = MBEDTLS_ERR_NET_RECV_FAILED;
2093 }
else if (ret == 0) {
2095 ret = MBEDTLS_ERR_SSL_WANT_READ;
2108coap_sock_write(
void *context,
const unsigned char *in,
size_t inl) {
2113 (
const uint8_t *)in,
2119 (errno == EPIPE || errno == ECONNRESET)) {
2134 int lasterror = WSAGetLastError();
2136 if (lasterror == WSAEWOULDBLOCK) {
2137 ret = MBEDTLS_ERR_SSL_WANT_WRITE;
2138 }
else if (lasterror == WSAECONNRESET) {
2139 ret = MBEDTLS_ERR_NET_CONN_RESET;
2142 if (errno == EAGAIN || errno == EINTR) {
2143 ret = MBEDTLS_ERR_SSL_WANT_WRITE;
2144 }
else if (errno == EPIPE || errno == ECONNRESET) {
2145 ret = MBEDTLS_ERR_NET_CONN_RESET;
2149 ret = MBEDTLS_ERR_NET_SEND_FAILED;
2158 ret = MBEDTLS_ERR_SSL_WANT_WRITE;
2164static coap_mbedtls_env_t *
2168#if !COAP_USE_PSA_CRYPTO
2171 coap_mbedtls_env_t *m_env = (coap_mbedtls_env_t *)c_session->
tls;
2176 m_env = (coap_mbedtls_env_t *)mbedtls_malloc(
sizeof(coap_mbedtls_env_t));
2180 memset(m_env, 0,
sizeof(coap_mbedtls_env_t));
2182 mbedtls_ssl_init(&m_env->ssl);
2183#if !COAP_USE_PSA_CRYPTO
2184 mbedtls_ctr_drbg_init(&m_env->ctr_drbg);
2185 mbedtls_entropy_init(&m_env->entropy);
2187 mbedtls_ssl_config_init(&m_env->conf);
2188 mbedtls_ssl_cookie_init(&m_env->cookie_ctx);
2190#if defined(ESPIDF_VERSION) && defined(CONFIG_MBEDTLS_DEBUG)
2191 mbedtls_esp_enable_debug_log(&m_env->conf, CONFIG_MBEDTLS_DEBUG_LEVEL);
2194#if !COAP_USE_PSA_CRYPTO
2195 if ((ret = mbedtls_ctr_drbg_seed(&m_env->ctr_drbg,
2196 mbedtls_entropy_func, &m_env->entropy,
NULL, 0)) != 0) {
2197 if (ret != MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED) {
2198 coap_log_info(
"mbedtls_ctr_drbg_seed returned -0x%x: '%s'\n",
2199 -ret, get_error_string(ret));
2202 coap_log_err(
"mbedtls_ctr_drbg_seed returned -0x%x: '%s'\n",
2203 -ret, get_error_string(ret));
2208#if COAP_CLIENT_SUPPORT
2209 if (setup_client_ssl_session(c_session, m_env) != 0) {
2216#if defined(MBEDTLS_SSL_SRV_C)
2217 if (setup_server_ssl_session(c_session, m_env) != 0) {
2227#if MBEDTLS_VERSION_NUMBER >= 0x03020000
2228 mbedtls_ssl_conf_min_tls_version(&m_env->conf, MBEDTLS_SSL_VERSION_TLS1_2);
2230 mbedtls_ssl_conf_min_version(&m_env->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
2231 MBEDTLS_SSL_MINOR_VERSION_3);
2234 if (mbedtls_ssl_setup(&m_env->ssl, &m_env->conf) != 0) {
2238 mbedtls_ssl_set_bio(&m_env->ssl, c_session, coap_dgram_write,
2239 coap_dgram_read,
NULL);
2240#ifdef MBEDTLS_SSL_DTLS_CONNECTION_ID
2243#if COAP_CLIENT_SUPPORT
2244 coap_mbedtls_context_t *m_context =
2248 m_context->setup_data.use_cid) {
2256 mbedtls_ssl_set_cid(&m_env->ssl, MBEDTLS_SSL_CID_ENABLED,
NULL, 0);
2260#if COAP_SERVER_SUPPORT
2270 mbedtls_ssl_set_cid(&m_env->ssl, MBEDTLS_SSL_CID_ENABLED, cid,
2278#if !COAP_DISABLE_TCP
2281 mbedtls_ssl_set_bio(&m_env->ssl, c_session, coap_sock_write,
2282 coap_sock_read,
NULL);
2285#ifdef MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2286 coap_mbedtls_context_t *m_context =
2288 if ((m_context->psk_pki_enabled & IS_PSK) &&
2292#if COAP_CLIENT_SUPPORT && COAP_SERVER_SUPPORT
2298#elif COAP_CLIENT_SUPPORT
2303 mbedtls_ssl_set_hs_ecjpake_password(&m_env->ssl, psk_key->
s, psk_key->
length);
2307 mbedtls_ssl_set_timer_cb(&m_env->ssl, &m_env->timer,
2308 zephyr_timing_set_delay,
2309 zephyr_timing_get_delay);
2311 mbedtls_ssl_set_timer_cb(&m_env->ssl, &m_env->timer,
2312 mbedtls_timing_set_delay,
2313 mbedtls_timing_get_delay);
2316 mbedtls_ssl_conf_dbg(&m_env->conf, mbedtls_debug_out, stdout);
2321 mbedtls_cleanup(m_env);
2322 mbedtls_free(m_env);
2329#if defined(MBEDTLS_SSL_PROTO_DTLS)
2332 static int reported = 0;
2336 " - update Mbed TLS to include DTLS\n");
2344#if !COAP_DISABLE_TCP
2393#ifdef MBEDTLS_SSL_DTLS_CONNECTION_ID
2400#if COAP_CLIENT_SUPPORT
2403#ifdef MBEDTLS_SSL_DTLS_CONNECTION_ID
2404 c_context->testing_cids = every;
2416 coap_mbedtls_context_t *m_context;
2419 m_context = (coap_mbedtls_context_t *)mbedtls_malloc(
sizeof(coap_mbedtls_context_t));
2421 memset(m_context, 0,
sizeof(coap_mbedtls_context_t));
2426#if COAP_SERVER_SUPPORT
2435 coap_mbedtls_context_t *m_context =
2438#if !defined(MBEDTLS_SSL_SRV_C)
2440 " libcoap not compiled for Server Mode for Mbed TLS"
2441 " - update Mbed TLS to include Server Mode\n");
2444 if (!m_context || !setup_data)
2448#ifndef MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2449 coap_log_warn(
"Mbed TLS not compiled for EC-JPAKE support\n");
2453 coap_log_warn(
"CoAP Server with Mbed TLS does not support Identity Hint\n");
2455 m_context->psk_pki_enabled |= IS_PSK;
2460#if COAP_CLIENT_SUPPORT
2469#if !defined(MBEDTLS_SSL_CLI_C)
2474 " libcoap not compiled for Client Mode for Mbed TLS"
2475 " - update Mbed TLS to include Client Mode\n");
2478 coap_mbedtls_context_t *m_context =
2481 if (!m_context || !setup_data)
2485 coap_log_warn(
"CoAP Client with Mbed TLS does not support Identity Hint selection\n");
2488#ifndef MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2489 coap_log_warn(
"Mbed TLS not compiled for EC-JPAKE support\n");
2493#ifndef MBEDTLS_SSL_DTLS_CONNECTION_ID
2494 coap_log_warn(
"Mbed TLS not compiled for Connection-ID support\n");
2497 m_context->psk_pki_enabled |= IS_PSK;
2507 coap_mbedtls_context_t *m_context =
2510 m_context->setup_data = *setup_data;
2511 if (!m_context->setup_data.verify_peer_cert) {
2513 m_context->setup_data.check_common_ca = 0;
2515 m_context->setup_data.allow_self_signed = 1;
2516 m_context->setup_data.allow_expired_certs = 1;
2517 m_context->setup_data.cert_chain_validation = 1;
2518 m_context->setup_data.cert_chain_verify_depth = 10;
2519 m_context->setup_data.check_cert_revocation = 1;
2520 m_context->setup_data.allow_no_crl = 1;
2521 m_context->setup_data.allow_expired_crl = 1;
2522 m_context->setup_data.allow_bad_md_hash = 1;
2523 m_context->setup_data.allow_short_rsa_length = 1;
2525 m_context->psk_pki_enabled |= IS_PKI;
2527#ifndef MBEDTLS_SSL_DTLS_CONNECTION_ID
2528 coap_log_warn(
"Mbed TLS not compiled for Connection-ID support\n");
2536 const char *ca_file,
2537 const char *ca_path) {
2538 coap_mbedtls_context_t *m_context =
2542 coap_log_warn(
"coap_context_set_pki_root_cas: (D)TLS environment "
2547 if (ca_file ==
NULL && ca_path ==
NULL) {
2548 coap_log_warn(
"coap_context_set_pki_root_cas: ca_file and/or ca_path "
2552 if (m_context->root_ca_file) {
2553 mbedtls_free(m_context->root_ca_file);
2554 m_context->root_ca_file =
NULL;
2558 m_context->root_ca_file = mbedtls_strdup(ca_file);
2561 if (m_context->root_ca_path) {
2562 mbedtls_free(m_context->root_ca_path);
2563 m_context->root_ca_path =
NULL;
2567 m_context->root_ca_path = mbedtls_strdup(ca_path);
2578 coap_mbedtls_context_t *m_context =
2582 coap_log_warn(
"coap_context_load_pki_trust_store: (D)TLS environment "
2586 m_context->trust_store_defined = 1;
2595 coap_mbedtls_context_t *m_context =
2597 return m_context->psk_pki_enabled ? 1 : 0;
2602 coap_mbedtls_context_t *m_context = (coap_mbedtls_context_t *)dtls_context;
2605 for (i = 0; i < m_context->pki_sni_count; i++) {
2606 mbedtls_free(m_context->pki_sni_entry_list[i]->sni);
2608 mbedtls_x509_crt_free(&m_context->pki_sni_entry_list[i]->public_cert);
2610 mbedtls_pk_free(&m_context->pki_sni_entry_list[i]->private_key);
2612 mbedtls_x509_crt_free(&m_context->pki_sni_entry_list[i]->cacert);
2614 mbedtls_free(m_context->pki_sni_entry_list[i]);
2616 if (m_context->pki_sni_entry_list)
2617 mbedtls_free(m_context->pki_sni_entry_list);
2619 for (i = 0; i < m_context->psk_sni_count; i++) {
2620 mbedtls_free(m_context->psk_sni_entry_list[i].sni);
2622 if (m_context->psk_sni_entry_list)
2623 mbedtls_free(m_context->psk_sni_entry_list);
2625 if (m_context->root_ca_path)
2626 mbedtls_free(m_context->root_ca_path);
2627 if (m_context->root_ca_file)
2628 mbedtls_free(m_context->root_ca_file);
2630 mbedtls_free(m_context);
2633#if COAP_CLIENT_SUPPORT
2636#if !defined(MBEDTLS_SSL_CLI_C)
2639 " libcoap not compiled for Client Mode for Mbed TLS"
2640 " - update Mbed TLS to include Client Mode\n");
2643 coap_mbedtls_env_t *m_env = coap_dtls_new_mbedtls_env(c_session,
2652 m_env->last_timeout = now;
2653 ret = do_mbedtls_handshake(c_session, m_env);
2655 coap_dtls_free_mbedtls_env(m_env);
2664#if COAP_SERVER_SUPPORT
2667#if !defined(MBEDTLS_SSL_SRV_C)
2670 " libcoap not compiled for Server Mode for Mbed TLS"
2671 " - update Mbed TLS to include Server Mode\n");
2674 coap_mbedtls_env_t *m_env =
2675 (coap_mbedtls_env_t *)c_session->
tls;
2677#if defined(MBEDTLS_SSL_PROTO_DTLS)
2678#if MBEDTLS_VERSION_NUMBER >= 0x02100100
2679 mbedtls_ssl_set_mtu(&m_env->ssl, (uint16_t)c_session->
mtu);
2690 if (c_session && c_session->
context && c_session->
tls) {
2691 coap_dtls_free_mbedtls_env(c_session->
tls);
2700#if defined(MBEDTLS_SSL_PROTO_DTLS)
2701 coap_mbedtls_env_t *m_env =
2702 (coap_mbedtls_env_t *)c_session->
tls;
2704#if MBEDTLS_VERSION_NUMBER >= 0x02100100
2705 mbedtls_ssl_set_mtu(&m_env->ssl, (uint16_t)c_session->
mtu);
2715 const uint8_t *data,
size_t data_len) {
2717 coap_mbedtls_env_t *m_env = (coap_mbedtls_env_t *)c_session->
tls;
2726 if (m_env->established) {
2727 ret = mbedtls_ssl_write(&m_env->ssl, (
const unsigned char *) data, data_len);
2730 case MBEDTLS_ERR_SSL_WANT_READ:
2731 case MBEDTLS_ERR_SSL_WANT_WRITE:
2734 case MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE:
2740 "returned -0x%x: '%s'\n",
2741 -ret, get_error_string(ret));
2750 ret = do_mbedtls_handshake(c_session, m_env);
2780 coap_mbedtls_env_t *m_env = (coap_mbedtls_env_t *)c_session->
tls;
2782 int ret = zephyr_timing_get_delay(&m_env->timer);
2784 int ret = mbedtls_timing_get_delay(&m_env->timer);
2786 unsigned int scalar = 1 << m_env->retry_scalar;
2796 m_env->last_timeout = now;
2809 m_env->last_timeout = now;
2827 coap_mbedtls_env_t *m_env = (coap_mbedtls_env_t *)c_session->
tls;
2829 if (m_env ==
NULL) {
2834 m_env->retry_scalar++;
2836 (do_mbedtls_handshake(c_session, m_env) < 0)) {
2845coap_dtls_receive_done(coap_ssl_t *ssl_data,
int ret) {
2846 if (ssl_data->pdu_len) {
2848 coap_log_debug(
"coap_dtls_receive: ret %d: remaining data %u\n", ret, ssl_data->pdu_len);
2849 ssl_data->pdu_len = 0;
2850 ssl_data->pdu =
NULL;
2861 const uint8_t *data,
2866 coap_mbedtls_env_t *m_env = (coap_mbedtls_env_t *)c_session->
tls;
2867 coap_ssl_t *ssl_data;
2869 if (m_env ==
NULL) {
2874 ssl_data = &m_env->coap_ssl_data;
2875 if (ssl_data->pdu_len) {
2876 coap_log_err(
"** %s: Previous data not read %u bytes\n",
2879 ssl_data->pdu = data;
2880 ssl_data->pdu_len = (unsigned)data_len;
2882 if (m_env->established) {
2883#if COAP_CONSTRAINED_STACK
2890 ret = mbedtls_ssl_read(&m_env->ssl, pdu,
sizeof(pdu));
2894 coap_dtls_receive_done(ssl_data, ret);
2900 case MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY:
2901 case MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE:
2904 case MBEDTLS_ERR_SSL_WANT_READ:
2908 "returned -0x%x: '%s' (length %" PRIdS ")\n",
2909 -ret, get_error_string(ret), data_len);
2914 ret = do_mbedtls_handshake(c_session, m_env);
2919 if (ssl_data->pdu_len) {
2921 ret = do_mbedtls_handshake(c_session, m_env);
2940 coap_dtls_receive_done(ssl_data, ret);
2944#if COAP_SERVER_SUPPORT
2952 const uint8_t *data,
2954#if !defined(MBEDTLS_SSL_PROTO_DTLS) || !defined(MBEDTLS_SSL_SRV_C)
2959 " libcoap not compiled for DTLS or Server Mode for Mbed TLS"
2960 " - update Mbed TLS to include DTLS and Server Mode\n");
2963 coap_mbedtls_env_t *m_env = (coap_mbedtls_env_t *)c_session->
tls;
2964 coap_ssl_t *ssl_data;
2971 c_session->
tls = m_env;
2978 if ((ret = mbedtls_ssl_set_client_transport_id(&m_env->ssl,
2981 coap_log_err(
"mbedtls_ssl_set_client_transport_id() returned -0x%x: '%s'\n",
2982 -ret, get_error_string(ret));
2986 ssl_data = &m_env->coap_ssl_data;
2987 if (ssl_data->pdu_len) {
2988 coap_log_err(
"** %s: Previous data not read %u bytes\n",
2991 ssl_data->pdu = data;
2992 ssl_data->pdu_len = (unsigned)data_len;
2994 ret = do_mbedtls_handshake(c_session, m_env);
2995 if (ret == 0 || m_env->seen_client_hello) {
3001 m_env->seen_client_hello = 0;
3007 if (ssl_data->pdu_len) {
3009 coap_log_debug(
"coap_dtls_hello: ret %d: remaining data %u\n", ret, ssl_data->pdu_len);
3010 ssl_data->pdu_len = 0;
3011 ssl_data->pdu =
NULL;
3020 coap_mbedtls_env_t *m_env = (coap_mbedtls_env_t *)c_session->
tls;
3021 int expansion = mbedtls_ssl_get_record_expansion(&m_env->ssl);
3023 if (expansion == MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE) {
3029#if !COAP_DISABLE_TCP
3030#if COAP_CLIENT_SUPPORT
3033#if !defined(MBEDTLS_SSL_CLI_C)
3037 " libcoap not compiled for Client Mode for Mbed TLS"
3038 " - update Mbed TLS to include Client Mode\n");
3041 coap_mbedtls_env_t *m_env = coap_dtls_new_mbedtls_env(c_session,
3050 m_env->last_timeout = now;
3051 c_session->
tls = m_env;
3052 do_mbedtls_handshake(c_session, m_env);
3058#if COAP_SERVER_SUPPORT
3061#if !defined(MBEDTLS_SSL_SRV_C)
3066 " libcoap not compiled for Server Mode for Mbed TLS"
3067 " - update Mbed TLS to include Server Mode\n");
3070 coap_mbedtls_env_t *m_env = coap_dtls_new_mbedtls_env(c_session,
3077 c_session->
tls = m_env;
3078 do_mbedtls_handshake(c_session, m_env);
3099 coap_mbedtls_env_t *m_env = (coap_mbedtls_env_t *)c_session->
tls;
3100 size_t amount_sent = 0;
3107 if (m_env->established) {
3108 while (amount_sent < data_len) {
3109 ret = mbedtls_ssl_write(&m_env->ssl, &data[amount_sent],
3110 data_len - amount_sent);
3113 case MBEDTLS_ERR_SSL_WANT_READ:
3114 case MBEDTLS_ERR_SSL_WANT_WRITE:
3121 case MBEDTLS_ERR_NET_CONN_RESET:
3122 case MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE:
3127 "returned -0x%x: '%s'\n",
3128 -ret, get_error_string(ret));
3139 ret = (int)amount_sent;
3142 ret = do_mbedtls_handshake(c_session, m_env);
3156 if (ret == (ssize_t)data_len)
3175 coap_mbedtls_env_t *m_env = (coap_mbedtls_env_t *)c_session->
tls;
3184 if (!m_env->established && !m_env->sent_alert) {
3185 ret = do_mbedtls_handshake(c_session, m_env);
3189 ret = mbedtls_ssl_read(&m_env->ssl, data, data_len);
3193 case MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY:
3197 case MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE:
3199 m_env->sent_alert = 1;
3202#if MBEDTLS_VERSION_NUMBER >= 0x03060000
3203 case MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET:
3205 case MBEDTLS_ERR_SSL_WANT_READ:
3211 "returned -0x%x: '%s' (length %" PRIdS ")\n",
3212 -ret, get_error_string(ret), data_len);
3216 }
else if (ret < (
int)data_len) {
3239#if COAP_USE_PSA_CRYPTO || defined(MBEDTLS_PSA_CRYPTO_C)
3246#if COAP_CLIENT_SUPPORT
3247 mbedtls_free(psk_ciphers);
3248 mbedtls_free(pki_ciphers);
3249 mbedtls_free(ecjpake_ciphers);
3252 ecjpake_ciphers =
NULL;
3253 processed_ciphers = 0;
3256#if COAP_USE_PSA_CRYPTO || defined(MBEDTLS_PSA_CRYPTO_C)
3257 mbedtls_psa_crypto_free();
3267 if (c_session && c_session->
tls) {
3268 coap_mbedtls_env_t *m_env;
3271 memcpy(&m_env, &c_session->
tls,
sizeof(m_env));
3273 return (
void *)&m_env->ssl;
3282#if !defined(ESPIDF_VERSION)
3292 switch ((
int)level) {
3313 mbedtls_debug_set_threshold(use_level);
3315 keep_log_level = level;
3320 return keep_log_level;
3325#if COAP_WITH_LIBMBEDTLS || COAP_WITH_LIBMBEDTLS_OSCORE
3327#if COAP_SERVER_SUPPORT
3329coap_digest_setup(
void) {
3330 coap_crypto_sha256_ctx_t *digest_ctx = mbedtls_malloc(
sizeof(coap_crypto_sha256_ctx_t));
3333 if (coap_crypto_sha256_init(digest_ctx) != 0) {
3334 coap_digest_free(digest_ctx);
3342coap_digest_free(coap_digest_ctx_t *digest_ctx) {
3344 coap_crypto_sha256_free(digest_ctx);
3345 mbedtls_free(digest_ctx);
3350coap_digest_update(coap_digest_ctx_t *digest_ctx,
3351 const uint8_t *data,
3353 return coap_crypto_sha256_update(digest_ctx, data, data_len) == 0;
3357coap_digest_final(coap_digest_ctx_t *digest_ctx,
3358 coap_digest_t *digest_buffer) {
3359 int ret = coap_crypto_sha256_finish(digest_ctx, (uint8_t *)digest_buffer) == 0;
3360 coap_digest_free(digest_ctx);
3370 coap_crypto_md_type_t md_type;
3375 md_type = COAP_CRYPTO_MD_SHA1;
3378 md_type = COAP_CRYPTO_MD_SHA256;
3381 md_type = COAP_CRYPTO_MD_SHA512;
3384 coap_log_debug(
"coap_crypto_hash: algorithm %d not supported\n", alg);
3388 hash_len = coap_crypto_hash_size(md_type);
3396 if (coap_crypto_hash_compute(md_type, data->
s, data->
length,
3409#if COAP_OSCORE_SUPPORT
3411coap_crypto_hmac_compute(coap_crypto_md_type_t md_type,
3412 const uint8_t *key,
size_t key_len,
3413 const uint8_t *input,
size_t ilen,
3414 uint8_t *output,
size_t output_size,
3415 size_t *output_len) {
3416#if COAP_USE_PSA_CRYPTO
3417 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3418 psa_key_id_t key_id;
3419 psa_algorithm_t psa_alg = PSA_ALG_HMAC(md_type);
3421 psa_status_t status;
3423 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
3424 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
3425 psa_set_key_algorithm(&attributes, psa_alg);
3427 if (psa_import_key(&attributes, key, key_len, &key_id) != PSA_SUCCESS) {
3431 status = psa_mac_compute(key_id, psa_alg, input, ilen,
3432 output, output_size, &mac_len);
3433 psa_destroy_key(key_id);
3436 *output_len = mac_len;
3437 return (status == PSA_SUCCESS) ? 0 : -1;
3439 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_type);
3442 size_t mac_size = mbedtls_md_get_size(md_info);
3443 if (mac_size > output_size)
3446 *output_len = mac_size;
3447 return mbedtls_md_hmac(md_info, key, key_len, input, ilen, output);
3454coap_crypto_aead_encrypt_ccm(
const uint8_t *key,
size_t key_len,
3455 const uint8_t *nonce,
size_t nonce_len,
3456 const uint8_t *aad,
size_t aad_len,
3457 const uint8_t *plaintext,
size_t plaintext_len,
3458 uint8_t *ciphertext,
size_t ciphertext_size,
3459 size_t *ciphertext_len,
size_t tag_len) {
3460#if COAP_USE_PSA_CRYPTO
3461 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3462 psa_key_id_t key_id;
3463 psa_algorithm_t psa_alg = PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, tag_len);
3465 psa_status_t status;
3467 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
3468 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
3469 psa_set_key_algorithm(&attributes, psa_alg);
3470 psa_set_key_bits(&attributes, key_len * 8);
3472 if (psa_import_key(&attributes, key, key_len, &key_id) != PSA_SUCCESS) {
3476 status = psa_aead_encrypt(key_id, psa_alg,
3479 plaintext, plaintext_len,
3480 ciphertext, ciphertext_size, &output_len);
3481 psa_destroy_key(key_id);
3484 *ciphertext_len = output_len;
3485 return (status == PSA_SUCCESS) ? 0 : -1;
3487 mbedtls_cipher_context_t ctx;
3488 const mbedtls_cipher_info_t *cipher_info;
3489 mbedtls_cipher_type_t cipher_type;
3491 size_t result_len = ciphertext_size;
3493 if (key_len == 16) {
3494 cipher_type = MBEDTLS_CIPHER_AES_128_CCM;
3495 }
else if (key_len == 32) {
3496 cipher_type = MBEDTLS_CIPHER_AES_256_CCM;
3501 cipher_info = mbedtls_cipher_info_from_type(cipher_type);
3505 mbedtls_cipher_init(&ctx);
3506 if (mbedtls_cipher_setup(&ctx, cipher_info) != 0)
3508 if (mbedtls_cipher_setkey(&ctx, key, key_len * 8, MBEDTLS_ENCRYPT) != 0)
3511#if (MBEDTLS_VERSION_NUMBER < 0x02150000)
3513 unsigned char tag[16];
3514 if (mbedtls_cipher_auth_encrypt(&ctx,
3517 plaintext, plaintext_len,
3518 ciphertext, &result_len,
3519 tag, tag_len) != 0) {
3522 if ((result_len + tag_len) > ciphertext_size)
3524 memcpy(ciphertext + result_len, tag, tag_len);
3525 result_len += tag_len;
3528 if (mbedtls_cipher_auth_encrypt_ext(&ctx,
3531 plaintext, plaintext_len,
3532 ciphertext, ciphertext_size,
3533 &result_len, tag_len) != 0) {
3539 *ciphertext_len = result_len;
3543 mbedtls_cipher_free(&ctx);
3549coap_crypto_aead_decrypt_ccm(
const uint8_t *key,
size_t key_len,
3550 const uint8_t *nonce,
size_t nonce_len,
3551 const uint8_t *aad,
size_t aad_len,
3552 const uint8_t *ciphertext,
size_t ciphertext_len,
3553 uint8_t *plaintext,
size_t plaintext_size,
3554 size_t *plaintext_len,
size_t tag_len) {
3555#if COAP_USE_PSA_CRYPTO
3556 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3557 psa_key_id_t key_id;
3558 psa_algorithm_t psa_alg = PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, tag_len);
3560 psa_status_t status;
3562 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
3563 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
3564 psa_set_key_algorithm(&attributes, psa_alg);
3565 psa_set_key_bits(&attributes, key_len * 8);
3567 if (psa_import_key(&attributes, key, key_len, &key_id) != PSA_SUCCESS) {
3571 status = psa_aead_decrypt(key_id, psa_alg,
3574 ciphertext, ciphertext_len,
3575 plaintext, plaintext_size, &output_len);
3576 psa_destroy_key(key_id);
3579 *plaintext_len = output_len;
3580 return (status == PSA_SUCCESS) ? 0 : -1;
3582 mbedtls_cipher_context_t ctx;
3583 const mbedtls_cipher_info_t *cipher_info;
3584 mbedtls_cipher_type_t cipher_type;
3586 size_t result_len = plaintext_size;
3588 if (key_len == 16) {
3589 cipher_type = MBEDTLS_CIPHER_AES_128_CCM;
3590 }
else if (key_len == 32) {
3591 cipher_type = MBEDTLS_CIPHER_AES_256_CCM;
3596 cipher_info = mbedtls_cipher_info_from_type(cipher_type);
3600 mbedtls_cipher_init(&ctx);
3601 if (mbedtls_cipher_setup(&ctx, cipher_info) != 0)
3603 if (mbedtls_cipher_setkey(&ctx, key, key_len * 8, MBEDTLS_DECRYPT) != 0)
3606#if (MBEDTLS_VERSION_NUMBER < 0x02150000)
3608 const unsigned char *tag = ciphertext + ciphertext_len - tag_len;
3609 if (mbedtls_cipher_auth_decrypt(&ctx,
3612 ciphertext, ciphertext_len - tag_len,
3613 plaintext, &result_len,
3614 tag, tag_len) != 0) {
3619 if (mbedtls_cipher_auth_decrypt_ext(&ctx,
3622 ciphertext, ciphertext_len,
3623 plaintext, plaintext_size,
3624 &result_len, tag_len) != 0) {
3630 *plaintext_len = result_len;
3634 mbedtls_cipher_free(&ctx);
3650get_cipher_key_size(
cose_alg_t alg,
size_t *key_size) {
3661 coap_log_debug(
"get_cipher_key_size: COSE cipher %d not supported\n", alg);
3671 coap_crypto_md_type_t *md_type,
3673 switch ((
int)hmac_alg) {
3676 *md_type = COAP_CRYPTO_MD_SHA256;
3682 *md_type = COAP_CRYPTO_MD_SHA384;
3688 *md_type = COAP_CRYPTO_MD_SHA512;
3693 coap_log_debug(
"get_hmac_params: COSE HMAC %d not supported\n", hmac_alg);
3700 return get_cipher_key_size(alg,
NULL);
3709 return get_hmac_params(hmac_alg,
NULL,
NULL);
3717 size_t *max_result_len) {
3723 assert(params !=
NULL);
3729 if (!get_cipher_key_size(params->
alg,
NULL)) {
3730 coap_log_debug(
"coap_crypto_aead_encrypt: algorithm %d not supported\n",
3737 if (coap_crypto_aead_encrypt_ccm(ccm->
key.
s, ccm->
key.
length,
3741 result, *max_result_len, max_result_len,
3755 size_t *max_result_len) {
3761 assert(params !=
NULL);
3767 if (!get_cipher_key_size(params->
alg,
NULL)) {
3768 coap_log_debug(
"coap_crypto_aead_decrypt: algorithm %d not supported\n",
3780 if (coap_crypto_aead_decrypt_ccm(ccm->
key.
s, ccm->
key.
length,
3784 result, *max_result_len, max_result_len,
3798 coap_crypto_md_type_t md_type;
3806 if (!get_hmac_params(hmac_alg, &md_type, &mac_len)) {
3807 coap_log_debug(
"coap_crypto_hmac: algorithm %d not supported\n", hmac_alg);
3815 if (coap_crypto_hmac_compute(md_type, key->
s, key->
length,
3835#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.
int coap_pki_name_match_sni(const char *name_entry, size_t name_length, const char *sni_match)
Check if the PKI name entry is a (wildcard) match for the requested SNI.
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
Triggerrd 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::@116123127237115130276143055073025260011070157353 params
coap_crypto_aes_ccm_t aes
Used if AES type encryption.
cose_alg_t alg
The COSE algorithm 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
coap_pki_key_t key_type
key format type
union coap_dtls_key_t::@213054141046010326177203305133000126243235267332 key
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 allow_sni_cn_mismatch
1 if SNI and returned CN allowed to mismatch (Client only).
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.
char * client_sni
If not NULL, SNI to use in client TLS setup.
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_dtls_spsk_info_t psk_info
Server PSK definition.
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