x509_crl.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309
  1. /*
  2. * Copyright 2014-2023 The GmSSL Project. All Rights Reserved.
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the License); you may
  5. * not use this file except in compliance with the License.
  6. *
  7. * http://www.apache.org/licenses/LICENSE-2.0
  8. */
  9. #ifndef GMSSL_X509_CRL_H
  10. #define GMSSL_X509_CRL_H
  11. #include <time.h>
  12. #include <stdint.h>
  13. #include <gmssl/sm2.h>
  14. #ifdef __cplusplus
  15. extern "C" {
  16. #endif
  17. /*
  18. CRLReason ::= ENUMERATED
  19. */
  20. typedef enum {
  21. X509_cr_unspecified = 0,
  22. X509_cr_key_compromise = 1,
  23. X509_cr_ca_compromise = 2 ,
  24. X509_cr_affiliation_changed = 3,
  25. X509_cr_superseded = 4,
  26. X509_cr_cessation_of_operation = 5,
  27. X509_cr_certificate_hold = 6,
  28. X509_cr_not_assigned = 7,
  29. X509_cr_remove_from_crl = 8,
  30. X509_cr_privilege_withdrawn = 9,
  31. X509_cr_aa_compromise = 10,
  32. } X509_CRL_REASON;
  33. const char *x509_crl_reason_name(int reason);
  34. int x509_crl_reason_from_name(int *reason, const char *name);
  35. int x509_crl_reason_to_der(int reason, uint8_t **out, size_t *outlen);
  36. int x509_crl_reason_from_der(int *reason, const uint8_t **in, size_t *inlen);
  37. int x509_implicit_crl_reason_from_der(int index, int *reason, const uint8_t **in, size_t *inlen);
  38. /*
  39. CRL Entry Extensions:
  40. OID_ce_crl_reasons ENUMERATED non-critical
  41. OID_ce_invalidity_date GeneralizedTime non-critical
  42. OID_ce_certificate_issuer GeneralNames MUST critical
  43. */
  44. const char *x509_crl_entry_ext_id_name(int oid);
  45. int x509_crl_entry_ext_id_from_name(const char *name);
  46. int x509_crl_entry_ext_id_to_der(int oid, uint8_t **out, size_t *outlen);
  47. int x509_crl_entry_ext_id_from_der(int *oid, const uint8_t **in, size_t *inlen);
  48. int x509_crl_entry_ext_to_der(int oid, int critical, const uint8_t *val, size_t vlen, uint8_t **out, size_t *outlen);
  49. int x509_crl_entry_ext_from_der(int *oid, int *critical, const uint8_t **val, size_t *vlen, const uint8_t **in, size_t *inlen);
  50. int x509_crl_entry_ext_critical_check(int oid, int critical);
  51. int x509_crl_entry_ext_print(FILE *fp, int fmt, int ind, const char *label, const uint8_t *d, size_t dlen);
  52. int x509_crl_reason_ext_to_der(int critical, int reason, uint8_t **out, size_t *outlen);
  53. int x509_invalidity_date_ext_to_der(int critical, time_t date, uint8_t **out, size_t *outlen);
  54. int x509_cert_issuer_ext_to_der(int critical, const uint8_t *d, size_t dlen, uint8_t **out, size_t *outlen);
  55. int x509_crl_entry_ext_from_der_ex(int *oid, int *critical,
  56. int *reason, time_t *invalid_date, const uint8_t **cert_issuer, size_t *cert_issuer_len,
  57. const uint8_t **in, size_t *inlen);
  58. int x509_crl_entry_exts_to_der(
  59. int reason, time_t invalid_date, const uint8_t *cert_issuer, size_t cert_issuer_len,
  60. uint8_t **out, size_t *outlen);
  61. int x509_crl_entry_exts_from_der(
  62. int *reason, time_t *invalid_date, const uint8_t **cert_issuer, size_t *cert_issuer_len,
  63. const uint8_t **in, size_t *inlen);
  64. int x509_crl_entry_exts_get(const uint8_t *d, size_t dlen,
  65. int *reason, time_t *invalid_date, const uint8_t **cert_issuer, size_t *cert_issuer_len);
  66. int x509_crl_entry_exts_check(const uint8_t *d, size_t dlen);
  67. int x509_crl_entry_exts_print(FILE *fp, int fmt, int ind, const char *label, const uint8_t *d, size_t dlen);
  68. /*
  69. RevokedCertificate ::= SEQUENCE {
  70. userCertificate CertificateSerialNumber,
  71. revocationDate Time,
  72. crlEntryExtensions Extensions OPTIONAL }
  73. */
  74. int x509_revoked_cert_to_der(
  75. const uint8_t *serial, size_t serial_len, time_t revoke_date,
  76. const uint8_t *crl_entry_exts, size_t crl_entry_exts_len,
  77. uint8_t **out, size_t *outlen);
  78. int x509_revoked_cert_from_der(
  79. const uint8_t **serial, size_t *serial_len, time_t *revoke_date,
  80. const uint8_t **crl_entry_exts, size_t *crl_entry_exts_len,
  81. const uint8_t **in, size_t *inlen);
  82. int x509_revoked_cert_to_der_ex(
  83. const uint8_t *serial, size_t serial_len, time_t revoke_date,
  84. int reason, time_t invalid_date, const uint8_t *cert_issuer, size_t cert_issuer_len,
  85. uint8_t **out, size_t *outlen);
  86. int x509_revoked_cert_from_der_ex(
  87. const uint8_t **serial, size_t *serial_len, time_t *revoke_date,
  88. int *reason, time_t *invalid_date, const uint8_t **cert_issuer, size_t *cert_issuer_len,
  89. const uint8_t **in, size_t *inlen);
  90. int x509_revoked_cert_print(FILE *fp, int fmt, int ind, const char *label, const uint8_t *d, size_t dlen);
  91. int x509_cert_revoke_to_der(const uint8_t *cert, size_t certlen,
  92. time_t revoke_date, int reason, time_t invalid_date, const uint8_t *cert_issuer, size_t cert_issuer_len,
  93. uint8_t **out, size_t *outlen);
  94. /*
  95. RevokedCertificates ::= SEQUENCE OF RevokedCertificate
  96. */
  97. int x509_revoked_certs_find_revoked_cert_by_serial_number(const uint8_t *d, size_t dlen,
  98. const uint8_t *serial, size_t serial_len, time_t *revoke_date,
  99. const uint8_t **crl_entry_exts, size_t *crl_entry_exts_len);
  100. int x509_revoked_certs_print(FILE *fp, int fmt, int ind, const char *label, const uint8_t *d, size_t dlen);
  101. /*
  102. CRL Extensions:
  103. OID_ce_authority_key_identifier AuthorityKeyIdentifier critical or non-critical
  104. OID_ce_issuer_alt_name GeneralNames SHOULD non-critical
  105. OID_ce_crl_number INTEGER MUST non-critical
  106. OID_ce_delta_crl_indicator INTEGER MUST critical
  107. OID_ce_issuing_distribution_point IssuingDistributionPoint critical
  108. OID_ce_freshest_crl CRLDistributionPoints MUST non-critical
  109. OID_pe_authority_info_access AccessDescriptions MUST non-critical
  110. */
  111. const char *x509_crl_ext_id_name(int oid);
  112. int x509_crl_ext_id_from_name(const char *name);
  113. int x509_crl_ext_id_to_der(int oid, uint8_t **out, size_t *outlen);
  114. int x509_crl_ext_id_from_der(int *oid, const uint8_t **in, size_t *inlen);
  115. int x509_crl_ext_id_from_der_ex(int *oid, uint32_t *nodes, size_t *nodes_cnt, const uint8_t **in, size_t *inlen);
  116. /*
  117. IssuingDistributionPoint ::= SEQUENCE {
  118. distributionPoint [0] EXPLICIT DistributionPointName OPTIONAL,
  119. onlyContainsUserCerts [1] IMPLICIT BOOLEAN DEFAULT FALSE,
  120. onlyContainsCACerts [2] IMPLICIT BOOLEAN DEFAULT FALSE,
  121. onlySomeReasons [3] IMPLICIT ReasonFlags OPTIONAL,
  122. indirectCRL [4] IMPLICIT BOOLEAN DEFAULT FALSE,
  123. onlyContainsAttributeCerts [5] IMPLICIT BOOLEAN DEFAULT FALSE }
  124. */
  125. int x509_issuing_distribution_point_to_der(
  126. const char *dist_point_uri, size_t dist_point_uri_len,
  127. int only_contains_user_certs,
  128. int only_contains_ca_certs,
  129. int only_some_reasons,
  130. int indirect_crl,
  131. int only_contains_attr_certs,
  132. uint8_t **out, size_t *outlen);
  133. int x509_issuing_distribution_point_from_der(
  134. int *dist_point_choice, const uint8_t **dist_point, size_t *dist_point_len,
  135. int *only_contains_user_certs,
  136. int *only_contains_ca_certs,
  137. int *only_some_reasons,
  138. int *indirect_crl,
  139. int *only_contains_attr_certs,
  140. const uint8_t **in, size_t *inlen);
  141. int x509_issuing_distribution_point_print(FILE *fp, int fmt, int ind, const char *label, const uint8_t *d, size_t dlen);
  142. int x509_crl_ext_to_der(int oid, int critical, const uint8_t *val, size_t vlen, uint8_t **out, size_t *outlen);
  143. int x509_crl_ext_from_der_ex(int *oid, uint32_t *nodes, size_t *nodes_cnt,
  144. int *critical, const uint8_t **val, size_t *vlen,
  145. const uint8_t **in, size_t *inlen);
  146. int x509_crl_ext_critical_check(int oid, int critical);
  147. int x509_crl_ext_print(FILE *fp, int fmt, int ind, const char *label, const uint8_t *d, size_t dlen);
  148. int x509_crl_exts_add_authority_key_identifier(
  149. uint8_t *exts, size_t *extslen, size_t maxlen,
  150. int critical,
  151. const uint8_t *keyid, size_t keyid_len,
  152. const uint8_t *issuer, size_t issuer_len,
  153. const uint8_t *serial, size_t serial_len);
  154. int x509_crl_exts_add_default_authority_key_identifier(uint8_t *exts, size_t *extslen, size_t maxlen,
  155. const SM2_KEY *public_key);
  156. int x509_crl_exts_add_issuer_alt_name(
  157. uint8_t *exts, size_t *extslen, size_t maxlen,
  158. int critical,
  159. const uint8_t *d, size_t dlen);
  160. int x509_crl_exts_add_crl_number_ex(
  161. uint8_t *exts, size_t *extslen, size_t maxlen,
  162. int oid, int critical, int num);
  163. int x509_crl_exts_add_crl_number(
  164. uint8_t *exts, size_t *extslen, size_t maxlen,
  165. int critical,
  166. int num);
  167. int x509_crl_exts_add_delta_crl_indicator(
  168. uint8_t *exts, size_t *extslen, size_t maxlen,
  169. int critical,
  170. int num);
  171. int x509_crl_exts_add_issuing_distribution_point(
  172. uint8_t *exts, size_t *extslen, size_t maxlen,
  173. int critical,
  174. const char *dist_point_uri, size_t dist_point_uri_len,
  175. int only_contains_user_certs,
  176. int only_contains_ca_certs,
  177. int only_some_reasons,
  178. int indirect_crl,
  179. int only_contains_attr_certs);
  180. int x509_crl_exts_add_freshest_crl(
  181. uint8_t *exts, size_t *extslen, size_t maxlen, int critical,
  182. const char *http_uri, size_t http_urilen,
  183. const char *ldap_uri, size_t ldap_urilen);
  184. int x509_crl_exts_add_authority_info_acess(
  185. uint8_t *exts, size_t *extslen, size_t maxlen, int critical,
  186. const char *ca_issuers_uri, size_t ca_issuers_urilen,
  187. const char *ocsp_uri, size_t ocsp_urilen);
  188. #define x509_crl_exts_to_der(d,dlen,out,outlen) x509_explicit_exts_to_der(0,d,dlen,out,outlen)
  189. #define x509_crl_exts_from_der(d,dlen,in,inlen) x509_explicit_exts_from_der(0,d,dlen,in,inlen)
  190. int x509_crl_exts_check(const uint8_t *d, size_t dlen);
  191. int x509_crl_exts_print(FILE *fp, int fmt, int ind, const char *label, const uint8_t *d, size_t dlen);
  192. /*
  193. TBSCertList ::= SEQUENCE {
  194. version INTEGER OPTIONAL, -- if present, MUST be v2
  195. signature AlgorithmIdentifier,
  196. issuer Name,
  197. thisUpdate Time,
  198. nextUpdate Time OPTIONAL,
  199. revokedCertificates RevokedCertificates OPTIONAL,
  200. crlExtensions [0] EXPLICIT Extensions OPTIONAL, -- if present, MUST be v2 }
  201. */
  202. int x509_tbs_crl_to_der(
  203. int version,
  204. int signature_algor,
  205. const uint8_t *issuer, size_t issuer_len,
  206. time_t this_update,
  207. time_t next_update,
  208. const uint8_t *revoked_certs, size_t revoked_certs_len,
  209. const uint8_t *exts, size_t exts_len,
  210. uint8_t **out, size_t *outlen);
  211. int x509_tbs_crl_from_der(
  212. int *version,
  213. int *signature_algor,
  214. const uint8_t **issuer, size_t *issuer_len,
  215. time_t *this_update,
  216. time_t *next_update,
  217. const uint8_t **revoked_certs, size_t *revoked_certs_len,
  218. const uint8_t **exts, size_t *exts_len,
  219. const uint8_t **in, size_t *inlen);
  220. int x509_tbs_crl_print(FILE *fp, int fmt, int ind, const char *label, const uint8_t *d, size_t dlen);
  221. /*
  222. CertificateList ::= SEQUENCE {
  223. tbsCertList TBSCertList,
  224. signatureAlgorithm AlgorithmIdentifier,
  225. signatureValue BIT STRING }
  226. */
  227. int x509_crl_to_der(const uint8_t *a, size_t alen, uint8_t **out, size_t *outlen);
  228. int x509_crl_from_der(const uint8_t **a, size_t *alen, const uint8_t **in, size_t *inlen);
  229. int x509_crl_to_pem(const uint8_t *a, size_t alen, FILE *fp);
  230. int x509_crl_from_pem(uint8_t *a, size_t *alen, size_t maxlen, FILE *fp);
  231. int x509_crl_print(FILE *fp, int fmt, int ind, const char *label, const uint8_t *a, size_t alen);
  232. int x509_crl_sign_to_der(
  233. int version, int sig_alg,
  234. const uint8_t *issuer, size_t issuer_len,
  235. time_t this_update, time_t next_update,
  236. const uint8_t *revoked_certs, size_t revoked_certs_len,
  237. const uint8_t *crl_exts, size_t crl_exts_len,
  238. const SM2_KEY *sign_key, const char *signer_id, size_t signer_id_len,
  239. uint8_t **out, size_t *outlen);
  240. int x509_crl_from_der_ex(
  241. int *version,
  242. int *inner_sig_alg,
  243. const uint8_t **issuer, size_t *issuer_len,
  244. time_t *this_update, time_t *next_update,
  245. const uint8_t **revoked_certs, size_t *revoked_certs_len,
  246. const uint8_t **exts, size_t *exts_len,
  247. int *sig_alg, const uint8_t **sig, size_t *siglen,
  248. const uint8_t **in, size_t *inlen);
  249. int x509_crl_check(const uint8_t *a, size_t alen, time_t now);
  250. int x509_crl_verify(const uint8_t *a, size_t alen,
  251. const SM2_KEY *sign_pub_key, const char *signer_id, size_t signer_id_len);
  252. int x509_crl_verify_by_ca_cert(const uint8_t *a, size_t alen, const uint8_t *cacert, size_t cacertlen,
  253. const char *signer_id, size_t signer_id_len);
  254. int x509_crl_get_details(const uint8_t *crl, size_t crl_len,
  255. int *version,
  256. int *inner_sig_alg,
  257. const uint8_t **issuer, size_t *issuer_len,
  258. time_t *this_update,
  259. time_t *next_update,
  260. const uint8_t **revoked_certs, size_t *revoked_certs_len,
  261. const uint8_t **exts, size_t *exts_len,
  262. int *signature_algor,
  263. const uint8_t **sig, size_t *siglen);
  264. int x509_crl_get_issuer(const uint8_t *crl, size_t crl_len,
  265. const uint8_t **issuer, size_t *issuer_len);
  266. int x509_crl_get_revoked_certs(const uint8_t *a, size_t alen, const uint8_t **d, size_t *dlen);
  267. int x509_crl_find_revoked_cert_by_serial_number(const uint8_t *a, size_t alen,
  268. const uint8_t *serial, size_t serial_len, time_t *revoke_date,
  269. const uint8_t **entry_exts, size_t *entry_exts_len);
  270. int x509_crls_print(FILE *fp, int fmt, int ind, const char *label, const uint8_t *d, size_t dlen);
  271. int x509_crl_new_from_uri(uint8_t **crl, size_t *crl_len, const char *uri, size_t urilen);
  272. int x509_crl_new_from_cert(uint8_t **crl, size_t *crl_len, const uint8_t *cert, size_t certlen);
  273. int x509_cert_check_crl(const uint8_t *cert, size_t certlen, const uint8_t *cacert, size_t cacertlen,
  274. const char *ca_signer_id, size_t ca_signer_id_len);
  275. #ifdef __cplusplus
  276. }
  277. #endif
  278. #endif