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--) {
188 x = sk_X509_value(certs, i);
189 ex_flags = X509_get_extension_flags(x);
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 (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 (!(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 */
222 tree = OPENSSL_zalloc(sizeof(*tree));
225 tree->levels = OPENSSL_zalloc(sizeof(*tree->levels) * n);
231 level = tree->levels;
233 /* Root data: initialize to anyPolicy */
234 data = policy_data_new(NULL, OBJ_nid2obj(NID_any_policy), 0);
236 if (!data || !level_add_node(level, data, NULL, tree))
239 for (i = n - 2; i >= 0; i--) {
242 x = sk_X509_value(certs, i);
243 ex_flags = X509_get_extension_flags(x);
244 cache = policy_cache_set(x);
248 if (!cache->anyPolicy)
249 level->flags |= X509_V_FLAG_INHIBIT_ANY;
251 /* Determine inhibit any and inhibit map flags */
254 * Any matching allowed if certificate is self issued and not the
257 if (!(ex_flags & EXFLAG_SI) || (i == 0))
258 level->flags |= X509_V_FLAG_INHIBIT_ANY;
260 if (!(ex_flags & EXFLAG_SI))
262 if ((cache->any_skip >= 0)
263 && (cache->any_skip < any_skip))
264 any_skip = cache->any_skip;
268 level->flags |= X509_V_FLAG_INHIBIT_MAP;
270 if (!(ex_flags & EXFLAG_SI))
272 if ((cache->map_skip >= 0)
273 && (cache->map_skip < map_skip))
274 map_skip = cache->map_skip;
288 X509_policy_tree_free(tree);
294 static int tree_link_matching_nodes(X509_POLICY_LEVEL *curr,
295 const X509_POLICY_DATA *data)
297 X509_POLICY_LEVEL *last = curr - 1;
298 X509_POLICY_NODE *node;
300 /* Iterate through all in nodes linking matches */
301 for (i = 0; i < sk_X509_POLICY_NODE_num(last->nodes); i++) {
302 node = sk_X509_POLICY_NODE_value(last->nodes, i);
303 if (policy_node_match(last, node, data->valid_policy)) {
304 if (!level_add_node(curr, data, node, NULL))
309 if (!matched && last->anyPolicy) {
310 if (!level_add_node(curr, data, last->anyPolicy, NULL))
317 * This corresponds to RFC3280 6.1.3(d)(1): link any data from
318 * CertificatePolicies onto matching parent or anyPolicy if no match.
321 static int tree_link_nodes(X509_POLICY_LEVEL *curr,
322 const X509_POLICY_CACHE *cache)
325 X509_POLICY_DATA *data;
327 for (i = 0; i < sk_X509_POLICY_DATA_num(cache->data); i++) {
328 data = sk_X509_POLICY_DATA_value(cache->data, i);
329 /* Look for matching nodes in previous level */
330 if (!tree_link_matching_nodes(curr, data))
337 * This corresponds to RFC3280 6.1.3(d)(2): Create new data for any unmatched
338 * policies in the parent and link to anyPolicy.
341 static int tree_add_unmatched(X509_POLICY_LEVEL *curr,
342 const X509_POLICY_CACHE *cache,
343 const ASN1_OBJECT *id,
344 X509_POLICY_NODE *node, X509_POLICY_TREE *tree)
346 X509_POLICY_DATA *data;
348 id = node->data->valid_policy;
350 * Create a new node with qualifiers from anyPolicy and id from unmatched
353 data = policy_data_new(NULL, id, node_critical(node));
357 /* Curr may not have anyPolicy */
358 data->qualifier_set = cache->anyPolicy->qualifier_set;
359 data->flags |= POLICY_DATA_FLAG_SHARED_QUALIFIERS;
360 if (!level_add_node(curr, data, node, tree)) {
361 policy_data_free(data);
368 static int tree_link_unmatched(X509_POLICY_LEVEL *curr,
369 const X509_POLICY_CACHE *cache,
370 X509_POLICY_NODE *node, X509_POLICY_TREE *tree)
372 const X509_POLICY_LEVEL *last = curr - 1;
375 if ((last->flags & X509_V_FLAG_INHIBIT_MAP)
376 || !(node->data->flags & POLICY_DATA_FLAG_MAPPED)) {
377 /* If no policy mapping: matched if one child present */
380 if (!tree_add_unmatched(curr, cache, NULL, node, tree))
384 /* If mapping: matched if one child per expected policy set */
385 STACK_OF(ASN1_OBJECT) *expset = node->data->expected_policy_set;
386 if (node->nchild == sk_ASN1_OBJECT_num(expset))
388 /* Locate unmatched nodes */
389 for (i = 0; i < sk_ASN1_OBJECT_num(expset); i++) {
390 ASN1_OBJECT *oid = sk_ASN1_OBJECT_value(expset, i);
391 if (level_find_node(curr, node, oid))
393 if (!tree_add_unmatched(curr, cache, oid, node, tree))
403 static int tree_link_any(X509_POLICY_LEVEL *curr,
404 const X509_POLICY_CACHE *cache,
405 X509_POLICY_TREE *tree)
408 X509_POLICY_NODE *node;
409 X509_POLICY_LEVEL *last = curr - 1;
411 for (i = 0; i < sk_X509_POLICY_NODE_num(last->nodes); i++) {
412 node = sk_X509_POLICY_NODE_value(last->nodes, i);
414 if (!tree_link_unmatched(curr, cache, node, tree))
417 /* Finally add link to anyPolicy */
418 if (last->anyPolicy) {
419 if (!level_add_node(curr, cache->anyPolicy, last->anyPolicy, NULL))
426 * Prune the tree: delete any child mapped child data on the current level
427 * then proceed up the tree deleting any data with no children. If we ever
428 * have no data on a level we can halt because the tree will be empty.
431 static int tree_prune(X509_POLICY_TREE *tree, X509_POLICY_LEVEL *curr)
433 STACK_OF(X509_POLICY_NODE) *nodes;
434 X509_POLICY_NODE *node;
437 if (curr->flags & X509_V_FLAG_INHIBIT_MAP) {
438 for (i = sk_X509_POLICY_NODE_num(nodes) - 1; i >= 0; i--) {
439 node = sk_X509_POLICY_NODE_value(nodes, i);
440 /* Delete any mapped data: see RFC3280 XXXX */
441 if (node->data->flags & POLICY_DATA_FLAG_MAP_MASK) {
442 node->parent->nchild--;
444 (void)sk_X509_POLICY_NODE_delete(nodes, i);
452 for (i = sk_X509_POLICY_NODE_num(nodes) - 1; i >= 0; i--) {
453 node = sk_X509_POLICY_NODE_value(nodes, i);
454 if (node->nchild == 0) {
455 node->parent->nchild--;
457 (void)sk_X509_POLICY_NODE_delete(nodes, i);
460 if (curr->anyPolicy && !curr->anyPolicy->nchild) {
461 if (curr->anyPolicy->parent)
462 curr->anyPolicy->parent->nchild--;
463 OPENSSL_free(curr->anyPolicy);
464 curr->anyPolicy = NULL;
466 if (curr == tree->levels) {
467 /* If we zapped anyPolicy at top then tree is empty */
468 if (!curr->anyPolicy)
478 static int tree_add_auth_node(STACK_OF(X509_POLICY_NODE) **pnodes,
479 X509_POLICY_NODE *pcy)
482 *pnodes = policy_node_cmp_new();
485 } else if (sk_X509_POLICY_NODE_find(*pnodes, pcy) != -1)
488 if (!sk_X509_POLICY_NODE_push(*pnodes, pcy))
496 * Calculate the authority set based on policy tree. The 'pnodes' parameter
497 * is used as a store for the set of policy nodes used to calculate the user
498 * set. If the authority set is not anyPolicy then pnodes will just point to
499 * the authority set. If however the authority set is anyPolicy then the set
500 * of valid policies (other than anyPolicy) is store in pnodes. The return
501 * value of '2' is used in this case to indicate that pnodes should be freed.
504 static int tree_calculate_authority_set(X509_POLICY_TREE *tree,
505 STACK_OF(X509_POLICY_NODE) **pnodes)
507 X509_POLICY_LEVEL *curr;
508 X509_POLICY_NODE *node, *anyptr;
509 STACK_OF(X509_POLICY_NODE) **addnodes;
511 curr = tree->levels + tree->nlevel - 1;
513 /* If last level contains anyPolicy set is anyPolicy */
514 if (curr->anyPolicy) {
515 if (!tree_add_auth_node(&tree->auth_policies, curr->anyPolicy))
519 /* Add policies to authority set */
520 addnodes = &tree->auth_policies;
523 for (i = 1; i < tree->nlevel; i++) {
525 * If no anyPolicy node on this this level it can't appear on lower
526 * levels so end search.
528 if ((anyptr = curr->anyPolicy) == NULL)
531 for (j = 0; j < sk_X509_POLICY_NODE_num(curr->nodes); j++) {
532 node = sk_X509_POLICY_NODE_value(curr->nodes, j);
533 if ((node->parent == anyptr)
534 && !tree_add_auth_node(addnodes, node))
539 if (addnodes == pnodes)
542 *pnodes = tree->auth_policies;
547 static int tree_calculate_user_set(X509_POLICY_TREE *tree,
548 STACK_OF(ASN1_OBJECT) *policy_oids,
549 STACK_OF(X509_POLICY_NODE) *auth_nodes)
552 X509_POLICY_NODE *node;
555 X509_POLICY_NODE *anyPolicy;
556 X509_POLICY_DATA *extra;
559 * Check if anyPolicy present in authority constrained policy set: this
560 * will happen if it is a leaf node.
563 if (sk_ASN1_OBJECT_num(policy_oids) <= 0)
566 anyPolicy = tree->levels[tree->nlevel - 1].anyPolicy;
568 for (i = 0; i < sk_ASN1_OBJECT_num(policy_oids); i++) {
569 oid = sk_ASN1_OBJECT_value(policy_oids, i);
570 if (OBJ_obj2nid(oid) == NID_any_policy) {
571 tree->flags |= POLICY_FLAG_ANY_POLICY;
576 for (i = 0; i < sk_ASN1_OBJECT_num(policy_oids); i++) {
577 oid = sk_ASN1_OBJECT_value(policy_oids, i);
578 node = tree_find_sk(auth_nodes, oid);
583 * Create a new node with policy ID from user set and qualifiers
586 extra = policy_data_new(NULL, oid, node_critical(anyPolicy));
589 extra->qualifier_set = anyPolicy->data->qualifier_set;
590 extra->flags = POLICY_DATA_FLAG_SHARED_QUALIFIERS
591 | POLICY_DATA_FLAG_EXTRA_NODE;
592 node = level_add_node(NULL, extra, anyPolicy->parent, tree);
594 if (!tree->user_policies) {
595 tree->user_policies = sk_X509_POLICY_NODE_new_null();
596 if (!tree->user_policies)
599 if (!sk_X509_POLICY_NODE_push(tree->user_policies, node))
606 static int tree_evaluate(X509_POLICY_TREE *tree)
609 X509_POLICY_LEVEL *curr = tree->levels + 1;
610 const X509_POLICY_CACHE *cache;
612 for (i = 1; i < tree->nlevel; i++, curr++) {
613 cache = policy_cache_set(curr->cert);
614 if (!tree_link_nodes(curr, cache))
617 if (!(curr->flags & X509_V_FLAG_INHIBIT_ANY)
618 && !tree_link_any(curr, cache, tree))
620 tree_print("before tree_prune()", tree, curr);
621 ret = tree_prune(tree, curr);
630 static void exnode_free(X509_POLICY_NODE *node)
632 if (node->data && (node->data->flags & POLICY_DATA_FLAG_EXTRA_NODE))
636 void X509_policy_tree_free(X509_POLICY_TREE *tree)
638 X509_POLICY_LEVEL *curr;
644 sk_X509_POLICY_NODE_free(tree->auth_policies);
645 sk_X509_POLICY_NODE_pop_free(tree->user_policies, exnode_free);
647 for (i = 0, curr = tree->levels; i < tree->nlevel; i++, curr++) {
648 X509_free(curr->cert);
649 sk_X509_POLICY_NODE_pop_free(curr->nodes, policy_node_free);
650 policy_node_free(curr->anyPolicy);
653 sk_X509_POLICY_DATA_pop_free(tree->extra_data, policy_data_free);
654 OPENSSL_free(tree->levels);
660 * Application policy checking function.
664 * -1 One or more certificates contain invalid or inconsistent extensions
665 * -2 User constrained policy set empty and requireExplicit true.
668 int X509_policy_check(X509_POLICY_TREE **ptree, int *pexplicit_policy,
669 STACK_OF(X509) *certs,
670 STACK_OF(ASN1_OBJECT) *policy_oids, unsigned int flags)
673 X509_POLICY_TREE *tree = NULL;
674 STACK_OF(X509_POLICY_NODE) *nodes, *auth_nodes = NULL;
677 *pexplicit_policy = 0;
678 ret = tree_init(&tree, certs, flags);
682 /* Tree empty requireExplicit False: OK */
686 /* Some internal error */
690 /* Some internal error */
694 /* Tree empty requireExplicit True: Error */
697 *pexplicit_policy = 1;
700 /* Tree OK requireExplicit True: OK and continue */
702 *pexplicit_policy = 1;
705 /* Tree OK: continue */
710 * tree_init() returns success and a null tree
711 * if it's just looking at a trust anchor.
712 * I'm not sure that returning success here is
713 * correct, but I'm sure that reporting this
714 * as an internal error which our caller
715 * interprets as a malloc failure is wrong.
723 ret = tree_evaluate(tree);
725 tree_print("tree_evaluate()", tree, NULL);
730 /* Return value 2 means tree empty */
732 X509_policy_tree_free(tree);
733 if (*pexplicit_policy)
739 /* Tree is not empty: continue */
741 ret = tree_calculate_authority_set(tree, &auth_nodes);
746 if (!tree_calculate_user_set(tree, policy_oids, auth_nodes))
750 sk_X509_POLICY_NODE_free(auth_nodes);
755 if (*pexplicit_policy) {
756 nodes = X509_policy_tree_get0_user_policies(tree);
757 if (sk_X509_POLICY_NODE_num(nodes) <= 0)
765 X509_policy_tree_free(tree);