3 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
6 /* ====================================================================
7 * Copyright (c) 2004 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
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 * ====================================================================
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).
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>
71 /* X509_VERIFY_PARAM functions */
76 static char *str_copy(const char *s)
78 return OPENSSL_strdup(s);
81 static void str_free(char *s)
86 #define string_stack_free(sk) sk_OPENSSL_STRING_pop_free(sk, str_free)
88 static int int_x509_param_set_hosts(X509_VERIFY_PARAM_ID *id, int mode,
89 const char *name, size_t namelen)
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?
98 namelen = name ? strlen(name) : 0;
99 else if (name && memchr(name, '\0', namelen > 1 ? namelen - 1 : namelen))
101 if (name && name[namelen - 1] == '\0')
104 if (mode == SET_HOST && id->hosts) {
105 string_stack_free(id->hosts);
108 if (name == NULL || namelen == 0)
111 copy = BUF_strndup(name, namelen);
115 if (id->hosts == NULL &&
116 (id->hosts = sk_OPENSSL_STRING_new_null()) == NULL) {
121 if (!sk_OPENSSL_STRING_push(id->hosts, copy)) {
123 if (sk_OPENSSL_STRING_num(id->hosts) == 0) {
124 sk_OPENSSL_STRING_free(id->hosts);
133 static void x509_verify_param_zero(X509_VERIFY_PARAM *param)
135 X509_VERIFY_PARAM_ID *paramid;
142 * param->inh_flags = X509_VP_FLAG_DEFAULT;
144 param->inh_flags = 0;
147 sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
148 param->policies = NULL;
150 string_stack_free(paramid->hosts);
151 paramid->hosts = NULL;
152 OPENSSL_free(paramid->peername);
153 OPENSSL_free(paramid->email);
154 paramid->email = NULL;
155 paramid->emaillen = 0;
156 OPENSSL_free(paramid->ip);
161 X509_VERIFY_PARAM *X509_VERIFY_PARAM_new(void)
163 X509_VERIFY_PARAM *param;
164 X509_VERIFY_PARAM_ID *paramid;
166 param = OPENSSL_malloc(sizeof(X509_VERIFY_PARAM));
169 paramid = OPENSSL_malloc(sizeof(X509_VERIFY_PARAM));
174 memset(param, 0, sizeof(X509_VERIFY_PARAM));
175 memset(paramid, 0, sizeof(X509_VERIFY_PARAM_ID));
177 x509_verify_param_zero(param);
181 void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM *param)
185 x509_verify_param_zero(param);
186 OPENSSL_free(param->id);
191 * This function determines how parameters are "inherited" from one structure
192 * to another. There are several different ways this can happen.
194 * 1. If a child structure needs to have its values initialized from a parent
195 * they are simply copied across. For example SSL_CTX copied to SSL.
196 * 2. If the structure should take on values only if they are currently unset.
197 * For example the values in an SSL structure will take appropriate value
198 * for SSL servers or clients but only if the application has not set new
201 * The "inh_flags" field determines how this function behaves.
203 * Normally any values which are set in the default are not copied from the
204 * destination and verify flags are ORed together.
206 * If X509_VP_FLAG_DEFAULT is set then anything set in the source is copied
207 * to the destination. Effectively the values in "to" become default values
208 * which will be used only if nothing new is set in "from".
210 * If X509_VP_FLAG_OVERWRITE is set then all value are copied across whether
211 * they are set or not. Flags is still Ored though.
213 * If X509_VP_FLAG_RESET_FLAGS is set then the flags value is copied instead
216 * If X509_VP_FLAG_LOCKED is set then no values are copied.
218 * If X509_VP_FLAG_ONCE is set then the current inh_flags setting is zeroed
219 * after the next call.
222 /* Macro to test if a field should be copied from src to dest */
224 #define test_x509_verify_param_copy(field, def) \
226 ((src->field != def) && (to_default || (dest->field == def))))
228 /* As above but for ID fields */
230 #define test_x509_verify_param_copy_id(idf, def) \
231 test_x509_verify_param_copy(id->idf, def)
233 /* Macro to test and copy a field if necessary */
235 #define x509_verify_param_copy(field, def) \
236 if (test_x509_verify_param_copy(field, def)) \
237 dest->field = src->field
239 int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM *dest,
240 const X509_VERIFY_PARAM *src)
242 unsigned long inh_flags;
243 int to_default, to_overwrite;
244 X509_VERIFY_PARAM_ID *id;
248 inh_flags = dest->inh_flags | src->inh_flags;
250 if (inh_flags & X509_VP_FLAG_ONCE)
253 if (inh_flags & X509_VP_FLAG_LOCKED)
256 if (inh_flags & X509_VP_FLAG_DEFAULT)
261 if (inh_flags & X509_VP_FLAG_OVERWRITE)
266 x509_verify_param_copy(purpose, 0);
267 x509_verify_param_copy(trust, 0);
268 x509_verify_param_copy(depth, -1);
270 /* If overwrite or check time not set, copy across */
272 if (to_overwrite || !(dest->flags & X509_V_FLAG_USE_CHECK_TIME)) {
273 dest->check_time = src->check_time;
274 dest->flags &= ~X509_V_FLAG_USE_CHECK_TIME;
275 /* Don't need to copy flag: that is done below */
278 if (inh_flags & X509_VP_FLAG_RESET_FLAGS)
281 dest->flags |= src->flags;
283 if (test_x509_verify_param_copy(policies, NULL)) {
284 if (!X509_VERIFY_PARAM_set1_policies(dest, src->policies))
288 /* Copy the host flags if and only if we're copying the host list */
289 if (test_x509_verify_param_copy_id(hosts, NULL)) {
290 if (dest->id->hosts) {
291 string_stack_free(dest->id->hosts);
292 dest->id->hosts = NULL;
296 sk_OPENSSL_STRING_deep_copy(id->hosts, str_copy, str_free);
297 if (dest->id->hosts == NULL)
299 dest->id->hostflags = id->hostflags;
303 if (test_x509_verify_param_copy_id(email, NULL)) {
304 if (!X509_VERIFY_PARAM_set1_email(dest, id->email, id->emaillen))
308 if (test_x509_verify_param_copy_id(ip, NULL)) {
309 if (!X509_VERIFY_PARAM_set1_ip(dest, id->ip, id->iplen))
316 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to,
317 const X509_VERIFY_PARAM *from)
319 unsigned long save_flags = to->inh_flags;
321 to->inh_flags |= X509_VP_FLAG_DEFAULT;
322 ret = X509_VERIFY_PARAM_inherit(to, from);
323 to->inh_flags = save_flags;
327 static int int_x509_param_set1(char **pdest, size_t *pdestlen,
328 const char *src, size_t srclen)
333 tmp = BUF_strdup(src);
334 srclen = strlen(src);
336 tmp = BUF_memdup(src, srclen);
343 OPENSSL_free(*pdest);
350 int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name)
352 OPENSSL_free(param->name);
353 param->name = BUF_strdup(name);
359 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags)
361 param->flags |= flags;
362 if (flags & X509_V_FLAG_POLICY_MASK)
363 param->flags |= X509_V_FLAG_POLICY_CHECK;
367 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param,
370 param->flags &= ~flags;
374 unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM *param)
379 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose)
381 return X509_PURPOSE_set(¶m->purpose, purpose);
384 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust)
386 return X509_TRUST_set(¶m->trust, trust);
389 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth)
391 param->depth = depth;
394 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t)
396 param->check_time = t;
397 param->flags |= X509_V_FLAG_USE_CHECK_TIME;
400 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param,
403 if (!param->policies) {
404 param->policies = sk_ASN1_OBJECT_new_null();
405 if (!param->policies)
408 if (!sk_ASN1_OBJECT_push(param->policies, policy))
413 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
414 STACK_OF(ASN1_OBJECT) *policies)
417 ASN1_OBJECT *oid, *doid;
421 sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
424 param->policies = NULL;
428 param->policies = sk_ASN1_OBJECT_new_null();
429 if (!param->policies)
432 for (i = 0; i < sk_ASN1_OBJECT_num(policies); i++) {
433 oid = sk_ASN1_OBJECT_value(policies, i);
437 if (!sk_ASN1_OBJECT_push(param->policies, doid)) {
438 ASN1_OBJECT_free(doid);
442 param->flags |= X509_V_FLAG_POLICY_CHECK;
446 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
447 const char *name, size_t namelen)
449 return int_x509_param_set_hosts(param->id, SET_HOST, name, namelen);
452 int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param,
453 const char *name, size_t namelen)
455 return int_x509_param_set_hosts(param->id, ADD_HOST, name, namelen);
458 void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
461 param->id->hostflags = flags;
464 char *X509_VERIFY_PARAM_get0_peername(X509_VERIFY_PARAM *param)
466 return param->id->peername;
469 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
470 const char *email, size_t emaillen)
472 return int_x509_param_set1(¶m->id->email, ¶m->id->emaillen,
476 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
477 const unsigned char *ip, size_t iplen)
479 if (iplen != 0 && iplen != 4 && iplen != 16)
481 return int_x509_param_set1((char **)¶m->id->ip, ¶m->id->iplen,
485 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param, const char *ipasc)
487 unsigned char ipout[16];
490 iplen = (size_t)a2i_ipadd(ipout, ipasc);
493 return X509_VERIFY_PARAM_set1_ip(param, ipout, iplen);
496 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param)
501 const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM *param)
506 static X509_VERIFY_PARAM_ID _empty_id = { NULL, 0U, NULL, NULL, 0, NULL, 0 };
508 #define vpm_empty_id (X509_VERIFY_PARAM_ID *)&_empty_id
511 * Default verify parameters: these are used for various applications and can
512 * be overridden by the user specified table. NB: the 'name' field *must* be
513 * in alphabetical order because it will be searched using OBJ_search.
516 static const X509_VERIFY_PARAM default_table[] = {
518 "default", /* X509 default parameters */
520 0, /* internal flags */
528 "pkcs7", /* S/MIME sign parameters */
530 0, /* internal flags */
532 X509_PURPOSE_SMIME_SIGN, /* purpose */
533 X509_TRUST_EMAIL, /* trust */
538 "smime_sign", /* S/MIME sign parameters */
540 0, /* internal flags */
542 X509_PURPOSE_SMIME_SIGN, /* purpose */
543 X509_TRUST_EMAIL, /* trust */
548 "ssl_client", /* SSL/TLS client parameters */
550 0, /* internal flags */
552 X509_PURPOSE_SSL_CLIENT, /* purpose */
553 X509_TRUST_SSL_CLIENT, /* trust */
558 "ssl_server", /* SSL/TLS server parameters */
560 0, /* internal flags */
562 X509_PURPOSE_SSL_SERVER, /* purpose */
563 X509_TRUST_SSL_SERVER, /* trust */
569 static STACK_OF(X509_VERIFY_PARAM) *param_table = NULL;
571 static int table_cmp(const X509_VERIFY_PARAM *a, const X509_VERIFY_PARAM *b)
573 return strcmp(a->name, b->name);
576 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
577 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
579 static int param_cmp(const X509_VERIFY_PARAM *const *a,
580 const X509_VERIFY_PARAM *const *b)
582 return strcmp((*a)->name, (*b)->name);
585 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param)
588 X509_VERIFY_PARAM *ptmp;
590 param_table = sk_X509_VERIFY_PARAM_new(param_cmp);
594 idx = sk_X509_VERIFY_PARAM_find(param_table, param);
596 ptmp = sk_X509_VERIFY_PARAM_value(param_table, idx);
597 X509_VERIFY_PARAM_free(ptmp);
598 (void)sk_X509_VERIFY_PARAM_delete(param_table, idx);
601 if (!sk_X509_VERIFY_PARAM_push(param_table, param))
606 int X509_VERIFY_PARAM_get_count(void)
608 int num = sizeof(default_table) / sizeof(X509_VERIFY_PARAM);
610 num += sk_X509_VERIFY_PARAM_num(param_table);
614 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_get0(int id)
616 int num = sizeof(default_table) / sizeof(X509_VERIFY_PARAM);
618 return default_table + id;
619 return sk_X509_VERIFY_PARAM_value(param_table, id - num);
622 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name)
625 X509_VERIFY_PARAM pm;
627 pm.name = (char *)name;
629 idx = sk_X509_VERIFY_PARAM_find(param_table, &pm);
631 return sk_X509_VERIFY_PARAM_value(param_table, idx);
633 return OBJ_bsearch_table(&pm, default_table,
634 sizeof(default_table) /
635 sizeof(X509_VERIFY_PARAM));
638 void X509_VERIFY_PARAM_table_cleanup(void)
640 sk_X509_VERIFY_PARAM_pop_free(param_table, X509_VERIFY_PARAM_free);