mirrors/ngircd
1
0
Fork 0
mirror of https://github.com/osmarks/ngircd.git synced 2024-12-12 09:50:29 +00:00
Code Issues Releases Wiki Activity

Merge branch 'ssl-log-messages'

Browse Source 
* ssl-log-messages:
  Make SSL-related log messages more readable
  ConnSSL_HandleError: Code cleanup, more documentation
This commit is contained in:
Alexander Barton 2013-08-17 22:05:59 +02:00
commit c8b12af1d2
1 changed files with 82 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

132
src/ngircd/conn-ssl.c
View File

@ -113,17 +113,26 @@ out:
#ifdef HAVE_LIBSSL #ifdef HAVE_LIBSSL
/**
* Log OpenSSL error message.
*
* @param msg The error message.
* @param info Additional information text or NULL.
*/
static void static void
LogOpenSSLError( const char *msg, const char *msg2 ) LogOpenSSLError(const char *error, const char *info)
{ {
unsigned long err = ERR_get_error(); unsigned long err = ERR_get_error();
char * errmsg = err ? ERR_error_string(err, NULL) : "Unable to determine error"; char * errmsg = err
? ERR_error_string(err, NULL)
: "Unable to determine error";
if (!msg) msg = "SSL Error"; assert(error != NULL);
if (msg2)
Log( LOG_ERR, "%s: %s: %s", msg, msg2, errmsg); if (info)
Log(LOG_ERR, "%s: %s (%s)", error, info, errmsg);
else else
Log( LOG_ERR, "%s: %s", msg, errmsg); Log(LOG_ERR, "%s: %s", error, errmsg);
} }
@ -142,7 +151,7 @@ pem_passwd_cb(char *buf, int size, int rwflag, void *password)
LogDebug("pem_passwd_cb buf size %d, array size %d", size, passlen); LogDebug("pem_passwd_cb buf size %d, array size %d", size, passlen);
assert(passlen >= 0); assert(passlen >= 0);
if (passlen <= 0) { if (passlen <= 0) {
Log(LOG_ERR, "pem_passwd_cb: password required, but not set"); Log(LOG_ERR, "PEM password required but not set [in pem_passwd_cb()]!");
return 0; return 0;
} }
size = passlen > size ? size : passlen; size = passlen > size ? size : passlen;
@ -177,7 +186,7 @@ Load_DH_params(void)
} }
dh_params = PEM_read_DHparams(fp, NULL, NULL, NULL); dh_params = PEM_read_DHparams(fp, NULL, NULL, NULL);
if (!dh_params) { if (!dh_params) {
Log(LOG_ERR, "%s: PEM_read_DHparams failed!", Log(LOG_ERR, "%s: Failed to read SSL DH parameters!",
Conf_SSLOptions.DHFile); Conf_SSLOptions.DHFile);
ret = false; ret = false;
} }
@ -191,7 +200,8 @@ Load_DH_params(void)
err = gnutls_dh_params_init(&tmp_dh_params); err = gnutls_dh_params_init(&tmp_dh_params);
if (err < 0) { if (err < 0) {
Log(LOG_ERR, "gnutls_dh_params_init: %s", gnutls_strerror(err)); Log(LOG_ERR, "Failed to initialize SSL DH parameters: %s",
gnutls_strerror(err));
return false; return false;
} }
if (Conf_SSLOptions.DHFile) { if (Conf_SSLOptions.DHFile) {
@ -204,7 +214,9 @@ Load_DH_params(void)
if (err == 0) if (err == 0)
need_dhgenerate = false; need_dhgenerate = false;
else else
Log(LOG_ERR, "gnutls_dh_params_init: %s", gnutls_strerror(err)); Log(LOG_ERR,
"Failed to initialize SSL DH parameters: %s",
gnutls_strerror(err));
memset(dhparms.data, 0, size); memset(dhparms.data, 0, size);
free(dhparms.data); free(dhparms.data);
@ -216,7 +228,8 @@ Load_DH_params(void)
DH_BITS); DH_BITS);
err = gnutls_dh_params_generate2(tmp_dh_params, DH_BITS); err = gnutls_dh_params_generate2(tmp_dh_params, DH_BITS);
if (err < 0) { if (err < 0) {
Log(LOG_ERR, "gnutls_dh_params_generate2: %s", gnutls_strerror(err)); Log(LOG_ERR, "Failed to generate SSL DH parameters: %s",
gnutls_strerror(err));
return false; return false;
} }
} }
@ -282,7 +295,7 @@ ConnSSL_InitLibrary( void )
newctx = SSL_CTX_new(SSLv23_method()); newctx = SSL_CTX_new(SSLv23_method());
if (!newctx) { if (!newctx) {
LogOpenSSLError("SSL_CTX_new()", NULL); LogOpenSSLError("Failed to create SSL context", NULL);
array_free(&Conf_SSLOptions.ListenPorts); array_free(&Conf_SSLOptions.ListenPorts);
return false; return false;
} }
@ -310,7 +323,7 @@ out:
err = gnutls_global_init(); err = gnutls_global_init();
if (err) { if (err) {
Log(LOG_ERR, "gnutls_global_init(): %s", gnutls_strerror(err)); Log(LOG_ERR, "Failed to initialize GnuTLS: %s", gnutls_strerror(err));
array_free(&Conf_SSLOptions.ListenPorts); array_free(&Conf_SSLOptions.ListenPorts);
return false; return false;
} }
@ -318,7 +331,7 @@ out:
array_free(&Conf_SSLOptions.ListenPorts); array_free(&Conf_SSLOptions.ListenPorts);
return false; return false;
} }
Log(LOG_INFO, "gnutls %s initialized.", gnutls_check_version(NULL)); Log(LOG_INFO, "GnuTLS %s initialized.", gnutls_check_version(NULL));
initialized = true; initialized = true;
return true; return true;
#endif #endif
@ -334,7 +347,8 @@ ConnSSL_LoadServerKey_gnutls(void)
err = gnutls_certificate_allocate_credentials(&x509_cred); err = gnutls_certificate_allocate_credentials(&x509_cred);
if (err < 0) { if (err < 0) {
Log(LOG_ERR, "gnutls_certificate_allocate_credentials: %s", gnutls_strerror(err)); Log(LOG_ERR, "Failed to allocate certificate credentials: %s",
gnutls_strerror(err));
return false; return false;
} }
@ -346,7 +360,7 @@ ConnSSL_LoadServerKey_gnutls(void)
if (array_bytes(&Conf_SSLOptions.KeyFilePassword)) if (array_bytes(&Conf_SSLOptions.KeyFilePassword))
Log(LOG_WARNING, Log(LOG_WARNING,
"Ignoring KeyFilePassword: Not supported by GNUTLS."); "Ignoring KeyFilePassword: Not supported by GnuTLS.");
if (!Load_DH_params()) if (!Load_DH_params())
return false; return false;
@ -354,8 +368,11 @@ ConnSSL_LoadServerKey_gnutls(void)
gnutls_certificate_set_dh_params(x509_cred, dh_params); gnutls_certificate_set_dh_params(x509_cred, dh_params);
err = gnutls_certificate_set_x509_key_file(x509_cred, cert_file, Conf_SSLOptions.KeyFile, GNUTLS_X509_FMT_PEM); err = gnutls_certificate_set_x509_key_file(x509_cred, cert_file, Conf_SSLOptions.KeyFile, GNUTLS_X509_FMT_PEM);
if (err < 0) { if (err < 0) {
Log(LOG_ERR, "gnutls_certificate_set_x509_key_file (cert %s, key %s): %s", Log(LOG_ERR,
cert_file, Conf_SSLOptions.KeyFile ? Conf_SSLOptions.KeyFile : "(NULL)", gnutls_strerror(err)); "Failed to set certificate key file (cert %s, key %s): %s",
cert_file,
Conf_SSLOptions.KeyFile ? Conf_SSLOptions.KeyFile : "(NULL)",
gnutls_strerror(err));
return false; return false;
} }
return true; return true;
@ -380,26 +397,26 @@ ConnSSL_LoadServerKey_openssl(SSL_CTX *ctx)
if (SSL_CTX_use_PrivateKey_file(ctx, Conf_SSLOptions.KeyFile, SSL_FILETYPE_PEM) != 1) { if (SSL_CTX_use_PrivateKey_file(ctx, Conf_SSLOptions.KeyFile, SSL_FILETYPE_PEM) != 1) {
array_free_wipe(&Conf_SSLOptions.KeyFilePassword); array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
LogOpenSSLError("SSL_CTX_use_PrivateKey_file", Conf_SSLOptions.KeyFile); LogOpenSSLError("Failed to add private key", Conf_SSLOptions.KeyFile);
return false; return false;
} }
cert_key = Conf_SSLOptions.CertFile ? Conf_SSLOptions.CertFile:Conf_SSLOptions.KeyFile; cert_key = Conf_SSLOptions.CertFile ? Conf_SSLOptions.CertFile:Conf_SSLOptions.KeyFile;
if (SSL_CTX_use_certificate_chain_file(ctx, cert_key) != 1) { if (SSL_CTX_use_certificate_chain_file(ctx, cert_key) != 1) {
array_free_wipe(&Conf_SSLOptions.KeyFilePassword); array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
LogOpenSSLError("SSL_CTX_use_certificate_file", cert_key); LogOpenSSLError("Failed to load certificate chain", cert_key);
return false; return false;
} }
array_free_wipe(&Conf_SSLOptions.KeyFilePassword); array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
if (!SSL_CTX_check_private_key(ctx)) { if (!SSL_CTX_check_private_key(ctx)) {
LogOpenSSLError("Server Private Key does not match certificate", NULL); LogOpenSSLError("Server private key does not match certificate", NULL);
return false; return false;
} }
if (Load_DH_params()) { if (Load_DH_params()) {
if (SSL_CTX_set_tmp_dh(ctx, dh_params) != 1) if (SSL_CTX_set_tmp_dh(ctx, dh_params) != 1)
LogOpenSSLError("Error setting DH Parameters", Conf_SSLOptions.DHFile); LogOpenSSLError("Error setting DH parameters", Conf_SSLOptions.DHFile);
/* don't return false here: the non-DH modes will still work */ /* don't return false here: the non-DH modes will still work */
DH_free(dh_params); DH_free(dh_params);
dh_params = NULL; dh_params = NULL;
@ -416,7 +433,8 @@ ConnSSL_Init_SSL(CONNECTION *c)
assert(c != NULL); assert(c != NULL);
#ifdef HAVE_LIBSSL #ifdef HAVE_LIBSSL
if (!ssl_ctx) { if (!ssl_ctx) {
Log(LOG_ERR, "Cannot init ssl_ctx: OpenSSL initialization failed at startup"); Log(LOG_ERR,
"Can't initialize SSL context, OpenSSL initialization failed at startup!");
return false; return false;
} }
assert(c->ssl_state.ssl == NULL); assert(c->ssl_state.ssl == NULL);
@ -424,13 +442,13 @@ ConnSSL_Init_SSL(CONNECTION *c)
c->ssl_state.ssl = SSL_new(ssl_ctx); c->ssl_state.ssl = SSL_new(ssl_ctx);
if (!c->ssl_state.ssl) { if (!c->ssl_state.ssl) {
LogOpenSSLError("SSL_new()", NULL); LogOpenSSLError("Failed to create SSL structure", NULL);
return false; return false;
} }
ret = SSL_set_fd(c->ssl_state.ssl, c->sock); ret = SSL_set_fd(c->ssl_state.ssl, c->sock);
if (ret != 1) { if (ret != 1) {
LogOpenSSLError("SSL_set_fd()", NULL); LogOpenSSLError("Failed to set SSL file descriptor", NULL);
ConnSSL_Free(c); ConnSSL_Free(c);
return false; return false;
} }
@ -438,7 +456,8 @@ ConnSSL_Init_SSL(CONNECTION *c)
#ifdef HAVE_LIBGNUTLS #ifdef HAVE_LIBGNUTLS
ret = gnutls_set_default_priority(c->ssl_state.gnutls_session); ret = gnutls_set_default_priority(c->ssl_state.gnutls_session);
if (ret < 0) { if (ret < 0) {
Log(LOG_ERR, "gnutls_set_default_priority: %s", gnutls_strerror(ret)); Log(LOG_ERR, "Failed to set GnuTLS default priority: %s",
gnutls_strerror(ret));
ConnSSL_Free(c); ConnSSL_Free(c);
return false; return false;
} }
@ -452,7 +471,7 @@ ConnSSL_Init_SSL(CONNECTION *c)
gnutls_certificate_server_set_request(c->ssl_state.gnutls_session, GNUTLS_CERT_REQUEST); gnutls_certificate_server_set_request(c->ssl_state.gnutls_session, GNUTLS_CERT_REQUEST);
ret = gnutls_credentials_set(c->ssl_state.gnutls_session, GNUTLS_CRD_CERTIFICATE, x509_cred); ret = gnutls_credentials_set(c->ssl_state.gnutls_session, GNUTLS_CRD_CERTIFICATE, x509_cred);
if (ret < 0) { if (ret < 0) {
Log(LOG_ERR, "gnutls_credentials_set: %s", gnutls_strerror(ret)); Log(LOG_ERR, "Failed to set SSL credentials: %s", gnutls_strerror(ret));
ConnSSL_Free(c); ConnSSL_Free(c);
return false; return false;
} }
@ -472,7 +491,8 @@ ConnSSL_PrepareConnect(CONNECTION *c, UNUSED CONF_SERVER *s)
err = gnutls_init(&c->ssl_state.gnutls_session, GNUTLS_CLIENT); err = gnutls_init(&c->ssl_state.gnutls_session, GNUTLS_CLIENT);
if (err) { if (err) {
Log(LOG_ERR, "gnutls_init: %s", gnutls_strerror(err)); Log(LOG_ERR, "Failed to initialize new SSL session: %s",
gnutls_strerror(err));
return false; return false;
} }
#endif #endif
@ -488,16 +508,23 @@ ConnSSL_PrepareConnect(CONNECTION *c, UNUSED CONF_SERVER *s)
} }
/* /**
Check an Handle Error return code after failed calls to ssl/tls functions. * Check and handle error return codes after failed calls to SSL functions.
OpenSSL: *
SSL_connect(), SSL_accept(), SSL_do_handshake(), SSL_read(), SSL_peek(), or SSL_write() on ssl. * OpenSSL:
GNUTLS: * SSL_connect(), SSL_accept(), SSL_do_handshake(), SSL_read(), SSL_peek(), or
gnutlsssl_read(), gnutls_write() or gnutls_handshake(). * SSL_write() on ssl.
Return: -1 on fatal error, 0 if we can try again later. *
* GnuTLS:
* gnutlsssl_read(), gnutls_write() or gnutls_handshake().
*
* @param c The connection handle.
* @prarm code The return code.
* @param fname The name of the function in which the error occurred.
* @return -1 on fatal errors, 0 if we can try again later.
*/ */
static int static int
ConnSSL_HandleError( CONNECTION *c, const int code, const char *fname ) ConnSSL_HandleError(CONNECTION * c, const int code, const char *fname)
{ {
#ifdef HAVE_LIBSSL #ifdef HAVE_LIBSSL
int ret = SSL_ERROR_SYSCALL; int ret = SSL_ERROR_SYSCALL;
@ -505,6 +532,7 @@ ConnSSL_HandleError( CONNECTION *c, const int code, const char *fname )
int real_errno = errno; int real_errno = errno;
ret = SSL_get_error(c->ssl_state.ssl, code); ret = SSL_get_error(c->ssl_state.ssl, code);
switch (ret) { switch (ret) {
case SSL_ERROR_WANT_READ: case SSL_ERROR_WANT_READ:
io_event_del(c->sock, IO_WANTWRITE); io_event_del(c->sock, IO_WANTWRITE);
@ -516,31 +544,33 @@ ConnSSL_HandleError( CONNECTION *c, const int code, const char *fname )
case SSL_ERROR_NONE: case SSL_ERROR_NONE:
return 0; /* try again later */ return 0; /* try again later */
case SSL_ERROR_ZERO_RETURN: case SSL_ERROR_ZERO_RETURN:
LogDebug("TLS/SSL connection shut down normally"); LogDebug("SSL connection shut down normally.");
break; break;
/*
SSL_ERROR_WANT_CONNECT, SSL_ERROR_WANT_ACCEPT, SSL_ERROR_WANT_X509_LOOKUP
*/
case SSL_ERROR_SYSCALL: case SSL_ERROR_SYSCALL:
/* SSL_ERROR_WANT_CONNECT, SSL_ERROR_WANT_ACCEPT,
* and SSL_ERROR_WANT_X509_LOOKUP */
sslerr = ERR_get_error(); sslerr = ERR_get_error();
if (sslerr) { if (sslerr) {
Log( LOG_ERR, "%s: %s", fname, ERR_error_string(sslerr, NULL )); Log(LOG_ERR, "SSL error: %s [in %s()]!",
ERR_error_string(sslerr, NULL), fname);
} else { } else {
switch (code) { /* EOF that violated protocol */ switch (code) { /* EOF that violated protocol */
case 0: case 0:
Log(LOG_ERR, "%s: Client Disconnected", fname ); Log(LOG_ERR,
"SSL error, client disconnected [in %s()]!",
fname);
break; break;
case -1: /* low level socket I/O error, check errno */ case -1: /* low level socket I/O error, check errno */
Log(LOG_ERR, "%s: %s", fname, strerror(real_errno)); Log(LOG_ERR, "SSL error: %s [in %s()]!",
strerror(real_errno), fname);
} }
} }
break; break;
case SSL_ERROR_SSL: case SSL_ERROR_SSL:
LogOpenSSLError("TLS/SSL Protocol Error", fname); LogOpenSSLError("SSL protocol error", fname);
break; break;
default: default:
Log( LOG_ERR, "%s: Unknown error %d!", fname, ret); Log(LOG_ERR, "Unknown SSL error %d [in %s()]!", ret, fname);
} }
ConnSSL_Free(c); ConnSSL_Free(c);
return -1; return -1;
@ -560,7 +590,8 @@ ConnSSL_HandleError( CONNECTION *c, const int code, const char *fname )
default: default:
assert(code < 0); assert(code < 0);
if (gnutls_error_is_fatal(code)) { if (gnutls_error_is_fatal(code)) {
Log(LOG_ERR, "%s: %s", fname, gnutls_strerror(code)); Log(LOG_ERR, "SSL error: %s [%s].",
gnutls_strerror(code), fname);
ConnSSL_Free(c); ConnSSL_Free(c);
return -1; return -1;
} }
@ -609,11 +640,12 @@ ConnSSL_Accept( CONNECTION *c )
#ifdef HAVE_LIBGNUTLS #ifdef HAVE_LIBGNUTLS
int err = gnutls_init(&c->ssl_state.gnutls_session, GNUTLS_SERVER); int err = gnutls_init(&c->ssl_state.gnutls_session, GNUTLS_SERVER);
if (err) { if (err) {
Log(LOG_ERR, "gnutls_init: %s", gnutls_strerror(err)); Log(LOG_ERR, "Failed to initialize new SSL session: %s",
gnutls_strerror(err));
return false; return false;
} }
#endif #endif
LogDebug("ConnSSL_Accept: Initializing SSL data"); LogDebug("Initializing SSL data ...");
if (!ConnSSL_Init_SSL(c)) if (!ConnSSL_Init_SSL(c))
return -1; return -1;
} }