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