source: mod_gnutls/src/gnutls_cache.h @ ce5f776

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

Move config and post_config of a cache instance to separate functions

This prepares the infrastructure for multiple caches and simplifies
the server configuration structure.

  • Property mode set to 100644
File size: 4.9 KB
RevLine 
[14548b9]1/*
[04e6e65]2 *  Copyright 2004-2005 Paul Querna
3 *  Copyright 2014 Nikos Mavrogiannopoulos
[a85de63]4 *  Copyright 2015-2018 Fiona Klute
[04e6e65]5 *
6 *  Licensed under the Apache License, Version 2.0 (the "License");
7 *  you may not use this file except in compliance with the License.
8 *  You may obtain a copy of the License at
9 *
10 *      http://www.apache.org/licenses/LICENSE-2.0
11 *
12 *  Unless required by applicable law or agreed to in writing, software
13 *  distributed under the License is distributed on an "AS IS" BASIS,
14 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 *  See the License for the specific language governing permissions and
16 *  limitations under the License.
[14548b9]17 */
18
19/**
20 * @file
[04e6e65]21 *
[104e881]22 * Generic object cache for mod_gnutls.
[04e6e65]23 */
24
25#ifndef __MOD_GNUTLS_CACHE_H__
26#define __MOD_GNUTLS_CACHE_H__
27
28#include "mod_gnutls.h"
29#include <httpd.h>
[de1ceab]30#include <ap_socache.h>
[04e6e65]31
[14548b9]32/** Name of the mod_gnutls cache access mutex, for use with Apache's
33 * `Mutex` directive */
[c005645]34#define MGS_CACHE_MUTEX_NAME "gnutls-cache"
35
[04e6e65]36/**
[ce5f776]37 * Configure a cache instance
38 *
39 * This function is supposed to be called during config and
40 * initializes an mgs_cache_t by finding the named socache provider
41 * and creating a cache instance with the given configuration. Note
42 * that the socache instance is only created, not initialized, which
43 * is supposed to happen during post_config.
44 *
45 * @param cache pointer to the mgs_cache_t, memory will be allocated
46 * if currently NULL.
47 *
48 * @param server associated server for logging purposes
49 *
50 * @param type socache provider type
51 *
52 * @param config configuration string for the socache provider, may be
53 * `NULL` if the provider accepts an empty configuration
54 *
55 * @param pconf configuration memory pool
56 *
57 * @param ptemp temporary memory pool
58 */
59const char *mgs_cache_inst_config(mgs_cache_t *cache, server_rec *server,
60                                  const char* type, const char* config,
61                                  apr_pool_t *pconf, apr_pool_t *ptemp);
62
63/**
[14548b9]64 * Initialize the internal cache configuration structure. This
65 * function is called after the configuration file(s) have been
66 * parsed.
[104e881]67 *
[de1ceab]68 * @param pconf configuration memory pool
69 * @param ptemp temporary memory pool
[104e881]70 * @param s default server of the Apache configuration, head of the
71 * server list
72 * @param sc mod_gnutls data associated with `s`
[04e6e65]73 */
[de1ceab]74int mgs_cache_post_config(apr_pool_t *pconf, apr_pool_t *ptemp,
75                          server_rec *s, mgs_srvconf_rec *sc);
[04e6e65]76
77/**
[104e881]78 * (Re-)Initialize the cache in a child process after forking.
79 *
80 * @param p child memory pool provided by Apache
81 * @param s default server of the Apache configuration, head of the
82 * server list
83 * @param sc mod_gnutls data associated with `s`
[04e6e65]84 */
85int mgs_cache_child_init(apr_pool_t *p, server_rec *s, mgs_srvconf_rec *sc);
86
87/**
[104e881]88 * Set up caching for the given TLS session.
[14548b9]89 *
90 * @param ctxt mod_gnutls session context
[104e881]91 *
[14548b9]92 * @return 0
[04e6e65]93 */
94int mgs_cache_session_init(mgs_handle_t *ctxt);
95
96
97
98/**
[14548b9]99 * Convert a `time_t` into a null terminated string in a format
[104e881]100 * compatible with OpenSSL's `ASN1_TIME_print()`.
[0831437]101 *
[04e6e65]102 * @param t time_t time
[0831437]103 * @param str Location to store the time string
[14548b9]104 * @param strsize The maximum length that can be stored in `str`
[104e881]105 *
[14548b9]106 * @return `str`
[04e6e65]107 */
108char *mgs_time2sz(time_t t, char *str, int strsize);
109
[14548b9]110/**
[ded2291]111 * Store function for the mod_gnutls object caches.
[14548b9]112 *
[ded2291]113 * @param cache the cache to store the entry in
[14548b9]114 * @param s server associated with the cache entry
115 * @param key key for the cache entry
116 * @param data data to be cached
117 * @param expiry expiration time
[104e881]118 *
119 * @return `-1` on error, `0` on success
[6b4136c]120 */
[ded2291]121int mgs_cache_store(mgs_cache_t cache, server_rec *server, gnutls_datum_t key,
122                    gnutls_datum_t data, apr_time_t expiry);
123
[14548b9]124/**
[ded2291]125 * Fetch function for the mod_gnutls object caches.
[104e881]126 *
127 * *Warning*: The `data` element of the returned `gnutls_datum_t` is
128 * allocated using `gnutls_malloc()` for compatibility with the GnuTLS
129 * session caching API, and must be released using `gnutls_free()`.
[14548b9]130 *
[ded2291]131 * @param cache the cache to fetch from
132 *
[a85de63]133 * @param server server context for the request
134 *
[14548b9]135 * @param key key for the cache entry to be fetched
[104e881]136 *
[a85de63]137 * @param pool pool to allocate the response and other temporary
138 * memory from
139 *
[14548b9]140 * @return the requested cache entry, or `{NULL, 0}`
141 */
[ded2291]142gnutls_datum_t mgs_cache_fetch(mgs_cache_t cache, server_rec *server,
143                               gnutls_datum_t key, apr_pool_t *pool);
144
[14548b9]145/**
146 * Internal cache configuration structure
147 */
[e809fb3]148struct mgs_cache {
[de1ceab]149    /** Socache provider to use for this cache */
150    const ap_socache_provider_t *prov;
151    /** The actual socache instance */
152    ap_socache_instance_t *socache;
[a314ec9]153    /** Cache configuration string (as passed to the socache create
154     * function, for logging) */
155    const char *config;
[14548b9]156    /** Mutex for cache access (used only if the cache type is not
[aa68232]157     * thread-safe) */
158    apr_global_mutex_t *mutex;
[e809fb3]159};
[6b4136c]160
[04e6e65]161#endif /** __MOD_GNUTLS_CACHE_H__ */
Note: See TracBrowser for help on using the repository browser.