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 #define MAX_HASH_SIZE 64 /* from gnutls-int.h */
59 static gnutls_certificate_credentials_t x509_cred;
60 static gnutls_dh_params_t dh_params;
61 static bool ConnSSL_LoadServerKey_gnutls PARAMS(( void ));
64 #define CERTFP_LEN (20 * 2 + 1)
66 static bool ConnSSL_Init_SSL PARAMS(( CONNECTION *c ));
67 static int ConnectAccept PARAMS(( CONNECTION *c, bool connect ));
68 static int ConnSSL_HandleError PARAMS(( CONNECTION *c, const int code, const char *fname ));
71 static char * openreadclose(const char *name, size_t *len)
76 int fd = open(name, O_RDONLY);
78 Log(LOG_ERR, "Could not open %s: %s", name, strerror(errno));
82 Log(LOG_ERR, "Could not fstat %s: %s", name, strerror(errno));
85 if (!S_ISREG(s.st_mode)) {
86 Log(LOG_ERR, "%s: Not a regular file", name);
90 Log(LOG_ERR, "%s: invalid file length (size %ld <= 0)", name, (long) s.st_size);
93 buf = malloc(s.st_size);
95 Log(LOG_ERR, "Could not malloc %lu bytes for file %s: %s", s.st_size, name, strerror(errno));
98 br = read(fd, buf, s.st_size);
99 if (br != (ssize_t)s.st_size) {
100 Log(LOG_ERR, "Could not read file %s: read returned %ld, expected %ld: %s",
101 name, (long) br, (long) s.st_size, br == -1 ? strerror(errno):"short read?!");
102 memset(buf, 0, s.st_size);
117 LogOpenSSLError( const char *msg, const char *msg2 )
119 unsigned long err = ERR_get_error();
120 char * errmsg = err ? ERR_error_string(err, NULL) : "Unable to determine error";
122 if (!msg) msg = "SSL Error";
124 Log( LOG_ERR, "%s: %s: %s", msg, msg2, errmsg);
126 Log( LOG_ERR, "%s: %s", msg, errmsg);
131 pem_passwd_cb(char *buf, int size, int rwflag, void *password)
133 array *pass = password;
136 (void)rwflag; /* rwflag is unused if DEBUG is not set. */
137 assert(rwflag == 0); /* 0 -> callback used for decryption.
138 * See SSL_CTX_set_default_passwd_cb(3) */
140 passlen = (int) array_bytes(pass);
142 LogDebug("pem_passwd_cb buf size %d, array size %d", size, passlen);
143 assert(passlen >= 0);
145 Log(LOG_ERR, "pem_passwd_cb: password required, but not set");
148 size = passlen > size ? size : passlen;
149 memcpy(buf, (char *)(array_start(pass)), size);
155 Verify_openssl(UNUSED int preverify_ok, UNUSED X509_STORE_CTX *x509_ctx)
169 if (!Conf_SSLOptions.DHFile) {
170 Log(LOG_NOTICE, "Configuration option \"DHFile\" not set!");
173 fp = fopen(Conf_SSLOptions.DHFile, "r");
175 Log(LOG_ERR, "%s: %s", Conf_SSLOptions.DHFile, strerror(errno));
178 dh_params = PEM_read_DHparams(fp, NULL, NULL, NULL);
180 Log(LOG_ERR, "%s: PEM_read_DHparams failed!",
181 Conf_SSLOptions.DHFile);
187 #ifdef HAVE_LIBGNUTLS
188 bool need_dhgenerate = true;
190 gnutls_dh_params_t tmp_dh_params;
192 err = gnutls_dh_params_init(&tmp_dh_params);
194 Log(LOG_ERR, "gnutls_dh_params_init: %s", gnutls_strerror(err));
197 if (Conf_SSLOptions.DHFile) {
198 gnutls_datum_t dhparms;
200 dhparms.data = (unsigned char *) openreadclose(Conf_SSLOptions.DHFile, &size);
203 err = gnutls_dh_params_import_pkcs3(tmp_dh_params, &dhparms, GNUTLS_X509_FMT_PEM);
205 need_dhgenerate = false;
207 Log(LOG_ERR, "gnutls_dh_params_init: %s", gnutls_strerror(err));
209 memset(dhparms.data, 0, size);
213 if (need_dhgenerate) {
215 "DHFile not set, generating %u bit DH parameters. This may take a while ...",
217 err = gnutls_dh_params_generate2(tmp_dh_params, DH_BITS);
219 Log(LOG_ERR, "gnutls_dh_params_generate2: %s", gnutls_strerror(err));
223 dh_params = tmp_dh_params;
229 void ConnSSL_Free(CONNECTION *c)
232 SSL *ssl = c->ssl_state.ssl;
236 c->ssl_state.ssl = NULL;
237 if (c->ssl_state.fingerprint) {
238 free(c->ssl_state.fingerprint);
239 c->ssl_state.fingerprint = NULL;
243 #ifdef HAVE_LIBGNUTLS
244 gnutls_session_t sess = c->ssl_state.gnutls_session;
245 if (Conn_OPTION_ISSET(c, CONN_SSL)) {
246 gnutls_bye(sess, GNUTLS_SHUT_RDWR);
250 assert(Conn_OPTION_ISSET(c, CONN_SSL));
251 /* can't just set bitmask to 0 -- there are other, non-ssl related flags, e.g. CONN_ZIP. */
252 Conn_OPTION_DEL(c, CONN_SSL_FLAGS_ALL);
257 ConnSSL_InitLibrary( void )
259 if (!Conf_SSLInUse()) {
260 LogDebug("SSL not in use, skipping initialization.");
269 SSL_load_error_strings();
272 if (!RAND_status()) {
273 Log(LOG_ERR, "OpenSSL PRNG not seeded: /dev/urandom missing?");
275 * it is probably best to fail and let the user install EGD or a similar program if no kernel random device is available.
276 * According to OpenSSL RAND_egd(3): "The automatic query of /var/run/egd-pool et al was added in OpenSSL 0.9.7";
277 * so it makes little sense to deal with PRNGD seeding ourselves.
279 array_free(&Conf_SSLOptions.ListenPorts);
283 newctx = SSL_CTX_new(SSLv23_method());
285 LogOpenSSLError("SSL_CTX_new()", NULL);
286 array_free(&Conf_SSLOptions.ListenPorts);
290 if (!ConnSSL_LoadServerKey_openssl(newctx))
293 SSL_CTX_set_options(newctx, SSL_OP_SINGLE_DH_USE|SSL_OP_NO_SSLv2);
294 SSL_CTX_set_mode(newctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
295 SSL_CTX_set_verify(newctx, SSL_VERIFY_PEER|SSL_VERIFY_CLIENT_ONCE, Verify_openssl);
296 SSL_CTX_free(ssl_ctx);
298 Log(LOG_INFO, "%s initialized.", SSLeay_version(SSLEAY_VERSION));
301 SSL_CTX_free(newctx);
302 array_free(&Conf_SSLOptions.ListenPorts);
305 #ifdef HAVE_LIBGNUTLS
307 static bool initialized;
308 if (initialized) /* TODO: cannot reload gnutls keys: can't simply free x509 context -- it may still be in use */
311 err = gnutls_global_init();
313 Log(LOG_ERR, "gnutls_global_init(): %s", gnutls_strerror(err));
314 array_free(&Conf_SSLOptions.ListenPorts);
317 if (!ConnSSL_LoadServerKey_gnutls()) {
318 array_free(&Conf_SSLOptions.ListenPorts);
321 Log(LOG_INFO, "gnutls %s initialized.", gnutls_check_version(NULL));
328 #ifdef HAVE_LIBGNUTLS
330 ConnSSL_LoadServerKey_gnutls(void)
333 const char *cert_file;
335 err = gnutls_certificate_allocate_credentials(&x509_cred);
337 Log(LOG_ERR, "gnutls_certificate_allocate_credentials: %s", gnutls_strerror(err));
341 cert_file = Conf_SSLOptions.CertFile ? Conf_SSLOptions.CertFile:Conf_SSLOptions.KeyFile;
343 Log(LOG_ERR, "No SSL server key configured!");
347 if (array_bytes(&Conf_SSLOptions.KeyFilePassword))
349 "Ignoring KeyFilePassword: Not supported by GNUTLS.");
351 if (!Load_DH_params())
354 gnutls_certificate_set_dh_params(x509_cred, dh_params);
355 err = gnutls_certificate_set_x509_key_file(x509_cred, cert_file, Conf_SSLOptions.KeyFile, GNUTLS_X509_FMT_PEM);
357 Log(LOG_ERR, "gnutls_certificate_set_x509_key_file (cert %s, key %s): %s",
358 cert_file, Conf_SSLOptions.KeyFile ? Conf_SSLOptions.KeyFile : "(NULL)", gnutls_strerror(err));
368 ConnSSL_LoadServerKey_openssl(SSL_CTX *ctx)
373 if (!Conf_SSLOptions.KeyFile) {
374 Log(LOG_ERR, "No SSL server key configured!");
378 SSL_CTX_set_default_passwd_cb(ctx, pem_passwd_cb);
379 SSL_CTX_set_default_passwd_cb_userdata(ctx, &Conf_SSLOptions.KeyFilePassword);
381 if (SSL_CTX_use_PrivateKey_file(ctx, Conf_SSLOptions.KeyFile, SSL_FILETYPE_PEM) != 1) {
382 array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
383 LogOpenSSLError("SSL_CTX_use_PrivateKey_file", Conf_SSLOptions.KeyFile);
387 cert_key = Conf_SSLOptions.CertFile ? Conf_SSLOptions.CertFile:Conf_SSLOptions.KeyFile;
388 if (SSL_CTX_use_certificate_chain_file(ctx, cert_key) != 1) {
389 array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
390 LogOpenSSLError("SSL_CTX_use_certificate_file", cert_key);
394 array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
396 if (!SSL_CTX_check_private_key(ctx)) {
397 LogOpenSSLError("Server Private Key does not match certificate", NULL);
400 if (Load_DH_params()) {
401 if (SSL_CTX_set_tmp_dh(ctx, dh_params) != 1)
402 LogOpenSSLError("Error setting DH Parameters", Conf_SSLOptions.DHFile);
403 /* don't return false here: the non-DH modes will still work */
413 ConnSSL_Init_SSL(CONNECTION *c)
419 Log(LOG_ERR, "Cannot init ssl_ctx: OpenSSL initialization failed at startup");
422 assert(c->ssl_state.ssl == NULL);
423 assert(c->ssl_state.fingerprint == NULL);
425 c->ssl_state.ssl = SSL_new(ssl_ctx);
426 if (!c->ssl_state.ssl) {
427 LogOpenSSLError("SSL_new()", NULL);
431 ret = SSL_set_fd(c->ssl_state.ssl, c->sock);
433 LogOpenSSLError("SSL_set_fd()", NULL);
438 #ifdef HAVE_LIBGNUTLS
439 ret = gnutls_set_default_priority(c->ssl_state.gnutls_session);
441 Log(LOG_ERR, "gnutls_set_default_priority: %s", gnutls_strerror(ret));
446 * The intermediate (long) cast is here to avoid a warning like:
447 * "cast to pointer from integer of different size" on 64-bit platforms.
448 * There doesn't seem to be an alternate GNUTLS API we could use instead, see e.g.
449 * http://www.mail-archive.com/help-gnutls@gnu.org/msg00286.html
451 gnutls_transport_set_ptr(c->ssl_state.gnutls_session, (gnutls_transport_ptr_t) (long) c->sock);
452 gnutls_certificate_server_set_request(c->ssl_state.gnutls_session, GNUTLS_CERT_REQUEST);
453 ret = gnutls_credentials_set(c->ssl_state.gnutls_session, GNUTLS_CRD_CERTIFICATE, x509_cred);
455 Log(LOG_ERR, "gnutls_credentials_set: %s", gnutls_strerror(ret));
459 gnutls_dh_set_prime_bits(c->ssl_state.gnutls_session, DH_BITS_MIN);
461 Conn_OPTION_ADD(c, CONN_SSL);
467 ConnSSL_PrepareConnect(CONNECTION *c, UNUSED CONF_SERVER *s)
470 #ifdef HAVE_LIBGNUTLS
473 err = gnutls_init(&c->ssl_state.gnutls_session, GNUTLS_CLIENT);
475 Log(LOG_ERR, "gnutls_init: %s", gnutls_strerror(err));
479 ret = ConnSSL_Init_SSL(c);
482 Conn_OPTION_ADD(c, CONN_SSL_CONNECT);
484 assert(c->ssl_state.ssl);
485 SSL_set_verify(c->ssl_state.ssl, SSL_VERIFY_NONE, NULL);
492 * Check and handle error return codes after failed calls to SSL/TLS functions.
495 * SSL_connect(), SSL_accept(), SSL_do_handshake(), SSL_read(), SSL_peek(), or
496 * SSL_write() on ssl.
499 * gnutlsssl_read(), gnutls_write() or gnutls_handshake().
501 * @param c The connection handle.
502 * @prarm code The return code.
503 * @param fname The name of the function in which the error occurred.
504 * @return -1 on fatal errors, 0 if we can try again later.
507 ConnSSL_HandleError(CONNECTION * c, const int code, const char *fname)
510 int ret = SSL_ERROR_SYSCALL;
511 unsigned long sslerr;
512 int real_errno = errno;
514 ret = SSL_get_error(c->ssl_state.ssl, code);
516 case SSL_ERROR_WANT_READ:
517 io_event_del(c->sock, IO_WANTWRITE);
518 Conn_OPTION_ADD(c, CONN_SSL_WANT_READ);
519 return 0; /* try again later */
520 case SSL_ERROR_WANT_WRITE:
521 io_event_del(c->sock, IO_WANTREAD);
522 Conn_OPTION_ADD(c, CONN_SSL_WANT_WRITE); /* fall through */
524 return 0; /* try again later */
525 case SSL_ERROR_ZERO_RETURN:
526 LogDebug("TLS/SSL connection shut down normally");
528 case SSL_ERROR_SYSCALL:
529 /* SSL_ERROR_WANT_CONNECT, SSL_ERROR_WANT_ACCEPT,
530 * and SSL_ERROR_WANT_X509_LOOKUP */
531 sslerr = ERR_get_error();
533 Log(LOG_ERR, "%s: %s", fname,
534 ERR_error_string(sslerr, NULL));
537 switch (code) { /* EOF that violated protocol */
539 Log(LOG_ERR, "%s: Client Disconnected", fname);
541 case -1: /* low level socket I/O error, check errno */
542 Log(LOG_ERR, "%s: %s", fname,
543 strerror(real_errno));
548 LogOpenSSLError("TLS/SSL Protocol Error", fname);
551 Log(LOG_ERR, "%s: Unknown error %d!", fname, ret);
556 #ifdef HAVE_LIBGNUTLS
559 case GNUTLS_E_INTERRUPTED:
560 if (gnutls_record_get_direction(c->ssl_state.gnutls_session)) {
561 Conn_OPTION_ADD(c, CONN_SSL_WANT_WRITE);
562 io_event_del(c->sock, IO_WANTREAD);
564 Conn_OPTION_ADD(c, CONN_SSL_WANT_READ);
565 io_event_del(c->sock, IO_WANTWRITE);
570 if (gnutls_error_is_fatal(code)) {
571 Log(LOG_ERR, "%s: %s", fname, gnutls_strerror(code));
582 ConnSSL_LogCertInfo( CONNECTION *c )
585 SSL *ssl = c->ssl_state.ssl;
589 Log(LOG_INFO, "Connection %d: initialized %s using cipher %s.",
590 c->sock, SSL_get_version(ssl), SSL_get_cipher(ssl));
592 #ifdef HAVE_LIBGNUTLS
593 gnutls_session_t sess = c->ssl_state.gnutls_session;
594 gnutls_cipher_algorithm_t cipher = gnutls_cipher_get(sess);
596 Log(LOG_INFO, "Connection %d: initialized %s using cipher %s-%s.",
598 gnutls_protocol_get_name(gnutls_protocol_get_version(sess)),
599 gnutls_cipher_get_name(cipher),
600 gnutls_mac_get_name(gnutls_mac_get(sess)));
606 Accept incoming SSL connection.
608 1: SSL Connection established
610 -1: SSL Connection not established due to fatal error.
613 ConnSSL_Accept( CONNECTION *c )
616 if (!Conn_OPTION_ISSET(c, CONN_SSL)) {
617 #ifdef HAVE_LIBGNUTLS
618 int err = gnutls_init(&c->ssl_state.gnutls_session, GNUTLS_SERVER);
620 Log(LOG_ERR, "gnutls_init: %s", gnutls_strerror(err));
624 LogDebug("ConnSSL_Accept: Initializing SSL data");
625 if (!ConnSSL_Init_SSL(c))
628 return ConnectAccept(c, false );
633 ConnSSL_Connect( CONNECTION *c )
637 assert(c->ssl_state.ssl);
639 assert(Conn_OPTION_ISSET(c, CONN_SSL));
640 return ConnectAccept(c, true);
644 ConnSSL_InitCertFp( CONNECTION *c )
646 const char hex[] = "0123456789abcdef";
650 unsigned char digest[EVP_MAX_MD_SIZE];
651 unsigned int digest_size;
654 cert = SSL_get_peer_certificate(c->ssl_state.ssl);
658 if (!X509_digest(cert, EVP_sha1(), digest, &digest_size)) {
664 #endif /* HAVE_LIBSSL */
665 #ifdef HAVE_LIBGNUTLS
666 gnutls_x509_crt_t cert;
667 unsigned int cert_list_size;
668 const gnutls_datum_t *cert_list;
669 unsigned char digest[MAX_HASH_SIZE];
672 if (gnutls_certificate_type_get(c->ssl_state.gnutls_session) != GNUTLS_CRT_X509)
675 if (gnutls_x509_crt_init(&cert) != GNUTLS_E_SUCCESS)
679 cert_list = gnutls_certificate_get_peers(c->ssl_state.gnutls_session,
682 gnutls_x509_crt_deinit(cert);
686 if (gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER) != GNUTLS_E_SUCCESS) {
687 gnutls_x509_crt_deinit(cert);
691 digest_size = sizeof(digest);
692 if (gnutls_x509_crt_get_fingerprint(cert, GNUTLS_DIG_SHA1, digest, &digest_size)) {
693 gnutls_x509_crt_deinit(cert);
697 gnutls_x509_crt_deinit(cert);
698 #endif /* HAVE_LIBGNUTLS */
700 assert(c->ssl_state.fingerprint == NULL);
702 c->ssl_state.fingerprint = malloc(CERTFP_LEN);
703 if (!c->ssl_state.fingerprint)
706 for (i = 0; i < (int)digest_size; i++) {
707 c->ssl_state.fingerprint[i * 2] = hex[digest[i] / 16];
708 c->ssl_state.fingerprint[i * 2 + 1] = hex[digest[i] % 16];
710 c->ssl_state.fingerprint[i * 2] = '\0';
715 /* accept/connect wrapper. if connect is true, connect to peer, otherwise wait for incoming connection */
717 ConnectAccept( CONNECTION *c, bool connect)
721 SSL *ssl = c->ssl_state.ssl;
724 ret = connect ? SSL_connect(ssl) : SSL_accept(ssl);
726 return ConnSSL_HandleError(c, ret, connect ? "SSL_connect": "SSL_accept");
728 #ifdef HAVE_LIBGNUTLS
730 ret = gnutls_handshake(c->ssl_state.gnutls_session);
732 return ConnSSL_HandleError(c, ret, "gnutls_handshake");
734 (void)ConnSSL_InitCertFp(c);
736 Conn_OPTION_DEL(c, (CONN_SSL_WANT_WRITE|CONN_SSL_WANT_READ|CONN_SSL_CONNECT));
737 ConnSSL_LogCertInfo(c);
739 Conn_StartLogin(CONNECTION2ID(c));
745 ConnSSL_Write(CONNECTION *c, const void *buf, size_t count)
749 Conn_OPTION_DEL(c, CONN_SSL_WANT_WRITE|CONN_SSL_WANT_READ);
753 bw = (ssize_t) SSL_write(c->ssl_state.ssl, buf, count);
755 #ifdef HAVE_LIBGNUTLS
756 bw = gnutls_write(c->ssl_state.gnutls_session, buf, count);
760 if (ConnSSL_HandleError( c, bw, "ConnSSL_Write") == 0)
761 errno = EAGAIN; /* try again */
767 ConnSSL_Read(CONNECTION *c, void * buf, size_t count)
771 Conn_OPTION_DEL(c, CONN_SSL_WANT_WRITE|CONN_SSL_WANT_READ);
773 br = (ssize_t) SSL_read(c->ssl_state.ssl, buf, count);
774 if (br > 0) /* on EOF we have to call ConnSSL_HandleError(), see SSL_read(3) */
777 #ifdef HAVE_LIBGNUTLS
778 br = gnutls_read(c->ssl_state.gnutls_session, buf, count);
779 if (br >= 0) /* on EOF we must _not_ call ConnSSL_HandleError, see gnutls_record_recv(3) */
782 /* error on read: switch ConnSSL_HandleError() return values -> 0 is "try again", so return -1 and set EAGAIN */
783 if (ConnSSL_HandleError(c, br, "ConnSSL_Read") == 0) {
792 ConnSSL_GetCipherInfo(CONNECTION *c, char *buf, size_t len)
796 SSL *ssl = c->ssl_state.ssl;
801 SSL_CIPHER_description(SSL_get_current_cipher(ssl), buf, len);
802 nl = strchr(buf, '\n');
807 #ifdef HAVE_LIBGNUTLS
808 if (Conn_OPTION_ISSET(c, CONN_SSL)) {
809 const char *name_cipher, *name_mac, *name_proto, *name_keyexchange;
812 gnutls_session_t sess = c->ssl_state.gnutls_session;
813 gnutls_cipher_algorithm_t cipher = gnutls_cipher_get(sess);
814 name_cipher = gnutls_cipher_get_name(cipher);
815 name_mac = gnutls_mac_get_name(gnutls_mac_get(sess));
816 keysize = gnutls_cipher_get_key_size(cipher) * 8;
817 name_proto = gnutls_protocol_get_name(gnutls_protocol_get_version(sess));
818 name_keyexchange = gnutls_kx_get_name(gnutls_kx_get(sess));
820 return snprintf(buf, len, "%s-%s%15s Kx=%s Enc=%s(%u) Mac=%s",
821 name_cipher, name_mac, name_proto, name_keyexchange, name_cipher, keysize, name_mac) > 0;
828 ConnSSL_GetCertFp(CONNECTION *c)
830 return c->ssl_state.fingerprint;
834 ConnSSL_SetCertFp(CONNECTION *c, const char *fingerprint)
837 c->ssl_state.fingerprint = strdup(fingerprint);
838 return c->ssl_state.fingerprint != NULL;
843 ConnSSL_InitLibrary(void)
848 #endif /* SSL_SUPPORT */