2 * librb: a library used by ircd-ratbox and other things
3 * openssl.c: openssl related code
5 * Copyright (C) 2007-2008 ircd-ratbox development team
6 * Copyright (C) 2007-2008 Aaron Sethman <androsyn@ratbox.org>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
25 #include <librb_config.h>
30 #include <commio-int.h>
31 #include <commio-ssl.h>
32 #include <openssl/ssl.h>
33 #include <openssl/dh.h>
34 #include <openssl/err.h>
35 #include <openssl/evp.h>
36 #include <openssl/rand.h>
37 #include <openssl/opensslv.h>
40 * This is a mess but what can you do when the library authors
41 * refuse to play ball with established conventions?
43 #if defined(LIBRESSL_VERSION_NUMBER) && (LIBRESSL_VERSION_NUMBER >= 0x20020002L)
44 # define LRB_HAVE_TLS_METHOD_API 1
46 # if !defined(LIBRESSL_VERSION_NUMBER) && (OPENSSL_VERSION_NUMBER >= 0x10100000L)
47 # define LRB_HAVE_TLS_METHOD_API 1
52 * Use SSL_CTX_set_ecdh_auto() in OpenSSL 1.0.2 only
53 * Use SSL_CTX_set1_curves_list() in OpenSSL 1.0.2 and above
54 * TODO: Merge this into the block above if LibreSSL implements them
56 #if !defined(LIBRESSL_VERSION_NUMBER) && (OPENSSL_VERSION_NUMBER >= 0x10002000L)
57 # define LRB_HAVE_TLS_SET_CURVES 1
58 # if (OPENSSL_VERSION_NUMBER < 0x10100000L)
59 # define LRB_HAVE_TLS_ECDH_AUTO 1
63 static SSL_CTX
*ssl_server_ctx
= NULL
;
64 static SSL_CTX
*ssl_client_ctx
= NULL
;
65 static int librb_index
= -1;
70 unsigned long t_err
, err
= 0;
71 err
= ERR_get_error();
75 while((t_err
= ERR_get_error()) > 0)
82 rb_ssl_shutdown(rb_fde_t
*F
)
85 if(F
== NULL
|| F
->ssl
== NULL
)
87 SSL_set_shutdown((SSL
*) F
->ssl
, SSL_RECEIVED_SHUTDOWN
);
89 for(i
= 0; i
< 4; i
++)
91 if(SSL_shutdown((SSL
*) F
->ssl
))
95 SSL_free((SSL
*) F
->ssl
);
99 rb_ssl_handshake_count(rb_fde_t
*F
)
101 return F
->handshake_count
;
105 rb_ssl_clear_handshake_count(rb_fde_t
*F
)
107 F
->handshake_count
= 0;
111 rb_ssl_timeout(rb_fde_t
*F
, void *notused
)
113 lrb_assert(F
->accept
!= NULL
);
114 F
->accept
->callback(F
, RB_ERR_TIMEOUT
, NULL
, 0, F
->accept
->data
);
119 rb_ssl_info_callback(SSL
* ssl
, int where
, int ret
)
121 if(where
& SSL_CB_HANDSHAKE_START
)
123 rb_fde_t
*F
= SSL_get_ex_data(ssl
, librb_index
);
126 F
->handshake_count
++;
131 rb_setup_ssl_cb(rb_fde_t
*F
)
133 SSL_set_ex_data(F
->ssl
, librb_index
, (char *)F
);
134 SSL_set_info_callback((SSL
*) F
->ssl
, (void (*)(const SSL
*,int,int))rb_ssl_info_callback
);
138 rb_ssl_tryaccept(rb_fde_t
*F
, void *data
)
141 lrb_assert(F
->accept
!= NULL
);
143 struct acceptdata
*ad
;
145 if(!SSL_is_init_finished((SSL
*) F
->ssl
))
147 if((ssl_err
= SSL_accept((SSL
*) F
->ssl
)) <= 0)
149 switch (ssl_err
= SSL_get_error((SSL
*) F
->ssl
, ssl_err
))
151 case SSL_ERROR_WANT_READ
:
152 case SSL_ERROR_WANT_WRITE
:
153 if(ssl_err
== SSL_ERROR_WANT_WRITE
)
154 flags
= RB_SELECT_WRITE
;
156 flags
= RB_SELECT_READ
;
157 F
->ssl_errno
= get_last_err();
158 rb_setselect(F
, flags
, rb_ssl_tryaccept
, NULL
);
160 case SSL_ERROR_SYSCALL
:
161 F
->accept
->callback(F
, RB_ERROR
, NULL
, 0, F
->accept
->data
);
164 F
->ssl_errno
= get_last_err();
165 F
->accept
->callback(F
, RB_ERROR_SSL
, NULL
, 0, F
->accept
->data
);
171 rb_settimeout(F
, 0, NULL
, NULL
);
172 rb_setselect(F
, RB_SELECT_READ
| RB_SELECT_WRITE
, NULL
, NULL
);
176 ad
->callback(F
, RB_OK
, (struct sockaddr
*)&ad
->S
, ad
->addrlen
, ad
->data
);
183 rb_ssl_accept_common(rb_fde_t
*new_F
)
186 if((ssl_err
= SSL_accept((SSL
*) new_F
->ssl
)) <= 0)
188 switch (ssl_err
= SSL_get_error((SSL
*) new_F
->ssl
, ssl_err
))
190 case SSL_ERROR_SYSCALL
:
191 if(rb_ignore_errno(errno
))
192 case SSL_ERROR_WANT_READ
:
193 case SSL_ERROR_WANT_WRITE
:
195 new_F
->ssl_errno
= get_last_err();
196 rb_setselect(new_F
, RB_SELECT_READ
| RB_SELECT_WRITE
,
197 rb_ssl_tryaccept
, NULL
);
201 new_F
->ssl_errno
= get_last_err();
202 new_F
->accept
->callback(new_F
, RB_ERROR_SSL
, NULL
, 0, new_F
->accept
->data
);
208 rb_ssl_tryaccept(new_F
, NULL
);
213 rb_ssl_start_accepted(rb_fde_t
*new_F
, ACCB
* cb
, void *data
, int timeout
)
215 new_F
->type
|= RB_FD_SSL
;
216 new_F
->ssl
= SSL_new(ssl_server_ctx
);
217 new_F
->accept
= rb_malloc(sizeof(struct acceptdata
));
219 new_F
->accept
->callback
= cb
;
220 new_F
->accept
->data
= data
;
221 rb_settimeout(new_F
, timeout
, rb_ssl_timeout
, NULL
);
223 new_F
->accept
->addrlen
= 0;
224 SSL_set_fd((SSL
*) new_F
->ssl
, rb_get_fd(new_F
));
225 rb_setup_ssl_cb(new_F
);
226 rb_ssl_accept_common(new_F
);
233 rb_ssl_accept_setup(rb_fde_t
*F
, rb_fde_t
*new_F
, struct sockaddr
*st
, int addrlen
)
235 new_F
->type
|= RB_FD_SSL
;
236 new_F
->ssl
= SSL_new(ssl_server_ctx
);
237 new_F
->accept
= rb_malloc(sizeof(struct acceptdata
));
239 new_F
->accept
->callback
= F
->accept
->callback
;
240 new_F
->accept
->data
= F
->accept
->data
;
241 rb_settimeout(new_F
, 10, rb_ssl_timeout
, NULL
);
242 memcpy(&new_F
->accept
->S
, st
, addrlen
);
243 new_F
->accept
->addrlen
= addrlen
;
245 SSL_set_fd((SSL
*) new_F
->ssl
, rb_get_fd(new_F
));
246 rb_setup_ssl_cb(new_F
);
247 rb_ssl_accept_common(new_F
);
251 rb_ssl_read_or_write(int r_or_w
, rb_fde_t
*F
, void *rbuf
, const void *wbuf
, size_t count
)
258 ret
= (ssize_t
) SSL_read(ssl
, rbuf
, (int)count
);
260 ret
= (ssize_t
) SSL_write(ssl
, wbuf
, (int)count
);
264 switch (SSL_get_error(ssl
, ret
))
266 case SSL_ERROR_WANT_READ
:
268 return RB_RW_SSL_NEED_READ
;
269 case SSL_ERROR_WANT_WRITE
:
271 return RB_RW_SSL_NEED_WRITE
;
272 case SSL_ERROR_ZERO_RETURN
:
274 case SSL_ERROR_SYSCALL
:
275 err
= get_last_err();
279 return RB_RW_IO_ERROR
;
283 err
= get_last_err();
289 errno
= EIO
; /* not great but... */
290 return RB_RW_SSL_ERROR
;
292 return RB_RW_IO_ERROR
;
298 rb_ssl_read(rb_fde_t
*F
, void *buf
, size_t count
)
300 return rb_ssl_read_or_write(0, F
, buf
, NULL
, count
);
304 rb_ssl_write(rb_fde_t
*F
, const void *buf
, size_t count
)
306 return rb_ssl_read_or_write(1, F
, NULL
, buf
, count
);
310 verify_accept_all_cb(int preverify_ok
, X509_STORE_CTX
*x509_ctx
)
316 get_ssl_error(unsigned long err
)
318 static char buf
[512];
320 ERR_error_string_n(err
, buf
, sizeof buf
);
327 char librb_data
[] = "librb data";
329 #if (OPENSSL_VERSION_NUMBER < 0x10100000L)
331 * OpenSSL 1.1.0 and above automatically initialises itself with sane defaults
334 SSL_load_error_strings();
337 librb_index
= SSL_get_ex_new_index(0, librb_data
, NULL
, NULL
, NULL
);
343 rb_setup_ssl_server(const char *cert
, const char *keyfile
, const char *dhfile
, const char *cipher_list
)
345 const char librb_ciphers
[] = "kEECDH+HIGH:kEDH+HIGH:HIGH:!aNULL";
347 #ifdef LRB_HAVE_TLS_SET_CURVES
348 const char librb_curves
[] = "P-521:P-384:P-256";
353 rb_lib_log("rb_setup_ssl_server: No certificate file");
359 rb_lib_log("rb_setup_ssl_server: No key file");
363 if(cipher_list
== NULL
)
364 cipher_list
= librb_ciphers
;
367 SSL_CTX_free(ssl_server_ctx
);
370 SSL_CTX_free(ssl_client_ctx
);
372 #ifdef LRB_HAVE_TLS_METHOD_API
373 ssl_server_ctx
= SSL_CTX_new(TLS_server_method());
374 ssl_client_ctx
= SSL_CTX_new(TLS_client_method());
376 ssl_server_ctx
= SSL_CTX_new(SSLv23_server_method());
377 ssl_client_ctx
= SSL_CTX_new(SSLv23_client_method());
380 if(ssl_server_ctx
== NULL
)
382 rb_lib_log("rb_init_openssl: Unable to initialize OpenSSL server context: %s",
383 get_ssl_error(ERR_get_error()));
387 if(ssl_client_ctx
== NULL
)
389 rb_lib_log("rb_init_openssl: Unable to initialize OpenSSL client context: %s",
390 get_ssl_error(ERR_get_error()));
394 #ifndef LRB_HAVE_TLS_METHOD_API
395 SSL_CTX_set_options(ssl_server_ctx
, SSL_OP_NO_SSLv2
| SSL_OP_NO_SSLv3
);
396 SSL_CTX_set_options(ssl_client_ctx
, SSL_OP_NO_SSLv2
| SSL_OP_NO_SSLv3
);
399 #ifdef SSL_OP_SINGLE_DH_USE
400 SSL_CTX_set_options(ssl_server_ctx
, SSL_OP_SINGLE_DH_USE
);
403 #ifdef SSL_OP_SINGLE_ECDH_USE
404 SSL_CTX_set_options(ssl_server_ctx
, SSL_OP_SINGLE_ECDH_USE
);
407 #ifdef SSL_OP_NO_TICKET
408 SSL_CTX_set_options(ssl_server_ctx
, SSL_OP_NO_TICKET
);
409 SSL_CTX_set_options(ssl_client_ctx
, SSL_OP_NO_TICKET
);
412 #ifdef SSL_OP_CIPHER_SERVER_PREFERENCE
413 SSL_CTX_set_options(ssl_server_ctx
, SSL_OP_CIPHER_SERVER_PREFERENCE
);
416 SSL_CTX_set_verify(ssl_server_ctx
, SSL_VERIFY_PEER
| SSL_VERIFY_CLIENT_ONCE
, verify_accept_all_cb
);
417 SSL_CTX_set_session_cache_mode(ssl_server_ctx
, SSL_SESS_CACHE_OFF
);
419 #ifdef LRB_HAVE_TLS_SET_CURVES
420 SSL_CTX_set1_curves_list(ssl_server_ctx
, librb_curves
);
423 #ifdef LRB_HAVE_TLS_ECDH_AUTO
424 SSL_CTX_set_ecdh_auto(ssl_server_ctx
, 1);
428 * Set manual ECDHE curve on OpenSSL 1.0.0 & 1.0.1, but make sure it's actually available
430 #if (OPENSSL_VERSION_NUMBER >= 0x10000000L) && (OPENSSL_VERSION_NUMBER < 0x10002000L) && !defined(OPENSSL_NO_ECDH)
431 EC_KEY
*key
= EC_KEY_new_by_curve_name(NID_secp384r1
);
433 SSL_CTX_set_tmp_ecdh(ssl_server_ctx
, key
);
438 SSL_CTX_set_cipher_list(ssl_server_ctx
, cipher_list
);
439 SSL_CTX_set_cipher_list(ssl_client_ctx
, cipher_list
);
441 if(!SSL_CTX_use_certificate_chain_file(ssl_server_ctx
, cert
) || !SSL_CTX_use_certificate_chain_file(ssl_client_ctx
, cert
))
443 rb_lib_log("rb_setup_ssl_server: Error loading certificate file [%s]: %s", cert
,
444 get_ssl_error(ERR_get_error()));
448 if(!SSL_CTX_use_PrivateKey_file(ssl_server_ctx
, keyfile
, SSL_FILETYPE_PEM
) || !SSL_CTX_use_PrivateKey_file(ssl_client_ctx
, keyfile
, SSL_FILETYPE_PEM
))
450 rb_lib_log("rb_setup_ssl_server: Error loading keyfile [%s]: %s", keyfile
,
451 get_ssl_error(ERR_get_error()));
457 /* DH parameters aren't necessary, but they are nice..if they didn't pass one..that is their problem */
458 BIO
*bio
= BIO_new_file(dhfile
, "r");
461 DH
*dh
= PEM_read_bio_DHparams(bio
, NULL
, NULL
, NULL
);
465 ("rb_setup_ssl_server: Error loading DH params file [%s]: %s",
466 dhfile
, get_ssl_error(ERR_get_error()));
471 SSL_CTX_set_tmp_dh(ssl_server_ctx
, dh
);
476 rb_lib_log("rb_setup_ssl_server: Error loading DH params file [%s]: %s",
477 dhfile
, get_ssl_error(ERR_get_error()));
485 rb_ssl_listen(rb_fde_t
*F
, int backlog
, int defer_accept
)
489 result
= rb_listen(F
, backlog
, defer_accept
);
490 F
->type
= RB_FD_SOCKET
| RB_FD_LISTEN
| RB_FD_SSL
;
503 rb_ssl_connect_realcb(rb_fde_t
*F
, int status
, struct ssl_connect
*sconn
)
505 F
->connect
->callback
= sconn
->callback
;
506 F
->connect
->data
= sconn
->data
;
508 rb_connect_callback(F
, status
);
512 rb_ssl_tryconn_timeout_cb(rb_fde_t
*F
, void *data
)
514 rb_ssl_connect_realcb(F
, RB_ERR_TIMEOUT
, data
);
518 rb_ssl_tryconn_cb(rb_fde_t
*F
, void *data
)
520 struct ssl_connect
*sconn
= data
;
522 if(!SSL_is_init_finished((SSL
*) F
->ssl
))
524 if((ssl_err
= SSL_connect((SSL
*) F
->ssl
)) <= 0)
526 switch (ssl_err
= SSL_get_error((SSL
*) F
->ssl
, ssl_err
))
528 case SSL_ERROR_SYSCALL
:
529 if(rb_ignore_errno(errno
))
530 case SSL_ERROR_WANT_READ
:
531 case SSL_ERROR_WANT_WRITE
:
533 F
->ssl_errno
= get_last_err();
534 rb_setselect(F
, RB_SELECT_READ
| RB_SELECT_WRITE
,
535 rb_ssl_tryconn_cb
, sconn
);
539 F
->ssl_errno
= get_last_err();
540 rb_ssl_connect_realcb(F
, RB_ERROR_SSL
, sconn
);
546 rb_ssl_connect_realcb(F
, RB_OK
, sconn
);
552 rb_ssl_tryconn(rb_fde_t
*F
, int status
, void *data
)
554 struct ssl_connect
*sconn
= data
;
558 rb_ssl_connect_realcb(F
, status
, sconn
);
562 F
->type
|= RB_FD_SSL
;
563 F
->ssl
= SSL_new(ssl_client_ctx
);
564 SSL_set_fd((SSL
*) F
->ssl
, F
->fd
);
566 rb_settimeout(F
, sconn
->timeout
, rb_ssl_tryconn_timeout_cb
, sconn
);
567 if((ssl_err
= SSL_connect((SSL
*) F
->ssl
)) <= 0)
569 switch (ssl_err
= SSL_get_error((SSL
*) F
->ssl
, ssl_err
))
571 case SSL_ERROR_SYSCALL
:
572 if(rb_ignore_errno(errno
))
573 case SSL_ERROR_WANT_READ
:
574 case SSL_ERROR_WANT_WRITE
:
576 F
->ssl_errno
= get_last_err();
577 rb_setselect(F
, RB_SELECT_READ
| RB_SELECT_WRITE
,
578 rb_ssl_tryconn_cb
, sconn
);
582 F
->ssl_errno
= get_last_err();
583 rb_ssl_connect_realcb(F
, RB_ERROR_SSL
, sconn
);
589 rb_ssl_connect_realcb(F
, RB_OK
, sconn
);
594 rb_connect_tcp_ssl(rb_fde_t
*F
, struct sockaddr
*dest
,
595 struct sockaddr
*clocal
, CNCB
* callback
, void *data
, int timeout
)
597 struct ssl_connect
*sconn
;
601 sconn
= rb_malloc(sizeof(struct ssl_connect
));
603 sconn
->callback
= callback
;
604 sconn
->timeout
= timeout
;
605 rb_connect_tcp(F
, dest
, clocal
, rb_ssl_tryconn
, sconn
, timeout
);
609 rb_ssl_start_connected(rb_fde_t
*F
, CNCB
* callback
, void *data
, int timeout
)
611 struct ssl_connect
*sconn
;
616 sconn
= rb_malloc(sizeof(struct ssl_connect
));
618 sconn
->callback
= callback
;
619 sconn
->timeout
= timeout
;
620 F
->connect
= rb_malloc(sizeof(struct conndata
));
621 F
->connect
->callback
= callback
;
622 F
->connect
->data
= data
;
623 F
->type
|= RB_FD_SSL
;
624 F
->ssl
= SSL_new(ssl_client_ctx
);
626 SSL_set_fd((SSL
*) F
->ssl
, F
->fd
);
628 rb_settimeout(F
, sconn
->timeout
, rb_ssl_tryconn_timeout_cb
, sconn
);
629 if((ssl_err
= SSL_connect((SSL
*) F
->ssl
)) <= 0)
631 switch (ssl_err
= SSL_get_error((SSL
*) F
->ssl
, ssl_err
))
633 case SSL_ERROR_SYSCALL
:
634 if(rb_ignore_errno(errno
))
635 case SSL_ERROR_WANT_READ
:
636 case SSL_ERROR_WANT_WRITE
:
638 F
->ssl_errno
= get_last_err();
639 rb_setselect(F
, RB_SELECT_READ
| RB_SELECT_WRITE
,
640 rb_ssl_tryconn_cb
, sconn
);
644 F
->ssl_errno
= get_last_err();
645 rb_ssl_connect_realcb(F
, RB_ERROR_SSL
, sconn
);
651 rb_ssl_connect_realcb(F
, RB_OK
, sconn
);
656 rb_init_prng(const char *path
, prng_seed_t seed_type
)
658 if(seed_type
== RB_PRNG_DEFAULT
)
663 return RAND_status();
666 return RAND_status();
671 if(RAND_load_file(path
, -1) == -1)
683 return RAND_status();
687 rb_get_random(void *buf
, size_t length
)
691 if((ret
= RAND_bytes(buf
, length
)) == 0)
693 /* remove the error from the queue */
700 rb_get_ssl_strerror(rb_fde_t
*F
)
702 return get_ssl_error(F
->ssl_errno
);
706 make_certfp(X509
*cert
, uint8_t certfp
[RB_SSL_CERTFP_LEN
], int method
)
715 case RB_SSL_CERTFP_METH_CERT_SHA1
:
716 it
= ASN1_ITEM_rptr(X509
);
719 len
= RB_SSL_CERTFP_LEN_SHA1
;
721 case RB_SSL_CERTFP_METH_CERT_SHA256
:
722 it
= ASN1_ITEM_rptr(X509
);
725 len
= RB_SSL_CERTFP_LEN_SHA256
;
727 case RB_SSL_CERTFP_METH_CERT_SHA512
:
728 it
= ASN1_ITEM_rptr(X509
);
731 len
= RB_SSL_CERTFP_LEN_SHA512
;
733 case RB_SSL_CERTFP_METH_SPKI_SHA256
:
734 it
= ASN1_ITEM_rptr(X509_PUBKEY
);
736 data
= X509_get_X509_PUBKEY(cert
);
737 len
= RB_SSL_CERTFP_LEN_SHA256
;
739 case RB_SSL_CERTFP_METH_SPKI_SHA512
:
740 it
= ASN1_ITEM_rptr(X509_PUBKEY
);
742 data
= X509_get_X509_PUBKEY(cert
);
743 len
= RB_SSL_CERTFP_LEN_SHA512
;
749 if (ASN1_item_digest(it
, evp
, data
, certfp
, &len
) != 1)
755 rb_get_ssl_certfp(rb_fde_t
*F
, uint8_t certfp
[RB_SSL_CERTFP_LEN
], int method
)
764 cert
= SSL_get_peer_certificate((SSL
*) F
->ssl
);
768 res
= SSL_get_verify_result((SSL
*) F
->ssl
);
772 case X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN
:
773 case X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE
:
774 case X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT
:
775 case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY
:
776 case X509_V_ERR_CERT_UNTRUSTED
:
777 len
= make_certfp(cert
, certfp
, method
);
779 default: /* to silence code inspectors */
788 rb_get_ssl_certfp_file(const char *filename
, uint8_t certfp
[RB_SSL_CERTFP_LEN
], int method
)
791 FILE *f
= fopen(filename
, "r");
796 cert
= PEM_read_X509(f
, NULL
, NULL
, NULL
);
800 unsigned int len
= make_certfp(cert
, certfp
, method
);
808 rb_supports_ssl(void)
814 rb_get_ssl_info(char *buf
, size_t len
)
816 snprintf(buf
, len
, "Using SSL: %s compiled: 0x%lx, library 0x%lx",
817 SSLeay_version(SSLEAY_VERSION
),
818 (long)OPENSSL_VERSION_NUMBER
, SSLeay());
822 rb_ssl_get_cipher(rb_fde_t
*F
)
824 const SSL_CIPHER
*sslciph
;
826 if(F
== NULL
|| F
->ssl
== NULL
)
829 if((sslciph
= SSL_get_current_cipher(F
->ssl
)) == NULL
)
832 return SSL_CIPHER_get_name(sslciph
);
835 #endif /* HAVE_OPENSSL */