Don't exclude quite so much in a no-sock build
[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
21 /*
22  * These definitions are outside the OPENSSL_NO_OCSP guard because although for
23  * historical reasons they have OCSP_* names, they can actually be used
24  * independently of OCSP. E.g. see RFC5280
25  */
26 /*-
27  *   CRLReason ::= ENUMERATED {
28  *        unspecified             (0),
29  *        keyCompromise           (1),
30  *        cACompromise            (2),
31  *        affiliationChanged      (3),
32  *        superseded              (4),
33  *        cessationOfOperation    (5),
34  *        certificateHold         (6),
35  *        -- value 7 is not used
36  *        removeFromCRL           (8),
37  *        privilegeWithdrawn      (9),
38  *        aACompromise           (10) }
39  */
40 # define OCSP_REVOKED_STATUS_NOSTATUS                -1
41 # define OCSP_REVOKED_STATUS_UNSPECIFIED             0
42 # define OCSP_REVOKED_STATUS_KEYCOMPROMISE           1
43 # define OCSP_REVOKED_STATUS_CACOMPROMISE            2
44 # define OCSP_REVOKED_STATUS_AFFILIATIONCHANGED      3
45 # define OCSP_REVOKED_STATUS_SUPERSEDED              4
46 # define OCSP_REVOKED_STATUS_CESSATIONOFOPERATION    5
47 # define OCSP_REVOKED_STATUS_CERTIFICATEHOLD         6
48 # define OCSP_REVOKED_STATUS_REMOVEFROMCRL           8
49 # define OCSP_REVOKED_STATUS_PRIVILEGEWITHDRAWN      9
50 # define OCSP_REVOKED_STATUS_AACOMPROMISE            10
51
52 /*
53  * These definitions are outside the OPENSSL_NO_OCSP guard because although for
54  * historical reasons they have OCSP_* names, they are used for the HTTP client.
55  */
56 # include <openssl/asn1.h>
57 /* The following functions are used only internally */
58 OCSP_REQ_CTX *OCSP_REQ_CTX_new(BIO *wbio, BIO *rbio,
59                                int method_GET, int maxline,
60                                unsigned long max_resp_len, int timeout,
61                                const char *expected_content_type,
62                                int expect_asn1);
63 void OCSP_REQ_CTX_free(OCSP_REQ_CTX *rctx);
64 int OCSP_REQ_CTX_http(OCSP_REQ_CTX *rctx,
65                       const char *server, const char *port, const char *path);
66 int OCSP_REQ_CTX_add1_header(OCSP_REQ_CTX *rctx,
67                              const char *name, const char *value);
68 int OCSP_REQ_CTX_i2d(OCSP_REQ_CTX *rctx, const char *content_type,
69                      const ASN1_ITEM *it, ASN1_VALUE *req);
70 int OCSP_REQ_CTX_nbio(OCSP_REQ_CTX *rctx);
71 ASN1_VALUE *OCSP_REQ_CTX_nbio_d2i(OCSP_REQ_CTX *rctx, const ASN1_ITEM *it);
72 BIO *OCSP_REQ_CTX_get0_mem_bio(OCSP_REQ_CTX *rctx);
73 void OCSP_set_max_response_length(OCSP_REQ_CTX *rctx, unsigned long len);
74 /* End of functions used only internally */
75
76
77 # ifndef OPENSSL_NO_OCSP
78
79 #  include <openssl/x509.h>
80 #  include <openssl/x509v3.h>
81 #  include <openssl/safestack.h>
82 #  include <openssl/ocsperr.h>
83
84 #  ifdef __cplusplus
85 extern "C" {
86 #  endif
87
88 /* Various flags and values */
89
90 #  define OCSP_DEFAULT_NONCE_LENGTH       16
91
92 #  define OCSP_NOCERTS                    0x1
93 #  define OCSP_NOINTERN                   0x2
94 #  define OCSP_NOSIGS                     0x4
95 #  define OCSP_NOCHAIN                    0x8
96 #  define OCSP_NOVERIFY                   0x10
97 #  define OCSP_NOEXPLICIT                 0x20
98 #  define OCSP_NOCASIGN                   0x40
99 #  define OCSP_NODELEGATED                0x80
100 #  define OCSP_NOCHECKS                   0x100
101 #  define OCSP_TRUSTOTHER                 0x200
102 #  define OCSP_RESPID_KEY                 0x400
103 #  define OCSP_NOTIME                     0x800
104
105 typedef struct ocsp_cert_id_st OCSP_CERTID;
106
107 DEFINE_STACK_OF(OCSP_CERTID)
108
109 typedef struct ocsp_one_request_st OCSP_ONEREQ;
110
111 DEFINE_STACK_OF(OCSP_ONEREQ)
112
113 typedef struct ocsp_req_info_st OCSP_REQINFO;
114 typedef struct ocsp_signature_st OCSP_SIGNATURE;
115 typedef struct ocsp_request_st OCSP_REQUEST;
116
117 #  define OCSP_RESPONSE_STATUS_SUCCESSFUL           0
118 #  define OCSP_RESPONSE_STATUS_MALFORMEDREQUEST     1
119 #  define OCSP_RESPONSE_STATUS_INTERNALERROR        2
120 #  define OCSP_RESPONSE_STATUS_TRYLATER             3
121 #  define OCSP_RESPONSE_STATUS_SIGREQUIRED          5
122 #  define OCSP_RESPONSE_STATUS_UNAUTHORIZED         6
123
124 typedef struct ocsp_resp_bytes_st OCSP_RESPBYTES;
125
126 #  define V_OCSP_RESPID_NAME 0
127 #  define V_OCSP_RESPID_KEY  1
128
129 DEFINE_STACK_OF(OCSP_RESPID)
130
131 typedef struct ocsp_revoked_info_st OCSP_REVOKEDINFO;
132
133 #  define V_OCSP_CERTSTATUS_GOOD    0
134 #  define V_OCSP_CERTSTATUS_REVOKED 1
135 #  define V_OCSP_CERTSTATUS_UNKNOWN 2
136
137 typedef struct ocsp_cert_status_st OCSP_CERTSTATUS;
138 typedef struct ocsp_single_response_st OCSP_SINGLERESP;
139
140 DEFINE_STACK_OF(OCSP_SINGLERESP)
141
142 typedef struct ocsp_response_data_st OCSP_RESPDATA;
143
144 typedef struct ocsp_basic_response_st OCSP_BASICRESP;
145
146 typedef struct ocsp_crl_id_st OCSP_CRLID;
147 typedef struct ocsp_service_locator_st OCSP_SERVICELOC;
148
149 #  define PEM_STRING_OCSP_REQUEST "OCSP REQUEST"
150 #  define PEM_STRING_OCSP_RESPONSE "OCSP RESPONSE"
151
152 #  define d2i_OCSP_REQUEST_bio(bp,p) ASN1_d2i_bio_of(OCSP_REQUEST,OCSP_REQUEST_new,d2i_OCSP_REQUEST,bp,p)
153
154 #  define d2i_OCSP_RESPONSE_bio(bp,p) ASN1_d2i_bio_of(OCSP_RESPONSE,OCSP_RESPONSE_new,d2i_OCSP_RESPONSE,bp,p)
155
156 #  define PEM_read_bio_OCSP_REQUEST(bp,x,cb) (OCSP_REQUEST *)PEM_ASN1_read_bio( \
157      (char *(*)())d2i_OCSP_REQUEST,PEM_STRING_OCSP_REQUEST, \
158      bp,(char **)(x),cb,NULL)
159
160 #  define PEM_read_bio_OCSP_RESPONSE(bp,x,cb) (OCSP_RESPONSE *)PEM_ASN1_read_bio(\
161      (char *(*)())d2i_OCSP_RESPONSE,PEM_STRING_OCSP_RESPONSE, \
162      bp,(char **)(x),cb,NULL)
163
164 #  define PEM_write_bio_OCSP_REQUEST(bp,o) \
165     PEM_ASN1_write_bio((int (*)())i2d_OCSP_REQUEST,PEM_STRING_OCSP_REQUEST,\
166                         bp,(char *)(o), NULL,NULL,0,NULL,NULL)
167
168 #  define PEM_write_bio_OCSP_RESPONSE(bp,o) \
169     PEM_ASN1_write_bio((int (*)())i2d_OCSP_RESPONSE,PEM_STRING_OCSP_RESPONSE,\
170                         bp,(char *)(o), NULL,NULL,0,NULL,NULL)
171
172 #  define i2d_OCSP_RESPONSE_bio(bp,o) ASN1_i2d_bio_of(OCSP_RESPONSE,i2d_OCSP_RESPONSE,bp,o)
173
174 #  define i2d_OCSP_REQUEST_bio(bp,o) ASN1_i2d_bio_of(OCSP_REQUEST,i2d_OCSP_REQUEST,bp,o)
175
176 #  define ASN1_BIT_STRING_digest(data,type,md,len) \
177         ASN1_item_digest(ASN1_ITEM_rptr(ASN1_BIT_STRING),type,data,md,len)
178
179 #  define OCSP_CERTSTATUS_dup(cs)\
180                 (OCSP_CERTSTATUS*)ASN1_dup((int(*)())i2d_OCSP_CERTSTATUS,\
181                 (char *(*)())d2i_OCSP_CERTSTATUS,(char *)(cs))
182
183 DECLARE_ASN1_DUP_FUNCTION(OCSP_CERTID)
184
185 OCSP_RESPONSE *OCSP_sendreq_bio(BIO *b, const char *path, OCSP_REQUEST *req);
186 OCSP_REQ_CTX *OCSP_sendreq_new(BIO *io, const char *path, OCSP_REQUEST *req,
187                                int maxline);
188 int OCSP_sendreq_nbio(OCSP_RESPONSE **presp, OCSP_REQ_CTX *rctx);
189
190 /* TODO: remove this (documented but) meanwhile obsolete function? */
191 int OCSP_REQ_CTX_set1_req(OCSP_REQ_CTX *rctx, const OCSP_REQUEST *req);
192
193 OCSP_CERTID *OCSP_cert_to_id(const EVP_MD *dgst, const X509 *subject,
194                              const X509 *issuer);
195
196 OCSP_CERTID *OCSP_cert_id_new(const EVP_MD *dgst,
197                               const X509_NAME *issuerName,
198                               const ASN1_BIT_STRING *issuerKey,
199                               const ASN1_INTEGER *serialNumber);
200
201 OCSP_ONEREQ *OCSP_request_add0_id(OCSP_REQUEST *req, OCSP_CERTID *cid);
202
203 int OCSP_request_add1_nonce(OCSP_REQUEST *req, unsigned char *val, int len);
204 int OCSP_basic_add1_nonce(OCSP_BASICRESP *resp, unsigned char *val, int len);
205 int OCSP_check_nonce(OCSP_REQUEST *req, OCSP_BASICRESP *bs);
206 int OCSP_copy_nonce(OCSP_BASICRESP *resp, OCSP_REQUEST *req);
207
208 int OCSP_request_set1_name(OCSP_REQUEST *req, X509_NAME *nm);
209 int OCSP_request_add1_cert(OCSP_REQUEST *req, X509 *cert);
210
211 int OCSP_request_sign(OCSP_REQUEST *req,
212                       X509 *signer,
213                       EVP_PKEY *key,
214                       const EVP_MD *dgst,
215                       STACK_OF(X509) *certs, unsigned long flags);
216
217 int OCSP_response_status(OCSP_RESPONSE *resp);
218 OCSP_BASICRESP *OCSP_response_get1_basic(OCSP_RESPONSE *resp);
219
220 const ASN1_OCTET_STRING *OCSP_resp_get0_signature(const OCSP_BASICRESP *bs);
221 const X509_ALGOR *OCSP_resp_get0_tbs_sigalg(const OCSP_BASICRESP *bs);
222 const OCSP_RESPDATA *OCSP_resp_get0_respdata(const OCSP_BASICRESP *bs);
223 int OCSP_resp_get0_signer(OCSP_BASICRESP *bs, X509 **signer,
224                           STACK_OF(X509) *extra_certs);
225
226 int OCSP_resp_count(OCSP_BASICRESP *bs);
227 OCSP_SINGLERESP *OCSP_resp_get0(OCSP_BASICRESP *bs, int idx);
228 const ASN1_GENERALIZEDTIME *OCSP_resp_get0_produced_at(const OCSP_BASICRESP* bs);
229 const STACK_OF(X509) *OCSP_resp_get0_certs(const OCSP_BASICRESP *bs);
230 int OCSP_resp_get0_id(const OCSP_BASICRESP *bs,
231                       const ASN1_OCTET_STRING **pid,
232                       const X509_NAME **pname);
233 int OCSP_resp_get1_id(const OCSP_BASICRESP *bs,
234                       ASN1_OCTET_STRING **pid,
235                       X509_NAME **pname);
236
237 int OCSP_resp_find(OCSP_BASICRESP *bs, OCSP_CERTID *id, int last);
238 int OCSP_single_get0_status(OCSP_SINGLERESP *single, int *reason,
239                             ASN1_GENERALIZEDTIME **revtime,
240                             ASN1_GENERALIZEDTIME **thisupd,
241                             ASN1_GENERALIZEDTIME **nextupd);
242 int OCSP_resp_find_status(OCSP_BASICRESP *bs, OCSP_CERTID *id, int *status,
243                           int *reason,
244                           ASN1_GENERALIZEDTIME **revtime,
245                           ASN1_GENERALIZEDTIME **thisupd,
246                           ASN1_GENERALIZEDTIME **nextupd);
247 int OCSP_check_validity(ASN1_GENERALIZEDTIME *thisupd,
248                         ASN1_GENERALIZEDTIME *nextupd, long sec, long maxsec);
249
250 int OCSP_request_verify(OCSP_REQUEST *req, STACK_OF(X509) *certs,
251                         X509_STORE *store, unsigned long flags);
252
253 #  define OCSP_parse_url OSSL_HTTP_parse_url /* for backward compatibility */
254
255 int OCSP_id_issuer_cmp(const OCSP_CERTID *a, const OCSP_CERTID *b);
256 int OCSP_id_cmp(const OCSP_CERTID *a, const OCSP_CERTID *b);
257
258 int OCSP_request_onereq_count(OCSP_REQUEST *req);
259 OCSP_ONEREQ *OCSP_request_onereq_get0(OCSP_REQUEST *req, int i);
260 OCSP_CERTID *OCSP_onereq_get0_id(OCSP_ONEREQ *one);
261 int OCSP_id_get0_info(ASN1_OCTET_STRING **piNameHash, ASN1_OBJECT **pmd,
262                       ASN1_OCTET_STRING **pikeyHash,
263                       ASN1_INTEGER **pserial, OCSP_CERTID *cid);
264 int OCSP_request_is_signed(OCSP_REQUEST *req);
265 OCSP_RESPONSE *OCSP_response_create(int status, OCSP_BASICRESP *bs);
266 OCSP_SINGLERESP *OCSP_basic_add1_status(OCSP_BASICRESP *rsp,
267                                         OCSP_CERTID *cid,
268                                         int status, int reason,
269                                         ASN1_TIME *revtime,
270                                         ASN1_TIME *thisupd,
271                                         ASN1_TIME *nextupd);
272 int OCSP_basic_add1_cert(OCSP_BASICRESP *resp, X509 *cert);
273 int OCSP_basic_sign(OCSP_BASICRESP *brsp,
274                     X509 *signer, EVP_PKEY *key, const EVP_MD *dgst,
275                     STACK_OF(X509) *certs, unsigned long flags);
276 int OCSP_basic_sign_ctx(OCSP_BASICRESP *brsp,
277                         X509 *signer, EVP_MD_CTX *ctx,
278                         STACK_OF(X509) *certs, unsigned long flags);
279 int OCSP_RESPID_set_by_name(OCSP_RESPID *respid, X509 *cert);
280 int OCSP_RESPID_set_by_key(OCSP_RESPID *respid, X509 *cert);
281 int OCSP_RESPID_match(OCSP_RESPID *respid, X509 *cert);
282
283 X509_EXTENSION *OCSP_crlID_new(const char *url, long *n, char *tim);
284
285 X509_EXTENSION *OCSP_accept_responses_new(char **oids);
286
287 X509_EXTENSION *OCSP_archive_cutoff_new(char *tim);
288
289 X509_EXTENSION *OCSP_url_svcloc_new(X509_NAME *issuer, const char **urls);
290
291 int OCSP_REQUEST_get_ext_count(OCSP_REQUEST *x);
292 int OCSP_REQUEST_get_ext_by_NID(OCSP_REQUEST *x, int nid, int lastpos);
293 int OCSP_REQUEST_get_ext_by_OBJ(OCSP_REQUEST *x, const ASN1_OBJECT *obj,
294                                 int lastpos);
295 int OCSP_REQUEST_get_ext_by_critical(OCSP_REQUEST *x, int crit, int lastpos);
296 X509_EXTENSION *OCSP_REQUEST_get_ext(OCSP_REQUEST *x, int loc);
297 X509_EXTENSION *OCSP_REQUEST_delete_ext(OCSP_REQUEST *x, int loc);
298 void *OCSP_REQUEST_get1_ext_d2i(OCSP_REQUEST *x, int nid, int *crit,
299                                 int *idx);
300 int OCSP_REQUEST_add1_ext_i2d(OCSP_REQUEST *x, int nid, void *value, int crit,
301                               unsigned long flags);
302 int OCSP_REQUEST_add_ext(OCSP_REQUEST *x, X509_EXTENSION *ex, int loc);
303
304 int OCSP_ONEREQ_get_ext_count(OCSP_ONEREQ *x);
305 int OCSP_ONEREQ_get_ext_by_NID(OCSP_ONEREQ *x, int nid, int lastpos);
306 int OCSP_ONEREQ_get_ext_by_OBJ(OCSP_ONEREQ *x, const ASN1_OBJECT *obj, int lastpos);
307 int OCSP_ONEREQ_get_ext_by_critical(OCSP_ONEREQ *x, int crit, int lastpos);
308 X509_EXTENSION *OCSP_ONEREQ_get_ext(OCSP_ONEREQ *x, int loc);
309 X509_EXTENSION *OCSP_ONEREQ_delete_ext(OCSP_ONEREQ *x, int loc);
310 void *OCSP_ONEREQ_get1_ext_d2i(OCSP_ONEREQ *x, int nid, int *crit, int *idx);
311 int OCSP_ONEREQ_add1_ext_i2d(OCSP_ONEREQ *x, int nid, void *value, int crit,
312                              unsigned long flags);
313 int OCSP_ONEREQ_add_ext(OCSP_ONEREQ *x, X509_EXTENSION *ex, int loc);
314
315 int OCSP_BASICRESP_get_ext_count(OCSP_BASICRESP *x);
316 int OCSP_BASICRESP_get_ext_by_NID(OCSP_BASICRESP *x, int nid, int lastpos);
317 int OCSP_BASICRESP_get_ext_by_OBJ(OCSP_BASICRESP *x, const ASN1_OBJECT *obj,
318                                   int lastpos);
319 int OCSP_BASICRESP_get_ext_by_critical(OCSP_BASICRESP *x, int crit,
320                                        int lastpos);
321 X509_EXTENSION *OCSP_BASICRESP_get_ext(OCSP_BASICRESP *x, int loc);
322 X509_EXTENSION *OCSP_BASICRESP_delete_ext(OCSP_BASICRESP *x, int loc);
323 void *OCSP_BASICRESP_get1_ext_d2i(OCSP_BASICRESP *x, int nid, int *crit,
324                                   int *idx);
325 int OCSP_BASICRESP_add1_ext_i2d(OCSP_BASICRESP *x, int nid, void *value,
326                                 int crit, unsigned long flags);
327 int OCSP_BASICRESP_add_ext(OCSP_BASICRESP *x, X509_EXTENSION *ex, int loc);
328
329 int OCSP_SINGLERESP_get_ext_count(OCSP_SINGLERESP *x);
330 int OCSP_SINGLERESP_get_ext_by_NID(OCSP_SINGLERESP *x, int nid, int lastpos);
331 int OCSP_SINGLERESP_get_ext_by_OBJ(OCSP_SINGLERESP *x, const ASN1_OBJECT *obj,
332                                    int lastpos);
333 int OCSP_SINGLERESP_get_ext_by_critical(OCSP_SINGLERESP *x, int crit,
334                                         int lastpos);
335 X509_EXTENSION *OCSP_SINGLERESP_get_ext(OCSP_SINGLERESP *x, int loc);
336 X509_EXTENSION *OCSP_SINGLERESP_delete_ext(OCSP_SINGLERESP *x, int loc);
337 void *OCSP_SINGLERESP_get1_ext_d2i(OCSP_SINGLERESP *x, int nid, int *crit,
338                                    int *idx);
339 int OCSP_SINGLERESP_add1_ext_i2d(OCSP_SINGLERESP *x, int nid, void *value,
340                                  int crit, unsigned long flags);
341 int OCSP_SINGLERESP_add_ext(OCSP_SINGLERESP *x, X509_EXTENSION *ex, int loc);
342 const OCSP_CERTID *OCSP_SINGLERESP_get0_id(const OCSP_SINGLERESP *x);
343
344 DECLARE_ASN1_FUNCTIONS(OCSP_SINGLERESP)
345 DECLARE_ASN1_FUNCTIONS(OCSP_CERTSTATUS)
346 DECLARE_ASN1_FUNCTIONS(OCSP_REVOKEDINFO)
347 DECLARE_ASN1_FUNCTIONS(OCSP_BASICRESP)
348 DECLARE_ASN1_FUNCTIONS(OCSP_RESPDATA)
349 DECLARE_ASN1_FUNCTIONS(OCSP_RESPID)
350 DECLARE_ASN1_FUNCTIONS(OCSP_RESPONSE)
351 DECLARE_ASN1_FUNCTIONS(OCSP_RESPBYTES)
352 DECLARE_ASN1_FUNCTIONS(OCSP_ONEREQ)
353 DECLARE_ASN1_FUNCTIONS(OCSP_CERTID)
354 DECLARE_ASN1_FUNCTIONS(OCSP_REQUEST)
355 DECLARE_ASN1_FUNCTIONS(OCSP_SIGNATURE)
356 DECLARE_ASN1_FUNCTIONS(OCSP_REQINFO)
357 DECLARE_ASN1_FUNCTIONS(OCSP_CRLID)
358 DECLARE_ASN1_FUNCTIONS(OCSP_SERVICELOC)
359
360 const char *OCSP_response_status_str(long s);
361 const char *OCSP_cert_status_str(long s);
362 const char *OCSP_crl_reason_str(long s);
363
364 int OCSP_REQUEST_print(BIO *bp, OCSP_REQUEST *a, unsigned long flags);
365 int OCSP_RESPONSE_print(BIO *bp, OCSP_RESPONSE *o, unsigned long flags);
366
367 int OCSP_basic_verify(OCSP_BASICRESP *bs, STACK_OF(X509) *certs,
368                       X509_STORE *st, unsigned long flags);
369
370
371 #  ifdef  __cplusplus
372 }
373 #  endif
374 # endif /* !defined OPENSSL_NO_OCSP */
375 #endif