Add and use OPENSSL_zalloc
[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_zalloc(sizeof(*param));
166     if (!param)
167         return NULL;
168     param->id = paramid = OPENSSL_zalloc(sizeof(*paramid));
169     if (!paramid) {
170         OPENSSL_free(param);
171         return NULL;
172     }
173     x509_verify_param_zero(param);
174     return param;
175 }
176
177 void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM *param)
178 {
179     if (!param)
180         return;
181     x509_verify_param_zero(param);
182     OPENSSL_free(param->id);
183     OPENSSL_free(param);
184 }
185
186 /*-
187  * This function determines how parameters are "inherited" from one structure
188  * to another. There are several different ways this can happen.
189  *
190  * 1. If a child structure needs to have its values initialized from a parent
191  *    they are simply copied across. For example SSL_CTX copied to SSL.
192  * 2. If the structure should take on values only if they are currently unset.
193  *    For example the values in an SSL structure will take appropriate value
194  *    for SSL servers or clients but only if the application has not set new
195  *    ones.
196  *
197  * The "inh_flags" field determines how this function behaves.
198  *
199  * Normally any values which are set in the default are not copied from the
200  * destination and verify flags are ORed together.
201  *
202  * If X509_VP_FLAG_DEFAULT is set then anything set in the source is copied
203  * to the destination. Effectively the values in "to" become default values
204  * which will be used only if nothing new is set in "from".
205  *
206  * If X509_VP_FLAG_OVERWRITE is set then all value are copied across whether
207  * they are set or not. Flags is still Ored though.
208  *
209  * If X509_VP_FLAG_RESET_FLAGS is set then the flags value is copied instead
210  * of ORed.
211  *
212  * If X509_VP_FLAG_LOCKED is set then no values are copied.
213  *
214  * If X509_VP_FLAG_ONCE is set then the current inh_flags setting is zeroed
215  * after the next call.
216  */
217
218 /* Macro to test if a field should be copied from src to dest */
219
220 #define test_x509_verify_param_copy(field, def) \
221         (to_overwrite || \
222                 ((src->field != def) && (to_default || (dest->field == def))))
223
224 /* As above but for ID fields */
225
226 #define test_x509_verify_param_copy_id(idf, def) \
227         test_x509_verify_param_copy(id->idf, def)
228
229 /* Macro to test and copy a field if necessary */
230
231 #define x509_verify_param_copy(field, def) \
232         if (test_x509_verify_param_copy(field, def)) \
233                 dest->field = src->field
234
235 int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM *dest,
236                               const X509_VERIFY_PARAM *src)
237 {
238     unsigned long inh_flags;
239     int to_default, to_overwrite;
240     X509_VERIFY_PARAM_ID *id;
241     if (!src)
242         return 1;
243     id = src->id;
244     inh_flags = dest->inh_flags | src->inh_flags;
245
246     if (inh_flags & X509_VP_FLAG_ONCE)
247         dest->inh_flags = 0;
248
249     if (inh_flags & X509_VP_FLAG_LOCKED)
250         return 1;
251
252     if (inh_flags & X509_VP_FLAG_DEFAULT)
253         to_default = 1;
254     else
255         to_default = 0;
256
257     if (inh_flags & X509_VP_FLAG_OVERWRITE)
258         to_overwrite = 1;
259     else
260         to_overwrite = 0;
261
262     x509_verify_param_copy(purpose, 0);
263     x509_verify_param_copy(trust, 0);
264     x509_verify_param_copy(depth, -1);
265
266     /* If overwrite or check time not set, copy across */
267
268     if (to_overwrite || !(dest->flags & X509_V_FLAG_USE_CHECK_TIME)) {
269         dest->check_time = src->check_time;
270         dest->flags &= ~X509_V_FLAG_USE_CHECK_TIME;
271         /* Don't need to copy flag: that is done below */
272     }
273
274     if (inh_flags & X509_VP_FLAG_RESET_FLAGS)
275         dest->flags = 0;
276
277     dest->flags |= src->flags;
278
279     if (test_x509_verify_param_copy(policies, NULL)) {
280         if (!X509_VERIFY_PARAM_set1_policies(dest, src->policies))
281             return 0;
282     }
283
284     /* Copy the host flags if and only if we're copying the host list */
285     if (test_x509_verify_param_copy_id(hosts, NULL)) {
286         sk_OPENSSL_STRING_pop_free(dest->id->hosts, str_free);
287         dest->id->hosts = NULL;
288         if (id->hosts) {
289             dest->id->hosts =
290                 sk_OPENSSL_STRING_deep_copy(id->hosts, str_copy, str_free);
291             if (dest->id->hosts == NULL)
292                 return 0;
293             dest->id->hostflags = id->hostflags;
294         }
295     }
296
297     if (test_x509_verify_param_copy_id(email, NULL)) {
298         if (!X509_VERIFY_PARAM_set1_email(dest, id->email, id->emaillen))
299             return 0;
300     }
301
302     if (test_x509_verify_param_copy_id(ip, NULL)) {
303         if (!X509_VERIFY_PARAM_set1_ip(dest, id->ip, id->iplen))
304             return 0;
305     }
306
307     return 1;
308 }
309
310 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to,
311                            const X509_VERIFY_PARAM *from)
312 {
313     unsigned long save_flags = to->inh_flags;
314     int ret;
315     to->inh_flags |= X509_VP_FLAG_DEFAULT;
316     ret = X509_VERIFY_PARAM_inherit(to, from);
317     to->inh_flags = save_flags;
318     return ret;
319 }
320
321 static int int_x509_param_set1(char **pdest, size_t *pdestlen,
322                                const char *src, size_t srclen)
323 {
324     void *tmp;
325     if (src) {
326         if (srclen == 0) {
327             tmp = BUF_strdup(src);
328             srclen = strlen(src);
329         } else
330             tmp = BUF_memdup(src, srclen);
331         if (!tmp)
332             return 0;
333     } else {
334         tmp = NULL;
335         srclen = 0;
336     }
337     OPENSSL_free(*pdest);
338     *pdest = tmp;
339     if (pdestlen)
340         *pdestlen = srclen;
341     return 1;
342 }
343
344 int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name)
345 {
346     OPENSSL_free(param->name);
347     param->name = BUF_strdup(name);
348     if (param->name)
349         return 1;
350     return 0;
351 }
352
353 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags)
354 {
355     param->flags |= flags;
356     if (flags & X509_V_FLAG_POLICY_MASK)
357         param->flags |= X509_V_FLAG_POLICY_CHECK;
358     return 1;
359 }
360
361 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param,
362                                   unsigned long flags)
363 {
364     param->flags &= ~flags;
365     return 1;
366 }
367
368 unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM *param)
369 {
370     return param->flags;
371 }
372
373 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose)
374 {
375     return X509_PURPOSE_set(&param->purpose, purpose);
376 }
377
378 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust)
379 {
380     return X509_TRUST_set(&param->trust, trust);
381 }
382
383 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth)
384 {
385     param->depth = depth;
386 }
387
388 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t)
389 {
390     param->check_time = t;
391     param->flags |= X509_V_FLAG_USE_CHECK_TIME;
392 }
393
394 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param,
395                                   ASN1_OBJECT *policy)
396 {
397     if (!param->policies) {
398         param->policies = sk_ASN1_OBJECT_new_null();
399         if (!param->policies)
400             return 0;
401     }
402     if (!sk_ASN1_OBJECT_push(param->policies, policy))
403         return 0;
404     return 1;
405 }
406
407 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
408                                     STACK_OF(ASN1_OBJECT) *policies)
409 {
410     int i;
411     ASN1_OBJECT *oid, *doid;
412
413     if (!param)
414         return 0;
415     sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
416
417     if (!policies) {
418         param->policies = NULL;
419         return 1;
420     }
421
422     param->policies = sk_ASN1_OBJECT_new_null();
423     if (!param->policies)
424         return 0;
425
426     for (i = 0; i < sk_ASN1_OBJECT_num(policies); i++) {
427         oid = sk_ASN1_OBJECT_value(policies, i);
428         doid = OBJ_dup(oid);
429         if (!doid)
430             return 0;
431         if (!sk_ASN1_OBJECT_push(param->policies, doid)) {
432             ASN1_OBJECT_free(doid);
433             return 0;
434         }
435     }
436     param->flags |= X509_V_FLAG_POLICY_CHECK;
437     return 1;
438 }
439
440 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
441                                 const char *name, size_t namelen)
442 {
443     return int_x509_param_set_hosts(param->id, SET_HOST, name, namelen);
444 }
445
446 int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param,
447                                 const char *name, size_t namelen)
448 {
449     return int_x509_param_set_hosts(param->id, ADD_HOST, name, namelen);
450 }
451
452 void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
453                                      unsigned int flags)
454 {
455     param->id->hostflags = flags;
456 }
457
458 char *X509_VERIFY_PARAM_get0_peername(X509_VERIFY_PARAM *param)
459 {
460     return param->id->peername;
461 }
462
463 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
464                                  const char *email, size_t emaillen)
465 {
466     return int_x509_param_set1(&param->id->email, &param->id->emaillen,
467                                email, emaillen);
468 }
469
470 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
471                               const unsigned char *ip, size_t iplen)
472 {
473     if (iplen != 0 && iplen != 4 && iplen != 16)
474         return 0;
475     return int_x509_param_set1((char **)&param->id->ip, &param->id->iplen,
476                                (char *)ip, iplen);
477 }
478
479 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param, const char *ipasc)
480 {
481     unsigned char ipout[16];
482     size_t iplen;
483
484     iplen = (size_t)a2i_ipadd(ipout, ipasc);
485     if (iplen == 0)
486         return 0;
487     return X509_VERIFY_PARAM_set1_ip(param, ipout, iplen);
488 }
489
490 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param)
491 {
492     return param->depth;
493 }
494
495 const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM *param)
496 {
497     return param->name;
498 }
499
500 static X509_VERIFY_PARAM_ID _empty_id = { NULL, 0U, NULL, NULL, 0, NULL, 0 };
501
502 #define vpm_empty_id (X509_VERIFY_PARAM_ID *)&_empty_id
503
504 /*
505  * Default verify parameters: these are used for various applications and can
506  * be overridden by the user specified table. NB: the 'name' field *must* be
507  * in alphabetical order because it will be searched using OBJ_search.
508  */
509
510 static const X509_VERIFY_PARAM default_table[] = {
511     {
512      "default",                 /* X509 default parameters */
513      0,                         /* Check time */
514      0,                         /* internal flags */
515      0,                         /* flags */
516      0,                         /* purpose */
517      0,                         /* trust */
518      100,                       /* depth */
519      NULL,                      /* policies */
520      vpm_empty_id},
521     {
522      "pkcs7",                   /* S/MIME sign parameters */
523      0,                         /* Check time */
524      0,                         /* internal flags */
525      0,                         /* flags */
526      X509_PURPOSE_SMIME_SIGN,   /* purpose */
527      X509_TRUST_EMAIL,          /* trust */
528      -1,                        /* depth */
529      NULL,                      /* policies */
530      vpm_empty_id},
531     {
532      "smime_sign",              /* 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      "ssl_client",              /* SSL/TLS client parameters */
543      0,                         /* Check time */
544      0,                         /* internal flags */
545      0,                         /* flags */
546      X509_PURPOSE_SSL_CLIENT,   /* purpose */
547      X509_TRUST_SSL_CLIENT,     /* trust */
548      -1,                        /* depth */
549      NULL,                      /* policies */
550      vpm_empty_id},
551     {
552      "ssl_server",              /* SSL/TLS server parameters */
553      0,                         /* Check time */
554      0,                         /* internal flags */
555      0,                         /* flags */
556      X509_PURPOSE_SSL_SERVER,   /* purpose */
557      X509_TRUST_SSL_SERVER,     /* trust */
558      -1,                        /* depth */
559      NULL,                      /* policies */
560      vpm_empty_id}
561 };
562
563 static STACK_OF(X509_VERIFY_PARAM) *param_table = NULL;
564
565 static int table_cmp(const X509_VERIFY_PARAM *a, const X509_VERIFY_PARAM *b)
566 {
567     return strcmp(a->name, b->name);
568 }
569
570 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
571 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
572
573 static int param_cmp(const X509_VERIFY_PARAM *const *a,
574                      const X509_VERIFY_PARAM *const *b)
575 {
576     return strcmp((*a)->name, (*b)->name);
577 }
578
579 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param)
580 {
581     int idx;
582     X509_VERIFY_PARAM *ptmp;
583     if (!param_table) {
584         param_table = sk_X509_VERIFY_PARAM_new(param_cmp);
585         if (!param_table)
586             return 0;
587     } else {
588         idx = sk_X509_VERIFY_PARAM_find(param_table, param);
589         if (idx != -1) {
590             ptmp = sk_X509_VERIFY_PARAM_value(param_table, idx);
591             X509_VERIFY_PARAM_free(ptmp);
592             (void)sk_X509_VERIFY_PARAM_delete(param_table, idx);
593         }
594     }
595     if (!sk_X509_VERIFY_PARAM_push(param_table, param))
596         return 0;
597     return 1;
598 }
599
600 int X509_VERIFY_PARAM_get_count(void)
601 {
602     int num = OSSL_NELEM(default_table);
603     if (param_table)
604         num += sk_X509_VERIFY_PARAM_num(param_table);
605     return num;
606 }
607
608 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_get0(int id)
609 {
610     int num = OSSL_NELEM(default_table);
611     if (id < num)
612         return default_table + id;
613     return sk_X509_VERIFY_PARAM_value(param_table, id - num);
614 }
615
616 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name)
617 {
618     int idx;
619     X509_VERIFY_PARAM pm;
620
621     pm.name = (char *)name;
622     if (param_table) {
623         idx = sk_X509_VERIFY_PARAM_find(param_table, &pm);
624         if (idx != -1)
625             return sk_X509_VERIFY_PARAM_value(param_table, idx);
626     }
627     return OBJ_bsearch_table(&pm, default_table, OSSL_NELEM(default_table));
628 }
629
630 void X509_VERIFY_PARAM_table_cleanup(void)
631 {
632     sk_X509_VERIFY_PARAM_pop_free(param_table, X509_VERIFY_PARAM_free);
633     param_table = NULL;
634 }