2 * {- join("\n * ", @autowarntext) -}
4 * Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.
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
13 use OpenSSL::stackhash qw(generate_stack_macros);
16 #ifndef OPENSSL_OCSP_H
17 # define OPENSSL_OCSP_H
20 # include <openssl/macros.h>
21 # ifndef OPENSSL_NO_DEPRECATED_3_0
22 # define HEADER_OCSP_H
25 # include <openssl/opensslconf.h>
26 # include <openssl/http.h>
27 # include <openssl/asn1.h>
30 * These definitions are outside the OPENSSL_NO_OCSP guard because although for
31 * historical reasons they have OCSP_* names, they can actually be used
32 * independently of OCSP. E.g. see RFC5280
35 * CRLReason ::= ENUMERATED {
39 * affiliationChanged (3),
41 * cessationOfOperation (5),
42 * certificateHold (6),
43 * -- value 7 is not used
45 * privilegeWithdrawn (9),
48 # define OCSP_REVOKED_STATUS_NOSTATUS -1
49 # define OCSP_REVOKED_STATUS_UNSPECIFIED 0
50 # define OCSP_REVOKED_STATUS_KEYCOMPROMISE 1
51 # define OCSP_REVOKED_STATUS_CACOMPROMISE 2
52 # define OCSP_REVOKED_STATUS_AFFILIATIONCHANGED 3
53 # define OCSP_REVOKED_STATUS_SUPERSEDED 4
54 # define OCSP_REVOKED_STATUS_CESSATIONOFOPERATION 5
55 # define OCSP_REVOKED_STATUS_CERTIFICATEHOLD 6
56 # define OCSP_REVOKED_STATUS_REMOVEFROMCRL 8
57 # define OCSP_REVOKED_STATUS_PRIVILEGEWITHDRAWN 9
58 # define OCSP_REVOKED_STATUS_AACOMPROMISE 10
61 # ifndef OPENSSL_NO_OCSP
63 # include <openssl/x509.h>
64 # include <openssl/x509v3.h>
65 # include <openssl/safestack.h>
66 # include <openssl/ocsperr.h>
72 /* Various flags and values */
74 # define OCSP_DEFAULT_NONCE_LENGTH 16
76 # define OCSP_NOCERTS 0x1
77 # define OCSP_NOINTERN 0x2
78 # define OCSP_NOSIGS 0x4
79 # define OCSP_NOCHAIN 0x8
80 # define OCSP_NOVERIFY 0x10
81 # define OCSP_NOEXPLICIT 0x20
82 # define OCSP_NOCASIGN 0x40
83 # define OCSP_NODELEGATED 0x80
84 # define OCSP_NOCHECKS 0x100
85 # define OCSP_TRUSTOTHER 0x200
86 # define OCSP_RESPID_KEY 0x400
87 # define OCSP_NOTIME 0x800
88 # define OCSP_PARTIAL_CHAIN 0x1000
90 typedef struct ocsp_cert_id_st OCSP_CERTID;
91 typedef struct ocsp_one_request_st OCSP_ONEREQ;
92 typedef struct ocsp_req_info_st OCSP_REQINFO;
93 typedef struct ocsp_signature_st OCSP_SIGNATURE;
94 typedef struct ocsp_request_st OCSP_REQUEST;
97 generate_stack_macros("OCSP_CERTID")
98 .generate_stack_macros("OCSP_ONEREQ");
101 # define OCSP_RESPONSE_STATUS_SUCCESSFUL 0
102 # define OCSP_RESPONSE_STATUS_MALFORMEDREQUEST 1
103 # define OCSP_RESPONSE_STATUS_INTERNALERROR 2
104 # define OCSP_RESPONSE_STATUS_TRYLATER 3
105 # define OCSP_RESPONSE_STATUS_SIGREQUIRED 5
106 # define OCSP_RESPONSE_STATUS_UNAUTHORIZED 6
108 typedef struct ocsp_resp_bytes_st OCSP_RESPBYTES;
110 # define V_OCSP_RESPID_NAME 0
111 # define V_OCSP_RESPID_KEY 1
114 generate_stack_macros("OCSP_RESPID");
117 typedef struct ocsp_revoked_info_st OCSP_REVOKEDINFO;
119 # define V_OCSP_CERTSTATUS_GOOD 0
120 # define V_OCSP_CERTSTATUS_REVOKED 1
121 # define V_OCSP_CERTSTATUS_UNKNOWN 2
123 typedef struct ocsp_cert_status_st OCSP_CERTSTATUS;
124 typedef struct ocsp_single_response_st OCSP_SINGLERESP;
127 generate_stack_macros("OCSP_SINGLERESP");
130 typedef struct ocsp_response_data_st OCSP_RESPDATA;
132 typedef struct ocsp_basic_response_st OCSP_BASICRESP;
134 typedef struct ocsp_crl_id_st OCSP_CRLID;
135 typedef struct ocsp_service_locator_st OCSP_SERVICELOC;
137 # define PEM_STRING_OCSP_REQUEST "OCSP REQUEST"
138 # define PEM_STRING_OCSP_RESPONSE "OCSP RESPONSE"
140 # define d2i_OCSP_REQUEST_bio(bp,p) ASN1_d2i_bio_of(OCSP_REQUEST,OCSP_REQUEST_new,d2i_OCSP_REQUEST,bp,p)
142 # define d2i_OCSP_RESPONSE_bio(bp,p) ASN1_d2i_bio_of(OCSP_RESPONSE,OCSP_RESPONSE_new,d2i_OCSP_RESPONSE,bp,p)
144 # define PEM_read_bio_OCSP_REQUEST(bp,x,cb) (OCSP_REQUEST *)PEM_ASN1_read_bio( \
145 (char *(*)())d2i_OCSP_REQUEST,PEM_STRING_OCSP_REQUEST, \
146 bp,(char **)(x),cb,NULL)
148 # define PEM_read_bio_OCSP_RESPONSE(bp,x,cb) (OCSP_RESPONSE *)PEM_ASN1_read_bio(\
149 (char *(*)())d2i_OCSP_RESPONSE,PEM_STRING_OCSP_RESPONSE, \
150 bp,(char **)(x),cb,NULL)
152 # define PEM_write_bio_OCSP_REQUEST(bp,o) \
153 PEM_ASN1_write_bio((int (*)())i2d_OCSP_REQUEST,PEM_STRING_OCSP_REQUEST,\
154 bp,(char *)(o), NULL,NULL,0,NULL,NULL)
156 # define PEM_write_bio_OCSP_RESPONSE(bp,o) \
157 PEM_ASN1_write_bio((int (*)())i2d_OCSP_RESPONSE,PEM_STRING_OCSP_RESPONSE,\
158 bp,(char *)(o), NULL,NULL,0,NULL,NULL)
160 # define i2d_OCSP_RESPONSE_bio(bp,o) ASN1_i2d_bio_of(OCSP_RESPONSE,i2d_OCSP_RESPONSE,bp,o)
162 # define i2d_OCSP_REQUEST_bio(bp,o) ASN1_i2d_bio_of(OCSP_REQUEST,i2d_OCSP_REQUEST,bp,o)
164 # define ASN1_BIT_STRING_digest(data,type,md,len) \
165 ASN1_item_digest(ASN1_ITEM_rptr(ASN1_BIT_STRING),type,data,md,len)
167 # define OCSP_CERTSTATUS_dup(cs)\
168 (OCSP_CERTSTATUS*)ASN1_dup((i2d_of_void *)i2d_OCSP_CERTSTATUS,\
169 (d2i_of_void *)d2i_OCSP_CERTSTATUS,(char *)(cs))
171 DECLARE_ASN1_DUP_FUNCTION(OCSP_CERTID)
173 OCSP_RESPONSE *OCSP_sendreq_bio(BIO *b, const char *path, OCSP_REQUEST *req);
174 OSSL_HTTP_REQ_CTX *OCSP_sendreq_new(BIO *io, const char *path,
175 const OCSP_REQUEST *req, int maxline);
176 int OCSP_sendreq_nbio(OCSP_RESPONSE **presp, OSSL_HTTP_REQ_CTX *rctx);
178 # ifndef OPENSSL_NO_DEPRECATED_3_0
179 typedef OSSL_HTTP_REQ_CTX OCSP_REQ_CTX;
180 # define OCSP_REQ_CTX_new(io, maxline) \
181 OSSL_HTTP_REQ_CTX_new(io, io, 1, maxline, 0, 0, NULL, 1)
182 # define OCSP_REQ_CTX_free(r) \
183 OSSL_HTTP_REQ_CTX_free(r)
184 # define OCSP_REQ_CTX_http(rctx, op, path) \
185 OSSL_HTTP_REQ_CTX_set_request_line(rctx, NULL, NULL, path)
186 # define OCSP_REQ_CTX_add1_header(r, n, v) \
187 OSSL_HTTP_REQ_CTX_add1_header(r, n, v)
188 # define OCSP_REQ_CTX_i2d(r, i, req) \
189 OSSL_HTTP_REQ_CTX_i2d(r, "application/ocsp-request", i, req)
190 # define OCSP_REQ_CTX_nbio(r) \
191 OSSL_HTTP_REQ_CTX_nbio(r)
192 # define OCSP_REQ_CTX_nbio_d2i(r, p, i) \
193 ((*(p) = OSSL_HTTP_REQ_CTX_sendreq_d2i(r, i)) != NULL)
194 # define OCSP_REQ_CTX_get0_mem_bio(r) \
195 OSSL_HTTP_REQ_CTX_get0_mem_bio(r)
196 # define OCSP_set_max_response_length(r, l) \
197 OSSL_HTTP_REQ_CTX_set_max_response_length(r, l)
198 # define OCSP_REQ_CTX_set1_req(r, req) \
199 OCSP_REQ_CTX_i2d(r, ASN1_ITEM_rptr(OCSP_REQUEST), (ASN1_VALUE *)(req))
202 OCSP_CERTID *OCSP_cert_to_id(const EVP_MD *dgst, const X509 *subject,
205 OCSP_CERTID *OCSP_cert_id_new(const EVP_MD *dgst,
206 const X509_NAME *issuerName,
207 const ASN1_BIT_STRING *issuerKey,
208 const ASN1_INTEGER *serialNumber);
210 OCSP_ONEREQ *OCSP_request_add0_id(OCSP_REQUEST *req, OCSP_CERTID *cid);
212 int OCSP_request_add1_nonce(OCSP_REQUEST *req, unsigned char *val, int len);
213 int OCSP_basic_add1_nonce(OCSP_BASICRESP *resp, unsigned char *val, int len);
214 int OCSP_check_nonce(OCSP_REQUEST *req, OCSP_BASICRESP *bs);
215 int OCSP_copy_nonce(OCSP_BASICRESP *resp, OCSP_REQUEST *req);
217 int OCSP_request_set1_name(OCSP_REQUEST *req, const X509_NAME *nm);
218 int OCSP_request_add1_cert(OCSP_REQUEST *req, X509 *cert);
220 int OCSP_request_sign(OCSP_REQUEST *req,
224 STACK_OF(X509) *certs, unsigned long flags);
226 int OCSP_response_status(OCSP_RESPONSE *resp);
227 OCSP_BASICRESP *OCSP_response_get1_basic(OCSP_RESPONSE *resp);
229 const ASN1_OCTET_STRING *OCSP_resp_get0_signature(const OCSP_BASICRESP *bs);
230 const X509_ALGOR *OCSP_resp_get0_tbs_sigalg(const OCSP_BASICRESP *bs);
231 const OCSP_RESPDATA *OCSP_resp_get0_respdata(const OCSP_BASICRESP *bs);
232 int OCSP_resp_get0_signer(OCSP_BASICRESP *bs, X509 **signer,
233 STACK_OF(X509) *extra_certs);
235 int OCSP_resp_count(OCSP_BASICRESP *bs);
236 OCSP_SINGLERESP *OCSP_resp_get0(OCSP_BASICRESP *bs, int idx);
237 const ASN1_GENERALIZEDTIME *OCSP_resp_get0_produced_at(const OCSP_BASICRESP* bs);
238 const STACK_OF(X509) *OCSP_resp_get0_certs(const OCSP_BASICRESP *bs);
239 int OCSP_resp_get0_id(const OCSP_BASICRESP *bs,
240 const ASN1_OCTET_STRING **pid,
241 const X509_NAME **pname);
242 int OCSP_resp_get1_id(const OCSP_BASICRESP *bs,
243 ASN1_OCTET_STRING **pid,
246 int OCSP_resp_find(OCSP_BASICRESP *bs, OCSP_CERTID *id, int last);
247 int OCSP_single_get0_status(OCSP_SINGLERESP *single, int *reason,
248 ASN1_GENERALIZEDTIME **revtime,
249 ASN1_GENERALIZEDTIME **thisupd,
250 ASN1_GENERALIZEDTIME **nextupd);
251 int OCSP_resp_find_status(OCSP_BASICRESP *bs, OCSP_CERTID *id, int *status,
253 ASN1_GENERALIZEDTIME **revtime,
254 ASN1_GENERALIZEDTIME **thisupd,
255 ASN1_GENERALIZEDTIME **nextupd);
256 int OCSP_check_validity(ASN1_GENERALIZEDTIME *thisupd,
257 ASN1_GENERALIZEDTIME *nextupd, long sec, long maxsec);
259 int OCSP_request_verify(OCSP_REQUEST *req, STACK_OF(X509) *certs,
260 X509_STORE *store, unsigned long flags);
262 # define OCSP_parse_url(url, host, port, path, ssl) \
263 OSSL_HTTP_parse_url(url, ssl, NULL, host, port, NULL, path, NULL, NULL)
265 int OCSP_id_issuer_cmp(const OCSP_CERTID *a, const OCSP_CERTID *b);
266 int OCSP_id_cmp(const OCSP_CERTID *a, const OCSP_CERTID *b);
268 int OCSP_request_onereq_count(OCSP_REQUEST *req);
269 OCSP_ONEREQ *OCSP_request_onereq_get0(OCSP_REQUEST *req, int i);
270 OCSP_CERTID *OCSP_onereq_get0_id(OCSP_ONEREQ *one);
271 int OCSP_id_get0_info(ASN1_OCTET_STRING **piNameHash, ASN1_OBJECT **pmd,
272 ASN1_OCTET_STRING **pikeyHash,
273 ASN1_INTEGER **pserial, OCSP_CERTID *cid);
274 int OCSP_request_is_signed(OCSP_REQUEST *req);
275 OCSP_RESPONSE *OCSP_response_create(int status, OCSP_BASICRESP *bs);
276 OCSP_SINGLERESP *OCSP_basic_add1_status(OCSP_BASICRESP *rsp,
278 int status, int reason,
282 int OCSP_basic_add1_cert(OCSP_BASICRESP *resp, X509 *cert);
283 int OCSP_basic_sign(OCSP_BASICRESP *brsp,
284 X509 *signer, EVP_PKEY *key, const EVP_MD *dgst,
285 STACK_OF(X509) *certs, unsigned long flags);
286 int OCSP_basic_sign_ctx(OCSP_BASICRESP *brsp,
287 X509 *signer, EVP_MD_CTX *ctx,
288 STACK_OF(X509) *certs, unsigned long flags);
289 int OCSP_RESPID_set_by_name(OCSP_RESPID *respid, X509 *cert);
290 int OCSP_RESPID_set_by_key_ex(OCSP_RESPID *respid, X509 *cert,
291 OSSL_LIB_CTX *libctx, const char *propq);
292 int OCSP_RESPID_set_by_key(OCSP_RESPID *respid, X509 *cert);
293 int OCSP_RESPID_match_ex(OCSP_RESPID *respid, X509 *cert, OSSL_LIB_CTX *libctx,
295 int OCSP_RESPID_match(OCSP_RESPID *respid, X509 *cert);
297 X509_EXTENSION *OCSP_crlID_new(const char *url, long *n, char *tim);
299 X509_EXTENSION *OCSP_accept_responses_new(char **oids);
301 X509_EXTENSION *OCSP_archive_cutoff_new(char *tim);
303 X509_EXTENSION *OCSP_url_svcloc_new(const X509_NAME *issuer, const char **urls);
305 int OCSP_REQUEST_get_ext_count(OCSP_REQUEST *x);
306 int OCSP_REQUEST_get_ext_by_NID(OCSP_REQUEST *x, int nid, int lastpos);
307 int OCSP_REQUEST_get_ext_by_OBJ(OCSP_REQUEST *x, const ASN1_OBJECT *obj,
309 int OCSP_REQUEST_get_ext_by_critical(OCSP_REQUEST *x, int crit, int lastpos);
310 X509_EXTENSION *OCSP_REQUEST_get_ext(OCSP_REQUEST *x, int loc);
311 X509_EXTENSION *OCSP_REQUEST_delete_ext(OCSP_REQUEST *x, int loc);
312 void *OCSP_REQUEST_get1_ext_d2i(OCSP_REQUEST *x, int nid, int *crit,
314 int OCSP_REQUEST_add1_ext_i2d(OCSP_REQUEST *x, int nid, void *value, int crit,
315 unsigned long flags);
316 int OCSP_REQUEST_add_ext(OCSP_REQUEST *x, X509_EXTENSION *ex, int loc);
318 int OCSP_ONEREQ_get_ext_count(OCSP_ONEREQ *x);
319 int OCSP_ONEREQ_get_ext_by_NID(OCSP_ONEREQ *x, int nid, int lastpos);
320 int OCSP_ONEREQ_get_ext_by_OBJ(OCSP_ONEREQ *x, const ASN1_OBJECT *obj, int lastpos);
321 int OCSP_ONEREQ_get_ext_by_critical(OCSP_ONEREQ *x, int crit, int lastpos);
322 X509_EXTENSION *OCSP_ONEREQ_get_ext(OCSP_ONEREQ *x, int loc);
323 X509_EXTENSION *OCSP_ONEREQ_delete_ext(OCSP_ONEREQ *x, int loc);
324 void *OCSP_ONEREQ_get1_ext_d2i(OCSP_ONEREQ *x, int nid, int *crit, int *idx);
325 int OCSP_ONEREQ_add1_ext_i2d(OCSP_ONEREQ *x, int nid, void *value, int crit,
326 unsigned long flags);
327 int OCSP_ONEREQ_add_ext(OCSP_ONEREQ *x, X509_EXTENSION *ex, int loc);
329 int OCSP_BASICRESP_get_ext_count(OCSP_BASICRESP *x);
330 int OCSP_BASICRESP_get_ext_by_NID(OCSP_BASICRESP *x, int nid, int lastpos);
331 int OCSP_BASICRESP_get_ext_by_OBJ(OCSP_BASICRESP *x, const ASN1_OBJECT *obj,
333 int OCSP_BASICRESP_get_ext_by_critical(OCSP_BASICRESP *x, int crit,
335 X509_EXTENSION *OCSP_BASICRESP_get_ext(OCSP_BASICRESP *x, int loc);
336 X509_EXTENSION *OCSP_BASICRESP_delete_ext(OCSP_BASICRESP *x, int loc);
337 void *OCSP_BASICRESP_get1_ext_d2i(OCSP_BASICRESP *x, int nid, int *crit,
339 int OCSP_BASICRESP_add1_ext_i2d(OCSP_BASICRESP *x, int nid, void *value,
340 int crit, unsigned long flags);
341 int OCSP_BASICRESP_add_ext(OCSP_BASICRESP *x, X509_EXTENSION *ex, int loc);
343 int OCSP_SINGLERESP_get_ext_count(OCSP_SINGLERESP *x);
344 int OCSP_SINGLERESP_get_ext_by_NID(OCSP_SINGLERESP *x, int nid, int lastpos);
345 int OCSP_SINGLERESP_get_ext_by_OBJ(OCSP_SINGLERESP *x, const ASN1_OBJECT *obj,
347 int OCSP_SINGLERESP_get_ext_by_critical(OCSP_SINGLERESP *x, int crit,
349 X509_EXTENSION *OCSP_SINGLERESP_get_ext(OCSP_SINGLERESP *x, int loc);
350 X509_EXTENSION *OCSP_SINGLERESP_delete_ext(OCSP_SINGLERESP *x, int loc);
351 void *OCSP_SINGLERESP_get1_ext_d2i(OCSP_SINGLERESP *x, int nid, int *crit,
353 int OCSP_SINGLERESP_add1_ext_i2d(OCSP_SINGLERESP *x, int nid, void *value,
354 int crit, unsigned long flags);
355 int OCSP_SINGLERESP_add_ext(OCSP_SINGLERESP *x, X509_EXTENSION *ex, int loc);
356 const OCSP_CERTID *OCSP_SINGLERESP_get0_id(const OCSP_SINGLERESP *x);
358 DECLARE_ASN1_FUNCTIONS(OCSP_SINGLERESP)
359 DECLARE_ASN1_FUNCTIONS(OCSP_CERTSTATUS)
360 DECLARE_ASN1_FUNCTIONS(OCSP_REVOKEDINFO)
361 DECLARE_ASN1_FUNCTIONS(OCSP_BASICRESP)
362 DECLARE_ASN1_FUNCTIONS(OCSP_RESPDATA)
363 DECLARE_ASN1_FUNCTIONS(OCSP_RESPID)
364 DECLARE_ASN1_FUNCTIONS(OCSP_RESPONSE)
365 DECLARE_ASN1_FUNCTIONS(OCSP_RESPBYTES)
366 DECLARE_ASN1_FUNCTIONS(OCSP_ONEREQ)
367 DECLARE_ASN1_FUNCTIONS(OCSP_CERTID)
368 DECLARE_ASN1_FUNCTIONS(OCSP_REQUEST)
369 DECLARE_ASN1_FUNCTIONS(OCSP_SIGNATURE)
370 DECLARE_ASN1_FUNCTIONS(OCSP_REQINFO)
371 DECLARE_ASN1_FUNCTIONS(OCSP_CRLID)
372 DECLARE_ASN1_FUNCTIONS(OCSP_SERVICELOC)
374 const char *OCSP_response_status_str(long s);
375 const char *OCSP_cert_status_str(long s);
376 const char *OCSP_crl_reason_str(long s);
378 int OCSP_REQUEST_print(BIO *bp, OCSP_REQUEST *a, unsigned long flags);
379 int OCSP_RESPONSE_print(BIO *bp, OCSP_RESPONSE *o, unsigned long flags);
381 int OCSP_basic_verify(OCSP_BASICRESP *bs, STACK_OF(X509) *certs,
382 X509_STORE *st, unsigned long flags);
388 # endif /* !defined(OPENSSL_NO_OCSP) */