2 * Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (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
11 # define HEADER_OCSP_H
13 #include <openssl/opensslconf.h>
16 * These definitions are outside the OPENSSL_NO_OCSP guard because although for
17 * historical reasons they have OCSP_* names, they can actually be used
18 * independently of OCSP. E.g. see RFC5280
21 * CRLReason ::= ENUMERATED {
25 * affiliationChanged (3),
27 * cessationOfOperation (5),
28 * certificateHold (6),
31 # define OCSP_REVOKED_STATUS_NOSTATUS -1
32 # define OCSP_REVOKED_STATUS_UNSPECIFIED 0
33 # define OCSP_REVOKED_STATUS_KEYCOMPROMISE 1
34 # define OCSP_REVOKED_STATUS_CACOMPROMISE 2
35 # define OCSP_REVOKED_STATUS_AFFILIATIONCHANGED 3
36 # define OCSP_REVOKED_STATUS_SUPERSEDED 4
37 # define OCSP_REVOKED_STATUS_CESSATIONOFOPERATION 5
38 # define OCSP_REVOKED_STATUS_CERTIFICATEHOLD 6
39 # define OCSP_REVOKED_STATUS_REMOVEFROMCRL 8
42 # ifndef OPENSSL_NO_OCSP
44 # include <openssl/ossl_typ.h>
45 # include <openssl/x509.h>
46 # include <openssl/x509v3.h>
47 # include <openssl/safestack.h>
53 /* Various flags and values */
55 # define OCSP_DEFAULT_NONCE_LENGTH 16
57 # define OCSP_NOCERTS 0x1
58 # define OCSP_NOINTERN 0x2
59 # define OCSP_NOSIGS 0x4
60 # define OCSP_NOCHAIN 0x8
61 # define OCSP_NOVERIFY 0x10
62 # define OCSP_NOEXPLICIT 0x20
63 # define OCSP_NOCASIGN 0x40
64 # define OCSP_NODELEGATED 0x80
65 # define OCSP_NOCHECKS 0x100
66 # define OCSP_TRUSTOTHER 0x200
67 # define OCSP_RESPID_KEY 0x400
68 # define OCSP_NOTIME 0x800
70 typedef struct ocsp_cert_id_st OCSP_CERTID;
72 DEFINE_STACK_OF(OCSP_CERTID)
74 typedef struct ocsp_one_request_st OCSP_ONEREQ;
76 DEFINE_STACK_OF(OCSP_ONEREQ)
78 typedef struct ocsp_req_info_st OCSP_REQINFO;
79 typedef struct ocsp_signature_st OCSP_SIGNATURE;
80 typedef struct ocsp_request_st OCSP_REQUEST;
82 # define OCSP_RESPONSE_STATUS_SUCCESSFUL 0
83 # define OCSP_RESPONSE_STATUS_MALFORMEDREQUEST 1
84 # define OCSP_RESPONSE_STATUS_INTERNALERROR 2
85 # define OCSP_RESPONSE_STATUS_TRYLATER 3
86 # define OCSP_RESPONSE_STATUS_SIGREQUIRED 5
87 # define OCSP_RESPONSE_STATUS_UNAUTHORIZED 6
89 typedef struct ocsp_resp_bytes_st OCSP_RESPBYTES;
91 # define V_OCSP_RESPID_NAME 0
92 # define V_OCSP_RESPID_KEY 1
94 DEFINE_STACK_OF(OCSP_RESPID)
95 DECLARE_ASN1_FUNCTIONS(OCSP_RESPID)
97 typedef struct ocsp_revoked_info_st OCSP_REVOKEDINFO;
99 # define V_OCSP_CERTSTATUS_GOOD 0
100 # define V_OCSP_CERTSTATUS_REVOKED 1
101 # define V_OCSP_CERTSTATUS_UNKNOWN 2
103 typedef struct ocsp_cert_status_st OCSP_CERTSTATUS;
104 typedef struct ocsp_single_response_st OCSP_SINGLERESP;
106 DEFINE_STACK_OF(OCSP_SINGLERESP)
108 typedef struct ocsp_response_data_st OCSP_RESPDATA;
110 typedef struct ocsp_basic_response_st OCSP_BASICRESP;
112 typedef struct ocsp_crl_id_st OCSP_CRLID;
113 typedef struct ocsp_service_locator_st OCSP_SERVICELOC;
115 # define PEM_STRING_OCSP_REQUEST "OCSP REQUEST"
116 # define PEM_STRING_OCSP_RESPONSE "OCSP RESPONSE"
118 # define d2i_OCSP_REQUEST_bio(bp,p) ASN1_d2i_bio_of(OCSP_REQUEST,OCSP_REQUEST_new,d2i_OCSP_REQUEST,bp,p)
120 # define d2i_OCSP_RESPONSE_bio(bp,p) ASN1_d2i_bio_of(OCSP_RESPONSE,OCSP_RESPONSE_new,d2i_OCSP_RESPONSE,bp,p)
122 # define PEM_read_bio_OCSP_REQUEST(bp,x,cb) (OCSP_REQUEST *)PEM_ASN1_read_bio( \
123 (char *(*)())d2i_OCSP_REQUEST,PEM_STRING_OCSP_REQUEST,bp,(char **)x,cb,NULL)
125 # define PEM_read_bio_OCSP_RESPONSE(bp,x,cb)(OCSP_RESPONSE *)PEM_ASN1_read_bio(\
126 (char *(*)())d2i_OCSP_RESPONSE,PEM_STRING_OCSP_RESPONSE,bp,(char **)x,cb,NULL)
128 # define PEM_write_bio_OCSP_REQUEST(bp,o) \
129 PEM_ASN1_write_bio((int (*)())i2d_OCSP_REQUEST,PEM_STRING_OCSP_REQUEST,\
130 bp,(char *)o, NULL,NULL,0,NULL,NULL)
132 # define PEM_write_bio_OCSP_RESPONSE(bp,o) \
133 PEM_ASN1_write_bio((int (*)())i2d_OCSP_RESPONSE,PEM_STRING_OCSP_RESPONSE,\
134 bp,(char *)o, NULL,NULL,0,NULL,NULL)
136 # define i2d_OCSP_RESPONSE_bio(bp,o) ASN1_i2d_bio_of(OCSP_RESPONSE,i2d_OCSP_RESPONSE,bp,o)
138 # define i2d_OCSP_REQUEST_bio(bp,o) ASN1_i2d_bio_of(OCSP_REQUEST,i2d_OCSP_REQUEST,bp,o)
140 # define OCSP_REQUEST_sign(o,pkey,md) \
141 ASN1_item_sign(ASN1_ITEM_rptr(OCSP_REQINFO),\
142 &o->optionalSignature->signatureAlgorithm,NULL,\
143 o->optionalSignature->signature,&o->tbsRequest,pkey,md)
145 # define OCSP_BASICRESP_sign(o,pkey,md,d) \
146 ASN1_item_sign(ASN1_ITEM_rptr(OCSP_RESPDATA),&o->signatureAlgorithm,NULL,\
147 o->signature,&o->tbsResponseData,pkey,md)
149 # define OCSP_REQUEST_verify(a,r) ASN1_item_verify(ASN1_ITEM_rptr(OCSP_REQINFO),\
150 &a->optionalSignature->signatureAlgorithm,\
151 a->optionalSignature->signature,&a->tbsRequest,r)
153 # define OCSP_BASICRESP_verify(a,r,d) ASN1_item_verify(ASN1_ITEM_rptr(OCSP_RESPDATA),\
154 &a->signatureAlgorithm,a->signature,&a->tbsResponseData,r)
156 # define ASN1_BIT_STRING_digest(data,type,md,len) \
157 ASN1_item_digest(ASN1_ITEM_rptr(ASN1_BIT_STRING),type,data,md,len)
159 # define OCSP_CERTSTATUS_dup(cs)\
160 (OCSP_CERTSTATUS*)ASN1_dup((int(*)())i2d_OCSP_CERTSTATUS,\
161 (char *(*)())d2i_OCSP_CERTSTATUS,(char *)(cs))
163 OCSP_CERTID *OCSP_CERTID_dup(OCSP_CERTID *id);
165 OCSP_RESPONSE *OCSP_sendreq_bio(BIO *b, const char *path, OCSP_REQUEST *req);
166 OCSP_REQ_CTX *OCSP_sendreq_new(BIO *io, const char *path, OCSP_REQUEST *req,
168 int OCSP_REQ_CTX_nbio(OCSP_REQ_CTX *rctx);
169 int OCSP_sendreq_nbio(OCSP_RESPONSE **presp, OCSP_REQ_CTX *rctx);
170 OCSP_REQ_CTX *OCSP_REQ_CTX_new(BIO *io, int maxline);
171 void OCSP_REQ_CTX_free(OCSP_REQ_CTX *rctx);
172 void OCSP_set_max_response_length(OCSP_REQ_CTX *rctx, unsigned long len);
173 int OCSP_REQ_CTX_i2d(OCSP_REQ_CTX *rctx, const ASN1_ITEM *it,
175 int OCSP_REQ_CTX_nbio_d2i(OCSP_REQ_CTX *rctx, ASN1_VALUE **pval,
176 const ASN1_ITEM *it);
177 BIO *OCSP_REQ_CTX_get0_mem_bio(OCSP_REQ_CTX *rctx);
178 int OCSP_REQ_CTX_i2d(OCSP_REQ_CTX *rctx, const ASN1_ITEM *it,
180 int OCSP_REQ_CTX_http(OCSP_REQ_CTX *rctx, const char *op, const char *path);
181 int OCSP_REQ_CTX_set1_req(OCSP_REQ_CTX *rctx, OCSP_REQUEST *req);
182 int OCSP_REQ_CTX_add1_header(OCSP_REQ_CTX *rctx,
183 const char *name, const char *value);
185 OCSP_CERTID *OCSP_cert_to_id(const EVP_MD *dgst, const X509 *subject,
188 OCSP_CERTID *OCSP_cert_id_new(const EVP_MD *dgst,
189 const X509_NAME *issuerName,
190 const ASN1_BIT_STRING *issuerKey,
191 const ASN1_INTEGER *serialNumber);
193 OCSP_ONEREQ *OCSP_request_add0_id(OCSP_REQUEST *req, OCSP_CERTID *cid);
195 int OCSP_request_add1_nonce(OCSP_REQUEST *req, unsigned char *val, int len);
196 int OCSP_basic_add1_nonce(OCSP_BASICRESP *resp, unsigned char *val, int len);
197 int OCSP_check_nonce(OCSP_REQUEST *req, OCSP_BASICRESP *bs);
198 int OCSP_copy_nonce(OCSP_BASICRESP *resp, OCSP_REQUEST *req);
200 int OCSP_request_set1_name(OCSP_REQUEST *req, X509_NAME *nm);
201 int OCSP_request_add1_cert(OCSP_REQUEST *req, X509 *cert);
203 int OCSP_request_sign(OCSP_REQUEST *req,
207 STACK_OF(X509) *certs, unsigned long flags);
209 int OCSP_response_status(OCSP_RESPONSE *resp);
210 OCSP_BASICRESP *OCSP_response_get1_basic(OCSP_RESPONSE *resp);
212 const ASN1_OCTET_STRING *OCSP_resp_get0_signature(const OCSP_BASICRESP *bs);
214 int OCSP_resp_count(OCSP_BASICRESP *bs);
215 OCSP_SINGLERESP *OCSP_resp_get0(OCSP_BASICRESP *bs, int idx);
216 const ASN1_GENERALIZEDTIME *OCSP_resp_get0_produced_at(const OCSP_BASICRESP* bs);
217 const STACK_OF(X509) *OCSP_resp_get0_certs(const OCSP_BASICRESP *bs);
218 int OCSP_resp_get0_id(const OCSP_BASICRESP *bs,
219 const ASN1_OCTET_STRING **pid,
220 const X509_NAME **pname);
222 int OCSP_resp_find(OCSP_BASICRESP *bs, OCSP_CERTID *id, int last);
223 int OCSP_single_get0_status(OCSP_SINGLERESP *single, int *reason,
224 ASN1_GENERALIZEDTIME **revtime,
225 ASN1_GENERALIZEDTIME **thisupd,
226 ASN1_GENERALIZEDTIME **nextupd);
227 int OCSP_resp_find_status(OCSP_BASICRESP *bs, OCSP_CERTID *id, int *status,
229 ASN1_GENERALIZEDTIME **revtime,
230 ASN1_GENERALIZEDTIME **thisupd,
231 ASN1_GENERALIZEDTIME **nextupd);
232 int OCSP_check_validity(ASN1_GENERALIZEDTIME *thisupd,
233 ASN1_GENERALIZEDTIME *nextupd, long sec, long maxsec);
235 int OCSP_request_verify(OCSP_REQUEST *req, STACK_OF(X509) *certs,
236 X509_STORE *store, unsigned long flags);
238 int OCSP_parse_url(const char *url, char **phost, char **pport, char **ppath,
241 int OCSP_id_issuer_cmp(OCSP_CERTID *a, OCSP_CERTID *b);
242 int OCSP_id_cmp(OCSP_CERTID *a, OCSP_CERTID *b);
244 int OCSP_request_onereq_count(OCSP_REQUEST *req);
245 OCSP_ONEREQ *OCSP_request_onereq_get0(OCSP_REQUEST *req, int i);
246 OCSP_CERTID *OCSP_onereq_get0_id(OCSP_ONEREQ *one);
247 int OCSP_id_get0_info(ASN1_OCTET_STRING **piNameHash, ASN1_OBJECT **pmd,
248 ASN1_OCTET_STRING **pikeyHash,
249 ASN1_INTEGER **pserial, OCSP_CERTID *cid);
250 int OCSP_request_is_signed(OCSP_REQUEST *req);
251 OCSP_RESPONSE *OCSP_response_create(int status, OCSP_BASICRESP *bs);
252 OCSP_SINGLERESP *OCSP_basic_add1_status(OCSP_BASICRESP *rsp,
254 int status, int reason,
258 int OCSP_basic_add1_cert(OCSP_BASICRESP *resp, X509 *cert);
259 int OCSP_basic_sign(OCSP_BASICRESP *brsp,
260 X509 *signer, EVP_PKEY *key, const EVP_MD *dgst,
261 STACK_OF(X509) *certs, unsigned long flags);
262 int OCSP_RESPID_set_by_name(OCSP_RESPID *respid, X509 *cert);
263 int OCSP_RESPID_set_by_key(OCSP_RESPID *respid, X509 *cert);
264 int OCSP_RESPID_match(OCSP_RESPID *respid, X509 *cert);
266 X509_EXTENSION *OCSP_crlID_new(const char *url, long *n, char *tim);
268 X509_EXTENSION *OCSP_accept_responses_new(char **oids);
270 X509_EXTENSION *OCSP_archive_cutoff_new(char *tim);
272 X509_EXTENSION *OCSP_url_svcloc_new(X509_NAME *issuer, const char **urls);
274 int OCSP_REQUEST_get_ext_count(OCSP_REQUEST *x);
275 int OCSP_REQUEST_get_ext_by_NID(OCSP_REQUEST *x, int nid, int lastpos);
276 int OCSP_REQUEST_get_ext_by_OBJ(OCSP_REQUEST *x, const ASN1_OBJECT *obj,
278 int OCSP_REQUEST_get_ext_by_critical(OCSP_REQUEST *x, int crit, int lastpos);
279 X509_EXTENSION *OCSP_REQUEST_get_ext(OCSP_REQUEST *x, int loc);
280 X509_EXTENSION *OCSP_REQUEST_delete_ext(OCSP_REQUEST *x, int loc);
281 void *OCSP_REQUEST_get1_ext_d2i(OCSP_REQUEST *x, int nid, int *crit,
283 int OCSP_REQUEST_add1_ext_i2d(OCSP_REQUEST *x, int nid, void *value, int crit,
284 unsigned long flags);
285 int OCSP_REQUEST_add_ext(OCSP_REQUEST *x, X509_EXTENSION *ex, int loc);
287 int OCSP_ONEREQ_get_ext_count(OCSP_ONEREQ *x);
288 int OCSP_ONEREQ_get_ext_by_NID(OCSP_ONEREQ *x, int nid, int lastpos);
289 int OCSP_ONEREQ_get_ext_by_OBJ(OCSP_ONEREQ *x, const ASN1_OBJECT *obj, int lastpos);
290 int OCSP_ONEREQ_get_ext_by_critical(OCSP_ONEREQ *x, int crit, int lastpos);
291 X509_EXTENSION *OCSP_ONEREQ_get_ext(OCSP_ONEREQ *x, int loc);
292 X509_EXTENSION *OCSP_ONEREQ_delete_ext(OCSP_ONEREQ *x, int loc);
293 void *OCSP_ONEREQ_get1_ext_d2i(OCSP_ONEREQ *x, int nid, int *crit, int *idx);
294 int OCSP_ONEREQ_add1_ext_i2d(OCSP_ONEREQ *x, int nid, void *value, int crit,
295 unsigned long flags);
296 int OCSP_ONEREQ_add_ext(OCSP_ONEREQ *x, X509_EXTENSION *ex, int loc);
298 int OCSP_BASICRESP_get_ext_count(OCSP_BASICRESP *x);
299 int OCSP_BASICRESP_get_ext_by_NID(OCSP_BASICRESP *x, int nid, int lastpos);
300 int OCSP_BASICRESP_get_ext_by_OBJ(OCSP_BASICRESP *x, const ASN1_OBJECT *obj,
302 int OCSP_BASICRESP_get_ext_by_critical(OCSP_BASICRESP *x, int crit,
304 X509_EXTENSION *OCSP_BASICRESP_get_ext(OCSP_BASICRESP *x, int loc);
305 X509_EXTENSION *OCSP_BASICRESP_delete_ext(OCSP_BASICRESP *x, int loc);
306 void *OCSP_BASICRESP_get1_ext_d2i(OCSP_BASICRESP *x, int nid, int *crit,
308 int OCSP_BASICRESP_add1_ext_i2d(OCSP_BASICRESP *x, int nid, void *value,
309 int crit, unsigned long flags);
310 int OCSP_BASICRESP_add_ext(OCSP_BASICRESP *x, X509_EXTENSION *ex, int loc);
312 int OCSP_SINGLERESP_get_ext_count(OCSP_SINGLERESP *x);
313 int OCSP_SINGLERESP_get_ext_by_NID(OCSP_SINGLERESP *x, int nid, int lastpos);
314 int OCSP_SINGLERESP_get_ext_by_OBJ(OCSP_SINGLERESP *x, const ASN1_OBJECT *obj,
316 int OCSP_SINGLERESP_get_ext_by_critical(OCSP_SINGLERESP *x, int crit,
318 X509_EXTENSION *OCSP_SINGLERESP_get_ext(OCSP_SINGLERESP *x, int loc);
319 X509_EXTENSION *OCSP_SINGLERESP_delete_ext(OCSP_SINGLERESP *x, int loc);
320 void *OCSP_SINGLERESP_get1_ext_d2i(OCSP_SINGLERESP *x, int nid, int *crit,
322 int OCSP_SINGLERESP_add1_ext_i2d(OCSP_SINGLERESP *x, int nid, void *value,
323 int crit, unsigned long flags);
324 int OCSP_SINGLERESP_add_ext(OCSP_SINGLERESP *x, X509_EXTENSION *ex, int loc);
325 const OCSP_CERTID *OCSP_SINGLERESP_get0_id(const OCSP_SINGLERESP *x);
327 DECLARE_ASN1_FUNCTIONS(OCSP_SINGLERESP)
328 DECLARE_ASN1_FUNCTIONS(OCSP_CERTSTATUS)
329 DECLARE_ASN1_FUNCTIONS(OCSP_REVOKEDINFO)
330 DECLARE_ASN1_FUNCTIONS(OCSP_BASICRESP)
331 DECLARE_ASN1_FUNCTIONS(OCSP_RESPDATA)
332 DECLARE_ASN1_FUNCTIONS(OCSP_RESPID)
333 DECLARE_ASN1_FUNCTIONS(OCSP_RESPONSE)
334 DECLARE_ASN1_FUNCTIONS(OCSP_RESPBYTES)
335 DECLARE_ASN1_FUNCTIONS(OCSP_ONEREQ)
336 DECLARE_ASN1_FUNCTIONS(OCSP_CERTID)
337 DECLARE_ASN1_FUNCTIONS(OCSP_REQUEST)
338 DECLARE_ASN1_FUNCTIONS(OCSP_SIGNATURE)
339 DECLARE_ASN1_FUNCTIONS(OCSP_REQINFO)
340 DECLARE_ASN1_FUNCTIONS(OCSP_CRLID)
341 DECLARE_ASN1_FUNCTIONS(OCSP_SERVICELOC)
343 const char *OCSP_response_status_str(long s);
344 const char *OCSP_cert_status_str(long s);
345 const char *OCSP_crl_reason_str(long s);
347 int OCSP_REQUEST_print(BIO *bp, OCSP_REQUEST *a, unsigned long flags);
348 int OCSP_RESPONSE_print(BIO *bp, OCSP_RESPONSE *o, unsigned long flags);
350 int OCSP_basic_verify(OCSP_BASICRESP *bs, STACK_OF(X509) *certs,
351 X509_STORE *st, unsigned long flags);
353 /* BEGIN ERROR CODES */
355 * The following lines are auto generated by the script mkerr.pl. Any changes
356 * made after this point may be overwritten when the script is next run.
359 int ERR_load_OCSP_strings(void);
361 /* Error codes for the OCSP functions. */
363 /* Function codes. */
364 # define OCSP_F_D2I_OCSP_NONCE 102
365 # define OCSP_F_OCSP_BASIC_ADD1_STATUS 103
366 # define OCSP_F_OCSP_BASIC_SIGN 104
367 # define OCSP_F_OCSP_BASIC_VERIFY 105
368 # define OCSP_F_OCSP_CERT_ID_NEW 101
369 # define OCSP_F_OCSP_CHECK_DELEGATED 106
370 # define OCSP_F_OCSP_CHECK_IDS 107
371 # define OCSP_F_OCSP_CHECK_ISSUER 108
372 # define OCSP_F_OCSP_CHECK_VALIDITY 115
373 # define OCSP_F_OCSP_MATCH_ISSUERID 109
374 # define OCSP_F_OCSP_PARSE_URL 114
375 # define OCSP_F_OCSP_REQUEST_SIGN 110
376 # define OCSP_F_OCSP_REQUEST_VERIFY 116
377 # define OCSP_F_OCSP_RESPONSE_GET1_BASIC 111
378 # define OCSP_F_PARSE_HTTP_LINE1 118
381 # define OCSP_R_CERTIFICATE_VERIFY_ERROR 101
382 # define OCSP_R_DIGEST_ERR 102
383 # define OCSP_R_ERROR_IN_NEXTUPDATE_FIELD 122
384 # define OCSP_R_ERROR_IN_THISUPDATE_FIELD 123
385 # define OCSP_R_ERROR_PARSING_URL 121
386 # define OCSP_R_MISSING_OCSPSIGNING_USAGE 103
387 # define OCSP_R_NEXTUPDATE_BEFORE_THISUPDATE 124
388 # define OCSP_R_NOT_BASIC_RESPONSE 104
389 # define OCSP_R_NO_CERTIFICATES_IN_CHAIN 105
390 # define OCSP_R_NO_RESPONSE_DATA 108
391 # define OCSP_R_NO_REVOKED_TIME 109
392 # define OCSP_R_NO_SIGNER_KEY 130
393 # define OCSP_R_PRIVATE_KEY_DOES_NOT_MATCH_CERTIFICATE 110
394 # define OCSP_R_REQUEST_NOT_SIGNED 128
395 # define OCSP_R_RESPONSE_CONTAINS_NO_REVOCATION_DATA 111
396 # define OCSP_R_ROOT_CA_NOT_TRUSTED 112
397 # define OCSP_R_SERVER_RESPONSE_ERROR 114
398 # define OCSP_R_SERVER_RESPONSE_PARSE_ERROR 115
399 # define OCSP_R_SIGNATURE_FAILURE 117
400 # define OCSP_R_SIGNER_CERTIFICATE_NOT_FOUND 118
401 # define OCSP_R_STATUS_EXPIRED 125
402 # define OCSP_R_STATUS_NOT_YET_VALID 126
403 # define OCSP_R_STATUS_TOO_OLD 127
404 # define OCSP_R_UNKNOWN_MESSAGE_DIGEST 119
405 # define OCSP_R_UNKNOWN_NID 120
406 # define OCSP_R_UNSUPPORTED_REQUESTORNAME_TYPE 129