source: mod_gnutls/src/gnutls_cache.c @ 6bbd378

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

Remove special handling for APR memcache and leftover includes

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