source: mod_gnutls/src/gnutls_ocsp.c @ 78b75b3

debian/masterdebian/stretch-backportsupstream
Last change on this file since 78b75b3 was 78b75b3, checked in by Thomas Klute <thomas2.klute@…>, 3 years ago

Restore GnuTLSOCSPResponseFile option

Using an externally updated response file avoids the blocking issues
the OCSP client implementation currently has, so it is good to have
both options.

  • Property mode set to 100644
File size: 29.1 KB
Line 
1/**
2 *  Copyright 2016 Thomas Klute
3 *
4 *  Licensed under the Apache License, Version 2.0 (the "License");
5 *  you may not use this file except in compliance with the License.
6 *  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#include "gnutls_ocsp.h"
18#include "mod_gnutls.h"
19#include "gnutls_cache.h"
20#include "gnutls_util.h"
21
22#include <apr_escape.h>
23#include <apr_lib.h>
24#include <apr_time.h>
25#include <gnutls/ocsp.h>
26#include <time.h>
27
28#ifdef APLOG_USE_MODULE
29APLOG_USE_MODULE(gnutls);
30#endif
31
32/* maximum supported OCSP response size, 8K should be plenty */
33#define OCSP_RESP_SIZE_MAX (8 * 1024)
34#define OCSP_REQ_TYPE "application/ocsp-request"
35#define OCSP_RESP_TYPE "application/ocsp-response"
36
37
38
39#define _log_one_ocsp_fail(str, srv)                                    \
40    ap_log_error(APLOG_MARK, APLOG_INFO, APR_EGENERAL, (srv),           \
41                 "Reason for failed OCSP response verification: %s", (str))
42/*
43 * Log all matching reasons for verification failure
44 */
45static void _log_verify_fail_reason(const unsigned int verify, server_rec *s)
46{
47    if (verify & GNUTLS_OCSP_VERIFY_SIGNER_NOT_FOUND)
48        _log_one_ocsp_fail("Signer cert not found", s);
49
50    if (verify & GNUTLS_OCSP_VERIFY_SIGNER_KEYUSAGE_ERROR)
51        _log_one_ocsp_fail("Signer cert keyusage error", s);
52
53    if (verify & GNUTLS_OCSP_VERIFY_UNTRUSTED_SIGNER)
54        _log_one_ocsp_fail("Signer cert is not trusted", s);
55
56    if (verify & GNUTLS_OCSP_VERIFY_INSECURE_ALGORITHM)
57        _log_one_ocsp_fail("Insecure algorithm", s);
58
59    if (verify & GNUTLS_OCSP_VERIFY_SIGNATURE_FAILURE)
60        _log_one_ocsp_fail("Signature failure", s);
61
62    if (verify & GNUTLS_OCSP_VERIFY_CERT_NOT_ACTIVATED)
63        _log_one_ocsp_fail("Signer cert not yet activated", s);
64
65    if (verify & GNUTLS_OCSP_VERIFY_CERT_EXPIRED)
66        _log_one_ocsp_fail("Signer cert expired", s);
67}
68
69
70
71const char *mgs_ocsp_stapling_enable(cmd_parms *parms,
72                                     void *dummy __attribute__((unused)),
73                                     const int arg)
74{
75    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
76        ap_get_module_config(parms->server->module_config, &gnutls_module);
77
78    if (arg)
79        sc->ocsp_staple = GNUTLS_ENABLED_TRUE;
80    else
81        sc->ocsp_staple = GNUTLS_ENABLED_FALSE;
82
83    return NULL;
84}
85
86
87
88const char *mgs_store_ocsp_response_path(cmd_parms *parms,
89                                         void *dummy __attribute__((unused)),
90                                         const char *arg)
91{
92    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
93        ap_get_module_config(parms->server->module_config, &gnutls_module);
94
95    sc->ocsp_response_file = ap_server_root_relative(parms->pool, arg);
96    return NULL;
97}
98
99
100
101/**
102 * Create an OCSP request for the certificate of the given server. The
103 * DER encoded request is stored in 'req' (must be released with
104 * gnutls_free() when no longer needed), its nonce in 'nonce' (same,
105 * if not NULL).
106 *
107 * Returns GNUTLS_E_SUCCESS, or a GnuTLS error code.
108 */
109static int mgs_create_ocsp_request(server_rec *s, gnutls_datum_t *req,
110                            gnutls_datum_t *nonce)
111    __attribute__((nonnull(1, 2)));
112static int mgs_create_ocsp_request(server_rec *s, gnutls_datum_t *req,
113                            gnutls_datum_t *nonce)
114{
115    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
116        ap_get_module_config(s->module_config, &gnutls_module);
117
118    gnutls_ocsp_req_t r;
119    int ret = gnutls_ocsp_req_init(&r);
120    if (ret != GNUTLS_E_SUCCESS)
121    {
122        ap_log_error(APLOG_MARK, APLOG_ERR, APR_EGENERAL, s,
123                     "Could not initialize OCSP request structure: %s (%d)",
124                     gnutls_strerror(ret), ret);
125        return ret;
126    }
127
128    /* GnuTLS doc says that the digest is "normally"
129     * GNUTLS_DIG_SHA1. */
130    ret = gnutls_ocsp_req_add_cert(r, GNUTLS_DIG_SHA256,
131                                   sc->certs_x509_crt_chain[1],
132                                   sc->certs_x509_crt_chain[0]);
133
134    if (ret != GNUTLS_E_SUCCESS)
135    {
136        ap_log_error(APLOG_MARK, APLOG_ERR, APR_EGENERAL, s,
137                     "Adding certificate to OCSP request for %s:%d "
138                     "failed: %s (%d)",
139                     s->server_hostname, s->addrs->host_port,
140                     gnutls_strerror(ret), ret);
141        gnutls_ocsp_req_deinit(r);
142        return ret;
143    }
144
145    ret = gnutls_ocsp_req_randomize_nonce(r);
146    if (ret != GNUTLS_E_SUCCESS)
147    {
148        ap_log_error(APLOG_MARK, APLOG_ERR, APR_EGENERAL, s,
149                     "OCSP nonce creation failed: %s (%d)",
150                     gnutls_strerror(ret), ret);
151        gnutls_ocsp_req_deinit(r);
152        return ret;
153    }
154
155    if (nonce != NULL)
156    {
157        ret = gnutls_ocsp_req_get_nonce(r, NULL, nonce);
158        if (ret != GNUTLS_E_SUCCESS)
159        {
160            ap_log_error(APLOG_MARK, APLOG_ERR, APR_EGENERAL, s,
161                         "Could not get nonce: %s (%d)",
162                         gnutls_strerror(ret), ret);
163            gnutls_free(nonce->data);
164            nonce->data = NULL;
165            nonce->size = 0;
166            gnutls_ocsp_req_deinit(r);
167            return ret;
168        }
169    }
170
171    ret = gnutls_ocsp_req_export(r, req);
172    if (ret != GNUTLS_E_SUCCESS)
173    {
174        ap_log_error(APLOG_MARK, APLOG_ERR, APR_EGENERAL, s,
175                     "OCSP request export failed: %s (%d)",
176                     gnutls_strerror(ret), ret);
177        gnutls_free(req->data);
178        req->data = NULL;
179        req->size = 0;
180        if (nonce != NULL)
181        {
182            gnutls_free(nonce->data);
183            nonce->data = NULL;
184            nonce->size = 0;
185        }
186        gnutls_ocsp_req_deinit(r);
187        return ret;
188    }
189
190    gnutls_ocsp_req_deinit(r);
191    return ret;
192}
193
194
195
196/**
197 * Check if the provided OCSP response is usable for stapling in
198 * connections to this server. Returns GNUTLS_E_SUCCESS if yes.
199 *
200 * Supports only one certificate status per response.
201 *
202 * If expiry is not NULL, it will be set to the nextUpdate time
203 * contained in the response, or zero if the response does not contain
204 * a nextUpdate field.
205 *
206 * If nonce is not NULL, the response must contain a matching nonce.
207 */
208int check_ocsp_response(server_rec *s, const gnutls_datum_t *ocsp_response,
209                        apr_time_t* expiry, const gnutls_datum_t *nonce)
210    __attribute__((nonnull(1, 2)));
211int check_ocsp_response(server_rec *s, const gnutls_datum_t *ocsp_response,
212                        apr_time_t* expiry, const gnutls_datum_t *nonce)
213{
214    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
215        ap_get_module_config(s->module_config, &gnutls_module);
216
217    if (sc->ocsp->trust == NULL)
218    {
219        ap_log_error(APLOG_MARK, APLOG_ERR, APR_EGENERAL, s,
220                     "No OCSP trust list available for server \"%s\"!",
221                     s->server_hostname);
222        return GNUTLS_E_NO_CERTIFICATE_FOUND;
223    }
224
225    gnutls_ocsp_resp_t resp;
226    int ret = gnutls_ocsp_resp_init(&resp);
227    if (ret != GNUTLS_E_SUCCESS)
228    {
229        ap_log_error(APLOG_MARK, APLOG_ERR, APR_EGENERAL, s,
230                     "Could not initialize OCSP response structure: %s (%d)",
231                     gnutls_strerror(ret), ret);
232        goto resp_cleanup;
233    }
234    ret = gnutls_ocsp_resp_import(resp, ocsp_response);
235    if (ret != GNUTLS_E_SUCCESS)
236    {
237        ap_log_error(APLOG_MARK, APLOG_ERR, APR_EGENERAL, s,
238                     "Importing OCSP response failed: %s (%d)",
239                     gnutls_strerror(ret), ret);
240        goto resp_cleanup;
241    }
242
243    ret = gnutls_ocsp_resp_check_crt(resp, 0, sc->certs_x509_crt_chain[0]);
244    if (ret != GNUTLS_E_SUCCESS)
245    {
246        ap_log_error(APLOG_MARK, APLOG_ERR, APR_EGENERAL, s,
247                     "OCSP response is not for server certificate: %s (%d)",
248                     gnutls_strerror(ret), ret);
249        goto resp_cleanup;
250    }
251
252    unsigned int verify;
253    ret = gnutls_ocsp_resp_verify(resp, *(sc->ocsp->trust), &verify, 0);
254    if (ret != GNUTLS_E_SUCCESS)
255    {
256        ap_log_error(APLOG_MARK, APLOG_ERR, APR_EGENERAL, s,
257                     "OCSP response verification failed: %s (%d)",
258                     gnutls_strerror(ret), ret);
259        goto resp_cleanup;
260    }
261    else
262    {
263        /* verification worked, check the result */
264        if (verify != 0)
265        {
266            _log_verify_fail_reason(verify, s);
267            ret = GNUTLS_E_OCSP_RESPONSE_ERROR;
268            goto resp_cleanup;
269        }
270        else
271            ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, s,
272                         "OCSP response signature is valid.");
273    }
274
275    if (nonce != NULL)
276    {
277        gnutls_datum_t resp_nonce;
278        ret = gnutls_ocsp_resp_get_nonce(resp, 0, &resp_nonce);
279        if (ret != GNUTLS_E_SUCCESS)
280        {
281            ap_log_error(APLOG_MARK, APLOG_ERR, APR_EGENERAL, s,
282                         "Could not get OCSP response nonce: %s (%d)",
283                         gnutls_strerror(ret), ret);
284            goto resp_cleanup;
285        }
286        if (resp_nonce.size != nonce->size
287            || memcmp(resp_nonce.data, nonce->data, nonce->size))
288        {
289            ret = GNUTLS_E_OCSP_RESPONSE_ERROR;
290            ap_log_error(APLOG_MARK, APLOG_ERR, APR_EGENERAL, s,
291                         "OCSP response invalid: nonce mismatch");
292            gnutls_free(resp_nonce.data);
293            goto resp_cleanup;
294        }
295        ap_log_error(APLOG_MARK, APLOG_TRACE2, APR_SUCCESS, s,
296                     "OCSP response: nonce match");
297        gnutls_free(resp_nonce.data);
298    }
299
300    /* OK, response is for our certificate and valid, let's get the
301     * actual response data. */
302    unsigned int cert_status;
303    time_t this_update;
304    time_t next_update;
305    ret = gnutls_ocsp_resp_get_single(resp, 0, NULL, NULL, NULL, NULL,
306                                      &cert_status, &this_update,
307                                      &next_update, NULL, NULL);
308    if (ret != GNUTLS_E_SUCCESS)
309    {
310        ap_log_error(APLOG_MARK, APLOG_ERR, APR_EGENERAL, s,
311                     "Could not get OCSP response data: %s (%d)",
312                     gnutls_strerror(ret), ret);
313        goto resp_cleanup;
314    }
315
316    apr_time_t now = apr_time_now();
317    apr_time_t valid_at;
318    apr_time_ansi_put(&valid_at, this_update);
319    /* Buffer for human-readable times produced by apr_rfc822_date,
320     * see apr_time.h */
321    char date_str[APR_RFC822_DATE_LEN];
322    apr_rfc822_date(date_str, valid_at);
323
324    if (now < valid_at)
325    {
326        /* We don't know if our clock or that of the OCSP responder is
327         * out of sync, so warn but continue. */
328        ap_log_error(APLOG_MARK, APLOG_WARNING, APR_EGENERAL, s,
329                     "OSCP response claims to be from future (%s), check "
330                     "time synchronization!", date_str);
331    }
332
333    if (next_update == (time_t) -1)
334    {
335        ap_log_error(APLOG_MARK, APLOG_INFO, APR_SUCCESS, s,
336                     "OSCP response does not contain nextUpdate info.");
337        if (expiry != NULL)
338            *expiry = 0;
339    }
340    else
341    {
342        apr_time_t valid_to;
343        apr_time_ansi_put(&valid_to, next_update);
344        if (expiry != NULL)
345            *expiry = valid_to;
346        if (now > valid_to)
347        {
348            apr_rfc822_date(date_str, valid_to);
349            ap_log_error(APLOG_MARK, APLOG_ERR, APR_EGENERAL, s,
350                         "OCSP response has expired at %s!", date_str);
351            /* Do not send a stale response */
352            ret = GNUTLS_E_OCSP_RESPONSE_ERROR;
353            goto resp_cleanup;
354        }
355    }
356
357    /* What's the actual status? Will be one of
358     * gnutls_ocsp_cert_status_t as defined in gnutls/ocsp.h. */
359    if (cert_status == GNUTLS_OCSP_CERT_GOOD)
360    {
361        /* Yay, everything's good! */
362        ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, s,
363                     "CA flagged certificate as valid at %s.", date_str);
364    }
365    else
366    {
367        ap_log_error(APLOG_MARK, APLOG_ERR, APR_EGENERAL, s,
368                     "CA flagged certificate as %s at %s.",
369                     cert_status == GNUTLS_OCSP_CERT_REVOKED ?
370                     "revoked" : "unknown", date_str);
371        ret = GNUTLS_E_OCSP_RESPONSE_ERROR;
372    }
373
374 resp_cleanup:
375    gnutls_ocsp_resp_deinit(resp);
376    return ret;
377}
378
379
380
381/*
382 * Returns the certificate fingerprint, memory is allocated from p.
383 */
384static gnutls_datum_t mgs_get_cert_fingerprint(apr_pool_t *p,
385                                               gnutls_x509_crt_t cert)
386{
387    gnutls_datum_t fingerprint = {NULL, 0};
388    size_t fplen = 0;
389    gnutls_x509_crt_get_fingerprint(cert, GNUTLS_DIG_SHA1, NULL, &fplen);
390    unsigned char * fp = apr_palloc(p, fplen);
391    gnutls_x509_crt_get_fingerprint(cert, GNUTLS_DIG_SHA1, fp, &fplen);
392    /* Safe integer type conversion: The types of fingerprint.size
393     * (unsigned int) and fplen (size_t) may have different
394     * lengths. */
395    if (__builtin_add_overflow(fplen, 0, &fingerprint.size))
396        fingerprint.size = 0;
397    else
398        fingerprint.data = fp;
399    return fingerprint;
400}
401
402
403
404static apr_status_t do_ocsp_request(apr_pool_t *p, server_rec *s,
405                                    gnutls_datum_t *request,
406                                    gnutls_datum_t *response)
407    __attribute__((nonnull));
408static apr_status_t do_ocsp_request(apr_pool_t *p, server_rec *s,
409                                    gnutls_datum_t *request,
410                                    gnutls_datum_t *response)
411{
412    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
413        ap_get_module_config(s->module_config, &gnutls_module);
414
415    if (apr_strnatcmp(sc->ocsp->uri->scheme, "http"))
416    {
417        ap_log_error(APLOG_MARK, APLOG_ERR, APR_EGENERAL, s,
418                     "Scheme \"%s\" is not supported for OCSP requests!",
419                     sc->ocsp->uri->scheme);
420        return APR_EINVAL;
421    }
422
423    const char* header = http_post_header(p, sc->ocsp->uri,
424                                          OCSP_REQ_TYPE, OCSP_RESP_TYPE,
425                                          request->size);
426    ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, s,
427                 "OCSP POST header: %s", header);
428
429    /* Find correct port */
430    apr_port_t port = sc->ocsp->uri->port ?
431        sc->ocsp->uri->port : apr_uri_port_of_scheme(sc->ocsp->uri->scheme);
432
433    apr_sockaddr_t *sa;
434    apr_status_t rv = apr_sockaddr_info_get(&sa, sc->ocsp->uri->hostname,
435                                            APR_UNSPEC, port, 0, p);
436    if (rv != APR_SUCCESS)
437    {
438        ap_log_error(APLOG_MARK, APLOG_ERR, rv, s,
439                     "Address resolution for OCSP responder %s failed.",
440                     sc->ocsp->uri->hostinfo);
441    }
442
443    /* There may be multiple answers, try them in order until one
444     * works. */
445    apr_socket_t *sock;
446    /* TODO: configurable timeout */
447    apr_interval_time_t timeout = apr_time_from_sec(2);
448    while (sa)
449    {
450        rv = apr_socket_create(&sock, sa->family, SOCK_STREAM,
451                               APR_PROTO_TCP, p);
452        if (rv == APR_SUCCESS)
453        {
454            apr_socket_timeout_set(sock, timeout);
455            rv = apr_socket_connect(sock, sa);
456            if (rv == APR_SUCCESS)
457                /* Connected! */
458                break;
459            apr_socket_close(sock);
460        }
461        sa = sa->next;
462    }
463    /* If the socket is connected, 'sa' points at the matching
464     * address. */
465    if (sa == NULL)
466    {
467        ap_log_error(APLOG_MARK, APLOG_ERR, rv, s,
468                     "Connecting to OCSP responder %s failed.",
469                     sc->ocsp->uri->hostinfo);
470        return rv;
471    }
472
473    /* Header is generated locally, so strlen() is safe. */
474    rv = sock_send_buf(sock, header, strlen(header));
475    if (rv == APR_SUCCESS)
476        rv = sock_send_buf(sock, (char*) request->data, request->size);
477    /* catches errors from both header and request */
478    if (rv != APR_SUCCESS)
479    {
480        ap_log_error(APLOG_MARK, APLOG_ERR, rv, s,
481                     "Sending OCSP request failed.");
482        goto exit;
483    }
484
485    /* Prepare bucket brigades to read the response header. BBs make
486     * it easy to split the header into lines. */
487    apr_bucket_alloc_t *ba = apr_bucket_alloc_create(p);
488    apr_bucket_brigade *bb = apr_brigade_create(p, ba);
489    /* will carry split response headers */
490    apr_bucket_brigade *rh = apr_brigade_create(p, ba);
491
492    APR_BRIGADE_INSERT_TAIL(bb, apr_bucket_socket_create(sock, ba));
493    /* The first line in the response header must be the status, check
494     * for OK status code. Line looks similar to "HTTP/1.0 200 OK". */
495    const char *h = read_line(p, bb, rh);
496    const char *code = 0;
497    if (h == NULL
498        || strncmp(h, "HTTP/", 5)
499        || (code = ap_strchr(h, ' ')) == NULL
500        || apr_atoi64(code + 1) != HTTP_OK)
501    {
502        ap_log_error(APLOG_MARK, APLOG_ERR, rv, s,
503                     "Invalid HTTP response status from %s: %s",
504                     sc->ocsp->uri->hostinfo, h);
505        rv = APR_ECONNRESET;
506        goto exit;
507    }
508    /* Read remaining header lines */
509    for (h = read_line(p, bb, rh); h != NULL && apr_strnatcmp(h, "") != 0;
510         h = read_line(p, bb, rh))
511    {
512        ap_log_error(APLOG_MARK, APLOG_TRACE2, APR_SUCCESS, s,
513                     "Received header: %s", h);
514    }
515    /* The last header line should be empty (""), NULL indicates an
516     * error. */
517    if (h == NULL)
518    {
519        ap_log_error(APLOG_MARK, APLOG_ERR, rv, s,
520                     "Error while reading HTTP response header from %s",
521                     sc->ocsp->uri->hostinfo);
522        rv = APR_ECONNRESET;
523        goto exit;
524    }
525
526    /* Headers have been consumed, the rest of the available data
527     * should be the actual response. */
528    apr_size_t len = OCSP_RESP_SIZE_MAX;
529    char buf[OCSP_RESP_SIZE_MAX];
530    /* apr_brigade_pflatten() can allocate directly from the pool, but
531     * the documentation does not describe a way to limit the size of
532     * the buffer, which is necessary here to prevent DoS by endless
533     * response. Use apr_brigade_flatten() to read to a stack pool,
534     * then create a copy to return. */
535    rv = apr_brigade_flatten(bb, buf, &len);
536    if (rv != APR_SUCCESS)
537    {
538        ap_log_error(APLOG_MARK, APLOG_ERR, rv, s,
539                     "Failed to read OCSP response.");
540        goto exit;
541    }
542
543    /* With the length restriction this really should not happen. */
544    if (__builtin_add_overflow(len, 0, &response->size))
545    {
546        response->data = NULL;
547        rv = APR_ENOMEM;
548    }
549    else
550    {
551        response->data = apr_pmemdup(p, buf, len);
552    }
553
554 exit:
555    apr_socket_close(sock);
556    return rv;
557}
558
559
560
561apr_status_t mgs_cache_ocsp_response(server_rec *s)
562{
563    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
564        ap_get_module_config(s->module_config, &gnutls_module);
565
566    if (sc->cache == NULL)
567    {
568        /* OCSP caching requires a cache. */
569        return APR_ENOTIMPL;
570    }
571
572    apr_pool_t *tmp;
573    apr_status_t rv = apr_pool_create(&tmp, NULL);
574    if (rv != APR_SUCCESS)
575    {
576        ap_log_error(APLOG_MARK, APLOG_ERR, rv, s,
577                     "could not create temporary pool for %s",
578                     __func__);
579        return rv;
580    }
581
582    gnutls_datum_t resp;
583    gnutls_datum_t nonce = { NULL, 0 };
584
585    if (sc->ocsp_response_file != NULL)
586    {
587        ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, s,
588                     "Loading OCSP response from %s",
589                     sc->ocsp_response_file);
590        rv = datum_from_file(tmp, sc->ocsp_response_file, &resp);
591        if (rv != APR_SUCCESS)
592        {
593            ap_log_error(APLOG_MARK, APLOG_ERR, rv, s,
594                         "Loading OCSP response from %s failed!",
595                         sc->ocsp_response_file);
596            apr_pool_destroy(tmp);
597            return rv;
598        }
599    }
600    else
601    {
602        gnutls_datum_t req;
603        int ret = mgs_create_ocsp_request(s, &req, &nonce);
604        if (ret == GNUTLS_E_SUCCESS)
605        {
606            ap_log_error(APLOG_MARK, APLOG_TRACE2, APR_SUCCESS, s,
607                         "created OCSP request for %s:%d: %s",
608                         s->server_hostname, s->addrs->host_port,
609                         apr_pescape_hex(tmp, req.data, req.size, 0));
610        }
611        else
612        {
613            gnutls_free(req.data);
614            gnutls_free(nonce.data);
615            apr_pool_destroy(tmp);
616            return APR_EGENERAL;
617        }
618
619        rv = do_ocsp_request(tmp, s, &req, &resp);
620        gnutls_free(req.data);
621        if (rv != APR_SUCCESS)
622        {
623            /* do_ocsp_request() does its own error logging. */
624            gnutls_free(nonce.data);
625            apr_pool_destroy(tmp);
626            return rv;
627        }
628    }
629
630    /* TODO: separate option to enable/disable nonce */
631
632    apr_time_t expiry;
633    if (check_ocsp_response(s, &resp, &expiry, nonce.size ? &nonce : NULL)
634        != GNUTLS_E_SUCCESS)
635    {
636        ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_EGENERAL, s,
637                     "OCSP response validation failed, cannot "
638                     "update cache.");
639        apr_pool_destroy(tmp);
640        gnutls_free(nonce.data);
641        return APR_EGENERAL;
642    }
643    gnutls_free(nonce.data);
644
645    /* If expiry is zero, the response does not contain a nextUpdate
646     * field. Use the default cache timeout. */
647    if (expiry == 0)
648        expiry = apr_time_now() + sc->cache_timeout;
649    /* Apply grace time otherwise. */
650    else
651        expiry -= sc->ocsp_grace_time;
652
653    int r = sc->cache->store(s, sc->ocsp->fingerprint, resp, expiry);
654    /* destroy pool, and original copy of the OCSP response with it */
655    apr_pool_destroy(tmp);
656    if (r != 0)
657    {
658        ap_log_error(APLOG_MARK, APLOG_ERR, APR_EGENERAL, s,
659                      "Storing OCSP response in cache failed.");
660        return APR_EGENERAL;
661    }
662    return APR_SUCCESS;
663}
664
665
666
667int mgs_get_ocsp_response(gnutls_session_t session __attribute__((unused)),
668                          void *ptr,
669                          gnutls_datum_t *ocsp_response)
670{
671    mgs_handle_t *ctxt = (mgs_handle_t *) ptr;
672    if (!ctxt->sc->ocsp_staple || ctxt->sc->cache == NULL)
673    {
674        /* OCSP must be enabled and caching requires a cache. */
675        return GNUTLS_E_NO_CERTIFICATE_STATUS;
676    }
677
678    *ocsp_response = ctxt->sc->cache->fetch(ctxt,
679                                            ctxt->sc->ocsp->fingerprint);
680    if (ocsp_response->size == 0)
681    {
682        ap_log_cerror(APLOG_MARK, APLOG_DEBUG, APR_EGENERAL, ctxt->c,
683                      "Fetching OCSP response from cache failed.");
684    }
685    else
686    {
687        return GNUTLS_E_SUCCESS;
688    }
689    /* get rid of invalid response (if any) */
690    gnutls_free(ocsp_response->data);
691    ocsp_response->data = NULL;
692
693    /* If the cache had no response or an invalid one, try to update. */
694    ap_log_cerror(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, ctxt->c,
695                  "No valid OCSP response in cache, trying to update.");
696
697    /* TODO: Once sending OCSP requests is implemented we need a rate
698     * limit for retries on error. If the responder is overloaded or
699     * buggy we don't want to add too much more load, and if a MITM is
700     * messing with requests a repetition loop might end up being a
701     * self-inflicted denial of service. */
702    apr_status_t rv = apr_global_mutex_trylock(ctxt->sc->ocsp_mutex);
703    if (APR_STATUS_IS_EBUSY(rv))
704    {
705        /* Another thread is currently holding the mutex, wait. */
706        apr_global_mutex_lock(ctxt->sc->ocsp_mutex);
707        /* Check if this other thread updated the response we need. It
708         * would be better to have a vhost specific mutex, but at the
709         * moment there's no good way to integrate that with the
710         * Apache Mutex directive. */
711        *ocsp_response = ctxt->sc->cache->fetch(ctxt,
712                                                ctxt->sc->ocsp->fingerprint);
713        if (ocsp_response->size > 0)
714        {
715            /* Got a valid response now, unlock mutex and return. */
716            apr_global_mutex_unlock(ctxt->sc->ocsp_mutex);
717            return GNUTLS_E_SUCCESS;
718        }
719        else
720        {
721            gnutls_free(ocsp_response->data);
722            ocsp_response->data = NULL;
723        }
724    }
725
726    rv = mgs_cache_ocsp_response(ctxt->c->base_server);
727    if (rv != APR_SUCCESS)
728    {
729        ap_log_cerror(APLOG_MARK, APLOG_ERR, rv, ctxt->c,
730                      "Updating OCSP response cache failed");
731        apr_global_mutex_unlock(ctxt->sc->ocsp_mutex);
732        goto fail_cleanup;
733    }
734    apr_global_mutex_unlock(ctxt->sc->ocsp_mutex);
735
736    /* retry reading from cache */
737    *ocsp_response = ctxt->sc->cache->fetch(ctxt,
738                                            ctxt->sc->ocsp->fingerprint);
739    if (ocsp_response->size == 0)
740    {
741        ap_log_cerror(APLOG_MARK, APLOG_ERR, APR_EGENERAL, ctxt->c,
742                      "Fetching OCSP response from cache failed on retry.");
743    }
744    else
745    {
746        return GNUTLS_E_SUCCESS;
747    }
748
749    /* failure, clean up response data */
750 fail_cleanup:
751    gnutls_free(ocsp_response->data);
752    ocsp_response->size = 0;
753    ocsp_response->data = NULL;
754    return GNUTLS_E_NO_CERTIFICATE_STATUS;
755}
756
757
758
759int mgs_create_ocsp_trust_list(gnutls_x509_trust_list_t *tl,
760                               const gnutls_x509_crt_t *chain,
761                               const int num)
762{
763    int added = 0;
764    int ret = gnutls_x509_trust_list_init(tl, num);
765
766    if (ret == GNUTLS_E_SUCCESS)
767        added = gnutls_x509_trust_list_add_cas(*tl, chain, num, 0);
768
769    if (added != num)
770        ret = GNUTLS_E_CERTIFICATE_ERROR;
771
772    /* Clean up trust list in case of error */
773    if (ret != GNUTLS_E_SUCCESS)
774        gnutls_x509_trust_list_deinit(*tl, 0);
775
776    return ret;
777}
778
779
780
781apr_status_t mgs_cleanup_trust_list(void *data)
782{
783    gnutls_x509_trust_list_t *tl = (gnutls_x509_trust_list_t *) data;
784    gnutls_x509_trust_list_deinit(*tl, 0);
785    return APR_SUCCESS;
786}
787
788
789
790apr_uri_t * mgs_cert_get_ocsp_uri(apr_pool_t *p, gnutls_x509_crt_t cert)
791{
792    apr_pool_t *tmp;
793    apr_status_t rv = apr_pool_create(&tmp, p);
794    if (rv != APR_SUCCESS)
795        return NULL;
796
797    apr_uri_t *ocsp_uri = NULL;
798
799    int ret = GNUTLS_E_SUCCESS;
800    /* search authority info access for OCSP URI */
801    for (int seq = 0; ret != GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE; seq++)
802    {
803        gnutls_datum_t ocsp_access_data;
804        ret = gnutls_x509_crt_get_authority_info_access(cert, seq,
805                                                        GNUTLS_IA_OCSP_URI,
806                                                        &ocsp_access_data,
807                                                        NULL);
808        if (ret == GNUTLS_E_SUCCESS)
809        {
810            /* create NULL terminated string */
811            char *ocsp_str =
812                apr_pstrndup(tmp, (const char*) ocsp_access_data.data,
813                             ocsp_access_data.size);
814            gnutls_free(ocsp_access_data.data);
815
816            ocsp_uri = apr_palloc(p, sizeof(apr_uri_t));
817            rv = apr_uri_parse(p, ocsp_str, ocsp_uri);
818            if (rv == APR_SUCCESS)
819                break;
820            else
821                ocsp_uri = NULL;
822        }
823    }
824
825    apr_pool_destroy(tmp);
826    return ocsp_uri;
827}
828
829
830
831/*
832 * Like in the general post_config hook the HTTP status codes for
833 * errors are just for fun. What matters is "neither OK nor DECLINED"
834 * to denote an error.
835 */
836int mgs_ocsp_post_config_server(apr_pool_t *pconf,
837                                apr_pool_t *ptemp __attribute__((unused)),
838                                server_rec *server)
839{
840    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
841        ap_get_module_config(server->module_config, &gnutls_module);
842
843    if (sc->certs_x509_chain_num < 2)
844    {
845        ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, server,
846                     "OCSP stapling is enabled but no CA certificate "
847                     "available for %s:%d, make sure it is included in "
848                     "GnuTLSCertificateFile!",
849                     server->server_hostname, server->addrs->host_port);
850        return HTTP_NOT_FOUND;
851    }
852
853    sc->ocsp = apr_palloc(pconf, sizeof(struct mgs_ocsp_data));
854
855    sc->ocsp->fingerprint =
856        mgs_get_cert_fingerprint(pconf, sc->certs_x509_crt_chain[0]);
857    if (sc->ocsp->fingerprint.data == NULL)
858        return HTTP_INTERNAL_SERVER_ERROR;
859
860    sc->ocsp->uri = mgs_cert_get_ocsp_uri(pconf,
861                                          sc->certs_x509_crt_chain[0]);
862
863    sc->ocsp->trust = apr_palloc(pconf,
864                                 sizeof(gnutls_x509_trust_list_t));
865     /* Only the direct issuer may sign the OCSP response or an OCSP
866      * signer. */
867    int ret = mgs_create_ocsp_trust_list(sc->ocsp->trust,
868                                         &(sc->certs_x509_crt_chain[1]),
869                                         1);
870    if (ret != GNUTLS_E_SUCCESS)
871    {
872        ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, server,
873                     "Could not create OCSP trust list: %s (%d)",
874                     gnutls_strerror(ret), ret);
875        return HTTP_INTERNAL_SERVER_ERROR;
876    }
877    /* deinit trust list when the config pool is destroyed */
878    apr_pool_cleanup_register(pconf, sc->ocsp->trust,
879                              mgs_cleanup_trust_list,
880                              apr_pool_cleanup_null);
881
882    return OK;
883}
Note: See TracBrowser for help on using the repository browser.