x509.h 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291
  1. /*
  2. * Copyright 2015-2021 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. #include "internal/refcount.h"
  10. #include <openssl/x509.h>
  11. #include <openssl/conf.h>
  12. /* Internal X509 structures and functions: not for application use */
  13. /* Note: unless otherwise stated a field pointer is mandatory and should
  14. * never be set to NULL: the ASN.1 code and accessors rely on mandatory
  15. * fields never being NULL.
  16. */
  17. /*
  18. * name entry structure, equivalent to AttributeTypeAndValue defined
  19. * in RFC5280 et al.
  20. */
  21. struct X509_name_entry_st {
  22. ASN1_OBJECT *object; /* AttributeType */
  23. ASN1_STRING *value; /* AttributeValue */
  24. int set; /* index of RDNSequence for this entry */
  25. int size; /* temp variable */
  26. };
  27. /* Name from RFC 5280. */
  28. struct X509_name_st {
  29. STACK_OF(X509_NAME_ENTRY) *entries; /* DN components */
  30. int modified; /* true if 'bytes' needs to be built */
  31. BUF_MEM *bytes; /* cached encoding: cannot be NULL */
  32. /* canonical encoding used for rapid Name comparison */
  33. unsigned char *canon_enc;
  34. int canon_enclen;
  35. } /* X509_NAME */ ;
  36. /* Signature info structure */
  37. struct x509_sig_info_st {
  38. /* NID of message digest */
  39. int mdnid;
  40. /* NID of public key algorithm */
  41. int pknid;
  42. /* Security bits */
  43. int secbits;
  44. /* Various flags */
  45. uint32_t flags;
  46. };
  47. /* PKCS#10 certificate request */
  48. struct X509_req_info_st {
  49. ASN1_ENCODING enc; /* cached encoding of signed part */
  50. ASN1_INTEGER *version; /* version, defaults to v1(0) so can be NULL */
  51. X509_NAME *subject; /* certificate request DN */
  52. X509_PUBKEY *pubkey; /* public key of request */
  53. /*
  54. * Zero or more attributes.
  55. * NB: although attributes is a mandatory field some broken
  56. * encodings omit it so this may be NULL in that case.
  57. */
  58. STACK_OF(X509_ATTRIBUTE) *attributes;
  59. };
  60. struct X509_req_st {
  61. X509_REQ_INFO req_info; /* signed certificate request data */
  62. X509_ALGOR sig_alg; /* signature algorithm */
  63. ASN1_BIT_STRING *signature; /* signature */
  64. CRYPTO_REF_COUNT references;
  65. CRYPTO_RWLOCK *lock;
  66. };
  67. struct X509_crl_info_st {
  68. ASN1_INTEGER *version; /* version: defaults to v1(0) so may be NULL */
  69. X509_ALGOR sig_alg; /* signature algorithm */
  70. X509_NAME *issuer; /* CRL issuer name */
  71. ASN1_TIME *lastUpdate; /* lastUpdate field */
  72. ASN1_TIME *nextUpdate; /* nextUpdate field: optional */
  73. STACK_OF(X509_REVOKED) *revoked; /* revoked entries: optional */
  74. STACK_OF(X509_EXTENSION) *extensions; /* extensions: optional */
  75. ASN1_ENCODING enc; /* encoding of signed portion of CRL */
  76. };
  77. struct X509_crl_st {
  78. X509_CRL_INFO crl; /* signed CRL data */
  79. X509_ALGOR sig_alg; /* CRL signature algorithm */
  80. ASN1_BIT_STRING signature; /* CRL signature */
  81. CRYPTO_REF_COUNT references;
  82. int flags;
  83. /*
  84. * Cached copies of decoded extension values, since extensions
  85. * are optional any of these can be NULL.
  86. */
  87. AUTHORITY_KEYID *akid;
  88. ISSUING_DIST_POINT *idp;
  89. /* Convenient breakdown of IDP */
  90. int idp_flags;
  91. int idp_reasons;
  92. /* CRL and base CRL numbers for delta processing */
  93. ASN1_INTEGER *crl_number;
  94. ASN1_INTEGER *base_crl_number;
  95. STACK_OF(GENERAL_NAMES) *issuers;
  96. /* hash of CRL */
  97. unsigned char sha1_hash[SHA_DIGEST_LENGTH];
  98. /* alternative method to handle this CRL */
  99. const X509_CRL_METHOD *meth;
  100. void *meth_data;
  101. CRYPTO_RWLOCK *lock;
  102. };
  103. struct x509_revoked_st {
  104. ASN1_INTEGER serialNumber; /* revoked entry serial number */
  105. ASN1_TIME *revocationDate; /* revocation date */
  106. STACK_OF(X509_EXTENSION) *extensions; /* CRL entry extensions: optional */
  107. /* decoded value of CRLissuer extension: set if indirect CRL */
  108. STACK_OF(GENERAL_NAME) *issuer;
  109. /* revocation reason: set to CRL_REASON_NONE if reason extension absent */
  110. int reason;
  111. /*
  112. * CRL entries are reordered for faster lookup of serial numbers. This
  113. * field contains the original load sequence for this entry.
  114. */
  115. int sequence;
  116. };
  117. /*
  118. * This stuff is certificate "auxiliary info": it contains details which are
  119. * useful in certificate stores and databases. When used this is tagged onto
  120. * the end of the certificate itself. OpenSSL specific structure not defined
  121. * in any RFC.
  122. */
  123. struct x509_cert_aux_st {
  124. STACK_OF(ASN1_OBJECT) *trust; /* trusted uses */
  125. STACK_OF(ASN1_OBJECT) *reject; /* rejected uses */
  126. ASN1_UTF8STRING *alias; /* "friendly name" */
  127. ASN1_OCTET_STRING *keyid; /* key id of private key */
  128. STACK_OF(X509_ALGOR) *other; /* other unspecified info */
  129. };
  130. struct x509_cinf_st {
  131. ASN1_INTEGER *version; /* [ 0 ] default of v1 */
  132. ASN1_INTEGER serialNumber;
  133. X509_ALGOR signature;
  134. X509_NAME *issuer;
  135. X509_VAL validity;
  136. X509_NAME *subject;
  137. X509_PUBKEY *key;
  138. ASN1_BIT_STRING *issuerUID; /* [ 1 ] optional in v2 */
  139. ASN1_BIT_STRING *subjectUID; /* [ 2 ] optional in v2 */
  140. STACK_OF(X509_EXTENSION) *extensions; /* [ 3 ] optional in v3 */
  141. ASN1_ENCODING enc;
  142. };
  143. struct x509_st {
  144. X509_CINF cert_info;
  145. X509_ALGOR sig_alg;
  146. ASN1_BIT_STRING signature;
  147. X509_SIG_INFO siginf;
  148. CRYPTO_REF_COUNT references;
  149. CRYPTO_EX_DATA ex_data;
  150. /* These contain copies of various extension values */
  151. long ex_pathlen;
  152. long ex_pcpathlen;
  153. uint32_t ex_flags;
  154. uint32_t ex_kusage;
  155. uint32_t ex_xkusage;
  156. uint32_t ex_nscert;
  157. ASN1_OCTET_STRING *skid;
  158. AUTHORITY_KEYID *akid;
  159. X509_POLICY_CACHE *policy_cache;
  160. STACK_OF(DIST_POINT) *crldp;
  161. STACK_OF(GENERAL_NAME) *altname;
  162. NAME_CONSTRAINTS *nc;
  163. #ifndef OPENSSL_NO_RFC3779
  164. STACK_OF(IPAddressFamily) *rfc3779_addr;
  165. struct ASIdentifiers_st *rfc3779_asid;
  166. # endif
  167. unsigned char sha1_hash[SHA_DIGEST_LENGTH];
  168. X509_CERT_AUX *aux;
  169. CRYPTO_RWLOCK *lock;
  170. volatile int ex_cached;
  171. } /* X509 */ ;
  172. /*
  173. * This is a used when verifying cert chains. Since the gathering of the
  174. * cert chain can take some time (and have to be 'retried', this needs to be
  175. * kept and passed around.
  176. */
  177. struct x509_store_ctx_st { /* X509_STORE_CTX */
  178. X509_STORE *ctx;
  179. /* The following are set by the caller */
  180. /* The cert to check */
  181. X509 *cert;
  182. /* chain of X509s - untrusted - passed in */
  183. STACK_OF(X509) *untrusted;
  184. /* set of CRLs passed in */
  185. STACK_OF(X509_CRL) *crls;
  186. X509_VERIFY_PARAM *param;
  187. /* Other info for use with get_issuer() */
  188. void *other_ctx;
  189. /* Callbacks for various operations */
  190. /* called to verify a certificate */
  191. int (*verify) (X509_STORE_CTX *ctx);
  192. /* error callback */
  193. int (*verify_cb) (int ok, X509_STORE_CTX *ctx);
  194. /* get issuers cert from ctx */
  195. int (*get_issuer) (X509 **issuer, X509_STORE_CTX *ctx, X509 *x);
  196. /* check issued */
  197. int (*check_issued) (X509_STORE_CTX *ctx, X509 *x, X509 *issuer);
  198. /* Check revocation status of chain */
  199. int (*check_revocation) (X509_STORE_CTX *ctx);
  200. /* retrieve CRL */
  201. int (*get_crl) (X509_STORE_CTX *ctx, X509_CRL **crl, X509 *x);
  202. /* Check CRL validity */
  203. int (*check_crl) (X509_STORE_CTX *ctx, X509_CRL *crl);
  204. /* Check certificate against CRL */
  205. int (*cert_crl) (X509_STORE_CTX *ctx, X509_CRL *crl, X509 *x);
  206. /* Check policy status of the chain */
  207. int (*check_policy) (X509_STORE_CTX *ctx);
  208. STACK_OF(X509) *(*lookup_certs) (X509_STORE_CTX *ctx, X509_NAME *nm);
  209. STACK_OF(X509_CRL) *(*lookup_crls) (X509_STORE_CTX *ctx, X509_NAME *nm);
  210. int (*cleanup) (X509_STORE_CTX *ctx);
  211. /* The following is built up */
  212. /* if 0, rebuild chain */
  213. int valid;
  214. /* number of untrusted certs */
  215. int num_untrusted;
  216. /* chain of X509s - built up and trusted */
  217. STACK_OF(X509) *chain;
  218. /* Valid policy tree */
  219. X509_POLICY_TREE *tree;
  220. /* Require explicit policy value */
  221. int explicit_policy;
  222. /* When something goes wrong, this is why */
  223. int error_depth;
  224. int error;
  225. X509 *current_cert;
  226. /* cert currently being tested as valid issuer */
  227. X509 *current_issuer;
  228. /* current CRL */
  229. X509_CRL *current_crl;
  230. /* score of current CRL */
  231. int current_crl_score;
  232. /* Reason mask */
  233. unsigned int current_reasons;
  234. /* For CRL path validation: parent context */
  235. X509_STORE_CTX *parent;
  236. CRYPTO_EX_DATA ex_data;
  237. SSL_DANE *dane;
  238. /* signed via bare TA public key, rather than CA certificate */
  239. int bare_ta_signed;
  240. };
  241. /* PKCS#8 private key info structure */
  242. struct pkcs8_priv_key_info_st {
  243. ASN1_INTEGER *version;
  244. X509_ALGOR *pkeyalg;
  245. ASN1_OCTET_STRING *pkey;
  246. STACK_OF(X509_ATTRIBUTE) *attributes;
  247. };
  248. struct X509_sig_st {
  249. X509_ALGOR *algor;
  250. ASN1_OCTET_STRING *digest;
  251. };
  252. struct x509_object_st {
  253. /* one of the above types */
  254. X509_LOOKUP_TYPE type;
  255. union {
  256. char *ptr;
  257. X509 *x509;
  258. X509_CRL *crl;
  259. EVP_PKEY *pkey;
  260. } data;
  261. };
  262. int a2i_ipadd(unsigned char *ipout, const char *ipasc);
  263. int x509_set1_time(ASN1_TIME **ptm, const ASN1_TIME *tm);
  264. void x509_init_sig_info(X509 *x);
  265. int x509v3_add_len_value_uchar(const char *name, const unsigned char *value,
  266. size_t vallen, STACK_OF(CONF_VALUE) **extlist);