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);
107 curr = tree->levels + tree->nlevel;
110 BIO_printf(err, "Level print after %s\n", str);
111 BIO_printf(err, "Printing Up to Level %ld\n", curr - tree->levels);
112 for (plev = tree->levels; plev != curr; plev++) {
113 BIO_printf(err, "Level %ld, flags = %x\n",
114 plev - tree->levels, plev->flags);
115 for (i = 0; i < sk_X509_POLICY_NODE_num(plev->nodes); i++) {
116 node = sk_X509_POLICY_NODE_value(plev->nodes, i);
117 X509_POLICY_NODE_print(err, node, 2);
118 expected_print(err, plev, node, 2);
119 BIO_printf(err, " Flags: %x\n", node->data->flags);
122 X509_POLICY_NODE_print(err, plev->anyPolicy, 2);
130 # define tree_print(a,b,c) /* */
135 * Initialize policy tree. Return values:
136 * 0 Some internal error occurred.
137 * -1 Inconsistent or invalid extensions in certificates.
138 * 1 Tree initialized OK.
139 * 2 Policy tree is empty.
140 * 5 Tree OK and requireExplicitPolicy true.
141 * 6 Tree empty and requireExplicitPolicy true.
144 static int tree_init(X509_POLICY_TREE **ptree, STACK_OF(X509) *certs,
147 X509_POLICY_TREE *tree;
148 X509_POLICY_LEVEL *level;
149 const X509_POLICY_CACHE *cache;
150 X509_POLICY_DATA *data = NULL;
158 n = sk_X509_num(certs);
161 /* Disable policy mapping for now... */
162 flags |= X509_V_FLAG_INHIBIT_MAP;
165 if (flags & X509_V_FLAG_EXPLICIT_POLICY)
168 explicit_policy = n + 1;
170 if (flags & X509_V_FLAG_INHIBIT_ANY)
175 if (flags & X509_V_FLAG_INHIBIT_MAP)
180 /* Can't do anything with just a trust anchor */
184 * First setup policy cache in all certificates apart from the trust
185 * anchor. Note any bad cache results on the way. Also can calculate
186 * explicit_policy value at this point.
188 for (i = n - 2; i >= 0; i--) {
189 x = sk_X509_value(certs, i);
190 X509_check_purpose(x, -1, -1);
191 cache = policy_cache_set(x);
192 /* If cache NULL something bad happened: return immediately */
196 * If inconsistent extensions keep a note of it but continue
198 if (x->ex_flags & EXFLAG_INVALID_POLICY)
201 * Otherwise if we have no data (hence no CertificatePolicies) and
202 * haven't already set an inconsistent code note it.
204 else if ((ret == 1) && !cache->data)
206 if (explicit_policy > 0) {
207 if (!(x->ex_flags & EXFLAG_SI))
209 if ((cache->explicit_skip != -1)
210 && (cache->explicit_skip < explicit_policy))
211 explicit_policy = cache->explicit_skip;
216 if (ret == 2 && !explicit_policy)
221 /* If we get this far initialize the tree */
223 tree = OPENSSL_malloc(sizeof(X509_POLICY_TREE));
229 tree->levels = OPENSSL_malloc(sizeof(X509_POLICY_LEVEL) * n);
231 tree->extra_data = NULL;
232 tree->auth_policies = NULL;
233 tree->user_policies = NULL;
240 memset(tree->levels, 0, n * sizeof(X509_POLICY_LEVEL));
244 level = tree->levels;
246 /* Root data: initialize to anyPolicy */
248 data = policy_data_new(NULL, OBJ_nid2obj(NID_any_policy), 0);
250 if (!data || !level_add_node(level, data, NULL, tree))
253 for (i = n - 2; i >= 0; i--) {
255 x = sk_X509_value(certs, i);
256 cache = policy_cache_set(x);
257 CRYPTO_add(&x->references, 1, CRYPTO_LOCK_X509);
260 if (!cache->anyPolicy)
261 level->flags |= X509_V_FLAG_INHIBIT_ANY;
263 /* Determine inhibit any and inhibit map flags */
266 * Any matching allowed if certificate is self issued and not the
269 if (!(x->ex_flags & EXFLAG_SI) || (i == 0))
270 level->flags |= X509_V_FLAG_INHIBIT_ANY;
272 if (!(x->ex_flags & EXFLAG_SI))
274 if ((cache->any_skip >= 0)
275 && (cache->any_skip < any_skip))
276 any_skip = cache->any_skip;
280 level->flags |= X509_V_FLAG_INHIBIT_MAP;
282 if (!(x->ex_flags & EXFLAG_SI))
284 if ((cache->map_skip >= 0)
285 && (cache->map_skip < map_skip))
286 map_skip = cache->map_skip;
300 X509_policy_tree_free(tree);
306 static int tree_link_matching_nodes(X509_POLICY_LEVEL *curr,
307 const X509_POLICY_DATA *data)
309 X509_POLICY_LEVEL *last = curr - 1;
310 X509_POLICY_NODE *node;
312 /* Iterate through all in nodes linking matches */
313 for (i = 0; i < sk_X509_POLICY_NODE_num(last->nodes); i++) {
314 node = sk_X509_POLICY_NODE_value(last->nodes, i);
315 if (policy_node_match(last, node, data->valid_policy)) {
316 if (!level_add_node(curr, data, node, NULL))
321 if (!matched && last->anyPolicy) {
322 if (!level_add_node(curr, data, last->anyPolicy, NULL))
329 * This corresponds to RFC3280 6.1.3(d)(1): link any data from
330 * CertificatePolicies onto matching parent or anyPolicy if no match.
333 static int tree_link_nodes(X509_POLICY_LEVEL *curr,
334 const X509_POLICY_CACHE *cache)
337 X509_POLICY_DATA *data;
339 for (i = 0; i < sk_X509_POLICY_DATA_num(cache->data); i++) {
340 data = sk_X509_POLICY_DATA_value(cache->data, i);
342 * If a node is mapped any it doesn't have a corresponding
343 * CertificatePolicies entry. However such an identical node would
344 * be created if anyPolicy matching is enabled because there would be
345 * no match with the parent valid_policy_set. So we create link
346 * because then it will have the mapping flags right and we can prune
350 if ((data->flags & POLICY_DATA_FLAG_MAPPED_ANY)
351 && !(curr->flags & X509_V_FLAG_INHIBIT_ANY))
354 /* Look for matching nodes in previous level */
355 if (!tree_link_matching_nodes(curr, data))
362 * This corresponds to RFC3280 6.1.3(d)(2): Create new data for any unmatched
363 * policies in the parent and link to anyPolicy.
366 static int tree_add_unmatched(X509_POLICY_LEVEL *curr,
367 const X509_POLICY_CACHE *cache,
368 const ASN1_OBJECT *id,
369 X509_POLICY_NODE *node, X509_POLICY_TREE *tree)
371 X509_POLICY_DATA *data;
373 id = node->data->valid_policy;
375 * Create a new node with qualifiers from anyPolicy and id from unmatched
378 data = policy_data_new(NULL, id, node_critical(node));
382 /* Curr may not have anyPolicy */
383 data->qualifier_set = cache->anyPolicy->qualifier_set;
384 data->flags |= POLICY_DATA_FLAG_SHARED_QUALIFIERS;
385 if (!level_add_node(curr, data, node, tree)) {
386 policy_data_free(data);
393 static int tree_link_unmatched(X509_POLICY_LEVEL *curr,
394 const X509_POLICY_CACHE *cache,
395 X509_POLICY_NODE *node, X509_POLICY_TREE *tree)
397 const X509_POLICY_LEVEL *last = curr - 1;
400 if ((last->flags & X509_V_FLAG_INHIBIT_MAP)
401 || !(node->data->flags & POLICY_DATA_FLAG_MAPPED)) {
402 /* If no policy mapping: matched if one child present */
405 if (!tree_add_unmatched(curr, cache, NULL, node, tree))
409 /* If mapping: matched if one child per expected policy set */
410 STACK_OF(ASN1_OBJECT) *expset = node->data->expected_policy_set;
411 if (node->nchild == sk_ASN1_OBJECT_num(expset))
413 /* Locate unmatched nodes */
414 for (i = 0; i < sk_ASN1_OBJECT_num(expset); i++) {
415 ASN1_OBJECT *oid = sk_ASN1_OBJECT_value(expset, i);
416 if (level_find_node(curr, node, oid))
418 if (!tree_add_unmatched(curr, cache, oid, node, tree))
428 static int tree_link_any(X509_POLICY_LEVEL *curr,
429 const X509_POLICY_CACHE *cache,
430 X509_POLICY_TREE *tree)
434 * X509_POLICY_DATA *data;
436 X509_POLICY_NODE *node;
437 X509_POLICY_LEVEL *last = curr - 1;
439 for (i = 0; i < sk_X509_POLICY_NODE_num(last->nodes); i++) {
440 node = sk_X509_POLICY_NODE_value(last->nodes, i);
442 if (!tree_link_unmatched(curr, cache, node, tree))
448 * Skip any node with any children: we only want unmathced nodes.
449 * Note: need something better for policy mapping because each node
450 * may have multiple children
456 * Create a new node with qualifiers from anyPolicy and id from
459 data = policy_data_new(NULL, node->data->valid_policy,
460 node_critical(node));
464 /* Curr may not have anyPolicy */
465 data->qualifier_set = cache->anyPolicy->qualifier_set;
466 data->flags |= POLICY_DATA_FLAG_SHARED_QUALIFIERS;
467 if (!level_add_node(curr, data, node, tree)) {
468 policy_data_free(data);
474 /* Finally add link to anyPolicy */
475 if (last->anyPolicy) {
476 if (!level_add_node(curr, cache->anyPolicy, last->anyPolicy, NULL))
483 * Prune the tree: delete any child mapped child data on the current level
484 * then proceed up the tree deleting any data with no children. If we ever
485 * have no data on a level we can halt because the tree will be empty.
488 static int tree_prune(X509_POLICY_TREE *tree, X509_POLICY_LEVEL *curr)
490 STACK_OF(X509_POLICY_NODE) *nodes;
491 X509_POLICY_NODE *node;
494 if (curr->flags & X509_V_FLAG_INHIBIT_MAP) {
495 for (i = sk_X509_POLICY_NODE_num(nodes) - 1; i >= 0; i--) {
496 node = sk_X509_POLICY_NODE_value(nodes, i);
497 /* Delete any mapped data: see RFC3280 XXXX */
498 if (node->data->flags & POLICY_DATA_FLAG_MAP_MASK) {
499 node->parent->nchild--;
501 (void)sk_X509_POLICY_NODE_delete(nodes, i);
509 for (i = sk_X509_POLICY_NODE_num(nodes) - 1; i >= 0; i--) {
510 node = sk_X509_POLICY_NODE_value(nodes, i);
511 if (node->nchild == 0) {
512 node->parent->nchild--;
514 (void)sk_X509_POLICY_NODE_delete(nodes, i);
517 if (curr->anyPolicy && !curr->anyPolicy->nchild) {
518 if (curr->anyPolicy->parent)
519 curr->anyPolicy->parent->nchild--;
520 OPENSSL_free(curr->anyPolicy);
521 curr->anyPolicy = NULL;
523 if (curr == tree->levels) {
524 /* If we zapped anyPolicy at top then tree is empty */
525 if (!curr->anyPolicy)
535 static int tree_add_auth_node(STACK_OF(X509_POLICY_NODE) **pnodes,
536 X509_POLICY_NODE *pcy)
539 *pnodes = policy_node_cmp_new();
542 } else if (sk_X509_POLICY_NODE_find(*pnodes, pcy) != -1)
545 if (!sk_X509_POLICY_NODE_push(*pnodes, pcy))
553 * Calculate the authority set based on policy tree. The 'pnodes' parameter
554 * is used as a store for the set of policy nodes used to calculate the user
555 * set. If the authority set is not anyPolicy then pnodes will just point to
556 * the authority set. If however the authority set is anyPolicy then the set
557 * of valid policies (other than anyPolicy) is store in pnodes. The return
558 * value of '2' is used in this case to indicate that pnodes should be freed.
561 static int tree_calculate_authority_set(X509_POLICY_TREE *tree,
562 STACK_OF(X509_POLICY_NODE) **pnodes)
564 X509_POLICY_LEVEL *curr;
565 X509_POLICY_NODE *node, *anyptr;
566 STACK_OF(X509_POLICY_NODE) **addnodes;
568 curr = tree->levels + tree->nlevel - 1;
570 /* If last level contains anyPolicy set is anyPolicy */
571 if (curr->anyPolicy) {
572 if (!tree_add_auth_node(&tree->auth_policies, curr->anyPolicy))
576 /* Add policies to authority set */
577 addnodes = &tree->auth_policies;
580 for (i = 1; i < tree->nlevel; i++) {
582 * If no anyPolicy node on this this level it can't appear on lower
583 * levels so end search.
585 if (!(anyptr = curr->anyPolicy))
588 for (j = 0; j < sk_X509_POLICY_NODE_num(curr->nodes); j++) {
589 node = sk_X509_POLICY_NODE_value(curr->nodes, j);
590 if ((node->parent == anyptr)
591 && !tree_add_auth_node(addnodes, node))
596 if (addnodes == pnodes)
599 *pnodes = tree->auth_policies;
604 static int tree_calculate_user_set(X509_POLICY_TREE *tree,
605 STACK_OF(ASN1_OBJECT) *policy_oids,
606 STACK_OF(X509_POLICY_NODE) *auth_nodes)
609 X509_POLICY_NODE *node;
612 X509_POLICY_NODE *anyPolicy;
613 X509_POLICY_DATA *extra;
616 * Check if anyPolicy present in authority constrained policy set: this
617 * will happen if it is a leaf node.
620 if (sk_ASN1_OBJECT_num(policy_oids) <= 0)
623 anyPolicy = tree->levels[tree->nlevel - 1].anyPolicy;
625 for (i = 0; i < sk_ASN1_OBJECT_num(policy_oids); i++) {
626 oid = sk_ASN1_OBJECT_value(policy_oids, i);
627 if (OBJ_obj2nid(oid) == NID_any_policy) {
628 tree->flags |= POLICY_FLAG_ANY_POLICY;
633 for (i = 0; i < sk_ASN1_OBJECT_num(policy_oids); i++) {
634 oid = sk_ASN1_OBJECT_value(policy_oids, i);
635 node = tree_find_sk(auth_nodes, oid);
640 * Create a new node with policy ID from user set and qualifiers
643 extra = policy_data_new(NULL, oid, node_critical(anyPolicy));
646 extra->qualifier_set = anyPolicy->data->qualifier_set;
647 extra->flags = POLICY_DATA_FLAG_SHARED_QUALIFIERS
648 | POLICY_DATA_FLAG_EXTRA_NODE;
649 node = level_add_node(NULL, extra, anyPolicy->parent, tree);
651 if (!tree->user_policies) {
652 tree->user_policies = sk_X509_POLICY_NODE_new_null();
653 if (!tree->user_policies)
656 if (!sk_X509_POLICY_NODE_push(tree->user_policies, node))
663 static int tree_evaluate(X509_POLICY_TREE *tree)
666 X509_POLICY_LEVEL *curr = tree->levels + 1;
667 const X509_POLICY_CACHE *cache;
669 for (i = 1; i < tree->nlevel; i++, curr++) {
670 cache = policy_cache_set(curr->cert);
671 if (!tree_link_nodes(curr, cache))
674 if (!(curr->flags & X509_V_FLAG_INHIBIT_ANY)
675 && !tree_link_any(curr, cache, tree))
677 tree_print("before tree_prune()", tree, curr);
678 ret = tree_prune(tree, curr);
687 static void exnode_free(X509_POLICY_NODE *node)
689 if (node->data && (node->data->flags & POLICY_DATA_FLAG_EXTRA_NODE))
693 void X509_policy_tree_free(X509_POLICY_TREE *tree)
695 X509_POLICY_LEVEL *curr;
701 sk_X509_POLICY_NODE_free(tree->auth_policies);
702 sk_X509_POLICY_NODE_pop_free(tree->user_policies, exnode_free);
704 for (i = 0, curr = tree->levels; i < tree->nlevel; i++, curr++) {
706 X509_free(curr->cert);
708 sk_X509_POLICY_NODE_pop_free(curr->nodes, policy_node_free);
710 policy_node_free(curr->anyPolicy);
713 if (tree->extra_data)
714 sk_X509_POLICY_DATA_pop_free(tree->extra_data, policy_data_free);
716 OPENSSL_free(tree->levels);
722 * Application policy checking function.
726 * -1 One or more certificates contain invalid or inconsistent extensions
727 * -2 User constrained policy set empty and requireExplicit true.
730 int X509_policy_check(X509_POLICY_TREE **ptree, int *pexplicit_policy,
731 STACK_OF(X509) *certs,
732 STACK_OF(ASN1_OBJECT) *policy_oids, unsigned int flags)
735 X509_POLICY_TREE *tree = NULL;
736 STACK_OF(X509_POLICY_NODE) *nodes, *auth_nodes = NULL;
739 *pexplicit_policy = 0;
740 ret = tree_init(&tree, certs, flags);
744 /* Tree empty requireExplicit False: OK */
748 /* Some internal error */
752 /* Some internal error */
756 /* Tree empty requireExplicit True: Error */
759 *pexplicit_policy = 1;
762 /* Tree OK requireExplicit True: OK and continue */
764 *pexplicit_policy = 1;
767 /* Tree OK: continue */
772 * tree_init() returns success and a null tree
773 * if it's just looking at a trust anchor.
774 * I'm not sure that returning success here is
775 * correct, but I'm sure that reporting this
776 * as an internal error which our caller
777 * interprets as a malloc failure is wrong.
785 ret = tree_evaluate(tree);
787 tree_print("tree_evaluate()", tree, NULL);
792 /* Return value 2 means tree empty */
794 X509_policy_tree_free(tree);
795 if (*pexplicit_policy)
801 /* Tree is not empty: continue */
803 ret = tree_calculate_authority_set(tree, &auth_nodes);
808 if (!tree_calculate_user_set(tree, policy_oids, auth_nodes))
812 sk_X509_POLICY_NODE_free(auth_nodes);
817 if (*pexplicit_policy) {
818 nodes = X509_policy_tree_get0_user_policies(tree);
819 if (sk_X509_POLICY_NODE_num(nodes) <= 0)
827 X509_policy_tree_free(tree);