source: mod_gnutls/src/gnutls_cache.c @ adf36c3

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

Update documentation in gnutls_cache.c

  • Property mode set to 100644
File size: 13.9 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
34#include <ap_socache.h>
35#include <apr_escape.h>
36#include <util_mutex.h>
37
38/** Default session cache timeout */
39#define MGS_DEFAULT_CACHE_TIMEOUT 300
40
41/** Maximum length of the hex string representation of a GnuTLS
42 * session ID: two characters per byte, plus one more for `\0` */
43#if GNUTLS_VERSION_NUMBER >= 0x030400
44#define GNUTLS_SESSION_ID_STRING_LEN ((GNUTLS_MAX_SESSION_ID_SIZE * 2) + 1)
45#else
46#define GNUTLS_SESSION_ID_STRING_LEN ((GNUTLS_MAX_SESSION_ID * 2) + 1)
47#endif
48
49#ifdef APLOG_USE_MODULE
50APLOG_USE_MODULE(gnutls);
51#endif
52
53/**
54 * Turn a GnuTLS session ID into the key format we use for
55 * caches. Name the Session ID as `server:port.SessionID` to disallow
56 * resuming sessions on different servers.
57 *
58 * @return `0` on success, `-1` on failure
59 */
60static int mgs_session_id2dbm(conn_rec *c, unsigned char *id, int idlen,
61                              gnutls_datum_t *dbmkey)
62{
63    char sz[GNUTLS_SESSION_ID_STRING_LEN];
64    apr_status_t rv = apr_escape_hex(sz, id, idlen, 0, NULL);
65    if (rv != APR_SUCCESS)
66        return -1;
67
68    char *newkey = apr_psprintf(c->pool, "%s:%d.%s",
69                                c->base_server->server_hostname,
70                                c->base_server->port, sz);
71    dbmkey->size = strlen(newkey);
72    /* signedness does not matter for arbitrary bits */
73    dbmkey->data = (unsigned char*) newkey;
74    return 0;
75}
76
77/** The OPENSSL_TIME_FORMAT macro and mgs_time2sz() serve to print
78 * time in a format compatible with OpenSSL's `ASN1_TIME_print()`
79 * function. */
80#define OPENSSL_TIME_FORMAT "%b %d %k:%M:%S %Y %Z"
81
82char *mgs_time2sz(time_t in_time, char *str, int strsize)
83{
84    apr_time_exp_t vtm;
85    apr_size_t ret_size;
86    apr_time_t t;
87
88
89    apr_time_ansi_put(&t, in_time);
90    apr_time_exp_gmt(&vtm, t);
91    apr_strftime(str, &ret_size, strsize - 1, OPENSSL_TIME_FORMAT, &vtm);
92
93    return str;
94}
95
96
97
98int mgs_cache_store(mgs_cache_t cache, server_rec *server,
99                    gnutls_datum_t key, gnutls_datum_t data,
100                    apr_time_t expiry)
101{
102    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
103        ap_get_module_config(server->module_config, &gnutls_module);
104
105    apr_pool_t *spool;
106    apr_pool_create(&spool, NULL);
107
108    if (cache->prov->flags & AP_SOCACHE_FLAG_NOTMPSAFE)
109        apr_global_mutex_lock(cache->mutex);
110    apr_status_t rv = cache->prov->store(cache->socache, server,
111                                         key.data, key.size,
112                                         expiry,
113                                         data.data, data.size,
114                                         spool);
115    if (cache->prov->flags & AP_SOCACHE_FLAG_NOTMPSAFE)
116        apr_global_mutex_unlock(cache->mutex);
117
118    if (rv != APR_SUCCESS)
119    {
120        // TODO: clean up sc->cache_config reference
121        ap_log_error(APLOG_MARK, APLOG_DEBUG, rv, server,
122                     "error storing in cache '%s:%s'",
123                     cache->prov->name, sc->cache_config);
124        apr_pool_destroy(spool);
125        return -1;
126    }
127
128    // TODO: clean up sc->cache_config reference
129    ap_log_error(APLOG_MARK, APLOG_TRACE1, rv, server,
130                 "stored %u bytes of data (%u byte key) in cache '%s:%s'",
131                 data.size, key.size,
132                 cache->prov->name, sc->cache_config);
133    apr_pool_destroy(spool);
134    return 0;
135}
136
137
138
139/**
140 * Store function for the GnuTLS session cache, see
141 * gnutls_db_set_store_function().
142 *
143 * @param baton mgs_handle_t for the connection, as set via
144 * gnutls_db_set_ptr()
145 *
146 * @param key object key to store
147 *
148 * @param data the object to store
149 *
150 * @return `0` in case of success, `-1` in case of failure
151 */
152static int socache_store_session(void *baton, gnutls_datum_t key,
153                                 gnutls_datum_t data)
154{
155    mgs_handle_t *ctxt = baton;
156    gnutls_datum_t dbmkey;
157
158    if (mgs_session_id2dbm(ctxt->c, key.data, key.size, &dbmkey) < 0)
159        return -1;
160
161    apr_time_t expiry = apr_time_now() + ctxt->sc->cache_timeout;
162
163    return mgs_cache_store(ctxt->sc->cache, ctxt->c->base_server,
164                           dbmkey, data, expiry);
165}
166
167
168
169// 4K should be enough for OCSP responses and sessions alike
170#define SOCACHE_FETCH_BUF_SIZE 4096
171gnutls_datum_t mgs_cache_fetch(mgs_cache_t cache __attribute__((unused)),
172                               server_rec *server, gnutls_datum_t key,
173                               apr_pool_t *pool)
174{
175    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
176        ap_get_module_config(server->module_config, &gnutls_module);
177
178    gnutls_datum_t data = {NULL, 0};
179    data.data = gnutls_malloc(SOCACHE_FETCH_BUF_SIZE);
180    if (data.data == NULL)
181        return data;
182    data.size = SOCACHE_FETCH_BUF_SIZE;
183
184    apr_pool_t *spool;
185    apr_pool_create(&spool, pool);
186
187    if (cache->prov->flags & AP_SOCACHE_FLAG_NOTMPSAFE)
188        apr_global_mutex_lock(cache->mutex);
189    apr_status_t rv = cache->prov->retrieve(cache->socache, server,
190                                            key.data, key.size,
191                                            data.data, &data.size,
192                                            spool);
193    if (cache->prov->flags & AP_SOCACHE_FLAG_NOTMPSAFE)
194        apr_global_mutex_unlock(cache->mutex);
195
196    if (rv != APR_SUCCESS)
197    {
198        // TODO: clean up sc->cache_config references
199        /* APR_NOTFOUND means there's no such object. */
200        if (rv == APR_NOTFOUND)
201            ap_log_error(APLOG_MARK, APLOG_TRACE1, rv, server,
202                         "requested entry not found in cache '%s:%s'.",
203                         cache->prov->name, sc->cache_config);
204        else
205            ap_log_error(APLOG_MARK, APLOG_WARNING, rv, server,
206                         "error fetching from cache '%s:%s'",
207                         cache->prov->name, sc->cache_config);
208        /* free unused buffer */
209        gnutls_free(data.data);
210        data.data = NULL;
211        data.size = 0;
212    }
213    else
214    {
215        // TODO: clean up sc->cache_config reference
216        ap_log_error(APLOG_MARK, APLOG_TRACE1, rv, server,
217                     "fetched %u bytes from cache '%s:%s'",
218                     data.size, cache->prov->name, sc->cache_config);
219    }
220    apr_pool_destroy(spool);
221
222    return data;
223}
224
225
226
227/**
228 * Fetch function for the GnuTLS session cache, see
229 * gnutls_db_set_retrieve_function().
230 *
231 * *Warning*: The `data` element of the returned `gnutls_datum_t` is
232 * allocated using `gnutls_malloc()` for compatibility with the GnuTLS
233 * session caching API, and must be released using `gnutls_free()`.
234 *
235 * @param baton mgs_handle_t for the connection, as set via
236 * gnutls_db_set_ptr()
237 *
238 * @param key object key to fetch
239 *
240 * @return the requested cache entry, or `{NULL, 0}`
241 */
242static gnutls_datum_t socache_fetch_session(void *baton, gnutls_datum_t key)
243{
244    gnutls_datum_t data = {NULL, 0};
245    gnutls_datum_t dbmkey;
246    mgs_handle_t *ctxt = baton;
247
248    if (mgs_session_id2dbm(ctxt->c, key.data, key.size, &dbmkey) < 0)
249        return data;
250
251    return mgs_cache_fetch(ctxt->sc->cache, ctxt->c->base_server,
252                           dbmkey, ctxt->c->pool);
253}
254
255
256
257/**
258 * Remove function for the GnuTLS session cache, see
259 * gnutls_db_set_remove_function().
260 *
261 * @param baton mgs_handle_t for the connection, as set via
262 * gnutls_db_set_ptr()
263 *
264 * @param key object key to remove
265 *
266 * @return `0` in case of success, `-1` in case of failure
267 */
268static int socache_delete_session(void *baton, gnutls_datum_t key)
269{
270    gnutls_datum_t tmpkey;
271    mgs_handle_t *ctxt = baton;
272
273    if (mgs_session_id2dbm(ctxt->c, key.data, key.size, &tmpkey) < 0)
274        return -1;
275
276    if (ctxt->sc->cache->prov->flags & AP_SOCACHE_FLAG_NOTMPSAFE)
277        apr_global_mutex_lock(ctxt->sc->cache->mutex);
278    apr_status_t rv = ctxt->sc->cache->prov->remove(ctxt->sc->cache->socache,
279                                                    ctxt->c->base_server,
280                                                    key.data, key.size,
281                                                    ctxt->c->pool);
282    if (ctxt->sc->cache->prov->flags & AP_SOCACHE_FLAG_NOTMPSAFE)
283        apr_global_mutex_unlock(ctxt->sc->cache->mutex);
284
285    if (rv != APR_SUCCESS) {
286        ap_log_error(APLOG_MARK, APLOG_NOTICE, rv,
287                     ctxt->c->base_server,
288                     "error deleting from cache '%s:%s'",
289                     ctxt->sc->cache->prov->name, ctxt->sc->cache_config);
290        return -1;
291    }
292    return 0;
293}
294
295
296
297static apr_status_t cleanup_socache(void *data)
298{
299    server_rec *s = data;
300    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
301        ap_get_module_config(s->module_config, &gnutls_module);
302    ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, s,
303                 "Cleaning up socache '%s:%s'",
304                 sc->cache->prov->name, sc->cache_config);
305    sc->cache->prov->destroy(sc->cache->socache, s);
306    return APR_SUCCESS;
307}
308
309
310
311int mgs_cache_post_config(apr_pool_t *pconf, apr_pool_t *ptemp,
312                          server_rec *s, mgs_srvconf_rec *sc)
313{
314    apr_status_t rv = APR_SUCCESS;
315    /* if GnuTLSCache was never explicitly set: */
316    if (sc->cache_type == mgs_cache_unset || sc->cache_type == mgs_cache_none)
317    {
318        sc->cache_type = mgs_cache_none;
319        /* Cache disabled, done. */
320        return APR_SUCCESS;
321    }
322    /* if GnuTLSCacheTimeout was never explicitly set: */
323    if (sc->cache_timeout == MGS_TIMEOUT_UNSET)
324        sc->cache_timeout = apr_time_from_sec(MGS_DEFAULT_CACHE_TIMEOUT);
325
326    /* initialize mutex only once */
327    if (sc->cache == NULL)
328    {
329        sc->cache = apr_palloc(pconf, sizeof(struct mgs_cache));
330        rv = ap_global_mutex_create(&sc->cache->mutex, NULL,
331                                    MGS_CACHE_MUTEX_NAME,
332                                    NULL, s, pconf, 0);
333        if (rv != APR_SUCCESS)
334            return rv;
335    }
336
337    char *pname = NULL;
338
339    if (sc->cache_type == mgs_cache_dbm || sc->cache_type == mgs_cache_gdbm)
340        pname = "dbm";
341    else if (sc->cache_type == mgs_cache_memcache)
342        pname = "memcache";
343    else if (sc->cache_type == mgs_cache_shmcb)
344        pname = "shmcb";
345
346    /* Find the right socache provider */
347    sc->cache->prov = ap_lookup_provider(AP_SOCACHE_PROVIDER_GROUP,
348                                         pname,
349                                         AP_SOCACHE_PROVIDER_VERSION);
350    if (sc->cache->prov)
351    {
352        /* Cache found; create it, passing anything beyond the colon. */
353        const char *err = sc->cache->prov->create(&sc->cache->socache,
354                                                  sc->cache_config,
355                                                  ptemp, pconf);
356        if (err != NULL)
357        {
358            ap_log_error(APLOG_MARK, APLOG_EMERG, APR_EGENERAL, s,
359                         "Creating cache '%s:%s' failed: %s",
360                         pname, sc->cache_config, err);
361            return HTTP_INSUFFICIENT_STORAGE;
362        }
363        ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, s,
364                     "%s: Socache '%s' created.", __func__, pname);
365
366        // TODO: provide hints
367        rv = sc->cache->prov->init(sc->cache->socache,
368                                   "mod_gnutls-session", NULL, s, pconf);
369        if (rv != APR_SUCCESS)
370        {
371            ap_log_error(APLOG_MARK, APLOG_EMERG, rv, s,
372                         "Initializing cache '%s:%s' failed!",
373                         pname, sc->cache_config);
374            return HTTP_INSUFFICIENT_STORAGE;
375        }
376        ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, s,
377                     "%s: socache '%s:%s' created.", __func__,
378                     pname, sc->cache_config);
379    }
380    else
381    {
382        ap_log_error(APLOG_MARK, APLOG_EMERG, APR_EGENERAL, s,
383                     "Could not find socache provider '%s', please make sure "
384                     "that the provider name is valid and the "
385                     "appropriate mod_socache submodule is loaded.", pname);
386        return HTTP_NOT_FOUND;
387    }
388
389    apr_pool_pre_cleanup_register(pconf, s, cleanup_socache);
390
391    return APR_SUCCESS;
392}
393
394int mgs_cache_child_init(apr_pool_t * p,
395                         server_rec * s,
396                         mgs_srvconf_rec * sc)
397{
398    /* reinit cache mutex */
399    const char *lockfile = apr_global_mutex_lockfile(sc->cache->mutex);
400    apr_status_t rv = apr_global_mutex_child_init(&sc->cache->mutex,
401                                                  lockfile, p);
402    if (rv != APR_SUCCESS)
403        ap_log_error(APLOG_MARK, APLOG_EMERG, rv, s,
404                     "Failed to reinit mutex '%s'", MGS_CACHE_MUTEX_NAME);
405
406    return 0;
407}
408
409int mgs_cache_session_init(mgs_handle_t * ctxt)
410{
411    if (ctxt->sc->cache_type != mgs_cache_none)
412    {
413        gnutls_db_set_retrieve_function(ctxt->session,
414                                        socache_fetch_session);
415        gnutls_db_set_remove_function(ctxt->session,
416                                      socache_delete_session);
417        gnutls_db_set_store_function(ctxt->session,
418                                     socache_store_session);
419        gnutls_db_set_ptr(ctxt->session, ctxt);
420    }
421    return 0;
422}
Note: See TracBrowser for help on using the repository browser.