crypto/include/internal/x509_int.h

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