Add more CT utility routines to be used as part of larger patch.
[openssl.git] / crypto / x509v3 / pcy_int.h
1 /*
2  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
3  * 2004.
4  */
5 /* ====================================================================
6  * Copyright (c) 2004 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 typedef struct X509_POLICY_DATA_st X509_POLICY_DATA;
60
61 DEFINE_STACK_OF(X509_POLICY_DATA)
62
63 /* Internal structures */
64
65 /*
66  * This structure and the field names correspond to the Policy 'node' of
67  * RFC3280. NB this structure contains no pointers to parent or child data:
68  * X509_POLICY_NODE contains that. This means that the main policy data can
69  * be kept static and cached with the certificate.
70  */
71
72 struct X509_POLICY_DATA_st {
73     unsigned int flags;
74     /* Policy OID and qualifiers for this data */
75     ASN1_OBJECT *valid_policy;
76     STACK_OF(POLICYQUALINFO) *qualifier_set;
77     STACK_OF(ASN1_OBJECT) *expected_policy_set;
78 };
79
80 /* X509_POLICY_DATA flags values */
81
82 /*
83  * This flag indicates the structure has been mapped using a policy mapping
84  * extension. If policy mapping is not active its references get deleted.
85  */
86
87 #define POLICY_DATA_FLAG_MAPPED                 0x1
88
89 /*
90  * This flag indicates the data doesn't correspond to a policy in Certificate
91  * Policies: it has been mapped to any policy.
92  */
93
94 #define POLICY_DATA_FLAG_MAPPED_ANY             0x2
95
96 /* AND with flags to see if any mapping has occurred */
97
98 #define POLICY_DATA_FLAG_MAP_MASK               0x3
99
100 /* qualifiers are shared and shouldn't be freed */
101
102 #define POLICY_DATA_FLAG_SHARED_QUALIFIERS      0x4
103
104 /* Parent node is an extra node and should be freed */
105
106 #define POLICY_DATA_FLAG_EXTRA_NODE             0x8
107
108 /* Corresponding CertificatePolicies is critical */
109
110 #define POLICY_DATA_FLAG_CRITICAL               0x10
111
112 /* This structure is cached with a certificate */
113
114 struct X509_POLICY_CACHE_st {
115     /* anyPolicy data or NULL if no anyPolicy */
116     X509_POLICY_DATA *anyPolicy;
117     /* other policy data */
118     STACK_OF(X509_POLICY_DATA) *data;
119     /* If InhibitAnyPolicy present this is its value or -1 if absent. */
120     long any_skip;
121     /*
122      * If policyConstraints and requireExplicitPolicy present this is its
123      * value or -1 if absent.
124      */
125     long explicit_skip;
126     /*
127      * If policyConstraints and policyMapping present this is its value or -1
128      * if absent.
129      */
130     long map_skip;
131 };
132
133 /*
134  * #define POLICY_CACHE_FLAG_CRITICAL POLICY_DATA_FLAG_CRITICAL
135  */
136
137 /* This structure represents the relationship between nodes */
138
139 struct X509_POLICY_NODE_st {
140     /* node data this refers to */
141     const X509_POLICY_DATA *data;
142     /* Parent node */
143     X509_POLICY_NODE *parent;
144     /* Number of child nodes */
145     int nchild;
146 };
147
148 struct X509_POLICY_LEVEL_st {
149     /* Cert for this level */
150     X509 *cert;
151     /* nodes at this level */
152     STACK_OF(X509_POLICY_NODE) *nodes;
153     /* anyPolicy node */
154     X509_POLICY_NODE *anyPolicy;
155     /* Extra data */
156     /*
157      * STACK_OF(X509_POLICY_DATA) *extra_data;
158      */
159     unsigned int flags;
160 };
161
162 struct X509_POLICY_TREE_st {
163     /* This is the tree 'level' data */
164     X509_POLICY_LEVEL *levels;
165     int nlevel;
166     /*
167      * Extra policy data when additional nodes (not from the certificate) are
168      * required.
169      */
170     STACK_OF(X509_POLICY_DATA) *extra_data;
171     /* This is the authority constained policy set */
172     STACK_OF(X509_POLICY_NODE) *auth_policies;
173     STACK_OF(X509_POLICY_NODE) *user_policies;
174     unsigned int flags;
175 };
176
177 /* Set if anyPolicy present in user policies */
178 #define POLICY_FLAG_ANY_POLICY          0x2
179
180 /* Useful macros */
181
182 #define node_data_critical(data) (data->flags & POLICY_DATA_FLAG_CRITICAL)
183 #define node_critical(node) node_data_critical(node->data)
184
185 /* Internal functions */
186
187 X509_POLICY_DATA *policy_data_new(POLICYINFO *policy, const ASN1_OBJECT *id,
188                                   int crit);
189 void policy_data_free(X509_POLICY_DATA *data);
190
191 X509_POLICY_DATA *policy_cache_find_data(const X509_POLICY_CACHE *cache,
192                                          const ASN1_OBJECT *id);
193 int policy_cache_set_mapping(X509 *x, POLICY_MAPPINGS *maps);
194
195 STACK_OF(X509_POLICY_NODE) *policy_node_cmp_new(void);
196
197 void policy_cache_init(void);
198
199 void policy_cache_free(X509_POLICY_CACHE *cache);
200
201 X509_POLICY_NODE *level_find_node(const X509_POLICY_LEVEL *level,
202                                   const X509_POLICY_NODE *parent,
203                                   const ASN1_OBJECT *id);
204
205 X509_POLICY_NODE *tree_find_sk(STACK_OF(X509_POLICY_NODE) *sk,
206                                const ASN1_OBJECT *id);
207
208 X509_POLICY_NODE *level_add_node(X509_POLICY_LEVEL *level,
209                                  X509_POLICY_DATA *data,
210                                  X509_POLICY_NODE *parent,
211                                  X509_POLICY_TREE *tree);
212 void policy_node_free(X509_POLICY_NODE *node);
213 int policy_node_match(const X509_POLICY_LEVEL *lvl,
214                       const X509_POLICY_NODE *node, const ASN1_OBJECT *oid);
215
216 const X509_POLICY_CACHE *policy_cache_set(X509 *x);