source: mod_gnutls/src/gnutls_cache.c @ 0d7660d

debian/masterproxy-ticket
Last change on this file since 0d7660d was 0d7660d, checked in by Fiona Klute <fiona.klute@…>, 2 years ago

Provide a default path for the default OCSP cache

  • Property mode set to 100644
File size: 17.6 KB
Line 
1/*
2 *  Copyright 2004-2005 Paul Querna
3 *  Copyright 2008 Nikos Mavrogiannopoulos
4 *  Copyright 2011 Dash Shendy
5 *  Copyright 2015-2018 Fiona Klute
6 *
7 *  Licensed under the Apache License, Version 2.0 (the "License");
8 *  you may not use this file except in compliance with the License.
9 *  You may obtain a copy of the License at
10 *
11 *      http://www.apache.org/licenses/LICENSE-2.0
12 *
13 *  Unless required by applicable law or agreed to in writing, software
14 *  distributed under the License is distributed on an "AS IS" BASIS,
15 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 *  See the License for the specific language governing permissions and
17 *  limitations under the License.
18 */
19
20/**
21 * @file gnutls_cache.c
22 *
23 * This file contains the cache implementation used for session
24 * caching and OCSP stapling. The `socache_*_session` functions
25 * implement the GnuTLS session cache API using the configured cache,
26 * using mgs_cache_store() and mgs_cache_fetch() as appropriate (see
27 * gnutls_cache.h).
28 */
29
30#include "gnutls_cache.h"
31#include "mod_gnutls.h"
32#include "gnutls_config.h"
33#include "gnutls_ocsp.h"
34
35#include <ap_socache.h>
36#include <apr_escape.h>
37#include <util_mutex.h>
38
39/** Default session cache timeout */
40#define MGS_DEFAULT_CACHE_TIMEOUT 300
41
42/** Session cache name */
43#define MGS_SESSION_CACHE_NAME "gnutls_session"
44
45/** Default type for OCSP cache */
46#define DEFAULT_OCSP_CACHE_TYPE "shmcb"
47/** Default config string for OCSP cache */
48#define DEFAULT_OCSP_CACHE_CONF "gnutls_ocsp_cache"
49
50/** Maximum length of the hex string representation of a GnuTLS
51 * session ID: two characters per byte, plus one more for `\0` */
52#if GNUTLS_VERSION_NUMBER >= 0x030400
53#define GNUTLS_SESSION_ID_STRING_LEN ((GNUTLS_MAX_SESSION_ID_SIZE * 2) + 1)
54#else
55#define GNUTLS_SESSION_ID_STRING_LEN ((GNUTLS_MAX_SESSION_ID * 2) + 1)
56#endif
57
58#ifdef APLOG_USE_MODULE
59APLOG_USE_MODULE(gnutls);
60#endif
61
62/**
63 * Turn a GnuTLS session ID into the key format we use for
64 * caches. Name the Session ID as `server:port.SessionID` to disallow
65 * resuming sessions on different servers.
66 *
67 * @return `0` on success, `-1` on failure
68 */
69static int mgs_session_id2dbm(conn_rec *c, unsigned char *id, int idlen,
70                              gnutls_datum_t *dbmkey)
71{
72    char sz[GNUTLS_SESSION_ID_STRING_LEN];
73    apr_status_t rv = apr_escape_hex(sz, id, idlen, 0, NULL);
74    if (rv != APR_SUCCESS)
75        return -1;
76
77    char *newkey = apr_psprintf(c->pool, "%s:%d.%s",
78                                c->base_server->server_hostname,
79                                c->base_server->port, sz);
80    dbmkey->size = strlen(newkey);
81    /* signedness does not matter for arbitrary bits */
82    dbmkey->data = (unsigned char*) newkey;
83    return 0;
84}
85
86/** The OPENSSL_TIME_FORMAT macro and mgs_time2sz() serve to print
87 * time in a format compatible with OpenSSL's `ASN1_TIME_print()`
88 * function. */
89#define OPENSSL_TIME_FORMAT "%b %d %k:%M:%S %Y %Z"
90
91char *mgs_time2sz(time_t in_time, char *str, int strsize)
92{
93    apr_time_exp_t vtm;
94    apr_size_t ret_size;
95    apr_time_t t;
96
97
98    apr_time_ansi_put(&t, in_time);
99    apr_time_exp_gmt(&vtm, t);
100    apr_strftime(str, &ret_size, strsize - 1, OPENSSL_TIME_FORMAT, &vtm);
101
102    return str;
103}
104
105
106
107int mgs_cache_store(mgs_cache_t cache, server_rec *server,
108                    gnutls_datum_t key, gnutls_datum_t data,
109                    apr_time_t expiry)
110{
111    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
112        ap_get_module_config(server->module_config, &gnutls_module);
113
114    apr_pool_t *spool;
115    apr_pool_create(&spool, NULL);
116
117    if (cache->prov->flags & AP_SOCACHE_FLAG_NOTMPSAFE)
118        apr_global_mutex_lock(cache->mutex);
119    apr_status_t rv = cache->prov->store(cache->socache, server,
120                                         key.data, key.size,
121                                         expiry,
122                                         data.data, data.size,
123                                         spool);
124    if (cache->prov->flags & AP_SOCACHE_FLAG_NOTMPSAFE)
125        apr_global_mutex_unlock(cache->mutex);
126
127    if (rv != APR_SUCCESS)
128    {
129        ap_log_error(APLOG_MARK, APLOG_DEBUG, rv, server,
130                     "error storing in cache '%s:%s'",
131                     cache->prov->name, sc->cache->config);
132        apr_pool_destroy(spool);
133        return -1;
134    }
135
136    ap_log_error(APLOG_MARK, APLOG_TRACE1, rv, server,
137                 "stored %u bytes of data (%u byte key) in cache '%s:%s'",
138                 data.size, key.size,
139                 cache->prov->name, sc->cache->config);
140    apr_pool_destroy(spool);
141    return 0;
142}
143
144
145
146/**
147 * Store function for the GnuTLS session cache, see
148 * gnutls_db_set_store_function().
149 *
150 * @param baton mgs_handle_t for the connection, as set via
151 * gnutls_db_set_ptr()
152 *
153 * @param key object key to store
154 *
155 * @param data the object to store
156 *
157 * @return `0` in case of success, `-1` in case of failure
158 */
159static int socache_store_session(void *baton, gnutls_datum_t key,
160                                 gnutls_datum_t data)
161{
162    mgs_handle_t *ctxt = baton;
163    gnutls_datum_t dbmkey;
164
165    if (mgs_session_id2dbm(ctxt->c, key.data, key.size, &dbmkey) < 0)
166        return -1;
167
168    apr_time_t expiry = apr_time_now() + ctxt->sc->cache_timeout;
169
170    return mgs_cache_store(ctxt->sc->cache, ctxt->c->base_server,
171                           dbmkey, data, expiry);
172}
173
174
175
176/** 8K is the maximum size accepted when receiving OCSP responses,
177 * sessions cache entries should be much smaller. The buffer is
178 * reallocated to actual size after fetching, so memory waste is
179 * minimal and temporary. */
180#define SOCACHE_FETCH_BUF_SIZE (8 * 1024)
181
182gnutls_datum_t mgs_cache_fetch(mgs_cache_t cache, server_rec *server,
183                               gnutls_datum_t key, apr_pool_t *pool)
184{
185    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
186        ap_get_module_config(server->module_config, &gnutls_module);
187
188    gnutls_datum_t data = {NULL, 0};
189    data.data = gnutls_malloc(SOCACHE_FETCH_BUF_SIZE);
190    if (data.data == NULL)
191        return data;
192    data.size = SOCACHE_FETCH_BUF_SIZE;
193
194    apr_pool_t *spool;
195    apr_pool_create(&spool, pool);
196
197    if (cache->prov->flags & AP_SOCACHE_FLAG_NOTMPSAFE)
198        apr_global_mutex_lock(cache->mutex);
199    apr_status_t rv = cache->prov->retrieve(cache->socache, server,
200                                            key.data, key.size,
201                                            data.data, &data.size,
202                                            spool);
203    if (cache->prov->flags & AP_SOCACHE_FLAG_NOTMPSAFE)
204        apr_global_mutex_unlock(cache->mutex);
205
206    if (rv != APR_SUCCESS)
207    {
208        /* APR_NOTFOUND means there's no such object. */
209        if (rv == APR_NOTFOUND)
210            ap_log_error(APLOG_MARK, APLOG_TRACE1, rv, server,
211                         "requested entry not found in cache '%s:%s'.",
212                         cache->prov->name, sc->cache->config);
213        else
214            ap_log_error(APLOG_MARK, APLOG_WARNING, rv, server,
215                         "error fetching from cache '%s:%s'",
216                         cache->prov->name, sc->cache->config);
217        /* free unused buffer */
218        gnutls_free(data.data);
219        data.data = NULL;
220        data.size = 0;
221    }
222    else
223    {
224        ap_log_error(APLOG_MARK, APLOG_TRACE1, rv, server,
225                     "fetched %u bytes from cache '%s:%s'",
226                     data.size, cache->prov->name, sc->cache->config);
227
228        /* Realloc buffer to data.size. Data size must be less than or
229         * equal to the initial buffer size, so this REALLY should not
230         * fail. */
231        data.data = gnutls_realloc(data.data, data.size);
232        if (__builtin_expect(data.data == NULL, 0))
233        {
234            ap_log_error(APLOG_MARK, APLOG_CRIT, APR_ENOMEM, server,
235                         "%s: Could not realloc fetch buffer to data size!",
236                         __func__);
237            data.size = 0;
238        }
239    }
240    apr_pool_destroy(spool);
241
242    return data;
243}
244
245
246
247/**
248 * Fetch function for the GnuTLS session cache, see
249 * gnutls_db_set_retrieve_function().
250 *
251 * *Warning*: The `data` element of the returned `gnutls_datum_t` is
252 * allocated using `gnutls_malloc()` for compatibility with the GnuTLS
253 * session caching API, and must be released using `gnutls_free()`.
254 *
255 * @param baton mgs_handle_t for the connection, as set via
256 * gnutls_db_set_ptr()
257 *
258 * @param key object key to fetch
259 *
260 * @return the requested cache entry, or `{NULL, 0}`
261 */
262static gnutls_datum_t socache_fetch_session(void *baton, gnutls_datum_t key)
263{
264    gnutls_datum_t data = {NULL, 0};
265    gnutls_datum_t dbmkey;
266    mgs_handle_t *ctxt = baton;
267
268    if (mgs_session_id2dbm(ctxt->c, key.data, key.size, &dbmkey) < 0)
269        return data;
270
271    return mgs_cache_fetch(ctxt->sc->cache, ctxt->c->base_server,
272                           dbmkey, ctxt->c->pool);
273}
274
275
276
277/**
278 * Remove function for the GnuTLS session cache, see
279 * gnutls_db_set_remove_function().
280 *
281 * @param baton mgs_handle_t for the connection, as set via
282 * gnutls_db_set_ptr()
283 *
284 * @param key object key to remove
285 *
286 * @return `0` in case of success, `-1` in case of failure
287 */
288static int socache_delete_session(void *baton, gnutls_datum_t key)
289{
290    gnutls_datum_t tmpkey;
291    mgs_handle_t *ctxt = baton;
292
293    if (mgs_session_id2dbm(ctxt->c, key.data, key.size, &tmpkey) < 0)
294        return -1;
295
296    if (ctxt->sc->cache->prov->flags & AP_SOCACHE_FLAG_NOTMPSAFE)
297        apr_global_mutex_lock(ctxt->sc->cache->mutex);
298    apr_status_t rv = ctxt->sc->cache->prov->remove(ctxt->sc->cache->socache,
299                                                    ctxt->c->base_server,
300                                                    key.data, key.size,
301                                                    ctxt->c->pool);
302    if (ctxt->sc->cache->prov->flags & AP_SOCACHE_FLAG_NOTMPSAFE)
303        apr_global_mutex_unlock(ctxt->sc->cache->mutex);
304
305    if (rv != APR_SUCCESS) {
306        ap_log_error(APLOG_MARK, APLOG_NOTICE, rv,
307                     ctxt->c->base_server,
308                     "error deleting from cache '%s:%s'",
309                     ctxt->sc->cache->prov->name, ctxt->sc->cache->config);
310        return -1;
311    }
312    return 0;
313}
314
315
316
317const char *mgs_cache_inst_config(mgs_cache_t *cache, server_rec *server,
318                                  const char* type, const char* config,
319                                  apr_pool_t *pconf, apr_pool_t *ptemp)
320{
321    /* Allocate cache structure, will be assigned to *cache after
322     * successful configuration. */
323    mgs_cache_t c = apr_pcalloc(pconf, sizeof(struct mgs_cache));
324    if (c == NULL)
325        return "Could not allocate memory for cache configuration!";
326
327    /* Find the right socache provider */
328    c->prov = ap_lookup_provider(AP_SOCACHE_PROVIDER_GROUP,
329                                 type,
330                                 AP_SOCACHE_PROVIDER_VERSION);
331    if (c->prov == NULL)
332    {
333        return apr_psprintf(ptemp,
334                            "Could not find socache provider '%s', please "
335                            "make sure that the provider name is valid and "
336                            "the appropriate module is loaded (maybe "
337                            "mod_socache_%s.so?).",
338                            type, type);
339    }
340
341    /* shmcb works fine with NULL, but make sure there's a valid (if
342     * empty) string for logging */
343    if (config != NULL)
344        c->config = apr_pstrdup(pconf, config);
345    else
346        c->config = "";
347
348    /* Create and configure the cache instance. */
349    const char *err = c->prov->create(&c->socache, c->config, ptemp, pconf);
350    if (err != NULL)
351    {
352        return apr_psprintf(ptemp,
353                            "Creating cache '%s:%s' failed: %s",
354                            c->prov->name, c->config, err);
355    }
356    ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, server,
357                 "%s: Socache '%s:%s' created.",
358                 __func__, c->prov->name, c->config);
359
360    /* assign configured cache structure to server */
361    *cache = c;
362
363    return NULL;
364}
365
366
367
368/**
369 * This function is supposed to be called during post_config to
370 * initialize mutex and socache instance associated with an
371 * mgs_cache_t.
372 *
373 * @param cache the mod_gnutls cache structure
374 *
375 * @param cache_name name for socache initialization
376 *
377 * @param mutex_name name to pass to ap_global_mutex_create(), must
378 * have been registered during pre_config.
379 *
380 * @param server server for logging purposes
381 *
382 * @param pconf memory pool for server configuration
383 */
384static apr_status_t mgs_cache_inst_init(mgs_cache_t cache,
385                                        const char *cache_name,
386                                        const char *mutex_name,
387                                        server_rec *server,
388                                        apr_pool_t *pconf)
389{
390    apr_status_t rv = APR_SUCCESS;
391
392    if (cache->mutex == NULL)
393    {
394        rv = ap_global_mutex_create(&cache->mutex, NULL,
395                                    mutex_name,
396                                    NULL, server, pconf, 0);
397        ap_log_error(APLOG_MARK, APLOG_TRACE1, rv, server,
398                     "%s: create mutex", __func__);
399        if (rv != APR_SUCCESS)
400            return rv;
401    }
402
403    rv = cache->prov->init(cache->socache, cache_name, NULL, server, pconf);
404    if (rv != APR_SUCCESS)
405        ap_log_error(APLOG_MARK, APLOG_CRIT, rv, server,
406                     "Initializing cache '%s:%s' failed!",
407                     cache->prov->name, cache->config);
408    else
409        ap_log_error(APLOG_MARK, APLOG_DEBUG, rv, server,
410                     "%s: socache '%s:%s' initialized.", __func__,
411                     cache->prov->name, cache->config);
412    return rv;
413}
414
415
416
417static apr_status_t cleanup_socache(void *data)
418{
419    server_rec *s = data;
420    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
421        ap_get_module_config(s->module_config, &gnutls_module);
422    if (sc->cache)
423    {
424        ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, s,
425                     "Cleaning up session cache '%s:%s'",
426                     sc->cache->prov->name, sc->cache->config);
427        sc->cache->prov->destroy(sc->cache->socache, s);
428    }
429    if (sc->ocsp_cache)
430    {
431        ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, s,
432                     "Cleaning up OCSP cache '%s:%s'",
433                     sc->ocsp_cache->prov->name, sc->ocsp_cache->config);
434        sc->ocsp_cache->prov->destroy(sc->ocsp_cache->socache, s);
435    }
436    return APR_SUCCESS;
437}
438
439
440
441int mgs_cache_post_config(apr_pool_t *pconf, apr_pool_t *ptemp,
442                          server_rec *s, mgs_srvconf_rec *sc)
443{
444    apr_status_t rv = APR_SUCCESS;
445
446    /* If the OCSP cache is unconfigured initialize it with
447     * defaults. */
448    if (sc->ocsp_cache == NULL)
449    {
450        ap_log_error(APLOG_MARK, APLOG_DEBUG, rv, s,
451                     "%s: OCSP cache unconfigured, using '%s:%s'.", __func__,
452                     DEFAULT_OCSP_CACHE_TYPE, DEFAULT_OCSP_CACHE_CONF);
453        const char *err = mgs_cache_inst_config(&sc->ocsp_cache, s,
454                                                DEFAULT_OCSP_CACHE_TYPE,
455                                                DEFAULT_OCSP_CACHE_CONF,
456                                                pconf, ptemp);
457        if (err != NULL)
458            ap_log_error(APLOG_MARK, APLOG_WARNING, rv, s,
459                         "%s: Configuring default OCSP cache '%s:%s' failed, "
460                         "make sure that mod_socache_%s is loaded.", __func__,
461                         DEFAULT_OCSP_CACHE_TYPE, DEFAULT_OCSP_CACHE_CONF,
462                         DEFAULT_OCSP_CACHE_TYPE);
463    }
464
465    /* Initialize the OCSP cache first so it's not skipped if the
466     * session cache is disabled. */
467    if (sc->ocsp_cache != NULL)
468    {
469        /* TODO: Maybe initialize only if explicitly enabled OR at
470         * least one (virtual) host has OCSP enabled? */
471        rv = mgs_cache_inst_init(sc->ocsp_cache, MGS_OCSP_CACHE_NAME,
472                                 MGS_OCSP_CACHE_MUTEX_NAME, s, pconf);
473        if (rv != APR_SUCCESS)
474            return HTTP_INSUFFICIENT_STORAGE;
475    }
476
477    /* GnuTLSCache was never explicitly set or is disabled: */
478    if (sc->cache_enable == GNUTLS_ENABLED_UNSET
479        || sc->cache_enable == GNUTLS_ENABLED_FALSE)
480    {
481        sc->cache_enable = GNUTLS_ENABLED_FALSE;
482        /* Cache disabled, done. */
483        return APR_SUCCESS;
484    }
485    /* if GnuTLSCacheTimeout was never explicitly set: */
486    if (sc->cache_timeout == MGS_TIMEOUT_UNSET)
487        sc->cache_timeout = apr_time_from_sec(MGS_DEFAULT_CACHE_TIMEOUT);
488
489    rv = mgs_cache_inst_init(sc->cache, MGS_SESSION_CACHE_NAME,
490                             MGS_CACHE_MUTEX_NAME, s, pconf);
491    if (rv != APR_SUCCESS)
492        return HTTP_INSUFFICIENT_STORAGE;
493
494    apr_pool_pre_cleanup_register(pconf, s, cleanup_socache);
495
496    return APR_SUCCESS;
497}
498
499int mgs_cache_child_init(apr_pool_t *p, server_rec *server,
500                         mgs_cache_t cache, const char *mutex_name)
501{
502    /* reinit cache mutex */
503    const char *lockfile = apr_global_mutex_lockfile(cache->mutex);
504    apr_status_t rv = apr_global_mutex_child_init(&cache->mutex,
505                                                  lockfile, p);
506    if (rv != APR_SUCCESS)
507        ap_log_error(APLOG_MARK, APLOG_EMERG, rv, server,
508                     "Failed to reinit mutex '%s'", mutex_name);
509
510    return rv;
511}
512
513int mgs_cache_session_init(mgs_handle_t * ctxt)
514{
515    if (ctxt->sc->cache_enable)
516    {
517        gnutls_db_set_retrieve_function(ctxt->session,
518                                        socache_fetch_session);
519        gnutls_db_set_remove_function(ctxt->session,
520                                      socache_delete_session);
521        gnutls_db_set_store_function(ctxt->session,
522                                     socache_store_session);
523        gnutls_db_set_ptr(ctxt->session, ctxt);
524    }
525    return 0;
526}
Note: See TracBrowser for help on using the repository browser.