include/crypto/x509.h

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