Rename OPENSSL_CTX prefix to OSSL_LIB_CTX
[openssl.git] / include / openssl / ocsp.h.in
1 /*
2  * {- join("\n * ", @autowarntext) -}
3  *
4  * Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
5  *
6  * Licensed under the Apache License 2.0 (the "License").  You may not use
7  * this file except in compliance with the License.  You can obtain a copy
8  * in the file LICENSE in the source distribution or at
9  * https://www.openssl.org/source/license.html
10  */
11
12 {-
13 use OpenSSL::stackhash qw(generate_stack_macros);
14 -}
15
16 #ifndef OPENSSL_OCSP_H
17 # define OPENSSL_OCSP_H
18 # pragma once
19
20 # include <openssl/macros.h>
21 # ifndef OPENSSL_NO_DEPRECATED_3_0
22 #  define HEADER_OCSP_H
23 # endif
24
25 # include <openssl/opensslconf.h>
26 # include <openssl/http.h> /* for OSSL_HTTP_parse_url */
27
28 /*
29  * These definitions are outside the OPENSSL_NO_OCSP guard because although for
30  * historical reasons they have OCSP_* names, they can actually be used
31  * independently of OCSP. E.g. see RFC5280
32  */
33 /*-
34  *   CRLReason ::= ENUMERATED {
35  *        unspecified             (0),
36  *        keyCompromise           (1),
37  *        cACompromise            (2),
38  *        affiliationChanged      (3),
39  *        superseded              (4),
40  *        cessationOfOperation    (5),
41  *        certificateHold         (6),
42  *        -- value 7 is not used
43  *        removeFromCRL           (8),
44  *        privilegeWithdrawn      (9),
45  *        aACompromise           (10) }
46  */
47 # define OCSP_REVOKED_STATUS_NOSTATUS                -1
48 # define OCSP_REVOKED_STATUS_UNSPECIFIED             0
49 # define OCSP_REVOKED_STATUS_KEYCOMPROMISE           1
50 # define OCSP_REVOKED_STATUS_CACOMPROMISE            2
51 # define OCSP_REVOKED_STATUS_AFFILIATIONCHANGED      3
52 # define OCSP_REVOKED_STATUS_SUPERSEDED              4
53 # define OCSP_REVOKED_STATUS_CESSATIONOFOPERATION    5
54 # define OCSP_REVOKED_STATUS_CERTIFICATEHOLD         6
55 # define OCSP_REVOKED_STATUS_REMOVEFROMCRL           8
56 # define OCSP_REVOKED_STATUS_PRIVILEGEWITHDRAWN      9
57 # define OCSP_REVOKED_STATUS_AACOMPROMISE            10
58
59 /*
60  * These definitions are outside the OPENSSL_NO_OCSP guard because although for
61  * historical reasons they have OCSP_* names, they are used for the HTTP client.
62  */
63 # include <openssl/asn1.h>
64 /* The following functions are used only internally */
65 OCSP_REQ_CTX *OCSP_REQ_CTX_new(BIO *wbio, BIO *rbio,
66                                int method_GET, int maxline,
67                                unsigned long max_resp_len, int timeout,
68                                const char *expected_content_type,
69                                int expect_asn1);
70 void OCSP_REQ_CTX_free(OCSP_REQ_CTX *rctx);
71 int OCSP_REQ_CTX_http(OCSP_REQ_CTX *rctx,
72                       const char *server, const char *port, const char *path);
73 int OCSP_REQ_CTX_add1_header(OCSP_REQ_CTX *rctx,
74                              const char *name, const char *value);
75 int OCSP_REQ_CTX_i2d(OCSP_REQ_CTX *rctx, const char *content_type,
76                      const ASN1_ITEM *it, ASN1_VALUE *req);
77 int OCSP_REQ_CTX_nbio(OCSP_REQ_CTX *rctx);
78 ASN1_VALUE *OCSP_REQ_CTX_nbio_d2i(OCSP_REQ_CTX *rctx, const ASN1_ITEM *it);
79 BIO *OCSP_REQ_CTX_get0_mem_bio(OCSP_REQ_CTX *rctx);
80 void OCSP_set_max_response_length(OCSP_REQ_CTX *rctx, unsigned long len);
81 /* End of functions used only internally */
82
83
84 # ifndef OPENSSL_NO_OCSP
85
86 #  include <openssl/x509.h>
87 #  include <openssl/x509v3.h>
88 #  include <openssl/safestack.h>
89 #  include <openssl/ocsperr.h>
90
91 #  ifdef __cplusplus
92 extern "C" {
93 #  endif
94
95 /* Various flags and values */
96
97 #  define OCSP_DEFAULT_NONCE_LENGTH       16
98
99 #  define OCSP_NOCERTS                    0x1
100 #  define OCSP_NOINTERN                   0x2
101 #  define OCSP_NOSIGS                     0x4
102 #  define OCSP_NOCHAIN                    0x8
103 #  define OCSP_NOVERIFY                   0x10
104 #  define OCSP_NOEXPLICIT                 0x20
105 #  define OCSP_NOCASIGN                   0x40
106 #  define OCSP_NODELEGATED                0x80
107 #  define OCSP_NOCHECKS                   0x100
108 #  define OCSP_TRUSTOTHER                 0x200
109 #  define OCSP_RESPID_KEY                 0x400
110 #  define OCSP_NOTIME                     0x800
111 #  define OCSP_PARTIAL_CHAIN              0x1000
112
113 typedef struct ocsp_cert_id_st OCSP_CERTID;
114 typedef struct ocsp_one_request_st OCSP_ONEREQ;
115 typedef struct ocsp_req_info_st OCSP_REQINFO;
116 typedef struct ocsp_signature_st OCSP_SIGNATURE;
117 typedef struct ocsp_request_st OCSP_REQUEST;
118
119 {-
120     generate_stack_macros("OCSP_CERTID")
121     .generate_stack_macros("OCSP_ONEREQ");
122 -}
123
124 #  define OCSP_RESPONSE_STATUS_SUCCESSFUL           0
125 #  define OCSP_RESPONSE_STATUS_MALFORMEDREQUEST     1
126 #  define OCSP_RESPONSE_STATUS_INTERNALERROR        2
127 #  define OCSP_RESPONSE_STATUS_TRYLATER             3
128 #  define OCSP_RESPONSE_STATUS_SIGREQUIRED          5
129 #  define OCSP_RESPONSE_STATUS_UNAUTHORIZED         6
130
131 typedef struct ocsp_resp_bytes_st OCSP_RESPBYTES;
132
133 #  define V_OCSP_RESPID_NAME 0
134 #  define V_OCSP_RESPID_KEY  1
135
136 {-
137     generate_stack_macros("OCSP_RESPID");
138 -}
139
140 typedef struct ocsp_revoked_info_st OCSP_REVOKEDINFO;
141
142 #  define V_OCSP_CERTSTATUS_GOOD    0
143 #  define V_OCSP_CERTSTATUS_REVOKED 1
144 #  define V_OCSP_CERTSTATUS_UNKNOWN 2
145
146 typedef struct ocsp_cert_status_st OCSP_CERTSTATUS;
147 typedef struct ocsp_single_response_st OCSP_SINGLERESP;
148
149 {-
150     generate_stack_macros("OCSP_SINGLERESP");
151 -}
152
153 typedef struct ocsp_response_data_st OCSP_RESPDATA;
154
155 typedef struct ocsp_basic_response_st OCSP_BASICRESP;
156
157 typedef struct ocsp_crl_id_st OCSP_CRLID;
158 typedef struct ocsp_service_locator_st OCSP_SERVICELOC;
159
160 #  define PEM_STRING_OCSP_REQUEST "OCSP REQUEST"
161 #  define PEM_STRING_OCSP_RESPONSE "OCSP RESPONSE"
162
163 #  define d2i_OCSP_REQUEST_bio(bp,p) ASN1_d2i_bio_of(OCSP_REQUEST,OCSP_REQUEST_new,d2i_OCSP_REQUEST,bp,p)
164
165 #  define d2i_OCSP_RESPONSE_bio(bp,p) ASN1_d2i_bio_of(OCSP_RESPONSE,OCSP_RESPONSE_new,d2i_OCSP_RESPONSE,bp,p)
166
167 #  define PEM_read_bio_OCSP_REQUEST(bp,x,cb) (OCSP_REQUEST *)PEM_ASN1_read_bio( \
168      (char *(*)())d2i_OCSP_REQUEST,PEM_STRING_OCSP_REQUEST, \
169      bp,(char **)(x),cb,NULL)
170
171 #  define PEM_read_bio_OCSP_RESPONSE(bp,x,cb) (OCSP_RESPONSE *)PEM_ASN1_read_bio(\
172      (char *(*)())d2i_OCSP_RESPONSE,PEM_STRING_OCSP_RESPONSE, \
173      bp,(char **)(x),cb,NULL)
174
175 #  define PEM_write_bio_OCSP_REQUEST(bp,o) \
176     PEM_ASN1_write_bio((int (*)())i2d_OCSP_REQUEST,PEM_STRING_OCSP_REQUEST,\
177                         bp,(char *)(o), NULL,NULL,0,NULL,NULL)
178
179 #  define PEM_write_bio_OCSP_RESPONSE(bp,o) \
180     PEM_ASN1_write_bio((int (*)())i2d_OCSP_RESPONSE,PEM_STRING_OCSP_RESPONSE,\
181                         bp,(char *)(o), NULL,NULL,0,NULL,NULL)
182
183 #  define i2d_OCSP_RESPONSE_bio(bp,o) ASN1_i2d_bio_of(OCSP_RESPONSE,i2d_OCSP_RESPONSE,bp,o)
184
185 #  define i2d_OCSP_REQUEST_bio(bp,o) ASN1_i2d_bio_of(OCSP_REQUEST,i2d_OCSP_REQUEST,bp,o)
186
187 #  define ASN1_BIT_STRING_digest(data,type,md,len) \
188         ASN1_item_digest(ASN1_ITEM_rptr(ASN1_BIT_STRING),type,data,md,len)
189
190 #  define OCSP_CERTSTATUS_dup(cs)\
191                 (OCSP_CERTSTATUS*)ASN1_dup((i2d_of_void *)i2d_OCSP_CERTSTATUS,\
192                 (d2i_of_void *)d2i_OCSP_CERTSTATUS,(char *)(cs))
193
194 DECLARE_ASN1_DUP_FUNCTION(OCSP_CERTID)
195
196 OCSP_RESPONSE *OCSP_sendreq_bio(BIO *b, const char *path, OCSP_REQUEST *req);
197 OCSP_REQ_CTX *OCSP_sendreq_new(BIO *io, const char *path, OCSP_REQUEST *req,
198                                int maxline);
199 int OCSP_sendreq_nbio(OCSP_RESPONSE **presp, OCSP_REQ_CTX *rctx);
200
201 /* TODO: remove this (documented but) meanwhile obsolete function? */
202 int OCSP_REQ_CTX_set1_req(OCSP_REQ_CTX *rctx, const OCSP_REQUEST *req);
203
204 OCSP_CERTID *OCSP_cert_to_id(const EVP_MD *dgst, const X509 *subject,
205                              const X509 *issuer);
206
207 OCSP_CERTID *OCSP_cert_id_new(const EVP_MD *dgst,
208                               const X509_NAME *issuerName,
209                               const ASN1_BIT_STRING *issuerKey,
210                               const ASN1_INTEGER *serialNumber);
211
212 OCSP_ONEREQ *OCSP_request_add0_id(OCSP_REQUEST *req, OCSP_CERTID *cid);
213
214 int OCSP_request_add1_nonce(OCSP_REQUEST *req, unsigned char *val, int len);
215 int OCSP_basic_add1_nonce(OCSP_BASICRESP *resp, unsigned char *val, int len);
216 int OCSP_check_nonce(OCSP_REQUEST *req, OCSP_BASICRESP *bs);
217 int OCSP_copy_nonce(OCSP_BASICRESP *resp, OCSP_REQUEST *req);
218
219 int OCSP_request_set1_name(OCSP_REQUEST *req, const X509_NAME *nm);
220 int OCSP_request_add1_cert(OCSP_REQUEST *req, X509 *cert);
221
222 int OCSP_request_sign(OCSP_REQUEST *req,
223                       X509 *signer,
224                       EVP_PKEY *key,
225                       const EVP_MD *dgst,
226                       STACK_OF(X509) *certs, unsigned long flags);
227
228 int OCSP_response_status(OCSP_RESPONSE *resp);
229 OCSP_BASICRESP *OCSP_response_get1_basic(OCSP_RESPONSE *resp);
230
231 const ASN1_OCTET_STRING *OCSP_resp_get0_signature(const OCSP_BASICRESP *bs);
232 const X509_ALGOR *OCSP_resp_get0_tbs_sigalg(const OCSP_BASICRESP *bs);
233 const OCSP_RESPDATA *OCSP_resp_get0_respdata(const OCSP_BASICRESP *bs);
234 int OCSP_resp_get0_signer(OCSP_BASICRESP *bs, X509 **signer,
235                           STACK_OF(X509) *extra_certs);
236
237 int OCSP_resp_count(OCSP_BASICRESP *bs);
238 OCSP_SINGLERESP *OCSP_resp_get0(OCSP_BASICRESP *bs, int idx);
239 const ASN1_GENERALIZEDTIME *OCSP_resp_get0_produced_at(const OCSP_BASICRESP* bs);
240 const STACK_OF(X509) *OCSP_resp_get0_certs(const OCSP_BASICRESP *bs);
241 int OCSP_resp_get0_id(const OCSP_BASICRESP *bs,
242                       const ASN1_OCTET_STRING **pid,
243                       const X509_NAME **pname);
244 int OCSP_resp_get1_id(const OCSP_BASICRESP *bs,
245                       ASN1_OCTET_STRING **pid,
246                       X509_NAME **pname);
247
248 int OCSP_resp_find(OCSP_BASICRESP *bs, OCSP_CERTID *id, int last);
249 int OCSP_single_get0_status(OCSP_SINGLERESP *single, int *reason,
250                             ASN1_GENERALIZEDTIME **revtime,
251                             ASN1_GENERALIZEDTIME **thisupd,
252                             ASN1_GENERALIZEDTIME **nextupd);
253 int OCSP_resp_find_status(OCSP_BASICRESP *bs, OCSP_CERTID *id, int *status,
254                           int *reason,
255                           ASN1_GENERALIZEDTIME **revtime,
256                           ASN1_GENERALIZEDTIME **thisupd,
257                           ASN1_GENERALIZEDTIME **nextupd);
258 int OCSP_check_validity(ASN1_GENERALIZEDTIME *thisupd,
259                         ASN1_GENERALIZEDTIME *nextupd, long sec, long maxsec);
260
261 int OCSP_request_verify(OCSP_REQUEST *req, STACK_OF(X509) *certs,
262                         X509_STORE *store, unsigned long flags);
263
264 #  define OCSP_parse_url(url, host, port, path, ssl) \
265     OSSL_HTTP_parse_url(url, host, port, NULL, path, ssl) /* backward compat */
266
267 int OCSP_id_issuer_cmp(const OCSP_CERTID *a, const OCSP_CERTID *b);
268 int OCSP_id_cmp(const OCSP_CERTID *a, const OCSP_CERTID *b);
269
270 int OCSP_request_onereq_count(OCSP_REQUEST *req);
271 OCSP_ONEREQ *OCSP_request_onereq_get0(OCSP_REQUEST *req, int i);
272 OCSP_CERTID *OCSP_onereq_get0_id(OCSP_ONEREQ *one);
273 int OCSP_id_get0_info(ASN1_OCTET_STRING **piNameHash, ASN1_OBJECT **pmd,
274                       ASN1_OCTET_STRING **pikeyHash,
275                       ASN1_INTEGER **pserial, OCSP_CERTID *cid);
276 int OCSP_request_is_signed(OCSP_REQUEST *req);
277 OCSP_RESPONSE *OCSP_response_create(int status, OCSP_BASICRESP *bs);
278 OCSP_SINGLERESP *OCSP_basic_add1_status(OCSP_BASICRESP *rsp,
279                                         OCSP_CERTID *cid,
280                                         int status, int reason,
281                                         ASN1_TIME *revtime,
282                                         ASN1_TIME *thisupd,
283                                         ASN1_TIME *nextupd);
284 int OCSP_basic_add1_cert(OCSP_BASICRESP *resp, X509 *cert);
285 int OCSP_basic_sign(OCSP_BASICRESP *brsp,
286                     X509 *signer, EVP_PKEY *key, const EVP_MD *dgst,
287                     STACK_OF(X509) *certs, unsigned long flags);
288 int OCSP_basic_sign_ctx(OCSP_BASICRESP *brsp,
289                         X509 *signer, EVP_MD_CTX *ctx,
290                         STACK_OF(X509) *certs, unsigned long flags);
291 int OCSP_RESPID_set_by_name(OCSP_RESPID *respid, X509 *cert);
292 int OCSP_RESPID_set_by_key_ex(OCSP_RESPID *respid, X509 *cert,
293                               OSSL_LIB_CTX *libctx, const char *propq);
294 int OCSP_RESPID_set_by_key(OCSP_RESPID *respid, X509 *cert);
295 int OCSP_RESPID_match_ex(OCSP_RESPID *respid, X509 *cert, OSSL_LIB_CTX *libctx,
296                          const char *propq);
297 int OCSP_RESPID_match(OCSP_RESPID *respid, X509 *cert);
298
299 X509_EXTENSION *OCSP_crlID_new(const char *url, long *n, char *tim);
300
301 X509_EXTENSION *OCSP_accept_responses_new(char **oids);
302
303 X509_EXTENSION *OCSP_archive_cutoff_new(char *tim);
304
305 X509_EXTENSION *OCSP_url_svcloc_new(const X509_NAME *issuer, const char **urls);
306
307 int OCSP_REQUEST_get_ext_count(OCSP_REQUEST *x);
308 int OCSP_REQUEST_get_ext_by_NID(OCSP_REQUEST *x, int nid, int lastpos);
309 int OCSP_REQUEST_get_ext_by_OBJ(OCSP_REQUEST *x, const ASN1_OBJECT *obj,
310                                 int lastpos);
311 int OCSP_REQUEST_get_ext_by_critical(OCSP_REQUEST *x, int crit, int lastpos);
312 X509_EXTENSION *OCSP_REQUEST_get_ext(OCSP_REQUEST *x, int loc);
313 X509_EXTENSION *OCSP_REQUEST_delete_ext(OCSP_REQUEST *x, int loc);
314 void *OCSP_REQUEST_get1_ext_d2i(OCSP_REQUEST *x, int nid, int *crit,
315                                 int *idx);
316 int OCSP_REQUEST_add1_ext_i2d(OCSP_REQUEST *x, int nid, void *value, int crit,
317                               unsigned long flags);
318 int OCSP_REQUEST_add_ext(OCSP_REQUEST *x, X509_EXTENSION *ex, int loc);
319
320 int OCSP_ONEREQ_get_ext_count(OCSP_ONEREQ *x);
321 int OCSP_ONEREQ_get_ext_by_NID(OCSP_ONEREQ *x, int nid, int lastpos);
322 int OCSP_ONEREQ_get_ext_by_OBJ(OCSP_ONEREQ *x, const ASN1_OBJECT *obj, int lastpos);
323 int OCSP_ONEREQ_get_ext_by_critical(OCSP_ONEREQ *x, int crit, int lastpos);
324 X509_EXTENSION *OCSP_ONEREQ_get_ext(OCSP_ONEREQ *x, int loc);
325 X509_EXTENSION *OCSP_ONEREQ_delete_ext(OCSP_ONEREQ *x, int loc);
326 void *OCSP_ONEREQ_get1_ext_d2i(OCSP_ONEREQ *x, int nid, int *crit, int *idx);
327 int OCSP_ONEREQ_add1_ext_i2d(OCSP_ONEREQ *x, int nid, void *value, int crit,
328                              unsigned long flags);
329 int OCSP_ONEREQ_add_ext(OCSP_ONEREQ *x, X509_EXTENSION *ex, int loc);
330
331 int OCSP_BASICRESP_get_ext_count(OCSP_BASICRESP *x);
332 int OCSP_BASICRESP_get_ext_by_NID(OCSP_BASICRESP *x, int nid, int lastpos);
333 int OCSP_BASICRESP_get_ext_by_OBJ(OCSP_BASICRESP *x, const ASN1_OBJECT *obj,
334                                   int lastpos);
335 int OCSP_BASICRESP_get_ext_by_critical(OCSP_BASICRESP *x, int crit,
336                                        int lastpos);
337 X509_EXTENSION *OCSP_BASICRESP_get_ext(OCSP_BASICRESP *x, int loc);
338 X509_EXTENSION *OCSP_BASICRESP_delete_ext(OCSP_BASICRESP *x, int loc);
339 void *OCSP_BASICRESP_get1_ext_d2i(OCSP_BASICRESP *x, int nid, int *crit,
340                                   int *idx);
341 int OCSP_BASICRESP_add1_ext_i2d(OCSP_BASICRESP *x, int nid, void *value,
342                                 int crit, unsigned long flags);
343 int OCSP_BASICRESP_add_ext(OCSP_BASICRESP *x, X509_EXTENSION *ex, int loc);
344
345 int OCSP_SINGLERESP_get_ext_count(OCSP_SINGLERESP *x);
346 int OCSP_SINGLERESP_get_ext_by_NID(OCSP_SINGLERESP *x, int nid, int lastpos);
347 int OCSP_SINGLERESP_get_ext_by_OBJ(OCSP_SINGLERESP *x, const ASN1_OBJECT *obj,
348                                    int lastpos);
349 int OCSP_SINGLERESP_get_ext_by_critical(OCSP_SINGLERESP *x, int crit,
350                                         int lastpos);
351 X509_EXTENSION *OCSP_SINGLERESP_get_ext(OCSP_SINGLERESP *x, int loc);
352 X509_EXTENSION *OCSP_SINGLERESP_delete_ext(OCSP_SINGLERESP *x, int loc);
353 void *OCSP_SINGLERESP_get1_ext_d2i(OCSP_SINGLERESP *x, int nid, int *crit,
354                                    int *idx);
355 int OCSP_SINGLERESP_add1_ext_i2d(OCSP_SINGLERESP *x, int nid, void *value,
356                                  int crit, unsigned long flags);
357 int OCSP_SINGLERESP_add_ext(OCSP_SINGLERESP *x, X509_EXTENSION *ex, int loc);
358 const OCSP_CERTID *OCSP_SINGLERESP_get0_id(const OCSP_SINGLERESP *x);
359
360 DECLARE_ASN1_FUNCTIONS(OCSP_SINGLERESP)
361 DECLARE_ASN1_FUNCTIONS(OCSP_CERTSTATUS)
362 DECLARE_ASN1_FUNCTIONS(OCSP_REVOKEDINFO)
363 DECLARE_ASN1_FUNCTIONS(OCSP_BASICRESP)
364 DECLARE_ASN1_FUNCTIONS(OCSP_RESPDATA)
365 DECLARE_ASN1_FUNCTIONS(OCSP_RESPID)
366 DECLARE_ASN1_FUNCTIONS(OCSP_RESPONSE)
367 DECLARE_ASN1_FUNCTIONS(OCSP_RESPBYTES)
368 DECLARE_ASN1_FUNCTIONS(OCSP_ONEREQ)
369 DECLARE_ASN1_FUNCTIONS(OCSP_CERTID)
370 DECLARE_ASN1_FUNCTIONS(OCSP_REQUEST)
371 DECLARE_ASN1_FUNCTIONS(OCSP_SIGNATURE)
372 DECLARE_ASN1_FUNCTIONS(OCSP_REQINFO)
373 DECLARE_ASN1_FUNCTIONS(OCSP_CRLID)
374 DECLARE_ASN1_FUNCTIONS(OCSP_SERVICELOC)
375
376 const char *OCSP_response_status_str(long s);
377 const char *OCSP_cert_status_str(long s);
378 const char *OCSP_crl_reason_str(long s);
379
380 int OCSP_REQUEST_print(BIO *bp, OCSP_REQUEST *a, unsigned long flags);
381 int OCSP_RESPONSE_print(BIO *bp, OCSP_RESPONSE *o, unsigned long flags);
382
383 int OCSP_basic_verify(OCSP_BASICRESP *bs, STACK_OF(X509) *certs,
384                       X509_STORE *st, unsigned long flags);
385
386
387 #  ifdef  __cplusplus
388 }
389 #  endif
390 # endif /* !defined(OPENSSL_NO_OCSP) */
391 #endif