1 /* $OpenBSD: x509_ncons.c,v 1.5 2021/11/01 20:53:08 tb Exp $ */
2 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 2003 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).
62 #include <openssl/asn1t.h>
63 #include <openssl/conf.h>
64 #include <openssl/err.h>
65 #include <openssl/x509v3.h>
69 static void *v2i_NAME_CONSTRAINTS(const X509V3_EXT_METHOD *method,
70 X509V3_CTX *ctx, STACK_OF(CONF_VALUE) *nval);
71 static int i2r_NAME_CONSTRAINTS(const X509V3_EXT_METHOD *method,
72 void *a, BIO *bp, int ind);
73 static int do_i2r_name_constraints(const X509V3_EXT_METHOD *method,
74 STACK_OF(GENERAL_SUBTREE) *trees, BIO *bp, int ind, char *name);
75 static int print_nc_ipadd(BIO *bp, ASN1_OCTET_STRING *ip);
77 static int nc_match(GENERAL_NAME *gen, NAME_CONSTRAINTS *nc);
78 static int nc_match_single(GENERAL_NAME *sub, GENERAL_NAME *gen);
79 static int nc_dn(X509_NAME *sub, X509_NAME *nm);
80 static int nc_dns(ASN1_IA5STRING *sub, ASN1_IA5STRING *dns);
81 static int nc_email(ASN1_IA5STRING *sub, ASN1_IA5STRING *eml);
82 static int nc_uri(ASN1_IA5STRING *uri, ASN1_IA5STRING *base);
84 const X509V3_EXT_METHOD v3_name_constraints = {
85 .ext_nid = NID_name_constraints,
87 .it = &NAME_CONSTRAINTS_it,
95 .v2i = v2i_NAME_CONSTRAINTS,
96 .i2r = i2r_NAME_CONSTRAINTS,
101 static const ASN1_TEMPLATE GENERAL_SUBTREE_seq_tt[] = {
105 .offset = offsetof(GENERAL_SUBTREE, base),
106 .field_name = "base",
107 .item = &GENERAL_NAME_it,
110 .flags = ASN1_TFLG_IMPLICIT | ASN1_TFLG_OPTIONAL,
112 .offset = offsetof(GENERAL_SUBTREE, minimum),
113 .field_name = "minimum",
114 .item = &ASN1_INTEGER_it,
117 .flags = ASN1_TFLG_IMPLICIT | ASN1_TFLG_OPTIONAL,
119 .offset = offsetof(GENERAL_SUBTREE, maximum),
120 .field_name = "maximum",
121 .item = &ASN1_INTEGER_it,
125 const ASN1_ITEM GENERAL_SUBTREE_it = {
126 .itype = ASN1_ITYPE_SEQUENCE,
127 .utype = V_ASN1_SEQUENCE,
128 .templates = GENERAL_SUBTREE_seq_tt,
129 .tcount = sizeof(GENERAL_SUBTREE_seq_tt) / sizeof(ASN1_TEMPLATE),
131 .size = sizeof(GENERAL_SUBTREE),
132 .sname = "GENERAL_SUBTREE",
135 static const ASN1_TEMPLATE NAME_CONSTRAINTS_seq_tt[] = {
137 .flags = ASN1_TFLG_IMPLICIT | ASN1_TFLG_SEQUENCE_OF | ASN1_TFLG_OPTIONAL,
139 .offset = offsetof(NAME_CONSTRAINTS, permittedSubtrees),
140 .field_name = "permittedSubtrees",
141 .item = &GENERAL_SUBTREE_it,
144 .flags = ASN1_TFLG_IMPLICIT | ASN1_TFLG_SEQUENCE_OF | ASN1_TFLG_OPTIONAL,
146 .offset = offsetof(NAME_CONSTRAINTS, excludedSubtrees),
147 .field_name = "excludedSubtrees",
148 .item = &GENERAL_SUBTREE_it,
152 const ASN1_ITEM NAME_CONSTRAINTS_it = {
153 .itype = ASN1_ITYPE_SEQUENCE,
154 .utype = V_ASN1_SEQUENCE,
155 .templates = NAME_CONSTRAINTS_seq_tt,
156 .tcount = sizeof(NAME_CONSTRAINTS_seq_tt) / sizeof(ASN1_TEMPLATE),
158 .size = sizeof(NAME_CONSTRAINTS),
159 .sname = "NAME_CONSTRAINTS",
164 GENERAL_SUBTREE_new(void)
166 return (GENERAL_SUBTREE*)ASN1_item_new(&GENERAL_SUBTREE_it);
170 GENERAL_SUBTREE_free(GENERAL_SUBTREE *a)
172 ASN1_item_free((ASN1_VALUE *)a, &GENERAL_SUBTREE_it);
176 NAME_CONSTRAINTS_new(void)
178 return (NAME_CONSTRAINTS*)ASN1_item_new(&NAME_CONSTRAINTS_it);
182 NAME_CONSTRAINTS_free(NAME_CONSTRAINTS *a)
184 ASN1_item_free((ASN1_VALUE *)a, &NAME_CONSTRAINTS_it);
188 v2i_NAME_CONSTRAINTS(const X509V3_EXT_METHOD *method, X509V3_CTX *ctx,
189 STACK_OF(CONF_VALUE) *nval)
192 CONF_VALUE tval, *val;
193 STACK_OF(GENERAL_SUBTREE) **ptree = NULL;
194 NAME_CONSTRAINTS *ncons = NULL;
195 GENERAL_SUBTREE *sub = NULL;
197 ncons = NAME_CONSTRAINTS_new();
200 for (i = 0; i < sk_CONF_VALUE_num(nval); i++) {
201 val = sk_CONF_VALUE_value(nval, i);
202 if (!strncmp(val->name, "permitted", 9) && val->name[9]) {
203 ptree = &ncons->permittedSubtrees;
204 tval.name = val->name + 10;
205 } else if (!strncmp(val->name, "excluded", 8) && val->name[8]) {
206 ptree = &ncons->excludedSubtrees;
207 tval.name = val->name + 9;
209 X509V3error(X509V3_R_INVALID_SYNTAX);
212 tval.value = val->value;
213 sub = GENERAL_SUBTREE_new();
214 if (!v2i_GENERAL_NAME_ex(sub->base, method, ctx, &tval, 1))
217 *ptree = sk_GENERAL_SUBTREE_new_null();
218 if (!*ptree || !sk_GENERAL_SUBTREE_push(*ptree, sub))
226 X509V3error(ERR_R_MALLOC_FAILURE);
228 NAME_CONSTRAINTS_free(ncons);
229 GENERAL_SUBTREE_free(sub);
234 i2r_NAME_CONSTRAINTS(const X509V3_EXT_METHOD *method, void *a, BIO *bp, int ind)
236 NAME_CONSTRAINTS *ncons = a;
238 do_i2r_name_constraints(method, ncons->permittedSubtrees,
239 bp, ind, "Permitted");
240 do_i2r_name_constraints(method, ncons->excludedSubtrees,
241 bp, ind, "Excluded");
246 do_i2r_name_constraints(const X509V3_EXT_METHOD *method,
247 STACK_OF(GENERAL_SUBTREE) *trees, BIO *bp, int ind, char *name)
249 GENERAL_SUBTREE *tree;
252 if (sk_GENERAL_SUBTREE_num(trees) > 0)
253 BIO_printf(bp, "%*s%s:\n", ind, "", name);
254 for (i = 0; i < sk_GENERAL_SUBTREE_num(trees); i++) {
255 tree = sk_GENERAL_SUBTREE_value(trees, i);
256 BIO_printf(bp, "%*s", ind + 2, "");
257 if (tree->base->type == GEN_IPADD)
258 print_nc_ipadd(bp, tree->base->d.ip);
260 GENERAL_NAME_print(bp, tree->base);
267 print_nc_ipadd(BIO *bp, ASN1_OCTET_STRING *ip)
276 BIO_printf(bp, "%d.%d.%d.%d/%d.%d.%d.%d",
277 p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7]);
278 } else if (len == 32) {
279 for (i = 0; i < 16; i++) {
280 BIO_printf(bp, "%X", p[0] << 8 | p[1]);
288 BIO_printf(bp, "IP Address:<invalid>");
292 /* Check a certificate conforms to a specified set of constraints.
294 * X509_V_OK: All constraints obeyed.
295 * X509_V_ERR_PERMITTED_VIOLATION: Permitted subtree violation.
296 * X509_V_ERR_EXCLUDED_VIOLATION: Excluded subtree violation.
297 * X509_V_ERR_SUBTREE_MINMAX: Min or max values present and matching type.
298 * X509_V_ERR_UNSUPPORTED_CONSTRAINT_TYPE: Unsupported constraint type.
299 * X509_V_ERR_UNSUPPORTED_CONSTRAINT_SYNTAX: bad unsupported constraint syntax.
300 * X509_V_ERR_UNSUPPORTED_NAME_SYNTAX: bad or unsupported syntax of name
304 NAME_CONSTRAINTS_check(X509 *x, NAME_CONSTRAINTS *nc)
309 nm = X509_get_subject_name(x);
311 if (X509_NAME_entry_count(nm) > 0) {
313 gntmp.type = GEN_DIRNAME;
314 gntmp.d.directoryName = nm;
316 r = nc_match(&gntmp, nc);
321 gntmp.type = GEN_EMAIL;
323 /* Process any email address attributes in subject name */
327 i = X509_NAME_get_index_by_NID(nm,
328 NID_pkcs9_emailAddress, i);
331 ne = X509_NAME_get_entry(nm, i);
332 gntmp.d.rfc822Name = X509_NAME_ENTRY_get_data(ne);
333 if (gntmp.d.rfc822Name->type != V_ASN1_IA5STRING)
334 return X509_V_ERR_UNSUPPORTED_NAME_SYNTAX;
336 r = nc_match(&gntmp, nc);
344 for (i = 0; i < sk_GENERAL_NAME_num(x->altname); i++) {
345 GENERAL_NAME *gen = sk_GENERAL_NAME_value(x->altname, i);
346 r = nc_match(gen, nc);
353 nc_match(GENERAL_NAME *gen, NAME_CONSTRAINTS *nc)
355 GENERAL_SUBTREE *sub;
358 /* Permitted subtrees: if any subtrees exist of matching the type
359 * at least one subtree must match.
362 for (i = 0; i < sk_GENERAL_SUBTREE_num(nc->permittedSubtrees); i++) {
363 sub = sk_GENERAL_SUBTREE_value(nc->permittedSubtrees, i);
364 if (gen->type != sub->base->type)
366 if (sub->minimum || sub->maximum)
367 return X509_V_ERR_SUBTREE_MINMAX;
368 /* If we already have a match don't bother trying any more */
373 r = nc_match_single(gen, sub->base);
376 else if (r != X509_V_ERR_PERMITTED_VIOLATION)
381 return X509_V_ERR_PERMITTED_VIOLATION;
383 /* Excluded subtrees: must not match any of these */
385 for (i = 0; i < sk_GENERAL_SUBTREE_num(nc->excludedSubtrees); i++) {
386 sub = sk_GENERAL_SUBTREE_value(nc->excludedSubtrees, i);
387 if (gen->type != sub->base->type)
389 if (sub->minimum || sub->maximum)
390 return X509_V_ERR_SUBTREE_MINMAX;
392 r = nc_match_single(gen, sub->base);
394 return X509_V_ERR_EXCLUDED_VIOLATION;
395 else if (r != X509_V_ERR_PERMITTED_VIOLATION)
404 nc_match_single(GENERAL_NAME *gen, GENERAL_NAME *base)
406 switch (base->type) {
408 return nc_dn(gen->d.directoryName, base->d.directoryName);
411 return nc_dns(gen->d.dNSName, base->d.dNSName);
414 return nc_email(gen->d.rfc822Name, base->d.rfc822Name);
417 return nc_uri(gen->d.uniformResourceIdentifier,
418 base->d.uniformResourceIdentifier);
421 return X509_V_ERR_UNSUPPORTED_CONSTRAINT_TYPE;
425 /* directoryName name constraint matching.
426 * The canonical encoding of X509_NAME makes this comparison easy. It is
427 * matched if the subtree is a subset of the name.
431 nc_dn(X509_NAME *nm, X509_NAME *base)
433 /* Ensure canonical encodings are up to date. */
434 if (nm->modified && i2d_X509_NAME(nm, NULL) < 0)
435 return X509_V_ERR_OUT_OF_MEM;
436 if (base->modified && i2d_X509_NAME(base, NULL) < 0)
437 return X509_V_ERR_OUT_OF_MEM;
438 if (base->canon_enclen > nm->canon_enclen)
439 return X509_V_ERR_PERMITTED_VIOLATION;
440 if (memcmp(base->canon_enc, nm->canon_enc, base->canon_enclen))
441 return X509_V_ERR_PERMITTED_VIOLATION;
446 nc_dns(ASN1_IA5STRING *dns, ASN1_IA5STRING *base)
448 char *baseptr = (char *)base->data;
449 char *dnsptr = (char *)dns->data;
451 /* Empty matches everything */
454 /* Otherwise can add zero or more components on the left so
455 * compare RHS and if dns is longer and expect '.' as preceding
458 if (dns->length > base->length) {
459 dnsptr += dns->length - base->length;
460 if (baseptr[0] != '.' && dnsptr[-1] != '.')
461 return X509_V_ERR_PERMITTED_VIOLATION;
464 if (strcasecmp(baseptr, dnsptr))
465 return X509_V_ERR_PERMITTED_VIOLATION;
471 nc_email(ASN1_IA5STRING *eml, ASN1_IA5STRING *base)
473 const char *baseptr = (char *)base->data;
474 const char *emlptr = (char *)eml->data;
475 const char *baseat = strchr(baseptr, '@');
476 const char *emlat = strchr(emlptr, '@');
479 return X509_V_ERR_UNSUPPORTED_NAME_SYNTAX;
480 /* Special case: inital '.' is RHS match */
481 if (!baseat && (*baseptr == '.')) {
482 if (eml->length > base->length) {
483 emlptr += eml->length - base->length;
484 if (!strcasecmp(baseptr, emlptr))
487 return X509_V_ERR_PERMITTED_VIOLATION;
490 /* If we have anything before '@' match local part */
493 if (baseat != baseptr) {
494 if ((baseat - baseptr) != (emlat - emlptr))
495 return X509_V_ERR_PERMITTED_VIOLATION;
496 /* Case sensitive match of local part */
497 if (strncmp(baseptr, emlptr, emlat - emlptr))
498 return X509_V_ERR_PERMITTED_VIOLATION;
500 /* Position base after '@' */
501 baseptr = baseat + 1;
504 /* Just have hostname left to match: case insensitive */
505 if (strcasecmp(baseptr, emlptr))
506 return X509_V_ERR_PERMITTED_VIOLATION;
512 nc_uri(ASN1_IA5STRING *uri, ASN1_IA5STRING *base)
514 const char *baseptr = (char *)base->data;
515 const char *hostptr = (char *)uri->data;
516 const char *p = strchr(hostptr, ':');
519 /* Check for foo:// and skip past it */
520 if (!p || (p[1] != '/') || (p[2] != '/'))
521 return X509_V_ERR_UNSUPPORTED_NAME_SYNTAX;
524 /* Determine length of hostname part of URI */
526 /* Look for a port indicator as end of hostname first */
528 p = strchr(hostptr, ':');
529 /* Otherwise look for trailing slash */
531 p = strchr(hostptr, '/');
534 hostlen = strlen(hostptr);
536 hostlen = p - hostptr;
539 return X509_V_ERR_UNSUPPORTED_NAME_SYNTAX;
541 /* Special case: inital '.' is RHS match */
542 if (*baseptr == '.') {
543 if (hostlen > base->length) {
544 p = hostptr + hostlen - base->length;
545 if (!strncasecmp(p, baseptr, base->length))
548 return X509_V_ERR_PERMITTED_VIOLATION;
551 if ((base->length != (int)hostlen) ||
552 strncasecmp(hostptr, baseptr, hostlen))
553 return X509_V_ERR_PERMITTED_VIOLATION;