]> granicus.if.org Git - apache/blob - modules/ssl/ssl_engine_log.c
XML updates.
[apache] / modules / ssl / ssl_engine_log.c
1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2  * contributor license agreements.  See the NOTICE file distributed with
3  * this work for additional information regarding copyright ownership.
4  * The ASF licenses this file to You under the Apache License, Version 2.0
5  * (the "License"); you may not use this file except in compliance with
6  * the License.  You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 /*                      _             _
18  *  _ __ ___   ___   __| |    ___ ___| |  mod_ssl
19  * | '_ ` _ \ / _ \ / _` |   / __/ __| |  Apache Interface to OpenSSL
20  * | | | | | | (_) | (_| |   \__ \__ \ |
21  * |_| |_| |_|\___/ \__,_|___|___/___/_|
22  *                      |_____|
23  *  ssl_engine_log.c
24  *  Logging Facility
25  */
26                              /* ``The difference between a computer
27                                   industry job and open-source software
28                                   hacking is about 30 hours a week.''
29                                          -- Ralf S. Engelschall     */
30 #include "ssl_private.h"
31
32 /*  _________________________________________________________________
33 **
34 **  Logfile Support
35 **  _________________________________________________________________
36 */
37
38 static const struct {
39     const char *cpPattern;
40     const char *cpAnnotation;
41 } ssl_log_annotate[] = {
42     { "*envelope*bad*decrypt*", "wrong pass phrase!?" },
43     { "*CLIENT_HELLO*unknown*protocol*", "speaking not SSL to HTTPS port!?" },
44     { "*CLIENT_HELLO*http*request*", "speaking HTTP to HTTPS port!?" },
45     { "*SSL3_READ_BYTES:sslv3*alert*bad*certificate*", "Subject CN in certificate not server name or identical to CA!?" },
46     { "*self signed certificate in certificate chain*", "Client certificate signed by CA not known to server?" },
47     { "*peer did not return a certificate*", "No CAs known to server for verification?" },
48     { "*no shared cipher*", "Too restrictive SSLCipherSuite or using DSA server certificate?" },
49     { "*no start line*", "Bad file contents or format - or even just a forgotten SSLCertificateKeyFile?" },
50     { "*bad password read*", "You entered an incorrect pass phrase!?" },
51     { "*bad mac decode*", "Browser still remembered details of a re-created server certificate?" },
52     { NULL, NULL }
53 };
54
55 static const char *ssl_log_annotation(const char *error)
56 {
57     int i = 0;
58
59     while (ssl_log_annotate[i].cpPattern != NULL
60            && ap_strcmp_match(error, ssl_log_annotate[i].cpPattern) != 0)
61         i++;
62
63     return ssl_log_annotate[i].cpAnnotation;
64 }
65
66 apr_status_t ssl_die(server_rec *s)
67 {
68     if (s != NULL && s->is_virtual && s->error_fname != NULL)
69         ap_log_error(APLOG_MARK, APLOG_EMERG, 0, NULL, APLOGNO(02311)
70                      "Fatal error initialising mod_ssl, exiting. "
71                      "See %s for more information",
72                      ap_server_root_relative(s->process->pool,
73                                              s->error_fname));
74     else
75         ap_log_error(APLOG_MARK, APLOG_EMERG, 0, NULL, APLOGNO(02312)
76                      "Fatal error initialising mod_ssl, exiting.");
77
78     return APR_EGENERAL;
79 }
80
81 /*
82  * Prints the SSL library error information.
83  */
84 void ssl_log_ssl_error(const char *file, int line, int level, server_rec *s)
85 {
86     unsigned long e;
87     const char *data;
88     int flags;
89
90     while ((e = ERR_peek_error_line_data(NULL, NULL, &data, &flags))) {
91         const char *annotation;
92         char err[256];
93
94         if (!(flags & ERR_TXT_STRING)) {
95             data = NULL;
96         }
97
98         ERR_error_string_n(e, err, sizeof err);
99         annotation = ssl_log_annotation(err);
100
101         ap_log_error(file, line, APLOG_MODULE_INDEX, level, 0, s,
102                      "SSL Library Error: %s%s%s%s%s%s",
103                      /* %s */
104                      err,
105                      /* %s%s%s */
106                      data ? " (" : "", data ? data : "", data ? ")" : "",
107                      /* %s%s */
108                      annotation ? " -- " : "",
109                      annotation ? annotation : "");
110
111         /* Pop the error off the stack: */
112         ERR_get_error();
113     }
114 }
115
116 static void ssl_log_cert_error(const char *file, int line, int level,
117                                apr_status_t rv, const server_rec *s,
118                                const conn_rec *c, const request_rec *r,
119                                apr_pool_t *p, X509 *cert, const char *format,
120                                va_list ap)
121 {
122     char buf[HUGE_STRING_LEN];
123     int msglen, n;
124     char *name;
125
126     apr_vsnprintf(buf, sizeof buf, format, ap);
127
128     msglen = strlen(buf);
129
130     if (cert) {
131         BIO *bio = BIO_new(BIO_s_mem());
132
133         if (bio) {
134             /*
135              * Limit the maximum length of the subject and issuer DN strings
136              * in the log message. 300 characters should always be sufficient
137              * for holding both the timestamp, module name, pid etc. stuff
138              * at the beginning of the line and the trailing information about
139              * serial, notbefore and notafter.
140              */
141             int maxdnlen = (HUGE_STRING_LEN - msglen - 300) / 2;
142
143             BIO_puts(bio, " [subject: ");
144             name = modssl_X509_NAME_to_string(p, X509_get_subject_name(cert),
145                                               maxdnlen);
146             if (!strIsEmpty(name)) {
147                 BIO_puts(bio, name);
148             } else {
149                 BIO_puts(bio, "-empty-");
150             }
151
152             BIO_puts(bio, " / issuer: ");
153             name = modssl_X509_NAME_to_string(p, X509_get_issuer_name(cert),
154                                               maxdnlen);
155             if (!strIsEmpty(name)) {
156                 BIO_puts(bio, name);
157             } else {
158                 BIO_puts(bio, "-empty-");
159             }
160
161             BIO_puts(bio, " / serial: ");
162             if (i2a_ASN1_INTEGER(bio, X509_get_serialNumber(cert)) == -1)
163                 BIO_puts(bio, "(ERROR)");
164
165             BIO_puts(bio, " / notbefore: ");
166             ASN1_TIME_print(bio, X509_get_notBefore(cert));
167
168             BIO_puts(bio, " / notafter: ");
169             ASN1_TIME_print(bio, X509_get_notAfter(cert));
170
171             BIO_puts(bio, "]");
172
173             n = BIO_read(bio, buf + msglen, sizeof buf - msglen - 1);
174             if (n > 0)
175                buf[msglen + n] = '\0';
176
177             BIO_free(bio);
178         }
179         else {
180             ap_abort_on_oom();
181         }
182     }
183     else {
184         apr_snprintf(buf + msglen, sizeof buf - msglen,
185                      " [certificate: -not available-]");
186     }
187
188     if (r) {
189         ap_log_rerror(file, line, APLOG_MODULE_INDEX, level, rv, r, "%s", buf);
190     }
191     else if (c) {
192         ap_log_cerror(file, line, APLOG_MODULE_INDEX, level, rv, c, "%s", buf);
193     }
194     else if (s) {
195         ap_log_error(file, line, APLOG_MODULE_INDEX, level, rv, s, "%s", buf);
196     }
197
198 }
199
200 /*
201  * Wrappers for ap_log_error/ap_log_cerror/ap_log_rerror which log additional
202  * details of the X509 cert. For ssl_log_xerror, a pool needs to be passed in
203  * as well (for temporary allocation of the cert's subject/issuer name strings,
204  * in the other cases we use the connection and request pool, respectively).
205  */
206 void ssl_log_xerror(const char *file, int line, int level, apr_status_t rv,
207                     apr_pool_t *ptemp, server_rec *s, X509 *cert,
208                     const char *fmt, ...)
209 {
210     if (APLOG_IS_LEVEL(s,level)) {
211        va_list ap;
212        va_start(ap, fmt);
213        ssl_log_cert_error(file, line, level, rv, s, NULL, NULL, ptemp,
214                           cert, fmt, ap);
215        va_end(ap);
216     }
217 }
218
219 void ssl_log_cxerror(const char *file, int line, int level, apr_status_t rv,
220                      conn_rec *c, X509 *cert, const char *fmt, ...)
221 {
222     if (APLOG_IS_LEVEL(mySrvFromConn(c),level)) {
223        va_list ap;
224        va_start(ap, fmt);
225        ssl_log_cert_error(file, line, level, rv, NULL, c, NULL, c->pool,
226                           cert, fmt, ap);
227        va_end(ap);
228     }
229 }
230
231 void ssl_log_rxerror(const char *file, int line, int level, apr_status_t rv,
232                      request_rec *r, X509 *cert, const char *fmt, ...)
233 {
234     if (APLOG_R_IS_LEVEL(r,level)) {
235        va_list ap;
236        va_start(ap, fmt);
237        ssl_log_cert_error(file, line, level, rv, NULL, NULL, r, r->pool,
238                           cert, fmt, ap);
239        va_end(ap);
240     }
241 }