Better handling of verify param id peername field
[openssl.git] / crypto / x509 / x509_vpm.c
1 /* x509_vpm.c */
2 /*
3  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
4  * 2004.
5  */
6 /* ====================================================================
7  * Copyright (c) 2004 The OpenSSL Project.  All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  *
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
19  *    distribution.
20  *
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/)"
25  *
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.
30  *
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.
34  *
35  * 6. Redistributions of any form whatsoever must retain the following
36  *    acknowledgment:
37  *    "This product includes software developed by the OpenSSL Project
38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39  *
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  * ====================================================================
53  *
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).
57  *
58  */
59
60 #include <stdio.h>
61
62 #include "internal/cryptlib.h"
63 #include <openssl/crypto.h>
64 #include <openssl/lhash.h>
65 #include <openssl/buffer.h>
66 #include <openssl/x509.h>
67 #include <openssl/x509v3.h>
68
69 #include "x509_lcl.h"
70
71 /* X509_VERIFY_PARAM functions */
72
73 #define SET_HOST 0
74 #define ADD_HOST 1
75
76 static char *str_copy(const char *s)
77 {
78     return OPENSSL_strdup(s);
79 }
80
81 static void str_free(char *s)
82 {
83     OPENSSL_free(s);
84 }
85
86 static int int_x509_param_set_hosts(X509_VERIFY_PARAM_ID *id, int mode,
87                                     const char *name, size_t namelen)
88 {
89     char *copy;
90
91     /*
92      * Refuse names with embedded NUL bytes, except perhaps as final byte.
93      * XXX: Do we need to push an error onto the error stack?
94      */
95     if (namelen == 0)
96         namelen = name ? strlen(name) : 0;
97     else if (name && memchr(name, '\0', namelen > 1 ? namelen - 1 : namelen))
98         return 0;
99     if (name && name[namelen - 1] == '\0')
100         --namelen;
101
102     if (mode == SET_HOST) {
103         sk_OPENSSL_STRING_pop_free(id->hosts, str_free);
104         id->hosts = NULL;
105     }
106     if (name == NULL || namelen == 0)
107         return 1;
108
109     copy = BUF_strndup(name, namelen);
110     if (copy == NULL)
111         return 0;
112
113     if (id->hosts == NULL &&
114         (id->hosts = sk_OPENSSL_STRING_new_null()) == NULL) {
115         OPENSSL_free(copy);
116         return 0;
117     }
118
119     if (!sk_OPENSSL_STRING_push(id->hosts, copy)) {
120         OPENSSL_free(copy);
121         if (sk_OPENSSL_STRING_num(id->hosts) == 0) {
122             sk_OPENSSL_STRING_free(id->hosts);
123             id->hosts = NULL;
124         }
125         return 0;
126     }
127
128     return 1;
129 }
130
131 static void x509_verify_param_zero(X509_VERIFY_PARAM *param)
132 {
133     X509_VERIFY_PARAM_ID *paramid;
134     if (!param)
135         return;
136     param->name = NULL;
137     param->purpose = 0;
138     param->trust = 0;
139     /*
140      * param->inh_flags = X509_VP_FLAG_DEFAULT;
141      */
142     param->inh_flags = 0;
143     param->flags = 0;
144     param->depth = -1;
145     sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
146     param->policies = NULL;
147     paramid = param->id;
148     sk_OPENSSL_STRING_pop_free(paramid->hosts, str_free);
149     paramid->hosts = NULL;
150     OPENSSL_free(paramid->peername);
151     paramid->peername = NULL;
152     OPENSSL_free(paramid->email);
153     paramid->email = NULL;
154     paramid->emaillen = 0;
155     OPENSSL_free(paramid->ip);
156     paramid->ip = NULL;
157     paramid->iplen = 0;
158 }
159
160 X509_VERIFY_PARAM *X509_VERIFY_PARAM_new(void)
161 {
162     X509_VERIFY_PARAM *param;
163     X509_VERIFY_PARAM_ID *paramid;
164
165     param = OPENSSL_malloc(sizeof(*param));
166     if (!param)
167         return NULL;
168     memset(param, 0, sizeof(*param));
169
170     paramid = OPENSSL_malloc(sizeof(*paramid));
171     if (!paramid) {
172         OPENSSL_free(param);
173         return NULL;
174     }
175     memset(paramid, 0, sizeof(*paramid));
176     /* Exotic platforms may have non-zero bit representation of NULL */
177     paramid->hosts = NULL;
178     paramid->peername = NULL;
179     paramid->email = NULL;
180     paramid->ip = NULL;
181
182     param->id = paramid;
183     x509_verify_param_zero(param);
184     return param;
185 }
186
187 void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM *param)
188 {
189     if (!param)
190         return;
191     x509_verify_param_zero(param);
192     OPENSSL_free(param->id);
193     OPENSSL_free(param);
194 }
195
196 /*-
197  * This function determines how parameters are "inherited" from one structure
198  * to another. There are several different ways this can happen.
199  *
200  * 1. If a child structure needs to have its values initialized from a parent
201  *    they are simply copied across. For example SSL_CTX copied to SSL.
202  * 2. If the structure should take on values only if they are currently unset.
203  *    For example the values in an SSL structure will take appropriate value
204  *    for SSL servers or clients but only if the application has not set new
205  *    ones.
206  *
207  * The "inh_flags" field determines how this function behaves.
208  *
209  * Normally any values which are set in the default are not copied from the
210  * destination and verify flags are ORed together.
211  *
212  * If X509_VP_FLAG_DEFAULT is set then anything set in the source is copied
213  * to the destination. Effectively the values in "to" become default values
214  * which will be used only if nothing new is set in "from".
215  *
216  * If X509_VP_FLAG_OVERWRITE is set then all value are copied across whether
217  * they are set or not. Flags is still Ored though.
218  *
219  * If X509_VP_FLAG_RESET_FLAGS is set then the flags value is copied instead
220  * of ORed.
221  *
222  * If X509_VP_FLAG_LOCKED is set then no values are copied.
223  *
224  * If X509_VP_FLAG_ONCE is set then the current inh_flags setting is zeroed
225  * after the next call.
226  */
227
228 /* Macro to test if a field should be copied from src to dest */
229
230 #define test_x509_verify_param_copy(field, def) \
231         (to_overwrite || \
232                 ((src->field != def) && (to_default || (dest->field == def))))
233
234 /* As above but for ID fields */
235
236 #define test_x509_verify_param_copy_id(idf, def) \
237         test_x509_verify_param_copy(id->idf, def)
238
239 /* Macro to test and copy a field if necessary */
240
241 #define x509_verify_param_copy(field, def) \
242         if (test_x509_verify_param_copy(field, def)) \
243                 dest->field = src->field
244
245 int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM *dest,
246                               const X509_VERIFY_PARAM *src)
247 {
248     unsigned long inh_flags;
249     int to_default, to_overwrite;
250     X509_VERIFY_PARAM_ID *id;
251     if (!src)
252         return 1;
253     id = src->id;
254     inh_flags = dest->inh_flags | src->inh_flags;
255
256     if (inh_flags & X509_VP_FLAG_ONCE)
257         dest->inh_flags = 0;
258
259     if (inh_flags & X509_VP_FLAG_LOCKED)
260         return 1;
261
262     if (inh_flags & X509_VP_FLAG_DEFAULT)
263         to_default = 1;
264     else
265         to_default = 0;
266
267     if (inh_flags & X509_VP_FLAG_OVERWRITE)
268         to_overwrite = 1;
269     else
270         to_overwrite = 0;
271
272     x509_verify_param_copy(purpose, 0);
273     x509_verify_param_copy(trust, 0);
274     x509_verify_param_copy(depth, -1);
275
276     /* If overwrite or check time not set, copy across */
277
278     if (to_overwrite || !(dest->flags & X509_V_FLAG_USE_CHECK_TIME)) {
279         dest->check_time = src->check_time;
280         dest->flags &= ~X509_V_FLAG_USE_CHECK_TIME;
281         /* Don't need to copy flag: that is done below */
282     }
283
284     if (inh_flags & X509_VP_FLAG_RESET_FLAGS)
285         dest->flags = 0;
286
287     dest->flags |= src->flags;
288
289     if (test_x509_verify_param_copy(policies, NULL)) {
290         if (!X509_VERIFY_PARAM_set1_policies(dest, src->policies))
291             return 0;
292     }
293
294     /* Copy the host flags if and only if we're copying the host list */
295     if (test_x509_verify_param_copy_id(hosts, NULL)) {
296         sk_OPENSSL_STRING_pop_free(dest->id->hosts, str_free);
297         dest->id->hosts = NULL;
298         if (id->hosts) {
299             dest->id->hosts =
300                 sk_OPENSSL_STRING_deep_copy(id->hosts, str_copy, str_free);
301             if (dest->id->hosts == NULL)
302                 return 0;
303             dest->id->hostflags = id->hostflags;
304         }
305     }
306
307     if (test_x509_verify_param_copy_id(email, NULL)) {
308         if (!X509_VERIFY_PARAM_set1_email(dest, id->email, id->emaillen))
309             return 0;
310     }
311
312     if (test_x509_verify_param_copy_id(ip, NULL)) {
313         if (!X509_VERIFY_PARAM_set1_ip(dest, id->ip, id->iplen))
314             return 0;
315     }
316
317     return 1;
318 }
319
320 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to,
321                            const X509_VERIFY_PARAM *from)
322 {
323     unsigned long save_flags = to->inh_flags;
324     int ret;
325     to->inh_flags |= X509_VP_FLAG_DEFAULT;
326     ret = X509_VERIFY_PARAM_inherit(to, from);
327     to->inh_flags = save_flags;
328     return ret;
329 }
330
331 static int int_x509_param_set1(char **pdest, size_t *pdestlen,
332                                const char *src, size_t srclen)
333 {
334     void *tmp;
335     if (src) {
336         if (srclen == 0) {
337             tmp = BUF_strdup(src);
338             srclen = strlen(src);
339         } else
340             tmp = BUF_memdup(src, srclen);
341         if (!tmp)
342             return 0;
343     } else {
344         tmp = NULL;
345         srclen = 0;
346     }
347     OPENSSL_free(*pdest);
348     *pdest = tmp;
349     if (pdestlen)
350         *pdestlen = srclen;
351     return 1;
352 }
353
354 int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name)
355 {
356     OPENSSL_free(param->name);
357     param->name = BUF_strdup(name);
358     if (param->name)
359         return 1;
360     return 0;
361 }
362
363 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags)
364 {
365     param->flags |= flags;
366     if (flags & X509_V_FLAG_POLICY_MASK)
367         param->flags |= X509_V_FLAG_POLICY_CHECK;
368     return 1;
369 }
370
371 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param,
372                                   unsigned long flags)
373 {
374     param->flags &= ~flags;
375     return 1;
376 }
377
378 unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM *param)
379 {
380     return param->flags;
381 }
382
383 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose)
384 {
385     return X509_PURPOSE_set(&param->purpose, purpose);
386 }
387
388 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust)
389 {
390     return X509_TRUST_set(&param->trust, trust);
391 }
392
393 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth)
394 {
395     param->depth = depth;
396 }
397
398 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t)
399 {
400     param->check_time = t;
401     param->flags |= X509_V_FLAG_USE_CHECK_TIME;
402 }
403
404 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param,
405                                   ASN1_OBJECT *policy)
406 {
407     if (!param->policies) {
408         param->policies = sk_ASN1_OBJECT_new_null();
409         if (!param->policies)
410             return 0;
411     }
412     if (!sk_ASN1_OBJECT_push(param->policies, policy))
413         return 0;
414     return 1;
415 }
416
417 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
418                                     STACK_OF(ASN1_OBJECT) *policies)
419 {
420     int i;
421     ASN1_OBJECT *oid, *doid;
422
423     if (!param)
424         return 0;
425     sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
426
427     if (!policies) {
428         param->policies = NULL;
429         return 1;
430     }
431
432     param->policies = sk_ASN1_OBJECT_new_null();
433     if (!param->policies)
434         return 0;
435
436     for (i = 0; i < sk_ASN1_OBJECT_num(policies); i++) {
437         oid = sk_ASN1_OBJECT_value(policies, i);
438         doid = OBJ_dup(oid);
439         if (!doid)
440             return 0;
441         if (!sk_ASN1_OBJECT_push(param->policies, doid)) {
442             ASN1_OBJECT_free(doid);
443             return 0;
444         }
445     }
446     param->flags |= X509_V_FLAG_POLICY_CHECK;
447     return 1;
448 }
449
450 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
451                                 const char *name, size_t namelen)
452 {
453     return int_x509_param_set_hosts(param->id, SET_HOST, name, namelen);
454 }
455
456 int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param,
457                                 const char *name, size_t namelen)
458 {
459     return int_x509_param_set_hosts(param->id, ADD_HOST, name, namelen);
460 }
461
462 void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
463                                      unsigned int flags)
464 {
465     param->id->hostflags = flags;
466 }
467
468 char *X509_VERIFY_PARAM_get0_peername(X509_VERIFY_PARAM *param)
469 {
470     return param->id->peername;
471 }
472
473 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
474                                  const char *email, size_t emaillen)
475 {
476     return int_x509_param_set1(&param->id->email, &param->id->emaillen,
477                                email, emaillen);
478 }
479
480 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
481                               const unsigned char *ip, size_t iplen)
482 {
483     if (iplen != 0 && iplen != 4 && iplen != 16)
484         return 0;
485     return int_x509_param_set1((char **)&param->id->ip, &param->id->iplen,
486                                (char *)ip, iplen);
487 }
488
489 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param, const char *ipasc)
490 {
491     unsigned char ipout[16];
492     size_t iplen;
493
494     iplen = (size_t)a2i_ipadd(ipout, ipasc);
495     if (iplen == 0)
496         return 0;
497     return X509_VERIFY_PARAM_set1_ip(param, ipout, iplen);
498 }
499
500 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param)
501 {
502     return param->depth;
503 }
504
505 const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM *param)
506 {
507     return param->name;
508 }
509
510 static X509_VERIFY_PARAM_ID _empty_id = { NULL, 0U, NULL, NULL, 0, NULL, 0 };
511
512 #define vpm_empty_id (X509_VERIFY_PARAM_ID *)&_empty_id
513
514 /*
515  * Default verify parameters: these are used for various applications and can
516  * be overridden by the user specified table. NB: the 'name' field *must* be
517  * in alphabetical order because it will be searched using OBJ_search.
518  */
519
520 static const X509_VERIFY_PARAM default_table[] = {
521     {
522      "default",                 /* X509 default parameters */
523      0,                         /* Check time */
524      0,                         /* internal flags */
525      0,                         /* flags */
526      0,                         /* purpose */
527      0,                         /* trust */
528      100,                       /* depth */
529      NULL,                      /* policies */
530      vpm_empty_id},
531     {
532      "pkcs7",                   /* S/MIME sign parameters */
533      0,                         /* Check time */
534      0,                         /* internal flags */
535      0,                         /* flags */
536      X509_PURPOSE_SMIME_SIGN,   /* purpose */
537      X509_TRUST_EMAIL,          /* trust */
538      -1,                        /* depth */
539      NULL,                      /* policies */
540      vpm_empty_id},
541     {
542      "smime_sign",              /* S/MIME sign parameters */
543      0,                         /* Check time */
544      0,                         /* internal flags */
545      0,                         /* flags */
546      X509_PURPOSE_SMIME_SIGN,   /* purpose */
547      X509_TRUST_EMAIL,          /* trust */
548      -1,                        /* depth */
549      NULL,                      /* policies */
550      vpm_empty_id},
551     {
552      "ssl_client",              /* SSL/TLS client parameters */
553      0,                         /* Check time */
554      0,                         /* internal flags */
555      0,                         /* flags */
556      X509_PURPOSE_SSL_CLIENT,   /* purpose */
557      X509_TRUST_SSL_CLIENT,     /* trust */
558      -1,                        /* depth */
559      NULL,                      /* policies */
560      vpm_empty_id},
561     {
562      "ssl_server",              /* SSL/TLS server parameters */
563      0,                         /* Check time */
564      0,                         /* internal flags */
565      0,                         /* flags */
566      X509_PURPOSE_SSL_SERVER,   /* purpose */
567      X509_TRUST_SSL_SERVER,     /* trust */
568      -1,                        /* depth */
569      NULL,                      /* policies */
570      vpm_empty_id}
571 };
572
573 static STACK_OF(X509_VERIFY_PARAM) *param_table = NULL;
574
575 static int table_cmp(const X509_VERIFY_PARAM *a, const X509_VERIFY_PARAM *b)
576 {
577     return strcmp(a->name, b->name);
578 }
579
580 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
581 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
582
583 static int param_cmp(const X509_VERIFY_PARAM *const *a,
584                      const X509_VERIFY_PARAM *const *b)
585 {
586     return strcmp((*a)->name, (*b)->name);
587 }
588
589 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param)
590 {
591     int idx;
592     X509_VERIFY_PARAM *ptmp;
593     if (!param_table) {
594         param_table = sk_X509_VERIFY_PARAM_new(param_cmp);
595         if (!param_table)
596             return 0;
597     } else {
598         idx = sk_X509_VERIFY_PARAM_find(param_table, param);
599         if (idx != -1) {
600             ptmp = sk_X509_VERIFY_PARAM_value(param_table, idx);
601             X509_VERIFY_PARAM_free(ptmp);
602             (void)sk_X509_VERIFY_PARAM_delete(param_table, idx);
603         }
604     }
605     if (!sk_X509_VERIFY_PARAM_push(param_table, param))
606         return 0;
607     return 1;
608 }
609
610 int X509_VERIFY_PARAM_get_count(void)
611 {
612     int num = OSSL_NELEM(default_table);
613     if (param_table)
614         num += sk_X509_VERIFY_PARAM_num(param_table);
615     return num;
616 }
617
618 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_get0(int id)
619 {
620     int num = OSSL_NELEM(default_table);
621     if (id < num)
622         return default_table + id;
623     return sk_X509_VERIFY_PARAM_value(param_table, id - num);
624 }
625
626 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name)
627 {
628     int idx;
629     X509_VERIFY_PARAM pm;
630
631     pm.name = (char *)name;
632     if (param_table) {
633         idx = sk_X509_VERIFY_PARAM_find(param_table, &pm);
634         if (idx != -1)
635             return sk_X509_VERIFY_PARAM_value(param_table, idx);
636     }
637     return OBJ_bsearch_table(&pm, default_table, OSSL_NELEM(default_table));
638 }
639
640 void X509_VERIFY_PARAM_table_cleanup(void)
641 {
642     sk_X509_VERIFY_PARAM_pop_free(param_table, X509_VERIFY_PARAM_free);
643     param_table = NULL;
644 }