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 static gnutls_certificate_credentials_t x509_cred;
56 static gnutls_dh_params_t dh_params;
58 static bool ConnSSL_LoadServerKey_gnutls PARAMS(( void ));
61 static bool ConnSSL_Init_SSL PARAMS(( CONNECTION *c ));
62 static int ConnectAccept PARAMS(( CONNECTION *c, bool connect ));
63 static int ConnSSL_HandleError PARAMS(( CONNECTION *c, const int code, const char *fname ));
66 static char * openreadclose(const char *name, size_t *len)
71 int fd = open(name, O_RDONLY);
73 Log(LOG_ERR, "Could not open %s: %s", name, strerror(errno));
77 Log(LOG_ERR, "Could not fstat %s: %s", name, strerror(errno));
80 if (!S_ISREG(s.st_mode)) {
81 Log(LOG_ERR, "%s: Not a regular file", name);
85 Log(LOG_ERR, "%s: invalid file length (size %ld <= 0)", name, (long) s.st_size);
88 buf = malloc(s.st_size);
90 Log(LOG_ERR, "Could not malloc %lu bytes for file %s: %s", s.st_size, name, strerror(errno));
93 br = read(fd, buf, s.st_size);
94 if (br != (ssize_t)s.st_size) {
95 Log(LOG_ERR, "Could not read file %s: read returned %ld, expected %ld: %s",
96 name, (long) br, (long) s.st_size, br == -1 ? strerror(errno):"short read?!");
97 memset(buf, 0, s.st_size);
112 LogOpenSSLError( const char *msg, const char *msg2 )
114 unsigned long err = ERR_get_error();
115 char * errmsg = err ? ERR_error_string(err, NULL) : "Unable to determine error";
117 if (!msg) msg = "SSL Error";
119 Log( LOG_ERR, "%s: %s: %s", msg, msg2, errmsg);
121 Log( LOG_ERR, "%s: %s", msg, errmsg);
126 pem_passwd_cb(char *buf, int size, int rwflag, void *password)
128 array *pass = password;
131 (void)rwflag; /* rwflag is unused if DEBUG is not set. */
132 assert(rwflag == 0); /* 0 -> callback used for decryption.
133 * See SSL_CTX_set_default_passwd_cb(3) */
135 passlen = (int) array_bytes(pass);
137 LogDebug("pem_passwd_cb buf size %d, array size %d", size, passlen);
138 assert(passlen >= 0);
140 Log(LOG_ERR, "pem_passwd_cb: password required, but not set");
143 size = passlen > size ? size : passlen;
144 memcpy(buf, (char *)(array_start(pass)), size);
157 if (!Conf_SSLOptions.DHFile) {
158 Log(LOG_NOTICE, "Configuration option \"SSLDHFile\" not set!");
161 fp = fopen(Conf_SSLOptions.DHFile, "r");
163 Log(LOG_ERR, "%s: %s", Conf_SSLOptions.DHFile, strerror(errno));
166 dh_params = PEM_read_DHparams(fp, NULL, NULL, NULL);
168 Log(LOG_ERR, "%s: PEM_read_DHparams failed!",
169 Conf_SSLOptions.DHFile);
175 #ifdef HAVE_LIBGNUTLS
176 bool need_dhgenerate = true;
178 gnutls_dh_params_t tmp_dh_params;
180 err = gnutls_dh_params_init(&tmp_dh_params);
182 Log(LOG_ERR, "gnutls_dh_params_init: %s", gnutls_strerror(err));
185 if (Conf_SSLOptions.DHFile) {
186 gnutls_datum_t dhparms;
188 dhparms.data = (unsigned char *) openreadclose(Conf_SSLOptions.DHFile, &size);
191 err = gnutls_dh_params_import_pkcs3(tmp_dh_params, &dhparms, GNUTLS_X509_FMT_PEM);
193 need_dhgenerate = false;
195 Log(LOG_ERR, "gnutls_dh_params_init: %s", gnutls_strerror(err));
197 memset(dhparms.data, 0, size);
201 if (need_dhgenerate) {
203 "SSLDHFile not set, generating %u bit DH parameters. This may take a while ...",
205 err = gnutls_dh_params_generate2(tmp_dh_params, DH_BITS);
207 Log(LOG_ERR, "gnutls_dh_params_generate2: %s", gnutls_strerror(err));
211 dh_params = tmp_dh_params;
217 void ConnSSL_Free(CONNECTION *c)
220 SSL *ssl = c->ssl_state.ssl;
224 c->ssl_state.ssl = NULL;
227 #ifdef HAVE_LIBGNUTLS
228 gnutls_session_t sess = c->ssl_state.gnutls_session;
229 if (Conn_OPTION_ISSET(c, CONN_SSL)) {
230 gnutls_bye(sess, GNUTLS_SHUT_RDWR);
234 assert(Conn_OPTION_ISSET(c, CONN_SSL));
235 /* can't just set bitmask to 0 -- there are other, non-ssl related flags, e.g. CONN_ZIP. */
236 Conn_OPTION_DEL(c, CONN_SSL_FLAGS_ALL);
241 ConnSSL_InitLibrary( void )
248 SSL_load_error_strings();
251 if (!RAND_status()) {
252 Log(LOG_ERR, "OpenSSL PRNG not seeded: /dev/urandom missing?");
254 * it is probably best to fail and let the user install EGD or a similar program if no kernel random device is available.
255 * According to OpenSSL RAND_egd(3): "The automatic query of /var/run/egd-pool et al was added in OpenSSL 0.9.7";
256 * so it makes little sense to deal with PRNGD seeding ourselves.
261 newctx = SSL_CTX_new(SSLv23_method());
263 LogOpenSSLError("SSL_CTX_new()", NULL);
267 if (!ConnSSL_LoadServerKey_openssl(newctx))
270 SSL_CTX_set_options(newctx, SSL_OP_SINGLE_DH_USE|SSL_OP_NO_SSLv2);
271 SSL_CTX_set_mode(newctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
272 SSL_CTX_free(ssl_ctx);
274 Log(LOG_INFO, "%s initialized.", SSLeay_version(SSLEAY_VERSION));
277 SSL_CTX_free(newctx);
280 #ifdef HAVE_LIBGNUTLS
282 static bool initialized;
283 if (initialized) /* TODO: cannot reload gnutls keys: can't simply free x509 context -- it may still be in use */
286 err = gnutls_global_init();
288 Log(LOG_ERR, "gnutls_global_init(): %s", gnutls_strerror(err));
291 if (!ConnSSL_LoadServerKey_gnutls())
293 Log(LOG_INFO, "gnutls %s initialized.", gnutls_check_version(NULL));
300 #ifdef HAVE_LIBGNUTLS
302 ConnSSL_LoadServerKey_gnutls(void)
305 const char *cert_file;
307 err = gnutls_certificate_allocate_credentials(&x509_cred);
309 Log(LOG_ERR, "gnutls_certificate_allocate_credentials: %s", gnutls_strerror(err));
313 cert_file = Conf_SSLOptions.CertFile ? Conf_SSLOptions.CertFile:Conf_SSLOptions.KeyFile;
315 Log(LOG_NOTICE, "No SSL server key configured, SSL disabled.");
319 if (array_bytes(&Conf_SSLOptions.KeyFilePassword))
321 "Ignoring KeyFilePassword: Not supported by GNUTLS.");
323 if (!Load_DH_params())
326 gnutls_certificate_set_dh_params(x509_cred, dh_params);
327 err = gnutls_certificate_set_x509_key_file(x509_cred, cert_file, Conf_SSLOptions.KeyFile, GNUTLS_X509_FMT_PEM);
329 Log(LOG_ERR, "gnutls_certificate_set_x509_key_file (cert %s, key %s): %s",
330 cert_file, Conf_SSLOptions.KeyFile ? Conf_SSLOptions.KeyFile : "(NULL)", gnutls_strerror(err));
340 ConnSSL_LoadServerKey_openssl(SSL_CTX *ctx)
345 if (!Conf_SSLOptions.KeyFile) {
346 Log(LOG_NOTICE, "No SSL server key configured, SSL disabled.");
350 SSL_CTX_set_default_passwd_cb(ctx, pem_passwd_cb);
351 SSL_CTX_set_default_passwd_cb_userdata(ctx, &Conf_SSLOptions.KeyFilePassword);
353 if (SSL_CTX_use_PrivateKey_file(ctx, Conf_SSLOptions.KeyFile, SSL_FILETYPE_PEM) != 1) {
354 array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
355 LogOpenSSLError("SSL_CTX_use_PrivateKey_file", Conf_SSLOptions.KeyFile);
359 cert_key = Conf_SSLOptions.CertFile ? Conf_SSLOptions.CertFile:Conf_SSLOptions.KeyFile;
360 if (SSL_CTX_use_certificate_chain_file(ctx, cert_key) != 1) {
361 array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
362 LogOpenSSLError("SSL_CTX_use_certificate_file", cert_key);
366 array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
368 if (!SSL_CTX_check_private_key(ctx)) {
369 LogOpenSSLError("Server Private Key does not match certificate", NULL);
372 if (Load_DH_params()) {
373 if (SSL_CTX_set_tmp_dh(ctx, dh_params) != 1)
374 LogOpenSSLError("Error setting DH Parameters", Conf_SSLOptions.DHFile);
375 /* don't return false here: the non-DH modes will still work */
385 ConnSSL_Init_SSL(CONNECTION *c)
391 Log(LOG_ERR, "Cannot init ssl_ctx: OpenSSL initialization failed at startup");
394 assert(c->ssl_state.ssl == NULL);
396 c->ssl_state.ssl = SSL_new(ssl_ctx);
397 if (!c->ssl_state.ssl) {
398 LogOpenSSLError("SSL_new()", NULL);
402 ret = SSL_set_fd(c->ssl_state.ssl, c->sock);
404 LogOpenSSLError("SSL_set_fd()", NULL);
409 #ifdef HAVE_LIBGNUTLS
410 ret = gnutls_set_default_priority(c->ssl_state.gnutls_session);
412 Log(LOG_ERR, "gnutls_set_default_priority: %s", gnutls_strerror(ret));
417 * The intermediate (long) cast is here to avoid a warning like:
418 * "cast to pointer from integer of different size" on 64-bit platforms.
419 * There doesn't seem to be an alternate GNUTLS API we could use instead, see e.g.
420 * http://www.mail-archive.com/help-gnutls@gnu.org/msg00286.html
422 gnutls_transport_set_ptr(c->ssl_state.gnutls_session, (gnutls_transport_ptr_t) (long) c->sock);
423 ret = gnutls_credentials_set(c->ssl_state.gnutls_session, GNUTLS_CRD_CERTIFICATE, x509_cred);
425 Log(LOG_ERR, "gnutls_credentials_set: %s", gnutls_strerror(ret));
429 gnutls_dh_set_prime_bits(c->ssl_state.gnutls_session, DH_BITS);
431 Conn_OPTION_ADD(c, CONN_SSL);
437 ConnSSL_PrepareConnect(CONNECTION *c, UNUSED CONF_SERVER *s)
440 #ifdef HAVE_LIBGNUTLS
443 err = gnutls_init(&c->ssl_state.gnutls_session, GNUTLS_CLIENT);
445 Log(LOG_ERR, "gnutls_init: %s", gnutls_strerror(err));
449 ret = ConnSSL_Init_SSL(c);
452 Conn_OPTION_ADD(c, CONN_SSL_CONNECT);
454 assert(c->ssl_state.ssl);
455 SSL_set_verify(c->ssl_state.ssl, SSL_VERIFY_NONE, NULL);
462 Check an Handle Error return code after failed calls to ssl/tls functions.
464 SSL_connect(), SSL_accept(), SSL_do_handshake(), SSL_read(), SSL_peek(), or SSL_write() on ssl.
466 gnutlsssl_read(), gnutls_write() or gnutls_handshake().
467 Return: -1 on fatal error, 0 if we can try again later.
470 ConnSSL_HandleError( CONNECTION *c, const int code, const char *fname )
473 int ret = SSL_ERROR_SYSCALL;
474 unsigned long sslerr;
475 int real_errno = errno;
477 ret = SSL_get_error(c->ssl_state.ssl, code);
479 case SSL_ERROR_WANT_READ:
480 io_event_del(c->sock, IO_WANTWRITE);
481 Conn_OPTION_ADD(c, CONN_SSL_WANT_READ);
482 return 0; /* try again later */
483 case SSL_ERROR_WANT_WRITE:
484 io_event_del(c->sock, IO_WANTREAD);
485 Conn_OPTION_ADD(c, CONN_SSL_WANT_WRITE); /* fall through */
487 return 0; /* try again later */
488 case SSL_ERROR_ZERO_RETURN:
489 LogDebug("TLS/SSL connection shut down normally");
492 SSL_ERROR_WANT_CONNECT, SSL_ERROR_WANT_ACCEPT, SSL_ERROR_WANT_X509_LOOKUP
494 case SSL_ERROR_SYSCALL:
495 sslerr = ERR_get_error();
497 Log( LOG_ERR, "%s: %s", fname, ERR_error_string(sslerr, NULL ));
500 switch (code) { /* EOF that violated protocol */
502 Log(LOG_ERR, "%s: Client Disconnected", fname );
504 case -1: /* low level socket I/O error, check errno */
505 Log(LOG_ERR, "%s: %s", fname, strerror(real_errno));
510 LogOpenSSLError("TLS/SSL Protocol Error", fname);
513 Log( LOG_ERR, "%s: Unknown error %d!", fname, ret);
518 #ifdef HAVE_LIBGNUTLS
521 case GNUTLS_E_INTERRUPTED:
522 if (gnutls_record_get_direction(c->ssl_state.gnutls_session)) {
523 Conn_OPTION_ADD(c, CONN_SSL_WANT_WRITE);
524 io_event_del(c->sock, IO_WANTREAD);
526 Conn_OPTION_ADD(c, CONN_SSL_WANT_READ);
527 io_event_del(c->sock, IO_WANTWRITE);
532 if (gnutls_error_is_fatal(code)) {
533 Log(LOG_ERR, "%s: %s", fname, gnutls_strerror(code));
544 ConnSSL_LogCertInfo( CONNECTION *c )
547 SSL *ssl = c->ssl_state.ssl;
551 Log(LOG_INFO, "New %s connection using cipher %s on socket %d.",
552 SSL_get_version(ssl), SSL_get_cipher(ssl), c->sock);
554 #ifdef HAVE_LIBGNUTLS
555 gnutls_session_t sess = c->ssl_state.gnutls_session;
556 gnutls_cipher_algorithm_t cipher = gnutls_cipher_get(sess);
558 Log(LOG_INFO, "New %s connection using cipher %s-%s on socket %d.",
559 gnutls_protocol_get_name(gnutls_protocol_get_version(sess)),
560 gnutls_cipher_get_name(cipher),
561 gnutls_mac_get_name(gnutls_mac_get(sess)), c->sock);
567 Accept incoming SSL connection.
569 1: SSL Connection established
571 -1: SSL Connection not established due to fatal error.
574 ConnSSL_Accept( CONNECTION *c )
577 if (!Conn_OPTION_ISSET(c, CONN_SSL)) {
578 #ifdef HAVE_LIBGNUTLS
579 int err = gnutls_init(&c->ssl_state.gnutls_session, GNUTLS_SERVER);
581 Log(LOG_ERR, "gnutls_init: %s", gnutls_strerror(err));
585 LogDebug("ConnSSL_Accept: Initializing SSL data");
586 if (!ConnSSL_Init_SSL(c))
589 return ConnectAccept(c, false );
594 ConnSSL_Connect( CONNECTION *c )
598 assert(c->ssl_state.ssl);
600 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 ret = gnutls_handshake(c->ssl_state.gnutls_session);
622 return ConnSSL_HandleError(c, ret, "gnutls_handshake");
624 Conn_OPTION_DEL(c, (CONN_SSL_WANT_WRITE|CONN_SSL_WANT_READ|CONN_SSL_CONNECT));
625 ConnSSL_LogCertInfo(c);
631 ConnSSL_Write(CONNECTION *c, const void *buf, size_t count)
635 Conn_OPTION_DEL(c, CONN_SSL_WANT_WRITE|CONN_SSL_WANT_READ);
639 bw = (ssize_t) SSL_write(c->ssl_state.ssl, buf, count);
641 #ifdef HAVE_LIBGNUTLS
642 bw = gnutls_write(c->ssl_state.gnutls_session, buf, count);
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)
682 SSL *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
694 if (Conn_OPTION_ISSET(c, CONN_SSL)) {
695 const char *name_cipher, *name_mac, *name_proto, *name_keyexchange;
698 gnutls_session_t sess = c->ssl_state.gnutls_session;
699 gnutls_cipher_algorithm_t cipher = gnutls_cipher_get(sess);
700 name_cipher = gnutls_cipher_get_name(cipher);
701 name_mac = gnutls_mac_get_name(gnutls_mac_get(sess));
702 keysize = gnutls_cipher_get_key_size(cipher) * 8;
703 name_proto = gnutls_protocol_get_name(gnutls_protocol_get_version(sess));
704 name_keyexchange = gnutls_kx_get_name(gnutls_kx_get(sess));
706 return snprintf(buf, len, "%s-%s%15s Kx=%s Enc=%s(%u) Mac=%s",
707 name_cipher, name_mac, name_proto, name_keyexchange, name_cipher, keysize, name_mac) > 0;
714 #endif /* SSL_SUPPORT */