source: mod_gnutls/src/gnutls_ocsp.h @ cf6f974

proxy-ticket
Last change on this file since cf6f974 was cf6f974, checked in by Fiona Klute <fiona.klute@…>, 11 months ago

mgs_get_ocsp_response: Accept request information from cert_retrieve_fn

With this the certificate retrieve function could request multiple
responses for stapling if it had the request information.

  • Property mode set to 100644
File size: 4.7 KB
Line 
1/*
2 *  Copyright 2016-2020 Fiona Klute
3 *
4 *  Licensed under the Apache License, Version 2.0 (the "License");
5 *  you may not use this file except in compliance with the License.
6 *  You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 *  Unless required by applicable law or agreed to in writing, software
11 *  distributed under the License is distributed on an "AS IS" BASIS,
12 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 *  See the License for the specific language governing permissions and
14 *  limitations under the License.
15 */
16
17#ifndef __MOD_GNUTLS_OCSP_H__
18#define __MOD_GNUTLS_OCSP_H__
19
20#include "mod_gnutls.h"
21
22#include <gnutls/gnutls.h>
23#include <gnutls/x509.h>
24#include <httpd.h>
25#include <http_config.h>
26
27#define MGS_OCSP_MUTEX_NAME "gnutls-ocsp"
28#define MGS_OCSP_CACHE_MUTEX_NAME "gnutls-ocsp-cache"
29#define MGS_OCSP_CACHE_NAME "gnutls_ocsp"
30
31/** Default OCSP response cache timeout in seconds */
32#define MGS_OCSP_CACHE_TIMEOUT 3600
33/** Default OCSP failure timeout in seconds */
34#define MGS_OCSP_FAILURE_TIMEOUT 300
35/** Default socket timeout for OCSP responder connections, in
36 * seconds. Note that the timeout applies to "absolutely no data sent
37 * or received", not the whole connection. 10 seconds in mod_ssl. */
38#define MGS_OCSP_SOCKET_TIMEOUT 6
39
40/**
41 * Vhost specific OCSP data structure
42 */
43struct mgs_ocsp_data {
44    /** The certificate the following elements refer to. */
45    gnutls_x509_crt_t cert;
46    /** OCSP URI extracted from the certificate. NULL if unset. */
47    apr_uri_t *uri;
48    /** Trust list to verify OCSP responses for stapling. Should
49     * usually only contain the CA that signed the certificate. */
50    gnutls_x509_trust_list_t *trust;
51    /** Certificate fingerprint, used as cache key for the OCSP
52     * response. */
53    gnutls_datum_t fingerprint;
54};
55
56const char *mgs_ocsp_stapling_enable(cmd_parms *parms,
57                                     void *dummy __attribute__((unused)),
58                                     const int arg);
59
60const char *mgs_set_ocsp_auto_refresh(cmd_parms *parms,
61                                      void *dummy __attribute__((unused)),
62                                      const int arg);
63
64const char *mgs_set_ocsp_check_nonce(cmd_parms *parms,
65                                     void *dummy __attribute__((unused)),
66                                     const int arg);
67
68const char *mgs_store_ocsp_response_path(cmd_parms * parms,
69                                         void *dummy __attribute__((unused)),
70                                         const char *arg);
71
72/**
73 * Create a trust list from a certificate chain (one or more
74 * certificates).
75 *
76 * @param tl This trust list will be initialized and filled with the
77 * specified certificate(s)
78 *
79 * @param chain certificate chain, must contain at least `num`
80 * certifictes
81 *
82 * @param num number of certificates to load from chain
83 *
84 * Chain is supposed to be static (the trust chain of the server
85 * certificate), so when `gnutls_x509_trust_list_deinit()` is called on
86 * tl later, the "all" parameter should be zero.
87 *
88 * @return `GNUTLS_E_SUCCESS` or a GnuTLS error code. In case of error
89 * tl will be uninitialized.
90 */
91int mgs_create_ocsp_trust_list(gnutls_x509_trust_list_t *tl,
92                               const gnutls_x509_crt_t *chain,
93                               const int num);
94
95/**
96 * Pool cleanup function that deinits the trust list without
97 * deinitializing certificates.
98 */
99apr_status_t mgs_cleanup_trust_list(void *data);
100
101/**
102 * Try to generate the OCSP stapling configuration for a (virtual)
103 * host. This function must be called in the post_config hook after
104 * certificates have been loaded. This method does not actually enable
105 * stapling, it only prepares the configuration. The reason for
106 * splitting these tasks is that configuration failure may be ignored
107 * if stapling is not explicitly enabled but only opportunistically.
108 *
109 * @return `NULL` on success, a string describing why configuration
110 * failed otherwise (static or allocated from ptemp)
111 */
112const char* mgs_ocsp_configure_stapling(apr_pool_t *pconf, apr_pool_t *ptemp,
113                                        server_rec *server);
114
115/**
116 * Enable OCSP stapling for a (virtual) host. Must be called in the
117 * post_config hook after mgs_ocsp_configure_stapling has returned
118 * successfully for that host.
119 *
120 * @return OK or DECLINED on success, any other value on error (like
121 * the post_config hook)
122 */
123int mgs_ocsp_enable_stapling(apr_pool_t *pconf, apr_pool_t *ptemp,
124                             server_rec *server);
125
126int mgs_get_ocsp_response(mgs_handle_t *ctxt,
127                          struct mgs_ocsp_data *req_data,
128                          gnutls_datum_t *ocsp_response);
129
130#endif /* __MOD_GNUTLS_OCSP_H__ */
Note: See TracBrowser for help on using the repository browser.