3 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
6 /* ====================================================================
7 * Copyright (c) 2004 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgment:
23 * "This product includes software developed by the OpenSSL Project
24 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 * endorse or promote products derived from this software without
28 * prior written permission. For written permission, please contact
29 * licensing@OpenSSL.org.
31 * 5. Products derived from this software may not be called "OpenSSL"
32 * nor may "OpenSSL" appear in their names without prior written
33 * permission of the OpenSSL Project.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 * OF THE POSSIBILITY OF SUCH DAMAGE.
52 * ====================================================================
54 * This product includes cryptographic software written by Eric Young
55 * (eay@cryptsoft.com). This product includes software written by Tim
56 * Hudson (tjh@cryptsoft.com).
61 #include <openssl/x509.h>
62 #include <openssl/x509v3.h>
67 * Enable this to print out the complete policy tree at various point during
72 * #define OPENSSL_POLICY_DEBUG
75 #ifdef OPENSSL_POLICY_DEBUG
77 static void expected_print(BIO *err, X509_POLICY_LEVEL *lev,
78 X509_POLICY_NODE *node, int indent)
80 if ((lev->flags & X509_V_FLAG_INHIBIT_MAP)
81 || !(node->data->flags & POLICY_DATA_FLAG_MAP_MASK))
82 BIO_puts(err, " Not Mapped\n");
85 STACK_OF(ASN1_OBJECT) *pset = node->data->expected_policy_set;
87 BIO_puts(err, " Expected: ");
88 for (i = 0; i < sk_ASN1_OBJECT_num(pset); i++) {
89 oid = sk_ASN1_OBJECT_value(pset, i);
92 i2a_ASN1_OBJECT(err, oid);
98 static void tree_print(char *str, X509_POLICY_TREE *tree,
99 X509_POLICY_LEVEL *curr)
101 X509_POLICY_LEVEL *plev;
102 X509_POLICY_NODE *node;
105 err = BIO_new_fp(stderr, BIO_NOCLOSE);
109 curr = tree->levels + tree->nlevel;
112 BIO_printf(err, "Level print after %s\n", str);
113 BIO_printf(err, "Printing Up to Level %ld\n", curr - tree->levels);
114 for (plev = tree->levels; plev != curr; plev++) {
115 BIO_printf(err, "Level %ld, flags = %x\n",
116 plev - tree->levels, plev->flags);
117 for (i = 0; i < sk_X509_POLICY_NODE_num(plev->nodes); i++) {
118 node = sk_X509_POLICY_NODE_value(plev->nodes, i);
119 X509_POLICY_NODE_print(err, node, 2);
120 expected_print(err, plev, node, 2);
121 BIO_printf(err, " Flags: %x\n", node->data->flags);
124 X509_POLICY_NODE_print(err, plev->anyPolicy, 2);
132 # define tree_print(a,b,c) /* */
137 * Initialize policy tree. Return values:
138 * 0 Some internal error occurred.
139 * -1 Inconsistent or invalid extensions in certificates.
140 * 1 Tree initialized OK.
141 * 2 Policy tree is empty.
142 * 5 Tree OK and requireExplicitPolicy true.
143 * 6 Tree empty and requireExplicitPolicy true.
146 static int tree_init(X509_POLICY_TREE **ptree, STACK_OF(X509) *certs,
149 X509_POLICY_TREE *tree;
150 X509_POLICY_LEVEL *level;
151 const X509_POLICY_CACHE *cache;
152 X509_POLICY_DATA *data = NULL;
161 n = sk_X509_num(certs);
163 if (flags & X509_V_FLAG_EXPLICIT_POLICY)
166 explicit_policy = n + 1;
168 if (flags & X509_V_FLAG_INHIBIT_ANY)
173 if (flags & X509_V_FLAG_INHIBIT_MAP)
178 /* Can't do anything with just a trust anchor */
182 * First setup policy cache in all certificates apart from the trust
183 * anchor. Note any bad cache results on the way. Also can calculate
184 * explicit_policy value at this point.
186 for (i = n - 2; i >= 0; i--) {
187 x = sk_X509_value(certs, i);
188 X509_check_purpose(x, -1, -1);
189 cache = policy_cache_set(x);
190 /* If cache NULL something bad happened: return immediately */
194 * If inconsistent extensions keep a note of it but continue
196 if (x->ex_flags & EXFLAG_INVALID_POLICY)
199 * Otherwise if we have no data (hence no CertificatePolicies) and
200 * haven't already set an inconsistent code note it.
202 else if ((ret == 1) && !cache->data)
204 if (explicit_policy > 0) {
205 if (!(x->ex_flags & EXFLAG_SI))
207 if ((cache->explicit_skip != -1)
208 && (cache->explicit_skip < explicit_policy))
209 explicit_policy = cache->explicit_skip;
214 if (ret == 2 && !explicit_policy)
219 /* If we get this far initialize the tree */
221 tree = OPENSSL_malloc(sizeof(*tree));
227 tree->levels = OPENSSL_malloc(sizeof(*tree->levels) * n);
229 tree->extra_data = NULL;
230 tree->auth_policies = NULL;
231 tree->user_policies = NULL;
238 memset(tree->levels, 0, n * sizeof(X509_POLICY_LEVEL));
242 level = tree->levels;
244 /* Root data: initialize to anyPolicy */
246 data = policy_data_new(NULL, OBJ_nid2obj(NID_any_policy), 0);
248 if (!data || !level_add_node(level, data, NULL, tree))
251 for (i = n - 2; i >= 0; i--) {
253 x = sk_X509_value(certs, i);
254 cache = policy_cache_set(x);
255 CRYPTO_add(&x->references, 1, CRYPTO_LOCK_X509);
258 if (!cache->anyPolicy)
259 level->flags |= X509_V_FLAG_INHIBIT_ANY;
261 /* Determine inhibit any and inhibit map flags */
264 * Any matching allowed if certificate is self issued and not the
267 if (!(x->ex_flags & EXFLAG_SI) || (i == 0))
268 level->flags |= X509_V_FLAG_INHIBIT_ANY;
270 if (!(x->ex_flags & EXFLAG_SI))
272 if ((cache->any_skip >= 0)
273 && (cache->any_skip < any_skip))
274 any_skip = cache->any_skip;
278 level->flags |= X509_V_FLAG_INHIBIT_MAP;
280 if (!(x->ex_flags & EXFLAG_SI))
282 if ((cache->map_skip >= 0)
283 && (cache->map_skip < map_skip))
284 map_skip = cache->map_skip;
298 X509_policy_tree_free(tree);
304 static int tree_link_matching_nodes(X509_POLICY_LEVEL *curr,
305 const X509_POLICY_DATA *data)
307 X509_POLICY_LEVEL *last = curr - 1;
308 X509_POLICY_NODE *node;
310 /* Iterate through all in nodes linking matches */
311 for (i = 0; i < sk_X509_POLICY_NODE_num(last->nodes); i++) {
312 node = sk_X509_POLICY_NODE_value(last->nodes, i);
313 if (policy_node_match(last, node, data->valid_policy)) {
314 if (!level_add_node(curr, data, node, NULL))
319 if (!matched && last->anyPolicy) {
320 if (!level_add_node(curr, data, last->anyPolicy, NULL))
327 * This corresponds to RFC3280 6.1.3(d)(1): link any data from
328 * CertificatePolicies onto matching parent or anyPolicy if no match.
331 static int tree_link_nodes(X509_POLICY_LEVEL *curr,
332 const X509_POLICY_CACHE *cache)
335 X509_POLICY_DATA *data;
337 for (i = 0; i < sk_X509_POLICY_DATA_num(cache->data); i++) {
338 data = sk_X509_POLICY_DATA_value(cache->data, i);
339 /* Look for matching nodes in previous level */
340 if (!tree_link_matching_nodes(curr, data))
347 * This corresponds to RFC3280 6.1.3(d)(2): Create new data for any unmatched
348 * policies in the parent and link to anyPolicy.
351 static int tree_add_unmatched(X509_POLICY_LEVEL *curr,
352 const X509_POLICY_CACHE *cache,
353 const ASN1_OBJECT *id,
354 X509_POLICY_NODE *node, X509_POLICY_TREE *tree)
356 X509_POLICY_DATA *data;
358 id = node->data->valid_policy;
360 * Create a new node with qualifiers from anyPolicy and id from unmatched
363 data = policy_data_new(NULL, id, node_critical(node));
367 /* Curr may not have anyPolicy */
368 data->qualifier_set = cache->anyPolicy->qualifier_set;
369 data->flags |= POLICY_DATA_FLAG_SHARED_QUALIFIERS;
370 if (!level_add_node(curr, data, node, tree)) {
371 policy_data_free(data);
378 static int tree_link_unmatched(X509_POLICY_LEVEL *curr,
379 const X509_POLICY_CACHE *cache,
380 X509_POLICY_NODE *node, X509_POLICY_TREE *tree)
382 const X509_POLICY_LEVEL *last = curr - 1;
385 if ((last->flags & X509_V_FLAG_INHIBIT_MAP)
386 || !(node->data->flags & POLICY_DATA_FLAG_MAPPED)) {
387 /* If no policy mapping: matched if one child present */
390 if (!tree_add_unmatched(curr, cache, NULL, node, tree))
394 /* If mapping: matched if one child per expected policy set */
395 STACK_OF(ASN1_OBJECT) *expset = node->data->expected_policy_set;
396 if (node->nchild == sk_ASN1_OBJECT_num(expset))
398 /* Locate unmatched nodes */
399 for (i = 0; i < sk_ASN1_OBJECT_num(expset); i++) {
400 ASN1_OBJECT *oid = sk_ASN1_OBJECT_value(expset, i);
401 if (level_find_node(curr, node, oid))
403 if (!tree_add_unmatched(curr, cache, oid, node, tree))
413 static int tree_link_any(X509_POLICY_LEVEL *curr,
414 const X509_POLICY_CACHE *cache,
415 X509_POLICY_TREE *tree)
418 X509_POLICY_NODE *node;
419 X509_POLICY_LEVEL *last = curr - 1;
421 for (i = 0; i < sk_X509_POLICY_NODE_num(last->nodes); i++) {
422 node = sk_X509_POLICY_NODE_value(last->nodes, i);
424 if (!tree_link_unmatched(curr, cache, node, tree))
427 /* Finally add link to anyPolicy */
428 if (last->anyPolicy) {
429 if (!level_add_node(curr, cache->anyPolicy, last->anyPolicy, NULL))
436 * Prune the tree: delete any child mapped child data on the current level
437 * then proceed up the tree deleting any data with no children. If we ever
438 * have no data on a level we can halt because the tree will be empty.
441 static int tree_prune(X509_POLICY_TREE *tree, X509_POLICY_LEVEL *curr)
443 STACK_OF(X509_POLICY_NODE) *nodes;
444 X509_POLICY_NODE *node;
447 if (curr->flags & X509_V_FLAG_INHIBIT_MAP) {
448 for (i = sk_X509_POLICY_NODE_num(nodes) - 1; i >= 0; i--) {
449 node = sk_X509_POLICY_NODE_value(nodes, i);
450 /* Delete any mapped data: see RFC3280 XXXX */
451 if (node->data->flags & POLICY_DATA_FLAG_MAP_MASK) {
452 node->parent->nchild--;
454 (void)sk_X509_POLICY_NODE_delete(nodes, i);
462 for (i = sk_X509_POLICY_NODE_num(nodes) - 1; i >= 0; i--) {
463 node = sk_X509_POLICY_NODE_value(nodes, i);
464 if (node->nchild == 0) {
465 node->parent->nchild--;
467 (void)sk_X509_POLICY_NODE_delete(nodes, i);
470 if (curr->anyPolicy && !curr->anyPolicy->nchild) {
471 if (curr->anyPolicy->parent)
472 curr->anyPolicy->parent->nchild--;
473 OPENSSL_free(curr->anyPolicy);
474 curr->anyPolicy = NULL;
476 if (curr == tree->levels) {
477 /* If we zapped anyPolicy at top then tree is empty */
478 if (!curr->anyPolicy)
488 static int tree_add_auth_node(STACK_OF(X509_POLICY_NODE) **pnodes,
489 X509_POLICY_NODE *pcy)
492 *pnodes = policy_node_cmp_new();
495 } else if (sk_X509_POLICY_NODE_find(*pnodes, pcy) != -1)
498 if (!sk_X509_POLICY_NODE_push(*pnodes, pcy))
506 * Calculate the authority set based on policy tree. The 'pnodes' parameter
507 * is used as a store for the set of policy nodes used to calculate the user
508 * set. If the authority set is not anyPolicy then pnodes will just point to
509 * the authority set. If however the authority set is anyPolicy then the set
510 * of valid policies (other than anyPolicy) is store in pnodes. The return
511 * value of '2' is used in this case to indicate that pnodes should be freed.
514 static int tree_calculate_authority_set(X509_POLICY_TREE *tree,
515 STACK_OF(X509_POLICY_NODE) **pnodes)
517 X509_POLICY_LEVEL *curr;
518 X509_POLICY_NODE *node, *anyptr;
519 STACK_OF(X509_POLICY_NODE) **addnodes;
521 curr = tree->levels + tree->nlevel - 1;
523 /* If last level contains anyPolicy set is anyPolicy */
524 if (curr->anyPolicy) {
525 if (!tree_add_auth_node(&tree->auth_policies, curr->anyPolicy))
529 /* Add policies to authority set */
530 addnodes = &tree->auth_policies;
533 for (i = 1; i < tree->nlevel; i++) {
535 * If no anyPolicy node on this this level it can't appear on lower
536 * levels so end search.
538 if (!(anyptr = curr->anyPolicy))
541 for (j = 0; j < sk_X509_POLICY_NODE_num(curr->nodes); j++) {
542 node = sk_X509_POLICY_NODE_value(curr->nodes, j);
543 if ((node->parent == anyptr)
544 && !tree_add_auth_node(addnodes, node))
549 if (addnodes == pnodes)
552 *pnodes = tree->auth_policies;
557 static int tree_calculate_user_set(X509_POLICY_TREE *tree,
558 STACK_OF(ASN1_OBJECT) *policy_oids,
559 STACK_OF(X509_POLICY_NODE) *auth_nodes)
562 X509_POLICY_NODE *node;
565 X509_POLICY_NODE *anyPolicy;
566 X509_POLICY_DATA *extra;
569 * Check if anyPolicy present in authority constrained policy set: this
570 * will happen if it is a leaf node.
573 if (sk_ASN1_OBJECT_num(policy_oids) <= 0)
576 anyPolicy = tree->levels[tree->nlevel - 1].anyPolicy;
578 for (i = 0; i < sk_ASN1_OBJECT_num(policy_oids); i++) {
579 oid = sk_ASN1_OBJECT_value(policy_oids, i);
580 if (OBJ_obj2nid(oid) == NID_any_policy) {
581 tree->flags |= POLICY_FLAG_ANY_POLICY;
586 for (i = 0; i < sk_ASN1_OBJECT_num(policy_oids); i++) {
587 oid = sk_ASN1_OBJECT_value(policy_oids, i);
588 node = tree_find_sk(auth_nodes, oid);
593 * Create a new node with policy ID from user set and qualifiers
596 extra = policy_data_new(NULL, oid, node_critical(anyPolicy));
599 extra->qualifier_set = anyPolicy->data->qualifier_set;
600 extra->flags = POLICY_DATA_FLAG_SHARED_QUALIFIERS
601 | POLICY_DATA_FLAG_EXTRA_NODE;
602 node = level_add_node(NULL, extra, anyPolicy->parent, tree);
604 if (!tree->user_policies) {
605 tree->user_policies = sk_X509_POLICY_NODE_new_null();
606 if (!tree->user_policies)
609 if (!sk_X509_POLICY_NODE_push(tree->user_policies, node))
616 static int tree_evaluate(X509_POLICY_TREE *tree)
619 X509_POLICY_LEVEL *curr = tree->levels + 1;
620 const X509_POLICY_CACHE *cache;
622 for (i = 1; i < tree->nlevel; i++, curr++) {
623 cache = policy_cache_set(curr->cert);
624 if (!tree_link_nodes(curr, cache))
627 if (!(curr->flags & X509_V_FLAG_INHIBIT_ANY)
628 && !tree_link_any(curr, cache, tree))
630 tree_print("before tree_prune()", tree, curr);
631 ret = tree_prune(tree, curr);
640 static void exnode_free(X509_POLICY_NODE *node)
642 if (node->data && (node->data->flags & POLICY_DATA_FLAG_EXTRA_NODE))
646 void X509_policy_tree_free(X509_POLICY_TREE *tree)
648 X509_POLICY_LEVEL *curr;
654 sk_X509_POLICY_NODE_free(tree->auth_policies);
655 sk_X509_POLICY_NODE_pop_free(tree->user_policies, exnode_free);
657 for (i = 0, curr = tree->levels; i < tree->nlevel; i++, curr++) {
658 X509_free(curr->cert);
659 sk_X509_POLICY_NODE_pop_free(curr->nodes, policy_node_free);
660 policy_node_free(curr->anyPolicy);
663 sk_X509_POLICY_DATA_pop_free(tree->extra_data, policy_data_free);
664 OPENSSL_free(tree->levels);
670 * Application policy checking function.
674 * -1 One or more certificates contain invalid or inconsistent extensions
675 * -2 User constrained policy set empty and requireExplicit true.
678 int X509_policy_check(X509_POLICY_TREE **ptree, int *pexplicit_policy,
679 STACK_OF(X509) *certs,
680 STACK_OF(ASN1_OBJECT) *policy_oids, unsigned int flags)
683 X509_POLICY_TREE *tree = NULL;
684 STACK_OF(X509_POLICY_NODE) *nodes, *auth_nodes = NULL;
687 *pexplicit_policy = 0;
688 ret = tree_init(&tree, certs, flags);
692 /* Tree empty requireExplicit False: OK */
696 /* Some internal error */
700 /* Some internal error */
704 /* Tree empty requireExplicit True: Error */
707 *pexplicit_policy = 1;
710 /* Tree OK requireExplicit True: OK and continue */
712 *pexplicit_policy = 1;
715 /* Tree OK: continue */
720 * tree_init() returns success and a null tree
721 * if it's just looking at a trust anchor.
722 * I'm not sure that returning success here is
723 * correct, but I'm sure that reporting this
724 * as an internal error which our caller
725 * interprets as a malloc failure is wrong.
733 ret = tree_evaluate(tree);
735 tree_print("tree_evaluate()", tree, NULL);
740 /* Return value 2 means tree empty */
742 X509_policy_tree_free(tree);
743 if (*pexplicit_policy)
749 /* Tree is not empty: continue */
751 ret = tree_calculate_authority_set(tree, &auth_nodes);
756 if (!tree_calculate_user_set(tree, policy_oids, auth_nodes))
760 sk_X509_POLICY_NODE_free(auth_nodes);
765 if (*pexplicit_policy) {
766 nodes = X509_policy_tree_get0_user_policies(tree);
767 if (sk_X509_POLICY_NODE_num(nodes) <= 0)
775 X509_policy_tree_free(tree);