ocsp.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352
  1. /*
  2. * Copyright 2000-2019 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. #ifndef HEADER_OCSP_H
  10. # define HEADER_OCSP_H
  11. #include <openssl/opensslconf.h>
  12. /*
  13. * These definitions are outside the OPENSSL_NO_OCSP guard because although for
  14. * historical reasons they have OCSP_* names, they can actually be used
  15. * independently of OCSP. E.g. see RFC5280
  16. */
  17. /*-
  18. * CRLReason ::= ENUMERATED {
  19. * unspecified (0),
  20. * keyCompromise (1),
  21. * cACompromise (2),
  22. * affiliationChanged (3),
  23. * superseded (4),
  24. * cessationOfOperation (5),
  25. * certificateHold (6),
  26. * removeFromCRL (8) }
  27. */
  28. # define OCSP_REVOKED_STATUS_NOSTATUS -1
  29. # define OCSP_REVOKED_STATUS_UNSPECIFIED 0
  30. # define OCSP_REVOKED_STATUS_KEYCOMPROMISE 1
  31. # define OCSP_REVOKED_STATUS_CACOMPROMISE 2
  32. # define OCSP_REVOKED_STATUS_AFFILIATIONCHANGED 3
  33. # define OCSP_REVOKED_STATUS_SUPERSEDED 4
  34. # define OCSP_REVOKED_STATUS_CESSATIONOFOPERATION 5
  35. # define OCSP_REVOKED_STATUS_CERTIFICATEHOLD 6
  36. # define OCSP_REVOKED_STATUS_REMOVEFROMCRL 8
  37. # ifndef OPENSSL_NO_OCSP
  38. # include <openssl/ossl_typ.h>
  39. # include <openssl/x509.h>
  40. # include <openssl/x509v3.h>
  41. # include <openssl/safestack.h>
  42. # include <openssl/ocsperr.h>
  43. #ifdef __cplusplus
  44. extern "C" {
  45. #endif
  46. /* Various flags and values */
  47. # define OCSP_DEFAULT_NONCE_LENGTH 16
  48. # define OCSP_NOCERTS 0x1
  49. # define OCSP_NOINTERN 0x2
  50. # define OCSP_NOSIGS 0x4
  51. # define OCSP_NOCHAIN 0x8
  52. # define OCSP_NOVERIFY 0x10
  53. # define OCSP_NOEXPLICIT 0x20
  54. # define OCSP_NOCASIGN 0x40
  55. # define OCSP_NODELEGATED 0x80
  56. # define OCSP_NOCHECKS 0x100
  57. # define OCSP_TRUSTOTHER 0x200
  58. # define OCSP_RESPID_KEY 0x400
  59. # define OCSP_NOTIME 0x800
  60. typedef struct ocsp_cert_id_st OCSP_CERTID;
  61. DEFINE_STACK_OF(OCSP_CERTID)
  62. typedef struct ocsp_one_request_st OCSP_ONEREQ;
  63. DEFINE_STACK_OF(OCSP_ONEREQ)
  64. typedef struct ocsp_req_info_st OCSP_REQINFO;
  65. typedef struct ocsp_signature_st OCSP_SIGNATURE;
  66. typedef struct ocsp_request_st OCSP_REQUEST;
  67. # define OCSP_RESPONSE_STATUS_SUCCESSFUL 0
  68. # define OCSP_RESPONSE_STATUS_MALFORMEDREQUEST 1
  69. # define OCSP_RESPONSE_STATUS_INTERNALERROR 2
  70. # define OCSP_RESPONSE_STATUS_TRYLATER 3
  71. # define OCSP_RESPONSE_STATUS_SIGREQUIRED 5
  72. # define OCSP_RESPONSE_STATUS_UNAUTHORIZED 6
  73. typedef struct ocsp_resp_bytes_st OCSP_RESPBYTES;
  74. # define V_OCSP_RESPID_NAME 0
  75. # define V_OCSP_RESPID_KEY 1
  76. DEFINE_STACK_OF(OCSP_RESPID)
  77. typedef struct ocsp_revoked_info_st OCSP_REVOKEDINFO;
  78. # define V_OCSP_CERTSTATUS_GOOD 0
  79. # define V_OCSP_CERTSTATUS_REVOKED 1
  80. # define V_OCSP_CERTSTATUS_UNKNOWN 2
  81. typedef struct ocsp_cert_status_st OCSP_CERTSTATUS;
  82. typedef struct ocsp_single_response_st OCSP_SINGLERESP;
  83. DEFINE_STACK_OF(OCSP_SINGLERESP)
  84. typedef struct ocsp_response_data_st OCSP_RESPDATA;
  85. typedef struct ocsp_basic_response_st OCSP_BASICRESP;
  86. typedef struct ocsp_crl_id_st OCSP_CRLID;
  87. typedef struct ocsp_service_locator_st OCSP_SERVICELOC;
  88. # define PEM_STRING_OCSP_REQUEST "OCSP REQUEST"
  89. # define PEM_STRING_OCSP_RESPONSE "OCSP RESPONSE"
  90. # define d2i_OCSP_REQUEST_bio(bp,p) ASN1_d2i_bio_of(OCSP_REQUEST,OCSP_REQUEST_new,d2i_OCSP_REQUEST,bp,p)
  91. # define d2i_OCSP_RESPONSE_bio(bp,p) ASN1_d2i_bio_of(OCSP_RESPONSE,OCSP_RESPONSE_new,d2i_OCSP_RESPONSE,bp,p)
  92. # define PEM_read_bio_OCSP_REQUEST(bp,x,cb) (OCSP_REQUEST *)PEM_ASN1_read_bio( \
  93. (char *(*)())d2i_OCSP_REQUEST,PEM_STRING_OCSP_REQUEST, \
  94. bp,(char **)(x),cb,NULL)
  95. # define PEM_read_bio_OCSP_RESPONSE(bp,x,cb) (OCSP_RESPONSE *)PEM_ASN1_read_bio(\
  96. (char *(*)())d2i_OCSP_RESPONSE,PEM_STRING_OCSP_RESPONSE, \
  97. bp,(char **)(x),cb,NULL)
  98. # define PEM_write_bio_OCSP_REQUEST(bp,o) \
  99. PEM_ASN1_write_bio((int (*)())i2d_OCSP_REQUEST,PEM_STRING_OCSP_REQUEST,\
  100. bp,(char *)(o), NULL,NULL,0,NULL,NULL)
  101. # define PEM_write_bio_OCSP_RESPONSE(bp,o) \
  102. PEM_ASN1_write_bio((int (*)())i2d_OCSP_RESPONSE,PEM_STRING_OCSP_RESPONSE,\
  103. bp,(char *)(o), NULL,NULL,0,NULL,NULL)
  104. # define i2d_OCSP_RESPONSE_bio(bp,o) ASN1_i2d_bio_of(OCSP_RESPONSE,i2d_OCSP_RESPONSE,bp,o)
  105. # define i2d_OCSP_REQUEST_bio(bp,o) ASN1_i2d_bio_of(OCSP_REQUEST,i2d_OCSP_REQUEST,bp,o)
  106. # define ASN1_BIT_STRING_digest(data,type,md,len) \
  107. ASN1_item_digest(ASN1_ITEM_rptr(ASN1_BIT_STRING),type,data,md,len)
  108. # define OCSP_CERTSTATUS_dup(cs)\
  109. (OCSP_CERTSTATUS*)ASN1_dup((int(*)())i2d_OCSP_CERTSTATUS,\
  110. (char *(*)())d2i_OCSP_CERTSTATUS,(char *)(cs))
  111. OCSP_CERTID *OCSP_CERTID_dup(OCSP_CERTID *id);
  112. OCSP_RESPONSE *OCSP_sendreq_bio(BIO *b, const char *path, OCSP_REQUEST *req);
  113. OCSP_REQ_CTX *OCSP_sendreq_new(BIO *io, const char *path, OCSP_REQUEST *req,
  114. int maxline);
  115. int OCSP_REQ_CTX_nbio(OCSP_REQ_CTX *rctx);
  116. int OCSP_sendreq_nbio(OCSP_RESPONSE **presp, OCSP_REQ_CTX *rctx);
  117. OCSP_REQ_CTX *OCSP_REQ_CTX_new(BIO *io, int maxline);
  118. void OCSP_REQ_CTX_free(OCSP_REQ_CTX *rctx);
  119. void OCSP_set_max_response_length(OCSP_REQ_CTX *rctx, unsigned long len);
  120. int OCSP_REQ_CTX_i2d(OCSP_REQ_CTX *rctx, const ASN1_ITEM *it,
  121. ASN1_VALUE *val);
  122. int OCSP_REQ_CTX_nbio_d2i(OCSP_REQ_CTX *rctx, ASN1_VALUE **pval,
  123. const ASN1_ITEM *it);
  124. BIO *OCSP_REQ_CTX_get0_mem_bio(OCSP_REQ_CTX *rctx);
  125. int OCSP_REQ_CTX_http(OCSP_REQ_CTX *rctx, const char *op, const char *path);
  126. int OCSP_REQ_CTX_set1_req(OCSP_REQ_CTX *rctx, OCSP_REQUEST *req);
  127. int OCSP_REQ_CTX_add1_header(OCSP_REQ_CTX *rctx,
  128. const char *name, const char *value);
  129. OCSP_CERTID *OCSP_cert_to_id(const EVP_MD *dgst, const X509 *subject,
  130. const X509 *issuer);
  131. OCSP_CERTID *OCSP_cert_id_new(const EVP_MD *dgst,
  132. const X509_NAME *issuerName,
  133. const ASN1_BIT_STRING *issuerKey,
  134. const ASN1_INTEGER *serialNumber);
  135. OCSP_ONEREQ *OCSP_request_add0_id(OCSP_REQUEST *req, OCSP_CERTID *cid);
  136. int OCSP_request_add1_nonce(OCSP_REQUEST *req, unsigned char *val, int len);
  137. int OCSP_basic_add1_nonce(OCSP_BASICRESP *resp, unsigned char *val, int len);
  138. int OCSP_check_nonce(OCSP_REQUEST *req, OCSP_BASICRESP *bs);
  139. int OCSP_copy_nonce(OCSP_BASICRESP *resp, OCSP_REQUEST *req);
  140. int OCSP_request_set1_name(OCSP_REQUEST *req, X509_NAME *nm);
  141. int OCSP_request_add1_cert(OCSP_REQUEST *req, X509 *cert);
  142. int OCSP_request_sign(OCSP_REQUEST *req,
  143. X509 *signer,
  144. EVP_PKEY *key,
  145. const EVP_MD *dgst,
  146. STACK_OF(X509) *certs, unsigned long flags);
  147. int OCSP_response_status(OCSP_RESPONSE *resp);
  148. OCSP_BASICRESP *OCSP_response_get1_basic(OCSP_RESPONSE *resp);
  149. const ASN1_OCTET_STRING *OCSP_resp_get0_signature(const OCSP_BASICRESP *bs);
  150. const X509_ALGOR *OCSP_resp_get0_tbs_sigalg(const OCSP_BASICRESP *bs);
  151. const OCSP_RESPDATA *OCSP_resp_get0_respdata(const OCSP_BASICRESP *bs);
  152. int OCSP_resp_get0_signer(OCSP_BASICRESP *bs, X509 **signer,
  153. STACK_OF(X509) *extra_certs);
  154. int OCSP_resp_count(OCSP_BASICRESP *bs);
  155. OCSP_SINGLERESP *OCSP_resp_get0(OCSP_BASICRESP *bs, int idx);
  156. const ASN1_GENERALIZEDTIME *OCSP_resp_get0_produced_at(const OCSP_BASICRESP* bs);
  157. const STACK_OF(X509) *OCSP_resp_get0_certs(const OCSP_BASICRESP *bs);
  158. int OCSP_resp_get0_id(const OCSP_BASICRESP *bs,
  159. const ASN1_OCTET_STRING **pid,
  160. const X509_NAME **pname);
  161. int OCSP_resp_get1_id(const OCSP_BASICRESP *bs,
  162. ASN1_OCTET_STRING **pid,
  163. X509_NAME **pname);
  164. int OCSP_resp_find(OCSP_BASICRESP *bs, OCSP_CERTID *id, int last);
  165. int OCSP_single_get0_status(OCSP_SINGLERESP *single, int *reason,
  166. ASN1_GENERALIZEDTIME **revtime,
  167. ASN1_GENERALIZEDTIME **thisupd,
  168. ASN1_GENERALIZEDTIME **nextupd);
  169. int OCSP_resp_find_status(OCSP_BASICRESP *bs, OCSP_CERTID *id, int *status,
  170. int *reason,
  171. ASN1_GENERALIZEDTIME **revtime,
  172. ASN1_GENERALIZEDTIME **thisupd,
  173. ASN1_GENERALIZEDTIME **nextupd);
  174. int OCSP_check_validity(ASN1_GENERALIZEDTIME *thisupd,
  175. ASN1_GENERALIZEDTIME *nextupd, long sec, long maxsec);
  176. int OCSP_request_verify(OCSP_REQUEST *req, STACK_OF(X509) *certs,
  177. X509_STORE *store, unsigned long flags);
  178. int OCSP_parse_url(const char *url, char **phost, char **pport, char **ppath,
  179. int *pssl);
  180. int OCSP_id_issuer_cmp(const OCSP_CERTID *a, const OCSP_CERTID *b);
  181. int OCSP_id_cmp(const OCSP_CERTID *a, const OCSP_CERTID *b);
  182. int OCSP_request_onereq_count(OCSP_REQUEST *req);
  183. OCSP_ONEREQ *OCSP_request_onereq_get0(OCSP_REQUEST *req, int i);
  184. OCSP_CERTID *OCSP_onereq_get0_id(OCSP_ONEREQ *one);
  185. int OCSP_id_get0_info(ASN1_OCTET_STRING **piNameHash, ASN1_OBJECT **pmd,
  186. ASN1_OCTET_STRING **pikeyHash,
  187. ASN1_INTEGER **pserial, OCSP_CERTID *cid);
  188. int OCSP_request_is_signed(OCSP_REQUEST *req);
  189. OCSP_RESPONSE *OCSP_response_create(int status, OCSP_BASICRESP *bs);
  190. OCSP_SINGLERESP *OCSP_basic_add1_status(OCSP_BASICRESP *rsp,
  191. OCSP_CERTID *cid,
  192. int status, int reason,
  193. ASN1_TIME *revtime,
  194. ASN1_TIME *thisupd,
  195. ASN1_TIME *nextupd);
  196. int OCSP_basic_add1_cert(OCSP_BASICRESP *resp, X509 *cert);
  197. int OCSP_basic_sign(OCSP_BASICRESP *brsp,
  198. X509 *signer, EVP_PKEY *key, const EVP_MD *dgst,
  199. STACK_OF(X509) *certs, unsigned long flags);
  200. int OCSP_basic_sign_ctx(OCSP_BASICRESP *brsp,
  201. X509 *signer, EVP_MD_CTX *ctx,
  202. STACK_OF(X509) *certs, unsigned long flags);
  203. int OCSP_RESPID_set_by_name(OCSP_RESPID *respid, X509 *cert);
  204. int OCSP_RESPID_set_by_key(OCSP_RESPID *respid, X509 *cert);
  205. int OCSP_RESPID_match(OCSP_RESPID *respid, X509 *cert);
  206. X509_EXTENSION *OCSP_crlID_new(const char *url, long *n, char *tim);
  207. X509_EXTENSION *OCSP_accept_responses_new(char **oids);
  208. X509_EXTENSION *OCSP_archive_cutoff_new(char *tim);
  209. X509_EXTENSION *OCSP_url_svcloc_new(X509_NAME *issuer, const char **urls);
  210. int OCSP_REQUEST_get_ext_count(OCSP_REQUEST *x);
  211. int OCSP_REQUEST_get_ext_by_NID(OCSP_REQUEST *x, int nid, int lastpos);
  212. int OCSP_REQUEST_get_ext_by_OBJ(OCSP_REQUEST *x, const ASN1_OBJECT *obj,
  213. int lastpos);
  214. int OCSP_REQUEST_get_ext_by_critical(OCSP_REQUEST *x, int crit, int lastpos);
  215. X509_EXTENSION *OCSP_REQUEST_get_ext(OCSP_REQUEST *x, int loc);
  216. X509_EXTENSION *OCSP_REQUEST_delete_ext(OCSP_REQUEST *x, int loc);
  217. void *OCSP_REQUEST_get1_ext_d2i(OCSP_REQUEST *x, int nid, int *crit,
  218. int *idx);
  219. int OCSP_REQUEST_add1_ext_i2d(OCSP_REQUEST *x, int nid, void *value, int crit,
  220. unsigned long flags);
  221. int OCSP_REQUEST_add_ext(OCSP_REQUEST *x, X509_EXTENSION *ex, int loc);
  222. int OCSP_ONEREQ_get_ext_count(OCSP_ONEREQ *x);
  223. int OCSP_ONEREQ_get_ext_by_NID(OCSP_ONEREQ *x, int nid, int lastpos);
  224. int OCSP_ONEREQ_get_ext_by_OBJ(OCSP_ONEREQ *x, const ASN1_OBJECT *obj, int lastpos);
  225. int OCSP_ONEREQ_get_ext_by_critical(OCSP_ONEREQ *x, int crit, int lastpos);
  226. X509_EXTENSION *OCSP_ONEREQ_get_ext(OCSP_ONEREQ *x, int loc);
  227. X509_EXTENSION *OCSP_ONEREQ_delete_ext(OCSP_ONEREQ *x, int loc);
  228. void *OCSP_ONEREQ_get1_ext_d2i(OCSP_ONEREQ *x, int nid, int *crit, int *idx);
  229. int OCSP_ONEREQ_add1_ext_i2d(OCSP_ONEREQ *x, int nid, void *value, int crit,
  230. unsigned long flags);
  231. int OCSP_ONEREQ_add_ext(OCSP_ONEREQ *x, X509_EXTENSION *ex, int loc);
  232. int OCSP_BASICRESP_get_ext_count(OCSP_BASICRESP *x);
  233. int OCSP_BASICRESP_get_ext_by_NID(OCSP_BASICRESP *x, int nid, int lastpos);
  234. int OCSP_BASICRESP_get_ext_by_OBJ(OCSP_BASICRESP *x, const ASN1_OBJECT *obj,
  235. int lastpos);
  236. int OCSP_BASICRESP_get_ext_by_critical(OCSP_BASICRESP *x, int crit,
  237. int lastpos);
  238. X509_EXTENSION *OCSP_BASICRESP_get_ext(OCSP_BASICRESP *x, int loc);
  239. X509_EXTENSION *OCSP_BASICRESP_delete_ext(OCSP_BASICRESP *x, int loc);
  240. void *OCSP_BASICRESP_get1_ext_d2i(OCSP_BASICRESP *x, int nid, int *crit,
  241. int *idx);
  242. int OCSP_BASICRESP_add1_ext_i2d(OCSP_BASICRESP *x, int nid, void *value,
  243. int crit, unsigned long flags);
  244. int OCSP_BASICRESP_add_ext(OCSP_BASICRESP *x, X509_EXTENSION *ex, int loc);
  245. int OCSP_SINGLERESP_get_ext_count(OCSP_SINGLERESP *x);
  246. int OCSP_SINGLERESP_get_ext_by_NID(OCSP_SINGLERESP *x, int nid, int lastpos);
  247. int OCSP_SINGLERESP_get_ext_by_OBJ(OCSP_SINGLERESP *x, const ASN1_OBJECT *obj,
  248. int lastpos);
  249. int OCSP_SINGLERESP_get_ext_by_critical(OCSP_SINGLERESP *x, int crit,
  250. int lastpos);
  251. X509_EXTENSION *OCSP_SINGLERESP_get_ext(OCSP_SINGLERESP *x, int loc);
  252. X509_EXTENSION *OCSP_SINGLERESP_delete_ext(OCSP_SINGLERESP *x, int loc);
  253. void *OCSP_SINGLERESP_get1_ext_d2i(OCSP_SINGLERESP *x, int nid, int *crit,
  254. int *idx);
  255. int OCSP_SINGLERESP_add1_ext_i2d(OCSP_SINGLERESP *x, int nid, void *value,
  256. int crit, unsigned long flags);
  257. int OCSP_SINGLERESP_add_ext(OCSP_SINGLERESP *x, X509_EXTENSION *ex, int loc);
  258. const OCSP_CERTID *OCSP_SINGLERESP_get0_id(const OCSP_SINGLERESP *x);
  259. DECLARE_ASN1_FUNCTIONS(OCSP_SINGLERESP)
  260. DECLARE_ASN1_FUNCTIONS(OCSP_CERTSTATUS)
  261. DECLARE_ASN1_FUNCTIONS(OCSP_REVOKEDINFO)
  262. DECLARE_ASN1_FUNCTIONS(OCSP_BASICRESP)
  263. DECLARE_ASN1_FUNCTIONS(OCSP_RESPDATA)
  264. DECLARE_ASN1_FUNCTIONS(OCSP_RESPID)
  265. DECLARE_ASN1_FUNCTIONS(OCSP_RESPONSE)
  266. DECLARE_ASN1_FUNCTIONS(OCSP_RESPBYTES)
  267. DECLARE_ASN1_FUNCTIONS(OCSP_ONEREQ)
  268. DECLARE_ASN1_FUNCTIONS(OCSP_CERTID)
  269. DECLARE_ASN1_FUNCTIONS(OCSP_REQUEST)
  270. DECLARE_ASN1_FUNCTIONS(OCSP_SIGNATURE)
  271. DECLARE_ASN1_FUNCTIONS(OCSP_REQINFO)
  272. DECLARE_ASN1_FUNCTIONS(OCSP_CRLID)
  273. DECLARE_ASN1_FUNCTIONS(OCSP_SERVICELOC)
  274. const char *OCSP_response_status_str(long s);
  275. const char *OCSP_cert_status_str(long s);
  276. const char *OCSP_crl_reason_str(long s);
  277. int OCSP_REQUEST_print(BIO *bp, OCSP_REQUEST *a, unsigned long flags);
  278. int OCSP_RESPONSE_print(BIO *bp, OCSP_RESPONSE *o, unsigned long flags);
  279. int OCSP_basic_verify(OCSP_BASICRESP *bs, STACK_OF(X509) *certs,
  280. X509_STORE *st, unsigned long flags);
  281. # ifdef __cplusplus
  282. }
  283. # endif
  284. # endif
  285. #endif