Multiple verifier reference identities.
[openssl.git] / crypto / x509 / x509_vpm.c
1 /* x509_vpm.c */
2 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
3  * project 2004.
4  */
5 /* ====================================================================
6  * Copyright (c) 2004 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer. 
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  *
20  * 3. All advertising materials mentioning features or use of this
21  *    software must display the following acknowledgment:
22  *    "This product includes software developed by the OpenSSL Project
23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
24  *
25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26  *    endorse or promote products derived from this software without
27  *    prior written permission. For written permission, please contact
28  *    licensing@OpenSSL.org.
29  *
30  * 5. Products derived from this software may not be called "OpenSSL"
31  *    nor may "OpenSSL" appear in their names without prior written
32  *    permission of the OpenSSL Project.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50  * OF THE POSSIBILITY OF SUCH DAMAGE.
51  * ====================================================================
52  *
53  * This product includes cryptographic software written by Eric Young
54  * (eay@cryptsoft.com).  This product includes software written by Tim
55  * Hudson (tjh@cryptsoft.com).
56  *
57  */
58
59 #include <stdio.h>
60
61 #include "cryptlib.h"
62 #include <openssl/crypto.h>
63 #include <openssl/lhash.h>
64 #include <openssl/buffer.h>
65 #include <openssl/x509.h>
66 #include <openssl/x509v3.h>
67
68 #include "x509_lcl.h"
69
70 /* X509_VERIFY_PARAM functions */
71
72 #define SET_HOST 0
73 #define ADD_HOST 1
74
75 static char *str_copy(const char *s) { return OPENSSL_strdup(s); }
76 static void str_free(char *s) { OPENSSL_free(s); }
77
78 #define string_stack_free(sk) sk_OPENSSL_STRING_pop_free(sk, str_free)
79
80 static int int_x509_param_set_hosts(X509_VERIFY_PARAM_ID *id, int mode,
81                                     const unsigned char *name, size_t namelen)
82         {
83         char *copy;
84
85         /*
86          * Refuse names with embedded NUL bytes, except perhaps as final byte.
87          * XXX: Do we need to push an error onto the error stack?
88          */
89         if (namelen == 0)
90                 namelen = name ? strlen((char *)name) : 0;
91         else if (name && memchr(name, '\0', namelen > 1 ? namelen-1 : namelen))
92                  return 0;
93         if (name && name[namelen-1] == '\0')
94                 --namelen;
95
96         if (mode == SET_HOST && id->hosts)
97                 {
98                 string_stack_free(id->hosts);
99                 id->hosts = NULL;
100                 }
101         if (name == NULL || namelen == 0)
102                 return 1;
103
104         copy = BUF_strndup((char *)name, namelen);
105         if (copy == NULL)
106                 return 0;
107
108         if (id->hosts == NULL &&
109             (id->hosts = sk_OPENSSL_STRING_new_null()) == NULL)
110                 {
111                 OPENSSL_free(copy);
112                 return 0;
113                 }
114
115         if (!sk_OPENSSL_STRING_push(id->hosts, copy))
116                 {
117                 OPENSSL_free(copy);
118                 if (sk_OPENSSL_STRING_num(id->hosts) == 0)
119                         {
120                         sk_OPENSSL_STRING_free(id->hosts);
121                         id->hosts = NULL;
122                         }
123                 return 0;
124                 }
125
126         return 1;
127         }
128
129 static void x509_verify_param_zero(X509_VERIFY_PARAM *param)
130         {
131         X509_VERIFY_PARAM_ID *paramid;
132         if (!param)
133                 return;
134         param->name = NULL;
135         param->purpose = 0;
136         param->trust = 0;
137         /*param->inh_flags = X509_VP_FLAG_DEFAULT;*/
138         param->inh_flags = 0;
139         param->flags = 0;
140         param->depth = -1;
141         if (param->policies)
142                 {
143                 sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
144                 param->policies = NULL;
145                 }
146         paramid = param->id;
147         if (paramid->hosts)
148                 {
149                 string_stack_free(paramid->hosts);
150                 paramid->hosts = NULL;
151                 }
152         if (paramid->email)
153                 {
154                 OPENSSL_free(paramid->email);
155                 paramid->email = NULL;
156                 paramid->emaillen = 0;
157                 }
158         if (paramid->ip)
159                 {
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                 {
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         x509_verify_param_zero(param);
190         OPENSSL_free(param->id);
191         OPENSSL_free(param);
192         }
193
194 /* This function determines how parameters are "inherited" from one structure
195  * to another. There are several different ways this can happen.
196  *
197  * 1. If a child structure needs to have its values initialized from a parent
198  *    they are simply copied across. For example SSL_CTX copied to SSL.
199  * 2. If the structure should take on values only if they are currently unset.
200  *    For example the values in an SSL structure will take appropriate value
201  *    for SSL servers or clients but only if the application has not set new
202  *    ones.
203  *
204  * The "inh_flags" field determines how this function behaves. 
205  *
206  * Normally any values which are set in the default are not copied from the
207  * destination and verify flags are ORed together.
208  *
209  * If X509_VP_FLAG_DEFAULT is set then anything set in the source is copied
210  * to the destination. Effectively the values in "to" become default values
211  * which will be used only if nothing new is set in "from".
212  *
213  * If X509_VP_FLAG_OVERWRITE is set then all value are copied across whether
214  * they are set or not. Flags is still Ored though.
215  *
216  * If X509_VP_FLAG_RESET_FLAGS is set then the flags value is copied instead
217  * of ORed.
218  *
219  * If X509_VP_FLAG_LOCKED is set then no values are copied.
220  *
221  * If X509_VP_FLAG_ONCE is set then the current inh_flags setting is zeroed
222  * after the next call.
223  */
224
225 /* Macro to test if a field should be copied from src to dest */
226
227 #define test_x509_verify_param_copy(field, def) \
228         (to_overwrite || \
229                 ((src->field != def) && (to_default || (dest->field == def))))
230
231 /* As above but for ID fields */
232
233 #define test_x509_verify_param_copy_id(idf, def) \
234         test_x509_verify_param_copy(id->idf, def)
235
236 /* Macro to test and copy a field if necessary */
237
238 #define x509_verify_param_copy(field, def) \
239         if (test_x509_verify_param_copy(field, def)) \
240                 dest->field = src->field
241
242
243 int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM *dest,
244                                                 const X509_VERIFY_PARAM *src)
245         {
246         unsigned long inh_flags;
247         int to_default, to_overwrite;
248         X509_VERIFY_PARAM_ID *id;
249         if (!src)
250                 return 1;
251         id = src->id;
252         inh_flags = dest->inh_flags | src->inh_flags;
253
254         if (inh_flags & X509_VP_FLAG_ONCE)
255                 dest->inh_flags = 0;
256
257         if (inh_flags & X509_VP_FLAG_LOCKED)
258                 return 1;
259
260         if (inh_flags & X509_VP_FLAG_DEFAULT)
261                 to_default = 1;
262         else
263                 to_default = 0;
264
265         if (inh_flags & X509_VP_FLAG_OVERWRITE)
266                 to_overwrite = 1;
267         else
268                 to_overwrite = 0;
269
270         x509_verify_param_copy(purpose, 0);
271         x509_verify_param_copy(trust, 0);
272         x509_verify_param_copy(depth, -1);
273
274         /* If overwrite or check time not set, copy across */
275
276         if (to_overwrite || !(dest->flags & X509_V_FLAG_USE_CHECK_TIME))
277                 {
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                 {
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                 {
297                 if (dest->id->hosts)
298                         {
299                         string_stack_free(dest->id->hosts);
300                         dest->id->hosts = NULL;
301                         }
302                 if (id->hosts)
303                         {
304                         dest->id->hosts =
305                             sk_OPENSSL_STRING_deep_copy(id->hosts,
306                                                         str_copy, str_free);
307                         if (dest->id->hosts == NULL)
308                                 return 0;
309                         dest->id->hostflags = id->hostflags;
310                         }
311                 }
312
313         if (test_x509_verify_param_copy_id(email, NULL))
314                 {
315                 if (!X509_VERIFY_PARAM_set1_email(dest, id->email, id->emaillen))
316                         return 0;
317                 }
318
319         if (test_x509_verify_param_copy_id(ip, NULL))
320                 {
321                 if (!X509_VERIFY_PARAM_set1_ip(dest, id->ip, id->iplen))
322                         return 0;
323                 }
324
325         return 1;
326         }
327
328 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to,
329                                                 const X509_VERIFY_PARAM *from)
330         {
331         unsigned long save_flags = to->inh_flags;
332         int ret;
333         to->inh_flags |= X509_VP_FLAG_DEFAULT;
334         ret = X509_VERIFY_PARAM_inherit(to, from);
335         to->inh_flags = save_flags;
336         return ret;
337         }
338
339 static int int_x509_param_set1(unsigned char **pdest, size_t *pdestlen,
340                                 const unsigned char *src, size_t srclen)
341         {
342         void *tmp;
343         if (src)
344                 {
345                 if (srclen == 0)
346                         {
347                         tmp = BUF_strdup((char *)src);
348                         srclen = strlen((char *)src);
349                         }
350                 else
351                         tmp = BUF_memdup(src, srclen);
352                 if (!tmp)
353                         return 0;
354                 }
355         else
356                 {
357                 tmp = NULL;
358                 srclen = 0;
359                 }
360         if (*pdest)
361                 OPENSSL_free(*pdest);
362         *pdest = tmp;
363         if (pdestlen)
364                 *pdestlen = srclen;
365         return 1;
366         }
367
368 int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name)
369         {
370         if (param->name)
371                 OPENSSL_free(param->name);
372         param->name = BUF_strdup(name);
373         if (param->name)
374                 return 1;
375         return 0;
376         }
377
378 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags)
379         {
380         param->flags |= flags;
381         if (flags & X509_V_FLAG_POLICY_MASK)
382                 param->flags |= X509_V_FLAG_POLICY_CHECK;
383         return 1;
384         }
385
386 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param, unsigned long flags)
387         {
388         param->flags &= ~flags;
389         return 1;
390         }
391
392 unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM *param)
393         {
394         return param->flags;
395         }
396
397 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose)
398         {
399         return X509_PURPOSE_set(&param->purpose, purpose);
400         }
401
402 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust)
403         {
404         return X509_TRUST_set(&param->trust, trust);
405         }
406
407 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth)
408         {
409         param->depth = depth;
410         }
411
412 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t)
413         {
414         param->check_time = t;
415         param->flags |= X509_V_FLAG_USE_CHECK_TIME;
416         }
417
418 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param, ASN1_OBJECT *policy)
419         {
420         if (!param->policies)
421                 {
422                 param->policies = sk_ASN1_OBJECT_new_null();
423                 if (!param->policies)
424                         return 0;
425                 }
426         if (!sk_ASN1_OBJECT_push(param->policies, policy))
427                 return 0;
428         return 1;
429         }
430
431 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param, 
432                                         STACK_OF(ASN1_OBJECT) *policies)
433         {
434         int i;
435         ASN1_OBJECT *oid, *doid;
436         if (!param)
437                 return 0;
438         if (param->policies)
439                 sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
440
441         if (!policies)
442                 {
443                 param->policies = NULL;
444                 return 1;
445                 }
446
447         param->policies = sk_ASN1_OBJECT_new_null();
448         if (!param->policies)
449                 return 0;
450
451         for (i = 0; i < sk_ASN1_OBJECT_num(policies); i++)
452                 {
453                 oid = sk_ASN1_OBJECT_value(policies, i);
454                 doid = OBJ_dup(oid);
455                 if (!doid)
456                         return 0;
457                 if (!sk_ASN1_OBJECT_push(param->policies, doid))
458                         {
459                         ASN1_OBJECT_free(doid);
460                         return 0;
461                         }
462                 }
463         param->flags |= X509_V_FLAG_POLICY_CHECK;
464         return 1;
465         }
466
467 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
468                                 const unsigned char *name, size_t namelen)
469         {
470         return int_x509_param_set_hosts(param->id, SET_HOST, name, namelen);
471         }
472
473 int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param,
474                                 const unsigned char *name, size_t namelen)
475         {
476         return int_x509_param_set_hosts(param->id, ADD_HOST, name, namelen);
477         }
478
479 void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
480                                         unsigned int flags)
481         {
482         param->id->hostflags = flags;
483         }
484
485 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
486                                 const unsigned char *email, size_t emaillen)
487         {
488         return int_x509_param_set1(&param->id->email, &param->id->emaillen,
489                                         email, emaillen);
490         }
491
492 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
493                                         const unsigned char *ip, size_t iplen)
494         {
495         if (iplen != 0 && iplen != 4 && iplen != 16)
496                 return 0;
497         return int_x509_param_set1(&param->id->ip, &param->id->iplen, ip, iplen);
498         }
499
500 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param, const char *ipasc)
501         {
502         unsigned char ipout[16];
503         int iplen;
504         iplen = a2i_ipadd(ipout, ipasc);
505         if (iplen == 0)
506                 return 0;
507         return X509_VERIFY_PARAM_set1_ip(param, ipout, (size_t)iplen);
508         }
509
510 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param)
511         {
512         return param->depth;
513         }
514
515 const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM *param)
516         {
517         return param->name;
518         }
519
520 static X509_VERIFY_PARAM_ID _empty_id = {NULL, 0U, NULL, 0, NULL, 0};
521
522 #define vpm_empty_id (X509_VERIFY_PARAM_ID *)&_empty_id
523
524
525 /* Default verify parameters: these are used for various
526  * applications and can be overridden by the user specified table.
527  * NB: the 'name' field *must* be in alphabetical order because it
528  * will be searched using OBJ_search.
529  */
530
531 static const X509_VERIFY_PARAM default_table[] = {
532         {
533         "default",      /* X509 default parameters */
534         0,              /* Check time */
535         0,              /* internal flags */
536         0,              /* flags */
537         0,              /* purpose */
538         0,              /* trust */
539         100,            /* depth */
540         NULL,           /* policies */
541         vpm_empty_id
542         },
543         {
544         "pkcs7",                        /* S/MIME sign parameters */
545         0,                              /* Check time */
546         0,                              /* internal flags */
547         0,                              /* flags */
548         X509_PURPOSE_SMIME_SIGN,        /* purpose */
549         X509_TRUST_EMAIL,               /* trust */
550         -1,                             /* depth */
551         NULL,                           /* policies */
552         vpm_empty_id
553         },
554         {
555         "smime_sign",                   /* S/MIME sign parameters */
556         0,                              /* Check time */
557         0,                              /* internal flags */
558         0,                              /* flags */
559         X509_PURPOSE_SMIME_SIGN,        /* purpose */
560         X509_TRUST_EMAIL,               /* trust */
561         -1,                             /* depth */
562         NULL,                           /* policies */
563         vpm_empty_id
564         },
565         {
566         "ssl_client",                   /* SSL/TLS client parameters */
567         0,                              /* Check time */
568         0,                              /* internal flags */
569         0,                              /* flags */
570         X509_PURPOSE_SSL_CLIENT,        /* purpose */
571         X509_TRUST_SSL_CLIENT,          /* trust */
572         -1,                             /* depth */
573         NULL,                           /* policies */
574         vpm_empty_id
575         },
576         {
577         "ssl_server",                   /* SSL/TLS server parameters */
578         0,                              /* Check time */
579         0,                              /* internal flags */
580         0,                              /* flags */
581         X509_PURPOSE_SSL_SERVER,        /* purpose */
582         X509_TRUST_SSL_SERVER,          /* trust */
583         -1,                             /* depth */
584         NULL,                           /* policies */
585         vpm_empty_id
586         }};
587
588 static STACK_OF(X509_VERIFY_PARAM) *param_table = NULL;
589
590 static int table_cmp(const X509_VERIFY_PARAM *a, const X509_VERIFY_PARAM *b)
591
592         {
593         return strcmp(a->name, b->name);
594         }
595
596 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM,
597                            table);
598 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM,
599                              table);
600
601 static int param_cmp(const X509_VERIFY_PARAM * const *a,
602                         const X509_VERIFY_PARAM * const *b)
603         {
604         return strcmp((*a)->name, (*b)->name);
605         }
606
607 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param)
608         {
609         int idx;
610         X509_VERIFY_PARAM *ptmp;
611         if (!param_table)
612                 {
613                 param_table = sk_X509_VERIFY_PARAM_new(param_cmp);
614                 if (!param_table)
615                         return 0;
616                 }
617         else
618                 {
619                 idx = sk_X509_VERIFY_PARAM_find(param_table, param);
620                 if (idx != -1)
621                         {
622                         ptmp = sk_X509_VERIFY_PARAM_value(param_table, idx);
623                         X509_VERIFY_PARAM_free(ptmp);
624                         (void)sk_X509_VERIFY_PARAM_delete(param_table, idx);
625                         }
626                 }
627         if (!sk_X509_VERIFY_PARAM_push(param_table, param))
628                 return 0;
629         return 1;
630         }
631
632 int X509_VERIFY_PARAM_get_count(void)
633         {
634         int num = sizeof(default_table)/sizeof(X509_VERIFY_PARAM);
635         if (param_table)
636                 num += sk_X509_VERIFY_PARAM_num(param_table);
637         return num;
638         }
639
640 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_get0(int id)
641         {
642         int num = sizeof(default_table)/sizeof(X509_VERIFY_PARAM);
643         if (id < num)
644                 return default_table + id;
645         return sk_X509_VERIFY_PARAM_value(param_table, id - num);
646         }
647
648 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name)
649         {
650         int idx;
651         X509_VERIFY_PARAM pm;
652
653         pm.name = (char *)name;
654         if (param_table)
655                 {
656                 idx = sk_X509_VERIFY_PARAM_find(param_table, &pm);
657                 if (idx != -1)
658                         return sk_X509_VERIFY_PARAM_value(param_table, idx);
659                 }
660         return OBJ_bsearch_table(&pm, default_table,
661                            sizeof(default_table)/sizeof(X509_VERIFY_PARAM));
662         }
663
664 void X509_VERIFY_PARAM_table_cleanup(void)
665         {
666         if (param_table)
667                 sk_X509_VERIFY_PARAM_pop_free(param_table,
668                                                 X509_VERIFY_PARAM_free);
669         param_table = NULL;
670         }