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