561128e3faddeb8bef86fd90a8e5e135e4373db5
[openssl.git] / crypto / x509v3 / v3_ncons.c
1 /*
2  * Copyright 2003-2017 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #include "e_os.h"               /* for strncasecmp */
11 #include "internal/cryptlib.h"
12 #include <limits.h>
13 #include <stdio.h>
14 #include "internal/asn1_int.h"
15 #include <openssl/asn1t.h>
16 #include <openssl/conf.h>
17 #include <openssl/x509v3.h>
18
19 #include "internal/x509_int.h"
20 #include "ext_dat.h"
21
22 static void *v2i_NAME_CONSTRAINTS(const X509V3_EXT_METHOD *method,
23                                   X509V3_CTX *ctx,
24                                   STACK_OF(CONF_VALUE) *nval);
25 static int i2r_NAME_CONSTRAINTS(const X509V3_EXT_METHOD *method, void *a,
26                                 BIO *bp, int ind);
27 static int do_i2r_name_constraints(const X509V3_EXT_METHOD *method,
28                                    STACK_OF(GENERAL_SUBTREE) *trees, BIO *bp,
29                                    int ind, const char *name);
30 static int print_nc_ipadd(BIO *bp, ASN1_OCTET_STRING *ip);
31
32 static int nc_match(GENERAL_NAME *gen, NAME_CONSTRAINTS *nc);
33 static int nc_match_single(GENERAL_NAME *sub, GENERAL_NAME *gen);
34 static int nc_dn(X509_NAME *sub, X509_NAME *nm);
35 static int nc_dns(ASN1_IA5STRING *sub, ASN1_IA5STRING *dns);
36 static int nc_email(ASN1_IA5STRING *sub, ASN1_IA5STRING *eml);
37 static int nc_uri(ASN1_IA5STRING *uri, ASN1_IA5STRING *base);
38 static int nc_ip(ASN1_OCTET_STRING *ip, ASN1_OCTET_STRING *base);
39
40 const X509V3_EXT_METHOD v3_name_constraints = {
41     NID_name_constraints, 0,
42     ASN1_ITEM_ref(NAME_CONSTRAINTS),
43     0, 0, 0, 0,
44     0, 0,
45     0, v2i_NAME_CONSTRAINTS,
46     i2r_NAME_CONSTRAINTS, 0,
47     NULL
48 };
49
50 ASN1_SEQUENCE(GENERAL_SUBTREE) = {
51         ASN1_SIMPLE(GENERAL_SUBTREE, base, GENERAL_NAME),
52         ASN1_IMP_OPT(GENERAL_SUBTREE, minimum, ASN1_INTEGER, 0),
53         ASN1_IMP_OPT(GENERAL_SUBTREE, maximum, ASN1_INTEGER, 1)
54 } ASN1_SEQUENCE_END(GENERAL_SUBTREE)
55
56 ASN1_SEQUENCE(NAME_CONSTRAINTS) = {
57         ASN1_IMP_SEQUENCE_OF_OPT(NAME_CONSTRAINTS, permittedSubtrees,
58                                                         GENERAL_SUBTREE, 0),
59         ASN1_IMP_SEQUENCE_OF_OPT(NAME_CONSTRAINTS, excludedSubtrees,
60                                                         GENERAL_SUBTREE, 1),
61 } ASN1_SEQUENCE_END(NAME_CONSTRAINTS)
62
63
64 IMPLEMENT_ASN1_ALLOC_FUNCTIONS(GENERAL_SUBTREE)
65 IMPLEMENT_ASN1_ALLOC_FUNCTIONS(NAME_CONSTRAINTS)
66
67 static void *v2i_NAME_CONSTRAINTS(const X509V3_EXT_METHOD *method,
68                                   X509V3_CTX *ctx, STACK_OF(CONF_VALUE) *nval)
69 {
70     int i;
71     CONF_VALUE tval, *val;
72     STACK_OF(GENERAL_SUBTREE) **ptree = NULL;
73     NAME_CONSTRAINTS *ncons = NULL;
74     GENERAL_SUBTREE *sub = NULL;
75
76     ncons = NAME_CONSTRAINTS_new();
77     if (ncons == NULL)
78         goto memerr;
79     for (i = 0; i < sk_CONF_VALUE_num(nval); i++) {
80         val = sk_CONF_VALUE_value(nval, i);
81         if (strncmp(val->name, "permitted", 9) == 0 && val->name[9]) {
82             ptree = &ncons->permittedSubtrees;
83             tval.name = val->name + 10;
84         } else if (strncmp(val->name, "excluded", 8) == 0 && val->name[8]) {
85             ptree = &ncons->excludedSubtrees;
86             tval.name = val->name + 9;
87         } else {
88             X509V3err(X509V3_F_V2I_NAME_CONSTRAINTS, X509V3_R_INVALID_SYNTAX);
89             goto err;
90         }
91         tval.value = val->value;
92         sub = GENERAL_SUBTREE_new();
93         if (sub == NULL)
94             goto memerr;
95         if (!v2i_GENERAL_NAME_ex(sub->base, method, ctx, &tval, 1))
96             goto err;
97         if (*ptree == NULL)
98             *ptree = sk_GENERAL_SUBTREE_new_null();
99         if (*ptree == NULL || !sk_GENERAL_SUBTREE_push(*ptree, sub))
100             goto memerr;
101         sub = NULL;
102     }
103
104     return ncons;
105
106  memerr:
107     X509V3err(X509V3_F_V2I_NAME_CONSTRAINTS, ERR_R_MALLOC_FAILURE);
108  err:
109     NAME_CONSTRAINTS_free(ncons);
110     GENERAL_SUBTREE_free(sub);
111
112     return NULL;
113 }
114
115 static int i2r_NAME_CONSTRAINTS(const X509V3_EXT_METHOD *method, void *a,
116                                 BIO *bp, int ind)
117 {
118     NAME_CONSTRAINTS *ncons = a;
119     do_i2r_name_constraints(method, ncons->permittedSubtrees,
120                             bp, ind, "Permitted");
121     do_i2r_name_constraints(method, ncons->excludedSubtrees,
122                             bp, ind, "Excluded");
123     return 1;
124 }
125
126 static int do_i2r_name_constraints(const X509V3_EXT_METHOD *method,
127                                    STACK_OF(GENERAL_SUBTREE) *trees,
128                                    BIO *bp, int ind, const char *name)
129 {
130     GENERAL_SUBTREE *tree;
131     int i;
132     if (sk_GENERAL_SUBTREE_num(trees) > 0)
133         BIO_printf(bp, "%*s%s:\n", ind, "", name);
134     for (i = 0; i < sk_GENERAL_SUBTREE_num(trees); i++) {
135         tree = sk_GENERAL_SUBTREE_value(trees, i);
136         BIO_printf(bp, "%*s", ind + 2, "");
137         if (tree->base->type == GEN_IPADD)
138             print_nc_ipadd(bp, tree->base->d.ip);
139         else
140             GENERAL_NAME_print(bp, tree->base);
141         BIO_puts(bp, "\n");
142     }
143     return 1;
144 }
145
146 static int print_nc_ipadd(BIO *bp, ASN1_OCTET_STRING *ip)
147 {
148     int i, len;
149     unsigned char *p;
150     p = ip->data;
151     len = ip->length;
152     BIO_puts(bp, "IP:");
153     if (len == 8) {
154         BIO_printf(bp, "%d.%d.%d.%d/%d.%d.%d.%d",
155                    p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7]);
156     } else if (len == 32) {
157         for (i = 0; i < 16; i++) {
158             BIO_printf(bp, "%X", p[0] << 8 | p[1]);
159             p += 2;
160             if (i == 7)
161                 BIO_puts(bp, "/");
162             else if (i != 15)
163                 BIO_puts(bp, ":");
164         }
165     } else
166         BIO_printf(bp, "IP Address:<invalid>");
167     return 1;
168 }
169
170 #define NAME_CHECK_MAX (1 << 20)
171
172 static int add_lengths(int *out, int a, int b)
173 {
174     /* sk_FOO_num(NULL) returns -1 but is effectively 0 when iterating. */
175     if (a < 0)
176         a = 0;
177     if (b < 0)
178         b = 0;
179
180     if (a > INT_MAX - b)
181         return 0;
182     *out = a + b;
183     return 1;
184 }
185
186 /*-
187  * Check a certificate conforms to a specified set of constraints.
188  * Return values:
189  *  X509_V_OK: All constraints obeyed.
190  *  X509_V_ERR_PERMITTED_VIOLATION: Permitted subtree violation.
191  *  X509_V_ERR_EXCLUDED_VIOLATION: Excluded subtree violation.
192  *  X509_V_ERR_SUBTREE_MINMAX: Min or max values present and matching type.
193  *  X509_V_ERR_UNSUPPORTED_CONSTRAINT_TYPE:  Unsupported constraint type.
194  *  X509_V_ERR_UNSUPPORTED_CONSTRAINT_SYNTAX: bad unsupported constraint syntax.
195  *  X509_V_ERR_UNSUPPORTED_NAME_SYNTAX: bad or unsupported syntax of name
196  */
197
198 int NAME_CONSTRAINTS_check(X509 *x, NAME_CONSTRAINTS *nc)
199 {
200     int r, i, name_count, constraint_count;
201     X509_NAME *nm;
202
203     nm = X509_get_subject_name(x);
204
205     /*
206      * Guard against certificates with an excessive number of names or
207      * constraints causing a computationally expensive name constraints check.
208      */
209     if (!add_lengths(&name_count, X509_NAME_entry_count(nm),
210                      sk_GENERAL_NAME_num(x->altname))
211         || !add_lengths(&constraint_count,
212                         sk_GENERAL_SUBTREE_num(nc->permittedSubtrees),
213                         sk_GENERAL_SUBTREE_num(nc->excludedSubtrees))
214         || (name_count > 0 && constraint_count > NAME_CHECK_MAX / name_count))
215         return X509_V_ERR_UNSPECIFIED;
216
217     if (X509_NAME_entry_count(nm) > 0) {
218         GENERAL_NAME gntmp;
219         gntmp.type = GEN_DIRNAME;
220         gntmp.d.directoryName = nm;
221
222         r = nc_match(&gntmp, nc);
223
224         if (r != X509_V_OK)
225             return r;
226
227         gntmp.type = GEN_EMAIL;
228
229         /* Process any email address attributes in subject name */
230
231         for (i = -1;;) {
232             const X509_NAME_ENTRY *ne;
233
234             i = X509_NAME_get_index_by_NID(nm, NID_pkcs9_emailAddress, i);
235             if (i == -1)
236                 break;
237             ne = X509_NAME_get_entry(nm, i);
238             gntmp.d.rfc822Name = X509_NAME_ENTRY_get_data(ne);
239             if (gntmp.d.rfc822Name->type != V_ASN1_IA5STRING)
240                 return X509_V_ERR_UNSUPPORTED_NAME_SYNTAX;
241
242             r = nc_match(&gntmp, nc);
243
244             if (r != X509_V_OK)
245                 return r;
246         }
247
248     }
249
250     for (i = 0; i < sk_GENERAL_NAME_num(x->altname); i++) {
251         GENERAL_NAME *gen = sk_GENERAL_NAME_value(x->altname, i);
252         r = nc_match(gen, nc);
253         if (r != X509_V_OK)
254             return r;
255     }
256
257     return X509_V_OK;
258
259 }
260
261 int NAME_CONSTRAINTS_check_CN(X509 *x, NAME_CONSTRAINTS *nc)
262 {
263     int r, i;
264     X509_NAME *nm;
265
266     ASN1_STRING stmp;
267     GENERAL_NAME gntmp;
268     stmp.flags = 0;
269     stmp.type = V_ASN1_IA5STRING;
270     gntmp.type = GEN_DNS;
271     gntmp.d.dNSName = &stmp;
272
273     nm = X509_get_subject_name(x);
274
275     /* Process any commonName attributes in subject name */
276
277     for (i = -1;;) {
278         X509_NAME_ENTRY *ne;
279         ASN1_STRING *hn;
280
281         i = X509_NAME_get_index_by_NID(nm, NID_commonName, i);
282         if (i == -1)
283             break;
284         ne = X509_NAME_get_entry(nm, i);
285         hn = X509_NAME_ENTRY_get_data(ne);
286         /* Only process attributes that look like host names */
287         if (asn1_valid_host(hn)) {
288             unsigned char *h;
289             int hlen = ASN1_STRING_to_UTF8(&h, hn);
290             if (hlen <= 0)
291                 return X509_V_ERR_OUT_OF_MEM;
292
293             stmp.length = hlen;
294             stmp.data = h;
295
296             r = nc_match(&gntmp, nc);
297
298             OPENSSL_free(h);
299
300             if (r != X509_V_OK)
301                     return r;
302         }
303     }
304     return X509_V_OK;
305 }
306
307 static int nc_match(GENERAL_NAME *gen, NAME_CONSTRAINTS *nc)
308 {
309     GENERAL_SUBTREE *sub;
310     int i, r, match = 0;
311
312     /*
313      * Permitted subtrees: if any subtrees exist of matching the type at
314      * least one subtree must match.
315      */
316
317     for (i = 0; i < sk_GENERAL_SUBTREE_num(nc->permittedSubtrees); i++) {
318         sub = sk_GENERAL_SUBTREE_value(nc->permittedSubtrees, i);
319         if (gen->type != sub->base->type)
320             continue;
321         if (sub->minimum || sub->maximum)
322             return X509_V_ERR_SUBTREE_MINMAX;
323         /* If we already have a match don't bother trying any more */
324         if (match == 2)
325             continue;
326         if (match == 0)
327             match = 1;
328         r = nc_match_single(gen, sub->base);
329         if (r == X509_V_OK)
330             match = 2;
331         else if (r != X509_V_ERR_PERMITTED_VIOLATION)
332             return r;
333     }
334
335     if (match == 1)
336         return X509_V_ERR_PERMITTED_VIOLATION;
337
338     /* Excluded subtrees: must not match any of these */
339
340     for (i = 0; i < sk_GENERAL_SUBTREE_num(nc->excludedSubtrees); i++) {
341         sub = sk_GENERAL_SUBTREE_value(nc->excludedSubtrees, i);
342         if (gen->type != sub->base->type)
343             continue;
344         if (sub->minimum || sub->maximum)
345             return X509_V_ERR_SUBTREE_MINMAX;
346
347         r = nc_match_single(gen, sub->base);
348         if (r == X509_V_OK)
349             return X509_V_ERR_EXCLUDED_VIOLATION;
350         else if (r != X509_V_ERR_PERMITTED_VIOLATION)
351             return r;
352
353     }
354
355     return X509_V_OK;
356
357 }
358
359 static int nc_match_single(GENERAL_NAME *gen, GENERAL_NAME *base)
360 {
361     switch (base->type) {
362     case GEN_DIRNAME:
363         return nc_dn(gen->d.directoryName, base->d.directoryName);
364
365     case GEN_DNS:
366         return nc_dns(gen->d.dNSName, base->d.dNSName);
367
368     case GEN_EMAIL:
369         return nc_email(gen->d.rfc822Name, base->d.rfc822Name);
370
371     case GEN_URI:
372         return nc_uri(gen->d.uniformResourceIdentifier,
373                       base->d.uniformResourceIdentifier);
374
375     case GEN_IPADD:
376         return nc_ip(gen->d.iPAddress, base->d.iPAddress);
377
378     default:
379         return X509_V_ERR_UNSUPPORTED_CONSTRAINT_TYPE;
380     }
381
382 }
383
384 /*
385  * directoryName name constraint matching. The canonical encoding of
386  * X509_NAME makes this comparison easy. It is matched if the subtree is a
387  * subset of the name.
388  */
389
390 static int nc_dn(X509_NAME *nm, X509_NAME *base)
391 {
392     /* Ensure canonical encodings are up to date.  */
393     if (nm->modified && i2d_X509_NAME(nm, NULL) < 0)
394         return X509_V_ERR_OUT_OF_MEM;
395     if (base->modified && i2d_X509_NAME(base, NULL) < 0)
396         return X509_V_ERR_OUT_OF_MEM;
397     if (base->canon_enclen > nm->canon_enclen)
398         return X509_V_ERR_PERMITTED_VIOLATION;
399     if (memcmp(base->canon_enc, nm->canon_enc, base->canon_enclen))
400         return X509_V_ERR_PERMITTED_VIOLATION;
401     return X509_V_OK;
402 }
403
404 static int nc_dns(ASN1_IA5STRING *dns, ASN1_IA5STRING *base)
405 {
406     char *baseptr = (char *)base->data;
407     char *dnsptr = (char *)dns->data;
408     /* Empty matches everything */
409     if (!*baseptr)
410         return X509_V_OK;
411     /*
412      * Otherwise can add zero or more components on the left so compare RHS
413      * and if dns is longer and expect '.' as preceding character.
414      */
415     if (dns->length > base->length) {
416         dnsptr += dns->length - base->length;
417         if (*baseptr != '.' && dnsptr[-1] != '.')
418             return X509_V_ERR_PERMITTED_VIOLATION;
419     }
420
421     if (strcasecmp(baseptr, dnsptr))
422         return X509_V_ERR_PERMITTED_VIOLATION;
423
424     return X509_V_OK;
425
426 }
427
428 static int nc_email(ASN1_IA5STRING *eml, ASN1_IA5STRING *base)
429 {
430     const char *baseptr = (char *)base->data;
431     const char *emlptr = (char *)eml->data;
432
433     const char *baseat = strchr(baseptr, '@');
434     const char *emlat = strchr(emlptr, '@');
435     if (!emlat)
436         return X509_V_ERR_UNSUPPORTED_NAME_SYNTAX;
437     /* Special case: initial '.' is RHS match */
438     if (!baseat && (*baseptr == '.')) {
439         if (eml->length > base->length) {
440             emlptr += eml->length - base->length;
441             if (strcasecmp(baseptr, emlptr) == 0)
442                 return X509_V_OK;
443         }
444         return X509_V_ERR_PERMITTED_VIOLATION;
445     }
446
447     /* If we have anything before '@' match local part */
448
449     if (baseat) {
450         if (baseat != baseptr) {
451             if ((baseat - baseptr) != (emlat - emlptr))
452                 return X509_V_ERR_PERMITTED_VIOLATION;
453             /* Case sensitive match of local part */
454             if (strncmp(baseptr, emlptr, emlat - emlptr))
455                 return X509_V_ERR_PERMITTED_VIOLATION;
456         }
457         /* Position base after '@' */
458         baseptr = baseat + 1;
459     }
460     emlptr = emlat + 1;
461     /* Just have hostname left to match: case insensitive */
462     if (strcasecmp(baseptr, emlptr))
463         return X509_V_ERR_PERMITTED_VIOLATION;
464
465     return X509_V_OK;
466
467 }
468
469 static int nc_uri(ASN1_IA5STRING *uri, ASN1_IA5STRING *base)
470 {
471     const char *baseptr = (char *)base->data;
472     const char *hostptr = (char *)uri->data;
473     const char *p = strchr(hostptr, ':');
474     int hostlen;
475     /* Check for foo:// and skip past it */
476     if (!p || (p[1] != '/') || (p[2] != '/'))
477         return X509_V_ERR_UNSUPPORTED_NAME_SYNTAX;
478     hostptr = p + 3;
479
480     /* Determine length of hostname part of URI */
481
482     /* Look for a port indicator as end of hostname first */
483
484     p = strchr(hostptr, ':');
485     /* Otherwise look for trailing slash */
486     if (!p)
487         p = strchr(hostptr, '/');
488
489     if (!p)
490         hostlen = strlen(hostptr);
491     else
492         hostlen = p - hostptr;
493
494     if (hostlen == 0)
495         return X509_V_ERR_UNSUPPORTED_NAME_SYNTAX;
496
497     /* Special case: initial '.' is RHS match */
498     if (*baseptr == '.') {
499         if (hostlen > base->length) {
500             p = hostptr + hostlen - base->length;
501             if (strncasecmp(p, baseptr, base->length) == 0)
502                 return X509_V_OK;
503         }
504         return X509_V_ERR_PERMITTED_VIOLATION;
505     }
506
507     if ((base->length != (int)hostlen)
508         || strncasecmp(hostptr, baseptr, hostlen))
509         return X509_V_ERR_PERMITTED_VIOLATION;
510
511     return X509_V_OK;
512
513 }
514
515 static int nc_ip(ASN1_OCTET_STRING *ip, ASN1_OCTET_STRING *base)
516 {
517     int hostlen, baselen, i;
518     unsigned char *hostptr, *baseptr, *maskptr;
519     hostptr = ip->data;
520     hostlen = ip->length;
521     baseptr = base->data;
522     baselen = base->length;
523
524     /* Invalid if not IPv4 or IPv6 */
525     if (!((hostlen == 4) || (hostlen == 16)))
526         return X509_V_ERR_UNSUPPORTED_NAME_SYNTAX;
527     if (!((baselen == 8) || (baselen == 32)))
528         return X509_V_ERR_UNSUPPORTED_NAME_SYNTAX;
529
530     /* Do not match IPv4 with IPv6 */
531     if (hostlen * 2 != baselen)
532         return X509_V_ERR_PERMITTED_VIOLATION;
533
534     maskptr = base->data + hostlen;
535
536     /* Considering possible not aligned base ipAddress */
537     /* Not checking for wrong mask definition: i.e.: 255.0.255.0 */
538     for (i = 0; i < hostlen; i++)
539         if ((hostptr[i] & maskptr[i]) != (baseptr[i] & maskptr[i]))
540             return X509_V_ERR_PERMITTED_VIOLATION;
541
542     return X509_V_OK;
543
544 }