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;
126 assert(rwflag == 0); /* 0 -> callback used for decryption. See SSL_CTX_set_default_passwd_cb(3) */
128 passlen = (int) array_bytes(pass);
130 LogDebug("pem_passwd_cb buf size %d, array size %d", size, passlen);
131 assert(passlen >= 0);
133 Log(LOG_ERR, "pem_passwd_cb: password required, but not set");
136 size = passlen > size ? size : passlen;
137 memcpy(buf, (char *)(array_start(pass)), size);
150 if (!Conf_SSLOptions.DHFile) {
151 Log(LOG_NOTICE, "Configuration option \"SSLDHFile\" not set");
154 fp = fopen(Conf_SSLOptions.DHFile, "r");
156 Log(LOG_ERR, "%s: %s", Conf_SSLOptions.DHFile, strerror(errno));
159 dh_params = PEM_read_DHparams(fp, NULL, NULL, NULL);
161 Log(LOG_ERR, "%s: PEM_read_DHparams failed", Conf_SSLOptions.DHFile);
167 #ifdef HAVE_LIBGNUTLS
168 bool need_dhgenerate = true;
170 gnutls_dh_params_t tmp_dh_params;
172 err = gnutls_dh_params_init(&tmp_dh_params);
174 Log(LOG_ERR, "gnutls_dh_params_init: %s", gnutls_strerror(err));
177 if (Conf_SSLOptions.DHFile) {
178 gnutls_datum_t dhparms;
180 dhparms.data = (unsigned char *) openreadclose(Conf_SSLOptions.DHFile, &size);
183 err = gnutls_dh_params_import_pkcs3(tmp_dh_params, &dhparms, GNUTLS_X509_FMT_PEM);
185 need_dhgenerate = false;
187 Log(LOG_ERR, "gnutls_dh_params_init: %s", gnutls_strerror(err));
189 memset(dhparms.data, 0, size);
193 if (need_dhgenerate) {
194 Log(LOG_WARNING, "SSLDHFile not set, generating %u bit DH parameters. This may take a while...", DH_BITS);
195 err = gnutls_dh_params_generate2(tmp_dh_params, DH_BITS);
197 Log(LOG_ERR, "gnutls_dh_params_generate2: %s", gnutls_strerror(err));
201 dh_params = tmp_dh_params;
207 void ConnSSL_Free(CONNECTION *c)
210 SSL *ssl = c->ssl_state.ssl;
214 c->ssl_state.ssl = NULL;
217 #ifdef HAVE_LIBGNUTLS
218 gnutls_session_t sess = c->ssl_state.gnutls_session;
219 if (Conn_OPTION_ISSET(c, CONN_SSL)) {
220 gnutls_bye(sess, GNUTLS_SHUT_RDWR);
224 assert(Conn_OPTION_ISSET(c, CONN_SSL));
225 Conn_OPTION_DEL(c, (CONN_SSL_CONNECT|CONN_SSL|CONN_SSL_WANT_WRITE));
230 ConnSSL_InitLibrary( void )
237 SSL_load_error_strings();
240 if (!RAND_status()) {
241 Log(LOG_ERR, "OpenSSL PRNG not seeded: /dev/urandom missing?");
243 * it is probably best to fail and let the user install EGD or a similar program if no kernel random device is available.
244 * According to OpenSSL RAND_egd(3): "The automatic query of /var/run/egd-pool et al was added in OpenSSL 0.9.7";
245 * so it makes little sense to deal with PRNGD seeding ourselves.
250 newctx = SSL_CTX_new(SSLv23_method());
252 LogOpenSSLError("SSL_CTX_new()", NULL);
256 if (!ConnSSL_LoadServerKey_openssl(newctx))
259 SSL_CTX_set_options(newctx, SSL_OP_SINGLE_DH_USE|SSL_OP_NO_SSLv2);
260 SSL_CTX_set_mode(newctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
261 SSL_CTX_free(ssl_ctx);
263 Log(LOG_INFO, "%s initialized", SSLeay_version(SSLEAY_VERSION));
266 SSL_CTX_free(newctx);
269 #ifdef HAVE_LIBGNUTLS
271 static bool initialized;
272 if (initialized) /* TODO: cannot reload gnutls keys: can't simply free x509 context -- it may still be in use */
275 err = gnutls_global_init();
277 Log(LOG_ERR, "gnutls_global_init(): %s", gnutls_strerror(err));
280 if (!ConnSSL_LoadServerKey_gnutls())
282 Log(LOG_INFO, "gnutls %s initialized", gnutls_check_version(NULL));
289 #ifdef HAVE_LIBGNUTLS
291 ConnSSL_LoadServerKey_gnutls(void)
294 const char *cert_file;
296 err = gnutls_certificate_allocate_credentials(&x509_cred);
298 Log(LOG_ERR, "gnutls_certificate_allocate_credentials: %s", gnutls_strerror(err));
302 cert_file = Conf_SSLOptions.CertFile ? Conf_SSLOptions.CertFile:Conf_SSLOptions.KeyFile;
304 Log(LOG_ERR, "Neither Key nor certificate File set");
308 if (array_bytes(&Conf_SSLOptions.KeyFilePassword))
309 Log(LOG_WARNING, "Ignoring KeyFilePassword: Not supported by GNUTLS");
311 if (!Load_DH_params())
314 gnutls_certificate_set_dh_params(x509_cred, dh_params);
315 err = gnutls_certificate_set_x509_key_file(x509_cred, cert_file, Conf_SSLOptions.KeyFile, GNUTLS_X509_FMT_PEM);
317 Log(LOG_ERR, "gnutls_certificate_set_x509_key_file (cert %s, key %s): %s",
318 cert_file, Conf_SSLOptions.KeyFile ? Conf_SSLOptions.KeyFile : "(NULL)", gnutls_strerror(err));
328 ConnSSL_LoadServerKey_openssl(SSL_CTX *ctx)
333 if (!Conf_SSLOptions.KeyFile) {
334 Log(LOG_NOTICE, "No SSL Server Key configured, ssl disabled");
338 SSL_CTX_set_default_passwd_cb(ctx, pem_passwd_cb);
339 SSL_CTX_set_default_passwd_cb_userdata(ctx, &Conf_SSLOptions.KeyFilePassword);
341 if (SSL_CTX_use_PrivateKey_file(ctx, Conf_SSLOptions.KeyFile, SSL_FILETYPE_PEM) != 1) {
342 array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
343 LogOpenSSLError("SSL_CTX_use_PrivateKey_file", Conf_SSLOptions.KeyFile);
347 cert_key = Conf_SSLOptions.CertFile ? Conf_SSLOptions.CertFile:Conf_SSLOptions.KeyFile;
348 if (SSL_CTX_use_certificate_chain_file(ctx, cert_key) != 1) {
349 array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
350 LogOpenSSLError("SSL_CTX_use_certificate_file", cert_key);
354 array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
356 if (!SSL_CTX_check_private_key(ctx)) {
357 LogOpenSSLError("Server Private Key does not match certificate", NULL);
360 if (Load_DH_params()) {
361 if (SSL_CTX_set_tmp_dh(ctx, dh_params) != 1)
362 LogOpenSSLError("Error setting DH Parameters", Conf_SSLOptions.DHFile);
363 /* don't return false here: the non-DH modes will still work */
373 ConnSSL_Init_SSL(CONNECTION *c)
379 if (!ssl_ctx) /* NULL when library initialization failed */
382 assert(c->ssl_state.ssl == NULL);
384 c->ssl_state.ssl = SSL_new(ssl_ctx);
385 if (!c->ssl_state.ssl) {
386 LogOpenSSLError("SSL_new()", NULL);
390 ret = SSL_set_fd(c->ssl_state.ssl, c->sock);
392 LogOpenSSLError("SSL_set_fd()", NULL);
397 #ifdef HAVE_LIBGNUTLS
398 ret = gnutls_set_default_priority(c->ssl_state.gnutls_session);
400 Log(LOG_ERR, "gnutls_set_default_priority: %s", gnutls_strerror(ret));
404 * The intermediate (long) cast is here to avoid a warning like:
405 * "cast to pointer from integer of different size" on 64-bit platforms.
406 * There doesn't seem to be an alternate GNUTLS API we could use instead, see e.g.
407 * http://www.mail-archive.com/help-gnutls@gnu.org/msg00286.html
409 gnutls_transport_set_ptr(c->ssl_state.gnutls_session, (gnutls_transport_ptr_t) (long) c->sock);
410 ret = gnutls_credentials_set(c->ssl_state.gnutls_session, GNUTLS_CRD_CERTIFICATE, x509_cred);
412 Log(LOG_ERR, "gnutls_credentials_set: %s", gnutls_strerror(ret));
415 gnutls_dh_set_prime_bits(c->ssl_state.gnutls_session, DH_BITS);
417 Conn_OPTION_ADD(c, CONN_SSL);
423 ConnSSL_PrepareConnect(CONNECTION *c, UNUSED CONF_SERVER *s)
426 #ifdef HAVE_LIBGNUTLS
431 #ifdef HAVE_LIBGNUTLS
432 err = gnutls_init(&c->ssl_state.gnutls_session, GNUTLS_CLIENT);
434 Log(LOG_ERR, "gnutls_init: %s", gnutls_strerror(err));
438 ret = ConnSSL_Init_SSL(c);
441 Conn_OPTION_ADD(c, CONN_SSL_CONNECT);
443 assert(c->ssl_state.ssl);
444 SSL_set_verify(c->ssl_state.ssl, SSL_VERIFY_NONE, NULL);
451 Check an Handle Error return code after failed calls to ssl/tls functions.
453 SSL_connect(), SSL_accept(), SSL_do_handshake(), SSL_read(), SSL_peek(), or SSL_write() on ssl.
455 gnutlsssl_read(), gnutls_write() or gnutls_handshake().
456 Return: -1 on fatal error, 0 if we can try again later.
459 ConnSSL_HandleError( CONNECTION *c, const int code, const char *fname )
462 int ret = SSL_ERROR_SYSCALL;
463 unsigned long sslerr;
464 int real_errno = errno;
468 ret = SSL_get_error(c->ssl_state.ssl, code);
470 case SSL_ERROR_WANT_READ:
471 io_event_del(c->sock, IO_WANTWRITE);
472 Conn_OPTION_ADD(c, CONN_SSL_WANT_READ);
473 return 0; /* try again later */
474 case SSL_ERROR_WANT_WRITE:
475 io_event_del(c->sock, IO_WANTREAD);
476 Conn_OPTION_ADD(c, CONN_SSL_WANT_WRITE); /* fall through */
478 return 0; /* try again later */
479 case SSL_ERROR_ZERO_RETURN: /* TLS/SSL Connection was shut down */
480 LogOpenSSLError("TLS/SSL Connection shutdown", fname);
483 SSL_ERROR_WANT_CONNECT, SSL_ERROR_WANT_ACCEPT, SSL_ERROR_WANT_X509_LOOKUP
485 case SSL_ERROR_SYSCALL:
486 sslerr = ERR_get_error();
488 Log( LOG_ERR, "%s: %s", fname, ERR_error_string(sslerr, NULL ));
491 switch (code) { /* EOF that violated protocol */
493 Log(LOG_ERR, "%s: Client Disconnected", fname );
495 case -1: /* low level socket I/O error, check errno */
496 Log(LOG_ERR, "%s: %s", fname, strerror(real_errno));
501 LogOpenSSLError("TLS/SSL Protocol Error", fname);
504 Log( LOG_ERR, "%s: Unknown error %d!", fname, ret);
509 #ifdef HAVE_LIBGNUTLS
512 case GNUTLS_E_INTERRUPTED:
513 if (gnutls_record_get_direction(c->ssl_state.gnutls_session)) { /* need write */
514 io_event_del(c->sock, IO_WANTREAD);
515 Conn_OPTION_ADD(c, CONN_SSL_WANT_WRITE); /* fall through */
517 } else { /* need read */
518 io_event_del(c->sock, IO_WANTWRITE);
519 Conn_OPTION_ADD(c, CONN_SSL_WANT_READ);
524 if (gnutls_error_is_fatal(code)) {
525 Log(LOG_ERR, "%s: %s", fname, gnutls_strerror(code));
536 ConnSSL_LogCertInfo( CONNECTION *c )
539 SSL *ssl = c->ssl_state.ssl;
544 Log( LOG_INFO, "New %s connection using cipher %s on socket %d",
545 SSL_get_version(ssl), SSL_get_cipher(ssl), c->sock);
547 #ifdef HAVE_LIBGNUTLS
548 gnutls_session_t sess = c->ssl_state.gnutls_session;
549 gnutls_cipher_algorithm_t cipher = gnutls_cipher_get(sess);
551 Log( LOG_INFO, "New %s connection using cipher %s-%s on socket %d",
552 gnutls_protocol_get_name(gnutls_protocol_get_version(sess)),
553 gnutls_cipher_get_name(cipher), gnutls_mac_get_name(gnutls_mac_get(sess)), c->sock);
559 Accept incoming SSL connection.
561 1: SSL Connection established
563 -1: SSL Connection not established due to fatal error.
566 ConnSSL_Accept( CONNECTION *c )
570 if (!c->ssl_state.ssl) {
572 #ifdef HAVE_LIBGNUTLS
573 if (!Conn_OPTION_ISSET(c, CONN_SSL)) {
574 int err = gnutls_init(&c->ssl_state.gnutls_session, GNUTLS_SERVER);
576 Log(LOG_ERR, "gnutls_init: %s", gnutls_strerror(err));
580 LogDebug("ConnSSL_Accept: Initializing SSL data");
581 if (!ConnSSL_Init_SSL(c))
584 return ConnectAccept(c, false );
589 ConnSSL_Connect( CONNECTION *c )
593 assert(c->ssl_state.ssl);
595 #ifdef HAVE_LIBGNUTLS
596 assert(Conn_OPTION_ISSET(c, CONN_SSL));
598 return ConnectAccept(c, true);
602 /* accept/connect wrapper. if connect is true, connect to peer, otherwise wait for incoming connection */
604 ConnectAccept( CONNECTION *c, bool connect)
608 SSL *ssl = c->ssl_state.ssl;
611 ret = connect ? SSL_connect(ssl) : SSL_accept(ssl);
613 return ConnSSL_HandleError(c, ret, connect ? "SSL_connect": "SSL_accept");
615 #ifdef HAVE_LIBGNUTLS
617 assert(Conn_OPTION_ISSET(c, CONN_SSL));
618 ret = gnutls_handshake(c->ssl_state.gnutls_session);
620 return ConnSSL_HandleError(c, ret, "gnutls_handshake");
622 Conn_OPTION_DEL(c, (CONN_SSL_WANT_WRITE|CONN_SSL_WANT_READ|CONN_SSL_CONNECT));
623 ConnSSL_LogCertInfo(c);
629 ConnSSL_Write(CONNECTION *c, const void *buf, size_t count)
633 Conn_OPTION_DEL(c, CONN_SSL_WANT_WRITE|CONN_SSL_WANT_READ);
637 bw = (ssize_t) SSL_write(c->ssl_state.ssl, buf, count);
639 #ifdef HAVE_LIBGNUTLS
640 bw = gnutls_write(c->ssl_state.gnutls_session, buf, count);
642 if ( bw > 0 ) return bw;
643 if (ConnSSL_HandleError( c, bw, "ConnSSL_Write") == 0)
644 errno = EAGAIN; /* try again */
650 ConnSSL_Read(CONNECTION *c, void * buf, size_t count)
654 Conn_OPTION_DEL(c, CONN_SSL_WANT_WRITE|CONN_SSL_WANT_READ);
656 br = (ssize_t) SSL_read(c->ssl_state.ssl, buf, count);
657 if (br > 0) /* on EOF we have to call ConnSSL_HandleError(), see SSL_read(3) */
660 #ifdef HAVE_LIBGNUTLS
661 br = gnutls_read(c->ssl_state.gnutls_session, buf, count);
662 if (br >= 0) /* on EOF we must _not_ call ConnSSL_HandleError, see gnutls_record_recv(3) */
665 /* error on read: switch ConnSSL_HandleError() return values -> 0 is "try again", so return -1 and set EAGAIN */
666 if (ConnSSL_HandleError(c, br, "ConnSSL_Read") == 0) {
675 ConnSSL_GetCipherInfo(CONNECTION *c, char *buf, size_t len)
683 ssl = c->ssl_state.ssl;
687 SSL_CIPHER_description(SSL_get_current_cipher(ssl), buf, len);
688 nl = strchr(buf, '\n');
693 #ifdef HAVE_LIBGNUTLS
696 if (Conn_OPTION_ISSET(c, CONN_SSL)) {
697 const char *name_cipher, *name_mac, *name_proto, *name_keyexchange;
700 gnutls_session_t sess = c->ssl_state.gnutls_session;
701 gnutls_cipher_algorithm_t cipher = gnutls_cipher_get(sess);
702 name_cipher = gnutls_cipher_get_name(cipher);
703 name_mac = gnutls_mac_get_name(gnutls_mac_get(sess));
704 keysize = gnutls_cipher_get_key_size(cipher) * 8;
705 name_proto = gnutls_protocol_get_name(gnutls_protocol_get_version(sess));
706 name_keyexchange = gnutls_kx_get_name(gnutls_kx_get(sess));
708 return snprintf(buf, len, "%s-%s%15s Kx=%s Enc=%s(%u) Mac=%s",
709 name_cipher, name_mac, name_proto, name_keyexchange, name_cipher, keysize, name_mac) > 0;
716 #endif /* SSL_SUPPORT */