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!",
165 Conf_SSLOptions.DHFile);
171 #ifdef HAVE_LIBGNUTLS
172 bool need_dhgenerate = true;
174 gnutls_dh_params_t tmp_dh_params;
176 err = gnutls_dh_params_init(&tmp_dh_params);
178 Log(LOG_ERR, "gnutls_dh_params_init: %s", gnutls_strerror(err));
181 if (Conf_SSLOptions.DHFile) {
182 gnutls_datum_t dhparms;
184 dhparms.data = (unsigned char *) openreadclose(Conf_SSLOptions.DHFile, &size);
187 err = gnutls_dh_params_import_pkcs3(tmp_dh_params, &dhparms, GNUTLS_X509_FMT_PEM);
189 need_dhgenerate = false;
191 Log(LOG_ERR, "gnutls_dh_params_init: %s", gnutls_strerror(err));
193 memset(dhparms.data, 0, size);
197 if (need_dhgenerate) {
199 "SSLDHFile not set, generating %u bit DH parameters. This may take a while ...",
201 err = gnutls_dh_params_generate2(tmp_dh_params, DH_BITS);
203 Log(LOG_ERR, "gnutls_dh_params_generate2: %s", gnutls_strerror(err));
207 dh_params = tmp_dh_params;
213 void ConnSSL_Free(CONNECTION *c)
216 SSL *ssl = c->ssl_state.ssl;
220 c->ssl_state.ssl = NULL;
223 #ifdef HAVE_LIBGNUTLS
224 gnutls_session_t sess = c->ssl_state.gnutls_session;
225 if (Conn_OPTION_ISSET(c, CONN_SSL)) {
226 gnutls_bye(sess, GNUTLS_SHUT_RDWR);
230 assert(Conn_OPTION_ISSET(c, CONN_SSL));
231 /* can't just set bitmask to 0 -- there are other, non-ssl related flags, e.g. CONN_ZIP. */
232 Conn_OPTION_DEL(c, CONN_SSL_FLAGS_ALL);
237 ConnSSL_InitLibrary( void )
244 SSL_load_error_strings();
247 if (!RAND_status()) {
248 Log(LOG_ERR, "OpenSSL PRNG not seeded: /dev/urandom missing?");
250 * it is probably best to fail and let the user install EGD or a similar program if no kernel random device is available.
251 * According to OpenSSL RAND_egd(3): "The automatic query of /var/run/egd-pool et al was added in OpenSSL 0.9.7";
252 * so it makes little sense to deal with PRNGD seeding ourselves.
257 newctx = SSL_CTX_new(SSLv23_method());
259 LogOpenSSLError("SSL_CTX_new()", NULL);
263 if (!ConnSSL_LoadServerKey_openssl(newctx))
266 SSL_CTX_set_options(newctx, SSL_OP_SINGLE_DH_USE|SSL_OP_NO_SSLv2);
267 SSL_CTX_set_mode(newctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
268 SSL_CTX_free(ssl_ctx);
270 Log(LOG_INFO, "%s initialized.", SSLeay_version(SSLEAY_VERSION));
273 SSL_CTX_free(newctx);
276 #ifdef HAVE_LIBGNUTLS
278 static bool initialized;
279 if (initialized) /* TODO: cannot reload gnutls keys: can't simply free x509 context -- it may still be in use */
282 err = gnutls_global_init();
284 Log(LOG_ERR, "gnutls_global_init(): %s", gnutls_strerror(err));
287 if (!ConnSSL_LoadServerKey_gnutls())
289 Log(LOG_INFO, "gnutls %s initialized.", gnutls_check_version(NULL));
296 #ifdef HAVE_LIBGNUTLS
298 ConnSSL_LoadServerKey_gnutls(void)
301 const char *cert_file;
303 err = gnutls_certificate_allocate_credentials(&x509_cred);
305 Log(LOG_ERR, "gnutls_certificate_allocate_credentials: %s", gnutls_strerror(err));
309 cert_file = Conf_SSLOptions.CertFile ? Conf_SSLOptions.CertFile:Conf_SSLOptions.KeyFile;
311 Log(LOG_NOTICE, "No SSL server key configured, SSL disabled.");
315 if (array_bytes(&Conf_SSLOptions.KeyFilePassword))
317 "Ignoring KeyFilePassword: Not supported by GNUTLS.");
319 if (!Load_DH_params())
322 gnutls_certificate_set_dh_params(x509_cred, dh_params);
323 err = gnutls_certificate_set_x509_key_file(x509_cred, cert_file, Conf_SSLOptions.KeyFile, GNUTLS_X509_FMT_PEM);
325 Log(LOG_ERR, "gnutls_certificate_set_x509_key_file (cert %s, key %s): %s",
326 cert_file, Conf_SSLOptions.KeyFile ? Conf_SSLOptions.KeyFile : "(NULL)", gnutls_strerror(err));
336 ConnSSL_LoadServerKey_openssl(SSL_CTX *ctx)
341 if (!Conf_SSLOptions.KeyFile) {
342 Log(LOG_NOTICE, "No SSL server key configured, SSL disabled.");
346 SSL_CTX_set_default_passwd_cb(ctx, pem_passwd_cb);
347 SSL_CTX_set_default_passwd_cb_userdata(ctx, &Conf_SSLOptions.KeyFilePassword);
349 if (SSL_CTX_use_PrivateKey_file(ctx, Conf_SSLOptions.KeyFile, SSL_FILETYPE_PEM) != 1) {
350 array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
351 LogOpenSSLError("SSL_CTX_use_PrivateKey_file", Conf_SSLOptions.KeyFile);
355 cert_key = Conf_SSLOptions.CertFile ? Conf_SSLOptions.CertFile:Conf_SSLOptions.KeyFile;
356 if (SSL_CTX_use_certificate_chain_file(ctx, cert_key) != 1) {
357 array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
358 LogOpenSSLError("SSL_CTX_use_certificate_file", cert_key);
362 array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
364 if (!SSL_CTX_check_private_key(ctx)) {
365 LogOpenSSLError("Server Private Key does not match certificate", NULL);
368 if (Load_DH_params()) {
369 if (SSL_CTX_set_tmp_dh(ctx, dh_params) != 1)
370 LogOpenSSLError("Error setting DH Parameters", Conf_SSLOptions.DHFile);
371 /* don't return false here: the non-DH modes will still work */
381 ConnSSL_Init_SSL(CONNECTION *c)
387 Log(LOG_ERR, "Cannot init ssl_ctx: OpenSSL initialization failed at startup");
390 assert(c->ssl_state.ssl == NULL);
392 c->ssl_state.ssl = SSL_new(ssl_ctx);
393 if (!c->ssl_state.ssl) {
394 LogOpenSSLError("SSL_new()", NULL);
398 ret = SSL_set_fd(c->ssl_state.ssl, c->sock);
400 LogOpenSSLError("SSL_set_fd()", NULL);
405 #ifdef HAVE_LIBGNUTLS
406 ret = gnutls_set_default_priority(c->ssl_state.gnutls_session);
408 Log(LOG_ERR, "gnutls_set_default_priority: %s", gnutls_strerror(ret));
413 * The intermediate (long) cast is here to avoid a warning like:
414 * "cast to pointer from integer of different size" on 64-bit platforms.
415 * There doesn't seem to be an alternate GNUTLS API we could use instead, see e.g.
416 * http://www.mail-archive.com/help-gnutls@gnu.org/msg00286.html
418 gnutls_transport_set_ptr(c->ssl_state.gnutls_session, (gnutls_transport_ptr_t) (long) c->sock);
419 ret = gnutls_credentials_set(c->ssl_state.gnutls_session, GNUTLS_CRD_CERTIFICATE, x509_cred);
421 Log(LOG_ERR, "gnutls_credentials_set: %s", gnutls_strerror(ret));
425 gnutls_dh_set_prime_bits(c->ssl_state.gnutls_session, DH_BITS);
427 Conn_OPTION_ADD(c, CONN_SSL);
433 ConnSSL_PrepareConnect(CONNECTION *c, UNUSED CONF_SERVER *s)
436 #ifdef HAVE_LIBGNUTLS
439 err = gnutls_init(&c->ssl_state.gnutls_session, GNUTLS_CLIENT);
441 Log(LOG_ERR, "gnutls_init: %s", gnutls_strerror(err));
445 ret = ConnSSL_Init_SSL(c);
448 Conn_OPTION_ADD(c, CONN_SSL_CONNECT);
450 assert(c->ssl_state.ssl);
451 SSL_set_verify(c->ssl_state.ssl, SSL_VERIFY_NONE, NULL);
458 Check an Handle Error return code after failed calls to ssl/tls functions.
460 SSL_connect(), SSL_accept(), SSL_do_handshake(), SSL_read(), SSL_peek(), or SSL_write() on ssl.
462 gnutlsssl_read(), gnutls_write() or gnutls_handshake().
463 Return: -1 on fatal error, 0 if we can try again later.
466 ConnSSL_HandleError( CONNECTION *c, const int code, const char *fname )
469 int ret = SSL_ERROR_SYSCALL;
470 unsigned long sslerr;
471 int real_errno = errno;
473 ret = SSL_get_error(c->ssl_state.ssl, code);
475 case SSL_ERROR_WANT_READ:
476 io_event_del(c->sock, IO_WANTWRITE);
477 Conn_OPTION_ADD(c, CONN_SSL_WANT_READ);
478 return 0; /* try again later */
479 case SSL_ERROR_WANT_WRITE:
480 io_event_del(c->sock, IO_WANTREAD);
481 Conn_OPTION_ADD(c, CONN_SSL_WANT_WRITE); /* fall through */
483 return 0; /* try again later */
484 case SSL_ERROR_ZERO_RETURN:
485 LogDebug("TLS/SSL connection shut down normally");
488 SSL_ERROR_WANT_CONNECT, SSL_ERROR_WANT_ACCEPT, SSL_ERROR_WANT_X509_LOOKUP
490 case SSL_ERROR_SYSCALL:
491 sslerr = ERR_get_error();
493 Log( LOG_ERR, "%s: %s", fname, ERR_error_string(sslerr, NULL ));
496 switch (code) { /* EOF that violated protocol */
498 Log(LOG_ERR, "%s: Client Disconnected", fname );
500 case -1: /* low level socket I/O error, check errno */
501 Log(LOG_ERR, "%s: %s", fname, strerror(real_errno));
506 LogOpenSSLError("TLS/SSL Protocol Error", fname);
509 Log( LOG_ERR, "%s: Unknown error %d!", fname, ret);
514 #ifdef HAVE_LIBGNUTLS
517 case GNUTLS_E_INTERRUPTED:
518 if (gnutls_record_get_direction(c->ssl_state.gnutls_session)) {
519 Conn_OPTION_ADD(c, CONN_SSL_WANT_WRITE);
520 io_event_del(c->sock, IO_WANTREAD);
522 Conn_OPTION_ADD(c, CONN_SSL_WANT_READ);
523 io_event_del(c->sock, IO_WANTWRITE);
528 if (gnutls_error_is_fatal(code)) {
529 Log(LOG_ERR, "%s: %s", fname, gnutls_strerror(code));
540 ConnSSL_LogCertInfo( CONNECTION *c )
543 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),
557 gnutls_mac_get_name(gnutls_mac_get(sess)), c->sock);
563 Accept incoming SSL connection.
565 1: SSL Connection established
567 -1: SSL Connection not established due to fatal error.
570 ConnSSL_Accept( CONNECTION *c )
573 if (!Conn_OPTION_ISSET(c, CONN_SSL)) {
574 #ifdef HAVE_LIBGNUTLS
575 int err = gnutls_init(&c->ssl_state.gnutls_session, GNUTLS_SERVER);
577 Log(LOG_ERR, "gnutls_init: %s", gnutls_strerror(err));
581 LogDebug("ConnSSL_Accept: Initializing SSL data");
582 if (!ConnSSL_Init_SSL(c))
585 return ConnectAccept(c, false );
590 ConnSSL_Connect( CONNECTION *c )
594 assert(c->ssl_state.ssl);
596 assert(Conn_OPTION_ISSET(c, CONN_SSL));
597 return ConnectAccept(c, true);
601 /* accept/connect wrapper. if connect is true, connect to peer, otherwise wait for incoming connection */
603 ConnectAccept( CONNECTION *c, bool connect)
607 SSL *ssl = c->ssl_state.ssl;
610 ret = connect ? SSL_connect(ssl) : SSL_accept(ssl);
612 return ConnSSL_HandleError(c, ret, connect ? "SSL_connect": "SSL_accept");
614 #ifdef HAVE_LIBGNUTLS
616 ret = gnutls_handshake(c->ssl_state.gnutls_session);
618 return ConnSSL_HandleError(c, ret, "gnutls_handshake");
620 Conn_OPTION_DEL(c, (CONN_SSL_WANT_WRITE|CONN_SSL_WANT_READ|CONN_SSL_CONNECT));
621 ConnSSL_LogCertInfo(c);
627 ConnSSL_Write(CONNECTION *c, const void *buf, size_t count)
631 Conn_OPTION_DEL(c, CONN_SSL_WANT_WRITE|CONN_SSL_WANT_READ);
635 bw = (ssize_t) SSL_write(c->ssl_state.ssl, buf, count);
637 #ifdef HAVE_LIBGNUTLS
638 bw = gnutls_write(c->ssl_state.gnutls_session, buf, count);
642 if (ConnSSL_HandleError( c, bw, "ConnSSL_Write") == 0)
643 errno = EAGAIN; /* try again */
649 ConnSSL_Read(CONNECTION *c, void * buf, size_t count)
653 Conn_OPTION_DEL(c, CONN_SSL_WANT_WRITE|CONN_SSL_WANT_READ);
655 br = (ssize_t) SSL_read(c->ssl_state.ssl, buf, count);
656 if (br > 0) /* on EOF we have to call ConnSSL_HandleError(), see SSL_read(3) */
659 #ifdef HAVE_LIBGNUTLS
660 br = gnutls_read(c->ssl_state.gnutls_session, buf, count);
661 if (br >= 0) /* on EOF we must _not_ call ConnSSL_HandleError, see gnutls_record_recv(3) */
664 /* error on read: switch ConnSSL_HandleError() return values -> 0 is "try again", so return -1 and set EAGAIN */
665 if (ConnSSL_HandleError(c, br, "ConnSSL_Read") == 0) {
674 ConnSSL_GetCipherInfo(CONNECTION *c, char *buf, size_t len)
678 SSL *ssl = c->ssl_state.ssl;
683 SSL_CIPHER_description(SSL_get_current_cipher(ssl), buf, len);
684 nl = strchr(buf, '\n');
689 #ifdef HAVE_LIBGNUTLS
690 if (Conn_OPTION_ISSET(c, CONN_SSL)) {
691 const char *name_cipher, *name_mac, *name_proto, *name_keyexchange;
694 gnutls_session_t sess = c->ssl_state.gnutls_session;
695 gnutls_cipher_algorithm_t cipher = gnutls_cipher_get(sess);
696 name_cipher = gnutls_cipher_get_name(cipher);
697 name_mac = gnutls_mac_get_name(gnutls_mac_get(sess));
698 keysize = gnutls_cipher_get_key_size(cipher) * 8;
699 name_proto = gnutls_protocol_get_name(gnutls_protocol_get_version(sess));
700 name_keyexchange = gnutls_kx_get_name(gnutls_kx_get(sess));
702 return snprintf(buf, len, "%s-%s%15s Kx=%s Enc=%s(%u) Mac=%s",
703 name_cipher, name_mac, name_proto, name_keyexchange, name_cipher, keysize, name_mac) > 0;
710 #endif /* SSL_SUPPORT */