source: mod_gnutls/src/gnutls_cache.c @ 41f9bcb

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

Use cache parameter in mgs_cache_store() and mgs_cache_fetch()

The mgs_cache_store() and mgs_cache_fetch() functions now use the
provided mgs_cache_t cache to access the underlying socache.

  • Property mode set to 100644
File size: 13.8 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
114int mgs_cache_store(mgs_cache_t cache, server_rec *server,
115                    gnutls_datum_t key, gnutls_datum_t data,
116                    apr_time_t expiry)
117{
118    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
119        ap_get_module_config(server->module_config, &gnutls_module);
120
121    apr_pool_t *spool;
122    apr_pool_create(&spool, NULL);
123
124    if (cache->prov->flags & AP_SOCACHE_FLAG_NOTMPSAFE)
125        apr_global_mutex_lock(cache->mutex);
126    apr_status_t rv = cache->prov->store(cache->socache, server,
127                                         key.data, key.size,
128                                         expiry,
129                                         data.data, data.size,
130                                         spool);
131    if (cache->prov->flags & AP_SOCACHE_FLAG_NOTMPSAFE)
132        apr_global_mutex_unlock(cache->mutex);
133
134    if (rv != APR_SUCCESS)
135    {
136        // TODO: clean up sc->cache_config reference
137        ap_log_error(APLOG_MARK, APLOG_DEBUG, rv, server,
138                     "error storing in cache '%s:%s'",
139                     cache->prov->name, sc->cache_config);
140        apr_pool_destroy(spool);
141        return -1;
142    }
143
144    // TODO: clean up sc->cache_config reference
145    ap_log_error(APLOG_MARK, APLOG_TRACE1, rv, server,
146                 "stored %u bytes of data (%u byte key) in cache '%s:%s'",
147                 data.size, key.size,
148                 cache->prov->name, sc->cache_config);
149    apr_pool_destroy(spool);
150    return 0;
151}
152
153
154
155static int socache_store_session(void *baton, gnutls_datum_t key,
156                                 gnutls_datum_t data)
157{
158    mgs_handle_t *ctxt = baton;
159    gnutls_datum_t dbmkey;
160
161    if (mgs_session_id2dbm(ctxt->c, key.data, key.size, &dbmkey) < 0)
162        return -1;
163
164    apr_time_t expiry = apr_time_now() + ctxt->sc->cache_timeout;
165
166    return mgs_cache_store(ctxt->sc->cache, ctxt->c->base_server,
167                           dbmkey, data, expiry);
168}
169
170
171
172// 4K should be enough for OCSP responses and sessions alike
173#define SOCACHE_FETCH_BUF_SIZE 4096
174gnutls_datum_t mgs_cache_fetch(mgs_cache_t cache __attribute__((unused)),
175                               server_rec *server, gnutls_datum_t key,
176                               apr_pool_t *pool)
177{
178    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
179        ap_get_module_config(server->module_config, &gnutls_module);
180
181    gnutls_datum_t data = {NULL, 0};
182    data.data = gnutls_malloc(SOCACHE_FETCH_BUF_SIZE);
183    if (data.data == NULL)
184        return data;
185    data.size = SOCACHE_FETCH_BUF_SIZE;
186
187    apr_pool_t *spool;
188    apr_pool_create(&spool, pool);
189
190    if (cache->prov->flags & AP_SOCACHE_FLAG_NOTMPSAFE)
191        apr_global_mutex_lock(cache->mutex);
192    apr_status_t rv = cache->prov->retrieve(cache->socache, server,
193                                            key.data, key.size,
194                                            data.data, &data.size,
195                                            spool);
196    if (cache->prov->flags & AP_SOCACHE_FLAG_NOTMPSAFE)
197        apr_global_mutex_unlock(cache->mutex);
198
199    if (rv != APR_SUCCESS)
200    {
201        // TODO: clean up sc->cache_config references
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, sc->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, sc->cache_config);
211        /* free unused buffer */
212        gnutls_free(data.data);
213        data.data = NULL;
214        data.size = 0;
215    }
216    else
217    {
218        // TODO: clean up sc->cache_config reference
219        ap_log_error(APLOG_MARK, APLOG_TRACE1, rv, server,
220                     "fetched %u bytes from cache '%s:%s'",
221                     data.size, cache->prov->name, sc->cache_config);
222    }
223    apr_pool_destroy(spool);
224
225    return data;
226}
227
228static gnutls_datum_t socache_fetch_session(void *baton, gnutls_datum_t key)
229{
230    gnutls_datum_t data = {NULL, 0};
231    gnutls_datum_t dbmkey;
232    mgs_handle_t *ctxt = baton;
233
234    if (mgs_session_id2dbm(ctxt->c, key.data, key.size, &dbmkey) < 0)
235        return data;
236
237    return mgs_cache_fetch(ctxt->sc->cache, ctxt->c->base_server,
238                           dbmkey, ctxt->c->pool);
239}
240
241
242
243static int socache_delete(void *baton, gnutls_datum_t key)
244{
245    gnutls_datum_t tmpkey;
246    mgs_handle_t *ctxt = baton;
247
248    if (mgs_session_id2dbm(ctxt->c, key.data, key.size, &tmpkey) < 0)
249        return -1;
250
251    if (ctxt->sc->cache->prov->flags & AP_SOCACHE_FLAG_NOTMPSAFE)
252        apr_global_mutex_lock(ctxt->sc->cache->mutex);
253    apr_status_t rv = ctxt->sc->cache->prov->remove(ctxt->sc->cache->socache,
254                                                    ctxt->c->base_server,
255                                                    key.data, key.size,
256                                                    ctxt->c->pool);
257    if (ctxt->sc->cache->prov->flags & AP_SOCACHE_FLAG_NOTMPSAFE)
258        apr_global_mutex_unlock(ctxt->sc->cache->mutex);
259
260    if (rv != APR_SUCCESS) {
261        ap_log_error(APLOG_MARK, APLOG_NOTICE, rv,
262                     ctxt->c->base_server,
263                     "error deleting from cache '%s:%s'",
264                     ctxt->sc->cache->prov->name, ctxt->sc->cache_config);
265        return -1;
266    }
267    return 0;
268}
269
270
271
272static apr_status_t cleanup_socache(void *data)
273{
274    server_rec *s = data;
275    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
276        ap_get_module_config(s->module_config, &gnutls_module);
277    ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, s,
278                 "Cleaning up socache '%s:%s'",
279                 sc->cache->prov->name, sc->cache_config);
280    sc->cache->prov->destroy(sc->cache->socache, s);
281    return APR_SUCCESS;
282}
283
284
285
286int mgs_cache_post_config(apr_pool_t *pconf, apr_pool_t *ptemp,
287                          server_rec *s, mgs_srvconf_rec *sc)
288{
289    apr_status_t rv = APR_SUCCESS;
290    /* if GnuTLSCache was never explicitly set: */
291    if (sc->cache_type == mgs_cache_unset || sc->cache_type == mgs_cache_none)
292    {
293        sc->cache_type = mgs_cache_none;
294        /* Cache disabled, done. */
295        return APR_SUCCESS;
296    }
297    /* if GnuTLSCacheTimeout was never explicitly set: */
298    if (sc->cache_timeout == MGS_TIMEOUT_UNSET)
299        sc->cache_timeout = apr_time_from_sec(MGS_DEFAULT_CACHE_TIMEOUT);
300
301    /* initialize mutex only once */
302    if (sc->cache == NULL)
303    {
304        sc->cache = apr_palloc(pconf, sizeof(struct mgs_cache));
305        rv = ap_global_mutex_create(&sc->cache->mutex, NULL,
306                                    MGS_CACHE_MUTEX_NAME,
307                                    NULL, s, pconf, 0);
308        if (rv != APR_SUCCESS)
309            return rv;
310    }
311
312    char *pname = NULL;
313
314    if (sc->cache_type == mgs_cache_dbm || sc->cache_type == mgs_cache_gdbm)
315        pname = "dbm";
316    else if (sc->cache_type == mgs_cache_memcache)
317        pname = "memcache";
318    else if (sc->cache_type == mgs_cache_shmcb)
319        pname = "shmcb";
320
321    /* Find the right socache provider */
322    sc->cache->prov = ap_lookup_provider(AP_SOCACHE_PROVIDER_GROUP,
323                                         pname,
324                                         AP_SOCACHE_PROVIDER_VERSION);
325    if (sc->cache->prov)
326    {
327        /* Cache found; create it, passing anything beyond the colon. */
328        const char *err = sc->cache->prov->create(&sc->cache->socache,
329                                                  sc->cache_config,
330                                                  ptemp, pconf);
331        if (err != NULL)
332        {
333            ap_log_error(APLOG_MARK, APLOG_EMERG, APR_EGENERAL, s,
334                         "Creating cache '%s:%s' failed: %s",
335                         pname, sc->cache_config, err);
336            return HTTP_INSUFFICIENT_STORAGE;
337        }
338        ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, s,
339                     "%s: Socache '%s' created.", __func__, pname);
340
341        // TODO: provide hints
342        rv = sc->cache->prov->init(sc->cache->socache,
343                                   "mod_gnutls-session", NULL, s, pconf);
344        if (rv != APR_SUCCESS)
345        {
346            ap_log_error(APLOG_MARK, APLOG_EMERG, rv, s,
347                         "Initializing cache '%s:%s' failed!",
348                         pname, sc->cache_config);
349            return HTTP_INSUFFICIENT_STORAGE;
350        }
351        ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, s,
352                     "%s: socache '%s:%s' created.", __func__,
353                     pname, sc->cache_config);
354    }
355    else
356    {
357        ap_log_error(APLOG_MARK, APLOG_EMERG, APR_EGENERAL, s,
358                     "Could not find socache provider '%s', please make sure "
359                     "that the provider name is valid and the "
360                     "appropriate mod_socache submodule is loaded.", pname);
361        return HTTP_NOT_FOUND;
362    }
363
364    apr_pool_pre_cleanup_register(pconf, s, cleanup_socache);
365
366    return APR_SUCCESS;
367}
368
369int mgs_cache_child_init(apr_pool_t * p,
370                         server_rec * s,
371                         mgs_srvconf_rec * sc)
372{
373    /* reinit cache mutex */
374    const char *lockfile = apr_global_mutex_lockfile(sc->cache->mutex);
375    apr_status_t rv = apr_global_mutex_child_init(&sc->cache->mutex,
376                                                  lockfile, p);
377    if (rv != APR_SUCCESS)
378        ap_log_error(APLOG_MARK, APLOG_EMERG, rv, s,
379                     "Failed to reinit mutex '%s'", MGS_CACHE_MUTEX_NAME);
380
381    return 0;
382}
383
384#include <assert.h>
385
386int mgs_cache_session_init(mgs_handle_t * ctxt)
387{
388    if (ctxt->sc->cache_type != mgs_cache_none)
389    {
390        gnutls_db_set_retrieve_function(ctxt->session,
391                                        socache_fetch_session);
392        gnutls_db_set_remove_function(ctxt->session,
393                                      socache_delete);
394        gnutls_db_set_store_function(ctxt->session,
395                                     socache_store_session);
396        gnutls_db_set_ptr(ctxt->session, ctxt);
397    }
398    return 0;
399}
Note: See TracBrowser for help on using the repository browser.