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 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)
 147
 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)
 151
 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)
 155
 156 #  define OCSP_BASICRESP_verify(a,r,d) ASN1_item_verify(ASN1_ITEM_rptr(OCSP_RESPDATA),\
 157         &(a)->signatureAlgorithm,(a)->signature,&(a)->tbsResponseData,r)
 158
 159 #  define ASN1_BIT_STRING_digest(data,type,md,len) \
 160         ASN1_item_digest(ASN1_ITEM_rptr(ASN1_BIT_STRING),type,data,md,len)
 161
 162 #  define OCSP_CERTSTATUS_dup(cs)\
 163                 (OCSP_CERTSTATUS*)ASN1_dup((int(*)())i2d_OCSP_CERTSTATUS,\
 164                 (char *(*)())d2i_OCSP_CERTSTATUS,(char *)(cs))
 165
 166 OCSP_CERTID *OCSP_CERTID_dup(OCSP_CERTID *id);
 167
 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,
 170                                int maxline);
 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,
 177                      ASN1_VALUE *val);
 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,
 182                      ASN1_VALUE *val);
 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);
 187
 188 OCSP_CERTID *OCSP_cert_to_id(const EVP_MD *dgst, const X509 *subject,
 189                              const X509 *issuer);
 190
 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);
 195
 196 OCSP_ONEREQ *OCSP_request_add0_id(OCSP_REQUEST *req, OCSP_CERTID *cid);
 197
 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);
 202
 203 int OCSP_request_set1_name(OCSP_REQUEST *req, X509_NAME *nm);
 204 int OCSP_request_add1_cert(OCSP_REQUEST *req, X509 *cert);
 205
 206 int OCSP_request_sign(OCSP_REQUEST *req,
 207                       X509 *signer,
 208                       EVP_PKEY *key,
 209                       const EVP_MD *dgst,
 210                       STACK_OF(X509) *certs, unsigned long flags);
 211
 212 int OCSP_response_status(OCSP_RESPONSE *resp);
 213 OCSP_BASICRESP *OCSP_response_get1_basic(OCSP_RESPONSE *resp);
 214
 215 const ASN1_OCTET_STRING *OCSP_resp_get0_signature(const OCSP_BASICRESP *bs);
 216
 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);
 224 int OCSP_resp_get1_id(const OCSP_BASICRESP *bs,
 225                       ASN1_OCTET_STRING **pid,
 226                       X509_NAME **pname);
 227
 228 int OCSP_resp_find(OCSP_BASICRESP *bs, OCSP_CERTID *id, int last);
 229 int OCSP_single_get0_status(OCSP_SINGLERESP *single, int *reason,
 230                             ASN1_GENERALIZEDTIME **revtime,
 231                             ASN1_GENERALIZEDTIME **thisupd,
 232                             ASN1_GENERALIZEDTIME **nextupd);
 233 int OCSP_resp_find_status(OCSP_BASICRESP *bs, OCSP_CERTID *id, int *status,
 234                           int *reason,
 235                           ASN1_GENERALIZEDTIME **revtime,
 236                           ASN1_GENERALIZEDTIME **thisupd,
 237                           ASN1_GENERALIZEDTIME **nextupd);
 238 int OCSP_check_validity(ASN1_GENERALIZEDTIME *thisupd,
 239                         ASN1_GENERALIZEDTIME *nextupd, long sec, long maxsec);
 240
 241 int OCSP_request_verify(OCSP_REQUEST *req, STACK_OF(X509) *certs,
 242                         X509_STORE *store, unsigned long flags);
 243
 244 int OCSP_parse_url(const char *url, char **phost, char **pport, char **ppath,
 245                    int *pssl);
 246
 247 int OCSP_id_issuer_cmp(OCSP_CERTID *a, OCSP_CERTID *b);
 248 int OCSP_id_cmp(OCSP_CERTID *a, OCSP_CERTID *b);
 249
 250 int OCSP_request_onereq_count(OCSP_REQUEST *req);
 251 OCSP_ONEREQ *OCSP_request_onereq_get0(OCSP_REQUEST *req, int i);
 252 OCSP_CERTID *OCSP_onereq_get0_id(OCSP_ONEREQ *one);
 253 int OCSP_id_get0_info(ASN1_OCTET_STRING **piNameHash, ASN1_OBJECT **pmd,
 254                       ASN1_OCTET_STRING **pikeyHash,
 255                       ASN1_INTEGER **pserial, OCSP_CERTID *cid);
 256 int OCSP_request_is_signed(OCSP_REQUEST *req);
 257 OCSP_RESPONSE *OCSP_response_create(int status, OCSP_BASICRESP *bs);
 258 OCSP_SINGLERESP *OCSP_basic_add1_status(OCSP_BASICRESP *rsp,
 259                                         OCSP_CERTID *cid,
 260                                         int status, int reason,
 261                                         ASN1_TIME *revtime,
 262                                         ASN1_TIME *thisupd,
 263                                         ASN1_TIME *nextupd);
 264 int OCSP_basic_add1_cert(OCSP_BASICRESP *resp, X509 *cert);
 265 int OCSP_basic_sign(OCSP_BASICRESP *brsp,
 266                     X509 *signer, EVP_PKEY *key, const EVP_MD *dgst,
 267                     STACK_OF(X509) *certs, unsigned long flags);
 268 int OCSP_RESPID_set_by_name(OCSP_RESPID *respid, X509 *cert);
 269 int OCSP_RESPID_set_by_key(OCSP_RESPID *respid, X509 *cert);
 270 int OCSP_RESPID_match(OCSP_RESPID *respid, X509 *cert);
 271
 272 X509_EXTENSION *OCSP_crlID_new(const char *url, long *n, char *tim);
 273
 274 X509_EXTENSION *OCSP_accept_responses_new(char **oids);
 275
 276 X509_EXTENSION *OCSP_archive_cutoff_new(char *tim);
 277
 278 X509_EXTENSION *OCSP_url_svcloc_new(X509_NAME *issuer, const char **urls);
 279
 280 int OCSP_REQUEST_get_ext_count(OCSP_REQUEST *x);
 281 int OCSP_REQUEST_get_ext_by_NID(OCSP_REQUEST *x, int nid, int lastpos);
 282 int OCSP_REQUEST_get_ext_by_OBJ(OCSP_REQUEST *x, const ASN1_OBJECT *obj,
 283                                 int lastpos);
 284 int OCSP_REQUEST_get_ext_by_critical(OCSP_REQUEST *x, int crit, int lastpos);
 285 X509_EXTENSION *OCSP_REQUEST_get_ext(OCSP_REQUEST *x, int loc);
 286 X509_EXTENSION *OCSP_REQUEST_delete_ext(OCSP_REQUEST *x, int loc);
 287 void *OCSP_REQUEST_get1_ext_d2i(OCSP_REQUEST *x, int nid, int *crit,
 288                                 int *idx);
 289 int OCSP_REQUEST_add1_ext_i2d(OCSP_REQUEST *x, int nid, void *value, int crit,
 290                               unsigned long flags);
 291 int OCSP_REQUEST_add_ext(OCSP_REQUEST *x, X509_EXTENSION *ex, int loc);
 292
 293 int OCSP_ONEREQ_get_ext_count(OCSP_ONEREQ *x);
 294 int OCSP_ONEREQ_get_ext_by_NID(OCSP_ONEREQ *x, int nid, int lastpos);
 295 int OCSP_ONEREQ_get_ext_by_OBJ(OCSP_ONEREQ *x, const ASN1_OBJECT *obj, int lastpos);
 296 int OCSP_ONEREQ_get_ext_by_critical(OCSP_ONEREQ *x, int crit, int lastpos);
 297 X509_EXTENSION *OCSP_ONEREQ_get_ext(OCSP_ONEREQ *x, int loc);
 298 X509_EXTENSION *OCSP_ONEREQ_delete_ext(OCSP_ONEREQ *x, int loc);
 299 void *OCSP_ONEREQ_get1_ext_d2i(OCSP_ONEREQ *x, int nid, int *crit, int *idx);
 300 int OCSP_ONEREQ_add1_ext_i2d(OCSP_ONEREQ *x, int nid, void *value, int crit,
 301                              unsigned long flags);
 302 int OCSP_ONEREQ_add_ext(OCSP_ONEREQ *x, X509_EXTENSION *ex, int loc);
 303
 304 int OCSP_BASICRESP_get_ext_count(OCSP_BASICRESP *x);
 305 int OCSP_BASICRESP_get_ext_by_NID(OCSP_BASICRESP *x, int nid, int lastpos);
 306 int OCSP_BASICRESP_get_ext_by_OBJ(OCSP_BASICRESP *x, const ASN1_OBJECT *obj,
 307                                   int lastpos);
 308 int OCSP_BASICRESP_get_ext_by_critical(OCSP_BASICRESP *x, int crit,
 309                                        int lastpos);
 310 X509_EXTENSION *OCSP_BASICRESP_get_ext(OCSP_BASICRESP *x, int loc);
 311 X509_EXTENSION *OCSP_BASICRESP_delete_ext(OCSP_BASICRESP *x, int loc);
 312 void *OCSP_BASICRESP_get1_ext_d2i(OCSP_BASICRESP *x, int nid, int *crit,
 313                                   int *idx);
 314 int OCSP_BASICRESP_add1_ext_i2d(OCSP_BASICRESP *x, int nid, void *value,
 315                                 int crit, unsigned long flags);
 316 int OCSP_BASICRESP_add_ext(OCSP_BASICRESP *x, X509_EXTENSION *ex, int loc);
 317
 318 int OCSP_SINGLERESP_get_ext_count(OCSP_SINGLERESP *x);
 319 int OCSP_SINGLERESP_get_ext_by_NID(OCSP_SINGLERESP *x, int nid, int lastpos);
 320 int OCSP_SINGLERESP_get_ext_by_OBJ(OCSP_SINGLERESP *x, const ASN1_OBJECT *obj,
 321                                    int lastpos);
 322 int OCSP_SINGLERESP_get_ext_by_critical(OCSP_SINGLERESP *x, int crit,
 323                                         int lastpos);
 324 X509_EXTENSION *OCSP_SINGLERESP_get_ext(OCSP_SINGLERESP *x, int loc);
 325 X509_EXTENSION *OCSP_SINGLERESP_delete_ext(OCSP_SINGLERESP *x, int loc);
 326 void *OCSP_SINGLERESP_get1_ext_d2i(OCSP_SINGLERESP *x, int nid, int *crit,
 327                                    int *idx);
 328 int OCSP_SINGLERESP_add1_ext_i2d(OCSP_SINGLERESP *x, int nid, void *value,
 329                                  int crit, unsigned long flags);
 330 int OCSP_SINGLERESP_add_ext(OCSP_SINGLERESP *x, X509_EXTENSION *ex, int loc);
 331 const OCSP_CERTID *OCSP_SINGLERESP_get0_id(const OCSP_SINGLERESP *x);
 332
 333 DECLARE_ASN1_FUNCTIONS(OCSP_SINGLERESP)
 334 DECLARE_ASN1_FUNCTIONS(OCSP_CERTSTATUS)
 335 DECLARE_ASN1_FUNCTIONS(OCSP_REVOKEDINFO)
 336 DECLARE_ASN1_FUNCTIONS(OCSP_BASICRESP)
 337 DECLARE_ASN1_FUNCTIONS(OCSP_RESPDATA)
 338 DECLARE_ASN1_FUNCTIONS(OCSP_RESPID)
 339 DECLARE_ASN1_FUNCTIONS(OCSP_RESPONSE)
 340 DECLARE_ASN1_FUNCTIONS(OCSP_RESPBYTES)
 341 DECLARE_ASN1_FUNCTIONS(OCSP_ONEREQ)
 342 DECLARE_ASN1_FUNCTIONS(OCSP_CERTID)
 343 DECLARE_ASN1_FUNCTIONS(OCSP_REQUEST)
 344 DECLARE_ASN1_FUNCTIONS(OCSP_SIGNATURE)
 345 DECLARE_ASN1_FUNCTIONS(OCSP_REQINFO)
 346 DECLARE_ASN1_FUNCTIONS(OCSP_CRLID)
 347 DECLARE_ASN1_FUNCTIONS(OCSP_SERVICELOC)
 348
 349 const char *OCSP_response_status_str(long s);
 350 const char *OCSP_cert_status_str(long s);
 351 const char *OCSP_crl_reason_str(long s);
 352
 353 int OCSP_REQUEST_print(BIO *bp, OCSP_REQUEST *a, unsigned long flags);
 354 int OCSP_RESPONSE_print(BIO *bp, OCSP_RESPONSE *o, unsigned long flags);
 355
 356 int OCSP_basic_verify(OCSP_BASICRESP *bs, STACK_OF(X509) *certs,
 357                       X509_STORE *st, unsigned long flags);
 358
 359 int ERR_load_OCSP_strings(void);
 360
 361 #  ifdef  __cplusplus
 362 }
 363 #  endif
 364 # endif
 365 #endif