0b89a64eec9ee4f47cdbe70373b2a1d9168fab18
[openssl.git] / include / openssl / ocsp.h
1 /*
2  * Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
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
8  */
9
10 #ifndef HEADER_OCSP_H
11 # define HEADER_OCSP_H
12
13 #include <openssl/opensslconf.h>
14
15 /*
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
19  */
20 /*-
21  *   CRLReason ::= ENUMERATED {
22  *        unspecified             (0),
23  *        keyCompromise           (1),
24  *        cACompromise            (2),
25  *        affiliationChanged      (3),
26  *        superseded              (4),
27  *        cessationOfOperation    (5),
28  *        certificateHold         (6),
29  *        removeFromCRL           (8) }
30  */
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
40
41
42 # ifndef OPENSSL_NO_OCSP
43
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>
49
50 #ifdef  __cplusplus
51 extern "C" {
52 #endif
53
54 /* Various flags and values */
55
56 #  define OCSP_DEFAULT_NONCE_LENGTH       16
57
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
70
71 typedef struct ocsp_cert_id_st OCSP_CERTID;
72
73 DEFINE_STACK_OF(OCSP_CERTID)
74
75 typedef struct ocsp_one_request_st OCSP_ONEREQ;
76
77 DEFINE_STACK_OF(OCSP_ONEREQ)
78
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;
82
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
89
90 typedef struct ocsp_resp_bytes_st OCSP_RESPBYTES;
91
92 #  define V_OCSP_RESPID_NAME 0
93 #  define V_OCSP_RESPID_KEY  1
94
95 DEFINE_STACK_OF(OCSP_RESPID)
96 DECLARE_ASN1_FUNCTIONS(OCSP_RESPID)
97
98 typedef struct ocsp_revoked_info_st OCSP_REVOKEDINFO;
99
100 #  define V_OCSP_CERTSTATUS_GOOD    0
101 #  define V_OCSP_CERTSTATUS_REVOKED 1
102 #  define V_OCSP_CERTSTATUS_UNKNOWN 2
103
104 typedef struct ocsp_cert_status_st OCSP_CERTSTATUS;
105 typedef struct ocsp_single_response_st OCSP_SINGLERESP;
106
107 DEFINE_STACK_OF(OCSP_SINGLERESP)
108
109 typedef struct ocsp_response_data_st OCSP_RESPDATA;
110
111 typedef struct ocsp_basic_response_st OCSP_BASICRESP;
112
113 typedef struct ocsp_crl_id_st OCSP_CRLID;
114 typedef struct ocsp_service_locator_st OCSP_SERVICELOC;
115
116 #  define PEM_STRING_OCSP_REQUEST "OCSP REQUEST"
117 #  define PEM_STRING_OCSP_RESPONSE "OCSP RESPONSE"
118
119 #  define d2i_OCSP_REQUEST_bio(bp,p) ASN1_d2i_bio_of(OCSP_REQUEST,OCSP_REQUEST_new,d2i_OCSP_REQUEST,bp,p)
120
121 #  define d2i_OCSP_RESPONSE_bio(bp,p) ASN1_d2i_bio_of(OCSP_RESPONSE,OCSP_RESPONSE_new,d2i_OCSP_RESPONSE,bp,p)
122
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)
126
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)
130
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)
134
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)
138
139 #  define i2d_OCSP_RESPONSE_bio(bp,o) ASN1_i2d_bio_of(OCSP_RESPONSE,i2d_OCSP_RESPONSE,bp,o)
140
141 #  define i2d_OCSP_REQUEST_bio(bp,o) ASN1_i2d_bio_of(OCSP_REQUEST,i2d_OCSP_REQUEST,bp,o)
142
143 #  define ASN1_BIT_STRING_digest(data,type,md,len) \
144         ASN1_item_digest(ASN1_ITEM_rptr(ASN1_BIT_STRING),type,data,md,len)
145
146 #  define OCSP_CERTSTATUS_dup(cs)\
147                 (OCSP_CERTSTATUS*)ASN1_dup((int(*)())i2d_OCSP_CERTSTATUS,\
148                 (char *(*)())d2i_OCSP_CERTSTATUS,(char *)(cs))
149
150 OCSP_CERTID *OCSP_CERTID_dup(OCSP_CERTID *id);
151
152 OCSP_RESPONSE *OCSP_sendreq_bio(BIO *b, const char *path, OCSP_REQUEST *req);
153 OCSP_REQ_CTX *OCSP_sendreq_new(BIO *io, const char *path, OCSP_REQUEST *req,
154                                int maxline);
155 int OCSP_REQ_CTX_nbio(OCSP_REQ_CTX *rctx);
156 int OCSP_sendreq_nbio(OCSP_RESPONSE **presp, OCSP_REQ_CTX *rctx);
157 OCSP_REQ_CTX *OCSP_REQ_CTX_new(BIO *io, int maxline);
158 void OCSP_REQ_CTX_free(OCSP_REQ_CTX *rctx);
159 void OCSP_set_max_response_length(OCSP_REQ_CTX *rctx, unsigned long len);
160 int OCSP_REQ_CTX_i2d(OCSP_REQ_CTX *rctx, const ASN1_ITEM *it,
161                      ASN1_VALUE *val);
162 int OCSP_REQ_CTX_nbio_d2i(OCSP_REQ_CTX *rctx, ASN1_VALUE **pval,
163                           const ASN1_ITEM *it);
164 BIO *OCSP_REQ_CTX_get0_mem_bio(OCSP_REQ_CTX *rctx);
165 int OCSP_REQ_CTX_i2d(OCSP_REQ_CTX *rctx, const ASN1_ITEM *it,
166                      ASN1_VALUE *val);
167 int OCSP_REQ_CTX_http(OCSP_REQ_CTX *rctx, const char *op, const char *path);
168 int OCSP_REQ_CTX_set1_req(OCSP_REQ_CTX *rctx, OCSP_REQUEST *req);
169 int OCSP_REQ_CTX_add1_header(OCSP_REQ_CTX *rctx,
170                              const char *name, const char *value);
171
172 OCSP_CERTID *OCSP_cert_to_id(const EVP_MD *dgst, const X509 *subject,
173                              const X509 *issuer);
174
175 OCSP_CERTID *OCSP_cert_id_new(const EVP_MD *dgst,
176                               const X509_NAME *issuerName,
177                               const ASN1_BIT_STRING *issuerKey,
178                               const ASN1_INTEGER *serialNumber);
179
180 OCSP_ONEREQ *OCSP_request_add0_id(OCSP_REQUEST *req, OCSP_CERTID *cid);
181
182 int OCSP_request_add1_nonce(OCSP_REQUEST *req, unsigned char *val, int len);
183 int OCSP_basic_add1_nonce(OCSP_BASICRESP *resp, unsigned char *val, int len);
184 int OCSP_check_nonce(OCSP_REQUEST *req, OCSP_BASICRESP *bs);
185 int OCSP_copy_nonce(OCSP_BASICRESP *resp, OCSP_REQUEST *req);
186
187 int OCSP_request_set1_name(OCSP_REQUEST *req, X509_NAME *nm);
188 int OCSP_request_add1_cert(OCSP_REQUEST *req, X509 *cert);
189
190 int OCSP_request_sign(OCSP_REQUEST *req,
191                       X509 *signer,
192                       EVP_PKEY *key,
193                       const EVP_MD *dgst,
194                       STACK_OF(X509) *certs, unsigned long flags);
195
196 int OCSP_response_status(OCSP_RESPONSE *resp);
197 OCSP_BASICRESP *OCSP_response_get1_basic(OCSP_RESPONSE *resp);
198
199 const ASN1_OCTET_STRING *OCSP_resp_get0_signature(const OCSP_BASICRESP *bs);
200 int OCSP_resp_get0_signer(OCSP_BASICRESP *bs, X509 **signer,
201                           STACK_OF(X509) *extra_certs);
202
203 int OCSP_resp_count(OCSP_BASICRESP *bs);
204 OCSP_SINGLERESP *OCSP_resp_get0(OCSP_BASICRESP *bs, int idx);
205 const ASN1_GENERALIZEDTIME *OCSP_resp_get0_produced_at(const OCSP_BASICRESP* bs);
206 const STACK_OF(X509) *OCSP_resp_get0_certs(const OCSP_BASICRESP *bs);
207 int OCSP_resp_get0_id(const OCSP_BASICRESP *bs,
208                       const ASN1_OCTET_STRING **pid,
209                       const X509_NAME **pname);
210 int OCSP_resp_get1_id(const OCSP_BASICRESP *bs,
211                       ASN1_OCTET_STRING **pid,
212                       X509_NAME **pname);
213
214 int OCSP_resp_find(OCSP_BASICRESP *bs, OCSP_CERTID *id, int last);
215 int OCSP_single_get0_status(OCSP_SINGLERESP *single, int *reason,
216                             ASN1_GENERALIZEDTIME **revtime,
217                             ASN1_GENERALIZEDTIME **thisupd,
218                             ASN1_GENERALIZEDTIME **nextupd);
219 int OCSP_resp_find_status(OCSP_BASICRESP *bs, OCSP_CERTID *id, int *status,
220                           int *reason,
221                           ASN1_GENERALIZEDTIME **revtime,
222                           ASN1_GENERALIZEDTIME **thisupd,
223                           ASN1_GENERALIZEDTIME **nextupd);
224 int OCSP_check_validity(ASN1_GENERALIZEDTIME *thisupd,
225                         ASN1_GENERALIZEDTIME *nextupd, long sec, long maxsec);
226
227 int OCSP_request_verify(OCSP_REQUEST *req, STACK_OF(X509) *certs,
228                         X509_STORE *store, unsigned long flags);
229
230 int OCSP_parse_url(const char *url, char **phost, char **pport, char **ppath,
231                    int *pssl);
232
233 int OCSP_id_issuer_cmp(OCSP_CERTID *a, OCSP_CERTID *b);
234 int OCSP_id_cmp(OCSP_CERTID *a, OCSP_CERTID *b);
235
236 int OCSP_request_onereq_count(OCSP_REQUEST *req);
237 OCSP_ONEREQ *OCSP_request_onereq_get0(OCSP_REQUEST *req, int i);
238 OCSP_CERTID *OCSP_onereq_get0_id(OCSP_ONEREQ *one);
239 int OCSP_id_get0_info(ASN1_OCTET_STRING **piNameHash, ASN1_OBJECT **pmd,
240                       ASN1_OCTET_STRING **pikeyHash,
241                       ASN1_INTEGER **pserial, OCSP_CERTID *cid);
242 int OCSP_request_is_signed(OCSP_REQUEST *req);
243 OCSP_RESPONSE *OCSP_response_create(int status, OCSP_BASICRESP *bs);
244 OCSP_SINGLERESP *OCSP_basic_add1_status(OCSP_BASICRESP *rsp,
245                                         OCSP_CERTID *cid,
246                                         int status, int reason,
247                                         ASN1_TIME *revtime,
248                                         ASN1_TIME *thisupd,
249                                         ASN1_TIME *nextupd);
250 int OCSP_basic_add1_cert(OCSP_BASICRESP *resp, X509 *cert);
251 int OCSP_basic_sign(OCSP_BASICRESP *brsp,
252                     X509 *signer, EVP_PKEY *key, const EVP_MD *dgst,
253                     STACK_OF(X509) *certs, unsigned long flags);
254 int OCSP_basic_sign_ctx(OCSP_BASICRESP *brsp,
255                         X509 *signer, EVP_MD_CTX *ctx,
256                         STACK_OF(X509) *certs, unsigned long flags);
257 int OCSP_RESPID_set_by_name(OCSP_RESPID *respid, X509 *cert);
258 int OCSP_RESPID_set_by_key(OCSP_RESPID *respid, X509 *cert);
259 int OCSP_RESPID_match(OCSP_RESPID *respid, X509 *cert);
260
261 X509_EXTENSION *OCSP_crlID_new(const char *url, long *n, char *tim);
262
263 X509_EXTENSION *OCSP_accept_responses_new(char **oids);
264
265 X509_EXTENSION *OCSP_archive_cutoff_new(char *tim);
266
267 X509_EXTENSION *OCSP_url_svcloc_new(X509_NAME *issuer, const char **urls);
268
269 int OCSP_REQUEST_get_ext_count(OCSP_REQUEST *x);
270 int OCSP_REQUEST_get_ext_by_NID(OCSP_REQUEST *x, int nid, int lastpos);
271 int OCSP_REQUEST_get_ext_by_OBJ(OCSP_REQUEST *x, const ASN1_OBJECT *obj,
272                                 int lastpos);
273 int OCSP_REQUEST_get_ext_by_critical(OCSP_REQUEST *x, int crit, int lastpos);
274 X509_EXTENSION *OCSP_REQUEST_get_ext(OCSP_REQUEST *x, int loc);
275 X509_EXTENSION *OCSP_REQUEST_delete_ext(OCSP_REQUEST *x, int loc);
276 void *OCSP_REQUEST_get1_ext_d2i(OCSP_REQUEST *x, int nid, int *crit,
277                                 int *idx);
278 int OCSP_REQUEST_add1_ext_i2d(OCSP_REQUEST *x, int nid, void *value, int crit,
279                               unsigned long flags);
280 int OCSP_REQUEST_add_ext(OCSP_REQUEST *x, X509_EXTENSION *ex, int loc);
281
282 int OCSP_ONEREQ_get_ext_count(OCSP_ONEREQ *x);
283 int OCSP_ONEREQ_get_ext_by_NID(OCSP_ONEREQ *x, int nid, int lastpos);
284 int OCSP_ONEREQ_get_ext_by_OBJ(OCSP_ONEREQ *x, const ASN1_OBJECT *obj, int lastpos);
285 int OCSP_ONEREQ_get_ext_by_critical(OCSP_ONEREQ *x, int crit, int lastpos);
286 X509_EXTENSION *OCSP_ONEREQ_get_ext(OCSP_ONEREQ *x, int loc);
287 X509_EXTENSION *OCSP_ONEREQ_delete_ext(OCSP_ONEREQ *x, int loc);
288 void *OCSP_ONEREQ_get1_ext_d2i(OCSP_ONEREQ *x, int nid, int *crit, int *idx);
289 int OCSP_ONEREQ_add1_ext_i2d(OCSP_ONEREQ *x, int nid, void *value, int crit,
290                              unsigned long flags);
291 int OCSP_ONEREQ_add_ext(OCSP_ONEREQ *x, X509_EXTENSION *ex, int loc);
292
293 int OCSP_BASICRESP_get_ext_count(OCSP_BASICRESP *x);
294 int OCSP_BASICRESP_get_ext_by_NID(OCSP_BASICRESP *x, int nid, int lastpos);
295 int OCSP_BASICRESP_get_ext_by_OBJ(OCSP_BASICRESP *x, const ASN1_OBJECT *obj,
296                                   int lastpos);
297 int OCSP_BASICRESP_get_ext_by_critical(OCSP_BASICRESP *x, int crit,
298                                        int lastpos);
299 X509_EXTENSION *OCSP_BASICRESP_get_ext(OCSP_BASICRESP *x, int loc);
300 X509_EXTENSION *OCSP_BASICRESP_delete_ext(OCSP_BASICRESP *x, int loc);
301 void *OCSP_BASICRESP_get1_ext_d2i(OCSP_BASICRESP *x, int nid, int *crit,
302                                   int *idx);
303 int OCSP_BASICRESP_add1_ext_i2d(OCSP_BASICRESP *x, int nid, void *value,
304                                 int crit, unsigned long flags);
305 int OCSP_BASICRESP_add_ext(OCSP_BASICRESP *x, X509_EXTENSION *ex, int loc);
306
307 int OCSP_SINGLERESP_get_ext_count(OCSP_SINGLERESP *x);
308 int OCSP_SINGLERESP_get_ext_by_NID(OCSP_SINGLERESP *x, int nid, int lastpos);
309 int OCSP_SINGLERESP_get_ext_by_OBJ(OCSP_SINGLERESP *x, const ASN1_OBJECT *obj,
310                                    int lastpos);
311 int OCSP_SINGLERESP_get_ext_by_critical(OCSP_SINGLERESP *x, int crit,
312                                         int lastpos);
313 X509_EXTENSION *OCSP_SINGLERESP_get_ext(OCSP_SINGLERESP *x, int loc);
314 X509_EXTENSION *OCSP_SINGLERESP_delete_ext(OCSP_SINGLERESP *x, int loc);
315 void *OCSP_SINGLERESP_get1_ext_d2i(OCSP_SINGLERESP *x, int nid, int *crit,
316                                    int *idx);
317 int OCSP_SINGLERESP_add1_ext_i2d(OCSP_SINGLERESP *x, int nid, void *value,
318                                  int crit, unsigned long flags);
319 int OCSP_SINGLERESP_add_ext(OCSP_SINGLERESP *x, X509_EXTENSION *ex, int loc);
320 const OCSP_CERTID *OCSP_SINGLERESP_get0_id(const OCSP_SINGLERESP *x);
321
322 DECLARE_ASN1_FUNCTIONS(OCSP_SINGLERESP)
323 DECLARE_ASN1_FUNCTIONS(OCSP_CERTSTATUS)
324 DECLARE_ASN1_FUNCTIONS(OCSP_REVOKEDINFO)
325 DECLARE_ASN1_FUNCTIONS(OCSP_BASICRESP)
326 DECLARE_ASN1_FUNCTIONS(OCSP_RESPDATA)
327 DECLARE_ASN1_FUNCTIONS(OCSP_RESPID)
328 DECLARE_ASN1_FUNCTIONS(OCSP_RESPONSE)
329 DECLARE_ASN1_FUNCTIONS(OCSP_RESPBYTES)
330 DECLARE_ASN1_FUNCTIONS(OCSP_ONEREQ)
331 DECLARE_ASN1_FUNCTIONS(OCSP_CERTID)
332 DECLARE_ASN1_FUNCTIONS(OCSP_REQUEST)
333 DECLARE_ASN1_FUNCTIONS(OCSP_SIGNATURE)
334 DECLARE_ASN1_FUNCTIONS(OCSP_REQINFO)
335 DECLARE_ASN1_FUNCTIONS(OCSP_CRLID)
336 DECLARE_ASN1_FUNCTIONS(OCSP_SERVICELOC)
337
338 const char *OCSP_response_status_str(long s);
339 const char *OCSP_cert_status_str(long s);
340 const char *OCSP_crl_reason_str(long s);
341
342 int OCSP_REQUEST_print(BIO *bp, OCSP_REQUEST *a, unsigned long flags);
343 int OCSP_RESPONSE_print(BIO *bp, OCSP_RESPONSE *o, unsigned long flags);
344
345 int OCSP_basic_verify(OCSP_BASICRESP *bs, STACK_OF(X509) *certs,
346                       X509_STORE *st, unsigned long flags);
347
348 int ERR_load_OCSP_strings(void);
349
350 #  ifdef  __cplusplus
351 }
352 #  endif
353 # endif
354 #endif