OpenVPN
ssl_mbedtls.c
Go to the documentation of this file.
1/*
2 * OpenVPN -- An application to securely tunnel IP networks
3 * over a single TCP/UDP port, with support for SSL/TLS-based
4 * session authentication and key exchange,
5 * packet encryption, packet authentication, and
6 * packet compression.
7 *
8 * Copyright (C) 2002-2026 OpenVPN Inc <sales@openvpn.net>
9 * Copyright (C) 2010-2026 Sentyron B.V. <openvpn@sentyron.com>
10 * Copyright (C) 2006-2010, Brainspark B.V.
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License version 2
14 * as published by the Free Software Foundation.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License along
22 * with this program; if not, see <https://www.gnu.org/licenses/>.
23 */
24
30#ifdef HAVE_CONFIG_H
31#include "config.h"
32#endif
33
34#include "syshead.h"
35
36#if defined(ENABLE_CRYPTO_MBEDTLS)
37
38#include "errlevel.h"
39#include "ssl_backend.h"
40#include "base64.h"
41#include "buffer.h"
42#include "misc.h"
43#include "manage.h"
44#include "mbedtls_compat.h"
45#include "pkcs11_backend.h"
46#include "ssl_common.h"
47#include "ssl_util.h"
48
49#include "ssl_verify_mbedtls.h"
50#include <mbedtls/debug.h>
51#include <mbedtls/error.h>
52#include <mbedtls/net_sockets.h>
53#include <mbedtls/version.h>
54
55#include <mbedtls/oid.h>
56#include <mbedtls/pem.h>
57
58static const mbedtls_x509_crt_profile openvpn_x509_crt_profile_legacy = {
59 /* Hashes from SHA-1 and above */
60 MBEDTLS_X509_ID_FLAG(MBEDTLS_MD_SHA1) | MBEDTLS_X509_ID_FLAG(MBEDTLS_MD_RIPEMD160)
61 | MBEDTLS_X509_ID_FLAG(MBEDTLS_MD_SHA224) | MBEDTLS_X509_ID_FLAG(MBEDTLS_MD_SHA256)
62 | MBEDTLS_X509_ID_FLAG(MBEDTLS_MD_SHA384) | MBEDTLS_X509_ID_FLAG(MBEDTLS_MD_SHA512),
63 0xFFFFFFF, /* Any PK alg */
64 0xFFFFFFF, /* Any curve */
65 1024, /* RSA-1024 and larger */
66};
67
68static const mbedtls_x509_crt_profile openvpn_x509_crt_profile_preferred = {
69 /* SHA-2 and above */
70 MBEDTLS_X509_ID_FLAG(MBEDTLS_MD_SHA224) | MBEDTLS_X509_ID_FLAG(MBEDTLS_MD_SHA256)
71 | MBEDTLS_X509_ID_FLAG(MBEDTLS_MD_SHA384) | MBEDTLS_X509_ID_FLAG(MBEDTLS_MD_SHA512),
72 0xFFFFFFF, /* Any PK alg */
73 0xFFFFFFF, /* Any curve */
74 2048, /* RSA-2048 and larger */
75};
76
77#define openvpn_x509_crt_profile_suiteb mbedtls_x509_crt_profile_suiteb;
78
79void
80tls_init_lib(void)
81{
83}
84
85void
86tls_free_lib(void)
87{
88}
89
90void
92{
93 ASSERT(NULL != ctx);
94 CLEAR(*ctx);
95
96#if MBEDTLS_VERSION_NUMBER < 0x04000000
97 ALLOC_OBJ_CLEAR(ctx->dhm_ctx, mbedtls_dhm_context);
98#endif
99
100 ALLOC_OBJ_CLEAR(ctx->ca_chain, mbedtls_x509_crt);
101
102 ctx->endpoint = MBEDTLS_SSL_IS_SERVER;
103 ctx->initialised = true;
104}
105
106void
108{
109 ASSERT(NULL != ctx);
110 CLEAR(*ctx);
111
112#if MBEDTLS_VERSION_NUMBER < 0x04000000
113 ALLOC_OBJ_CLEAR(ctx->dhm_ctx, mbedtls_dhm_context);
114#endif
115 ALLOC_OBJ_CLEAR(ctx->ca_chain, mbedtls_x509_crt);
116
117 ctx->endpoint = MBEDTLS_SSL_IS_CLIENT;
118 ctx->initialised = true;
119}
120
121void
122tls_ctx_free(struct tls_root_ctx *ctx)
123{
124 if (ctx)
125 {
126 mbedtls_pk_free(ctx->priv_key);
127 free(ctx->priv_key);
128
129 mbedtls_x509_crt_free(ctx->ca_chain);
130 free(ctx->ca_chain);
131
132 mbedtls_x509_crt_free(ctx->crt_chain);
133 free(ctx->crt_chain);
134
135#if MBEDTLS_VERSION_NUMBER < 0x04000000
136 mbedtls_dhm_free(ctx->dhm_ctx);
137 free(ctx->dhm_ctx);
138#endif
139
140 mbedtls_x509_crl_free(ctx->crl);
141 free(ctx->crl);
142
143#if defined(ENABLE_PKCS11)
144 /* ...freeCertificate() can handle NULL ptrs, but if pkcs11 helper
145 * has not been initialized, it will ASSERT() - so, do not pass NULL
146 */
147 if (ctx->pkcs11_cert)
148 {
149 pkcs11h_certificate_freeCertificate(ctx->pkcs11_cert);
150 }
151#endif
152
153 free(ctx->allowed_ciphers);
154
155 free(ctx->groups);
156
157 CLEAR(*ctx);
158
159 ctx->initialised = false;
160 }
161}
162
163bool
165{
166 /* either this should be NULL or should be non-null and then have a
167 * valid TLS ctx inside as well */
168 ASSERT(NULL == ctx || ctx->initialised);
169 return ctx != NULL;
170}
171#if !defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT)
172/*
173 * If we don't have mbedtls_ssl_export_keying_material(), we use
174 * mbedtls_ssl_set_export_keys_cb() to obtain a copy of the TLS 1.2
175 * master secret and compute the TLS-Exporter function ourselves.
176 * Unfortunately, with TLS 1.3, there is no alternative to
177 * mbedtls_ssl_export_keying_material().
178 */
179void
180mbedtls_ssl_export_keys_cb(void *p_expkey, mbedtls_ssl_key_export_type type,
181 const unsigned char *secret, size_t secret_len,
182 const unsigned char client_random[32],
183 const unsigned char server_random[32],
184 mbedtls_tls_prf_types tls_prf_type)
185{
186 /* Since we can't get the TLS 1.3 exporter master secret, we ignore all key
187 * types except MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET. */
188 if (type != MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET)
189 {
190 return;
191 }
192
193 struct tls_session *session = p_expkey;
194 struct key_state_ssl *ks_ssl = &session->key[KS_PRIMARY].ks_ssl;
195 struct tls_key_cache *cache = &ks_ssl->tls_key_cache;
196
197 /* The TLS 1.2 master secret has a fixed size, so if secret_len has
198 * a different value, something is wrong with mbed TLS. */
199 if (secret_len != sizeof(cache->master_secret))
200 {
201 msg(M_FATAL, "ERROR: Incorrect TLS 1.2 master secret length: Got %zu, expected %zu",
202 secret_len, sizeof(cache->master_secret));
203 }
204
205 memcpy(cache->client_server_random, client_random, 32);
206 memcpy(cache->client_server_random + 32, server_random, 32);
207 memcpy(cache->master_secret, secret, sizeof(cache->master_secret));
208 cache->tls_prf_type = tls_prf_type;
209}
210#endif /* !defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT) */
211
212
213bool
214key_state_export_keying_material(struct tls_session *session, const char *label, size_t label_size,
215 void *ekm, size_t ekm_size)
216{
217 ASSERT(strlen(label) == label_size);
218
219#if defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT)
220 /* Our version of mbed TLS has a built-in TLS-Exporter. */
221
222 mbedtls_ssl_context *ctx = session->key[KS_PRIMARY].ks_ssl.ctx;
223 if (mbed_ok(
224 mbedtls_ssl_export_keying_material(ctx, ekm, ekm_size, label, label_size, NULL, 0, 0)))
225 {
226 return true;
227 }
228 else
229 {
230 return false;
231 }
232
233#else /* defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT) */
234 struct tls_key_cache *cache = &session->key[KS_PRIMARY].ks_ssl.tls_key_cache;
235
236 /* If the type is NONE, we either have no cached secrets or
237 * there is no PRF, in both cases we cannot generate key material */
238 if (cache->tls_prf_type == MBEDTLS_SSL_TLS_PRF_NONE)
239 {
240 return false;
241 }
242
243 int ret = mbedtls_ssl_tls_prf(cache->tls_prf_type, cache->master_secret,
244 sizeof(cache->master_secret), label, cache->client_server_random,
245 sizeof(cache->client_server_random), ekm, ekm_size);
246
247 if (mbed_ok(ret))
248 {
249 return true;
250 }
251 else
252 {
253 secure_memzero(ekm, session->opt->ekm_size);
254 return false;
255 }
256#endif /* defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT) */
257}
258
259bool
260tls_ctx_set_options(struct tls_root_ctx *ctx, unsigned int ssl_flags)
261{
262 return true;
263}
264
265static const char *
266tls_translate_cipher_name(const char *cipher_name)
267{
268 const tls_cipher_name_pair *pair = tls_get_cipher_name_pair(cipher_name, strlen(cipher_name));
269
270 if (NULL == pair)
271 {
272 /* No translation found, return original */
273 return cipher_name;
274 }
275
276 if (0 != strcmp(cipher_name, pair->iana_name))
277 {
278 /* Deprecated name found, notify user */
279 msg(M_WARN, "Deprecated cipher suite name '%s', please use IANA name '%s'",
280 pair->openssl_name, pair->iana_name);
281 }
282
283 return pair->iana_name;
284}
285
286void
287tls_ctx_restrict_ciphers_tls13(struct tls_root_ctx *ctx, const char *ciphers)
288{
289 if (ciphers == NULL)
290 {
291 /* Nothing to do, return without warning message */
292 return;
293 }
294
295 msg(M_WARN,
296 "mbed TLS does not support setting tls-ciphersuites. "
297 "Ignoring TLS 1.3 cipher list: %s",
298 ciphers);
299}
300
301void
302tls_ctx_restrict_ciphers(struct tls_root_ctx *ctx, const char *ciphers)
303{
304 char *tmp_ciphers, *tmp_ciphers_orig, *token;
305
306 if (NULL == ciphers)
307 {
308 return; /* Nothing to do */
309 }
310
311 ASSERT(NULL != ctx);
312
313 /* Get number of ciphers */
314 int cipher_count = get_num_elements(ciphers, ':');
315
316 /* Allocate an array for them */
317 ALLOC_ARRAY_CLEAR(ctx->allowed_ciphers, int, cipher_count + 1)
318
319 /* Parse allowed ciphers, getting IDs */
320 int i = 0;
321 tmp_ciphers_orig = tmp_ciphers = string_alloc(ciphers, NULL);
322
323 token = strtok(tmp_ciphers, ":");
324 while (token)
325 {
326 ctx->allowed_ciphers[i] = mbedtls_ssl_get_ciphersuite_id(tls_translate_cipher_name(token));
327 if (0 != ctx->allowed_ciphers[i])
328 {
329 i++;
330 }
331 token = strtok(NULL, ":");
332 }
333 free(tmp_ciphers_orig);
334}
335
336void
337tls_ctx_set_cert_profile(struct tls_root_ctx *ctx, const char *profile)
338{
339 if (!profile || 0 == strcmp(profile, "legacy") || 0 == strcmp(profile, "insecure"))
340 {
341 ctx->cert_profile = openvpn_x509_crt_profile_legacy;
342 }
343 else if (0 == strcmp(profile, "preferred"))
344 {
345 ctx->cert_profile = openvpn_x509_crt_profile_preferred;
346 }
347 else if (0 == strcmp(profile, "suiteb"))
348 {
349 ctx->cert_profile = openvpn_x509_crt_profile_suiteb;
350 }
351 else
352 {
353 msg(M_FATAL, "ERROR: Invalid cert profile: %s", profile);
354 }
355}
356
357#if MBEDTLS_VERSION_NUMBER >= 0x04000000
358static const mbedtls_ecp_curve_info ecp_curve_info_table[] = {
359 /* TODO: Fill out the table. */
360 { "secp256r1", MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1 },
361 { "secp384r1", MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1 },
362 { "X25519", MBEDTLS_SSL_IANA_TLS_GROUP_X25519 },
363 { "ffdhe2048", MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048 },
364 { "ffdhe3072", MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072 },
365 { "ffdhe4096", MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096 },
366 { "ffdhe6144", MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144 },
367 { "ffdhe8192", MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192 },
368};
369static const size_t ecp_curve_info_table_items = sizeof(ecp_curve_info_table) / sizeof(mbedtls_ecp_curve_info);
370
371static const mbedtls_ecp_curve_info *
372mbedtls_ecp_curve_info_from_name(const char *name)
373{
374 for (size_t i = 0; i < ecp_curve_info_table_items; i++)
375 {
376 if (strcmp(name, ecp_curve_info_table[i].name) == 0)
377 {
378 return &ecp_curve_info_table[i];
379 }
380 }
381 return NULL;
382}
383#endif /* MBEDTLS_VERSION_NUMBER >= 0x04000000 */
384
385void
386tls_ctx_set_tls_groups(struct tls_root_ctx *ctx, const char *groups)
387{
388 ASSERT(ctx);
389 struct gc_arena gc = gc_new();
390
391 /* Get number of groups and allocate an array in ctx */
392 int groups_count = get_num_elements(groups, ':');
393 ALLOC_ARRAY_CLEAR(ctx->groups, uint16_t, groups_count + 1)
394
395 /* Parse allowed ciphers, getting IDs */
396 int i = 0;
397 char *tmp_groups = string_alloc(groups, &gc);
398
399 const char *token;
400 while ((token = strsep(&tmp_groups, ":")))
401 {
402 const mbedtls_ecp_curve_info *ci = mbedtls_ecp_curve_info_from_name(token);
403 if (!ci)
404 {
405 msg(M_WARN, "Warning unknown curve/group specified: %s", token);
406 }
407 else
408 {
409 ctx->groups[i] = ci->tls_id;
410 i++;
411 }
412 }
413
414 /* Recent mbedtls versions state that the list of groups must be terminated
415 * with 0. Older versions state that it must be terminated with MBEDTLS_ECP_DP_NONE
416 * which is also 0, so this works either way. */
417 ctx->groups[i] = 0;
418
419 gc_free(&gc);
420}
421
422
423void
424tls_ctx_check_cert_time(const struct tls_root_ctx *ctx)
425{
426 ASSERT(ctx);
427 if (ctx->crt_chain == NULL)
428 {
429 return; /* Nothing to check if there is no certificate */
430 }
431
432 if (mbedtls_x509_time_is_future(&ctx->crt_chain->valid_from))
433 {
434 msg(M_WARN, "WARNING: Your certificate is not yet valid!");
435 }
436
437 if (mbedtls_x509_time_is_past(&ctx->crt_chain->valid_to))
438 {
439 msg(M_WARN, "WARNING: Your certificate has expired!");
440 }
441}
442
443void
444tls_ctx_load_dh_params(struct tls_root_ctx *ctx, const char *dh_file, bool dh_inline)
445{
446#if MBEDTLS_VERSION_NUMBER < 0x04000000
447 if (dh_inline)
448 {
449 if (!mbed_ok(mbedtls_dhm_parse_dhm(ctx->dhm_ctx, (const unsigned char *)dh_file,
450 strlen(dh_file) + 1)))
451 {
452 msg(M_FATAL, "Cannot read inline DH parameters");
453 }
454 }
455 else
456 {
457 if (!mbed_ok(mbedtls_dhm_parse_dhmfile(ctx->dhm_ctx, dh_file)))
458 {
459 msg(M_FATAL, "Cannot read DH parameters from file %s", dh_file);
460 }
461 }
462
463 msg(D_TLS_DEBUG_LOW, "Diffie-Hellman initialized with " counter_format " bit key",
464 (counter_type)mbedtls_dhm_get_bitlen(ctx->dhm_ctx));
465#else
466 if (strcmp(dh_file, "none") != 0)
467 {
468 msg(M_FATAL, "Mbed TLS 4 only supports pre-defined Diffie-Hellman groups.");
469 }
470#endif /* MBEDTLS_VERSION_NUMBER < 0x04000000 */
471}
472
473void
474tls_ctx_load_ecdh_params(struct tls_root_ctx *ctx, const char *curve_name)
475{
476 if (NULL != curve_name)
477 {
478 msg(M_WARN, "WARNING: mbed TLS builds do not support specifying an "
479 "ECDH curve with --ecdh-curve, using default curves. Use "
480 "--tls-groups to specify curves.");
481 }
482}
483
484int
485tls_ctx_load_pkcs12(struct tls_root_ctx *ctx, const char *pkcs12_file, bool pkcs12_file_inline,
486 bool load_ca_file)
487{
488 msg(M_FATAL, "PKCS #12 files not yet supported for mbed TLS.");
489 return 0;
490}
491
492#ifdef ENABLE_CRYPTOAPI
493void
494tls_ctx_load_cryptoapi(struct tls_root_ctx *ctx, const char *cryptoapi_cert)
495{
496 msg(M_FATAL, "Windows CryptoAPI not yet supported for mbed TLS.");
497}
498#endif /* _WIN32 */
499
500void
501tls_ctx_load_cert_file(struct tls_root_ctx *ctx, const char *cert_file, bool cert_inline)
502{
503 ASSERT(NULL != ctx);
504
505 if (!ctx->crt_chain)
506 {
507 ALLOC_OBJ_CLEAR(ctx->crt_chain, mbedtls_x509_crt);
508 }
509
510 if (cert_inline)
511 {
512 if (!cert_file)
513 {
514 msg(M_FATAL, "Cannot load inline certificate: NULL");
515 }
516 if (!mbed_ok(mbedtls_x509_crt_parse(ctx->crt_chain, (const unsigned char *)cert_file,
517 strlen(cert_file) + 1)))
518 {
519 msg(M_FATAL, "Cannot load inline certificate");
520 }
521 }
522 else
523 {
524 if (!mbed_ok(mbedtls_x509_crt_parse_file(ctx->crt_chain, cert_file)))
525 {
526 msg(M_FATAL, "Cannot load certificate file %s", cert_file);
527 }
528 }
529}
530
531int
532tls_ctx_load_priv_file(struct tls_root_ctx *ctx, const char *priv_key_file, bool priv_key_inline)
533{
534 int status;
535 ASSERT(NULL != ctx);
536
537 if (!ctx->priv_key)
538 {
539 ALLOC_OBJ_CLEAR(ctx->priv_key, mbedtls_pk_context);
540 }
541
542 if (priv_key_inline)
543 {
544 status = mbedtls_compat_pk_parse_key(ctx->priv_key, (const unsigned char *)priv_key_file,
545 strlen(priv_key_file) + 1, NULL, 0);
546
547 if (MBEDTLS_ERR_PK_PASSWORD_REQUIRED == status)
548 {
549 char passbuf[512] = { 0 };
550 pem_password_callback(passbuf, 512, 0, NULL);
552 ctx->priv_key, (const unsigned char *)priv_key_file, strlen(priv_key_file) + 1,
553 (unsigned char *)passbuf, strlen(passbuf));
554 }
555 }
556 else
557 {
558 status = mbedtls_compat_pk_parse_keyfile(ctx->priv_key, priv_key_file, NULL);
559 if (MBEDTLS_ERR_PK_PASSWORD_REQUIRED == status)
560 {
561 char passbuf[512] = { 0 };
562 pem_password_callback(passbuf, 512, 0, NULL);
564 }
565 }
566 if (!mbed_ok(status))
567 {
568#ifdef ENABLE_MANAGEMENT
569 if (management && (MBEDTLS_ERR_PK_PASSWORD_MISMATCH == status))
570 {
572 }
573#endif
574 msg(M_WARN, "Cannot load private key file %s",
575 print_key_filename(priv_key_file, priv_key_inline));
576 return 1;
577 }
578
580 {
581 msg(M_WARN, "Private key does not match the certificate");
582 return 1;
583 }
584
585 return 0;
586}
587
588#if defined(__GNUC__) || defined(__clang__)
589#pragma GCC diagnostic push
590#pragma GCC diagnostic ignored "-Wconversion"
591#endif
592
593#if MBEDTLS_VERSION_NUMBER < 0x04000000
612static inline int
613external_pkcs1_sign(void *ctx_voidptr, int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
614 mbedtls_md_type_t md_alg, unsigned int hashlen, const unsigned char *hash,
615 unsigned char *sig)
616{
617 struct external_context *const ctx = ctx_voidptr;
618 int rv;
619 uint8_t *to_sign = NULL;
620 size_t asn_len = 0, oid_size = 0;
621 const char *oid = NULL;
622
623 if (NULL == ctx)
624 {
625 return MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
626 }
627
628 /*
629 * Support a wide range of hashes. TLSv1.1 and before only need SIG_RSA_RAW,
630 * but TLSv1.2 needs the full suite of hashes.
631 *
632 * This code has been taken from mbed TLS pkcs11_sign(), under the GPLv2.0+.
633 */
634 if (md_alg != MBEDTLS_MD_NONE)
635 {
636 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
637 if (md_info == NULL)
638 {
639 return (MBEDTLS_ERR_RSA_BAD_INPUT_DATA);
640 }
641
642 if (!mbed_ok(mbedtls_oid_get_oid_by_md(md_alg, &oid, &oid_size)))
643 {
644 return (MBEDTLS_ERR_RSA_BAD_INPUT_DATA);
645 }
646
647 hashlen = mbedtls_md_get_size(md_info);
648 asn_len = 10 + oid_size;
649 }
650
651 if ((SIZE_MAX - hashlen) < asn_len || ctx->signature_length < (asn_len + hashlen))
652 {
653 return MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
654 }
655
656 ALLOC_ARRAY_CLEAR(to_sign, uint8_t, asn_len + hashlen);
657 uint8_t *p = to_sign;
658 if (md_alg != MBEDTLS_MD_NONE)
659 {
660 /*
661 * DigestInfo ::= SEQUENCE {
662 * digestAlgorithm DigestAlgorithmIdentifier,
663 * digest Digest }
664 *
665 * DigestAlgorithmIdentifier ::= AlgorithmIdentifier
666 *
667 * Digest ::= OCTET STRING
668 */
669 *p++ = MBEDTLS_ASN1_SEQUENCE | MBEDTLS_ASN1_CONSTRUCTED;
670 *p++ = (unsigned char)(0x08 + oid_size + hashlen);
671 *p++ = MBEDTLS_ASN1_SEQUENCE | MBEDTLS_ASN1_CONSTRUCTED;
672 *p++ = (unsigned char)(0x04 + oid_size);
673 *p++ = MBEDTLS_ASN1_OID;
674 *p++ = oid_size & 0xFF;
675 memcpy(p, oid, oid_size);
676 p += oid_size;
677 *p++ = MBEDTLS_ASN1_NULL;
678 *p++ = 0x00;
679 *p++ = MBEDTLS_ASN1_OCTET_STRING;
680 *p++ = hashlen;
681
682 /* Double-check ASN length */
683 ASSERT(asn_len == p - to_sign);
684 }
685
686 /* Copy the hash to be signed */
687 memcpy(p, hash, hashlen);
688
689 /* Call external signature function */
690 if (!ctx->sign(ctx->sign_ctx, to_sign, asn_len + hashlen, sig, ctx->signature_length))
691 {
692 rv = MBEDTLS_ERR_RSA_PRIVATE_FAILED;
693 goto done;
694 }
695
696 rv = 0;
697
698done:
699 free(to_sign);
700 return rv;
701}
702
703static inline size_t
704external_key_len(void *vctx)
705{
706 struct external_context *const ctx = vctx;
707
708 return ctx->signature_length;
709}
710#endif /* MBEDTLS_VERSION_NUMBER < 0x04000000 */
711
712int
714 void *sign_ctx)
715{
716#if MBEDTLS_VERSION_NUMBER >= 0x04000000
717 msg(M_WARN, "tls_ctx_use_external_signing_func is not implemented for Mbed TLS 4.");
718 return 1;
719#else
720 ASSERT(NULL != ctx);
721
722 if (ctx->crt_chain == NULL)
723 {
724 msg(M_WARN, "ERROR: external key requires a certificate.");
725 return 1;
726 }
727
728 if (mbedtls_pk_get_type(&ctx->crt_chain->pk) != MBEDTLS_PK_RSA)
729 {
730 msg(M_WARN, "ERROR: external key with mbed TLS requires a "
731 "certificate with an RSA key.");
732 return 1;
733 }
734
735 ctx->external_key.signature_length = mbedtls_pk_get_len(&ctx->crt_chain->pk);
736 ctx->external_key.sign = sign_func;
738
739 ALLOC_OBJ_CLEAR(ctx->priv_key, mbedtls_pk_context);
740 if (!mbed_ok(mbedtls_pk_setup_rsa_alt(ctx->priv_key, &ctx->external_key, NULL,
741 external_pkcs1_sign, external_key_len)))
742 {
743 return 1;
744 }
745
746 return 0;
747#endif /* MBEDTLS_VERSION_NUMBER >= 0x04000000 */
748}
749
750#ifdef ENABLE_MANAGEMENT
752static bool
753management_sign_func(void *sign_ctx, const void *src, size_t src_len, void *dst, size_t dst_len)
754{
755 bool ret = false;
756 char *src_b64 = NULL;
757 char *dst_b64 = NULL;
758
759 if (!management || (openvpn_base64_encode(src, (int)src_len, &src_b64) <= 0))
760 {
761 goto cleanup;
762 }
763
764 /*
765 * We only support RSA external keys and PKCS1 signatures at the moment
766 * in mbed TLS, so the signature parameter is hardcoded to this encoding
767 */
768 if (!(dst_b64 = management_query_pk_sig(management, src_b64, "RSA_PKCS1_PADDING")))
769 {
770 goto cleanup;
771 }
772
773 if (openvpn_base64_decode(dst_b64, dst, (int)dst_len) != dst_len)
774 {
775 goto cleanup;
776 }
777
778 ret = true;
779cleanup:
780 free(src_b64);
781 free(dst_b64);
782
783 return ret;
784}
785
786int
788{
789 return tls_ctx_use_external_signing_func(ctx, management_sign_func, NULL);
790}
791
792#endif /* ifdef ENABLE_MANAGEMENT */
793
794void
795tls_ctx_load_ca(struct tls_root_ctx *ctx, const char *ca_file, bool ca_inline, const char *ca_path,
796 bool tls_server)
797{
798 if (ca_path)
799 {
800 msg(M_FATAL, "ERROR: mbed TLS cannot handle the capath directive");
801 }
802
803 if (ca_file && ca_inline)
804 {
805 if (!mbed_ok(mbedtls_x509_crt_parse(ctx->ca_chain, (const unsigned char *)ca_file,
806 strlen(ca_file) + 1)))
807 {
808 msg(M_FATAL, "Cannot load inline CA certificates");
809 }
810 }
811 else
812 {
813 /* Load CA file for verifying peer supplied certificate */
814 if (!mbed_ok(mbedtls_x509_crt_parse_file(ctx->ca_chain, ca_file)))
815 {
816 msg(M_FATAL, "Cannot load CA certificate file %s", ca_file);
817 }
818 }
819}
820
821void
822tls_ctx_load_extra_certs(struct tls_root_ctx *ctx, const char *extra_certs_file,
823 bool extra_certs_inline)
824{
825 ASSERT(NULL != ctx);
826
827 if (!ctx->crt_chain)
828 {
829 ALLOC_OBJ_CLEAR(ctx->crt_chain, mbedtls_x509_crt);
830 }
831
832 if (extra_certs_inline)
833 {
834 if (!mbed_ok(mbedtls_x509_crt_parse(ctx->crt_chain, (const unsigned char *)extra_certs_file,
835 strlen(extra_certs_file) + 1)))
836 {
837 msg(M_FATAL, "Cannot load inline extra-certs file");
838 }
839 }
840 else
841 {
842 if (!mbed_ok(mbedtls_x509_crt_parse_file(ctx->crt_chain, extra_certs_file)))
843 {
844 msg(M_FATAL, "Cannot load extra-certs file: %s", extra_certs_file);
845 }
846 }
847}
848
849/* **************************************
850 *
851 * Key-state specific functions
852 *
853 ***************************************/
854
855/*
856 * "Endless buffer"
857 */
858
859static inline void
860buf_free_entry(buffer_entry *entry)
861{
862 if (NULL != entry)
863 {
864 free(entry->data);
865 free(entry);
866 }
867}
868
869static void
870buf_free_entries(endless_buffer *buf)
871{
872 while (buf->first_block)
873 {
874 buffer_entry *cur_block = buf->first_block;
875 buf->first_block = cur_block->next_block;
876 buf_free_entry(cur_block);
877 }
878 buf->last_block = NULL;
879}
880
881static int
882endless_buf_read(endless_buffer *in, unsigned char *out, size_t out_len)
883{
884 size_t read_len = 0;
885
886 if (in->first_block == NULL)
887 {
888 return MBEDTLS_ERR_SSL_WANT_READ;
889 }
890
891 while (in->first_block != NULL && read_len < out_len)
892 {
893 int block_len = in->first_block->length - in->data_start;
894 if (block_len <= out_len - read_len)
895 {
896 buffer_entry *cur_entry = in->first_block;
897 memcpy(out + read_len, cur_entry->data + in->data_start, block_len);
898
899 read_len += block_len;
900
901 in->first_block = cur_entry->next_block;
902 in->data_start = 0;
903
904 if (in->first_block == NULL)
905 {
906 in->last_block = NULL;
907 }
908
909 buf_free_entry(cur_entry);
910 }
911 else
912 {
913 memcpy(out + read_len, in->first_block->data + in->data_start, out_len - read_len);
914 in->data_start += out_len - read_len;
915 read_len = out_len;
916 }
917 }
918
919 return read_len;
920}
921
922static int
923endless_buf_write(endless_buffer *out, const unsigned char *in, size_t len)
924{
925 buffer_entry *new_block = malloc(sizeof(buffer_entry));
926 if (NULL == new_block)
927 {
928 return MBEDTLS_ERR_NET_SEND_FAILED;
929 }
930
931 new_block->data = malloc(len);
932 if (NULL == new_block->data)
933 {
934 free(new_block);
935 return MBEDTLS_ERR_NET_SEND_FAILED;
936 }
937
938 new_block->length = len;
939 new_block->next_block = NULL;
940
941 memcpy(new_block->data, in, len);
942
943 if (NULL == out->first_block)
944 {
945 out->first_block = new_block;
946 }
947
948 if (NULL != out->last_block)
949 {
950 out->last_block->next_block = new_block;
951 }
952
953 out->last_block = new_block;
954
955 return len;
956}
957
958static int
959ssl_bio_read(void *ctx, unsigned char *out, size_t out_len)
960{
961 bio_ctx *my_ctx = (bio_ctx *)ctx;
962 return endless_buf_read(&my_ctx->in, out, out_len);
963}
964
965static int
966ssl_bio_write(void *ctx, const unsigned char *in, size_t in_len)
967{
968 bio_ctx *my_ctx = (bio_ctx *)ctx;
969 return endless_buf_write(&my_ctx->out, in, in_len);
970}
971
972static void
973my_debug(void *ctx, int level, const char *file, int line, const char *str)
974{
975 int my_loglevel = (level < 3) ? D_TLS_DEBUG_MED : D_TLS_DEBUG;
976 msg(my_loglevel, "mbed TLS msg (%s:%d): %s", file, line, str);
977}
978
979/*
980 * Further personalise the RNG using a hash of the public key
981 */
982void
983tls_ctx_personalise_random(struct tls_root_ctx *ctx)
984{
985#if MBEDTLS_VERSION_NUMBER < 0x04000000
986 static char old_sha256_hash[32] = { 0 };
987 unsigned char sha256_hash[32] = { 0 };
988 mbedtls_ctr_drbg_context *cd_ctx = rand_ctx_get();
989
990 if (NULL != ctx->crt_chain)
991 {
992 mbedtls_x509_crt *cert = ctx->crt_chain;
993
994 if (!md_full("SHA256", cert->tbs.p, cert->tbs.len, sha256_hash))
995 {
996 msg(M_WARN, "WARNING: failed to personalise random");
997 }
998
999 if (0 != memcmp(old_sha256_hash, sha256_hash, sizeof(sha256_hash)))
1000 {
1001 if (!mbed_ok(mbedtls_ctr_drbg_update(cd_ctx, sha256_hash, 32)))
1002 {
1003 msg(M_WARN, "WARNING: failed to personalise random, could not update CTR_DRBG");
1004 }
1005 memcpy(old_sha256_hash, sha256_hash, sizeof(old_sha256_hash));
1006 }
1007 }
1008#endif /* MBEDTLS_VERSION_NUMBER < 0x040000 */
1009}
1010
1011#if defined(__GNUC__) || defined(__clang__)
1012#pragma GCC diagnostic pop
1013#endif
1014
1015int
1016tls_version_max(void)
1017{
1018 /* We need mbedtls_ssl_export_keying_material() to support TLS 1.3. */
1019#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT)
1020 return TLS_VER_1_3;
1021#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
1022 return TLS_VER_1_2;
1023#else
1024#error mbedtls is compiled without support for TLS 1.2 or 1.3
1025#endif
1026}
1027
1035mbedtls_ssl_protocol_version
1036tls_version_to_ssl_version(int tls_ver)
1037{
1038 switch (tls_ver)
1039 {
1040#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
1041 case TLS_VER_1_2:
1042 return MBEDTLS_SSL_VERSION_TLS1_2;
1043#endif
1044
1045#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1046 case TLS_VER_1_3:
1047 return MBEDTLS_SSL_VERSION_TLS1_3;
1048#endif
1049
1050 default:
1051 msg(M_FATAL, "%s: invalid or unsupported TLS version %d", __func__, tls_ver);
1052 return MBEDTLS_SSL_VERSION_UNKNOWN;
1053 }
1054}
1055
1056void
1057backend_tls_ctx_reload_crl(struct tls_root_ctx *ctx, const char *crl_file, bool crl_inline)
1058{
1059 ASSERT(crl_file);
1060
1061 if (ctx->crl == NULL)
1062 {
1063 ALLOC_OBJ_CLEAR(ctx->crl, mbedtls_x509_crl);
1064 }
1065 mbedtls_x509_crl_free(ctx->crl);
1066
1067 if (crl_inline)
1068 {
1069 if (!mbed_ok(mbedtls_x509_crl_parse(ctx->crl, (const unsigned char *)crl_file,
1070 strlen(crl_file) + 1)))
1071 {
1072 msg(M_WARN, "CRL: cannot parse inline CRL");
1073 goto err;
1074 }
1075 }
1076 else
1077 {
1078 if (!mbed_ok(mbedtls_x509_crl_parse_file(ctx->crl, crl_file)))
1079 {
1080 msg(M_WARN, "CRL: cannot read CRL from file %s", crl_file);
1081 goto err;
1082 }
1083 }
1084 return;
1085
1086err:
1087 mbedtls_x509_crl_free(ctx->crl);
1088}
1089
1090void
1091key_state_ssl_init(struct key_state_ssl *ks_ssl, const struct tls_root_ctx *ssl_ctx, bool is_server,
1092 struct tls_session *session)
1093{
1094 ASSERT(NULL != ssl_ctx);
1095 ASSERT(ks_ssl);
1096 CLEAR(*ks_ssl);
1097
1098 /* Initialise SSL config */
1099 ALLOC_OBJ_CLEAR(ks_ssl->ssl_config, mbedtls_ssl_config);
1100 mbedtls_ssl_config_init(ks_ssl->ssl_config);
1101 mbedtls_ssl_config_defaults(ks_ssl->ssl_config, ssl_ctx->endpoint, MBEDTLS_SSL_TRANSPORT_STREAM,
1102 MBEDTLS_SSL_PRESET_DEFAULT);
1103#ifdef MBEDTLS_DEBUG_C
1104 /* We only want to have mbed TLS generate debug level logging when we would
1105 * also display it.
1106 * In fact mbed TLS 2.25.0 crashes generating debug log if Curve25591 is
1107 * selected for DH (https://github.com/ARMmbed/mbedtls/issues/4208) */
1108 if (session->opt->ssl_flags & SSLF_TLS_DEBUG_ENABLED)
1109 {
1110 mbedtls_debug_set_threshold(3);
1111 }
1112 else
1113 {
1114 mbedtls_debug_set_threshold(2);
1115 }
1116#endif
1117 mbedtls_ssl_conf_dbg(ks_ssl->ssl_config, my_debug, NULL);
1118#if MBEDTLS_VERSION_NUMBER < 0x04000000
1119 mbedtls_ssl_conf_rng(ks_ssl->ssl_config, mbedtls_ctr_drbg_random, rand_ctx_get());
1120#endif /* MBEDTLS_VERSION_NUMBER < 0x04000000 */
1121
1122 mbedtls_ssl_conf_cert_profile(ks_ssl->ssl_config, &ssl_ctx->cert_profile);
1123
1124 if (ssl_ctx->allowed_ciphers)
1125 {
1126 mbedtls_ssl_conf_ciphersuites(ks_ssl->ssl_config, ssl_ctx->allowed_ciphers);
1127 }
1128
1129 if (ssl_ctx->groups)
1130 {
1131 mbedtls_ssl_conf_groups(ks_ssl->ssl_config, ssl_ctx->groups);
1132 }
1133
1134 /* Disable TLS renegotiations if the mbedtls library supports that feature.
1135 * OpenVPN's renegotiation creates new SSL sessions and does not depend on
1136 * this feature and TLS renegotiations have been problematic in the past. */
1137#if defined(MBEDTLS_SSL_RENEGOTIATION)
1138 mbedtls_ssl_conf_renegotiation(ks_ssl->ssl_config, MBEDTLS_SSL_RENEGOTIATION_DISABLED);
1139#endif /* MBEDTLS_SSL_RENEGOTIATION */
1140
1141 /* Disable record splitting (for now). OpenVPN assumes records are sent
1142 * unfragmented, and changing that will require thorough review and
1143 * testing. Since OpenVPN is not susceptible to BEAST, we can just
1144 * disable record splitting as a quick fix. */
1145#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
1146 mbedtls_ssl_conf_cbc_record_splitting(ks_ssl->ssl_config,
1147 MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED);
1148#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
1149
1150 /* Initialise authentication information */
1151#if MBEDTLS_VERSION_NUMBER < 0x04000000
1152 if (is_server)
1153 {
1154 mbed_ok(mbedtls_ssl_conf_dh_param_ctx(ks_ssl->ssl_config, ssl_ctx->dhm_ctx));
1155 }
1156#endif
1157
1158 (void)mbed_ok(mbedtls_ssl_conf_own_cert(ks_ssl->ssl_config, ssl_ctx->crt_chain, ssl_ctx->priv_key));
1159
1160 /* Initialise SSL verification */
1161 if (session->opt->ssl_flags & SSLF_CLIENT_CERT_OPTIONAL)
1162 {
1163 mbedtls_ssl_conf_authmode(ks_ssl->ssl_config, MBEDTLS_SSL_VERIFY_OPTIONAL);
1164 }
1165 else if (!(session->opt->ssl_flags & SSLF_CLIENT_CERT_NOT_REQUIRED))
1166 {
1167 mbedtls_ssl_conf_authmode(ks_ssl->ssl_config, MBEDTLS_SSL_VERIFY_REQUIRED);
1168 }
1169 mbedtls_ssl_conf_verify(ks_ssl->ssl_config, verify_callback, session);
1170
1171 /* TODO: mbed TLS does not currently support sending the CA chain to the client */
1172 mbedtls_ssl_conf_ca_chain(ks_ssl->ssl_config, ssl_ctx->ca_chain, ssl_ctx->crl);
1173
1174 /* Initialize minimum TLS version */
1175 {
1176 const int configured_tls_version_min =
1178
1179 /* default to TLS 1.2 */
1180 mbedtls_ssl_protocol_version version = MBEDTLS_SSL_VERSION_TLS1_2;
1181
1182 if (configured_tls_version_min > TLS_VER_UNSPEC)
1183 {
1184 version = tls_version_to_ssl_version(configured_tls_version_min);
1185 }
1186
1187 mbedtls_ssl_conf_min_tls_version(ks_ssl->ssl_config, version);
1188 }
1189
1190 /* Initialize maximum TLS version */
1191 {
1192 const int configured_tls_version_max =
1194
1195 mbedtls_ssl_protocol_version version = MBEDTLS_SSL_VERSION_UNKNOWN;
1196
1197 if (configured_tls_version_max > TLS_VER_UNSPEC)
1198 {
1199 version = tls_version_to_ssl_version(configured_tls_version_max);
1200 }
1201 else
1202 {
1203 /* Default to tls_version_max(). */
1204 version = tls_version_to_ssl_version(tls_version_max());
1205 }
1206
1207 mbedtls_ssl_conf_max_tls_version(ks_ssl->ssl_config, version);
1208 }
1209
1210 /* Initialise SSL context */
1211 ALLOC_OBJ_CLEAR(ks_ssl->ctx, mbedtls_ssl_context);
1212 mbedtls_ssl_init(ks_ssl->ctx);
1213 (void)mbed_ok(mbedtls_ssl_setup(ks_ssl->ctx, ks_ssl->ssl_config));
1214 /* We do verification in our own callback depending on the
1215 * exact configuration. We do not rely on the default hostname
1216 * verification. */
1217 ASSERT(mbed_ok(mbedtls_ssl_set_hostname(ks_ssl->ctx, NULL)));
1218
1219#if !defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT)
1220 /* Initialize the keying material exporter callback. */
1221 mbedtls_ssl_set_export_keys_cb(ks_ssl->ctx, mbedtls_ssl_export_keys_cb, session);
1222#endif
1223
1224 /* Initialise BIOs */
1226 mbedtls_ssl_set_bio(ks_ssl->ctx, ks_ssl->bio_ctx, ssl_bio_write, ssl_bio_read, NULL);
1227}
1228
1229
1230void
1232{
1233 mbedtls_ssl_send_alert_message(ks_ssl->ctx, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
1234 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY);
1235}
1236
1237void
1238key_state_ssl_free(struct key_state_ssl *ks_ssl)
1239{
1240 if (ks_ssl)
1241 {
1242 CLEAR(ks_ssl->tls_key_cache);
1243
1244 if (ks_ssl->ctx)
1245 {
1246 mbedtls_ssl_free(ks_ssl->ctx);
1247 free(ks_ssl->ctx);
1248 }
1249 if (ks_ssl->ssl_config)
1250 {
1251 mbedtls_ssl_config_free(ks_ssl->ssl_config);
1252 free(ks_ssl->ssl_config);
1253 }
1254 if (ks_ssl->bio_ctx)
1255 {
1256 buf_free_entries(&ks_ssl->bio_ctx->in);
1257 buf_free_entries(&ks_ssl->bio_ctx->out);
1258 free(ks_ssl->bio_ctx);
1259 }
1260 CLEAR(*ks_ssl);
1261 }
1262}
1263
1264int
1265key_state_write_plaintext(struct key_state_ssl *ks, struct buffer *buf)
1266{
1267 int retval = 0;
1268
1269 ASSERT(buf);
1270
1271 retval = key_state_write_plaintext_const(ks, BPTR(buf), BLEN(buf));
1272
1273 if (1 == retval)
1274 {
1275 memset(BPTR(buf), 0, BLEN(buf)); /* erase data just written */
1276 buf->len = 0;
1277 }
1278
1279 return retval;
1280}
1281
1282int
1283key_state_write_plaintext_const(struct key_state_ssl *ks, const uint8_t *data, int len)
1284{
1285 int retval = 0;
1286
1287 ASSERT(NULL != ks);
1288 ASSERT(len >= 0);
1289
1290 if (0 == len)
1291 {
1292 return 0;
1293 }
1294
1295 ASSERT(data);
1296
1297 retval = mbedtls_ssl_write(ks->ctx, data, len);
1298
1299 if (retval < 0)
1300 {
1301 if (MBEDTLS_ERR_SSL_WANT_WRITE == retval || MBEDTLS_ERR_SSL_WANT_READ == retval)
1302 {
1303 return 0;
1304 }
1305 mbed_log_err(D_TLS_ERRORS, retval, "TLS ERROR: write tls_write_plaintext_const error");
1306 return -1;
1307 }
1308
1309 if (retval != len)
1310 {
1311 msg(D_TLS_ERRORS, "TLS ERROR: write tls_write_plaintext_const incomplete %d/%d", retval,
1312 len);
1313 return -1;
1314 }
1315
1316 /* successful write */
1317 dmsg(D_HANDSHAKE_VERBOSE, "write tls_write_plaintext_const %d bytes", retval);
1318
1319 return 1;
1320}
1321
1322int
1323key_state_read_ciphertext(struct key_state_ssl *ks, struct buffer *buf)
1324{
1325 int retval = 0;
1326 int len = 0;
1327
1328 ASSERT(NULL != ks);
1329 ASSERT(buf);
1330 ASSERT(buf->len >= 0);
1331
1332 if (buf->len)
1333 {
1334 return 0;
1335 }
1336
1337 len = buf_forward_capacity(buf);
1338
1339 retval = endless_buf_read(&ks->bio_ctx->out, BPTR(buf), len);
1340
1341 /* Error during read, check for retry error */
1342 if (retval < 0)
1343 {
1344 if (MBEDTLS_ERR_SSL_WANT_WRITE == retval || MBEDTLS_ERR_SSL_WANT_READ == retval)
1345 {
1346 return 0;
1347 }
1348 mbed_log_err(D_TLS_ERRORS, retval, "TLS_ERROR: read tls_read_ciphertext error");
1349 buf->len = 0;
1350 return -1;
1351 }
1352 /* Nothing read, try again */
1353 if (0 == retval)
1354 {
1355 buf->len = 0;
1356 return 0;
1357 }
1358
1359 /* successful read */
1360 dmsg(D_HANDSHAKE_VERBOSE, "read tls_read_ciphertext %d bytes", retval);
1361 buf->len = retval;
1362 return 1;
1363}
1364
1365int
1366key_state_write_ciphertext(struct key_state_ssl *ks, struct buffer *buf)
1367{
1368 int retval = 0;
1369
1370 ASSERT(NULL != ks);
1371 ASSERT(buf);
1372 ASSERT(buf->len >= 0);
1373
1374 if (0 == buf->len)
1375 {
1376 return 0;
1377 }
1378
1379 retval = endless_buf_write(&ks->bio_ctx->in, BPTR(buf), buf->len);
1380
1381 if (retval < 0)
1382 {
1383 if (MBEDTLS_ERR_SSL_WANT_WRITE == retval || MBEDTLS_ERR_SSL_WANT_READ == retval)
1384 {
1385 return 0;
1386 }
1387 mbed_log_err(D_TLS_ERRORS, retval, "TLS ERROR: write tls_write_ciphertext error");
1388 return -1;
1389 }
1390
1391 if (retval != buf->len)
1392 {
1393 msg(D_TLS_ERRORS, "TLS ERROR: write tls_write_ciphertext incomplete %d/%d", retval,
1394 buf->len);
1395 return -1;
1396 }
1397
1398 /* successful write */
1399 dmsg(D_HANDSHAKE_VERBOSE, "write tls_write_ciphertext %d bytes", retval);
1400
1401 memset(BPTR(buf), 0, BLEN(buf)); /* erase data just written */
1402 buf->len = 0;
1403
1404 return 1;
1405}
1406
1407int
1408key_state_read_plaintext(struct key_state_ssl *ks, struct buffer *buf)
1409{
1410 int retval = 0;
1411 int len = 0;
1412
1413 ASSERT(NULL != ks);
1414 ASSERT(buf);
1415 ASSERT(buf->len >= 0);
1416
1417 if (buf->len)
1418 {
1419 return 0;
1420 }
1421
1422 len = buf_forward_capacity(buf);
1423
1424 retval = mbedtls_ssl_read(ks->ctx, BPTR(buf), len);
1425
1426 /* Error during read, check for retry error */
1427 if (retval < 0)
1428 {
1429 if (MBEDTLS_ERR_SSL_WANT_WRITE == retval || MBEDTLS_ERR_SSL_WANT_READ == retval
1430 || MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET == retval)
1431 {
1432 return 0;
1433 }
1434 mbed_log_err(D_TLS_ERRORS, retval, "TLS_ERROR: read tls_read_plaintext error");
1435 buf->len = 0;
1436 return -1;
1437 }
1438 /* Nothing read, try again */
1439 if (0 == retval)
1440 {
1441 buf->len = 0;
1442 return 0;
1443 }
1444
1445 /* successful read */
1446 dmsg(D_HANDSHAKE_VERBOSE, "read tls_read_plaintext %d bytes", retval);
1447 buf->len = retval;
1448
1449 return 1;
1450}
1451
1452/* **************************************
1453 *
1454 * Information functions
1455 *
1456 * Print information for the end user.
1457 *
1458 ***************************************/
1459void
1460print_details(struct key_state_ssl *ks_ssl, const char *prefix)
1461{
1462 const mbedtls_x509_crt *cert;
1463 char s1[256];
1464 char s2[256];
1465
1466 s1[0] = s2[0] = 0;
1467 snprintf(s1, sizeof(s1), "%s %s, cipher %s", prefix, mbedtls_ssl_get_version(ks_ssl->ctx),
1468 mbedtls_ssl_get_ciphersuite(ks_ssl->ctx));
1469
1470 cert = mbedtls_ssl_get_peer_cert(ks_ssl->ctx);
1471 if (cert != NULL)
1472 {
1473 snprintf(s2, sizeof(s2), ", %u bit key", (unsigned int)mbedtls_pk_get_bitlen(&cert->pk));
1474 }
1475
1476 msg(D_HANDSHAKE, "%s%s", s1, s2);
1477}
1478
1479void
1480show_available_tls_ciphers_list(const char *cipher_list, const char *tls_cert_profile, bool tls13)
1481{
1482 if (tls13)
1483 {
1484 /* mbed TLS has no TLS 1.3 support currently */
1485 return;
1486 }
1487 struct tls_root_ctx tls_ctx;
1488 const int *ciphers = mbedtls_ssl_list_ciphersuites();
1489
1490 tls_ctx_server_new(&tls_ctx);
1491 tls_ctx_set_cert_profile(&tls_ctx, tls_cert_profile);
1492 tls_ctx_restrict_ciphers(&tls_ctx, cipher_list);
1493
1494 if (tls_ctx.allowed_ciphers)
1495 {
1496 ciphers = tls_ctx.allowed_ciphers;
1497 }
1498
1499 while (*ciphers != 0)
1500 {
1501 printf("%s\n", mbedtls_ssl_get_ciphersuite_name(*ciphers));
1502 ciphers++;
1503 }
1504 tls_ctx_free(&tls_ctx);
1505}
1506
1507void
1509{
1510#if MBEDTLS_VERSION_NUMBER < 0x04000000
1511 const mbedtls_ecp_curve_info *pcurve = mbedtls_ecp_curve_list();
1512
1513 if (NULL == pcurve)
1514 {
1515 msg(M_FATAL, "Cannot retrieve curve list from mbed TLS");
1516 }
1517
1518 /* Print curve list */
1519 printf("Available Elliptic curves, listed in order of preference:\n\n");
1520 while (MBEDTLS_ECP_DP_NONE != pcurve->grp_id)
1521 {
1522 printf("%s\n", pcurve->name);
1523 pcurve++;
1524 }
1525#else
1526 msg(M_FATAL, "Mbed TLS 4 has no mechanism to list supported curves.");
1527#endif /* MBEDTLS_VERSION_NUMBER < 0x04000000 */
1528}
1529
1530const char *
1532{
1533 static char mbedtls_version[30];
1534 unsigned int pv = mbedtls_version_get_number();
1535 snprintf(mbedtls_version, sizeof(mbedtls_version), "mbed TLS %d.%d.%d", (pv >> 24) & 0xff,
1536 (pv >> 16) & 0xff, (pv >> 8) & 0xff);
1537 return mbedtls_version;
1538}
1539
1540void
1542{
1543 return; /* no external key provider in mbedTLS build */
1544}
1545
1546#endif /* defined(ENABLE_CRYPTO_MBEDTLS) */
char * string_alloc(const char *str, struct gc_arena *gc)
Definition buffer.c:648
#define BPTR(buf)
Definition buffer.h:123
#define ALLOC_ARRAY_CLEAR(dptr, type, n)
Definition buffer.h:1080
static int buf_forward_capacity(const struct buffer *buf)
Definition buffer.h:539
static void secure_memzero(void *data, size_t len)
Securely zeroise memory.
Definition buffer.h:414
#define BLEN(buf)
Definition buffer.h:126
static void gc_free(struct gc_arena *a)
Definition buffer.h:1025
#define ALLOC_OBJ_CLEAR(dptr, type)
Definition buffer.h:1064
static struct gc_arena gc_new(void)
Definition buffer.h:1017
uint64_t counter_type
Definition common.h:31
#define counter_format
Definition common.h:32
char * strsep(char **stringp, const char *delim)
const char * print_key_filename(const char *str, bool is_inline)
To be used when printing a string that may contain inline data.
Definition crypto.c:1279
int md_full(const char *mdname, const uint8_t *src, int src_len, uint8_t *dst)
Calculates the message digest for the given buffer.
#define mbed_ok(errval)
Check errval and log on error.
bool mbed_log_err(unsigned int flags, int errval, const char *prefix)
Log the supplied mbed TLS error, prefixed by supplied prefix.
mbedtls_ctr_drbg_context * rand_ctx_get(void)
Returns a singleton instance of the mbed TLS random number generator.
#define D_TLS_DEBUG_LOW
Definition errlevel.h:76
#define D_TLS_DEBUG_MED
Definition errlevel.h:156
#define D_HANDSHAKE_VERBOSE
Definition errlevel.h:155
#define D_HANDSHAKE
Definition errlevel.h:71
#define D_TLS_ERRORS
Definition errlevel.h:58
#define D_TLS_DEBUG
Definition errlevel.h:164
#define KS_PRIMARY
Primary key state index.
Definition ssl_common.h:464
int key_state_read_plaintext(struct key_state_ssl *ks_ssl, struct buffer *buf)
Extract plaintext data from the TLS module.
int key_state_write_ciphertext(struct key_state_ssl *ks_ssl, struct buffer *buf)
Insert a ciphertext buffer into the TLS module.
int key_state_read_ciphertext(struct key_state_ssl *ks_ssl, struct buffer *buf)
Extract ciphertext data from the TLS module.
int key_state_write_plaintext_const(struct key_state_ssl *ks_ssl, const uint8_t *data, int len)
Insert plaintext data into the TLS module.
int key_state_write_plaintext(struct key_state_ssl *ks_ssl, struct buffer *buf)
Insert a plaintext buffer into the TLS module.
int verify_callback(void *session_obj, mbedtls_x509_crt *cert, int cert_depth, uint32_t *flags)
Verify that the remote OpenVPN peer's certificate allows setting up a VPN tunnel.
static SERVICE_STATUS status
Definition interactive.c:51
void management_auth_failure(struct management *man, const char *type, const char *reason)
Definition manage.c:3103
char * management_query_pk_sig(struct management *man, const char *b64_data, const char *algorithm)
Definition manage.c:3764
mbedtls compatibility stub.
static int mbedtls_compat_pk_parse_key(mbedtls_pk_context *ctx, const unsigned char *key, size_t keylen, const unsigned char *pwd, size_t pwdlen)
static void mbedtls_compat_psa_crypto_init(void)
static int mbedtls_compat_pk_check_pair(const mbedtls_pk_context *pub, const mbedtls_pk_context *prv)
static int mbedtls_compat_pk_parse_keyfile(mbedtls_pk_context *ctx, const char *path, const char *password)
#define CLEAR(x)
Definition basic.h:32
#define M_FATAL
Definition error.h:90
#define dmsg(flags,...)
Definition error.h:172
#define msg(flags,...)
Definition error.h:152
#define ASSERT(x)
Definition error.h:219
#define M_WARN
Definition error.h:92
PKCS #11 SSL library-specific backend.
int openvpn_base64_decode(const char *str, void *data, int size)
Definition base64.c:160
int openvpn_base64_encode(const void *data, int size, char **str)
Definition base64.c:51
static struct user_pass passbuf
Definition ssl.c:245
int pem_password_callback(char *buf, int size, int rwflag, void *u)
Callback to retrieve the user's password.
Definition ssl.c:259
void load_xkey_provider(void)
Load ovpn.xkey provider used for external key signing.
Control Channel SSL library backend module.
void tls_ctx_set_tls_groups(struct tls_root_ctx *ctx, const char *groups)
Set the (elliptic curve) group allowed for signatures and key exchange.
void tls_ctx_free(struct tls_root_ctx *ctx)
Frees the library-specific TLSv1 context.
const char * get_ssl_library_version(void)
return a pointer to a static memory area containing the name and version number of the SSL library in...
bool key_state_export_keying_material(struct tls_session *session, const char *label, size_t label_size, void *ekm, size_t ekm_size)
Keying Material Exporters [RFC 5705] allows additional keying material to be derived from existing TL...
void show_available_tls_ciphers_list(const char *cipher_list, const char *tls_cert_profile, bool tls13)
Show the TLS ciphers that are available for us to use in the library depending on the TLS version.
void tls_ctx_server_new(struct tls_root_ctx *ctx)
Initialise a library-specific TLS context for a server.
void show_available_curves(void)
Show the available elliptic curves in the crypto library.
void key_state_ssl_free(struct key_state_ssl *ks_ssl)
Free the SSL channel part of the given key state.
#define TLS_VER_1_2
int tls_ctx_load_priv_file(struct tls_root_ctx *ctx, const char *priv_key_file, bool priv_key_file_inline)
Load private key file into the given TLS context.
void key_state_ssl_shutdown(struct key_state_ssl *ks_ssl)
Sets a TLS session to be shutdown state, so the TLS library will generate a shutdown alert.
void tls_ctx_load_extra_certs(struct tls_root_ctx *ctx, const char *extra_certs_file, bool extra_certs_file_inline)
Load extra certificate authority certificates from the given file or path.
void tls_ctx_check_cert_time(const struct tls_root_ctx *ctx)
Check our certificate notBefore and notAfter fields, and warn if the cert is either not yet valid or ...
void tls_ctx_restrict_ciphers_tls13(struct tls_root_ctx *ctx, const char *ciphers)
Restrict the list of ciphers that can be used within the TLS context for TLS 1.3 and higher.
int tls_ctx_load_pkcs12(struct tls_root_ctx *ctx, const char *pkcs12_file, bool pkcs12_file_inline, bool load_ca_file)
Load PKCS #12 file for key, cert and (optionally) CA certs, and add to library-specific TLS context.
bool tls_ctx_initialised(struct tls_root_ctx *ctx)
Checks whether the given TLS context is initialised.
void key_state_ssl_init(struct key_state_ssl *ks_ssl, const struct tls_root_ctx *ssl_ctx, bool is_server, struct tls_session *session)
Initialise the SSL channel part of the given key state.
void tls_free_lib(void)
Free any global SSL library-specific data structures.
Definition ssl_openssl.c:98
void tls_ctx_load_ecdh_params(struct tls_root_ctx *ctx, const char *curve_name)
Load Elliptic Curve Parameters, and load them into the library-specific TLS context.
#define TLS_VER_1_3
#define TLS_VER_UNSPEC
void tls_init_lib(void)
Perform any static initialisation necessary by the library.
Definition ssl_openssl.c:91
void print_details(struct key_state_ssl *ks_ssl, const char *prefix)
Print a one line summary of SSL/TLS session handshake.
int tls_version_max(void)
Return the maximum TLS version (as a TLS_VER_x constant) supported by current SSL implementation.
void backend_tls_ctx_reload_crl(struct tls_root_ctx *ssl_ctx, const char *crl_file, bool crl_inline)
Reload the Certificate Revocation List for the SSL channel.
void tls_ctx_restrict_ciphers(struct tls_root_ctx *ctx, const char *ciphers)
Restrict the list of ciphers that can be used within the TLS context for TLS 1.2 and below.
void tls_ctx_load_ca(struct tls_root_ctx *ctx, const char *ca_file, bool ca_file_inline, const char *ca_path, bool tls_server)
Load certificate authority certificates from the given file or path.
void tls_ctx_set_cert_profile(struct tls_root_ctx *ctx, const char *profile)
Set the TLS certificate profile.
int tls_ctx_use_management_external_key(struct tls_root_ctx *ctx)
Tell the management interface to load the given certificate and the external private key matching the...
void tls_ctx_load_cryptoapi(struct tls_root_ctx *ctx, const char *cryptoapi_cert)
Use Windows cryptoapi for key and cert, and add to library-specific TLS context.
bool tls_ctx_set_options(struct tls_root_ctx *ctx, unsigned int ssl_flags)
Set any library specific options.
void tls_ctx_load_dh_params(struct tls_root_ctx *ctx, const char *dh_file, bool dh_file_inline)
Load Diffie Hellman Parameters, and load them into the library-specific TLS context.
void tls_ctx_client_new(struct tls_root_ctx *ctx)
Initialises a library-specific TLS context for a client.
void tls_ctx_load_cert_file(struct tls_root_ctx *ctx, const char *cert_file, bool cert_file_inline)
Load certificate file into the given TLS context.
Control Channel Common Data Structures.
#define SSLF_TLS_VERSION_MAX_SHIFT
Definition ssl_common.h:431
#define UP_TYPE_PRIVATE_KEY
Definition ssl_common.h:42
#define SSLF_CLIENT_CERT_OPTIONAL
Definition ssl_common.h:424
#define SSLF_CLIENT_CERT_NOT_REQUIRED
Definition ssl_common.h:423
#define SSLF_TLS_DEBUG_ENABLED
Definition ssl_common.h:433
#define SSLF_TLS_VERSION_MAX_MASK
Definition ssl_common.h:432
#define SSLF_TLS_VERSION_MIN_SHIFT
Definition ssl_common.h:429
#define SSLF_TLS_VERSION_MIN_MASK
Definition ssl_common.h:430
int tls_ctx_use_external_signing_func(struct tls_root_ctx *ctx, external_sign_func sign_func, void *sign_ctx)
Call the supplied signing function to create a TLS signature during the TLS handshake.
bool(* external_sign_func)(void *sign_ctx, const void *src, size_t src_size, void *dst, size_t dst_size)
External signing function prototype.
Definition ssl_mbedtls.h:77
int get_num_elements(const char *string, char delimiter)
Returns the occurrences of 'delimiter' in a string +1 This is typically used to find out the number e...
Definition ssl_util.c:294
const tls_cipher_name_pair * tls_get_cipher_name_pair(const char *cipher_name, size_t len)
Definition ssl_util.c:275
SSL utility functions.
Control Channel Verification Module mbed TLS backend.
size_t length
Definition ssl_mbedtls.h:46
uint8_t * data
Definition ssl_mbedtls.h:47
buffer_entry * next_block
Definition ssl_mbedtls.h:48
endless_buffer out
Definition ssl_mbedtls.h:61
endless_buffer in
Definition ssl_mbedtls.h:60
Definition buffer.h:1119
Wrapper structure for dynamically allocated memory.
Definition buffer.h:60
int len
Length in bytes of the actual content within the allocated memory.
Definition buffer.h:65
size_t data_start
Definition ssl_mbedtls.h:53
buffer_entry * first_block
Definition ssl_mbedtls.h:54
buffer_entry * last_block
Definition ssl_mbedtls.h:55
Context used by external_pkcs1_sign()
Definition ssl_mbedtls.h:82
external_sign_func sign
Definition ssl_mbedtls.h:84
size_t signature_length
Definition ssl_mbedtls.h:83
Garbage collection arena used to keep track of dynamically allocated memory.
Definition buffer.h:116
Definition list.h:53
bio_ctx * bio_ctx
mbedtls_ssl_config * ssl_config
mbedTLS global ssl config
mbedtls_ssl_context * ctx
mbedTLS connection context
struct tls_key_cache tls_key_cache
Get a tls_cipher_name_pair containing OpenSSL and IANA names for supplied TLS cipher name.
Definition ssl_util.h:77
const char * iana_name
Definition ssl_util.h:79
const char * openssl_name
Definition ssl_util.h:78
struct to cache TLS secrets for keying material exporter (RFC 5705).
Definition ssl_mbedtls.h:96
unsigned char master_secret[48]
Definition ssl_mbedtls.h:99
mbedtls_tls_prf_types tls_prf_type
Definition ssl_mbedtls.h:98
unsigned char client_server_random[64]
Definition ssl_mbedtls.h:97
Structure that wraps the TLS context.
mbedtls_x509_crl * crl
Certificate Revocation List.
mbedtls_x509_crt * crt_chain
Local Certificate chain.
uint16_t * groups
List of allowed groups for this connection.
mbedtls_x509_crt * ca_chain
CA chain for remote verification.
int * allowed_ciphers
List of allowed ciphers for this connection.
mbedtls_dhm_context * dhm_ctx
Diffie-Helmann-Merkle context.
mbedtls_x509_crt_profile cert_profile
Allowed certificate types.
bool initialised
True if the context has been initialised.
int endpoint
Whether or not this is a server or a client.
struct external_context external_key
External key context.
mbedtls_pk_context * priv_key
Local private key.
Security parameter state of a single session within a VPN tunnel.
Definition ssl_common.h:489
static int cleanup(void **state)
struct gc_arena gc
Definition test_ssl.c:131