| /* _ _ |
| ** _ __ ___ ___ __| | ___ ___| | mod_ssl |
| ** | '_ ` _ \ / _ \ / _` | / __/ __| | Apache Interface to OpenSSL |
| ** | | | | | | (_) | (_| | \__ \__ \ | www.modssl.org |
| ** |_| |_| |_|\___/ \__,_|___|___/___/_| ftp.modssl.org |
| ** |_____| |
| ** ssl_engine_log.c |
| ** Logging Facility |
| */ |
| |
| /* ==================================================================== |
| * The Apache Software License, Version 1.1 |
| * |
| * Copyright (c) 2000-2002 The Apache Software Foundation. All rights |
| * reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in |
| * the documentation and/or other materials provided with the |
| * distribution. |
| * |
| * 3. The end-user documentation included with the redistribution, |
| * if any, must include the following acknowledgment: |
| * "This product includes software developed by the |
| * Apache Software Foundation (http://www.apache.org/)." |
| * Alternately, this acknowledgment may appear in the software itself, |
| * if and wherever such third-party acknowledgments normally appear. |
| * |
| * 4. The names "Apache" and "Apache Software Foundation" must |
| * not be used to endorse or promote products derived from this |
| * software without prior written permission. For written |
| * permission, please contact apache@apache.org. |
| * |
| * 5. Products derived from this software may not be called "Apache", |
| * nor may "Apache" appear in their name, without prior written |
| * permission of the Apache Software Foundation. |
| * |
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
| * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR |
| * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| * SUCH DAMAGE. |
| * ==================================================================== |
| */ |
| /* ``The difference between a computer |
| industry job and open-source software |
| hacking is about 30 hours a week.'' |
| -- Ralf S. Engelschall */ |
| #include "mod_ssl.h" |
| |
| /* _________________________________________________________________ |
| ** |
| ** Logfile Support |
| ** _________________________________________________________________ |
| */ |
| |
| /* |
| * Open the SSL logfile |
| */ |
| void ssl_log_open(server_rec *s_main, server_rec *s, apr_pool_t *p) |
| { |
| const char *szLogFile; |
| SSLSrvConfigRec *sc_main = mySrvConfig(s_main); |
| SSLSrvConfigRec *sc = mySrvConfig(s); |
| piped_log *pl; |
| |
| /* |
| * Short-circuit for inherited logfiles in order to save |
| * filedescriptors in mass-vhost situation. Be careful, this works |
| * fine because the close happens implicitly by the pool facility. |
| */ |
| if ( s != s_main |
| && sc_main->fileLogFile != NULL |
| && ( (sc->szLogFile == NULL) |
| || ( sc->szLogFile != NULL |
| && sc_main->szLogFile != NULL |
| && strEQ(sc->szLogFile, sc_main->szLogFile)))) { |
| sc->fileLogFile = sc_main->fileLogFile; |
| } |
| else if (sc->szLogFile != NULL) { |
| if (strEQ(sc->szLogFile, "/dev/null")) |
| return; |
| else if (sc->szLogFile[0] == '|') { |
| szLogFile = sc->szLogFile + 1; |
| if ((pl = ap_open_piped_log(p, szLogFile)) == NULL) { |
| ssl_log(s, SSL_LOG_ERROR|SSL_ADD_ERRNO, |
| "Cannot open reliable pipe to SSL logfile filter %s", szLogFile); |
| ssl_die(); |
| } |
| sc->fileLogFile = ap_piped_log_write_fd(pl); |
| } |
| else { |
| szLogFile = ap_server_root_relative(p, sc->szLogFile); |
| if (!szLogFile) { |
| ssl_log(s, SSL_LOG_ERROR|SSL_ADD_ERRNO, |
| "Invalid SSL logfile path %s", sc->szLogFile); |
| ssl_die(); |
| } |
| if ((apr_file_open(&(sc->fileLogFile), szLogFile, |
| APR_WRITE|APR_APPEND|APR_CREATE, APR_OS_DEFAULT, p)) |
| != APR_SUCCESS) { |
| ssl_log(s, SSL_LOG_ERROR|SSL_ADD_ERRNO, |
| "Cannot open SSL logfile %s", szLogFile); |
| ssl_die(); |
| } |
| } |
| } |
| return; |
| } |
| |
| static struct { |
| int nLevel; |
| char *szLevel; |
| } ssl_log_level2string[] = { |
| { SSL_LOG_ERROR, "error" }, |
| { SSL_LOG_WARN, "warn" }, |
| { SSL_LOG_INFO, "info" }, |
| { SSL_LOG_TRACE, "trace" }, |
| { SSL_LOG_DEBUG, "debug" }, |
| { 0, NULL } |
| }; |
| |
| static struct { |
| char *cpPattern; |
| char *cpAnnotation; |
| } ssl_log_annotate[] = { |
| { "*envelope*bad*decrypt*", "wrong pass phrase!?" }, |
| { "*CLIENT_HELLO*unknown*protocol*", "speaking not SSL to HTTPS port!?" }, |
| { "*CLIENT_HELLO*http*request*", "speaking HTTP to HTTPS port!?" }, |
| { "*SSL3_READ_BYTES:sslv3*alert*bad*certificate*", "Subject CN in certificate not server name or identical to CA!?" }, |
| { "*self signed certificate in certificate chain*", "Client certificate signed by CA not known to server?" }, |
| { "*peer did not return a certificate*", "No CAs known to server for verification?" }, |
| { "*no shared cipher*", "Too restrictive SSLCipherSuite or using DSA server certificate?" }, |
| { "*no start line*", "Bad file contents or format - or even just a forgotten SSLCertificateKeyFile?" }, |
| { "*bad password read*", "You entered an incorrect pass phrase!?" }, |
| { "*bad mac decode*", "Browser still remembered details of a re-created server certificate?" }, |
| { NULL, NULL } |
| }; |
| |
| static char *ssl_log_annotation(char *error) |
| { |
| char *errstr; |
| int i; |
| |
| errstr = NULL; |
| for (i = 0; ssl_log_annotate[i].cpPattern != NULL; i++) { |
| if (ap_strcmp_match(error, ssl_log_annotate[i].cpPattern) == 0) { |
| errstr = ssl_log_annotate[i].cpAnnotation; |
| break; |
| } |
| } |
| return errstr; |
| } |
| |
| void ssl_log(server_rec *s, int level, const char *msg, ...) |
| { |
| char tstr[80]; |
| char lstr[20]; |
| char vstr[1024]; |
| char str[1024]; |
| char *nstr; |
| apr_size_t len; |
| apr_time_exp_t t; |
| va_list ap; |
| int add; |
| int i; |
| char *astr; |
| int safe_errno; |
| unsigned long e; |
| SSLSrvConfigRec *sc; |
| char *cpE; |
| char *cpA; |
| |
| /* initialization */ |
| safe_errno = errno; |
| sc = mySrvConfig(s); |
| |
| /* strip out additional flags */ |
| add = (level & ~SSL_LOG_MASK); |
| level = (level & SSL_LOG_MASK); |
| |
| /* reduce flags when not reasonable in context */ |
| if (add & SSL_ADD_ERRNO && errno == 0) |
| add &= ~SSL_ADD_ERRNO; |
| if (add & SSL_ADD_SSLERR && ERR_peek_error() == 0) |
| add &= ~SSL_ADD_SSLERR; |
| |
| /* we log only levels below, except for errors */ |
| if ( sc->fileLogFile == NULL |
| && !(level & SSL_LOG_ERROR)) |
| return; |
| if ( level > sc->nLogLevel |
| && !(level & SSL_LOG_ERROR)) |
| return; |
| |
| /* determine the time entry string */ |
| if (add & SSL_NO_TIMESTAMP) |
| tstr[0] = NUL; |
| else { |
| apr_explode_localtime(&t, apr_time_now()); |
| apr_strftime(tstr, &len, 80, "[%d/%b/%Y %H:%M:%S", &t); |
| apr_snprintf(tstr + strlen(tstr), 80 - strlen(tstr), " %05d] ", |
| (unsigned int)getpid()); |
| } |
| |
| /* determine whether newline should be written */ |
| if (add & SSL_NO_NEWLINE) |
| nstr = ""; |
| else { |
| nstr = APR_EOL_STR; |
| } |
| |
| /* determine level name */ |
| lstr[0] = NUL; |
| if (!(add & SSL_NO_LEVELID)) { |
| for (i = 0; ssl_log_level2string[i].nLevel != 0; i++) { |
| if (ssl_log_level2string[i].nLevel == level) { |
| apr_snprintf(lstr, sizeof(lstr), "[%s]", ssl_log_level2string[i].szLevel); |
| break; |
| } |
| } |
| for (i = strlen(lstr); i <= 7; i++) |
| lstr[i] = ' '; |
| lstr[i] = NUL; |
| } |
| |
| /* create custom message */ |
| va_start(ap, msg); |
| apr_vsnprintf(vstr, sizeof(vstr), msg, ap); |
| va_end(ap); |
| |
| /* write out SSLog message */ |
| if ((add & SSL_ADD_ERRNO) && (add & SSL_ADD_SSLERR)) |
| astr = " (System and " SSL_LIBRARY_NAME " library errors follow)"; |
| else if (add & SSL_ADD_ERRNO) |
| astr = " (System error follows)"; |
| else if (add & SSL_ADD_SSLERR) |
| astr = " (" SSL_LIBRARY_NAME " library error follows)"; |
| else |
| astr = ""; |
| if (level <= sc->nLogLevel && sc->fileLogFile != NULL) { |
| apr_snprintf(str, sizeof(str), "%s%s%s%s%s", |
| tstr, lstr, vstr, astr, nstr); |
| apr_file_printf(sc->fileLogFile, "%s", str); |
| } |
| if (level & SSL_LOG_ERROR) |
| ap_log_error(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, 0, s, |
| "mod_ssl: %s%s", vstr, astr); |
| |
| /* write out additional attachment messages */ |
| if (add & SSL_ADD_ERRNO) { |
| if (level <= sc->nLogLevel && sc->fileLogFile != NULL) { |
| apr_snprintf(str, sizeof(str), "%s%sSystem: %s (errno: %d)%s", |
| tstr, lstr, strerror(safe_errno), safe_errno, nstr); |
| apr_file_printf(sc->fileLogFile, "%s", str); |
| } |
| if (level & SSL_LOG_ERROR) |
| ap_log_error(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, 0, s, |
| "System: %s (errno: %d)", |
| strerror(safe_errno), safe_errno); |
| } |
| if (add & SSL_ADD_SSLERR) { |
| while ((e = ERR_get_error())) { |
| cpE = ERR_error_string(e, NULL); |
| cpA = ssl_log_annotation(cpE); |
| if (level <= sc->nLogLevel && sc->fileLogFile != NULL) { |
| apr_snprintf(str, sizeof(str), "%s%s%s: %s%s%s%s%s", |
| tstr, lstr, SSL_LIBRARY_NAME, cpE, |
| cpA != NULL ? " [Hint: " : "", |
| cpA != NULL ? cpA : "", cpA != NULL ? "]" : "", |
| nstr); |
| apr_file_printf(sc->fileLogFile, "%s", str); |
| } |
| if (level & SSL_LOG_ERROR) |
| ap_log_error(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, 0, s, |
| "%s: %s%s%s%s", SSL_LIBRARY_NAME, cpE, |
| cpA != NULL ? " [Hint: " : "", |
| cpA != NULL ? cpA : "", cpA != NULL ? "]" : ""); |
| } |
| } |
| /* make sure the next log starts from a clean base */ |
| /* ERR_clear_error(); */ |
| |
| /* cleanup and return */ |
| if (sc->fileLogFile != NULL) |
| apr_file_flush(sc->fileLogFile); |
| errno = safe_errno; |
| return; |
| } |
| |
| void ssl_die(void) |
| { |
| /* |
| * This is used for fatal errors and here |
| * it is common module practice to really |
| * exit from the complete program. |
| */ |
| exit(1); |
| } |
| |
