crypto/x509/x509_local.h

   1 /*
   2  * Copyright 2014-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
  12 /*
  13  * This structure holds all parameters associated with a verify operation by
  14  * including an X509_VERIFY_PARAM structure in related structures the
  15  * parameters used can be customized
  16  */
  17
  18 struct X509_VERIFY_PARAM_st {
  19     char *name;
  20     time_t check_time;          /* Time to use */
  21     uint32_t inh_flags;         /* Inheritance flags */
  22     unsigned long flags;        /* Various verify flags */
  23     int purpose;                /* purpose to check untrusted certificates */
  24     int trust;                  /* trust setting to check */
  25     int depth;                  /* Verify depth */
  26     int auth_level;             /* Security level for chain verification */
  27     STACK_OF(ASN1_OBJECT) *policies; /* Permissible policies */
  28     /* Peer identity details */
  29     STACK_OF(OPENSSL_STRING) *hosts; /* Set of acceptable names */
  30     unsigned int hostflags;     /* Flags to control matching features */
  31     char *peername;             /* Matching hostname in peer certificate */
  32     char *email;                /* If not NULL email address to match */
  33     size_t emaillen;
  34     unsigned char *ip;          /* If not NULL IP address to match */
  35     size_t iplen;               /* Length of IP address */
  36 };
  37
  38 /* No error callback if depth < 0 */
  39 int x509_check_cert_time(X509_STORE_CTX *ctx, X509 *x, int depth);
  40
  41 /* a sequence of these are used */
  42 struct x509_attributes_st {
  43     ASN1_OBJECT *object;
  44     STACK_OF(ASN1_TYPE) *set;
  45 };
  46
  47 struct X509_extension_st {
  48     ASN1_OBJECT *object;
  49     ASN1_BOOLEAN critical;
  50     ASN1_OCTET_STRING value;
  51 };
  52
  53 /*
  54  * Method to handle CRL access. In general a CRL could be very large (several
  55  * Mb) and can consume large amounts of resources if stored in memory by
  56  * multiple processes. This method allows general CRL operations to be
  57  * redirected to more efficient callbacks: for example a CRL entry database.
  58  */
  59
  60 #define X509_CRL_METHOD_DYNAMIC         1
  61
  62 struct x509_crl_method_st {
  63     int flags;
  64     int (*crl_init) (X509_CRL *crl);
  65     int (*crl_free) (X509_CRL *crl);
  66     int (*crl_lookup) (X509_CRL *crl, X509_REVOKED **ret,
  67                        const ASN1_INTEGER *ser, const X509_NAME *issuer);
  68     int (*crl_verify) (X509_CRL *crl, EVP_PKEY *pk);
  69 };
  70
  71 struct x509_lookup_method_st {
  72     char *name;
  73     int (*new_item) (X509_LOOKUP *ctx);
  74     void (*free) (X509_LOOKUP *ctx);
  75     int (*init) (X509_LOOKUP *ctx);
  76     int (*shutdown) (X509_LOOKUP *ctx);
  77     int (*ctrl) (X509_LOOKUP *ctx, int cmd, const char *argc, long argl,
  78                  char **ret);
  79     int (*get_by_subject) (X509_LOOKUP *ctx, X509_LOOKUP_TYPE type,
  80                            const X509_NAME *name, X509_OBJECT *ret);
  81     int (*get_by_issuer_serial) (X509_LOOKUP *ctx, X509_LOOKUP_TYPE type,
  82                                  const X509_NAME *name,
  83                                  const ASN1_INTEGER *serial,
  84                                  X509_OBJECT *ret);
  85     int (*get_by_fingerprint) (X509_LOOKUP *ctx, X509_LOOKUP_TYPE type,
  86                                const unsigned char *bytes, int len,
  87                                X509_OBJECT *ret);
  88     int (*get_by_alias) (X509_LOOKUP *ctx, X509_LOOKUP_TYPE type,
  89                          const char *str, int len, X509_OBJECT *ret);
  90 };
  91
  92 /* This is the functions plus an instance of the local variables. */
  93 struct x509_lookup_st {
  94     int init;                   /* have we been started */
  95     int skip;                   /* don't use us. */
  96     X509_LOOKUP_METHOD *method; /* the functions */
  97     void *method_data;          /* method data */
  98     X509_STORE *store_ctx;      /* who owns us */
  99 };
 100
 101 /*
 102  * This is used to hold everything.  It is used for all certificate
 103  * validation.  Once we have a certificate chain, the 'verify' function is
 104  * then called to actually check the cert chain.
 105  */
 106 struct x509_store_st {
 107     /* The following is a cache of trusted certs */
 108     int cache;                  /* if true, stash any hits */
 109     STACK_OF(X509_OBJECT) *objs; /* Cache of all objects */
 110     /* These are external lookup methods */
 111     STACK_OF(X509_LOOKUP) *get_cert_methods;
 112     X509_VERIFY_PARAM *param;
 113     /* Callbacks for various operations */
 114     /* called to verify a certificate */
 115     int (*verify) (X509_STORE_CTX *ctx);
 116     /* error callback */
 117     int (*verify_cb) (int ok, X509_STORE_CTX *ctx);
 118     /* get issuers cert from ctx */
 119     int (*get_issuer) (X509 **issuer, X509_STORE_CTX *ctx, X509 *x);
 120     /* check issued */
 121     int (*check_issued) (X509_STORE_CTX *ctx, X509 *x, X509 *issuer);
 122     /* Check revocation status of chain */
 123     int (*check_revocation) (X509_STORE_CTX *ctx);
 124     /* retrieve CRL */
 125     int (*get_crl) (X509_STORE_CTX *ctx, X509_CRL **crl, X509 *x);
 126     /* Check CRL validity */
 127     int (*check_crl) (X509_STORE_CTX *ctx, X509_CRL *crl);
 128     /* Check certificate against CRL */
 129     int (*cert_crl) (X509_STORE_CTX *ctx, X509_CRL *crl, X509 *x);
 130     /* Check policy status of the chain */
 131     int (*check_policy) (X509_STORE_CTX *ctx);
 132     STACK_OF(X509) *(*lookup_certs) (X509_STORE_CTX *ctx,
 133                                      const X509_NAME *nm);
 134     /* cannot constify 'ctx' param due to lookup_certs_sk() in x509_vfy.c */
 135     STACK_OF(X509_CRL) *(*lookup_crls) (const X509_STORE_CTX *ctx,
 136                                         const X509_NAME *nm);
 137     int (*cleanup) (X509_STORE_CTX *ctx);
 138     CRYPTO_EX_DATA ex_data;
 139     CRYPTO_REF_COUNT references;
 140     CRYPTO_RWLOCK *lock;
 141 };
 142
 143 typedef struct lookup_dir_hashes_st BY_DIR_HASH;
 144 typedef struct lookup_dir_entry_st BY_DIR_ENTRY;
 145 DEFINE_STACK_OF(BY_DIR_HASH)
 146 DEFINE_STACK_OF(BY_DIR_ENTRY)
 147 typedef STACK_OF(X509_NAME_ENTRY) STACK_OF_X509_NAME_ENTRY;
 148 DEFINE_STACK_OF(STACK_OF_X509_NAME_ENTRY)
 149
 150 void x509_set_signature_info(X509_SIG_INFO *siginf, const X509_ALGOR *alg,
 151                              const ASN1_STRING *sig);