2 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
5 /* ====================================================================
6 * Copyright (c) 2004 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
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 * ====================================================================
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).
61 #include <openssl/mem.h>
62 #include <openssl/obj.h>
63 #include <openssl/stack.h>
64 #include <openssl/thread.h>
65 #include <openssl/x509.h>
66 #include <openssl/x509v3.h>
69 #include "../internal.h"
72 * Enable this to print out the complete policy tree at various point during
77 * #define OPENSSL_POLICY_DEBUG
80 #ifdef OPENSSL_POLICY_DEBUG
82 static void expected_print(BIO *err, X509_POLICY_LEVEL *lev,
83 X509_POLICY_NODE *node, int indent)
85 if ((lev->flags & X509_V_FLAG_INHIBIT_MAP)
86 || !(node->data->flags & POLICY_DATA_FLAG_MAP_MASK))
87 BIO_puts(err, " Not Mapped\n");
90 STACK_OF(ASN1_OBJECT) *pset = node->data->expected_policy_set;
92 BIO_puts(err, " Expected: ");
93 for (i = 0; i < sk_ASN1_OBJECT_num(pset); i++) {
94 oid = sk_ASN1_OBJECT_value(pset, i);
97 i2a_ASN1_OBJECT(err, oid);
103 static void tree_print(char *str, X509_POLICY_TREE *tree,
104 X509_POLICY_LEVEL *curr)
106 X509_POLICY_LEVEL *plev;
107 X509_POLICY_NODE *node;
110 err = BIO_new_fp(stderr, BIO_NOCLOSE);
112 curr = tree->levels + tree->nlevel;
115 BIO_printf(err, "Level print after %s\n", str);
116 BIO_printf(err, "Printing Up to Level %ld\n", curr - tree->levels);
117 for (plev = tree->levels; plev != curr; plev++) {
118 BIO_printf(err, "Level %ld, flags = %x\n",
119 plev - tree->levels, plev->flags);
120 for (i = 0; i < sk_X509_POLICY_NODE_num(plev->nodes); i++) {
121 node = sk_X509_POLICY_NODE_value(plev->nodes, i);
122 X509_POLICY_NODE_print(err, node, 2);
123 expected_print(err, plev, node, 2);
124 BIO_printf(err, " Flags: %x\n", node->data->flags);
127 X509_POLICY_NODE_print(err, plev->anyPolicy, 2);
135 # define tree_print(a,b,c) /* */
140 * Initialize policy tree. Return values:
141 * 0 Some internal error occurred.
142 * -1 Inconsistent or invalid extensions in certificates.
143 * 1 Tree initialized OK.
144 * 2 Policy tree is empty.
145 * 5 Tree OK and requireExplicitPolicy true.
146 * 6 Tree empty and requireExplicitPolicy true.
149 static int tree_init(X509_POLICY_TREE **ptree, STACK_OF(X509) *certs,
152 X509_POLICY_TREE *tree;
153 X509_POLICY_LEVEL *level;
154 const X509_POLICY_CACHE *cache;
155 X509_POLICY_DATA *data = NULL;
163 n = sk_X509_num(certs);
166 /* Disable policy mapping for now... */
167 flags |= X509_V_FLAG_INHIBIT_MAP;
170 if (flags & X509_V_FLAG_EXPLICIT_POLICY)
173 explicit_policy = n + 1;
175 if (flags & X509_V_FLAG_INHIBIT_ANY)
180 if (flags & X509_V_FLAG_INHIBIT_MAP)
185 /* Can't do anything with just a trust anchor */
189 * First setup policy cache in all certificates apart from the trust
190 * anchor. Note any bad cache results on the way. Also can calculate
191 * explicit_policy value at this point.
193 for (i = n - 2; i >= 0; i--) {
194 x = sk_X509_value(certs, i);
195 X509_check_purpose(x, -1, -1);
196 cache = policy_cache_set(x);
197 /* If cache NULL something bad happened: return immediately */
201 * If inconsistent extensions keep a note of it but continue
203 if (x->ex_flags & EXFLAG_INVALID_POLICY)
206 * Otherwise if we have no data (hence no CertificatePolicies) and
207 * haven't already set an inconsistent code note it.
209 else if ((ret == 1) && !cache->data)
211 if (explicit_policy > 0) {
212 if (!(x->ex_flags & EXFLAG_SI))
214 if ((cache->explicit_skip != -1)
215 && (cache->explicit_skip < explicit_policy))
216 explicit_policy = cache->explicit_skip;
221 if (ret == 2 && !explicit_policy)
226 /* If we get this far initialize the tree */
228 tree = OPENSSL_malloc(sizeof(X509_POLICY_TREE));
234 tree->levels = OPENSSL_malloc(sizeof(X509_POLICY_LEVEL) * n);
236 tree->extra_data = NULL;
237 tree->auth_policies = NULL;
238 tree->user_policies = NULL;
245 OPENSSL_memset(tree->levels, 0, n * sizeof(X509_POLICY_LEVEL));
249 level = tree->levels;
251 /* Root data: initialize to anyPolicy */
253 data = policy_data_new(NULL, OBJ_nid2obj(NID_any_policy), 0);
255 if (!data || !level_add_node(level, data, NULL, tree))
258 for (i = n - 2; i >= 0; i--) {
260 x = sk_X509_value(certs, i);
261 cache = policy_cache_set(x);
265 if (!cache->anyPolicy)
266 level->flags |= X509_V_FLAG_INHIBIT_ANY;
268 /* Determine inhibit any and inhibit map flags */
271 * Any matching allowed if certificate is self issued and not the
274 if (!(x->ex_flags & EXFLAG_SI) || (i == 0))
275 level->flags |= X509_V_FLAG_INHIBIT_ANY;
277 if (!(x->ex_flags & EXFLAG_SI))
279 if ((cache->any_skip >= 0)
280 && (cache->any_skip < any_skip))
281 any_skip = cache->any_skip;
285 level->flags |= X509_V_FLAG_INHIBIT_MAP;
287 if (!(x->ex_flags & EXFLAG_SI))
289 if ((cache->map_skip >= 0)
290 && (cache->map_skip < map_skip))
291 map_skip = cache->map_skip;
305 X509_policy_tree_free(tree);
311 static int tree_link_matching_nodes(X509_POLICY_LEVEL *curr,
312 X509_POLICY_DATA *data)
314 X509_POLICY_LEVEL *last = curr - 1;
315 X509_POLICY_NODE *node;
318 /* Iterate through all in nodes linking matches */
319 for (i = 0; i < sk_X509_POLICY_NODE_num(last->nodes); i++) {
320 node = sk_X509_POLICY_NODE_value(last->nodes, i);
321 if (policy_node_match(last, node, data->valid_policy)) {
322 if (!level_add_node(curr, data, node, NULL))
327 if (!matched && last->anyPolicy) {
328 if (!level_add_node(curr, data, last->anyPolicy, NULL))
335 * This corresponds to RFC3280 6.1.3(d)(1): link any data from
336 * CertificatePolicies onto matching parent or anyPolicy if no match.
339 static int tree_link_nodes(X509_POLICY_LEVEL *curr,
340 const X509_POLICY_CACHE *cache)
343 X509_POLICY_DATA *data;
345 for (i = 0; i < sk_X509_POLICY_DATA_num(cache->data); i++) {
346 data = sk_X509_POLICY_DATA_value(cache->data, i);
348 * If a node is mapped any it doesn't have a corresponding
349 * CertificatePolicies entry. However such an identical node would
350 * be created if anyPolicy matching is enabled because there would be
351 * no match with the parent valid_policy_set. So we create link
352 * because then it will have the mapping flags right and we can prune
356 if ((data->flags & POLICY_DATA_FLAG_MAPPED_ANY)
357 && !(curr->flags & X509_V_FLAG_INHIBIT_ANY))
360 /* Look for matching nodes in previous level */
361 if (!tree_link_matching_nodes(curr, data))
368 * This corresponds to RFC3280 6.1.3(d)(2): Create new data for any unmatched
369 * policies in the parent and link to anyPolicy.
372 static int tree_add_unmatched(X509_POLICY_LEVEL *curr,
373 const X509_POLICY_CACHE *cache,
374 const ASN1_OBJECT *id,
375 X509_POLICY_NODE *node, X509_POLICY_TREE *tree)
377 X509_POLICY_DATA *data;
379 id = node->data->valid_policy;
381 * Create a new node with qualifiers from anyPolicy and id from unmatched
384 data = policy_data_new(NULL, id, node_critical(node));
388 /* Curr may not have anyPolicy */
389 data->qualifier_set = cache->anyPolicy->qualifier_set;
390 data->flags |= POLICY_DATA_FLAG_SHARED_QUALIFIERS;
391 if (!level_add_node(curr, data, node, tree)) {
392 policy_data_free(data);
399 static int tree_link_unmatched(X509_POLICY_LEVEL *curr,
400 const X509_POLICY_CACHE *cache,
401 X509_POLICY_NODE *node, X509_POLICY_TREE *tree)
403 const X509_POLICY_LEVEL *last = curr - 1;
406 if ((last->flags & X509_V_FLAG_INHIBIT_MAP)
407 || !(node->data->flags & POLICY_DATA_FLAG_MAPPED)) {
408 /* If no policy mapping: matched if one child present */
411 if (!tree_add_unmatched(curr, cache, NULL, node, tree))
415 /* If mapping: matched if one child per expected policy set */
416 STACK_OF(ASN1_OBJECT) *expset = node->data->expected_policy_set;
417 if ((size_t)node->nchild == sk_ASN1_OBJECT_num(expset))
419 /* Locate unmatched nodes */
420 for (i = 0; i < sk_ASN1_OBJECT_num(expset); i++) {
421 ASN1_OBJECT *oid = sk_ASN1_OBJECT_value(expset, i);
422 if (level_find_node(curr, node, oid))
424 if (!tree_add_unmatched(curr, cache, oid, node, tree))
434 static int tree_link_any(X509_POLICY_LEVEL *curr,
435 const X509_POLICY_CACHE *cache,
436 X509_POLICY_TREE *tree)
440 * X509_POLICY_DATA *data;
442 X509_POLICY_NODE *node;
443 X509_POLICY_LEVEL *last = curr - 1;
445 for (i = 0; i < sk_X509_POLICY_NODE_num(last->nodes); i++) {
446 node = sk_X509_POLICY_NODE_value(last->nodes, i);
448 if (!tree_link_unmatched(curr, cache, node, tree))
454 * Skip any node with any children: we only want unmathced nodes.
455 * Note: need something better for policy mapping because each node
456 * may have multiple children
462 * Create a new node with qualifiers from anyPolicy and id from
465 data = policy_data_new(NULL, node->data->valid_policy,
466 node_critical(node));
470 /* Curr may not have anyPolicy */
471 data->qualifier_set = cache->anyPolicy->qualifier_set;
472 data->flags |= POLICY_DATA_FLAG_SHARED_QUALIFIERS;
473 if (!level_add_node(curr, data, node, tree)) {
474 policy_data_free(data);
480 /* Finally add link to anyPolicy */
481 if (last->anyPolicy) {
482 if (!level_add_node(curr, cache->anyPolicy, last->anyPolicy, NULL))
489 * Prune the tree: delete any child mapped child data on the current level
490 * then proceed up the tree deleting any data with no children. If we ever
491 * have no data on a level we can halt because the tree will be empty.
494 static int tree_prune(X509_POLICY_TREE *tree, X509_POLICY_LEVEL *curr)
496 STACK_OF(X509_POLICY_NODE) *nodes;
497 X509_POLICY_NODE *node;
500 if (curr->flags & X509_V_FLAG_INHIBIT_MAP) {
501 for (i = sk_X509_POLICY_NODE_num(nodes) - 1; i >= 0; i--) {
502 node = sk_X509_POLICY_NODE_value(nodes, i);
503 /* Delete any mapped data: see RFC3280 XXXX */
504 if (node->data->flags & POLICY_DATA_FLAG_MAP_MASK) {
505 node->parent->nchild--;
507 (void)sk_X509_POLICY_NODE_delete(nodes, i);
515 for (i = sk_X509_POLICY_NODE_num(nodes) - 1; i >= 0; i--) {
516 node = sk_X509_POLICY_NODE_value(nodes, i);
517 if (node->nchild == 0) {
518 node->parent->nchild--;
520 (void)sk_X509_POLICY_NODE_delete(nodes, i);
523 if (curr->anyPolicy && !curr->anyPolicy->nchild) {
524 if (curr->anyPolicy->parent)
525 curr->anyPolicy->parent->nchild--;
526 OPENSSL_free(curr->anyPolicy);
527 curr->anyPolicy = NULL;
529 if (curr == tree->levels) {
530 /* If we zapped anyPolicy at top then tree is empty */
531 if (!curr->anyPolicy)
539 static int tree_add_auth_node(STACK_OF(X509_POLICY_NODE) **pnodes,
540 X509_POLICY_NODE *pcy)
543 *pnodes = policy_node_cmp_new();
546 } else if (sk_X509_POLICY_NODE_find(*pnodes, NULL, pcy))
549 if (!sk_X509_POLICY_NODE_push(*pnodes, pcy))
557 * Calculate the authority set based on policy tree. The 'pnodes' parameter
558 * is used as a store for the set of policy nodes used to calculate the user
559 * set. If the authority set is not anyPolicy then pnodes will just point to
560 * the authority set. If however the authority set is anyPolicy then the set
561 * of valid policies (other than anyPolicy) is store in pnodes. The return
562 * value of '2' is used in this case to indicate that pnodes should be freed.
565 static int tree_calculate_authority_set(X509_POLICY_TREE *tree,
566 STACK_OF(X509_POLICY_NODE) **pnodes)
568 X509_POLICY_LEVEL *curr;
569 X509_POLICY_NODE *node, *anyptr;
570 STACK_OF(X509_POLICY_NODE) **addnodes;
573 curr = tree->levels + tree->nlevel - 1;
575 /* If last level contains anyPolicy set is anyPolicy */
576 if (curr->anyPolicy) {
577 if (!tree_add_auth_node(&tree->auth_policies, curr->anyPolicy))
581 /* Add policies to authority set */
582 addnodes = &tree->auth_policies;
585 for (i = 1; i < tree->nlevel; i++) {
587 * If no anyPolicy node on this this level it can't appear on lower
588 * levels so end search.
590 if (!(anyptr = curr->anyPolicy))
593 for (j = 0; j < sk_X509_POLICY_NODE_num(curr->nodes); j++) {
594 node = sk_X509_POLICY_NODE_value(curr->nodes, j);
595 if ((node->parent == anyptr)
596 && !tree_add_auth_node(addnodes, node))
601 if (addnodes == pnodes)
604 *pnodes = tree->auth_policies;
609 static int tree_calculate_user_set(X509_POLICY_TREE *tree,
610 STACK_OF(ASN1_OBJECT) *policy_oids,
611 STACK_OF(X509_POLICY_NODE) *auth_nodes)
614 X509_POLICY_NODE *node;
617 X509_POLICY_NODE *anyPolicy;
618 X509_POLICY_DATA *extra;
621 * Check if anyPolicy present in authority constrained policy set: this
622 * will happen if it is a leaf node.
625 if (sk_ASN1_OBJECT_num(policy_oids) <= 0)
628 anyPolicy = tree->levels[tree->nlevel - 1].anyPolicy;
630 for (i = 0; i < sk_ASN1_OBJECT_num(policy_oids); i++) {
631 oid = sk_ASN1_OBJECT_value(policy_oids, i);
632 if (OBJ_obj2nid(oid) == NID_any_policy) {
633 tree->flags |= POLICY_FLAG_ANY_POLICY;
638 for (i = 0; i < sk_ASN1_OBJECT_num(policy_oids); i++) {
639 oid = sk_ASN1_OBJECT_value(policy_oids, i);
640 node = tree_find_sk(auth_nodes, oid);
645 * Create a new node with policy ID from user set and qualifiers
648 extra = policy_data_new(NULL, oid, node_critical(anyPolicy));
651 extra->qualifier_set = anyPolicy->data->qualifier_set;
652 extra->flags = POLICY_DATA_FLAG_SHARED_QUALIFIERS
653 | POLICY_DATA_FLAG_EXTRA_NODE;
654 node = level_add_node(NULL, extra, anyPolicy->parent, tree);
656 if (!tree->user_policies) {
657 tree->user_policies = sk_X509_POLICY_NODE_new_null();
658 if (!tree->user_policies)
661 if (!sk_X509_POLICY_NODE_push(tree->user_policies, node))
668 static int tree_evaluate(X509_POLICY_TREE *tree)
671 X509_POLICY_LEVEL *curr = tree->levels + 1;
672 const X509_POLICY_CACHE *cache;
674 for (i = 1; i < tree->nlevel; i++, curr++) {
675 cache = policy_cache_set(curr->cert);
676 if (!tree_link_nodes(curr, cache))
679 if (!(curr->flags & X509_V_FLAG_INHIBIT_ANY)
680 && !tree_link_any(curr, cache, tree))
682 tree_print("before tree_prune()", tree, curr);
683 ret = tree_prune(tree, curr);
692 static void exnode_free(X509_POLICY_NODE *node)
694 if (node->data && (node->data->flags & POLICY_DATA_FLAG_EXTRA_NODE))
698 void X509_policy_tree_free(X509_POLICY_TREE *tree)
700 X509_POLICY_LEVEL *curr;
706 sk_X509_POLICY_NODE_free(tree->auth_policies);
707 sk_X509_POLICY_NODE_pop_free(tree->user_policies, exnode_free);
709 for (i = 0, curr = tree->levels; i < tree->nlevel; i++, curr++) {
711 X509_free(curr->cert);
713 sk_X509_POLICY_NODE_pop_free(curr->nodes, policy_node_free);
715 policy_node_free(curr->anyPolicy);
718 if (tree->extra_data)
719 sk_X509_POLICY_DATA_pop_free(tree->extra_data, policy_data_free);
721 OPENSSL_free(tree->levels);
727 * Application policy checking function.
731 * -1 One or more certificates contain invalid or inconsistent extensions
732 * -2 User constrained policy set empty and requireExplicit true.
735 int X509_policy_check(X509_POLICY_TREE **ptree, int *pexplicit_policy,
736 STACK_OF(X509) *certs,
737 STACK_OF(ASN1_OBJECT) *policy_oids, unsigned int flags)
741 X509_POLICY_TREE *tree = NULL;
742 STACK_OF(X509_POLICY_NODE) *nodes, *auth_nodes = NULL;
745 *pexplicit_policy = 0;
746 ret = tree_init(&tree, certs, flags);
750 /* Tree empty requireExplicit False: OK */
754 /* Some internal error */
758 /* Some internal error */
762 /* Tree empty requireExplicit True: Error */
765 *pexplicit_policy = 1;
768 /* Tree OK requireExplicit True: OK and continue */
770 *pexplicit_policy = 1;
773 /* Tree OK: continue */
778 * tree_init() returns success and a null tree
779 * if it's just looking at a trust anchor.
780 * I'm not sure that returning success here is
781 * correct, but I'm sure that reporting this
782 * as an internal error which our caller
783 * interprets as a malloc failure is wrong.
791 ret = tree_evaluate(tree);
793 tree_print("tree_evaluate()", tree, NULL);
798 /* Return value 2 means tree empty */
800 X509_policy_tree_free(tree);
801 if (*pexplicit_policy)
807 /* Tree is not empty: continue */
809 calc_ret = tree_calculate_authority_set(tree, &auth_nodes);
814 ret = tree_calculate_user_set(tree, policy_oids, auth_nodes);
817 sk_X509_POLICY_NODE_free(auth_nodes);
826 if (*pexplicit_policy) {
827 nodes = X509_policy_tree_get0_user_policies(tree);
828 if (sk_X509_POLICY_NODE_num(nodes) <= 0)
836 X509_policy_tree_free(tree);