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>
48 # include <openssl/ocsperr.h>
54 /* Various flags and values */
56 # define OCSP_DEFAULT_NONCE_LENGTH 16
58 # define OCSP_NOCERTS 0x1
59 # define OCSP_NOINTERN 0x2
60 # define OCSP_NOSIGS 0x4
61 # define OCSP_NOCHAIN 0x8
62 # define OCSP_NOVERIFY 0x10
63 # define OCSP_NOEXPLICIT 0x20
64 # define OCSP_NOCASIGN 0x40
65 # define OCSP_NODELEGATED 0x80
66 # define OCSP_NOCHECKS 0x100
67 # define OCSP_TRUSTOTHER 0x200
68 # define OCSP_RESPID_KEY 0x400
69 # define OCSP_NOTIME 0x800
71 typedef struct ocsp_cert_id_st OCSP_CERTID
;
73 DEFINE_STACK_OF(OCSP_CERTID
)
75 typedef struct ocsp_one_request_st OCSP_ONEREQ
;
77 DEFINE_STACK_OF(OCSP_ONEREQ
)
79 typedef struct ocsp_req_info_st OCSP_REQINFO
;
80 typedef struct ocsp_signature_st OCSP_SIGNATURE
;
81 typedef struct ocsp_request_st OCSP_REQUEST
;
83 # define OCSP_RESPONSE_STATUS_SUCCESSFUL 0
84 # define OCSP_RESPONSE_STATUS_MALFORMEDREQUEST 1
85 # define OCSP_RESPONSE_STATUS_INTERNALERROR 2
86 # define OCSP_RESPONSE_STATUS_TRYLATER 3
87 # define OCSP_RESPONSE_STATUS_SIGREQUIRED 5
88 # define OCSP_RESPONSE_STATUS_UNAUTHORIZED 6
90 typedef struct ocsp_resp_bytes_st OCSP_RESPBYTES
;
92 # define V_OCSP_RESPID_NAME 0
93 # define V_OCSP_RESPID_KEY 1
95 DEFINE_STACK_OF(OCSP_RESPID
)
96 DECLARE_ASN1_FUNCTIONS(OCSP_RESPID
)
98 typedef struct ocsp_revoked_info_st OCSP_REVOKEDINFO
;
100 # define V_OCSP_CERTSTATUS_GOOD 0
101 # define V_OCSP_CERTSTATUS_REVOKED 1
102 # define V_OCSP_CERTSTATUS_UNKNOWN 2
104 typedef struct ocsp_cert_status_st OCSP_CERTSTATUS
;
105 typedef struct ocsp_single_response_st OCSP_SINGLERESP
;
107 DEFINE_STACK_OF(OCSP_SINGLERESP
)
109 typedef struct ocsp_response_data_st OCSP_RESPDATA
;
111 typedef struct ocsp_basic_response_st OCSP_BASICRESP
;
113 typedef struct ocsp_crl_id_st OCSP_CRLID
;
114 typedef struct ocsp_service_locator_st OCSP_SERVICELOC
;
116 # define PEM_STRING_OCSP_REQUEST "OCSP REQUEST"
117 # define PEM_STRING_OCSP_RESPONSE "OCSP RESPONSE"
119 # define d2i_OCSP_REQUEST_bio(bp,p) ASN1_d2i_bio_of(OCSP_REQUEST,OCSP_REQUEST_new,d2i_OCSP_REQUEST,bp,p)
121 # define d2i_OCSP_RESPONSE_bio(bp,p) ASN1_d2i_bio_of(OCSP_RESPONSE,OCSP_RESPONSE_new,d2i_OCSP_RESPONSE,bp,p)
123 # define PEM_read_bio_OCSP_REQUEST(bp,x,cb) (OCSP_REQUEST *)PEM_ASN1_read_bio( \
124 (char *(*)())d2i_OCSP_REQUEST,PEM_STRING_OCSP_REQUEST, \
125 bp,(char **)(x),cb,NULL)
127 # define PEM_read_bio_OCSP_RESPONSE(bp,x,cb)(OCSP_RESPONSE *)PEM_ASN1_read_bio(\
128 (char *(*)())d2i_OCSP_RESPONSE,PEM_STRING_OCSP_RESPONSE, \
129 bp,(char **)(x),cb,NULL)
131 # define PEM_write_bio_OCSP_REQUEST(bp,o) \
132 PEM_ASN1_write_bio((int (*)())i2d_OCSP_REQUEST,PEM_STRING_OCSP_REQUEST,\
133 bp,(char *)(o), NULL,NULL,0,NULL,NULL)
135 # define PEM_write_bio_OCSP_RESPONSE(bp,o) \
136 PEM_ASN1_write_bio((int (*)())i2d_OCSP_RESPONSE,PEM_STRING_OCSP_RESPONSE,\
137 bp,(char *)(o), NULL,NULL,0,NULL,NULL)
139 # define i2d_OCSP_RESPONSE_bio(bp,o) ASN1_i2d_bio_of(OCSP_RESPONSE,i2d_OCSP_RESPONSE,bp,o)
141 # define i2d_OCSP_REQUEST_bio(bp,o) ASN1_i2d_bio_of(OCSP_REQUEST,i2d_OCSP_REQUEST,bp,o)
143 # define OCSP_REQUEST_sign(o,pkey,md) \
144 ASN1_item_sign(ASN1_ITEM_rptr(OCSP_REQINFO),\
145 &(o)->optionalSignature->signatureAlgorithm,NULL,\
146 (o)->optionalSignature->signature,&(o)->tbsRequest,pkey,md)
148 # define OCSP_BASICRESP_sign(o,pkey,md,d) \
149 ASN1_item_sign(ASN1_ITEM_rptr(OCSP_RESPDATA),&(o)->signatureAlgorithm,\
150 NULL,(o)->signature,&(o)->tbsResponseData,pkey,md)
152 # define OCSP_REQUEST_verify(a,r) ASN1_item_verify(ASN1_ITEM_rptr(OCSP_REQINFO),\
153 &(a)->optionalSignature->signatureAlgorithm,\
154 (a)->optionalSignature->signature,&(a)->tbsRequest,r)
156 # define OCSP_BASICRESP_verify(a,r,d) ASN1_item_verify(ASN1_ITEM_rptr(OCSP_RESPDATA),\
157 &(a)->signatureAlgorithm,(a)->signature,&(a)->tbsResponseData,r)
159 # define ASN1_BIT_STRING_digest(data,type,md,len) \
160 ASN1_item_digest(ASN1_ITEM_rptr(ASN1_BIT_STRING),type,data,md,len)
162 # define OCSP_CERTSTATUS_dup(cs)\
163 (OCSP_CERTSTATUS*)ASN1_dup((int(*)())i2d_OCSP_CERTSTATUS,\
164 (char *(*)())d2i_OCSP_CERTSTATUS,(char *)(cs))
166 OCSP_CERTID
*OCSP_CERTID_dup(OCSP_CERTID
*id
);
168 OCSP_RESPONSE
*OCSP_sendreq_bio(BIO
*b
, const char *path
, OCSP_REQUEST
*req
);
169 OCSP_REQ_CTX
*OCSP_sendreq_new(BIO
*io
, const char *path
, OCSP_REQUEST
*req
,
171 int OCSP_REQ_CTX_nbio(OCSP_REQ_CTX
*rctx
);
172 int OCSP_sendreq_nbio(OCSP_RESPONSE
**presp
, OCSP_REQ_CTX
*rctx
);
173 OCSP_REQ_CTX
*OCSP_REQ_CTX_new(BIO
*io
, int maxline
);
174 void OCSP_REQ_CTX_free(OCSP_REQ_CTX
*rctx
);
175 void OCSP_set_max_response_length(OCSP_REQ_CTX
*rctx
, unsigned long len
);
176 int OCSP_REQ_CTX_i2d(OCSP_REQ_CTX
*rctx
, const ASN1_ITEM
*it
,
178 int OCSP_REQ_CTX_nbio_d2i(OCSP_REQ_CTX
*rctx
, ASN1_VALUE
**pval
,
179 const ASN1_ITEM
*it
);
180 BIO
*OCSP_REQ_CTX_get0_mem_bio(OCSP_REQ_CTX
*rctx
);
181 int OCSP_REQ_CTX_i2d(OCSP_REQ_CTX
*rctx
, const ASN1_ITEM
*it
,
183 int OCSP_REQ_CTX_http(OCSP_REQ_CTX
*rctx
, const char *op
, const char *path
);
184 int OCSP_REQ_CTX_set1_req(OCSP_REQ_CTX
*rctx
, OCSP_REQUEST
*req
);
185 int OCSP_REQ_CTX_add1_header(OCSP_REQ_CTX
*rctx
,
186 const char *name
, const char *value
);
188 OCSP_CERTID
*OCSP_cert_to_id(const EVP_MD
*dgst
, const X509
*subject
,
191 OCSP_CERTID
*OCSP_cert_id_new(const EVP_MD
*dgst
,
192 const X509_NAME
*issuerName
,
193 const ASN1_BIT_STRING
*issuerKey
,
194 const ASN1_INTEGER
*serialNumber
);
196 OCSP_ONEREQ
*OCSP_request_add0_id(OCSP_REQUEST
*req
, OCSP_CERTID
*cid
);
198 int OCSP_request_add1_nonce(OCSP_REQUEST
*req
, unsigned char *val
, int len
);
199 int OCSP_basic_add1_nonce(OCSP_BASICRESP
*resp
, unsigned char *val
, int len
);
200 int OCSP_check_nonce(OCSP_REQUEST
*req
, OCSP_BASICRESP
*bs
);
201 int OCSP_copy_nonce(OCSP_BASICRESP
*resp
, OCSP_REQUEST
*req
);
203 int OCSP_request_set1_name(OCSP_REQUEST
*req
, X509_NAME
*nm
);
204 int OCSP_request_add1_cert(OCSP_REQUEST
*req
, X509
*cert
);
206 int OCSP_request_sign(OCSP_REQUEST
*req
,
210 STACK_OF(X509
) *certs
, unsigned long flags
);
212 int OCSP_response_status(OCSP_RESPONSE
*resp
);
213 OCSP_BASICRESP
*OCSP_response_get1_basic(OCSP_RESPONSE
*resp
);
215 const ASN1_OCTET_STRING
*OCSP_resp_get0_signature(const OCSP_BASICRESP
*bs
);
217 int OCSP_resp_count(OCSP_BASICRESP
*bs
);
218 OCSP_SINGLERESP
*OCSP_resp_get0(OCSP_BASICRESP
*bs
, int idx
);
219 const ASN1_GENERALIZEDTIME
*OCSP_resp_get0_produced_at(const OCSP_BASICRESP
* bs
);
220 const STACK_OF(X509
) *OCSP_resp_get0_certs(const OCSP_BASICRESP
*bs
);
221 int OCSP_resp_get0_id(const OCSP_BASICRESP
*bs
,
222 const ASN1_OCTET_STRING
**pid
,
223 const X509_NAME
**pname
);
225 int OCSP_resp_find(OCSP_BASICRESP
*bs
, OCSP_CERTID
*id
, int last
);
226 int OCSP_single_get0_status(OCSP_SINGLERESP
*single
, int *reason
,
227 ASN1_GENERALIZEDTIME
**revtime
,
228 ASN1_GENERALIZEDTIME
**thisupd
,
229 ASN1_GENERALIZEDTIME
**nextupd
);
230 int OCSP_resp_find_status(OCSP_BASICRESP
*bs
, OCSP_CERTID
*id
, int *status
,
232 ASN1_GENERALIZEDTIME
**revtime
,
233 ASN1_GENERALIZEDTIME
**thisupd
,
234 ASN1_GENERALIZEDTIME
**nextupd
);
235 int OCSP_check_validity(ASN1_GENERALIZEDTIME
*thisupd
,
236 ASN1_GENERALIZEDTIME
*nextupd
, long sec
, long maxsec
);
238 int OCSP_request_verify(OCSP_REQUEST
*req
, STACK_OF(X509
) *certs
,
239 X509_STORE
*store
, unsigned long flags
);
241 int OCSP_parse_url(const char *url
, char **phost
, char **pport
, char **ppath
,
244 int OCSP_id_issuer_cmp(OCSP_CERTID
*a
, OCSP_CERTID
*b
);
245 int OCSP_id_cmp(OCSP_CERTID
*a
, OCSP_CERTID
*b
);
247 int OCSP_request_onereq_count(OCSP_REQUEST
*req
);
248 OCSP_ONEREQ
*OCSP_request_onereq_get0(OCSP_REQUEST
*req
, int i
);
249 OCSP_CERTID
*OCSP_onereq_get0_id(OCSP_ONEREQ
*one
);
250 int OCSP_id_get0_info(ASN1_OCTET_STRING
**piNameHash
, ASN1_OBJECT
**pmd
,
251 ASN1_OCTET_STRING
**pikeyHash
,
252 ASN1_INTEGER
**pserial
, OCSP_CERTID
*cid
);
253 int OCSP_request_is_signed(OCSP_REQUEST
*req
);
254 OCSP_RESPONSE
*OCSP_response_create(int status
, OCSP_BASICRESP
*bs
);
255 OCSP_SINGLERESP
*OCSP_basic_add1_status(OCSP_BASICRESP
*rsp
,
257 int status
, int reason
,
261 int OCSP_basic_add1_cert(OCSP_BASICRESP
*resp
, X509
*cert
);
262 int OCSP_basic_sign(OCSP_BASICRESP
*brsp
,
263 X509
*signer
, EVP_PKEY
*key
, const EVP_MD
*dgst
,
264 STACK_OF(X509
) *certs
, unsigned long flags
);
265 int OCSP_RESPID_set_by_name(OCSP_RESPID
*respid
, X509
*cert
);
266 int OCSP_RESPID_set_by_key(OCSP_RESPID
*respid
, X509
*cert
);
267 int OCSP_RESPID_match(OCSP_RESPID
*respid
, X509
*cert
);
269 X509_EXTENSION
*OCSP_crlID_new(const char *url
, long *n
, char *tim
);
271 X509_EXTENSION
*OCSP_accept_responses_new(char **oids
);
273 X509_EXTENSION
*OCSP_archive_cutoff_new(char *tim
);
275 X509_EXTENSION
*OCSP_url_svcloc_new(X509_NAME
*issuer
, const char **urls
);
277 int OCSP_REQUEST_get_ext_count(OCSP_REQUEST
*x
);
278 int OCSP_REQUEST_get_ext_by_NID(OCSP_REQUEST
*x
, int nid
, int lastpos
);
279 int OCSP_REQUEST_get_ext_by_OBJ(OCSP_REQUEST
*x
, const ASN1_OBJECT
*obj
,
281 int OCSP_REQUEST_get_ext_by_critical(OCSP_REQUEST
*x
, int crit
, int lastpos
);
282 X509_EXTENSION
*OCSP_REQUEST_get_ext(OCSP_REQUEST
*x
, int loc
);
283 X509_EXTENSION
*OCSP_REQUEST_delete_ext(OCSP_REQUEST
*x
, int loc
);
284 void *OCSP_REQUEST_get1_ext_d2i(OCSP_REQUEST
*x
, int nid
, int *crit
,
286 int OCSP_REQUEST_add1_ext_i2d(OCSP_REQUEST
*x
, int nid
, void *value
, int crit
,
287 unsigned long flags
);
288 int OCSP_REQUEST_add_ext(OCSP_REQUEST
*x
, X509_EXTENSION
*ex
, int loc
);
290 int OCSP_ONEREQ_get_ext_count(OCSP_ONEREQ
*x
);
291 int OCSP_ONEREQ_get_ext_by_NID(OCSP_ONEREQ
*x
, int nid
, int lastpos
);
292 int OCSP_ONEREQ_get_ext_by_OBJ(OCSP_ONEREQ
*x
, const ASN1_OBJECT
*obj
, int lastpos
);
293 int OCSP_ONEREQ_get_ext_by_critical(OCSP_ONEREQ
*x
, int crit
, int lastpos
);
294 X509_EXTENSION
*OCSP_ONEREQ_get_ext(OCSP_ONEREQ
*x
, int loc
);
295 X509_EXTENSION
*OCSP_ONEREQ_delete_ext(OCSP_ONEREQ
*x
, int loc
);
296 void *OCSP_ONEREQ_get1_ext_d2i(OCSP_ONEREQ
*x
, int nid
, int *crit
, int *idx
);
297 int OCSP_ONEREQ_add1_ext_i2d(OCSP_ONEREQ
*x
, int nid
, void *value
, int crit
,
298 unsigned long flags
);
299 int OCSP_ONEREQ_add_ext(OCSP_ONEREQ
*x
, X509_EXTENSION
*ex
, int loc
);
301 int OCSP_BASICRESP_get_ext_count(OCSP_BASICRESP
*x
);
302 int OCSP_BASICRESP_get_ext_by_NID(OCSP_BASICRESP
*x
, int nid
, int lastpos
);
303 int OCSP_BASICRESP_get_ext_by_OBJ(OCSP_BASICRESP
*x
, const ASN1_OBJECT
*obj
,
305 int OCSP_BASICRESP_get_ext_by_critical(OCSP_BASICRESP
*x
, int crit
,
307 X509_EXTENSION
*OCSP_BASICRESP_get_ext(OCSP_BASICRESP
*x
, int loc
);
308 X509_EXTENSION
*OCSP_BASICRESP_delete_ext(OCSP_BASICRESP
*x
, int loc
);
309 void *OCSP_BASICRESP_get1_ext_d2i(OCSP_BASICRESP
*x
, int nid
, int *crit
,
311 int OCSP_BASICRESP_add1_ext_i2d(OCSP_BASICRESP
*x
, int nid
, void *value
,
312 int crit
, unsigned long flags
);
313 int OCSP_BASICRESP_add_ext(OCSP_BASICRESP
*x
, X509_EXTENSION
*ex
, int loc
);
315 int OCSP_SINGLERESP_get_ext_count(OCSP_SINGLERESP
*x
);
316 int OCSP_SINGLERESP_get_ext_by_NID(OCSP_SINGLERESP
*x
, int nid
, int lastpos
);
317 int OCSP_SINGLERESP_get_ext_by_OBJ(OCSP_SINGLERESP
*x
, const ASN1_OBJECT
*obj
,
319 int OCSP_SINGLERESP_get_ext_by_critical(OCSP_SINGLERESP
*x
, int crit
,
321 X509_EXTENSION
*OCSP_SINGLERESP_get_ext(OCSP_SINGLERESP
*x
, int loc
);
322 X509_EXTENSION
*OCSP_SINGLERESP_delete_ext(OCSP_SINGLERESP
*x
, int loc
);
323 void *OCSP_SINGLERESP_get1_ext_d2i(OCSP_SINGLERESP
*x
, int nid
, int *crit
,
325 int OCSP_SINGLERESP_add1_ext_i2d(OCSP_SINGLERESP
*x
, int nid
, void *value
,
326 int crit
, unsigned long flags
);
327 int OCSP_SINGLERESP_add_ext(OCSP_SINGLERESP
*x
, X509_EXTENSION
*ex
, int loc
);
328 const OCSP_CERTID
*OCSP_SINGLERESP_get0_id(const OCSP_SINGLERESP
*x
);
330 DECLARE_ASN1_FUNCTIONS(OCSP_SINGLERESP
)
331 DECLARE_ASN1_FUNCTIONS(OCSP_CERTSTATUS
)
332 DECLARE_ASN1_FUNCTIONS(OCSP_REVOKEDINFO
)
333 DECLARE_ASN1_FUNCTIONS(OCSP_BASICRESP
)
334 DECLARE_ASN1_FUNCTIONS(OCSP_RESPDATA
)
335 DECLARE_ASN1_FUNCTIONS(OCSP_RESPID
)
336 DECLARE_ASN1_FUNCTIONS(OCSP_RESPONSE
)
337 DECLARE_ASN1_FUNCTIONS(OCSP_RESPBYTES
)
338 DECLARE_ASN1_FUNCTIONS(OCSP_ONEREQ
)
339 DECLARE_ASN1_FUNCTIONS(OCSP_CERTID
)
340 DECLARE_ASN1_FUNCTIONS(OCSP_REQUEST
)
341 DECLARE_ASN1_FUNCTIONS(OCSP_SIGNATURE
)
342 DECLARE_ASN1_FUNCTIONS(OCSP_REQINFO
)
343 DECLARE_ASN1_FUNCTIONS(OCSP_CRLID
)
344 DECLARE_ASN1_FUNCTIONS(OCSP_SERVICELOC
)
346 const char *OCSP_response_status_str(long s
);
347 const char *OCSP_cert_status_str(long s
);
348 const char *OCSP_crl_reason_str(long s
);
350 int OCSP_REQUEST_print(BIO
*bp
, OCSP_REQUEST
*a
, unsigned long flags
);
351 int OCSP_RESPONSE_print(BIO
*bp
, OCSP_RESPONSE
*o
, unsigned long flags
);
353 int OCSP_basic_verify(OCSP_BASICRESP
*bs
, STACK_OF(X509
) *certs
,
354 X509_STORE
*st
, unsigned long flags
);
356 int ERR_load_OCSP_strings(void);