free NULL cleanup 5a
[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
172     param = OPENSSL_malloc(sizeof(X509_VERIFY_PARAM));
173     if (!param)
174         return NULL;
175     paramid = OPENSSL_malloc(sizeof(X509_VERIFY_PARAM));
176     if (!paramid) {
177         OPENSSL_free(param);
178         return NULL;
179     }
180     memset(param, 0, sizeof(X509_VERIFY_PARAM));
181     memset(paramid, 0, sizeof(X509_VERIFY_PARAM_ID));
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         if (dest->id->hosts) {
297             string_stack_free(dest->id->hosts);
298             dest->id->hosts = NULL;
299         }
300         if (id->hosts) {
301             dest->id->hosts =
302                 sk_OPENSSL_STRING_deep_copy(id->hosts, str_copy, str_free);
303             if (dest->id->hosts == NULL)
304                 return 0;
305             dest->id->hostflags = id->hostflags;
306         }
307     }
308
309     if (test_x509_verify_param_copy_id(email, NULL)) {
310         if (!X509_VERIFY_PARAM_set1_email(dest, id->email, id->emaillen))
311             return 0;
312     }
313
314     if (test_x509_verify_param_copy_id(ip, NULL)) {
315         if (!X509_VERIFY_PARAM_set1_ip(dest, id->ip, id->iplen))
316             return 0;
317     }
318
319     return 1;
320 }
321
322 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to,
323                            const X509_VERIFY_PARAM *from)
324 {
325     unsigned long save_flags = to->inh_flags;
326     int ret;
327     to->inh_flags |= X509_VP_FLAG_DEFAULT;
328     ret = X509_VERIFY_PARAM_inherit(to, from);
329     to->inh_flags = save_flags;
330     return ret;
331 }
332
333 static int int_x509_param_set1(char **pdest, size_t *pdestlen,
334                                const char *src, size_t srclen)
335 {
336     void *tmp;
337     if (src) {
338         if (srclen == 0) {
339             tmp = BUF_strdup(src);
340             srclen = strlen(src);
341         } else
342             tmp = BUF_memdup(src, srclen);
343         if (!tmp)
344             return 0;
345     } else {
346         tmp = NULL;
347         srclen = 0;
348     }
349     if (*pdest)
350         OPENSSL_free(*pdest);
351     *pdest = tmp;
352     if (pdestlen)
353         *pdestlen = srclen;
354     return 1;
355 }
356
357 int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name)
358 {
359     if (param->name)
360         OPENSSL_free(param->name);
361     param->name = BUF_strdup(name);
362     if (param->name)
363         return 1;
364     return 0;
365 }
366
367 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags)
368 {
369     param->flags |= flags;
370     if (flags & X509_V_FLAG_POLICY_MASK)
371         param->flags |= X509_V_FLAG_POLICY_CHECK;
372     return 1;
373 }
374
375 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param,
376                                   unsigned long flags)
377 {
378     param->flags &= ~flags;
379     return 1;
380 }
381
382 unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM *param)
383 {
384     return param->flags;
385 }
386
387 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose)
388 {
389     return X509_PURPOSE_set(&param->purpose, purpose);
390 }
391
392 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust)
393 {
394     return X509_TRUST_set(&param->trust, trust);
395 }
396
397 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth)
398 {
399     param->depth = depth;
400 }
401
402 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t)
403 {
404     param->check_time = t;
405     param->flags |= X509_V_FLAG_USE_CHECK_TIME;
406 }
407
408 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param,
409                                   ASN1_OBJECT *policy)
410 {
411     if (!param->policies) {
412         param->policies = sk_ASN1_OBJECT_new_null();
413         if (!param->policies)
414             return 0;
415     }
416     if (!sk_ASN1_OBJECT_push(param->policies, policy))
417         return 0;
418     return 1;
419 }
420
421 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
422                                     STACK_OF(ASN1_OBJECT) *policies)
423 {
424     int i;
425     ASN1_OBJECT *oid, *doid;
426
427     if (!param)
428         return 0;
429     sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
430
431     if (!policies) {
432         param->policies = NULL;
433         return 1;
434     }
435
436     param->policies = sk_ASN1_OBJECT_new_null();
437     if (!param->policies)
438         return 0;
439
440     for (i = 0; i < sk_ASN1_OBJECT_num(policies); i++) {
441         oid = sk_ASN1_OBJECT_value(policies, i);
442         doid = OBJ_dup(oid);
443         if (!doid)
444             return 0;
445         if (!sk_ASN1_OBJECT_push(param->policies, doid)) {
446             ASN1_OBJECT_free(doid);
447             return 0;
448         }
449     }
450     param->flags |= X509_V_FLAG_POLICY_CHECK;
451     return 1;
452 }
453
454 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
455                                 const char *name, size_t namelen)
456 {
457     return int_x509_param_set_hosts(param->id, SET_HOST, name, namelen);
458 }
459
460 int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param,
461                                 const char *name, size_t namelen)
462 {
463     return int_x509_param_set_hosts(param->id, ADD_HOST, name, namelen);
464 }
465
466 void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
467                                      unsigned int flags)
468 {
469     param->id->hostflags = flags;
470 }
471
472 char *X509_VERIFY_PARAM_get0_peername(X509_VERIFY_PARAM *param)
473 {
474     return param->id->peername;
475 }
476
477 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
478                                  const char *email, size_t emaillen)
479 {
480     return int_x509_param_set1(&param->id->email, &param->id->emaillen,
481                                email, emaillen);
482 }
483
484 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
485                               const unsigned char *ip, size_t iplen)
486 {
487     if (iplen != 0 && iplen != 4 && iplen != 16)
488         return 0;
489     return int_x509_param_set1((char **)&param->id->ip, &param->id->iplen,
490                                (char *)ip, iplen);
491 }
492
493 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param, const char *ipasc)
494 {
495     unsigned char ipout[16];
496     size_t iplen;
497
498     iplen = (size_t)a2i_ipadd(ipout, ipasc);
499     if (iplen == 0)
500         return 0;
501     return X509_VERIFY_PARAM_set1_ip(param, ipout, iplen);
502 }
503
504 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param)
505 {
506     return param->depth;
507 }
508
509 const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM *param)
510 {
511     return param->name;
512 }
513
514 static X509_VERIFY_PARAM_ID _empty_id = { NULL, 0U, NULL, NULL, 0, NULL, 0 };
515
516 #define vpm_empty_id (X509_VERIFY_PARAM_ID *)&_empty_id
517
518 /*
519  * Default verify parameters: these are used for various applications and can
520  * be overridden by the user specified table. NB: the 'name' field *must* be
521  * in alphabetical order because it will be searched using OBJ_search.
522  */
523
524 static const X509_VERIFY_PARAM default_table[] = {
525     {
526      "default",                 /* X509 default parameters */
527      0,                         /* Check time */
528      0,                         /* internal flags */
529      0,                         /* flags */
530      0,                         /* purpose */
531      0,                         /* trust */
532      100,                       /* depth */
533      NULL,                      /* policies */
534      vpm_empty_id},
535     {
536      "pkcs7",                   /* S/MIME sign parameters */
537      0,                         /* Check time */
538      0,                         /* internal flags */
539      0,                         /* flags */
540      X509_PURPOSE_SMIME_SIGN,   /* purpose */
541      X509_TRUST_EMAIL,          /* trust */
542      -1,                        /* depth */
543      NULL,                      /* policies */
544      vpm_empty_id},
545     {
546      "smime_sign",              /* S/MIME sign parameters */
547      0,                         /* Check time */
548      0,                         /* internal flags */
549      0,                         /* flags */
550      X509_PURPOSE_SMIME_SIGN,   /* purpose */
551      X509_TRUST_EMAIL,          /* trust */
552      -1,                        /* depth */
553      NULL,                      /* policies */
554      vpm_empty_id},
555     {
556      "ssl_client",              /* SSL/TLS client parameters */
557      0,                         /* Check time */
558      0,                         /* internal flags */
559      0,                         /* flags */
560      X509_PURPOSE_SSL_CLIENT,   /* purpose */
561      X509_TRUST_SSL_CLIENT,     /* trust */
562      -1,                        /* depth */
563      NULL,                      /* policies */
564      vpm_empty_id},
565     {
566      "ssl_server",              /* SSL/TLS server parameters */
567      0,                         /* Check time */
568      0,                         /* internal flags */
569      0,                         /* flags */
570      X509_PURPOSE_SSL_SERVER,   /* purpose */
571      X509_TRUST_SSL_SERVER,     /* trust */
572      -1,                        /* depth */
573      NULL,                      /* policies */
574      vpm_empty_id}
575 };
576
577 static STACK_OF(X509_VERIFY_PARAM) *param_table = NULL;
578
579 static int table_cmp(const X509_VERIFY_PARAM *a, const X509_VERIFY_PARAM *b)
580 {
581     return strcmp(a->name, b->name);
582 }
583
584 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
585 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
586
587 static int param_cmp(const X509_VERIFY_PARAM *const *a,
588                      const X509_VERIFY_PARAM *const *b)
589 {
590     return strcmp((*a)->name, (*b)->name);
591 }
592
593 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param)
594 {
595     int idx;
596     X509_VERIFY_PARAM *ptmp;
597     if (!param_table) {
598         param_table = sk_X509_VERIFY_PARAM_new(param_cmp);
599         if (!param_table)
600             return 0;
601     } else {
602         idx = sk_X509_VERIFY_PARAM_find(param_table, param);
603         if (idx != -1) {
604             ptmp = sk_X509_VERIFY_PARAM_value(param_table, idx);
605             X509_VERIFY_PARAM_free(ptmp);
606             (void)sk_X509_VERIFY_PARAM_delete(param_table, idx);
607         }
608     }
609     if (!sk_X509_VERIFY_PARAM_push(param_table, param))
610         return 0;
611     return 1;
612 }
613
614 int X509_VERIFY_PARAM_get_count(void)
615 {
616     int num = sizeof(default_table) / sizeof(X509_VERIFY_PARAM);
617     if (param_table)
618         num += sk_X509_VERIFY_PARAM_num(param_table);
619     return num;
620 }
621
622 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_get0(int id)
623 {
624     int num = sizeof(default_table) / sizeof(X509_VERIFY_PARAM);
625     if (id < num)
626         return default_table + id;
627     return sk_X509_VERIFY_PARAM_value(param_table, id - num);
628 }
629
630 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name)
631 {
632     int idx;
633     X509_VERIFY_PARAM pm;
634
635     pm.name = (char *)name;
636     if (param_table) {
637         idx = sk_X509_VERIFY_PARAM_find(param_table, &pm);
638         if (idx != -1)
639             return sk_X509_VERIFY_PARAM_value(param_table, idx);
640     }
641     return OBJ_bsearch_table(&pm, default_table,
642                              sizeof(default_table) /
643                              sizeof(X509_VERIFY_PARAM));
644 }
645
646 void X509_VERIFY_PARAM_table_cleanup(void)
647 {
648     sk_X509_VERIFY_PARAM_pop_free(param_table, X509_VERIFY_PARAM_free);
649     param_table = NULL;
650 }