Tidy up x509_vfy callback handling
[openssl.git] / crypto / x509 / x509_lcl.h
1 /*
2  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
3  * 2013.
4  */
5 /* ====================================================================
6  * Copyright (c) 2013 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  *
20  * 3. All advertising materials mentioning features or use of this
21  *    software must display the following acknowledgment:
22  *    "This product includes software developed by the OpenSSL Project
23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
24  *
25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26  *    endorse or promote products derived from this software without
27  *    prior written permission. For written permission, please contact
28  *    licensing@OpenSSL.org.
29  *
30  * 5. Products derived from this software may not be called "OpenSSL"
31  *    nor may "OpenSSL" appear in their names without prior written
32  *    permission of the OpenSSL Project.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50  * OF THE POSSIBILITY OF SUCH DAMAGE.
51  * ====================================================================
52  *
53  * This product includes cryptographic software written by Eric Young
54  * (eay@cryptsoft.com).  This product includes software written by Tim
55  * Hudson (tjh@cryptsoft.com).
56  *
57  */
58
59 /*
60  * This structure holds all parameters associated with a verify operation by
61  * including an X509_VERIFY_PARAM structure in related structures the
62  * parameters used can be customized
63  */
64
65 struct X509_VERIFY_PARAM_st {
66     char *name;
67     time_t check_time;          /* Time to use */
68     unsigned long inh_flags;    /* Inheritance flags */
69     unsigned long flags;        /* Various verify flags */
70     int purpose;                /* purpose to check untrusted certificates */
71     int trust;                  /* trust setting to check */
72     int depth;                  /* Verify depth */
73     STACK_OF(ASN1_OBJECT) *policies; /* Permissible policies */
74     /* Peer identity details */
75     STACK_OF(OPENSSL_STRING) *hosts; /* Set of acceptable names */
76     unsigned int hostflags;     /* Flags to control matching features */
77     char *peername;             /* Matching hostname in peer certificate */
78     char *email;                /* If not NULL email address to match */
79     size_t emaillen;
80     unsigned char *ip;          /* If not NULL IP address to match */
81     size_t iplen;               /* Length of IP address */
82 };
83
84 /* No error callback if depth < 0 */
85 int x509_check_cert_time(X509_STORE_CTX *ctx, X509 *x, int depth);
86
87 /* a sequence of these are used */
88 struct x509_attributes_st {
89     ASN1_OBJECT *object;
90     STACK_OF(ASN1_TYPE) *set;
91 };
92
93 struct X509_extension_st {
94     ASN1_OBJECT *object;
95     ASN1_BOOLEAN critical;
96     ASN1_OCTET_STRING value;
97 };
98
99 /*
100  * Method to handle CRL access. In general a CRL could be very large (several
101  * Mb) and can consume large amounts of resources if stored in memory by
102  * multiple processes. This method allows general CRL operations to be
103  * redirected to more efficient callbacks: for example a CRL entry database.
104  */
105
106 #define X509_CRL_METHOD_DYNAMIC         1
107
108 struct x509_crl_method_st {
109     int flags;
110     int (*crl_init) (X509_CRL *crl);
111     int (*crl_free) (X509_CRL *crl);
112     int (*crl_lookup) (X509_CRL *crl, X509_REVOKED **ret,
113                        ASN1_INTEGER *ser, X509_NAME *issuer);
114     int (*crl_verify) (X509_CRL *crl, EVP_PKEY *pk);
115 };
116
117 typedef struct lookup_dir_hashes_st BY_DIR_HASH;
118 typedef struct lookup_dir_entry_st BY_DIR_ENTRY;
119 DEFINE_STACK_OF(BY_DIR_HASH)
120 DEFINE_STACK_OF(BY_DIR_ENTRY)
121 typedef STACK_OF(X509_NAME_ENTRY) STACK_OF_X509_NAME_ENTRY;
122 DEFINE_STACK_OF(STACK_OF_X509_NAME_ENTRY)