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