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