Constify X509_check_akid and prefer using X509_get0_serialNumber over X509_get_serial...
[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
106 typedef struct ocsp_cert_id_st OCSP_CERTID;
107 typedef struct ocsp_one_request_st OCSP_ONEREQ;
108 typedef struct ocsp_req_info_st OCSP_REQINFO;
109 typedef struct ocsp_signature_st OCSP_SIGNATURE;
110 typedef struct ocsp_request_st OCSP_REQUEST;
111
112 DEFINE_OR_DECLARE_STACK_OF(OCSP_CERTID)
113 DEFINE_OR_DECLARE_STACK_OF(OCSP_ONEREQ)
114
115 #  define OCSP_RESPONSE_STATUS_SUCCESSFUL           0
116 #  define OCSP_RESPONSE_STATUS_MALFORMEDREQUEST     1
117 #  define OCSP_RESPONSE_STATUS_INTERNALERROR        2
118 #  define OCSP_RESPONSE_STATUS_TRYLATER             3
119 #  define OCSP_RESPONSE_STATUS_SIGREQUIRED          5
120 #  define OCSP_RESPONSE_STATUS_UNAUTHORIZED         6
121
122 typedef struct ocsp_resp_bytes_st OCSP_RESPBYTES;
123
124 #  define V_OCSP_RESPID_NAME 0
125 #  define V_OCSP_RESPID_KEY  1
126
127 DEFINE_OR_DECLARE_STACK_OF(OCSP_RESPID)
128
129 typedef struct ocsp_revoked_info_st OCSP_REVOKEDINFO;
130
131 #  define V_OCSP_CERTSTATUS_GOOD    0
132 #  define V_OCSP_CERTSTATUS_REVOKED 1
133 #  define V_OCSP_CERTSTATUS_UNKNOWN 2
134
135 typedef struct ocsp_cert_status_st OCSP_CERTSTATUS;
136 typedef struct ocsp_single_response_st OCSP_SINGLERESP;
137
138 DEFINE_OR_DECLARE_STACK_OF(OCSP_SINGLERESP)
139
140 typedef struct ocsp_response_data_st OCSP_RESPDATA;
141
142 typedef struct ocsp_basic_response_st OCSP_BASICRESP;
143
144 typedef struct ocsp_crl_id_st OCSP_CRLID;
145 typedef struct ocsp_service_locator_st OCSP_SERVICELOC;
146
147 #  define PEM_STRING_OCSP_REQUEST "OCSP REQUEST"
148 #  define PEM_STRING_OCSP_RESPONSE "OCSP RESPONSE"
149
150 #  define d2i_OCSP_REQUEST_bio(bp,p) ASN1_d2i_bio_of(OCSP_REQUEST,OCSP_REQUEST_new,d2i_OCSP_REQUEST,bp,p)
151
152 #  define d2i_OCSP_RESPONSE_bio(bp,p) ASN1_d2i_bio_of(OCSP_RESPONSE,OCSP_RESPONSE_new,d2i_OCSP_RESPONSE,bp,p)
153
154 #  define PEM_read_bio_OCSP_REQUEST(bp,x,cb) (OCSP_REQUEST *)PEM_ASN1_read_bio( \
155      (char *(*)())d2i_OCSP_REQUEST,PEM_STRING_OCSP_REQUEST, \
156      bp,(char **)(x),cb,NULL)
157
158 #  define PEM_read_bio_OCSP_RESPONSE(bp,x,cb) (OCSP_RESPONSE *)PEM_ASN1_read_bio(\
159      (char *(*)())d2i_OCSP_RESPONSE,PEM_STRING_OCSP_RESPONSE, \
160      bp,(char **)(x),cb,NULL)
161
162 #  define PEM_write_bio_OCSP_REQUEST(bp,o) \
163     PEM_ASN1_write_bio((int (*)())i2d_OCSP_REQUEST,PEM_STRING_OCSP_REQUEST,\
164                         bp,(char *)(o), NULL,NULL,0,NULL,NULL)
165
166 #  define PEM_write_bio_OCSP_RESPONSE(bp,o) \
167     PEM_ASN1_write_bio((int (*)())i2d_OCSP_RESPONSE,PEM_STRING_OCSP_RESPONSE,\
168                         bp,(char *)(o), NULL,NULL,0,NULL,NULL)
169
170 #  define i2d_OCSP_RESPONSE_bio(bp,o) ASN1_i2d_bio_of(OCSP_RESPONSE,i2d_OCSP_RESPONSE,bp,o)
171
172 #  define i2d_OCSP_REQUEST_bio(bp,o) ASN1_i2d_bio_of(OCSP_REQUEST,i2d_OCSP_REQUEST,bp,o)
173
174 #  define ASN1_BIT_STRING_digest(data,type,md,len) \
175         ASN1_item_digest(ASN1_ITEM_rptr(ASN1_BIT_STRING),type,data,md,len)
176
177 #  define OCSP_CERTSTATUS_dup(cs)\
178                 (OCSP_CERTSTATUS*)ASN1_dup((i2d_of_void *)i2d_OCSP_CERTSTATUS,\
179                 (d2i_of_void *)d2i_OCSP_CERTSTATUS,(char *)(cs))
180
181 DECLARE_ASN1_DUP_FUNCTION(OCSP_CERTID)
182
183 OCSP_RESPONSE *OCSP_sendreq_bio(BIO *b, const char *path, OCSP_REQUEST *req);
184 OCSP_REQ_CTX *OCSP_sendreq_new(BIO *io, const char *path, OCSP_REQUEST *req,
185                                int maxline);
186 int OCSP_sendreq_nbio(OCSP_RESPONSE **presp, OCSP_REQ_CTX *rctx);
187
188 /* TODO: remove this (documented but) meanwhile obsolete function? */
189 int OCSP_REQ_CTX_set1_req(OCSP_REQ_CTX *rctx, const OCSP_REQUEST *req);
190
191 OCSP_CERTID *OCSP_cert_to_id(const EVP_MD *dgst, const X509 *subject,
192                              const X509 *issuer);
193
194 OCSP_CERTID *OCSP_cert_id_new(const EVP_MD *dgst,
195                               const X509_NAME *issuerName,
196                               const ASN1_BIT_STRING *issuerKey,
197                               const ASN1_INTEGER *serialNumber);
198
199 OCSP_ONEREQ *OCSP_request_add0_id(OCSP_REQUEST *req, OCSP_CERTID *cid);
200
201 int OCSP_request_add1_nonce(OCSP_REQUEST *req, unsigned char *val, int len);
202 int OCSP_basic_add1_nonce(OCSP_BASICRESP *resp, unsigned char *val, int len);
203 int OCSP_check_nonce(OCSP_REQUEST *req, OCSP_BASICRESP *bs);
204 int OCSP_copy_nonce(OCSP_BASICRESP *resp, OCSP_REQUEST *req);
205
206 int OCSP_request_set1_name(OCSP_REQUEST *req, const X509_NAME *nm);
207 int OCSP_request_add1_cert(OCSP_REQUEST *req, X509 *cert);
208
209 int OCSP_request_sign(OCSP_REQUEST *req,
210                       X509 *signer,
211                       EVP_PKEY *key,
212                       const EVP_MD *dgst,
213                       STACK_OF(X509) *certs, unsigned long flags);
214
215 int OCSP_response_status(OCSP_RESPONSE *resp);
216 OCSP_BASICRESP *OCSP_response_get1_basic(OCSP_RESPONSE *resp);
217
218 const ASN1_OCTET_STRING *OCSP_resp_get0_signature(const OCSP_BASICRESP *bs);
219 const X509_ALGOR *OCSP_resp_get0_tbs_sigalg(const OCSP_BASICRESP *bs);
220 const OCSP_RESPDATA *OCSP_resp_get0_respdata(const OCSP_BASICRESP *bs);
221 int OCSP_resp_get0_signer(OCSP_BASICRESP *bs, X509 **signer,
222                           STACK_OF(X509) *extra_certs);
223
224 int OCSP_resp_count(OCSP_BASICRESP *bs);
225 OCSP_SINGLERESP *OCSP_resp_get0(OCSP_BASICRESP *bs, int idx);
226 const ASN1_GENERALIZEDTIME *OCSP_resp_get0_produced_at(const OCSP_BASICRESP* bs);
227 const STACK_OF(X509) *OCSP_resp_get0_certs(const OCSP_BASICRESP *bs);
228 int OCSP_resp_get0_id(const OCSP_BASICRESP *bs,
229                       const ASN1_OCTET_STRING **pid,
230                       const X509_NAME **pname);
231 int OCSP_resp_get1_id(const OCSP_BASICRESP *bs,
232                       ASN1_OCTET_STRING **pid,
233                       X509_NAME **pname);
234
235 int OCSP_resp_find(OCSP_BASICRESP *bs, OCSP_CERTID *id, int last);
236 int OCSP_single_get0_status(OCSP_SINGLERESP *single, int *reason,
237                             ASN1_GENERALIZEDTIME **revtime,
238                             ASN1_GENERALIZEDTIME **thisupd,
239                             ASN1_GENERALIZEDTIME **nextupd);
240 int OCSP_resp_find_status(OCSP_BASICRESP *bs, OCSP_CERTID *id, int *status,
241                           int *reason,
242                           ASN1_GENERALIZEDTIME **revtime,
243                           ASN1_GENERALIZEDTIME **thisupd,
244                           ASN1_GENERALIZEDTIME **nextupd);
245 int OCSP_check_validity(ASN1_GENERALIZEDTIME *thisupd,
246                         ASN1_GENERALIZEDTIME *nextupd, long sec, long maxsec);
247
248 int OCSP_request_verify(OCSP_REQUEST *req, STACK_OF(X509) *certs,
249                         X509_STORE *store, unsigned long flags);
250
251 #  define OCSP_parse_url OSSL_HTTP_parse_url /* for backward compatibility */
252
253 int OCSP_id_issuer_cmp(const OCSP_CERTID *a, const OCSP_CERTID *b);
254 int OCSP_id_cmp(const OCSP_CERTID *a, const OCSP_CERTID *b);
255
256 int OCSP_request_onereq_count(OCSP_REQUEST *req);
257 OCSP_ONEREQ *OCSP_request_onereq_get0(OCSP_REQUEST *req, int i);
258 OCSP_CERTID *OCSP_onereq_get0_id(OCSP_ONEREQ *one);
259 int OCSP_id_get0_info(ASN1_OCTET_STRING **piNameHash, ASN1_OBJECT **pmd,
260                       ASN1_OCTET_STRING **pikeyHash,
261                       ASN1_INTEGER **pserial, OCSP_CERTID *cid);
262 int OCSP_request_is_signed(OCSP_REQUEST *req);
263 OCSP_RESPONSE *OCSP_response_create(int status, OCSP_BASICRESP *bs);
264 OCSP_SINGLERESP *OCSP_basic_add1_status(OCSP_BASICRESP *rsp,
265                                         OCSP_CERTID *cid,
266                                         int status, int reason,
267                                         ASN1_TIME *revtime,
268                                         ASN1_TIME *thisupd,
269                                         ASN1_TIME *nextupd);
270 int OCSP_basic_add1_cert(OCSP_BASICRESP *resp, X509 *cert);
271 int OCSP_basic_sign(OCSP_BASICRESP *brsp,
272                     X509 *signer, EVP_PKEY *key, const EVP_MD *dgst,
273                     STACK_OF(X509) *certs, unsigned long flags);
274 int OCSP_basic_sign_ctx(OCSP_BASICRESP *brsp,
275                         X509 *signer, EVP_MD_CTX *ctx,
276                         STACK_OF(X509) *certs, unsigned long flags);
277 int OCSP_RESPID_set_by_name(OCSP_RESPID *respid, X509 *cert);
278 int OCSP_RESPID_set_by_key_ex(OCSP_RESPID *respid, X509 *cert,
279                               OPENSSL_CTX *libctx, const char *propq);
280 int OCSP_RESPID_set_by_key(OCSP_RESPID *respid, X509 *cert);
281 int OCSP_RESPID_match_ex(OCSP_RESPID *respid, X509 *cert, OPENSSL_CTX *libctx,
282                          const char *propq);
283 int OCSP_RESPID_match(OCSP_RESPID *respid, X509 *cert);
284
285 X509_EXTENSION *OCSP_crlID_new(const char *url, long *n, char *tim);
286
287 X509_EXTENSION *OCSP_accept_responses_new(char **oids);
288
289 X509_EXTENSION *OCSP_archive_cutoff_new(char *tim);
290
291 X509_EXTENSION *OCSP_url_svcloc_new(const X509_NAME *issuer, const char **urls);
292
293 int OCSP_REQUEST_get_ext_count(OCSP_REQUEST *x);
294 int OCSP_REQUEST_get_ext_by_NID(OCSP_REQUEST *x, int nid, int lastpos);
295 int OCSP_REQUEST_get_ext_by_OBJ(OCSP_REQUEST *x, const ASN1_OBJECT *obj,
296                                 int lastpos);
297 int OCSP_REQUEST_get_ext_by_critical(OCSP_REQUEST *x, int crit, int lastpos);
298 X509_EXTENSION *OCSP_REQUEST_get_ext(OCSP_REQUEST *x, int loc);
299 X509_EXTENSION *OCSP_REQUEST_delete_ext(OCSP_REQUEST *x, int loc);
300 void *OCSP_REQUEST_get1_ext_d2i(OCSP_REQUEST *x, int nid, int *crit,
301                                 int *idx);
302 int OCSP_REQUEST_add1_ext_i2d(OCSP_REQUEST *x, int nid, void *value, int crit,
303                               unsigned long flags);
304 int OCSP_REQUEST_add_ext(OCSP_REQUEST *x, X509_EXTENSION *ex, int loc);
305
306 int OCSP_ONEREQ_get_ext_count(OCSP_ONEREQ *x);
307 int OCSP_ONEREQ_get_ext_by_NID(OCSP_ONEREQ *x, int nid, int lastpos);
308 int OCSP_ONEREQ_get_ext_by_OBJ(OCSP_ONEREQ *x, const ASN1_OBJECT *obj, int lastpos);
309 int OCSP_ONEREQ_get_ext_by_critical(OCSP_ONEREQ *x, int crit, int lastpos);
310 X509_EXTENSION *OCSP_ONEREQ_get_ext(OCSP_ONEREQ *x, int loc);
311 X509_EXTENSION *OCSP_ONEREQ_delete_ext(OCSP_ONEREQ *x, int loc);
312 void *OCSP_ONEREQ_get1_ext_d2i(OCSP_ONEREQ *x, int nid, int *crit, int *idx);
313 int OCSP_ONEREQ_add1_ext_i2d(OCSP_ONEREQ *x, int nid, void *value, int crit,
314                              unsigned long flags);
315 int OCSP_ONEREQ_add_ext(OCSP_ONEREQ *x, X509_EXTENSION *ex, int loc);
316
317 int OCSP_BASICRESP_get_ext_count(OCSP_BASICRESP *x);
318 int OCSP_BASICRESP_get_ext_by_NID(OCSP_BASICRESP *x, int nid, int lastpos);
319 int OCSP_BASICRESP_get_ext_by_OBJ(OCSP_BASICRESP *x, const ASN1_OBJECT *obj,
320                                   int lastpos);
321 int OCSP_BASICRESP_get_ext_by_critical(OCSP_BASICRESP *x, int crit,
322                                        int lastpos);
323 X509_EXTENSION *OCSP_BASICRESP_get_ext(OCSP_BASICRESP *x, int loc);
324 X509_EXTENSION *OCSP_BASICRESP_delete_ext(OCSP_BASICRESP *x, int loc);
325 void *OCSP_BASICRESP_get1_ext_d2i(OCSP_BASICRESP *x, int nid, int *crit,
326                                   int *idx);
327 int OCSP_BASICRESP_add1_ext_i2d(OCSP_BASICRESP *x, int nid, void *value,
328                                 int crit, unsigned long flags);
329 int OCSP_BASICRESP_add_ext(OCSP_BASICRESP *x, X509_EXTENSION *ex, int loc);
330
331 int OCSP_SINGLERESP_get_ext_count(OCSP_SINGLERESP *x);
332 int OCSP_SINGLERESP_get_ext_by_NID(OCSP_SINGLERESP *x, int nid, int lastpos);
333 int OCSP_SINGLERESP_get_ext_by_OBJ(OCSP_SINGLERESP *x, const ASN1_OBJECT *obj,
334                                    int lastpos);
335 int OCSP_SINGLERESP_get_ext_by_critical(OCSP_SINGLERESP *x, int crit,
336                                         int lastpos);
337 X509_EXTENSION *OCSP_SINGLERESP_get_ext(OCSP_SINGLERESP *x, int loc);
338 X509_EXTENSION *OCSP_SINGLERESP_delete_ext(OCSP_SINGLERESP *x, int loc);
339 void *OCSP_SINGLERESP_get1_ext_d2i(OCSP_SINGLERESP *x, int nid, int *crit,
340                                    int *idx);
341 int OCSP_SINGLERESP_add1_ext_i2d(OCSP_SINGLERESP *x, int nid, void *value,
342                                  int crit, unsigned long flags);
343 int OCSP_SINGLERESP_add_ext(OCSP_SINGLERESP *x, X509_EXTENSION *ex, int loc);
344 const OCSP_CERTID *OCSP_SINGLERESP_get0_id(const OCSP_SINGLERESP *x);
345
346 DECLARE_ASN1_FUNCTIONS(OCSP_SINGLERESP)
347 DECLARE_ASN1_FUNCTIONS(OCSP_CERTSTATUS)
348 DECLARE_ASN1_FUNCTIONS(OCSP_REVOKEDINFO)
349 DECLARE_ASN1_FUNCTIONS(OCSP_BASICRESP)
350 DECLARE_ASN1_FUNCTIONS(OCSP_RESPDATA)
351 DECLARE_ASN1_FUNCTIONS(OCSP_RESPID)
352 DECLARE_ASN1_FUNCTIONS(OCSP_RESPONSE)
353 DECLARE_ASN1_FUNCTIONS(OCSP_RESPBYTES)
354 DECLARE_ASN1_FUNCTIONS(OCSP_ONEREQ)
355 DECLARE_ASN1_FUNCTIONS(OCSP_CERTID)
356 DECLARE_ASN1_FUNCTIONS(OCSP_REQUEST)
357 DECLARE_ASN1_FUNCTIONS(OCSP_SIGNATURE)
358 DECLARE_ASN1_FUNCTIONS(OCSP_REQINFO)
359 DECLARE_ASN1_FUNCTIONS(OCSP_CRLID)
360 DECLARE_ASN1_FUNCTIONS(OCSP_SERVICELOC)
361
362 const char *OCSP_response_status_str(long s);
363 const char *OCSP_cert_status_str(long s);
364 const char *OCSP_crl_reason_str(long s);
365
366 int OCSP_REQUEST_print(BIO *bp, OCSP_REQUEST *a, unsigned long flags);
367 int OCSP_RESPONSE_print(BIO *bp, OCSP_RESPONSE *o, unsigned long flags);
368
369 int OCSP_basic_verify(OCSP_BASICRESP *bs, STACK_OF(X509) *certs,
370                       X509_STORE *st, unsigned long flags);
371
372
373 #  ifdef  __cplusplus
374 }
375 #  endif
376 # endif /* !defined(OPENSSL_NO_OCSP) */
377 #endif