2 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 2004 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
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 * ====================================================================
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).
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>
70 /* X509_VERIFY_PARAM functions */
75 static char *str_copy(const char *s) { return OPENSSL_strdup(s); }
76 static void str_free(char *s) { OPENSSL_free(s); }
78 #define string_stack_free(sk) sk_OPENSSL_STRING_pop_free(sk, str_free)
80 static int int_x509_param_set_hosts(X509_VERIFY_PARAM_ID *id, int mode,
81 const char *name, size_t namelen)
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?
90 namelen = name ? strlen(name) : 0;
91 else if (name && memchr(name, '\0', namelen > 1 ? namelen-1 : namelen))
93 if (name && name[namelen-1] == '\0')
96 if (mode == SET_HOST && id->hosts)
98 string_stack_free(id->hosts);
101 if (name == NULL || namelen == 0)
104 copy = BUF_strndup(name, namelen);
108 if (id->hosts == NULL &&
109 (id->hosts = sk_OPENSSL_STRING_new_null()) == NULL)
115 if (!sk_OPENSSL_STRING_push(id->hosts, copy))
118 if (sk_OPENSSL_STRING_num(id->hosts) == 0)
120 sk_OPENSSL_STRING_free(id->hosts);
129 static void x509_verify_param_zero(X509_VERIFY_PARAM *param)
131 X509_VERIFY_PARAM_ID *paramid;
137 /*param->inh_flags = X509_VP_FLAG_DEFAULT;*/
138 param->inh_flags = 0;
143 sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
144 param->policies = NULL;
149 string_stack_free(paramid->hosts);
150 paramid->hosts = NULL;
152 if (paramid->peername)
153 OPENSSL_free(paramid->peername);
156 OPENSSL_free(paramid->email);
157 paramid->email = NULL;
158 paramid->emaillen = 0;
162 OPENSSL_free(paramid->ip);
169 X509_VERIFY_PARAM *X509_VERIFY_PARAM_new(void)
171 X509_VERIFY_PARAM *param;
172 X509_VERIFY_PARAM_ID *paramid;
173 param = OPENSSL_malloc(sizeof(X509_VERIFY_PARAM));
176 paramid = OPENSSL_malloc(sizeof(X509_VERIFY_PARAM));
182 memset(param, 0, sizeof(X509_VERIFY_PARAM));
183 memset(paramid, 0, sizeof(X509_VERIFY_PARAM_ID));
185 x509_verify_param_zero(param);
189 void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM *param)
191 x509_verify_param_zero(param);
192 OPENSSL_free(param->id);
196 /* This function determines how parameters are "inherited" from one structure
197 * to another. There are several different ways this can happen.
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
206 * The "inh_flags" field determines how this function behaves.
208 * Normally any values which are set in the default are not copied from the
209 * destination and verify flags are ORed together.
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".
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.
218 * If X509_VP_FLAG_RESET_FLAGS is set then the flags value is copied instead
221 * If X509_VP_FLAG_LOCKED is set then no values are copied.
223 * If X509_VP_FLAG_ONCE is set then the current inh_flags setting is zeroed
224 * after the next call.
227 /* Macro to test if a field should be copied from src to dest */
229 #define test_x509_verify_param_copy(field, def) \
231 ((src->field != def) && (to_default || (dest->field == def))))
233 /* As above but for ID fields */
235 #define test_x509_verify_param_copy_id(idf, def) \
236 test_x509_verify_param_copy(id->idf, def)
238 /* Macro to test and copy a field if necessary */
240 #define x509_verify_param_copy(field, def) \
241 if (test_x509_verify_param_copy(field, def)) \
242 dest->field = src->field
245 int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM *dest,
246 const X509_VERIFY_PARAM *src)
248 unsigned long inh_flags;
249 int to_default, to_overwrite;
250 X509_VERIFY_PARAM_ID *id;
254 inh_flags = dest->inh_flags | src->inh_flags;
256 if (inh_flags & X509_VP_FLAG_ONCE)
259 if (inh_flags & X509_VP_FLAG_LOCKED)
262 if (inh_flags & X509_VP_FLAG_DEFAULT)
267 if (inh_flags & X509_VP_FLAG_OVERWRITE)
272 x509_verify_param_copy(purpose, 0);
273 x509_verify_param_copy(trust, 0);
274 x509_verify_param_copy(depth, -1);
276 /* If overwrite or check time not set, copy across */
278 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 */
285 if (inh_flags & X509_VP_FLAG_RESET_FLAGS)
288 dest->flags |= src->flags;
290 if (test_x509_verify_param_copy(policies, NULL))
292 if (!X509_VERIFY_PARAM_set1_policies(dest, src->policies))
296 /* Copy the host flags if and only if we're copying the host list */
297 if (test_x509_verify_param_copy_id(hosts, NULL))
301 string_stack_free(dest->id->hosts);
302 dest->id->hosts = NULL;
307 sk_OPENSSL_STRING_deep_copy(id->hosts,
309 if (dest->id->hosts == NULL)
311 dest->id->hostflags = id->hostflags;
315 if (test_x509_verify_param_copy_id(email, NULL))
317 if (!X509_VERIFY_PARAM_set1_email(dest, id->email, id->emaillen))
321 if (test_x509_verify_param_copy_id(ip, NULL))
323 if (!X509_VERIFY_PARAM_set1_ip(dest, id->ip, id->iplen))
330 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to,
331 const X509_VERIFY_PARAM *from)
333 unsigned long save_flags = to->inh_flags;
335 to->inh_flags |= X509_VP_FLAG_DEFAULT;
336 ret = X509_VERIFY_PARAM_inherit(to, from);
337 to->inh_flags = save_flags;
341 static int int_x509_param_set1(char **pdest, size_t *pdestlen,
342 const char *src, size_t srclen)
349 tmp = BUF_strdup(src);
350 srclen = strlen(src);
353 tmp = BUF_memdup(src, srclen);
363 OPENSSL_free(*pdest);
370 int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name)
373 OPENSSL_free(param->name);
374 param->name = BUF_strdup(name);
380 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags)
382 param->flags |= flags;
383 if (flags & X509_V_FLAG_POLICY_MASK)
384 param->flags |= X509_V_FLAG_POLICY_CHECK;
388 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param, unsigned long flags)
390 param->flags &= ~flags;
394 unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM *param)
399 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose)
401 return X509_PURPOSE_set(¶m->purpose, purpose);
404 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust)
406 return X509_TRUST_set(¶m->trust, trust);
409 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth)
411 param->depth = depth;
414 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t)
416 param->check_time = t;
417 param->flags |= X509_V_FLAG_USE_CHECK_TIME;
420 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param, ASN1_OBJECT *policy)
422 if (!param->policies)
424 param->policies = sk_ASN1_OBJECT_new_null();
425 if (!param->policies)
428 if (!sk_ASN1_OBJECT_push(param->policies, policy))
433 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
434 STACK_OF(ASN1_OBJECT) *policies)
437 ASN1_OBJECT *oid, *doid;
441 sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
445 param->policies = NULL;
449 param->policies = sk_ASN1_OBJECT_new_null();
450 if (!param->policies)
453 for (i = 0; i < sk_ASN1_OBJECT_num(policies); i++)
455 oid = sk_ASN1_OBJECT_value(policies, i);
459 if (!sk_ASN1_OBJECT_push(param->policies, doid))
461 ASN1_OBJECT_free(doid);
465 param->flags |= X509_V_FLAG_POLICY_CHECK;
469 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
470 const char *name, size_t namelen)
472 return int_x509_param_set_hosts(param->id, SET_HOST, name, namelen);
475 int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param,
476 const char *name, size_t namelen)
478 return int_x509_param_set_hosts(param->id, ADD_HOST, name, namelen);
481 void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
484 param->id->hostflags = flags;
487 char *X509_VERIFY_PARAM_get0_peername(X509_VERIFY_PARAM *param)
489 return param->id->peername;
492 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
493 const char *email, size_t emaillen)
495 return int_x509_param_set1(¶m->id->email, ¶m->id->emaillen,
499 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
500 const unsigned char *ip, size_t iplen)
502 if (iplen != 0 && iplen != 4 && iplen != 16)
504 return int_x509_param_set1((char **)¶m->id->ip, ¶m->id->iplen,
508 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param, const char *ipasc)
510 unsigned char ipout[16];
513 iplen = (size_t) a2i_ipadd(ipout, ipasc);
516 return X509_VERIFY_PARAM_set1_ip(param, ipout, iplen);
519 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param)
524 const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM *param)
529 static X509_VERIFY_PARAM_ID _empty_id = {NULL, 0U, NULL, NULL, 0, NULL, 0};
531 #define vpm_empty_id (X509_VERIFY_PARAM_ID *)&_empty_id
534 /* Default verify parameters: these are used for various
535 * applications and can be overridden by the user specified table.
536 * NB: the 'name' field *must* be in alphabetical order because it
537 * will be searched using OBJ_search.
540 static const X509_VERIFY_PARAM default_table[] = {
542 "default", /* X509 default parameters */
544 0, /* internal flags */
553 "pkcs7", /* S/MIME sign parameters */
555 0, /* internal flags */
557 X509_PURPOSE_SMIME_SIGN, /* purpose */
558 X509_TRUST_EMAIL, /* trust */
564 "smime_sign", /* S/MIME sign parameters */
566 0, /* internal flags */
568 X509_PURPOSE_SMIME_SIGN, /* purpose */
569 X509_TRUST_EMAIL, /* trust */
575 "ssl_client", /* SSL/TLS client parameters */
577 0, /* internal flags */
579 X509_PURPOSE_SSL_CLIENT, /* purpose */
580 X509_TRUST_SSL_CLIENT, /* trust */
586 "ssl_server", /* SSL/TLS server parameters */
588 0, /* internal flags */
590 X509_PURPOSE_SSL_SERVER, /* purpose */
591 X509_TRUST_SSL_SERVER, /* trust */
597 static STACK_OF(X509_VERIFY_PARAM) *param_table = NULL;
599 static int table_cmp(const X509_VERIFY_PARAM *a, const X509_VERIFY_PARAM *b)
602 return strcmp(a->name, b->name);
605 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM,
607 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM,
610 static int param_cmp(const X509_VERIFY_PARAM * const *a,
611 const X509_VERIFY_PARAM * const *b)
613 return strcmp((*a)->name, (*b)->name);
616 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param)
619 X509_VERIFY_PARAM *ptmp;
622 param_table = sk_X509_VERIFY_PARAM_new(param_cmp);
628 idx = sk_X509_VERIFY_PARAM_find(param_table, param);
631 ptmp = sk_X509_VERIFY_PARAM_value(param_table, idx);
632 X509_VERIFY_PARAM_free(ptmp);
633 (void)sk_X509_VERIFY_PARAM_delete(param_table, idx);
636 if (!sk_X509_VERIFY_PARAM_push(param_table, param))
641 int X509_VERIFY_PARAM_get_count(void)
643 int num = sizeof(default_table)/sizeof(X509_VERIFY_PARAM);
645 num += sk_X509_VERIFY_PARAM_num(param_table);
649 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_get0(int id)
651 int num = sizeof(default_table)/sizeof(X509_VERIFY_PARAM);
653 return default_table + id;
654 return sk_X509_VERIFY_PARAM_value(param_table, id - num);
657 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name)
660 X509_VERIFY_PARAM pm;
662 pm.name = (char *)name;
665 idx = sk_X509_VERIFY_PARAM_find(param_table, &pm);
667 return sk_X509_VERIFY_PARAM_value(param_table, idx);
669 return OBJ_bsearch_table(&pm, default_table,
670 sizeof(default_table)/sizeof(X509_VERIFY_PARAM));
673 void X509_VERIFY_PARAM_table_cleanup(void)
676 sk_X509_VERIFY_PARAM_pop_free(param_table,
677 X509_VERIFY_PARAM_free);