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