source: mod_gnutls/src/gnutls_cache.c @ 78d75ac

debian/master
Last change on this file since 78d75ac was 78d75ac, checked in by Fiona Klute <fiona.klute@…>, 18 months ago

Use the right cache config string in cache trace logs

  • Property mode set to 100644
File size: 17.3 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    apr_pool_t *spool;
112    apr_pool_create(&spool, NULL);
113
114    if (cache->prov->flags & AP_SOCACHE_FLAG_NOTMPSAFE)
115        apr_global_mutex_lock(cache->mutex);
116    apr_status_t rv = cache->prov->store(cache->socache, server,
117                                         key.data, key.size,
118                                         expiry,
119                                         data.data, data.size,
120                                         spool);
121    if (cache->prov->flags & AP_SOCACHE_FLAG_NOTMPSAFE)
122        apr_global_mutex_unlock(cache->mutex);
123
124    if (rv != APR_SUCCESS)
125    {
126        ap_log_error(APLOG_MARK, APLOG_DEBUG, rv, server,
127                     "error storing in cache '%s:%s'",
128                     cache->prov->name, cache->config);
129        apr_pool_destroy(spool);
130        return -1;
131    }
132
133    ap_log_error(APLOG_MARK, APLOG_TRACE1, rv, server,
134                 "stored %u bytes of data (%u byte key) in cache '%s:%s'",
135                 data.size, key.size,
136                 cache->prov->name, cache->config);
137    apr_pool_destroy(spool);
138    return 0;
139}
140
141
142
143/**
144 * Store function for the GnuTLS session cache, see
145 * gnutls_db_set_store_function().
146 *
147 * @param baton mgs_handle_t for the connection, as set via
148 * gnutls_db_set_ptr()
149 *
150 * @param key object key to store
151 *
152 * @param data the object to store
153 *
154 * @return `0` in case of success, `-1` in case of failure
155 */
156static int socache_store_session(void *baton, gnutls_datum_t key,
157                                 gnutls_datum_t data)
158{
159    mgs_handle_t *ctxt = baton;
160    gnutls_datum_t dbmkey;
161
162    if (mgs_session_id2dbm(ctxt->c, key.data, key.size, &dbmkey) < 0)
163        return -1;
164
165    apr_time_t expiry = apr_time_now() + ctxt->sc->cache_timeout;
166
167    return mgs_cache_store(ctxt->sc->cache, ctxt->c->base_server,
168                           dbmkey, data, expiry);
169}
170
171
172
173/** 8K is the maximum size accepted when receiving OCSP responses,
174 * sessions cache entries should be much smaller. The buffer is
175 * reallocated to actual size after fetching, so memory waste is
176 * minimal and temporary. */
177#define SOCACHE_FETCH_BUF_SIZE (8 * 1024)
178
179gnutls_datum_t mgs_cache_fetch(mgs_cache_t cache, server_rec *server,
180                               gnutls_datum_t key, apr_pool_t *pool)
181{
182    gnutls_datum_t data = {NULL, 0};
183    data.data = gnutls_malloc(SOCACHE_FETCH_BUF_SIZE);
184    if (data.data == NULL)
185        return data;
186    data.size = SOCACHE_FETCH_BUF_SIZE;
187
188    apr_pool_t *spool;
189    apr_pool_create(&spool, pool);
190
191    if (cache->prov->flags & AP_SOCACHE_FLAG_NOTMPSAFE)
192        apr_global_mutex_lock(cache->mutex);
193    apr_status_t rv = cache->prov->retrieve(cache->socache, server,
194                                            key.data, key.size,
195                                            data.data, &data.size,
196                                            spool);
197    if (cache->prov->flags & AP_SOCACHE_FLAG_NOTMPSAFE)
198        apr_global_mutex_unlock(cache->mutex);
199
200    if (rv != APR_SUCCESS)
201    {
202        /* APR_NOTFOUND means there's no such object. */
203        if (rv == APR_NOTFOUND)
204            ap_log_error(APLOG_MARK, APLOG_TRACE1, rv, server,
205                         "requested entry not found in cache '%s:%s'.",
206                         cache->prov->name, cache->config);
207        else
208            ap_log_error(APLOG_MARK, APLOG_WARNING, rv, server,
209                         "error fetching from cache '%s:%s'",
210                         cache->prov->name, cache->config);
211        /* free unused buffer */
212        gnutls_free(data.data);
213        data.data = NULL;
214        data.size = 0;
215    }
216    else
217    {
218        ap_log_error(APLOG_MARK, APLOG_TRACE1, rv, server,
219                     "fetched %u bytes from cache '%s:%s'",
220                     data.size, cache->prov->name, cache->config);
221
222        /* Realloc buffer to data.size. Data size must be less than or
223         * equal to the initial buffer size, so this REALLY should not
224         * fail. */
225        data.data = gnutls_realloc(data.data, data.size);
226        if (__builtin_expect(data.data == NULL, 0))
227        {
228            ap_log_error(APLOG_MARK, APLOG_CRIT, APR_ENOMEM, server,
229                         "%s: Could not realloc fetch buffer to data size!",
230                         __func__);
231            data.size = 0;
232        }
233    }
234    apr_pool_destroy(spool);
235
236    return data;
237}
238
239
240
241/**
242 * Fetch function for the GnuTLS session cache, see
243 * gnutls_db_set_retrieve_function().
244 *
245 * *Warning*: The `data` element of the returned `gnutls_datum_t` is
246 * allocated using `gnutls_malloc()` for compatibility with the GnuTLS
247 * session caching API, and must be released using `gnutls_free()`.
248 *
249 * @param baton mgs_handle_t for the connection, as set via
250 * gnutls_db_set_ptr()
251 *
252 * @param key object key to fetch
253 *
254 * @return the requested cache entry, or `{NULL, 0}`
255 */
256static gnutls_datum_t socache_fetch_session(void *baton, gnutls_datum_t key)
257{
258    gnutls_datum_t data = {NULL, 0};
259    gnutls_datum_t dbmkey;
260    mgs_handle_t *ctxt = baton;
261
262    if (mgs_session_id2dbm(ctxt->c, key.data, key.size, &dbmkey) < 0)
263        return data;
264
265    return mgs_cache_fetch(ctxt->sc->cache, ctxt->c->base_server,
266                           dbmkey, ctxt->c->pool);
267}
268
269
270
271/**
272 * Remove function for the GnuTLS session cache, see
273 * gnutls_db_set_remove_function().
274 *
275 * @param baton mgs_handle_t for the connection, as set via
276 * gnutls_db_set_ptr()
277 *
278 * @param key object key to remove
279 *
280 * @return `0` in case of success, `-1` in case of failure
281 */
282static int socache_delete_session(void *baton, gnutls_datum_t key)
283{
284    gnutls_datum_t tmpkey;
285    mgs_handle_t *ctxt = baton;
286
287    if (mgs_session_id2dbm(ctxt->c, key.data, key.size, &tmpkey) < 0)
288        return -1;
289
290    if (ctxt->sc->cache->prov->flags & AP_SOCACHE_FLAG_NOTMPSAFE)
291        apr_global_mutex_lock(ctxt->sc->cache->mutex);
292    apr_status_t rv = ctxt->sc->cache->prov->remove(ctxt->sc->cache->socache,
293                                                    ctxt->c->base_server,
294                                                    key.data, key.size,
295                                                    ctxt->c->pool);
296    if (ctxt->sc->cache->prov->flags & AP_SOCACHE_FLAG_NOTMPSAFE)
297        apr_global_mutex_unlock(ctxt->sc->cache->mutex);
298
299    if (rv != APR_SUCCESS) {
300        ap_log_error(APLOG_MARK, APLOG_NOTICE, rv,
301                     ctxt->c->base_server,
302                     "error deleting from cache '%s:%s'",
303                     ctxt->sc->cache->prov->name, ctxt->sc->cache->config);
304        return -1;
305    }
306    return 0;
307}
308
309
310
311const char *mgs_cache_inst_config(mgs_cache_t *cache, server_rec *server,
312                                  const char* type, const char* config,
313                                  apr_pool_t *pconf, apr_pool_t *ptemp)
314{
315    /* Allocate cache structure, will be assigned to *cache after
316     * successful configuration. */
317    mgs_cache_t c = apr_pcalloc(pconf, sizeof(struct mgs_cache));
318    if (c == NULL)
319        return "Could not allocate memory for cache configuration!";
320
321    /* Find the right socache provider */
322    c->prov = ap_lookup_provider(AP_SOCACHE_PROVIDER_GROUP,
323                                 type,
324                                 AP_SOCACHE_PROVIDER_VERSION);
325    if (c->prov == NULL)
326    {
327        return apr_psprintf(ptemp,
328                            "Could not find socache provider '%s', please "
329                            "make sure that the provider name is valid and "
330                            "the appropriate module is loaded (maybe "
331                            "mod_socache_%s.so?).",
332                            type, type);
333    }
334
335    /* shmcb works fine with NULL, but make sure there's a valid (if
336     * empty) string for logging */
337    if (config != NULL)
338        c->config = apr_pstrdup(pconf, config);
339    else
340        c->config = "";
341
342    /* Create and configure the cache instance. */
343    const char *err = c->prov->create(&c->socache, c->config, ptemp, pconf);
344    if (err != NULL)
345    {
346        return apr_psprintf(ptemp,
347                            "Creating cache '%s:%s' failed: %s",
348                            c->prov->name, c->config, err);
349    }
350    ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, server,
351                 "%s: Socache '%s:%s' created.",
352                 __func__, c->prov->name, c->config);
353
354    /* assign configured cache structure to server */
355    *cache = c;
356
357    return NULL;
358}
359
360
361
362/**
363 * This function is supposed to be called during post_config to
364 * initialize mutex and socache instance associated with an
365 * mgs_cache_t.
366 *
367 * @param cache the mod_gnutls cache structure
368 *
369 * @param cache_name name for socache initialization
370 *
371 * @param mutex_name name to pass to ap_global_mutex_create(), must
372 * have been registered during pre_config.
373 *
374 * @param server server for logging purposes
375 *
376 * @param pconf memory pool for server configuration
377 */
378static apr_status_t mgs_cache_inst_init(mgs_cache_t cache,
379                                        const char *cache_name,
380                                        const char *mutex_name,
381                                        server_rec *server,
382                                        apr_pool_t *pconf)
383{
384    apr_status_t rv = APR_SUCCESS;
385
386    if (cache->mutex == NULL)
387    {
388        rv = ap_global_mutex_create(&cache->mutex, NULL,
389                                    mutex_name,
390                                    NULL, server, pconf, 0);
391        ap_log_error(APLOG_MARK, APLOG_TRACE1, rv, server,
392                     "%s: create mutex", __func__);
393        if (rv != APR_SUCCESS)
394            return rv;
395    }
396
397    rv = cache->prov->init(cache->socache, cache_name, NULL, server, pconf);
398    if (rv != APR_SUCCESS)
399        ap_log_error(APLOG_MARK, APLOG_CRIT, rv, server,
400                     "Initializing cache '%s:%s' failed!",
401                     cache->prov->name, cache->config);
402    else
403        ap_log_error(APLOG_MARK, APLOG_DEBUG, rv, server,
404                     "%s: socache '%s:%s' initialized.", __func__,
405                     cache->prov->name, cache->config);
406    return rv;
407}
408
409
410
411static apr_status_t cleanup_socache(void *data)
412{
413    server_rec *s = data;
414    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
415        ap_get_module_config(s->module_config, &gnutls_module);
416    if (sc->cache)
417    {
418        ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, s,
419                     "Cleaning up session cache '%s:%s'",
420                     sc->cache->prov->name, sc->cache->config);
421        sc->cache->prov->destroy(sc->cache->socache, s);
422    }
423    if (sc->ocsp_cache)
424    {
425        ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, s,
426                     "Cleaning up OCSP cache '%s:%s'",
427                     sc->ocsp_cache->prov->name, sc->ocsp_cache->config);
428        sc->ocsp_cache->prov->destroy(sc->ocsp_cache->socache, s);
429    }
430    return APR_SUCCESS;
431}
432
433
434
435int mgs_cache_post_config(apr_pool_t *pconf, apr_pool_t *ptemp,
436                          server_rec *s, mgs_srvconf_rec *sc)
437{
438    apr_status_t rv = APR_SUCCESS;
439
440    /* If the OCSP cache is unconfigured initialize it with
441     * defaults. */
442    if (sc->ocsp_cache == NULL)
443    {
444        ap_log_error(APLOG_MARK, APLOG_DEBUG, rv, s,
445                     "%s: OCSP cache unconfigured, using '%s:%s'.", __func__,
446                     DEFAULT_OCSP_CACHE_TYPE, DEFAULT_OCSP_CACHE_CONF);
447        const char *err = mgs_cache_inst_config(&sc->ocsp_cache, s,
448                                                DEFAULT_OCSP_CACHE_TYPE,
449                                                DEFAULT_OCSP_CACHE_CONF,
450                                                pconf, ptemp);
451        if (err != NULL)
452            ap_log_error(APLOG_MARK, APLOG_WARNING, rv, s,
453                         "%s: Configuring default OCSP cache '%s:%s' failed, "
454                         "make sure that mod_socache_%s is loaded.", __func__,
455                         DEFAULT_OCSP_CACHE_TYPE, DEFAULT_OCSP_CACHE_CONF,
456                         DEFAULT_OCSP_CACHE_TYPE);
457    }
458
459    /* Initialize the OCSP cache first so it's not skipped if the
460     * session cache is disabled. */
461    if (sc->ocsp_cache != NULL)
462    {
463        /* TODO: Maybe initialize only if explicitly enabled OR at
464         * least one (virtual) host has OCSP enabled? */
465        rv = mgs_cache_inst_init(sc->ocsp_cache, MGS_OCSP_CACHE_NAME,
466                                 MGS_OCSP_CACHE_MUTEX_NAME, s, pconf);
467        if (rv != APR_SUCCESS)
468            return HTTP_INSUFFICIENT_STORAGE;
469    }
470
471    /* GnuTLSCache was never explicitly set or is disabled: */
472    if (sc->cache_enable == GNUTLS_ENABLED_UNSET
473        || sc->cache_enable == GNUTLS_ENABLED_FALSE)
474    {
475        sc->cache_enable = GNUTLS_ENABLED_FALSE;
476        /* Cache disabled, done. */
477        return APR_SUCCESS;
478    }
479    /* if GnuTLSCacheTimeout was never explicitly set: */
480    if (sc->cache_timeout == MGS_TIMEOUT_UNSET)
481        sc->cache_timeout = apr_time_from_sec(MGS_DEFAULT_CACHE_TIMEOUT);
482
483    rv = mgs_cache_inst_init(sc->cache, MGS_SESSION_CACHE_NAME,
484                             MGS_CACHE_MUTEX_NAME, s, pconf);
485    if (rv != APR_SUCCESS)
486        return HTTP_INSUFFICIENT_STORAGE;
487
488    apr_pool_pre_cleanup_register(pconf, s, cleanup_socache);
489
490    return APR_SUCCESS;
491}
492
493int mgs_cache_child_init(apr_pool_t *p, server_rec *server,
494                         mgs_cache_t cache, const char *mutex_name)
495{
496    /* reinit cache mutex */
497    const char *lockfile = apr_global_mutex_lockfile(cache->mutex);
498    apr_status_t rv = apr_global_mutex_child_init(&cache->mutex,
499                                                  lockfile, p);
500    if (rv != APR_SUCCESS)
501        ap_log_error(APLOG_MARK, APLOG_EMERG, rv, server,
502                     "Failed to reinit mutex '%s'", mutex_name);
503
504    return rv;
505}
506
507int mgs_cache_session_init(mgs_handle_t * ctxt)
508{
509    if (ctxt->sc->cache_enable)
510    {
511        gnutls_db_set_retrieve_function(ctxt->session,
512                                        socache_fetch_session);
513        gnutls_db_set_remove_function(ctxt->session,
514                                      socache_delete_session);
515        gnutls_db_set_store_function(ctxt->session,
516                                     socache_store_session);
517        gnutls_db_set_ptr(ctxt->session, ctxt);
518    }
519    return 0;
520}
Note: See TracBrowser for help on using the repository browser.