source: mod_gnutls/src/gnutls_cache.c @ ded2291

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

Switch generic cache store/fetch function pointers to constant functions

Using socache takes care of the different cache types, so this layer
of abstraction is no longer needed. Add a currently unused mgs_cache_t
parameter to allow for multiple mod_gnutls caches in the future.

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