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"
29 static int s_ustream_read(void *ctx
, unsigned char *buf
, size_t len
)
31 struct ustream
*s
= ctx
;
38 sbuf
= ustream_get_read_buf(s
, &slen
);
39 if ((size_t) slen
> len
)
43 return MBEDTLS_ERR_SSL_WANT_READ
;
45 memcpy(buf
, sbuf
, slen
);
46 ustream_consume(s
, slen
);
51 static int s_ustream_write(void *ctx
, const unsigned char *buf
, size_t len
)
53 struct ustream
*s
= ctx
;
56 ret
= ustream_write(s
, (const char *) buf
, len
, false);
57 if (ret
< 0 || s
->write_error
)
58 return MBEDTLS_ERR_NET_SEND_FAILED
;
63 __hidden
void ustream_set_io(struct ustream_ssl_ctx
*ctx
, void *ssl
, struct ustream
*conn
)
65 mbedtls_ssl_set_bio(ssl
, conn
, s_ustream_write
, s_ustream_read
, NULL
);
68 static int _random(void *ctx
, unsigned char *out
, size_t len
)
72 ret
= getrandom(out
, len
, 0);
73 if (ret
< 0 || (size_t)ret
!= len
)
74 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED
;
79 #define AES_GCM_CIPHERS(v) \
80 MBEDTLS_TLS_##v##_WITH_AES_128_GCM_SHA256, \
81 MBEDTLS_TLS_##v##_WITH_AES_256_GCM_SHA384
83 #define AES_CBC_CIPHERS(v) \
84 MBEDTLS_TLS_##v##_WITH_AES_128_CBC_SHA, \
85 MBEDTLS_TLS_##v##_WITH_AES_256_CBC_SHA
87 #define AES_CIPHERS(v) \
91 static const int default_ciphersuites_server
[] =
93 MBEDTLS_TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256
,
94 AES_GCM_CIPHERS(ECDHE_ECDSA
),
95 MBEDTLS_TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
,
96 AES_GCM_CIPHERS(ECDHE_RSA
),
97 AES_CBC_CIPHERS(ECDHE_RSA
),
102 static const int default_ciphersuites_client
[] =
104 MBEDTLS_TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256
,
105 AES_GCM_CIPHERS(ECDHE_ECDSA
),
106 MBEDTLS_TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
,
107 AES_GCM_CIPHERS(ECDHE_RSA
),
108 MBEDTLS_TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256
,
109 AES_GCM_CIPHERS(DHE_RSA
),
110 AES_CBC_CIPHERS(ECDHE_ECDSA
),
111 AES_CBC_CIPHERS(ECDHE_RSA
),
112 AES_CBC_CIPHERS(DHE_RSA
),
113 /* Removed in Mbed TLS 3.0.0 */
114 #ifdef MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
115 MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
,
118 /* Removed in Mbed TLS 3.0.0 */
119 #ifdef MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
120 MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
,
126 __hidden
struct ustream_ssl_ctx
*
127 __ustream_ssl_context_new(bool server
)
129 struct ustream_ssl_ctx
*ctx
;
130 mbedtls_ssl_config
*conf
;
133 ctx
= calloc(1, sizeof(*ctx
));
137 ctx
->server
= server
;
138 mbedtls_pk_init(&ctx
->key
);
139 mbedtls_x509_crt_init(&ctx
->cert
);
140 mbedtls_x509_crt_init(&ctx
->ca_cert
);
142 #if defined(MBEDTLS_SSL_CACHE_C)
143 mbedtls_ssl_cache_init(&ctx
->cache
);
144 mbedtls_ssl_cache_set_timeout(&ctx
->cache
, 30 * 60);
145 mbedtls_ssl_cache_set_max_entries(&ctx
->cache
, 5);
149 mbedtls_ssl_config_init(conf
);
151 ep
= server
? MBEDTLS_SSL_IS_SERVER
: MBEDTLS_SSL_IS_CLIENT
;
153 mbedtls_ssl_config_defaults(conf
, ep
, MBEDTLS_SSL_TRANSPORT_STREAM
,
154 MBEDTLS_SSL_PRESET_DEFAULT
);
155 mbedtls_ssl_conf_rng(conf
, _random
, NULL
);
158 mbedtls_ssl_conf_authmode(conf
, MBEDTLS_SSL_VERIFY_NONE
);
159 mbedtls_ssl_conf_ciphersuites(conf
, default_ciphersuites_server
);
160 mbedtls_ssl_conf_min_version(conf
, MBEDTLS_SSL_MAJOR_VERSION_3
,
161 MBEDTLS_SSL_MINOR_VERSION_3
);
163 mbedtls_ssl_conf_authmode(conf
, MBEDTLS_SSL_VERIFY_OPTIONAL
);
164 mbedtls_ssl_conf_ciphersuites(conf
, default_ciphersuites_client
);
167 #if defined(MBEDTLS_SSL_CACHE_C)
168 mbedtls_ssl_conf_session_cache(conf
, &ctx
->cache
,
169 mbedtls_ssl_cache_get
,
170 mbedtls_ssl_cache_set
);
175 static void ustream_ssl_update_own_cert(struct ustream_ssl_ctx
*ctx
)
177 if (!ctx
->cert
.version
)
180 if (mbedtls_pk_get_type(&ctx
->key
) == MBEDTLS_PK_NONE
)
183 mbedtls_ssl_conf_own_cert(&ctx
->conf
, &ctx
->cert
, &ctx
->key
);
186 __hidden
int __ustream_ssl_add_ca_crt_file(struct ustream_ssl_ctx
*ctx
, const char *file
)
190 ret
= mbedtls_x509_crt_parse_file(&ctx
->ca_cert
, file
);
194 mbedtls_ssl_conf_ca_chain(&ctx
->conf
, &ctx
->ca_cert
, NULL
);
195 mbedtls_ssl_conf_authmode(&ctx
->conf
, MBEDTLS_SSL_VERIFY_OPTIONAL
);
199 __hidden
int __ustream_ssl_set_crt_file(struct ustream_ssl_ctx
*ctx
, const char *file
)
203 ret
= mbedtls_x509_crt_parse_file(&ctx
->cert
, file
);
207 ustream_ssl_update_own_cert(ctx
);
211 __hidden
int __ustream_ssl_set_key_file(struct ustream_ssl_ctx
*ctx
, const char *file
)
215 #if (MBEDTLS_VERSION_NUMBER >= 0x03000000)
216 ret
= mbedtls_pk_parse_keyfile(&ctx
->key
, file
, NULL
, _random
, NULL
);
218 ret
= mbedtls_pk_parse_keyfile(&ctx
->key
, file
, NULL
);
223 ustream_ssl_update_own_cert(ctx
);
227 __hidden
int __ustream_ssl_set_ciphers(struct ustream_ssl_ctx
*ctx
, const char *ciphers
)
229 int *ciphersuites
= NULL
, *tmp
, id
;
230 char *cipherstr
, *p
, *last
, c
;
236 cipherstr
= strdup(ciphers
);
238 if (cipherstr
== NULL
)
241 for (p
= cipherstr
, last
= p
;; p
++) {
242 if (*p
== ':' || *p
== 0) {
246 id
= mbedtls_ssl_get_ciphersuite_id(last
);
249 tmp
= realloc(ciphersuites
, (len
+ 2) * sizeof(int));
259 ciphersuites
[len
++] = id
;
260 ciphersuites
[len
] = 0;
270 * mbedTLS expects cipher names with dashes while many sources elsewhere
271 * like the Firefox wiki or Wireshark specify ciphers with underscores,
272 * so simply convert all underscores to dashes to accept both notations.
274 else if (*p
== '_') {
284 mbedtls_ssl_conf_ciphersuites(&ctx
->conf
, ciphersuites
);
285 free(ctx
->ciphersuites
);
287 ctx
->ciphersuites
= ciphersuites
;
292 __hidden
int __ustream_ssl_set_require_validation(struct ustream_ssl_ctx
*ctx
, bool require
)
294 int mode
= MBEDTLS_SSL_VERIFY_OPTIONAL
;
297 mode
= MBEDTLS_SSL_VERIFY_NONE
;
299 mbedtls_ssl_conf_authmode(&ctx
->conf
, mode
);
304 __hidden
void __ustream_ssl_context_free(struct ustream_ssl_ctx
*ctx
)
306 #if defined(MBEDTLS_SSL_CACHE_C)
307 mbedtls_ssl_cache_free(&ctx
->cache
);
309 mbedtls_pk_free(&ctx
->key
);
310 mbedtls_x509_crt_free(&ctx
->ca_cert
);
311 mbedtls_x509_crt_free(&ctx
->cert
);
312 mbedtls_ssl_config_free(&ctx
->conf
);
313 free(ctx
->ciphersuites
);
317 static void ustream_ssl_error(struct ustream_ssl
*us
, int ret
)
320 uloop_timeout_set(&us
->error_timer
, 0);
323 static bool ssl_do_wait(int ret
)
326 case MBEDTLS_ERR_SSL_WANT_READ
:
327 case MBEDTLS_ERR_SSL_WANT_WRITE
:
334 static void ustream_ssl_verify_cert(struct ustream_ssl
*us
)
337 const char *msg
= NULL
;
341 r
= mbedtls_ssl_get_verify_result(ssl
);
342 cn_mismatch
= r
& MBEDTLS_X509_BADCERT_CN_MISMATCH
;
343 r
&= ~MBEDTLS_X509_BADCERT_CN_MISMATCH
;
345 if (r
& MBEDTLS_X509_BADCERT_EXPIRED
)
346 msg
= "certificate has expired";
347 else if (r
& MBEDTLS_X509_BADCERT_REVOKED
)
348 msg
= "certificate has been revoked";
349 else if (r
& MBEDTLS_X509_BADCERT_NOT_TRUSTED
)
350 msg
= "certificate is self-signed or not signed by a trusted CA";
352 msg
= "unknown error";
355 if (us
->notify_verify_error
)
356 us
->notify_verify_error(us
, r
, msg
);
364 __hidden
enum ssl_conn_status
__ustream_ssl_connect(struct ustream_ssl
*us
)
369 r
= mbedtls_ssl_handshake(ssl
);
371 ustream_ssl_verify_cert(us
);
376 return U_SSL_PENDING
;
378 ustream_ssl_error(us
, r
);
382 __hidden
int __ustream_ssl_write(struct ustream_ssl
*us
, const char *buf
, int len
)
385 int done
= 0, ret
= 0;
387 while (done
!= len
) {
388 ret
= mbedtls_ssl_write(ssl
, (const unsigned char *) buf
+ done
, len
- done
);
391 if (ssl_do_wait(ret
))
394 ustream_ssl_error(us
, ret
);
404 __hidden
int __ustream_ssl_read(struct ustream_ssl
*us
, char *buf
, int len
)
406 int ret
= mbedtls_ssl_read(us
->ssl
, (unsigned char *) buf
, len
);
409 if (ssl_do_wait(ret
))
410 return U_SSL_PENDING
;
412 if (ret
== MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY
)
415 ustream_ssl_error(us
, ret
);
422 __hidden
void *__ustream_ssl_session_new(struct ustream_ssl_ctx
*ctx
)
424 mbedtls_ssl_context
*ssl
;
426 ssl
= calloc(1, sizeof(*ssl
));
430 mbedtls_ssl_init(ssl
);
432 if (mbedtls_ssl_setup(ssl
, &ctx
->conf
)) {
440 __hidden
void __ustream_ssl_session_free(void *ssl
)
442 mbedtls_ssl_free(ssl
);