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