2 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
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).
60 #include <openssl/x509.h>
61 #include <openssl/x509v3.h>
65 /* Enable this to print out the complete policy tree at various point during
69 /*#define OPENSSL_POLICY_DEBUG*/
71 #ifdef OPENSSL_POLICY_DEBUG
73 static void expected_print(BIO *err, X509_POLICY_LEVEL *lev,
74 X509_POLICY_NODE *node, int indent)
76 if ( (lev->flags & X509_V_FLAG_INHIBIT_MAP)
77 || !(node->data->flags & POLICY_DATA_FLAG_MAP_MASK))
78 BIO_puts(err, " Not Mapped\n");
82 STACK_OF(ASN1_OBJECT) *pset = node->data->expected_policy_set;
84 BIO_puts(err, " Expected: ");
85 for (i = 0; i < sk_ASN1_OBJECT_num(pset); i++)
87 oid = sk_ASN1_OBJECT_value(pset, i);
90 i2a_ASN1_OBJECT(err, oid);
96 static void tree_print(char *str, X509_POLICY_TREE *tree,
97 X509_POLICY_LEVEL *curr)
99 X509_POLICY_LEVEL *plev;
100 X509_POLICY_NODE *node;
103 err = BIO_new_fp(stderr, BIO_NOCLOSE);
105 curr = tree->levels + tree->nlevel;
108 BIO_printf(err, "Level print after %s\n", str);
109 BIO_printf(err, "Printing Up to Level %ld\n", curr - tree->levels);
110 for (plev = tree->levels; plev != curr; plev++)
112 BIO_printf(err, "Level %ld, flags = %x\n",
113 plev - tree->levels, plev->flags);
114 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) /* */
134 /* Initialize policy tree. Return values:
135 * 0 Some internal error occured.
136 * -1 Inconsistent or invalid extensions in certificates.
137 * 1 Tree initialized OK.
138 * 2 Policy tree is empty.
139 * 5 Tree OK and requireExplicitPolicy true.
140 * 6 Tree empty and requireExplicitPolicy true.
143 static int tree_init(X509_POLICY_TREE **ptree, STACK_OF(X509) *certs,
146 X509_POLICY_TREE *tree;
147 X509_POLICY_LEVEL *level;
148 const X509_POLICY_CACHE *cache;
149 X509_POLICY_DATA *data = NULL;
157 n = sk_X509_num(certs);
160 /* Disable policy mapping for now... */
161 flags |= X509_V_FLAG_INHIBIT_MAP;
164 if (flags & X509_V_FLAG_EXPLICIT_POLICY)
167 explicit_policy = n + 1;
169 if (flags & X509_V_FLAG_INHIBIT_ANY)
174 if (flags & X509_V_FLAG_INHIBIT_MAP)
179 /* Can't do anything with just a trust anchor */
182 /* First setup policy cache in all certificates apart from the
183 * trust anchor. Note any bad cache results on the way. Also can
184 * calculate explicit_policy value at this point.
186 for (i = n - 2; i >= 0; i--)
188 x = sk_X509_value(certs, i);
189 X509_check_purpose(x, -1, -1);
190 cache = policy_cache_set(x);
191 /* If cache NULL something bad happened: return immediately */
194 /* If inconsistent extensions keep a note of it but continue */
195 if (x->ex_flags & EXFLAG_INVALID_POLICY)
197 /* Otherwise if we have no data (hence no CertificatePolicies)
198 * and haven't already set an inconsistent code note it.
200 else if ((ret == 1) && !cache->data)
202 if (explicit_policy > 0)
204 if (!(x->ex_flags & EXFLAG_SI))
206 if ((cache->explicit_skip != -1)
207 && (cache->explicit_skip < explicit_policy))
208 explicit_policy = cache->explicit_skip;
214 if (ret == 2 && !explicit_policy)
220 /* If we get this far initialize the tree */
222 tree = OPENSSL_malloc(sizeof(X509_POLICY_TREE));
228 tree->levels = OPENSSL_malloc(sizeof(X509_POLICY_LEVEL) * n);
230 tree->extra_data = NULL;
231 tree->auth_policies = NULL;
232 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--)
256 x = sk_X509_value(certs, i);
257 cache = policy_cache_set(x);
258 CRYPTO_add(&x->references, 1, CRYPTO_LOCK_X509);
261 if (!cache->anyPolicy)
262 level->flags |= X509_V_FLAG_INHIBIT_ANY;
264 /* Determine inhibit any and inhibit map flags */
267 /* Any matching allowed if certificate is self
268 * issued and not the last in the chain.
270 if (!(x->ex_flags & EXFLAG_SI) || (i == 0))
271 level->flags |= X509_V_FLAG_INHIBIT_ANY;
275 if (!(x->ex_flags & EXFLAG_SI))
277 if ((cache->any_skip >= 0)
278 && (cache->any_skip < any_skip))
279 any_skip = cache->any_skip;
283 level->flags |= X509_V_FLAG_INHIBIT_MAP;
286 if (!(x->ex_flags & EXFLAG_SI))
288 if ((cache->map_skip >= 0)
289 && (cache->map_skip < map_skip))
290 map_skip = cache->map_skip;
304 X509_policy_tree_free(tree);
310 static int tree_link_matching_nodes(X509_POLICY_LEVEL *curr,
311 const X509_POLICY_DATA *data)
313 X509_POLICY_LEVEL *last = curr - 1;
314 X509_POLICY_NODE *node;
316 /* Iterate through all in nodes linking matches */
317 for (i = 0; i < sk_X509_POLICY_NODE_num(last->nodes); i++)
319 node = sk_X509_POLICY_NODE_value(last->nodes, i);
320 if (policy_node_match(last, node, data->valid_policy))
322 if (!level_add_node(curr, data, node, NULL))
327 if (!matched && last->anyPolicy)
329 if (!level_add_node(curr, data, last->anyPolicy, NULL))
335 /* This corresponds to RFC3280 6.1.3(d)(1):
336 * link any data from CertificatePolicies onto matching parent
337 * or anyPolicy if no match.
340 static int tree_link_nodes(X509_POLICY_LEVEL *curr,
341 const X509_POLICY_CACHE *cache)
344 X509_POLICY_LEVEL *last;
345 X509_POLICY_DATA *data;
347 for (i = 0; i < sk_X509_POLICY_DATA_num(cache->data); i++)
349 data = sk_X509_POLICY_DATA_value(cache->data, i);
350 /* If a node is mapped any it doesn't have a corresponding
351 * CertificatePolicies entry.
352 * However such an identical node would be created
353 * if anyPolicy matching is enabled because there would be
354 * no match with the parent valid_policy_set. So we create
355 * link because then it will have the mapping flags
356 * right and we can prune it later.
359 if ((data->flags & POLICY_DATA_FLAG_MAPPED_ANY)
360 && !(curr->flags & X509_V_FLAG_INHIBIT_ANY))
363 /* Look for matching nodes in previous level */
364 if (!tree_link_matching_nodes(curr, data))
370 /* This corresponds to RFC3280 6.1.3(d)(2):
371 * Create new data for any unmatched policies in the parent and link
375 static int tree_add_unmatched(X509_POLICY_LEVEL *curr,
376 const X509_POLICY_CACHE *cache,
377 const ASN1_OBJECT *id,
378 X509_POLICY_NODE *node,
379 X509_POLICY_TREE *tree)
381 X509_POLICY_DATA *data;
383 id = node->data->valid_policy;
384 /* Create a new node with qualifiers from anyPolicy and
385 * id from unmatched node.
387 data = policy_data_new(NULL, id, node_critical(node));
391 /* Curr may not have anyPolicy */
392 data->qualifier_set = cache->anyPolicy->qualifier_set;
393 data->flags |= POLICY_DATA_FLAG_SHARED_QUALIFIERS;
394 if (!level_add_node(curr, data, node, tree))
396 policy_data_free(data);
403 static int tree_link_unmatched(X509_POLICY_LEVEL *curr,
404 const X509_POLICY_CACHE *cache,
405 X509_POLICY_NODE *node,
406 X509_POLICY_TREE *tree)
408 const X509_POLICY_LEVEL *last = curr - 1;
411 if ( (last->flags & X509_V_FLAG_INHIBIT_MAP)
412 || !(node->data->flags & POLICY_DATA_FLAG_MAPPED))
414 /* If no policy mapping: matched if one child present */
417 if (!tree_add_unmatched(curr, cache, NULL, node, tree))
423 /* If mapping: matched if one child per expected policy set */
424 STACK_OF(ASN1_OBJECT) *expset = node->data->expected_policy_set;
425 if (node->nchild == sk_ASN1_OBJECT_num(expset))
427 /* Locate unmatched nodes */
428 for (i = 0; i < sk_ASN1_OBJECT_num(expset); i++)
430 ASN1_OBJECT *oid = sk_ASN1_OBJECT_value(expset, i);
431 if (level_find_node(curr, node, oid))
433 if (!tree_add_unmatched(curr, cache, oid, node, tree))
443 static int tree_link_any(X509_POLICY_LEVEL *curr,
444 const X509_POLICY_CACHE *cache,
445 X509_POLICY_TREE *tree)
448 /*X509_POLICY_DATA *data;*/
449 X509_POLICY_NODE *node;
450 X509_POLICY_LEVEL *last = curr - 1;
452 for (i = 0; i < sk_X509_POLICY_NODE_num(last->nodes); i++)
454 node = sk_X509_POLICY_NODE_value(last->nodes, i);
456 if (!tree_link_unmatched(curr, cache, node, tree))
461 /* Skip any node with any children: we only want unmathced
464 * Note: need something better for policy mapping
465 * because each node may have multiple children
470 /* Create a new node with qualifiers from anyPolicy and
471 * id from unmatched node.
473 data = policy_data_new(NULL, node->data->valid_policy,
474 node_critical(node));
478 /* Curr may not have anyPolicy */
479 data->qualifier_set = cache->anyPolicy->qualifier_set;
480 data->flags |= POLICY_DATA_FLAG_SHARED_QUALIFIERS;
481 if (!level_add_node(curr, data, node, tree))
483 policy_data_free(data);
490 /* Finally add link to anyPolicy */
493 if (!level_add_node(curr, cache->anyPolicy,
494 last->anyPolicy, NULL))
500 /* Prune the tree: delete any child mapped child data on the current level
501 * then proceed up the tree deleting any data with no children. If we ever
502 * have no data on a level we can halt because the tree will be empty.
505 static int tree_prune(X509_POLICY_TREE *tree, X509_POLICY_LEVEL *curr)
507 STACK_OF(X509_POLICY_NODE) *nodes;
508 X509_POLICY_NODE *node;
511 if (curr->flags & X509_V_FLAG_INHIBIT_MAP)
513 for (i = sk_X509_POLICY_NODE_num(nodes) - 1; i >= 0; i--)
515 node = sk_X509_POLICY_NODE_value(nodes, i);
516 /* Delete any mapped data: see RFC3280 XXXX */
517 if (node->data->flags & POLICY_DATA_FLAG_MAP_MASK)
519 node->parent->nchild--;
521 (void)sk_X509_POLICY_NODE_delete(nodes,i);
529 for (i = sk_X509_POLICY_NODE_num(nodes) - 1; i >= 0; i--)
531 node = sk_X509_POLICY_NODE_value(nodes, i);
532 if (node->nchild == 0)
534 node->parent->nchild--;
536 (void)sk_X509_POLICY_NODE_delete(nodes, i);
539 if (curr->anyPolicy && !curr->anyPolicy->nchild)
541 if (curr->anyPolicy->parent)
542 curr->anyPolicy->parent->nchild--;
543 OPENSSL_free(curr->anyPolicy);
544 curr->anyPolicy = NULL;
546 if (curr == tree->levels)
548 /* If we zapped anyPolicy at top then tree is empty */
549 if (!curr->anyPolicy)
559 static int tree_add_auth_node(STACK_OF(X509_POLICY_NODE) **pnodes,
560 X509_POLICY_NODE *pcy)
564 *pnodes = policy_node_cmp_new();
568 else if (sk_X509_POLICY_NODE_find(*pnodes, pcy) != -1)
571 if (!sk_X509_POLICY_NODE_push(*pnodes, pcy))
578 /* Calculate the authority set based on policy tree.
579 * The 'pnodes' parameter is used as a store for the set of policy nodes
580 * used to calculate the user set. If the authority set is not anyPolicy
581 * then pnodes will just point to the authority set. If however the authority
582 * set is anyPolicy then the set of valid policies (other than anyPolicy)
583 * is store in pnodes. The return value of '2' is used in this case to indicate
584 * that pnodes should be freed.
587 static int tree_calculate_authority_set(X509_POLICY_TREE *tree,
588 STACK_OF(X509_POLICY_NODE) **pnodes)
590 X509_POLICY_LEVEL *curr;
591 X509_POLICY_NODE *node, *anyptr;
592 STACK_OF(X509_POLICY_NODE) **addnodes;
594 curr = tree->levels + tree->nlevel - 1;
596 /* If last level contains anyPolicy set is anyPolicy */
599 if (!tree_add_auth_node(&tree->auth_policies, curr->anyPolicy))
604 /* Add policies to authority set */
605 addnodes = &tree->auth_policies;
608 for (i = 1; i < tree->nlevel; i++)
610 /* If no anyPolicy node on this this level it can't
611 * appear on lower levels so end search.
613 if (!(anyptr = curr->anyPolicy))
616 for (j = 0; j < sk_X509_POLICY_NODE_num(curr->nodes); j++)
618 node = sk_X509_POLICY_NODE_value(curr->nodes, j);
619 if ((node->parent == anyptr)
620 && !tree_add_auth_node(addnodes, node))
625 if (addnodes == pnodes)
628 *pnodes = tree->auth_policies;
633 static int tree_calculate_user_set(X509_POLICY_TREE *tree,
634 STACK_OF(ASN1_OBJECT) *policy_oids,
635 STACK_OF(X509_POLICY_NODE) *auth_nodes)
638 X509_POLICY_NODE *node;
641 X509_POLICY_NODE *anyPolicy;
642 X509_POLICY_DATA *extra;
644 /* Check if anyPolicy present in authority constrained policy set:
645 * this will happen if it is a leaf node.
648 if (sk_ASN1_OBJECT_num(policy_oids) <= 0)
651 anyPolicy = tree->levels[tree->nlevel - 1].anyPolicy;
653 for (i = 0; i < sk_ASN1_OBJECT_num(policy_oids); i++)
655 oid = sk_ASN1_OBJECT_value(policy_oids, i);
656 if (OBJ_obj2nid(oid) == NID_any_policy)
658 tree->flags |= POLICY_FLAG_ANY_POLICY;
663 for (i = 0; i < sk_ASN1_OBJECT_num(policy_oids); i++)
665 oid = sk_ASN1_OBJECT_value(policy_oids, i);
666 node = tree_find_sk(auth_nodes, oid);
671 /* Create a new node with policy ID from user set
672 * and qualifiers from anyPolicy.
674 extra = policy_data_new(NULL, oid,
675 node_critical(anyPolicy));
678 extra->qualifier_set = anyPolicy->data->qualifier_set;
679 extra->flags = POLICY_DATA_FLAG_SHARED_QUALIFIERS
680 | POLICY_DATA_FLAG_EXTRA_NODE;
681 node = level_add_node(NULL, extra, anyPolicy->parent,
684 if (!tree->user_policies)
686 tree->user_policies = sk_X509_POLICY_NODE_new_null();
687 if (!tree->user_policies)
690 if (!sk_X509_POLICY_NODE_push(tree->user_policies, node))
697 static int tree_evaluate(X509_POLICY_TREE *tree)
700 X509_POLICY_LEVEL *curr = tree->levels + 1;
701 const X509_POLICY_CACHE *cache;
703 for(i = 1; i < tree->nlevel; i++, curr++)
705 cache = policy_cache_set(curr->cert);
706 if (!tree_link_nodes(curr, cache))
709 if (!(curr->flags & X509_V_FLAG_INHIBIT_ANY)
710 && !tree_link_any(curr, cache, tree))
712 tree_print("before tree_prune()", tree, curr);
713 ret = tree_prune(tree, curr);
722 static void exnode_free(X509_POLICY_NODE *node)
724 if (node->data && (node->data->flags & POLICY_DATA_FLAG_EXTRA_NODE))
729 void X509_policy_tree_free(X509_POLICY_TREE *tree)
731 X509_POLICY_LEVEL *curr;
737 sk_X509_POLICY_NODE_free(tree->auth_policies);
738 sk_X509_POLICY_NODE_pop_free(tree->user_policies, exnode_free);
740 for(i = 0, curr = tree->levels; i < tree->nlevel; i++, curr++)
743 X509_free(curr->cert);
745 sk_X509_POLICY_NODE_pop_free(curr->nodes,
748 policy_node_free(curr->anyPolicy);
751 if (tree->extra_data)
752 sk_X509_POLICY_DATA_pop_free(tree->extra_data,
755 OPENSSL_free(tree->levels);
760 /* Application policy checking function.
764 * -1 One or more certificates contain invalid or inconsistent extensions
765 * -2 User constrained policy set empty and requireExplicit true.
768 int X509_policy_check(X509_POLICY_TREE **ptree, int *pexplicit_policy,
769 STACK_OF(X509) *certs,
770 STACK_OF(ASN1_OBJECT) *policy_oids,
774 X509_POLICY_TREE *tree = NULL;
775 STACK_OF(X509_POLICY_NODE) *nodes, *auth_nodes = NULL;
778 *pexplicit_policy = 0;
779 ret = tree_init(&tree, certs, flags);
784 /* Tree empty requireExplicit False: OK */
788 /* Some internal error */
792 /* Some internal error */
796 /* Tree empty requireExplicit True: Error */
799 *pexplicit_policy = 1;
802 /* Tree OK requireExplicit True: OK and continue */
804 *pexplicit_policy = 1;
807 /* Tree OK: continue */
812 * tree_init() returns success and a null tree
813 * if it's just looking at a trust anchor.
814 * I'm not sure that returning success here is
815 * correct, but I'm sure that reporting this
816 * as an internal error which our caller
817 * interprets as a malloc failure is wrong.
823 if (!tree) goto error;
824 ret = tree_evaluate(tree);
826 tree_print("tree_evaluate()", tree, NULL);
831 /* Return value 2 means tree empty */
834 X509_policy_tree_free(tree);
835 if (*pexplicit_policy)
841 /* Tree is not empty: continue */
843 ret = tree_calculate_authority_set(tree, &auth_nodes);
848 if (!tree_calculate_user_set(tree, policy_oids, auth_nodes))
852 sk_X509_POLICY_NODE_free(auth_nodes);
857 if (*pexplicit_policy)
859 nodes = X509_policy_tree_get0_user_policies(tree);
860 if (sk_X509_POLICY_NODE_num(nodes) <= 0)
868 X509_policy_tree_free(tree);