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).
60 #include "internal/cryptlib.h"
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, sizeof(*tree->levels) * n);
240 level = tree->levels;
242 /* Root data: initialize to anyPolicy */
243 data = policy_data_new(NULL, OBJ_nid2obj(NID_any_policy), 0);
245 if (!data || !level_add_node(level, data, NULL, tree))
248 for (i = n - 2; i >= 0; i--) {
250 x = sk_X509_value(certs, i);
251 cache = policy_cache_set(x);
255 if (!cache->anyPolicy)
256 level->flags |= X509_V_FLAG_INHIBIT_ANY;
258 /* Determine inhibit any and inhibit map flags */
261 * Any matching allowed if certificate is self issued and not the
264 if (!(x->ex_flags & EXFLAG_SI) || (i == 0))
265 level->flags |= X509_V_FLAG_INHIBIT_ANY;
267 if (!(x->ex_flags & EXFLAG_SI))
269 if ((cache->any_skip >= 0)
270 && (cache->any_skip < any_skip))
271 any_skip = cache->any_skip;
275 level->flags |= X509_V_FLAG_INHIBIT_MAP;
277 if (!(x->ex_flags & EXFLAG_SI))
279 if ((cache->map_skip >= 0)
280 && (cache->map_skip < map_skip))
281 map_skip = cache->map_skip;
295 X509_policy_tree_free(tree);
301 static int tree_link_matching_nodes(X509_POLICY_LEVEL *curr,
302 const X509_POLICY_DATA *data)
304 X509_POLICY_LEVEL *last = curr - 1;
305 X509_POLICY_NODE *node;
307 /* Iterate through all in nodes linking matches */
308 for (i = 0; i < sk_X509_POLICY_NODE_num(last->nodes); i++) {
309 node = sk_X509_POLICY_NODE_value(last->nodes, i);
310 if (policy_node_match(last, node, data->valid_policy)) {
311 if (!level_add_node(curr, data, node, NULL))
316 if (!matched && last->anyPolicy) {
317 if (!level_add_node(curr, data, last->anyPolicy, NULL))
324 * This corresponds to RFC3280 6.1.3(d)(1): link any data from
325 * CertificatePolicies onto matching parent or anyPolicy if no match.
328 static int tree_link_nodes(X509_POLICY_LEVEL *curr,
329 const X509_POLICY_CACHE *cache)
332 X509_POLICY_DATA *data;
334 for (i = 0; i < sk_X509_POLICY_DATA_num(cache->data); i++) {
335 data = sk_X509_POLICY_DATA_value(cache->data, i);
336 /* Look for matching nodes in previous level */
337 if (!tree_link_matching_nodes(curr, data))
344 * This corresponds to RFC3280 6.1.3(d)(2): Create new data for any unmatched
345 * policies in the parent and link to anyPolicy.
348 static int tree_add_unmatched(X509_POLICY_LEVEL *curr,
349 const X509_POLICY_CACHE *cache,
350 const ASN1_OBJECT *id,
351 X509_POLICY_NODE *node, X509_POLICY_TREE *tree)
353 X509_POLICY_DATA *data;
355 id = node->data->valid_policy;
357 * Create a new node with qualifiers from anyPolicy and id from unmatched
360 data = policy_data_new(NULL, id, node_critical(node));
364 /* Curr may not have anyPolicy */
365 data->qualifier_set = cache->anyPolicy->qualifier_set;
366 data->flags |= POLICY_DATA_FLAG_SHARED_QUALIFIERS;
367 if (!level_add_node(curr, data, node, tree)) {
368 policy_data_free(data);
375 static int tree_link_unmatched(X509_POLICY_LEVEL *curr,
376 const X509_POLICY_CACHE *cache,
377 X509_POLICY_NODE *node, X509_POLICY_TREE *tree)
379 const X509_POLICY_LEVEL *last = curr - 1;
382 if ((last->flags & X509_V_FLAG_INHIBIT_MAP)
383 || !(node->data->flags & POLICY_DATA_FLAG_MAPPED)) {
384 /* If no policy mapping: matched if one child present */
387 if (!tree_add_unmatched(curr, cache, NULL, node, tree))
391 /* If mapping: matched if one child per expected policy set */
392 STACK_OF(ASN1_OBJECT) *expset = node->data->expected_policy_set;
393 if (node->nchild == sk_ASN1_OBJECT_num(expset))
395 /* Locate unmatched nodes */
396 for (i = 0; i < sk_ASN1_OBJECT_num(expset); i++) {
397 ASN1_OBJECT *oid = sk_ASN1_OBJECT_value(expset, i);
398 if (level_find_node(curr, node, oid))
400 if (!tree_add_unmatched(curr, cache, oid, node, tree))
410 static int tree_link_any(X509_POLICY_LEVEL *curr,
411 const X509_POLICY_CACHE *cache,
412 X509_POLICY_TREE *tree)
415 X509_POLICY_NODE *node;
416 X509_POLICY_LEVEL *last = curr - 1;
418 for (i = 0; i < sk_X509_POLICY_NODE_num(last->nodes); i++) {
419 node = sk_X509_POLICY_NODE_value(last->nodes, i);
421 if (!tree_link_unmatched(curr, cache, node, tree))
424 /* Finally add link to anyPolicy */
425 if (last->anyPolicy) {
426 if (!level_add_node(curr, cache->anyPolicy, last->anyPolicy, NULL))
433 * Prune the tree: delete any child mapped child data on the current level
434 * then proceed up the tree deleting any data with no children. If we ever
435 * have no data on a level we can halt because the tree will be empty.
438 static int tree_prune(X509_POLICY_TREE *tree, X509_POLICY_LEVEL *curr)
440 STACK_OF(X509_POLICY_NODE) *nodes;
441 X509_POLICY_NODE *node;
444 if (curr->flags & X509_V_FLAG_INHIBIT_MAP) {
445 for (i = sk_X509_POLICY_NODE_num(nodes) - 1; i >= 0; i--) {
446 node = sk_X509_POLICY_NODE_value(nodes, i);
447 /* Delete any mapped data: see RFC3280 XXXX */
448 if (node->data->flags & POLICY_DATA_FLAG_MAP_MASK) {
449 node->parent->nchild--;
451 (void)sk_X509_POLICY_NODE_delete(nodes, i);
459 for (i = sk_X509_POLICY_NODE_num(nodes) - 1; i >= 0; i--) {
460 node = sk_X509_POLICY_NODE_value(nodes, i);
461 if (node->nchild == 0) {
462 node->parent->nchild--;
464 (void)sk_X509_POLICY_NODE_delete(nodes, i);
467 if (curr->anyPolicy && !curr->anyPolicy->nchild) {
468 if (curr->anyPolicy->parent)
469 curr->anyPolicy->parent->nchild--;
470 OPENSSL_free(curr->anyPolicy);
471 curr->anyPolicy = NULL;
473 if (curr == tree->levels) {
474 /* If we zapped anyPolicy at top then tree is empty */
475 if (!curr->anyPolicy)
485 static int tree_add_auth_node(STACK_OF(X509_POLICY_NODE) **pnodes,
486 X509_POLICY_NODE *pcy)
489 *pnodes = policy_node_cmp_new();
492 } else if (sk_X509_POLICY_NODE_find(*pnodes, pcy) != -1)
495 if (!sk_X509_POLICY_NODE_push(*pnodes, pcy))
503 * Calculate the authority set based on policy tree. The 'pnodes' parameter
504 * is used as a store for the set of policy nodes used to calculate the user
505 * set. If the authority set is not anyPolicy then pnodes will just point to
506 * the authority set. If however the authority set is anyPolicy then the set
507 * of valid policies (other than anyPolicy) is store in pnodes. The return
508 * value of '2' is used in this case to indicate that pnodes should be freed.
511 static int tree_calculate_authority_set(X509_POLICY_TREE *tree,
512 STACK_OF(X509_POLICY_NODE) **pnodes)
514 X509_POLICY_LEVEL *curr;
515 X509_POLICY_NODE *node, *anyptr;
516 STACK_OF(X509_POLICY_NODE) **addnodes;
518 curr = tree->levels + tree->nlevel - 1;
520 /* If last level contains anyPolicy set is anyPolicy */
521 if (curr->anyPolicy) {
522 if (!tree_add_auth_node(&tree->auth_policies, curr->anyPolicy))
526 /* Add policies to authority set */
527 addnodes = &tree->auth_policies;
530 for (i = 1; i < tree->nlevel; i++) {
532 * If no anyPolicy node on this this level it can't appear on lower
533 * levels so end search.
535 if ((anyptr = curr->anyPolicy) == NULL)
538 for (j = 0; j < sk_X509_POLICY_NODE_num(curr->nodes); j++) {
539 node = sk_X509_POLICY_NODE_value(curr->nodes, j);
540 if ((node->parent == anyptr)
541 && !tree_add_auth_node(addnodes, node))
546 if (addnodes == pnodes)
549 *pnodes = tree->auth_policies;
554 static int tree_calculate_user_set(X509_POLICY_TREE *tree,
555 STACK_OF(ASN1_OBJECT) *policy_oids,
556 STACK_OF(X509_POLICY_NODE) *auth_nodes)
559 X509_POLICY_NODE *node;
562 X509_POLICY_NODE *anyPolicy;
563 X509_POLICY_DATA *extra;
566 * Check if anyPolicy present in authority constrained policy set: this
567 * will happen if it is a leaf node.
570 if (sk_ASN1_OBJECT_num(policy_oids) <= 0)
573 anyPolicy = tree->levels[tree->nlevel - 1].anyPolicy;
575 for (i = 0; i < sk_ASN1_OBJECT_num(policy_oids); i++) {
576 oid = sk_ASN1_OBJECT_value(policy_oids, i);
577 if (OBJ_obj2nid(oid) == NID_any_policy) {
578 tree->flags |= POLICY_FLAG_ANY_POLICY;
583 for (i = 0; i < sk_ASN1_OBJECT_num(policy_oids); i++) {
584 oid = sk_ASN1_OBJECT_value(policy_oids, i);
585 node = tree_find_sk(auth_nodes, oid);
590 * Create a new node with policy ID from user set and qualifiers
593 extra = policy_data_new(NULL, oid, node_critical(anyPolicy));
596 extra->qualifier_set = anyPolicy->data->qualifier_set;
597 extra->flags = POLICY_DATA_FLAG_SHARED_QUALIFIERS
598 | POLICY_DATA_FLAG_EXTRA_NODE;
599 node = level_add_node(NULL, extra, anyPolicy->parent, tree);
601 if (!tree->user_policies) {
602 tree->user_policies = sk_X509_POLICY_NODE_new_null();
603 if (!tree->user_policies)
606 if (!sk_X509_POLICY_NODE_push(tree->user_policies, node))
613 static int tree_evaluate(X509_POLICY_TREE *tree)
616 X509_POLICY_LEVEL *curr = tree->levels + 1;
617 const X509_POLICY_CACHE *cache;
619 for (i = 1; i < tree->nlevel; i++, curr++) {
620 cache = policy_cache_set(curr->cert);
621 if (!tree_link_nodes(curr, cache))
624 if (!(curr->flags & X509_V_FLAG_INHIBIT_ANY)
625 && !tree_link_any(curr, cache, tree))
627 tree_print("before tree_prune()", tree, curr);
628 ret = tree_prune(tree, curr);
637 static void exnode_free(X509_POLICY_NODE *node)
639 if (node->data && (node->data->flags & POLICY_DATA_FLAG_EXTRA_NODE))
643 void X509_policy_tree_free(X509_POLICY_TREE *tree)
645 X509_POLICY_LEVEL *curr;
651 sk_X509_POLICY_NODE_free(tree->auth_policies);
652 sk_X509_POLICY_NODE_pop_free(tree->user_policies, exnode_free);
654 for (i = 0, curr = tree->levels; i < tree->nlevel; i++, curr++) {
655 X509_free(curr->cert);
656 sk_X509_POLICY_NODE_pop_free(curr->nodes, policy_node_free);
657 policy_node_free(curr->anyPolicy);
660 sk_X509_POLICY_DATA_pop_free(tree->extra_data, policy_data_free);
661 OPENSSL_free(tree->levels);
667 * Application policy checking function.
671 * -1 One or more certificates contain invalid or inconsistent extensions
672 * -2 User constrained policy set empty and requireExplicit true.
675 int X509_policy_check(X509_POLICY_TREE **ptree, int *pexplicit_policy,
676 STACK_OF(X509) *certs,
677 STACK_OF(ASN1_OBJECT) *policy_oids, unsigned int flags)
680 X509_POLICY_TREE *tree = NULL;
681 STACK_OF(X509_POLICY_NODE) *nodes, *auth_nodes = NULL;
684 *pexplicit_policy = 0;
685 ret = tree_init(&tree, certs, flags);
689 /* Tree empty requireExplicit False: OK */
693 /* Some internal error */
697 /* Some internal error */
701 /* Tree empty requireExplicit True: Error */
704 *pexplicit_policy = 1;
707 /* Tree OK requireExplicit True: OK and continue */
709 *pexplicit_policy = 1;
712 /* Tree OK: continue */
717 * tree_init() returns success and a null tree
718 * if it's just looking at a trust anchor.
719 * I'm not sure that returning success here is
720 * correct, but I'm sure that reporting this
721 * as an internal error which our caller
722 * interprets as a malloc failure is wrong.
730 ret = tree_evaluate(tree);
732 tree_print("tree_evaluate()", tree, NULL);
737 /* Return value 2 means tree empty */
739 X509_policy_tree_free(tree);
740 if (*pexplicit_policy)
746 /* Tree is not empty: continue */
748 ret = tree_calculate_authority_set(tree, &auth_nodes);
753 if (!tree_calculate_user_set(tree, policy_oids, auth_nodes))
757 sk_X509_POLICY_NODE_free(auth_nodes);
762 if (*pexplicit_policy) {
763 nodes = X509_policy_tree_get0_user_policies(tree);
764 if (sk_X509_POLICY_NODE_num(nodes) <= 0)
772 X509_policy_tree_free(tree);