2 * ngIRCd -- The Next Generation IRC Daemon
4 * SSL wrapper functions.
5 * Copyright (c) 2005-2008 Florian Westphal <fw@strlen.de>
24 #include "conn-func.h"
31 extern struct SSLOptions Conf_SSLOptions;
34 #include <openssl/err.h>
35 #include <openssl/rand.h>
37 static SSL_CTX * ssl_ctx;
40 static bool ConnSSL_LoadServerKey_openssl PARAMS(( SSL_CTX *c ));
44 #include <sys/types.h>
48 #include <gnutls/x509.h>
51 static gnutls_certificate_credentials_t x509_cred;
52 static gnutls_dh_params_t dh_params;
54 static bool ConnSSL_LoadServerKey_gnutls PARAMS(( void ));
57 static bool ConnSSL_Init_SSL PARAMS(( CONNECTION *c ));
58 static int ConnectAccept PARAMS(( CONNECTION *c, bool connect ));
59 static int ConnSSL_HandleError PARAMS(( CONNECTION *c, const int code, const char *fname ));
62 static char * openreadclose(const char *name, size_t *len)
67 int fd = open(name, O_RDONLY);
69 Log(LOG_ERR, "Could not open %s: %s", name, strerror(errno));
73 Log(LOG_ERR, "Could not fstat %s: %s", name, strerror(errno));
76 if (!S_ISREG(s.st_mode)) {
77 Log(LOG_ERR, "%s: Not a regular file", name);
81 Log(LOG_ERR, "%s: invalid file length (size %ld <= 0)", name, (long) s.st_size);
84 buf = malloc(s.st_size);
86 Log(LOG_ERR, "Could not malloc %lu bytes for file %s: %s", s.st_size, name, strerror(errno));
89 br = read(fd, buf, s.st_size);
90 if (br != (ssize_t)s.st_size) {
91 Log(LOG_ERR, "Could not read file %s: read returned %ld, expected %ld: %s",
92 name, (long) br, (long) s.st_size, br == -1 ? strerror(errno):"short read?!");
93 memset(buf, 0, s.st_size);
108 LogOpenSSLError( const char *msg, const char *msg2 )
110 unsigned long err = ERR_get_error();
111 char * errmsg = err ? ERR_error_string(err, NULL) : "Unable to determine error";
113 if (!msg) msg = "SSL Error";
115 Log( LOG_ERR, "%s: %s: %s", msg, msg2, errmsg);
117 Log( LOG_ERR, "%s: %s", msg, errmsg);
122 pem_passwd_cb(char *buf, int size, int rwflag, void *password)
124 array *pass = password;
127 (void)rwflag; /* rwflag is unused if DEBUG is not set. */
128 assert(rwflag == 0); /* 0 -> callback used for decryption.
129 * See SSL_CTX_set_default_passwd_cb(3) */
131 passlen = (int) array_bytes(pass);
133 LogDebug("pem_passwd_cb buf size %d, array size %d", size, passlen);
134 assert(passlen >= 0);
136 Log(LOG_ERR, "pem_passwd_cb: password required, but not set");
139 size = passlen > size ? size : passlen;
140 memcpy(buf, (char *)(array_start(pass)), size);
153 if (!Conf_SSLOptions.DHFile) {
154 Log(LOG_NOTICE, "Configuration option \"SSLDHFile\" not set");
157 fp = fopen(Conf_SSLOptions.DHFile, "r");
159 Log(LOG_ERR, "%s: %s", Conf_SSLOptions.DHFile, strerror(errno));
162 dh_params = PEM_read_DHparams(fp, NULL, NULL, NULL);
164 Log(LOG_ERR, "%s: PEM_read_DHparams failed", Conf_SSLOptions.DHFile);
170 #ifdef HAVE_LIBGNUTLS
171 bool need_dhgenerate = true;
173 gnutls_dh_params_t tmp_dh_params;
175 err = gnutls_dh_params_init(&tmp_dh_params);
177 Log(LOG_ERR, "gnutls_dh_params_init: %s", gnutls_strerror(err));
180 if (Conf_SSLOptions.DHFile) {
181 gnutls_datum_t dhparms;
183 dhparms.data = (unsigned char *) openreadclose(Conf_SSLOptions.DHFile, &size);
186 err = gnutls_dh_params_import_pkcs3(tmp_dh_params, &dhparms, GNUTLS_X509_FMT_PEM);
188 need_dhgenerate = false;
190 Log(LOG_ERR, "gnutls_dh_params_init: %s", gnutls_strerror(err));
192 memset(dhparms.data, 0, size);
196 if (need_dhgenerate) {
197 Log(LOG_WARNING, "SSLDHFile not set, generating %u bit DH parameters. This may take a while...", DH_BITS);
198 err = gnutls_dh_params_generate2(tmp_dh_params, DH_BITS);
200 Log(LOG_ERR, "gnutls_dh_params_generate2: %s", gnutls_strerror(err));
204 dh_params = tmp_dh_params;
210 void ConnSSL_Free(CONNECTION *c)
213 SSL *ssl = c->ssl_state.ssl;
217 c->ssl_state.ssl = NULL;
220 #ifdef HAVE_LIBGNUTLS
221 gnutls_session_t sess = c->ssl_state.gnutls_session;
222 if (Conn_OPTION_ISSET(c, CONN_SSL)) {
223 gnutls_bye(sess, GNUTLS_SHUT_RDWR);
227 assert(Conn_OPTION_ISSET(c, CONN_SSL));
228 Conn_OPTION_DEL(c, (CONN_SSL_CONNECT|CONN_SSL|CONN_SSL_WANT_WRITE));
233 ConnSSL_InitLibrary( void )
240 SSL_load_error_strings();
243 if (!RAND_status()) {
244 Log(LOG_ERR, "OpenSSL PRNG not seeded: /dev/urandom missing?");
246 * it is probably best to fail and let the user install EGD or a similar program if no kernel random device is available.
247 * According to OpenSSL RAND_egd(3): "The automatic query of /var/run/egd-pool et al was added in OpenSSL 0.9.7";
248 * so it makes little sense to deal with PRNGD seeding ourselves.
253 newctx = SSL_CTX_new(SSLv23_method());
255 LogOpenSSLError("SSL_CTX_new()", NULL);
259 if (!ConnSSL_LoadServerKey_openssl(newctx))
262 SSL_CTX_set_options(newctx, SSL_OP_SINGLE_DH_USE|SSL_OP_NO_SSLv2);
263 SSL_CTX_set_mode(newctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
264 SSL_CTX_free(ssl_ctx);
266 Log(LOG_INFO, "%s initialized", SSLeay_version(SSLEAY_VERSION));
269 SSL_CTX_free(newctx);
272 #ifdef HAVE_LIBGNUTLS
274 static bool initialized;
275 if (initialized) /* TODO: cannot reload gnutls keys: can't simply free x509 context -- it may still be in use */
278 err = gnutls_global_init();
280 Log(LOG_ERR, "gnutls_global_init(): %s", gnutls_strerror(err));
283 if (!ConnSSL_LoadServerKey_gnutls())
285 Log(LOG_INFO, "gnutls %s initialized", gnutls_check_version(NULL));
292 #ifdef HAVE_LIBGNUTLS
294 ConnSSL_LoadServerKey_gnutls(void)
297 const char *cert_file;
299 err = gnutls_certificate_allocate_credentials(&x509_cred);
301 Log(LOG_ERR, "gnutls_certificate_allocate_credentials: %s", gnutls_strerror(err));
305 cert_file = Conf_SSLOptions.CertFile ? Conf_SSLOptions.CertFile:Conf_SSLOptions.KeyFile;
307 Log(LOG_ERR, "Neither Key nor certificate File set");
311 if (array_bytes(&Conf_SSLOptions.KeyFilePassword))
312 Log(LOG_WARNING, "Ignoring KeyFilePassword: Not supported by GNUTLS");
314 if (!Load_DH_params())
317 gnutls_certificate_set_dh_params(x509_cred, dh_params);
318 err = gnutls_certificate_set_x509_key_file(x509_cred, cert_file, Conf_SSLOptions.KeyFile, GNUTLS_X509_FMT_PEM);
320 Log(LOG_ERR, "gnutls_certificate_set_x509_key_file (cert %s, key %s): %s",
321 cert_file, Conf_SSLOptions.KeyFile ? Conf_SSLOptions.KeyFile : "(NULL)", gnutls_strerror(err));
331 ConnSSL_LoadServerKey_openssl(SSL_CTX *ctx)
336 if (!Conf_SSLOptions.KeyFile) {
337 Log(LOG_NOTICE, "No SSL Server Key configured, ssl disabled");
341 SSL_CTX_set_default_passwd_cb(ctx, pem_passwd_cb);
342 SSL_CTX_set_default_passwd_cb_userdata(ctx, &Conf_SSLOptions.KeyFilePassword);
344 if (SSL_CTX_use_PrivateKey_file(ctx, Conf_SSLOptions.KeyFile, SSL_FILETYPE_PEM) != 1) {
345 array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
346 LogOpenSSLError("SSL_CTX_use_PrivateKey_file", Conf_SSLOptions.KeyFile);
350 cert_key = Conf_SSLOptions.CertFile ? Conf_SSLOptions.CertFile:Conf_SSLOptions.KeyFile;
351 if (SSL_CTX_use_certificate_chain_file(ctx, cert_key) != 1) {
352 array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
353 LogOpenSSLError("SSL_CTX_use_certificate_file", cert_key);
357 array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
359 if (!SSL_CTX_check_private_key(ctx)) {
360 LogOpenSSLError("Server Private Key does not match certificate", NULL);
363 if (Load_DH_params()) {
364 if (SSL_CTX_set_tmp_dh(ctx, dh_params) != 1)
365 LogOpenSSLError("Error setting DH Parameters", Conf_SSLOptions.DHFile);
366 /* don't return false here: the non-DH modes will still work */
376 ConnSSL_Init_SSL(CONNECTION *c)
382 if (!ssl_ctx) /* NULL when library initialization failed */
385 assert(c->ssl_state.ssl == NULL);
387 c->ssl_state.ssl = SSL_new(ssl_ctx);
388 if (!c->ssl_state.ssl) {
389 LogOpenSSLError("SSL_new()", NULL);
393 ret = SSL_set_fd(c->ssl_state.ssl, c->sock);
395 LogOpenSSLError("SSL_set_fd()", NULL);
400 #ifdef HAVE_LIBGNUTLS
401 ret = gnutls_set_default_priority(c->ssl_state.gnutls_session);
403 Log(LOG_ERR, "gnutls_set_default_priority: %s", gnutls_strerror(ret));
407 * The intermediate (long) cast is here to avoid a warning like:
408 * "cast to pointer from integer of different size" on 64-bit platforms.
409 * There doesn't seem to be an alternate GNUTLS API we could use instead, see e.g.
410 * http://www.mail-archive.com/help-gnutls@gnu.org/msg00286.html
412 gnutls_transport_set_ptr(c->ssl_state.gnutls_session, (gnutls_transport_ptr_t) (long) c->sock);
413 ret = gnutls_credentials_set(c->ssl_state.gnutls_session, GNUTLS_CRD_CERTIFICATE, x509_cred);
415 Log(LOG_ERR, "gnutls_credentials_set: %s", gnutls_strerror(ret));
418 gnutls_dh_set_prime_bits(c->ssl_state.gnutls_session, DH_BITS);
420 Conn_OPTION_ADD(c, CONN_SSL);
426 ConnSSL_PrepareConnect(CONNECTION *c, UNUSED CONF_SERVER *s)
429 #ifdef HAVE_LIBGNUTLS
434 #ifdef HAVE_LIBGNUTLS
435 err = gnutls_init(&c->ssl_state.gnutls_session, GNUTLS_CLIENT);
437 Log(LOG_ERR, "gnutls_init: %s", gnutls_strerror(err));
441 ret = ConnSSL_Init_SSL(c);
444 Conn_OPTION_ADD(c, CONN_SSL_CONNECT);
446 assert(c->ssl_state.ssl);
447 SSL_set_verify(c->ssl_state.ssl, SSL_VERIFY_NONE, NULL);
454 Check an Handle Error return code after failed calls to ssl/tls functions.
456 SSL_connect(), SSL_accept(), SSL_do_handshake(), SSL_read(), SSL_peek(), or SSL_write() on ssl.
458 gnutlsssl_read(), gnutls_write() or gnutls_handshake().
459 Return: -1 on fatal error, 0 if we can try again later.
462 ConnSSL_HandleError( CONNECTION *c, const int code, const char *fname )
465 int ret = SSL_ERROR_SYSCALL;
466 unsigned long sslerr;
467 int real_errno = errno;
471 ret = SSL_get_error(c->ssl_state.ssl, code);
473 case SSL_ERROR_WANT_READ:
474 io_event_del(c->sock, IO_WANTWRITE);
475 Conn_OPTION_ADD(c, CONN_SSL_WANT_READ);
476 return 0; /* try again later */
477 case SSL_ERROR_WANT_WRITE:
478 io_event_del(c->sock, IO_WANTREAD);
479 Conn_OPTION_ADD(c, CONN_SSL_WANT_WRITE); /* fall through */
481 return 0; /* try again later */
482 case SSL_ERROR_ZERO_RETURN: /* TLS/SSL Connection was shut down */
483 LogOpenSSLError("TLS/SSL Connection shutdown", fname);
486 SSL_ERROR_WANT_CONNECT, SSL_ERROR_WANT_ACCEPT, SSL_ERROR_WANT_X509_LOOKUP
488 case SSL_ERROR_SYSCALL:
489 sslerr = ERR_get_error();
491 Log( LOG_ERR, "%s: %s", fname, ERR_error_string(sslerr, NULL ));
494 switch (code) { /* EOF that violated protocol */
496 Log(LOG_ERR, "%s: Client Disconnected", fname );
498 case -1: /* low level socket I/O error, check errno */
499 Log(LOG_ERR, "%s: %s", fname, strerror(real_errno));
504 LogOpenSSLError("TLS/SSL Protocol Error", fname);
507 Log( LOG_ERR, "%s: Unknown error %d!", fname, ret);
512 #ifdef HAVE_LIBGNUTLS
515 case GNUTLS_E_INTERRUPTED:
516 if (gnutls_record_get_direction(c->ssl_state.gnutls_session)) { /* need write */
517 io_event_del(c->sock, IO_WANTREAD);
518 Conn_OPTION_ADD(c, CONN_SSL_WANT_WRITE); /* fall through */
520 } else { /* need read */
521 io_event_del(c->sock, IO_WANTWRITE);
522 Conn_OPTION_ADD(c, CONN_SSL_WANT_READ);
527 if (gnutls_error_is_fatal(code)) {
528 Log(LOG_ERR, "%s: %s", fname, gnutls_strerror(code));
539 ConnSSL_LogCertInfo( CONNECTION *c )
542 SSL *ssl = c->ssl_state.ssl;
547 Log( LOG_INFO, "New %s connection using cipher %s on socket %d",
548 SSL_get_version(ssl), SSL_get_cipher(ssl), c->sock);
550 #ifdef HAVE_LIBGNUTLS
551 gnutls_session_t sess = c->ssl_state.gnutls_session;
552 gnutls_cipher_algorithm_t cipher = gnutls_cipher_get(sess);
554 Log( LOG_INFO, "New %s connection using cipher %s-%s on socket %d",
555 gnutls_protocol_get_name(gnutls_protocol_get_version(sess)),
556 gnutls_cipher_get_name(cipher), gnutls_mac_get_name(gnutls_mac_get(sess)), c->sock);
562 Accept incoming SSL connection.
564 1: SSL Connection established
566 -1: SSL Connection not established due to fatal error.
569 ConnSSL_Accept( CONNECTION *c )
573 if (!c->ssl_state.ssl) {
575 #ifdef HAVE_LIBGNUTLS
576 if (!Conn_OPTION_ISSET(c, CONN_SSL)) {
577 int err = gnutls_init(&c->ssl_state.gnutls_session, GNUTLS_SERVER);
579 Log(LOG_ERR, "gnutls_init: %s", gnutls_strerror(err));
583 LogDebug("ConnSSL_Accept: Initializing SSL data");
584 if (!ConnSSL_Init_SSL(c))
587 return ConnectAccept(c, false );
592 ConnSSL_Connect( CONNECTION *c )
596 assert(c->ssl_state.ssl);
598 #ifdef HAVE_LIBGNUTLS
599 assert(Conn_OPTION_ISSET(c, CONN_SSL));
601 return ConnectAccept(c, true);
605 /* accept/connect wrapper. if connect is true, connect to peer, otherwise wait for incoming connection */
607 ConnectAccept( CONNECTION *c, bool connect)
611 SSL *ssl = c->ssl_state.ssl;
614 ret = connect ? SSL_connect(ssl) : SSL_accept(ssl);
616 return ConnSSL_HandleError(c, ret, connect ? "SSL_connect": "SSL_accept");
618 #ifdef HAVE_LIBGNUTLS
620 assert(Conn_OPTION_ISSET(c, CONN_SSL));
621 ret = gnutls_handshake(c->ssl_state.gnutls_session);
623 return ConnSSL_HandleError(c, ret, "gnutls_handshake");
625 Conn_OPTION_DEL(c, (CONN_SSL_WANT_WRITE|CONN_SSL_WANT_READ|CONN_SSL_CONNECT));
626 ConnSSL_LogCertInfo(c);
632 ConnSSL_Write(CONNECTION *c, const void *buf, size_t count)
636 Conn_OPTION_DEL(c, CONN_SSL_WANT_WRITE|CONN_SSL_WANT_READ);
640 bw = (ssize_t) SSL_write(c->ssl_state.ssl, buf, count);
642 #ifdef HAVE_LIBGNUTLS
643 bw = gnutls_write(c->ssl_state.gnutls_session, buf, count);
645 if ( bw > 0 ) return bw;
646 if (ConnSSL_HandleError( c, bw, "ConnSSL_Write") == 0)
647 errno = EAGAIN; /* try again */
653 ConnSSL_Read(CONNECTION *c, void * buf, size_t count)
657 Conn_OPTION_DEL(c, CONN_SSL_WANT_WRITE|CONN_SSL_WANT_READ);
659 br = (ssize_t) SSL_read(c->ssl_state.ssl, buf, count);
660 if (br > 0) /* on EOF we have to call ConnSSL_HandleError(), see SSL_read(3) */
663 #ifdef HAVE_LIBGNUTLS
664 br = gnutls_read(c->ssl_state.gnutls_session, buf, count);
665 if (br >= 0) /* on EOF we must _not_ call ConnSSL_HandleError, see gnutls_record_recv(3) */
668 /* error on read: switch ConnSSL_HandleError() return values -> 0 is "try again", so return -1 and set EAGAIN */
669 if (ConnSSL_HandleError(c, br, "ConnSSL_Read") == 0) {
678 ConnSSL_GetCipherInfo(CONNECTION *c, char *buf, size_t len)
686 ssl = c->ssl_state.ssl;
690 SSL_CIPHER_description(SSL_get_current_cipher(ssl), buf, len);
691 nl = strchr(buf, '\n');
696 #ifdef HAVE_LIBGNUTLS
699 if (Conn_OPTION_ISSET(c, CONN_SSL)) {
700 const char *name_cipher, *name_mac, *name_proto, *name_keyexchange;
703 gnutls_session_t sess = c->ssl_state.gnutls_session;
704 gnutls_cipher_algorithm_t cipher = gnutls_cipher_get(sess);
705 name_cipher = gnutls_cipher_get_name(cipher);
706 name_mac = gnutls_mac_get_name(gnutls_mac_get(sess));
707 keysize = gnutls_cipher_get_key_size(cipher) * 8;
708 name_proto = gnutls_protocol_get_name(gnutls_protocol_get_version(sess));
709 name_keyexchange = gnutls_kx_get_name(gnutls_kx_get(sess));
711 return snprintf(buf, len, "%s-%s%15s Kx=%s Enc=%s(%u) Mac=%s",
712 name_cipher, name_mac, name_proto, name_keyexchange, name_cipher, keysize, name_mac) > 0;
719 #endif /* SSL_SUPPORT */