1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
|
//
// Copyright 2025 Staysail Systems, Inc. <info@staysail.tech>
// Copyright 2018 Capitar IT Group BV <info@capitar.com>
// Copyright 2019 Devolutions <info@devolutions.net>
//
// This software is supplied under the terms of the MIT License, a
// copy of which should be located in the distribution where this
// file was obtained (LICENSE.txt). A copy of the license may also be
// found online at https://opensource.org/licenses/MIT.
//
#include <stdbool.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "nng/nng.h"
#include "../../../core/nng_impl.h"
#include "../tls_engine.h"
#include <mbedtls/version.h> // Must be first in order to pick up version
#include <mbedtls/error.h>
#ifdef MBEDTLS_PSA_CRYPTO_C
#include <psa/crypto.h>
#endif
// We use a common cookie for our application.
#include <mbedtls/ssl_cookie.h>
// mbedTLS renamed this header for 2.4.0.
#if MBEDTLS_VERSION_MAJOR > 2 || MBEDTLS_VERSION_MINOR >= 4
#include <mbedtls/net_sockets.h>
#else
#include <mbedtls/net.h>
#endif
#include <mbedtls/debug.h>
#include <mbedtls/ssl.h>
// pair holds a private key and the associated certificate.
typedef struct {
mbedtls_x509_crt crt;
mbedtls_pk_context key;
nni_list_node node;
} pair;
// psk holds an identity and preshared key
typedef struct {
// NB: Technically RFC 4279 requires this be UTF-8 string, although
// others suggest making it opaque bytes. We treat it as a C string,
// so we cannot support embedded zero bytes.
char *identity;
uint8_t *key;
size_t keylen;
nni_list_node node;
} psk;
static void
psk_free(psk *p)
{
if (p != NULL) {
NNI_ASSERT(!nni_list_node_active(&p->node));
if (p->identity != NULL) {
nni_strfree(p->identity);
p->identity = NULL;
}
if (p->key != NULL && p->keylen != 0) {
nni_free(p->key, p->keylen);
p->key = NULL;
p->keylen = 0;
}
NNI_FREE_STRUCT(p);
}
}
struct nng_tls_engine_cert {
mbedtls_x509_crt crt;
char subject[1024];
char issuer[1024];
char last_alt[256];
char serial[64]; // 20 bytes per RFC, x 3 for display
char cn[65]; // 64 + null
int next_alt;
};
struct nng_tls_engine_conn {
void *tls; // parent conn
mbedtls_ssl_context ctx;
nng_time exp1;
nng_time exp2;
};
struct nng_tls_engine_config {
mbedtls_ssl_config cfg_ctx;
char *server_name;
mbedtls_x509_crt ca_certs;
mbedtls_x509_crl crl;
int min_ver;
int max_ver;
nng_tls_mode mode;
nni_list pairs;
nni_list psks;
};
static mbedtls_ssl_cookie_ctx mbed_ssl_cookie_ctx;
static void
tls_dbg(void *ctx, int level, const char *file, int line, const char *s)
{
NNI_ARG_UNUSED(ctx);
NNI_ARG_UNUSED(level);
const char *f;
while ((f = strchr(file, '/')) != NULL) {
file = f + 1;
}
nng_log_debug("MBED", "%s: %d: %s", file, line, s);
}
static int
tls_get_entropy(void *arg, unsigned char *buf, size_t len)
{
NNI_ARG_UNUSED(arg);
while (len) {
uint32_t x = nni_random();
size_t n;
n = len < sizeof(x) ? len : sizeof(x);
memcpy(buf, &x, n);
len -= n;
buf += n;
}
return (0);
}
static int
tls_random(void *arg, unsigned char *buf, size_t sz)
{
return (tls_get_entropy(arg, buf, sz));
}
static void
tls_log_err(const char *msgid, const char *context, int errnum)
{
char errbuf[256];
mbedtls_strerror(errnum, errbuf, sizeof(errbuf));
nng_log_err(msgid, "%s: %s", context, errbuf);
}
static void
tls_log_warn(const char *msgid, const char *context, int errnum)
{
char errbuf[256];
mbedtls_strerror(errnum, errbuf, sizeof(errbuf));
nng_log_warn(msgid, "%s: %d - %s", context, errnum, errbuf);
}
static void
tls_log_debug(const char *msgid, const char *context, int errnum)
{
char errbuf[256];
mbedtls_strerror(errnum, errbuf, sizeof(errbuf));
nng_log_debug(msgid, "%s: %d - %s", context, errnum, errbuf);
}
// tls_mk_err converts an mbed error to an NNG error.
static struct {
int tls;
int nng;
} tls_errs[] = {
#ifdef MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE
{ MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE, NNG_EPEERAUTH },
#endif
#ifdef MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED
{ MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED, NNG_EPEERAUTH },
#endif
#ifdef MBEDTLS_ERR_SSL_PEER_VERIFY_FAILED
{ MBEDTLS_ERR_SSL_PEER_VERIFY_FAILED, NNG_EPEERAUTH },
#endif
#ifdef MBEDTLS_ERR_SSL_NO_USABLE_CIPHERSUITE
{ MBEDTLS_ERR_SSL_NO_USABLE_CIPHERSUITE, NNG_EPEERAUTH },
#endif
{ MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY, NNG_ECLOSED },
{ MBEDTLS_ERR_SSL_ALLOC_FAILED, NNG_ENOMEM },
{ MBEDTLS_ERR_SSL_TIMEOUT, NNG_ETIMEDOUT },
{ MBEDTLS_ERR_SSL_CONN_EOF, NNG_ECLOSED },
// MbedTLS 3.0 error codes
#ifdef MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE
{ MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE, NNG_EPEERAUTH },
#endif
#ifdef MBEDTLS_ERR_SSL_BAD_CERTIFICATE
{ MBEDTLS_ERR_SSL_BAD_CERTIFICATE, NNG_EPEERAUTH },
#endif
// terminator
{ 0, 0 },
};
static int
tls_mk_err(int err)
{
for (int i = 0; tls_errs[i].tls != 0; i++) {
if (tls_errs[i].tls == err) {
return (tls_errs[i].nng);
}
}
return (NNG_ECRYPTO);
}
static int
net_send(void *tls, const unsigned char *buf, size_t len)
{
size_t sz = len;
int rv;
rv = nng_tls_engine_send(tls, buf, &sz);
switch (rv) {
case 0:
return ((int) sz);
case NNG_EAGAIN:
return (MBEDTLS_ERR_SSL_WANT_WRITE);
default:
return (MBEDTLS_ERR_NET_SEND_FAILED);
}
}
static int
net_recv(void *tls, unsigned char *buf, size_t len)
{
size_t sz = len;
int rv;
rv = nng_tls_engine_recv(tls, buf, &sz);
switch (rv) {
case 0:
return ((int) sz);
case NNG_EAGAIN:
return (MBEDTLS_ERR_SSL_WANT_READ);
default:
return (MBEDTLS_ERR_NET_RECV_FAILED);
}
}
static void
conn_fini(nng_tls_engine_conn *ec)
{
mbedtls_ssl_free(&ec->ctx);
}
static void
conn_set_timer(void *arg, unsigned int t1, unsigned int t2)
{
nng_time now = nng_clock();
nng_tls_engine_conn *ec = arg;
ec->exp1 = t1 ? now + t1 : 0;
ec->exp2 = t2 ? now + t2 : 0;
}
static int
conn_get_timer(void *arg)
{
nng_tls_engine_conn *ec = arg;
nng_time now = nng_clock();
if (ec->exp2 == 0) {
return -1;
}
if (now > ec->exp2) {
return 2;
}
if (now > ec->exp1) {
return 1;
}
return (0);
}
static int
conn_init(nng_tls_engine_conn *ec, void *tls, nng_tls_engine_config *cfg,
const nng_sockaddr *sa)
{
int rv;
char buf[NNG_MAXADDRSTRLEN];
ec->tls = tls;
mbedtls_ssl_init(&ec->ctx);
mbedtls_ssl_set_bio(&ec->ctx, tls, net_send, net_recv, NULL);
mbedtls_ssl_set_timer_cb(&ec->ctx, ec, conn_set_timer, conn_get_timer);
if ((rv = mbedtls_ssl_setup(&ec->ctx, &cfg->cfg_ctx)) != 0) {
tls_log_warn(
"NNG-TLS-CONN-FAIL", "Failed to setup TLS connection", rv);
return (tls_mk_err(rv));
}
mbedtls_ssl_set_hostname(&ec->ctx, cfg->server_name);
if (cfg->mode == NNG_TLS_MODE_SERVER) {
nng_str_sockaddr(sa, buf, sizeof(buf));
mbedtls_ssl_set_client_transport_id(
&ec->ctx, (const void *) buf, strlen(buf));
}
return (0);
}
static void
conn_close(nng_tls_engine_conn *ec)
{
// This may succeed, or it may fail. Either way we
// don't care. Implementations that depend on
// close-notify to mean anything are broken by design,
// just like RFC. Note that we do *NOT* close the TCP
// connection at this point.
(void) mbedtls_ssl_close_notify(&ec->ctx);
}
static int
conn_recv(nng_tls_engine_conn *ec, uint8_t *buf, size_t *szp)
{
int rv;
if ((rv = mbedtls_ssl_read(&ec->ctx, buf, *szp)) < 0) {
switch (rv) {
case MBEDTLS_ERR_SSL_WANT_READ:
case MBEDTLS_ERR_SSL_WANT_WRITE:
return (NNG_EAGAIN);
default:
return (tls_mk_err(rv));
}
}
*szp = (size_t) rv;
return (0);
}
static int
conn_send(nng_tls_engine_conn *ec, const uint8_t *buf, size_t *szp)
{
int rv;
if ((rv = mbedtls_ssl_write(&ec->ctx, buf, *szp)) < 0) {
switch (rv) {
case MBEDTLS_ERR_SSL_WANT_READ:
case MBEDTLS_ERR_SSL_WANT_WRITE:
return (NNG_EAGAIN);
default:
return (tls_mk_err(rv));
}
}
*szp = (size_t) rv;
return (0);
}
static int
conn_handshake(nng_tls_engine_conn *ec)
{
int rv;
rv = mbedtls_ssl_handshake(&ec->ctx);
switch (rv) {
case MBEDTLS_ERR_SSL_WANT_WRITE:
case MBEDTLS_ERR_SSL_WANT_READ:
// We have underlying I/O to complete first. We will
// be called again by a callback later.
return (NNG_EAGAIN);
case 0:
// The handshake is done, yay!
return (0);
default:
// only at debug, because its too noisy otherwise (the crypto
// failure will still show up)
tls_log_debug("NNG-TLS-HANDSHAKE", "TLS handshake failed", rv);
return (tls_mk_err(rv));
}
}
static bool
conn_verified(nng_tls_engine_conn *ec)
{
return (mbedtls_ssl_get_verify_result(&ec->ctx) == 0);
}
static nng_err
conn_peer_cert(nng_tls_engine_conn *ec, nng_tls_engine_cert **certp)
{
nng_tls_engine_cert *cert;
const mbedtls_x509_crt *crt = mbedtls_ssl_get_peer_cert(&ec->ctx);
if (crt == NULL) {
return (NNG_ENOENT);
}
if ((cert = nni_zalloc(sizeof(*cert))) == NULL) {
return (NNG_ENOMEM);
}
// In order to ensure that we get our *own* copy that might outlive the
// cert buffer from the connection, we do a parse.
mbedtls_x509_crt_parse(&cert->crt, crt->raw.p, crt->raw.len);
*certp = cert;
return (NNG_OK);
}
static char *
conn_peer_cn(nng_tls_engine_conn *ec)
{
const mbedtls_x509_crt *crt = mbedtls_ssl_get_peer_cert(&ec->ctx);
if (crt == NULL) {
return (NULL);
}
char buf[0x400];
int len = mbedtls_x509_dn_gets(buf, sizeof(buf), &crt->subject);
if (len <= 0) {
return (NULL);
}
const char *pos = strstr(buf, "CN=");
if (!pos) {
return (NULL);
}
pos += 3;
len -= (int) (pos - buf - 1);
if (len <= 1) {
return (NULL);
}
char *rv = malloc(len);
memcpy(rv, pos, len);
return (rv);
}
static void
config_fini(nng_tls_engine_config *cfg)
{
pair *p;
psk *psk;
mbedtls_ssl_config_free(&cfg->cfg_ctx);
mbedtls_x509_crt_free(&cfg->ca_certs);
mbedtls_x509_crl_free(&cfg->crl);
if (cfg->server_name) {
nni_strfree(cfg->server_name);
}
while ((p = nni_list_first(&cfg->pairs)) != NULL) {
nni_list_remove(&cfg->pairs, p);
mbedtls_x509_crt_free(&p->crt);
mbedtls_pk_free(&p->key);
NNI_FREE_STRUCT(p);
}
while ((psk = nni_list_first(&cfg->psks)) != NULL) {
nni_list_remove(&cfg->psks, psk);
psk_free(psk);
}
}
static int
config_init(nng_tls_engine_config *cfg, enum nng_tls_mode mode)
{
int rv;
int ssl_mode;
int auth_mode;
if (mode == NNG_TLS_MODE_SERVER) {
ssl_mode = MBEDTLS_SSL_IS_SERVER;
auth_mode = MBEDTLS_SSL_VERIFY_NONE;
} else {
ssl_mode = MBEDTLS_SSL_IS_CLIENT;
auth_mode = MBEDTLS_SSL_VERIFY_REQUIRED;
}
cfg->mode = mode;
NNI_LIST_INIT(&cfg->pairs, pair, node);
NNI_LIST_INIT(&cfg->psks, psk, node);
mbedtls_ssl_config_init(&cfg->cfg_ctx);
mbedtls_x509_crt_init(&cfg->ca_certs);
mbedtls_x509_crl_init(&cfg->crl);
rv = mbedtls_ssl_config_defaults(&cfg->cfg_ctx, ssl_mode,
MBEDTLS_SSL_TRANSPORT_STREAM, MBEDTLS_SSL_PRESET_DEFAULT);
if (rv != 0) {
tls_log_err("NNG-TLS-CONFIG-INIT-FAIL",
"Failed to initialize TLS configuration", rv);
config_fini(cfg);
return (tls_mk_err(rv));
}
mbedtls_ssl_conf_authmode(&cfg->cfg_ctx, auth_mode);
// We *require* TLS v1.2 or newer, which is also known as SSL
// v3.3.
cfg->min_ver = MBEDTLS_SSL_MINOR_VERSION_3;
#ifdef MBEDTLS_SSL_PROTO_TLS1_3
cfg->max_ver = MBEDTLS_SSL_MINOR_VERSION_4;
#else
cfg->max_ver = MBEDTLS_SSL_MINOR_VERSION_3;
#endif
mbedtls_ssl_conf_min_version(
&cfg->cfg_ctx, MBEDTLS_SSL_MAJOR_VERSION_3, cfg->min_ver);
mbedtls_ssl_conf_max_version(
&cfg->cfg_ctx, MBEDTLS_SSL_MAJOR_VERSION_3, cfg->max_ver);
mbedtls_ssl_conf_rng(&cfg->cfg_ctx, tls_random, cfg);
mbedtls_ssl_conf_dbg(&cfg->cfg_ctx, tls_dbg, cfg);
if (cfg->mode == NNG_TLS_MODE_SERVER) {
mbedtls_ssl_conf_dtls_cookies(&cfg->cfg_ctx,
mbedtls_ssl_cookie_write, mbedtls_ssl_cookie_check,
&mbed_ssl_cookie_ctx);
}
return (0);
}
static int
config_server_name(nng_tls_engine_config *cfg, const char *name)
{
char *dup = NULL;
if (name != NULL && ((dup = nni_strdup(name)) == NULL)) {
return (NNG_ENOMEM);
}
if (cfg->server_name != NULL) {
nni_strfree(cfg->server_name);
}
cfg->server_name = dup;
return (0);
}
// callback used on the server side to select the right key
static int
config_psk_cb(void *arg, mbedtls_ssl_context *ssl,
const unsigned char *identity, size_t id_len)
{
nng_tls_engine_config *cfg = arg;
psk *psk;
NNI_LIST_FOREACH (&cfg->psks, psk) {
if (id_len == strlen(psk->identity) &&
(memcmp(identity, psk->identity, id_len) == 0)) {
nng_log_debug("NNG-TLS-PSK-IDENTITY",
"TLS client using PSK identity %s", psk->identity);
return (mbedtls_ssl_set_hs_psk(
ssl, psk->key, psk->keylen));
}
}
nng_log_warn(
"NNG-TLS-PSK-NO-IDENTITY", "TLS client PSK identity not found");
return (MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY);
}
static int
config_psk(nng_tls_engine_config *cfg, const char *identity,
const uint8_t *key, size_t key_len)
{
int rv;
psk *srch;
psk *newpsk;
if (((newpsk = NNI_ALLOC_STRUCT(newpsk)) == NULL) ||
((newpsk->identity = nni_strdup(identity)) == NULL) ||
((newpsk->key = nni_alloc(key_len)) == NULL)) {
psk_free(newpsk);
return (NNG_ENOMEM);
}
newpsk->keylen = key_len;
memcpy(newpsk->key, key, key_len);
if (cfg->mode == NNG_TLS_MODE_SERVER) {
if (nni_list_empty(&cfg->psks)) {
mbedtls_ssl_conf_psk_cb(
&cfg->cfg_ctx, config_psk_cb, cfg);
}
} else {
if ((rv = mbedtls_ssl_conf_psk(&cfg->cfg_ctx, key, key_len,
(const unsigned char *) identity,
strlen(identity))) != 0) {
psk_free(newpsk);
tls_log_err("NNG-TLS-PSK-FAIL",
"Failed to configure PSK identity", rv);
return (tls_mk_err(rv));
}
}
// If the identity was previously configured, replace it.
// The rule here is that last one wins, so we always append.
NNI_LIST_FOREACH (&cfg->psks, srch) {
if (strcmp(srch->identity, identity) == 0) {
nni_list_remove(&cfg->psks, srch);
psk_free(srch);
break;
}
}
nni_list_append(&cfg->psks, newpsk);
return (0);
}
static int
config_auth_mode(nng_tls_engine_config *cfg, nng_tls_auth_mode mode)
{
switch (mode) {
case NNG_TLS_AUTH_MODE_NONE:
mbedtls_ssl_conf_authmode(
&cfg->cfg_ctx, MBEDTLS_SSL_VERIFY_NONE);
return (0);
case NNG_TLS_AUTH_MODE_OPTIONAL:
mbedtls_ssl_conf_authmode(
&cfg->cfg_ctx, MBEDTLS_SSL_VERIFY_OPTIONAL);
return (0);
case NNG_TLS_AUTH_MODE_REQUIRED:
mbedtls_ssl_conf_authmode(
&cfg->cfg_ctx, MBEDTLS_SSL_VERIFY_REQUIRED);
return (0);
}
return (NNG_EINVAL);
}
static int
config_ca_chain(nng_tls_engine_config *cfg, const char *certs, const char *crl)
{
size_t len;
const uint8_t *pem;
int rv;
// Certs and CRL are in PEM data, with terminating NUL byte.
pem = (const uint8_t *) certs;
len = strlen(certs) + 1;
if ((rv = mbedtls_x509_crt_parse(&cfg->ca_certs, pem, len)) != 0) {
tls_log_err("NNG-TLS-CA-FAIL",
"Failed to parse CA certificate(s)", rv);
return (tls_mk_err(rv));
}
if (crl != NULL) {
pem = (const uint8_t *) crl;
len = strlen(crl) + 1;
if ((rv = mbedtls_x509_crl_parse(&cfg->crl, pem, len)) != 0) {
tls_log_err("NNG-TLS-CRL-FAIL",
"Failed to parse revocation list", rv);
return (tls_mk_err(rv));
}
}
mbedtls_ssl_conf_ca_chain(&cfg->cfg_ctx, &cfg->ca_certs, &cfg->crl);
return (0);
}
static int
config_own_cert(nng_tls_engine_config *cfg, const char *cert, const char *key,
const char *pass)
{
size_t len;
const uint8_t *pem;
pair *p;
int rv;
if ((p = NNI_ALLOC_STRUCT(p)) == NULL) {
return (NNG_ENOMEM);
}
mbedtls_x509_crt_init(&p->crt);
mbedtls_pk_init(&p->key);
pem = (const uint8_t *) cert;
len = strlen(cert) + 1;
if ((rv = mbedtls_x509_crt_parse(&p->crt, pem, len)) != 0) {
tls_log_err("NNG-TLS-CRT-FAIL",
"Failure parsing our own certificate", rv);
rv = tls_mk_err(rv);
goto err;
}
pem = (const uint8_t *) key;
len = strlen(key) + 1;
#if MBEDTLS_VERSION_MAJOR < 3
rv = mbedtls_pk_parse_key(&p->key, pem, len, (const uint8_t *) pass,
pass != NULL ? strlen(pass) : 0);
#else
rv = mbedtls_pk_parse_key(&p->key, pem, len, (const uint8_t *) pass,
pass != NULL ? strlen(pass) : 0, tls_random, NULL);
#endif
if (rv != 0) {
tls_log_err("NNG-TLS-KEY", "Failure parsing private key", rv);
rv = tls_mk_err(rv);
goto err;
}
rv = mbedtls_ssl_conf_own_cert(&cfg->cfg_ctx, &p->crt, &p->key);
if (rv != 0) {
tls_log_err("NNG-TLS-SELF",
"Failure configuring self certificate", rv);
rv = tls_mk_err(rv);
goto err;
}
// Save this structure so we can free it with the context.
nni_list_append(&cfg->pairs, p);
return (0);
err:
mbedtls_x509_crt_free(&p->crt);
mbedtls_pk_free(&p->key);
NNI_FREE_STRUCT(p);
return (rv);
}
static void
cert_fini(nng_tls_engine_cert *crt)
{
mbedtls_x509_crt_free(&crt->crt);
nni_free(crt, sizeof(*crt));
}
static nng_err
cert_parse_der(nng_tls_engine_cert **crtp, const uint8_t *der, size_t size)
{
nng_tls_engine_cert *cert;
int rv;
if ((cert = nni_zalloc(sizeof(*cert))) == NULL) {
return (NNG_ENOMEM);
}
mbedtls_x509_crt_init(&cert->crt);
if ((rv = mbedtls_x509_crt_parse_der(&cert->crt, der, size)) != 0) {
tls_log_err(
"NNG-TLS-DER", "Failure parsing DER certificate", rv);
rv = tls_mk_err(rv);
cert_fini(cert);
return (rv);
}
*crtp = cert;
return (NNG_OK);
}
static nng_err
cert_parse_pem(nng_tls_engine_cert **crtp, const char *pem, size_t size)
{
nng_tls_engine_cert *cert;
int rv;
if ((cert = nni_zalloc(sizeof(*cert))) == NULL) {
return (NNG_ENOMEM);
}
mbedtls_x509_crt_init(&cert->crt);
if ((rv = mbedtls_x509_crt_parse(
&cert->crt, (const uint8_t *) pem, size)) != 0) {
tls_log_err(
"NNG-TLS-PEM", "Failure parsing PEM certificate", rv);
rv = tls_mk_err(rv);
cert_fini(cert);
return (rv);
}
*crtp = cert;
return (NNG_OK);
}
static nng_err
cert_get_der(nng_tls_engine_cert *crt, uint8_t *buf, size_t *sizep)
{
if (*sizep < crt->crt.raw.len) {
*sizep = crt->crt.raw.len;
return (NNG_ENOSPC);
}
*sizep = crt->crt.raw.len;
memcpy(buf, crt->crt.raw.p, *sizep);
return (NNG_OK);
}
static nng_err
cert_subject(nng_tls_engine_cert *crt, char **namep)
{
if (crt->subject[0] != 0) {
*namep = (char *) &crt->subject[0];
return (NNG_OK);
}
int len = mbedtls_x509_dn_gets(
crt->subject, sizeof(crt->subject), &crt->crt.subject);
if (len <= 0) {
return (NNG_ENOTSUP);
}
*namep = &crt->subject[0];
return (NNG_OK);
}
static nng_err
cert_issuer(nng_tls_engine_cert *crt, char **namep)
{
if (crt->issuer[0] != 0) {
*namep = (char *) &crt->issuer[0];
return (NNG_OK);
}
int len = mbedtls_x509_dn_gets(
crt->issuer, sizeof(crt->issuer), &crt->crt.issuer);
if (len <= 0) {
return (NNG_ENOTSUP);
}
*namep = &crt->issuer[0];
return (NNG_OK);
}
static nng_err
cert_serial(nng_tls_engine_cert *crt, char **namep)
{
if (crt->serial[0] != 0) {
*namep = (char *) &crt->serial[0];
return (NNG_OK);
}
int len = mbedtls_x509_serial_gets(
crt->serial, sizeof(crt->serial), &crt->crt.serial);
if (len < 0) {
return (tls_mk_err(len));
}
*namep = &crt->serial[0];
return (NNG_OK);
}
static nng_err
cert_subject_cn(nng_tls_engine_cert *crt, char **namep)
{
nng_err rv;
char *subject;
char *s;
if (crt->cn[0] != 0) {
*namep = (char *) &crt->cn[0];
return (NNG_OK);
}
if ((rv = cert_subject(crt, &subject)) != NNG_OK) {
return (rv);
}
if ((s = strstr(crt->subject, "CN=")) == NULL) {
return (NNG_ENOENT);
}
s += 3;
int n = 0;
bool esc = false;
while (n < 64) {
if (*s == 0) {
crt->cn[n++] = 0;
break;
}
if (esc) {
esc = false;
crt->cn[n++] = *s++;
} else if (*s == '\\') {
esc = true;
} else if (*s == ',') {
crt->cn[n++] = 0;
break;
} else {
crt->cn[n++] = *s++;
}
}
if ((n == 0) || (n > 64)) {
nng_log_warn(
"NNG-TLS-CN", "X.509 Subject CN length is invalid");
return (NNG_EINVAL);
}
*namep = (char *) &crt->cn[0];
return (0);
}
static nng_err
cert_next_alt(nng_tls_engine_cert *crt, char **namep)
{
const mbedtls_asn1_sequence *seq = &crt->crt.subject_alt_names;
// get count
int count = 0;
for (seq = &crt->crt.subject_alt_names; seq != NULL; seq = seq->next) {
if (seq->buf.len == 0) {
continue;
}
if (count == crt->next_alt) {
break;
}
count++;
}
if (seq == NULL) {
return (NNG_ENOENT);
}
crt->next_alt++;
if (seq->buf.len >= sizeof(crt->last_alt)) {
return (NNG_EINVAL);
}
memcpy(crt->last_alt, seq->buf.p, seq->buf.len);
crt->last_alt[seq->buf.len] = 0;
*namep = crt->last_alt;
return (NNG_OK);
}
static void
mbed_time_to_tm(mbedtls_x509_time *mt, struct tm *tmp)
{
memset(tmp, 0, sizeof(*tmp)); // also clears any zone offset, etc
if (mt->year < 100) {
// all dates > Y2K, relative to 1900
tmp->tm_year = mt->year + 100;
} else {
tmp->tm_year = mt->year - 1900;
}
tmp->tm_mon = mt->mon - 1; // month is zero based
tmp->tm_mday = mt->day;
tmp->tm_hour = mt->hour;
tmp->tm_min = mt->min;
tmp->tm_sec = mt->sec;
// canonicalize the time
(void) mktime(tmp);
}
static nng_err
cert_not_before(nng_tls_engine_cert *cert, struct tm *tmp)
{
mbed_time_to_tm(&cert->crt.valid_from, tmp);
return (NNG_OK);
}
static nng_err
cert_not_after(nng_tls_engine_cert *cert, struct tm *tmp)
{
mbed_time_to_tm(&cert->crt.valid_to, tmp);
return (NNG_OK);
}
static int
config_version(nng_tls_engine_config *cfg, nng_tls_version min_ver,
nng_tls_version max_ver)
{
int v1, v2;
int maj = MBEDTLS_SSL_MAJOR_VERSION_3;
if (min_ver > max_ver) {
nng_log_err("TLS-CFG-VER",
"TLS maximum version must be larger than mimumum version");
return (NNG_ENOTSUP);
}
switch (min_ver) {
#ifdef MBEDTLS_SSL_MINOR_VERSION_3
case NNG_TLS_1_2:
v1 = MBEDTLS_SSL_MINOR_VERSION_3;
break;
#endif
#ifdef MBEDTLS_SSL_PROTO_TLS1_3
case NNG_TLS_1_3:
v1 = MBEDTLS_SSL_MINOR_VERSION_4;
break;
#endif
default:
nng_log_err(
"TLS-CFG-VER", "TLS minimum version not supported");
return (NNG_ENOTSUP);
}
switch (max_ver) {
#ifdef MBEDTLS_SSL_MINOR_VERSION_3
case NNG_TLS_1_2:
v2 = MBEDTLS_SSL_MINOR_VERSION_3;
break;
#endif
case NNG_TLS_1_3: // We lack support for 1.3, so treat as 1.2.
#ifdef MBEDTLS_SSL_PROTO_TLS1_3
v2 = MBEDTLS_SSL_MINOR_VERSION_4;
#else
v2 = MBEDTLS_SSL_MINOR_VERSION_3;
#endif
break;
default:
// Note that this means that if we ever TLS 1.4 or 2.0,
// then this will break. That's sufficiently far out
// to justify not worrying about it.
nng_log_err(
"TLS-CFG-VER", "TLS maximum version not supported");
return (NNG_ENOTSUP);
}
cfg->min_ver = v1;
cfg->max_ver = v2;
mbedtls_ssl_conf_min_version(&cfg->cfg_ctx, maj, cfg->min_ver);
mbedtls_ssl_conf_max_version(&cfg->cfg_ctx, maj, cfg->max_ver);
return (0);
}
static nng_err
tls_engine_init(void)
{
int rv;
#ifdef MBEDTLS_PSA_CRYPTO_C
rv = psa_crypto_init();
if (rv != 0) {
tls_log_err(
"NNG-TLS-INIT", "Failed initializing PSA crypto", rv);
return (tls_mk_err(rv));
}
#endif
// Uncomment the following to have noisy debug from mbedTLS.
// This may be useful when trying to debug failures.
// mbedtls_debug_set_threshold(9);
mbedtls_ssl_cookie_init(&mbed_ssl_cookie_ctx);
rv = mbedtls_ssl_cookie_setup(&mbed_ssl_cookie_ctx, tls_random, NULL);
if (rv != 0) {
tls_log_err("NNG_TLS_INIT",
"Failed initializing SSL cookie system", rv);
return (tls_mk_err(rv));
}
return (NNG_OK);
}
static void
tls_engine_fini(void)
{
mbedtls_ssl_cookie_free(&mbed_ssl_cookie_ctx);
#ifdef MBEDTLS_PSA_CRYPTO_C
mbedtls_psa_crypto_free();
#endif
}
static bool
fips_mode(void)
{
return (false);
}
static nng_tls_engine_config_ops config_ops = {
.init = config_init,
.fini = config_fini,
.size = sizeof(nng_tls_engine_config),
.auth = config_auth_mode,
.ca_chain = config_ca_chain,
.own_cert = config_own_cert,
.server = config_server_name,
.psk = config_psk,
.version = config_version,
};
static nng_tls_engine_conn_ops conn_ops = {
.size = sizeof(nng_tls_engine_conn),
.init = conn_init,
.fini = conn_fini,
.close = conn_close,
.recv = conn_recv,
.send = conn_send,
.handshake = conn_handshake,
.verified = conn_verified,
.peer_cert = conn_peer_cert,
.peer_cn = conn_peer_cn,
};
static nng_tls_engine_cert_ops cert_ops = {
.fini = cert_fini,
.parse_der = cert_parse_der,
.parse_pem = cert_parse_pem,
.get_der = cert_get_der,
.subject = cert_subject,
.issuer = cert_issuer,
.serial_number = cert_serial,
.subject_cn = cert_subject_cn,
.next_alt_name = cert_next_alt,
.not_before = cert_not_before,
.not_after = cert_not_after,
};
nng_tls_engine nng_tls_engine_ops = {
.version = NNG_TLS_ENGINE_VERSION,
.config_ops = &config_ops,
.conn_ops = &conn_ops,
.cert_ops = &cert_ops,
.name = "mbed",
.description = MBEDTLS_VERSION_STRING_FULL,
.init = tls_engine_init,
.fini = tls_engine_fini,
.fips_mode = fips_mode,
};
|