2 * ngIRCd -- The Next Generation IRC Daemon
3 * Copyright (c) 2005-2008 Florian Westphal <fw@strlen.de>
10 * SSL wrapper functions
28 #include "conn-func.h"
35 extern struct SSLOptions Conf_SSLOptions;
38 #include <openssl/err.h>
39 #include <openssl/rand.h>
41 static SSL_CTX * ssl_ctx;
44 static bool ConnSSL_LoadServerKey_openssl PARAMS(( SSL_CTX *c ));
48 #include <sys/types.h>
52 #include <gnutls/x509.h>
55 #define DH_BITS_MIN 1024
57 static gnutls_certificate_credentials_t x509_cred;
58 static gnutls_dh_params_t dh_params;
59 static bool ConnSSL_LoadServerKey_gnutls PARAMS(( void ));
62 static bool ConnSSL_Init_SSL PARAMS(( CONNECTION *c ));
63 static int ConnectAccept PARAMS(( CONNECTION *c, bool connect ));
64 static int ConnSSL_HandleError PARAMS(( CONNECTION *c, const int code, const char *fname ));
67 static char * openreadclose(const char *name, size_t *len)
72 int fd = open(name, O_RDONLY);
74 Log(LOG_ERR, "Could not open %s: %s", name, strerror(errno));
78 Log(LOG_ERR, "Could not fstat %s: %s", name, strerror(errno));
81 if (!S_ISREG(s.st_mode)) {
82 Log(LOG_ERR, "%s: Not a regular file", name);
86 Log(LOG_ERR, "%s: invalid file length (size %ld <= 0)", name, (long) s.st_size);
89 buf = malloc(s.st_size);
91 Log(LOG_ERR, "Could not malloc %lu bytes for file %s: %s", s.st_size, name, strerror(errno));
94 br = read(fd, buf, s.st_size);
95 if (br != (ssize_t)s.st_size) {
96 Log(LOG_ERR, "Could not read file %s: read returned %ld, expected %ld: %s",
97 name, (long) br, (long) s.st_size, br == -1 ? strerror(errno):"short read?!");
98 memset(buf, 0, s.st_size);
113 LogOpenSSLError( const char *msg, const char *msg2 )
115 unsigned long err = ERR_get_error();
116 char * errmsg = err ? ERR_error_string(err, NULL) : "Unable to determine error";
118 if (!msg) msg = "SSL Error";
120 Log( LOG_ERR, "%s: %s: %s", msg, msg2, errmsg);
122 Log( LOG_ERR, "%s: %s", msg, errmsg);
127 pem_passwd_cb(char *buf, int size, int rwflag, void *password)
129 array *pass = password;
132 (void)rwflag; /* rwflag is unused if DEBUG is not set. */
133 assert(rwflag == 0); /* 0 -> callback used for decryption.
134 * See SSL_CTX_set_default_passwd_cb(3) */
136 passlen = (int) array_bytes(pass);
138 LogDebug("pem_passwd_cb buf size %d, array size %d", size, passlen);
139 assert(passlen >= 0);
141 Log(LOG_ERR, "pem_passwd_cb: password required, but not set");
144 size = passlen > size ? size : passlen;
145 memcpy(buf, (char *)(array_start(pass)), size);
158 if (!Conf_SSLOptions.DHFile) {
159 Log(LOG_NOTICE, "Configuration option \"SSLDHFile\" not set!");
162 fp = fopen(Conf_SSLOptions.DHFile, "r");
164 Log(LOG_ERR, "%s: %s", Conf_SSLOptions.DHFile, strerror(errno));
167 dh_params = PEM_read_DHparams(fp, NULL, NULL, NULL);
169 Log(LOG_ERR, "%s: PEM_read_DHparams failed!",
170 Conf_SSLOptions.DHFile);
176 #ifdef HAVE_LIBGNUTLS
177 bool need_dhgenerate = true;
179 gnutls_dh_params_t tmp_dh_params;
181 err = gnutls_dh_params_init(&tmp_dh_params);
183 Log(LOG_ERR, "gnutls_dh_params_init: %s", gnutls_strerror(err));
186 if (Conf_SSLOptions.DHFile) {
187 gnutls_datum_t dhparms;
189 dhparms.data = (unsigned char *) openreadclose(Conf_SSLOptions.DHFile, &size);
192 err = gnutls_dh_params_import_pkcs3(tmp_dh_params, &dhparms, GNUTLS_X509_FMT_PEM);
194 need_dhgenerate = false;
196 Log(LOG_ERR, "gnutls_dh_params_init: %s", gnutls_strerror(err));
198 memset(dhparms.data, 0, size);
202 if (need_dhgenerate) {
204 "SSLDHFile not set, generating %u bit DH parameters. This may take a while ...",
206 err = gnutls_dh_params_generate2(tmp_dh_params, DH_BITS);
208 Log(LOG_ERR, "gnutls_dh_params_generate2: %s", gnutls_strerror(err));
212 dh_params = tmp_dh_params;
218 void ConnSSL_Free(CONNECTION *c)
221 SSL *ssl = c->ssl_state.ssl;
225 c->ssl_state.ssl = NULL;
228 #ifdef HAVE_LIBGNUTLS
229 gnutls_session_t sess = c->ssl_state.gnutls_session;
230 if (Conn_OPTION_ISSET(c, CONN_SSL)) {
231 gnutls_bye(sess, GNUTLS_SHUT_RDWR);
235 assert(Conn_OPTION_ISSET(c, CONN_SSL));
236 /* can't just set bitmask to 0 -- there are other, non-ssl related flags, e.g. CONN_ZIP. */
237 Conn_OPTION_DEL(c, CONN_SSL_FLAGS_ALL);
242 ConnSSL_InitLibrary( void )
244 if (!array_bytes(&Conf_SSLOptions.ListenPorts))
252 SSL_load_error_strings();
255 if (!RAND_status()) {
256 Log(LOG_ERR, "OpenSSL PRNG not seeded: /dev/urandom missing?");
258 * it is probably best to fail and let the user install EGD or a similar program if no kernel random device is available.
259 * According to OpenSSL RAND_egd(3): "The automatic query of /var/run/egd-pool et al was added in OpenSSL 0.9.7";
260 * so it makes little sense to deal with PRNGD seeding ourselves.
262 array_free(&Conf_SSLOptions.ListenPorts);
266 newctx = SSL_CTX_new(SSLv23_method());
268 LogOpenSSLError("SSL_CTX_new()", NULL);
269 array_free(&Conf_SSLOptions.ListenPorts);
273 if (!ConnSSL_LoadServerKey_openssl(newctx))
276 SSL_CTX_set_options(newctx, SSL_OP_SINGLE_DH_USE|SSL_OP_NO_SSLv2);
277 SSL_CTX_set_mode(newctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
278 SSL_CTX_free(ssl_ctx);
280 Log(LOG_INFO, "%s initialized.", SSLeay_version(SSLEAY_VERSION));
283 SSL_CTX_free(newctx);
284 array_free(&Conf_SSLOptions.ListenPorts);
287 #ifdef HAVE_LIBGNUTLS
289 static bool initialized;
290 if (initialized) /* TODO: cannot reload gnutls keys: can't simply free x509 context -- it may still be in use */
293 err = gnutls_global_init();
295 Log(LOG_ERR, "gnutls_global_init(): %s", gnutls_strerror(err));
296 array_free(&Conf_SSLOptions.ListenPorts);
299 if (!ConnSSL_LoadServerKey_gnutls()) {
300 array_free(&Conf_SSLOptions.ListenPorts);
303 Log(LOG_INFO, "gnutls %s initialized.", gnutls_check_version(NULL));
310 #ifdef HAVE_LIBGNUTLS
312 ConnSSL_LoadServerKey_gnutls(void)
315 const char *cert_file;
317 err = gnutls_certificate_allocate_credentials(&x509_cred);
319 Log(LOG_ERR, "gnutls_certificate_allocate_credentials: %s", gnutls_strerror(err));
323 cert_file = Conf_SSLOptions.CertFile ? Conf_SSLOptions.CertFile:Conf_SSLOptions.KeyFile;
325 Log(LOG_ERR, "No SSL server key configured!");
329 if (array_bytes(&Conf_SSLOptions.KeyFilePassword))
331 "Ignoring KeyFilePassword: Not supported by GNUTLS.");
333 if (!Load_DH_params())
336 gnutls_certificate_set_dh_params(x509_cred, dh_params);
337 err = gnutls_certificate_set_x509_key_file(x509_cred, cert_file, Conf_SSLOptions.KeyFile, GNUTLS_X509_FMT_PEM);
339 Log(LOG_ERR, "gnutls_certificate_set_x509_key_file (cert %s, key %s): %s",
340 cert_file, Conf_SSLOptions.KeyFile ? Conf_SSLOptions.KeyFile : "(NULL)", gnutls_strerror(err));
350 ConnSSL_LoadServerKey_openssl(SSL_CTX *ctx)
355 if (!Conf_SSLOptions.KeyFile) {
356 Log(LOG_ERR, "No SSL server key configured!");
360 SSL_CTX_set_default_passwd_cb(ctx, pem_passwd_cb);
361 SSL_CTX_set_default_passwd_cb_userdata(ctx, &Conf_SSLOptions.KeyFilePassword);
363 if (SSL_CTX_use_PrivateKey_file(ctx, Conf_SSLOptions.KeyFile, SSL_FILETYPE_PEM) != 1) {
364 array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
365 LogOpenSSLError("SSL_CTX_use_PrivateKey_file", Conf_SSLOptions.KeyFile);
369 cert_key = Conf_SSLOptions.CertFile ? Conf_SSLOptions.CertFile:Conf_SSLOptions.KeyFile;
370 if (SSL_CTX_use_certificate_chain_file(ctx, cert_key) != 1) {
371 array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
372 LogOpenSSLError("SSL_CTX_use_certificate_file", cert_key);
376 array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
378 if (!SSL_CTX_check_private_key(ctx)) {
379 LogOpenSSLError("Server Private Key does not match certificate", NULL);
382 if (Load_DH_params()) {
383 if (SSL_CTX_set_tmp_dh(ctx, dh_params) != 1)
384 LogOpenSSLError("Error setting DH Parameters", Conf_SSLOptions.DHFile);
385 /* don't return false here: the non-DH modes will still work */
395 ConnSSL_Init_SSL(CONNECTION *c)
401 Log(LOG_ERR, "Cannot init ssl_ctx: OpenSSL initialization failed at startup");
404 assert(c->ssl_state.ssl == NULL);
406 c->ssl_state.ssl = SSL_new(ssl_ctx);
407 if (!c->ssl_state.ssl) {
408 LogOpenSSLError("SSL_new()", NULL);
412 ret = SSL_set_fd(c->ssl_state.ssl, c->sock);
414 LogOpenSSLError("SSL_set_fd()", NULL);
419 #ifdef HAVE_LIBGNUTLS
420 ret = gnutls_set_default_priority(c->ssl_state.gnutls_session);
422 Log(LOG_ERR, "gnutls_set_default_priority: %s", gnutls_strerror(ret));
427 * The intermediate (long) cast is here to avoid a warning like:
428 * "cast to pointer from integer of different size" on 64-bit platforms.
429 * There doesn't seem to be an alternate GNUTLS API we could use instead, see e.g.
430 * http://www.mail-archive.com/help-gnutls@gnu.org/msg00286.html
432 gnutls_transport_set_ptr(c->ssl_state.gnutls_session, (gnutls_transport_ptr_t) (long) c->sock);
433 ret = gnutls_credentials_set(c->ssl_state.gnutls_session, GNUTLS_CRD_CERTIFICATE, x509_cred);
435 Log(LOG_ERR, "gnutls_credentials_set: %s", gnutls_strerror(ret));
439 gnutls_dh_set_prime_bits(c->ssl_state.gnutls_session, DH_BITS_MIN);
441 Conn_OPTION_ADD(c, CONN_SSL);
447 ConnSSL_PrepareConnect(CONNECTION *c, UNUSED CONF_SERVER *s)
450 #ifdef HAVE_LIBGNUTLS
453 err = gnutls_init(&c->ssl_state.gnutls_session, GNUTLS_CLIENT);
455 Log(LOG_ERR, "gnutls_init: %s", gnutls_strerror(err));
459 ret = ConnSSL_Init_SSL(c);
462 Conn_OPTION_ADD(c, CONN_SSL_CONNECT);
464 assert(c->ssl_state.ssl);
465 SSL_set_verify(c->ssl_state.ssl, SSL_VERIFY_NONE, NULL);
472 Check an Handle Error return code after failed calls to ssl/tls functions.
474 SSL_connect(), SSL_accept(), SSL_do_handshake(), SSL_read(), SSL_peek(), or SSL_write() on ssl.
476 gnutlsssl_read(), gnutls_write() or gnutls_handshake().
477 Return: -1 on fatal error, 0 if we can try again later.
480 ConnSSL_HandleError( CONNECTION *c, const int code, const char *fname )
483 int ret = SSL_ERROR_SYSCALL;
484 unsigned long sslerr;
485 int real_errno = errno;
487 ret = SSL_get_error(c->ssl_state.ssl, code);
489 case SSL_ERROR_WANT_READ:
490 io_event_del(c->sock, IO_WANTWRITE);
491 Conn_OPTION_ADD(c, CONN_SSL_WANT_READ);
492 return 0; /* try again later */
493 case SSL_ERROR_WANT_WRITE:
494 io_event_del(c->sock, IO_WANTREAD);
495 Conn_OPTION_ADD(c, CONN_SSL_WANT_WRITE); /* fall through */
497 return 0; /* try again later */
498 case SSL_ERROR_ZERO_RETURN:
499 LogDebug("TLS/SSL connection shut down normally");
502 SSL_ERROR_WANT_CONNECT, SSL_ERROR_WANT_ACCEPT, SSL_ERROR_WANT_X509_LOOKUP
504 case SSL_ERROR_SYSCALL:
505 sslerr = ERR_get_error();
507 Log( LOG_ERR, "%s: %s", fname, ERR_error_string(sslerr, NULL ));
510 switch (code) { /* EOF that violated protocol */
512 Log(LOG_ERR, "%s: Client Disconnected", fname );
514 case -1: /* low level socket I/O error, check errno */
515 Log(LOG_ERR, "%s: %s", fname, strerror(real_errno));
520 LogOpenSSLError("TLS/SSL Protocol Error", fname);
523 Log( LOG_ERR, "%s: Unknown error %d!", fname, ret);
528 #ifdef HAVE_LIBGNUTLS
531 case GNUTLS_E_INTERRUPTED:
532 if (gnutls_record_get_direction(c->ssl_state.gnutls_session)) {
533 Conn_OPTION_ADD(c, CONN_SSL_WANT_WRITE);
534 io_event_del(c->sock, IO_WANTREAD);
536 Conn_OPTION_ADD(c, CONN_SSL_WANT_READ);
537 io_event_del(c->sock, IO_WANTWRITE);
542 if (gnutls_error_is_fatal(code)) {
543 Log(LOG_ERR, "%s: %s", fname, gnutls_strerror(code));
554 ConnSSL_LogCertInfo( CONNECTION *c )
557 SSL *ssl = c->ssl_state.ssl;
561 Log(LOG_INFO, "Connection %d: initialized %s using cipher %s.",
562 c->sock, SSL_get_version(ssl), SSL_get_cipher(ssl));
564 #ifdef HAVE_LIBGNUTLS
565 gnutls_session_t sess = c->ssl_state.gnutls_session;
566 gnutls_cipher_algorithm_t cipher = gnutls_cipher_get(sess);
568 Log(LOG_INFO, "Connection %d: initialized %s using cipher %s-%s.",
570 gnutls_protocol_get_name(gnutls_protocol_get_version(sess)),
571 gnutls_cipher_get_name(cipher),
572 gnutls_mac_get_name(gnutls_mac_get(sess)));
578 Accept incoming SSL connection.
580 1: SSL Connection established
582 -1: SSL Connection not established due to fatal error.
585 ConnSSL_Accept( CONNECTION *c )
588 if (!Conn_OPTION_ISSET(c, CONN_SSL)) {
589 #ifdef HAVE_LIBGNUTLS
590 int err = gnutls_init(&c->ssl_state.gnutls_session, GNUTLS_SERVER);
592 Log(LOG_ERR, "gnutls_init: %s", gnutls_strerror(err));
596 LogDebug("ConnSSL_Accept: Initializing SSL data");
597 if (!ConnSSL_Init_SSL(c))
600 return ConnectAccept(c, false );
605 ConnSSL_Connect( CONNECTION *c )
609 assert(c->ssl_state.ssl);
611 assert(Conn_OPTION_ISSET(c, CONN_SSL));
612 return ConnectAccept(c, true);
616 /* accept/connect wrapper. if connect is true, connect to peer, otherwise wait for incoming connection */
618 ConnectAccept( CONNECTION *c, bool connect)
622 SSL *ssl = c->ssl_state.ssl;
625 ret = connect ? SSL_connect(ssl) : SSL_accept(ssl);
627 return ConnSSL_HandleError(c, ret, connect ? "SSL_connect": "SSL_accept");
629 #ifdef HAVE_LIBGNUTLS
631 ret = gnutls_handshake(c->ssl_state.gnutls_session);
633 return ConnSSL_HandleError(c, ret, "gnutls_handshake");
635 Conn_OPTION_DEL(c, (CONN_SSL_WANT_WRITE|CONN_SSL_WANT_READ|CONN_SSL_CONNECT));
636 ConnSSL_LogCertInfo(c);
638 Conn_StartLogin(CONNECTION2ID(c));
644 ConnSSL_Write(CONNECTION *c, const void *buf, size_t count)
648 Conn_OPTION_DEL(c, CONN_SSL_WANT_WRITE|CONN_SSL_WANT_READ);
652 bw = (ssize_t) SSL_write(c->ssl_state.ssl, buf, count);
654 #ifdef HAVE_LIBGNUTLS
655 bw = gnutls_write(c->ssl_state.gnutls_session, buf, count);
659 if (ConnSSL_HandleError( c, bw, "ConnSSL_Write") == 0)
660 errno = EAGAIN; /* try again */
666 ConnSSL_Read(CONNECTION *c, void * buf, size_t count)
670 Conn_OPTION_DEL(c, CONN_SSL_WANT_WRITE|CONN_SSL_WANT_READ);
672 br = (ssize_t) SSL_read(c->ssl_state.ssl, buf, count);
673 if (br > 0) /* on EOF we have to call ConnSSL_HandleError(), see SSL_read(3) */
676 #ifdef HAVE_LIBGNUTLS
677 br = gnutls_read(c->ssl_state.gnutls_session, buf, count);
678 if (br >= 0) /* on EOF we must _not_ call ConnSSL_HandleError, see gnutls_record_recv(3) */
681 /* error on read: switch ConnSSL_HandleError() return values -> 0 is "try again", so return -1 and set EAGAIN */
682 if (ConnSSL_HandleError(c, br, "ConnSSL_Read") == 0) {
691 ConnSSL_GetCipherInfo(CONNECTION *c, char *buf, size_t len)
695 SSL *ssl = c->ssl_state.ssl;
700 SSL_CIPHER_description(SSL_get_current_cipher(ssl), buf, len);
701 nl = strchr(buf, '\n');
706 #ifdef HAVE_LIBGNUTLS
707 if (Conn_OPTION_ISSET(c, CONN_SSL)) {
708 const char *name_cipher, *name_mac, *name_proto, *name_keyexchange;
711 gnutls_session_t sess = c->ssl_state.gnutls_session;
712 gnutls_cipher_algorithm_t cipher = gnutls_cipher_get(sess);
713 name_cipher = gnutls_cipher_get_name(cipher);
714 name_mac = gnutls_mac_get_name(gnutls_mac_get(sess));
715 keysize = gnutls_cipher_get_key_size(cipher) * 8;
716 name_proto = gnutls_protocol_get_name(gnutls_protocol_get_version(sess));
717 name_keyexchange = gnutls_kx_get_name(gnutls_kx_get(sess));
719 return snprintf(buf, len, "%s-%s%15s Kx=%s Enc=%s(%u) Mac=%s",
720 name_cipher, name_mac, name_proto, name_keyexchange, name_cipher, keysize, name_mac) > 0;
729 ConnSSL_InitLibrary(void)
734 #endif /* SSL_SUPPORT */