3 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
6 /* ====================================================================
7 * Copyright (c) 2003 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).
62 #include <openssl/asn1t.h>
63 #include <openssl/conf.h>
64 #include <openssl/x509v3.h>
66 #include "internal/x509_int.h"
68 static void *v2i_NAME_CONSTRAINTS(const X509V3_EXT_METHOD *method,
70 STACK_OF(CONF_VALUE) *nval);
71 static int i2r_NAME_CONSTRAINTS(const X509V3_EXT_METHOD *method, void *a,
73 static int do_i2r_name_constraints(const X509V3_EXT_METHOD *method,
74 STACK_OF(GENERAL_SUBTREE) *trees, BIO *bp,
76 static int print_nc_ipadd(BIO *bp, ASN1_OCTET_STRING *ip);
78 static int nc_match(GENERAL_NAME *gen, NAME_CONSTRAINTS *nc);
79 static int nc_match_single(GENERAL_NAME *sub, GENERAL_NAME *gen);
80 static int nc_dn(X509_NAME *sub, X509_NAME *nm);
81 static int nc_dns(ASN1_IA5STRING *sub, ASN1_IA5STRING *dns);
82 static int nc_email(ASN1_IA5STRING *sub, ASN1_IA5STRING *eml);
83 static int nc_uri(ASN1_IA5STRING *uri, ASN1_IA5STRING *base);
84 static int nc_ip(ASN1_OCTET_STRING *ip, ASN1_OCTET_STRING *base);
86 const X509V3_EXT_METHOD v3_name_constraints = {
87 NID_name_constraints, 0,
88 ASN1_ITEM_ref(NAME_CONSTRAINTS),
91 0, v2i_NAME_CONSTRAINTS,
92 i2r_NAME_CONSTRAINTS, 0,
96 ASN1_SEQUENCE(GENERAL_SUBTREE) = {
97 ASN1_SIMPLE(GENERAL_SUBTREE, base, GENERAL_NAME),
98 ASN1_IMP_OPT(GENERAL_SUBTREE, minimum, ASN1_INTEGER, 0),
99 ASN1_IMP_OPT(GENERAL_SUBTREE, maximum, ASN1_INTEGER, 1)
100 } ASN1_SEQUENCE_END(GENERAL_SUBTREE)
102 ASN1_SEQUENCE(NAME_CONSTRAINTS) = {
103 ASN1_IMP_SEQUENCE_OF_OPT(NAME_CONSTRAINTS, permittedSubtrees,
105 ASN1_IMP_SEQUENCE_OF_OPT(NAME_CONSTRAINTS, excludedSubtrees,
107 } ASN1_SEQUENCE_END(NAME_CONSTRAINTS)
110 IMPLEMENT_ASN1_ALLOC_FUNCTIONS(GENERAL_SUBTREE)
111 IMPLEMENT_ASN1_ALLOC_FUNCTIONS(NAME_CONSTRAINTS)
113 static void *v2i_NAME_CONSTRAINTS(const X509V3_EXT_METHOD *method,
114 X509V3_CTX *ctx, STACK_OF(CONF_VALUE) *nval)
117 CONF_VALUE tval, *val;
118 STACK_OF(GENERAL_SUBTREE) **ptree = NULL;
119 NAME_CONSTRAINTS *ncons = NULL;
120 GENERAL_SUBTREE *sub = NULL;
121 ncons = NAME_CONSTRAINTS_new();
124 for (i = 0; i < sk_CONF_VALUE_num(nval); i++) {
125 val = sk_CONF_VALUE_value(nval, i);
126 if (!strncmp(val->name, "permitted", 9) && val->name[9]) {
127 ptree = &ncons->permittedSubtrees;
128 tval.name = val->name + 10;
129 } else if (!strncmp(val->name, "excluded", 8) && val->name[8]) {
130 ptree = &ncons->excludedSubtrees;
131 tval.name = val->name + 9;
133 X509V3err(X509V3_F_V2I_NAME_CONSTRAINTS, X509V3_R_INVALID_SYNTAX);
136 tval.value = val->value;
137 sub = GENERAL_SUBTREE_new();
138 if (!v2i_GENERAL_NAME_ex(sub->base, method, ctx, &tval, 1))
141 *ptree = sk_GENERAL_SUBTREE_new_null();
142 if (!*ptree || !sk_GENERAL_SUBTREE_push(*ptree, sub))
150 X509V3err(X509V3_F_V2I_NAME_CONSTRAINTS, ERR_R_MALLOC_FAILURE);
152 NAME_CONSTRAINTS_free(ncons);
153 GENERAL_SUBTREE_free(sub);
158 static int i2r_NAME_CONSTRAINTS(const X509V3_EXT_METHOD *method, void *a,
161 NAME_CONSTRAINTS *ncons = a;
162 do_i2r_name_constraints(method, ncons->permittedSubtrees,
163 bp, ind, "Permitted");
164 do_i2r_name_constraints(method, ncons->excludedSubtrees,
165 bp, ind, "Excluded");
169 static int do_i2r_name_constraints(const X509V3_EXT_METHOD *method,
170 STACK_OF(GENERAL_SUBTREE) *trees,
171 BIO *bp, int ind, char *name)
173 GENERAL_SUBTREE *tree;
175 if (sk_GENERAL_SUBTREE_num(trees) > 0)
176 BIO_printf(bp, "%*s%s:\n", ind, "", name);
177 for (i = 0; i < sk_GENERAL_SUBTREE_num(trees); i++) {
178 tree = sk_GENERAL_SUBTREE_value(trees, i);
179 BIO_printf(bp, "%*s", ind + 2, "");
180 if (tree->base->type == GEN_IPADD)
181 print_nc_ipadd(bp, tree->base->d.ip);
183 GENERAL_NAME_print(bp, tree->base);
189 static int print_nc_ipadd(BIO *bp, ASN1_OCTET_STRING *ip)
197 BIO_printf(bp, "%d.%d.%d.%d/%d.%d.%d.%d",
198 p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7]);
199 } else if (len == 32) {
200 for (i = 0; i < 16; i++) {
201 BIO_printf(bp, "%X", p[0] << 8 | p[1]);
209 BIO_printf(bp, "IP Address:<invalid>");
214 * Check a certificate conforms to a specified set of constraints.
216 * X509_V_OK: All constraints obeyed.
217 * X509_V_ERR_PERMITTED_VIOLATION: Permitted subtree violation.
218 * X509_V_ERR_EXCLUDED_VIOLATION: Excluded subtree violation.
219 * X509_V_ERR_SUBTREE_MINMAX: Min or max values present and matching type.
220 * X509_V_ERR_UNSUPPORTED_CONSTRAINT_TYPE: Unsupported constraint type.
221 * X509_V_ERR_UNSUPPORTED_CONSTRAINT_SYNTAX: bad unsupported constraint syntax.
222 * X509_V_ERR_UNSUPPORTED_NAME_SYNTAX: bad or unsupported syntax of name
225 int NAME_CONSTRAINTS_check(X509 *x, NAME_CONSTRAINTS *nc)
230 nm = X509_get_subject_name(x);
232 if (X509_NAME_entry_count(nm) > 0) {
234 gntmp.type = GEN_DIRNAME;
235 gntmp.d.directoryName = nm;
237 r = nc_match(&gntmp, nc);
242 gntmp.type = GEN_EMAIL;
244 /* Process any email address attributes in subject name */
248 i = X509_NAME_get_index_by_NID(nm, NID_pkcs9_emailAddress, i);
251 ne = X509_NAME_get_entry(nm, i);
252 gntmp.d.rfc822Name = X509_NAME_ENTRY_get_data(ne);
253 if (gntmp.d.rfc822Name->type != V_ASN1_IA5STRING)
254 return X509_V_ERR_UNSUPPORTED_NAME_SYNTAX;
256 r = nc_match(&gntmp, nc);
264 for (i = 0; i < sk_GENERAL_NAME_num(x->altname); i++) {
265 GENERAL_NAME *gen = sk_GENERAL_NAME_value(x->altname, i);
266 r = nc_match(gen, nc);
275 static int nc_match(GENERAL_NAME *gen, NAME_CONSTRAINTS *nc)
277 GENERAL_SUBTREE *sub;
281 * Permitted subtrees: if any subtrees exist of matching the type at
282 * least one subtree must match.
285 for (i = 0; i < sk_GENERAL_SUBTREE_num(nc->permittedSubtrees); i++) {
286 sub = sk_GENERAL_SUBTREE_value(nc->permittedSubtrees, i);
287 if (gen->type != sub->base->type)
289 if (sub->minimum || sub->maximum)
290 return X509_V_ERR_SUBTREE_MINMAX;
291 /* If we already have a match don't bother trying any more */
296 r = nc_match_single(gen, sub->base);
299 else if (r != X509_V_ERR_PERMITTED_VIOLATION)
304 return X509_V_ERR_PERMITTED_VIOLATION;
306 /* Excluded subtrees: must not match any of these */
308 for (i = 0; i < sk_GENERAL_SUBTREE_num(nc->excludedSubtrees); i++) {
309 sub = sk_GENERAL_SUBTREE_value(nc->excludedSubtrees, i);
310 if (gen->type != sub->base->type)
312 if (sub->minimum || sub->maximum)
313 return X509_V_ERR_SUBTREE_MINMAX;
315 r = nc_match_single(gen, sub->base);
317 return X509_V_ERR_EXCLUDED_VIOLATION;
318 else if (r != X509_V_ERR_PERMITTED_VIOLATION)
327 static int nc_match_single(GENERAL_NAME *gen, GENERAL_NAME *base)
329 switch (base->type) {
331 return nc_dn(gen->d.directoryName, base->d.directoryName);
334 return nc_dns(gen->d.dNSName, base->d.dNSName);
337 return nc_email(gen->d.rfc822Name, base->d.rfc822Name);
340 return nc_uri(gen->d.uniformResourceIdentifier,
341 base->d.uniformResourceIdentifier);
344 return nc_ip(gen->d.iPAddress, base->d.iPAddress);
347 return X509_V_ERR_UNSUPPORTED_CONSTRAINT_TYPE;
353 * directoryName name constraint matching. The canonical encoding of
354 * X509_NAME makes this comparison easy. It is matched if the subtree is a
355 * subset of the name.
358 static int nc_dn(X509_NAME *nm, X509_NAME *base)
360 /* Ensure canonical encodings are up to date. */
361 if (nm->modified && i2d_X509_NAME(nm, NULL) < 0)
362 return X509_V_ERR_OUT_OF_MEM;
363 if (base->modified && i2d_X509_NAME(base, NULL) < 0)
364 return X509_V_ERR_OUT_OF_MEM;
365 if (base->canon_enclen > nm->canon_enclen)
366 return X509_V_ERR_PERMITTED_VIOLATION;
367 if (memcmp(base->canon_enc, nm->canon_enc, base->canon_enclen))
368 return X509_V_ERR_PERMITTED_VIOLATION;
372 static int nc_dns(ASN1_IA5STRING *dns, ASN1_IA5STRING *base)
374 char *baseptr = (char *)base->data;
375 char *dnsptr = (char *)dns->data;
376 /* Empty matches everything */
380 * Otherwise can add zero or more components on the left so compare RHS
381 * and if dns is longer and expect '.' as preceding character.
383 if (dns->length > base->length) {
384 dnsptr += dns->length - base->length;
385 if (*baseptr != '.' && dnsptr[-1] != '.')
386 return X509_V_ERR_PERMITTED_VIOLATION;
389 if (strcasecmp(baseptr, dnsptr))
390 return X509_V_ERR_PERMITTED_VIOLATION;
396 static int nc_email(ASN1_IA5STRING *eml, ASN1_IA5STRING *base)
398 const char *baseptr = (char *)base->data;
399 const char *emlptr = (char *)eml->data;
401 const char *baseat = strchr(baseptr, '@');
402 const char *emlat = strchr(emlptr, '@');
404 return X509_V_ERR_UNSUPPORTED_NAME_SYNTAX;
405 /* Special case: inital '.' is RHS match */
406 if (!baseat && (*baseptr == '.')) {
407 if (eml->length > base->length) {
408 emlptr += eml->length - base->length;
409 if (!strcasecmp(baseptr, emlptr))
412 return X509_V_ERR_PERMITTED_VIOLATION;
415 /* If we have anything before '@' match local part */
418 if (baseat != baseptr) {
419 if ((baseat - baseptr) != (emlat - emlptr))
420 return X509_V_ERR_PERMITTED_VIOLATION;
421 /* Case sensitive match of local part */
422 if (strncmp(baseptr, emlptr, emlat - emlptr))
423 return X509_V_ERR_PERMITTED_VIOLATION;
425 /* Position base after '@' */
426 baseptr = baseat + 1;
429 /* Just have hostname left to match: case insensitive */
430 if (strcasecmp(baseptr, emlptr))
431 return X509_V_ERR_PERMITTED_VIOLATION;
437 static int nc_uri(ASN1_IA5STRING *uri, ASN1_IA5STRING *base)
439 const char *baseptr = (char *)base->data;
440 const char *hostptr = (char *)uri->data;
441 const char *p = strchr(hostptr, ':');
443 /* Check for foo:// and skip past it */
444 if (!p || (p[1] != '/') || (p[2] != '/'))
445 return X509_V_ERR_UNSUPPORTED_NAME_SYNTAX;
448 /* Determine length of hostname part of URI */
450 /* Look for a port indicator as end of hostname first */
452 p = strchr(hostptr, ':');
453 /* Otherwise look for trailing slash */
455 p = strchr(hostptr, '/');
458 hostlen = strlen(hostptr);
460 hostlen = p - hostptr;
463 return X509_V_ERR_UNSUPPORTED_NAME_SYNTAX;
465 /* Special case: inital '.' is RHS match */
466 if (*baseptr == '.') {
467 if (hostlen > base->length) {
468 p = hostptr + hostlen - base->length;
469 if (!strncasecmp(p, baseptr, base->length))
472 return X509_V_ERR_PERMITTED_VIOLATION;
475 if ((base->length != (int)hostlen)
476 || strncasecmp(hostptr, baseptr, hostlen))
477 return X509_V_ERR_PERMITTED_VIOLATION;
483 static int nc_ip(ASN1_OCTET_STRING *ip, ASN1_OCTET_STRING *base)
485 int hostlen, baselen, i;
486 unsigned char *hostptr, *baseptr, *maskptr;
488 hostlen = ip->length;
489 baseptr = base->data;
490 baselen = base->length;
492 /* Invalid if not IPv4 or IPv6 */
493 if (!((hostlen == 4) || (hostlen == 16)))
494 return X509_V_ERR_UNSUPPORTED_NAME_SYNTAX;
495 if (!((baselen == 8) || (baselen == 32)))
496 return X509_V_ERR_UNSUPPORTED_NAME_SYNTAX;
498 /* Do not match IPv4 with IPv6 */
499 if (hostlen * 2 != baselen)
500 return X509_V_ERR_PERMITTED_VIOLATION;
502 maskptr = base->data + hostlen;
504 /* Considering possible not aligned base ipAddress */
505 /* Not checking for wrong mask definition: i.e.: 255.0.255.0 */
506 for (i = 0; i < hostlen; i++)
507 if ((hostptr[i] & maskptr[i]) != (baseptr[i] & maskptr[i]))
508 return X509_V_ERR_PERMITTED_VIOLATION;