2 * ustream-ssl - library for SSL over ustream
4 * Copyright (C) 2012 Felix Fietkau <nbd@openwrt.org>
6 * Permission to use, copy, modify, and/or distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19 #include <sys/types.h>
20 #include <sys/random.h>
26 #include "ustream-ssl.h"
27 #include "ustream-internal.h"
28 #include <psa/crypto.h>
29 #include <mbedtls/debug.h>
31 static void debug_cb(void *ctx_p
, int level
,
32 const char *file
, int line
,
35 struct ustream_ssl_ctx
*ctx
= ctx_p
;
43 while ((fstr
= strstr(file
+ 1, "library/")) != NULL
)
46 len
= snprintf(buf
, sizeof(buf
), "%s:%04d: %s", file
, line
, str
);
47 if (len
>= (int)sizeof(buf
))
48 len
= (int)sizeof(buf
) - 1;
49 if (buf
[len
- 1] == '\n')
51 ctx
->debug_cb(ctx
->debug_cb_priv
, level
, buf
);
54 static int s_ustream_read(void *ctx
, unsigned char *buf
, size_t len
)
56 struct ustream
*s
= ctx
;
63 sbuf
= ustream_get_read_buf(s
, &slen
);
64 if ((size_t) slen
> len
)
68 return MBEDTLS_ERR_SSL_WANT_READ
;
70 memcpy(buf
, sbuf
, slen
);
71 ustream_consume(s
, slen
);
76 static int s_ustream_write(void *ctx
, const unsigned char *buf
, size_t len
)
78 struct ustream
*s
= ctx
;
81 ret
= ustream_write(s
, (const char *) buf
, len
, false);
82 if (ret
< 0 || s
->write_error
)
83 return MBEDTLS_ERR_NET_SEND_FAILED
;
88 __hidden
void ustream_set_io(struct ustream_ssl_ctx
*ctx
, void *ssl
, struct ustream
*conn
)
90 mbedtls_ssl_set_bio(ssl
, conn
, s_ustream_write
, s_ustream_read
, NULL
);
93 static int _random(void *ctx
, unsigned char *out
, size_t len
)
96 if (getrandom(out
, len
, 0) != (ssize_t
) len
)
97 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED
;
102 f
= fopen("/dev/urandom", "r");
103 if (fread(out
, len
, 1, f
) != 1)
104 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED
;
110 #define AES_GCM_CIPHERS(v) \
111 MBEDTLS_TLS_##v##_WITH_AES_128_GCM_SHA256, \
112 MBEDTLS_TLS_##v##_WITH_AES_256_GCM_SHA384
114 #define AES_CBC_CIPHERS(v) \
115 MBEDTLS_TLS_##v##_WITH_AES_128_CBC_SHA, \
116 MBEDTLS_TLS_##v##_WITH_AES_256_CBC_SHA
118 #define AES_CIPHERS(v) \
119 AES_GCM_CIPHERS(v), \
122 static const int default_ciphersuites_server
[] =
124 #ifdef MBEDTLS_SSL_PROTO_TLS1_3
125 MBEDTLS_TLS1_3_CHACHA20_POLY1305_SHA256
,
126 MBEDTLS_TLS1_3_AES_256_GCM_SHA384
,
127 MBEDTLS_TLS1_3_AES_128_GCM_SHA256
,
128 MBEDTLS_TLS1_3_AES_128_CCM_SHA256
,
129 MBEDTLS_TLS1_3_AES_128_CCM_8_SHA256
,
132 MBEDTLS_TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256
,
133 AES_GCM_CIPHERS(ECDHE_ECDSA
),
134 MBEDTLS_TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
,
135 AES_GCM_CIPHERS(ECDHE_RSA
),
136 AES_CBC_CIPHERS(ECDHE_RSA
),
141 static const int default_ciphersuites_client
[] =
143 #ifdef MBEDTLS_SSL_PROTO_TLS1_3
144 MBEDTLS_TLS1_3_CHACHA20_POLY1305_SHA256
,
145 MBEDTLS_TLS1_3_AES_256_GCM_SHA384
,
146 MBEDTLS_TLS1_3_AES_128_GCM_SHA256
,
147 MBEDTLS_TLS1_3_AES_128_CCM_SHA256
,
148 MBEDTLS_TLS1_3_AES_128_CCM_8_SHA256
,
151 MBEDTLS_TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256
,
152 AES_GCM_CIPHERS(ECDHE_ECDSA
),
153 MBEDTLS_TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
,
154 AES_GCM_CIPHERS(ECDHE_RSA
),
155 MBEDTLS_TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256
,
156 AES_GCM_CIPHERS(DHE_RSA
),
157 AES_CBC_CIPHERS(ECDHE_ECDSA
),
158 AES_CBC_CIPHERS(ECDHE_RSA
),
159 AES_CBC_CIPHERS(DHE_RSA
),
160 /* Removed in Mbed TLS 3.0.0 */
161 #ifdef MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
162 MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
,
165 /* Removed in Mbed TLS 3.0.0 */
166 #ifdef MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
167 MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
,
173 __hidden
struct ustream_ssl_ctx
*
174 __ustream_ssl_context_new(bool server
)
176 struct ustream_ssl_ctx
*ctx
;
177 mbedtls_ssl_config
*conf
;
180 #ifdef MBEDTLS_PSA_CRYPTO_C
181 static bool psa_init
;
183 if (!psa_init
&& !psa_crypto_init())
187 ctx
= calloc(1, sizeof(*ctx
));
191 ctx
->server
= server
;
192 mbedtls_pk_init(&ctx
->key
);
193 mbedtls_x509_crt_init(&ctx
->cert
);
194 mbedtls_x509_crt_init(&ctx
->ca_cert
);
196 #if defined(MBEDTLS_SSL_CACHE_C)
197 mbedtls_ssl_cache_init(&ctx
->cache
);
198 mbedtls_ssl_cache_set_timeout(&ctx
->cache
, 30 * 60);
199 mbedtls_ssl_cache_set_max_entries(&ctx
->cache
, 5);
203 mbedtls_ssl_config_init(conf
);
205 ep
= server
? MBEDTLS_SSL_IS_SERVER
: MBEDTLS_SSL_IS_CLIENT
;
207 mbedtls_ssl_config_defaults(conf
, ep
, MBEDTLS_SSL_TRANSPORT_STREAM
,
208 MBEDTLS_SSL_PRESET_DEFAULT
);
209 mbedtls_ssl_conf_rng(conf
, _random
, NULL
);
212 mbedtls_ssl_conf_authmode(conf
, MBEDTLS_SSL_VERIFY_NONE
);
213 mbedtls_ssl_conf_ciphersuites(conf
, default_ciphersuites_server
);
214 mbedtls_ssl_conf_min_version(conf
, MBEDTLS_SSL_MAJOR_VERSION_3
,
215 MBEDTLS_SSL_MINOR_VERSION_3
);
217 mbedtls_ssl_conf_authmode(conf
, MBEDTLS_SSL_VERIFY_OPTIONAL
);
218 mbedtls_ssl_conf_ciphersuites(conf
, default_ciphersuites_client
);
221 #if defined(MBEDTLS_SSL_CACHE_C)
222 mbedtls_ssl_conf_session_cache(conf
, &ctx
->cache
,
223 mbedtls_ssl_cache_get
,
224 mbedtls_ssl_cache_set
);
229 static void ustream_ssl_update_own_cert(struct ustream_ssl_ctx
*ctx
)
231 if (!ctx
->cert
.version
)
234 if (mbedtls_pk_get_type(&ctx
->key
) == MBEDTLS_PK_NONE
)
237 mbedtls_ssl_conf_own_cert(&ctx
->conf
, &ctx
->cert
, &ctx
->key
);
240 __hidden
int __ustream_ssl_add_ca_crt_file(struct ustream_ssl_ctx
*ctx
, const char *file
)
244 ret
= mbedtls_x509_crt_parse_file(&ctx
->ca_cert
, file
);
248 mbedtls_ssl_conf_ca_chain(&ctx
->conf
, &ctx
->ca_cert
, NULL
);
249 mbedtls_ssl_conf_authmode(&ctx
->conf
, MBEDTLS_SSL_VERIFY_OPTIONAL
);
253 __hidden
int __ustream_ssl_set_crt_file(struct ustream_ssl_ctx
*ctx
, const char *file
)
257 ret
= mbedtls_x509_crt_parse_file(&ctx
->cert
, file
);
261 ustream_ssl_update_own_cert(ctx
);
265 __hidden
int __ustream_ssl_set_key_file(struct ustream_ssl_ctx
*ctx
, const char *file
)
269 #if (MBEDTLS_VERSION_NUMBER >= 0x03000000)
270 ret
= mbedtls_pk_parse_keyfile(&ctx
->key
, file
, NULL
, _random
, NULL
);
272 ret
= mbedtls_pk_parse_keyfile(&ctx
->key
, file
, NULL
);
277 ustream_ssl_update_own_cert(ctx
);
281 __hidden
int __ustream_ssl_set_ciphers(struct ustream_ssl_ctx
*ctx
, const char *ciphers
)
283 int *ciphersuites
= NULL
, *tmp
, id
;
284 char *cipherstr
, *p
, *last
, c
;
290 cipherstr
= strdup(ciphers
);
292 if (cipherstr
== NULL
)
295 for (p
= cipherstr
, last
= p
;; p
++) {
296 if (*p
== ':' || *p
== 0) {
300 id
= mbedtls_ssl_get_ciphersuite_id(last
);
303 tmp
= realloc(ciphersuites
, (len
+ 2) * sizeof(int));
313 ciphersuites
[len
++] = id
;
314 ciphersuites
[len
] = 0;
324 * mbedTLS expects cipher names with dashes while many sources elsewhere
325 * like the Firefox wiki or Wireshark specify ciphers with underscores,
326 * so simply convert all underscores to dashes to accept both notations.
328 else if (*p
== '_') {
338 mbedtls_ssl_conf_ciphersuites(&ctx
->conf
, ciphersuites
);
339 free(ctx
->ciphersuites
);
341 ctx
->ciphersuites
= ciphersuites
;
346 __hidden
int __ustream_ssl_set_require_validation(struct ustream_ssl_ctx
*ctx
, bool require
)
348 int mode
= MBEDTLS_SSL_VERIFY_OPTIONAL
;
351 mode
= MBEDTLS_SSL_VERIFY_NONE
;
353 /* force TLS 1.2 when not requiring validation for now */
354 if (!require
&& !ctx
->server
)
355 mbedtls_ssl_conf_max_version(&ctx
->conf
, MBEDTLS_SSL_MAJOR_VERSION_3
,
356 MBEDTLS_SSL_MINOR_VERSION_3
);
357 mbedtls_ssl_conf_authmode(&ctx
->conf
, mode
);
362 __hidden
void __ustream_ssl_context_free(struct ustream_ssl_ctx
*ctx
)
364 free(ctx
->session_data
);
365 #if defined(MBEDTLS_SSL_CACHE_C)
366 mbedtls_ssl_cache_free(&ctx
->cache
);
368 mbedtls_pk_free(&ctx
->key
);
369 mbedtls_x509_crt_free(&ctx
->ca_cert
);
370 mbedtls_x509_crt_free(&ctx
->cert
);
371 mbedtls_ssl_config_free(&ctx
->conf
);
372 free(ctx
->ciphersuites
);
376 static void ustream_ssl_error(struct ustream_ssl
*us
, int ret
)
379 uloop_timeout_set(&us
->error_timer
, 0);
382 #ifdef MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET
384 __ustream_ssl_save_session(struct ustream_ssl
*us
)
386 struct ustream_ssl_ctx
*ctx
= us
->ctx
;
387 mbedtls_ssl_session sess
;
392 free(ctx
->session_data
);
393 ctx
->session_data
= NULL
;
395 mbedtls_ssl_session_init(&sess
);
396 if (mbedtls_ssl_get_session(us
->ssl
, &sess
) != 0)
399 mbedtls_ssl_session_save(&sess
, NULL
, 0, &ctx
->session_data_len
);
400 ctx
->session_data
= malloc(ctx
->session_data_len
);
401 if (mbedtls_ssl_session_save(&sess
, ctx
->session_data
, ctx
->session_data_len
,
402 &ctx
->session_data_len
))
403 ctx
->session_data_len
= 0;
404 mbedtls_ssl_session_free(&sess
);
408 static int ssl_check_return(struct ustream_ssl
*us
, int ret
)
411 case MBEDTLS_ERR_SSL_WANT_READ
:
412 case MBEDTLS_ERR_SSL_WANT_WRITE
:
413 return U_SSL_PENDING
;
414 #ifdef MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET
415 case MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET
:
416 __ustream_ssl_save_session(us
);
419 #ifdef MBEDTLS_ECP_RESTARTABLE
420 case MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS
:
423 case MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY
:
424 case MBEDTLS_ERR_NET_CONN_RESET
:
427 ustream_ssl_error(us
, ret
);
432 static void ustream_ssl_verify_cert(struct ustream_ssl
*us
)
435 const char *msg
= NULL
;
439 r
= mbedtls_ssl_get_verify_result(ssl
);
440 cn_mismatch
= r
& MBEDTLS_X509_BADCERT_CN_MISMATCH
;
441 r
&= ~MBEDTLS_X509_BADCERT_CN_MISMATCH
;
443 if (r
& MBEDTLS_X509_BADCERT_EXPIRED
)
444 msg
= "certificate has expired";
445 else if (r
& MBEDTLS_X509_BADCERT_REVOKED
)
446 msg
= "certificate has been revoked";
447 else if (r
& MBEDTLS_X509_BADCERT_NOT_TRUSTED
)
448 msg
= "certificate is self-signed or not signed by a trusted CA";
450 msg
= "unknown error";
453 if (us
->notify_verify_error
)
454 us
->notify_verify_error(us
, r
, msg
);
462 __hidden
enum ssl_conn_status
__ustream_ssl_connect(struct ustream_ssl
*us
)
468 r
= mbedtls_ssl_handshake(ssl
);
470 ustream_ssl_verify_cert(us
);
474 r
= ssl_check_return(us
, r
);
475 } while (r
== U_SSL_RETRY
);
480 __hidden
int __ustream_ssl_write(struct ustream_ssl
*us
, const char *buf
, int len
)
483 int done
= 0, ret
= 0;
485 while (done
!= len
) {
486 ret
= mbedtls_ssl_write(ssl
, (const unsigned char *) buf
+ done
, len
- done
);
488 ret
= ssl_check_return(us
, ret
);
489 if (ret
== U_SSL_RETRY
)
492 if (ret
== U_SSL_PENDING
)
504 __hidden
int __ustream_ssl_read(struct ustream_ssl
*us
, char *buf
, int len
)
509 ret
= mbedtls_ssl_read(us
->ssl
, (unsigned char *) buf
, len
);
513 ret
= ssl_check_return(us
, ret
);
514 } while (ret
== U_SSL_RETRY
);
519 __hidden
void __ustream_ssl_set_debug(struct ustream_ssl_ctx
*ctx
, int level
,
520 ustream_ssl_debug_cb cb
, void *cb_priv
)
523 ctx
->debug_cb_priv
= cb_priv
;
524 mbedtls_ssl_conf_dbg(&ctx
->conf
, debug_cb
, ctx
);
525 #ifdef MBEDTLS_DEBUG_C
526 mbedtls_debug_set_threshold(level
);
530 __hidden
void *__ustream_ssl_session_new(struct ustream_ssl_ctx
*ctx
)
532 mbedtls_ssl_context
*ssl
;
533 mbedtls_ssl_session sess
;
535 ssl
= calloc(1, sizeof(*ssl
));
539 mbedtls_ssl_init(ssl
);
541 if (mbedtls_ssl_setup(ssl
, &ctx
->conf
)) {
546 if (!ctx
->session_data_len
)
549 mbedtls_ssl_session_init(&sess
);
550 if (mbedtls_ssl_session_load(&sess
, ctx
->session_data
, ctx
->session_data_len
) == 0)
551 mbedtls_ssl_set_session(ssl
, &sess
);
556 __hidden
void __ustream_ssl_session_free(void *ssl
)
558 mbedtls_ssl_free(ssl
);