2 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
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).
61 #include "internal/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>
70 /* X509_VERIFY_PARAM functions */
75 static char *str_copy(const char *s)
77 return OPENSSL_strdup(s);
80 static void str_free(char *s)
85 static int int_x509_param_set_hosts(X509_VERIFY_PARAM *vpm, int mode,
86 const char *name, size_t namelen)
91 * Refuse names with embedded NUL bytes, except perhaps as final byte.
92 * XXX: Do we need to push an error onto the error stack?
94 if (namelen == 0 || name == NULL)
95 namelen = name ? strlen(name) : 0;
96 else if (name && memchr(name, '\0', namelen > 1 ? namelen - 1 : namelen))
98 if (namelen > 0 && name[namelen - 1] == '\0')
101 if (mode == SET_HOST) {
102 sk_OPENSSL_STRING_pop_free(vpm->hosts, str_free);
105 if (name == NULL || namelen == 0)
108 copy = OPENSSL_strndup(name, namelen);
112 if (vpm->hosts == NULL &&
113 (vpm->hosts = sk_OPENSSL_STRING_new_null()) == NULL) {
118 if (!sk_OPENSSL_STRING_push(vpm->hosts, copy)) {
120 if (sk_OPENSSL_STRING_num(vpm->hosts) == 0) {
121 sk_OPENSSL_STRING_free(vpm->hosts);
130 static void x509_verify_param_zero(X509_VERIFY_PARAM *param)
136 param->trust = X509_TRUST_DEFAULT;
138 * param->inh_flags = X509_VP_FLAG_DEFAULT;
140 param->inh_flags = 0;
143 param->auth_level = -1; /* -1 means unset, 0 is explicit */
144 sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
145 param->policies = NULL;
146 sk_OPENSSL_STRING_pop_free(param->hosts, str_free);
148 OPENSSL_free(param->peername);
149 param->peername = NULL;
150 OPENSSL_free(param->email);
153 OPENSSL_free(param->ip);
158 X509_VERIFY_PARAM *X509_VERIFY_PARAM_new(void)
160 X509_VERIFY_PARAM *param;
162 param = OPENSSL_zalloc(sizeof(*param));
165 x509_verify_param_zero(param);
169 void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM *param)
173 x509_verify_param_zero(param);
178 * This function determines how parameters are "inherited" from one structure
179 * to another. There are several different ways this can happen.
181 * 1. If a child structure needs to have its values initialized from a parent
182 * they are simply copied across. For example SSL_CTX copied to SSL.
183 * 2. If the structure should take on values only if they are currently unset.
184 * For example the values in an SSL structure will take appropriate value
185 * for SSL servers or clients but only if the application has not set new
188 * The "inh_flags" field determines how this function behaves.
190 * Normally any values which are set in the default are not copied from the
191 * destination and verify flags are ORed together.
193 * If X509_VP_FLAG_DEFAULT is set then anything set in the source is copied
194 * to the destination. Effectively the values in "to" become default values
195 * which will be used only if nothing new is set in "from".
197 * If X509_VP_FLAG_OVERWRITE is set then all value are copied across whether
198 * they are set or not. Flags is still Ored though.
200 * If X509_VP_FLAG_RESET_FLAGS is set then the flags value is copied instead
203 * If X509_VP_FLAG_LOCKED is set then no values are copied.
205 * If X509_VP_FLAG_ONCE is set then the current inh_flags setting is zeroed
206 * after the next call.
209 /* Macro to test if a field should be copied from src to dest */
211 #define test_x509_verify_param_copy(field, def) \
213 ((src->field != def) && (to_default || (dest->field == def))))
215 /* Macro to test and copy a field if necessary */
217 #define x509_verify_param_copy(field, def) \
218 if (test_x509_verify_param_copy(field, def)) \
219 dest->field = src->field
221 int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM *dest,
222 const X509_VERIFY_PARAM *src)
224 unsigned long inh_flags;
225 int to_default, to_overwrite;
228 inh_flags = dest->inh_flags | src->inh_flags;
230 if (inh_flags & X509_VP_FLAG_ONCE)
233 if (inh_flags & X509_VP_FLAG_LOCKED)
236 if (inh_flags & X509_VP_FLAG_DEFAULT)
241 if (inh_flags & X509_VP_FLAG_OVERWRITE)
246 x509_verify_param_copy(purpose, 0);
247 x509_verify_param_copy(trust, X509_TRUST_DEFAULT);
248 x509_verify_param_copy(depth, -1);
249 x509_verify_param_copy(auth_level, -1);
251 /* If overwrite or check time not set, copy across */
253 if (to_overwrite || !(dest->flags & X509_V_FLAG_USE_CHECK_TIME)) {
254 dest->check_time = src->check_time;
255 dest->flags &= ~X509_V_FLAG_USE_CHECK_TIME;
256 /* Don't need to copy flag: that is done below */
259 if (inh_flags & X509_VP_FLAG_RESET_FLAGS)
262 dest->flags |= src->flags;
264 if (test_x509_verify_param_copy(policies, NULL)) {
265 if (!X509_VERIFY_PARAM_set1_policies(dest, src->policies))
269 /* Copy the host flags if and only if we're copying the host list */
270 if (test_x509_verify_param_copy(hosts, NULL)) {
271 sk_OPENSSL_STRING_pop_free(dest->hosts, str_free);
275 sk_OPENSSL_STRING_deep_copy(src->hosts, str_copy, str_free);
276 if (dest->hosts == NULL)
278 dest->hostflags = src->hostflags;
282 if (test_x509_verify_param_copy(email, NULL)) {
283 if (!X509_VERIFY_PARAM_set1_email(dest, src->email, src->emaillen))
287 if (test_x509_verify_param_copy(ip, NULL)) {
288 if (!X509_VERIFY_PARAM_set1_ip(dest, src->ip, src->iplen))
295 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to,
296 const X509_VERIFY_PARAM *from)
298 unsigned long save_flags = to->inh_flags;
300 to->inh_flags |= X509_VP_FLAG_DEFAULT;
301 ret = X509_VERIFY_PARAM_inherit(to, from);
302 to->inh_flags = save_flags;
306 static int int_x509_param_set1(char **pdest, size_t *pdestlen,
307 const char *src, size_t srclen)
312 tmp = OPENSSL_strdup(src);
313 srclen = strlen(src);
315 tmp = OPENSSL_memdup(src, srclen);
322 OPENSSL_free(*pdest);
329 int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name)
331 OPENSSL_free(param->name);
332 param->name = OPENSSL_strdup(name);
338 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags)
340 param->flags |= flags;
341 if (flags & X509_V_FLAG_POLICY_MASK)
342 param->flags |= X509_V_FLAG_POLICY_CHECK;
346 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param,
349 param->flags &= ~flags;
353 unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM *param)
358 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose)
360 return X509_PURPOSE_set(¶m->purpose, purpose);
363 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust)
365 return X509_TRUST_set(¶m->trust, trust);
368 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth)
370 param->depth = depth;
373 void X509_VERIFY_PARAM_set_auth_level(X509_VERIFY_PARAM *param, int auth_level)
375 param->auth_level = auth_level;
378 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t)
380 param->check_time = t;
381 param->flags |= X509_V_FLAG_USE_CHECK_TIME;
384 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param,
387 if (!param->policies) {
388 param->policies = sk_ASN1_OBJECT_new_null();
389 if (!param->policies)
392 if (!sk_ASN1_OBJECT_push(param->policies, policy))
397 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
398 STACK_OF(ASN1_OBJECT) *policies)
401 ASN1_OBJECT *oid, *doid;
405 sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
408 param->policies = NULL;
412 param->policies = sk_ASN1_OBJECT_new_null();
413 if (!param->policies)
416 for (i = 0; i < sk_ASN1_OBJECT_num(policies); i++) {
417 oid = sk_ASN1_OBJECT_value(policies, i);
421 if (!sk_ASN1_OBJECT_push(param->policies, doid)) {
422 ASN1_OBJECT_free(doid);
426 param->flags |= X509_V_FLAG_POLICY_CHECK;
430 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
431 const char *name, size_t namelen)
433 return int_x509_param_set_hosts(param, SET_HOST, name, namelen);
436 int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param,
437 const char *name, size_t namelen)
439 return int_x509_param_set_hosts(param, ADD_HOST, name, namelen);
442 void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
445 param->hostflags = flags;
448 char *X509_VERIFY_PARAM_get0_peername(X509_VERIFY_PARAM *param)
450 return param->peername;
454 * Move peername from one param structure to another, freeing any name present
455 * at the target. If the source is a NULL parameter structure, free and zero
456 * the target peername.
458 void X509_VERIFY_PARAM_move_peername(X509_VERIFY_PARAM *to,
459 X509_VERIFY_PARAM *from)
461 char *peername = (from != NULL) ? from->peername : NULL;
463 if (to->peername != peername) {
464 OPENSSL_free(to->peername);
465 to->peername = peername;
468 from->peername = NULL;
471 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
472 const char *email, size_t emaillen)
474 return int_x509_param_set1(¶m->email, ¶m->emaillen,
478 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
479 const unsigned char *ip, size_t iplen)
481 if (iplen != 0 && iplen != 4 && iplen != 16)
483 return int_x509_param_set1((char **)¶m->ip, ¶m->iplen,
487 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param, const char *ipasc)
489 unsigned char ipout[16];
492 iplen = (size_t)a2i_ipadd(ipout, ipasc);
495 return X509_VERIFY_PARAM_set1_ip(param, ipout, iplen);
498 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param)
503 int X509_VERIFY_PARAM_get_auth_level(const X509_VERIFY_PARAM *param)
505 return param->auth_level;
508 const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM *param)
513 #define vpm_empty_id NULL, 0U, NULL, NULL, 0, NULL, 0
516 * Default verify parameters: these are used for various applications and can
517 * be overridden by the user specified table. NB: the 'name' field *must* be
518 * in alphabetical order because it will be searched using OBJ_search.
521 static const X509_VERIFY_PARAM default_table[] = {
523 "default", /* X509 default parameters */
525 0, /* internal flags */
526 X509_V_FLAG_TRUSTED_FIRST, /* flags */
534 "pkcs7", /* S/MIME sign parameters */
536 0, /* internal flags */
538 X509_PURPOSE_SMIME_SIGN, /* purpose */
539 X509_TRUST_EMAIL, /* trust */
545 "smime_sign", /* S/MIME sign parameters */
547 0, /* internal flags */
549 X509_PURPOSE_SMIME_SIGN, /* purpose */
550 X509_TRUST_EMAIL, /* trust */
556 "ssl_client", /* SSL/TLS client parameters */
558 0, /* internal flags */
560 X509_PURPOSE_SSL_CLIENT, /* purpose */
561 X509_TRUST_SSL_CLIENT, /* trust */
567 "ssl_server", /* SSL/TLS server parameters */
569 0, /* internal flags */
571 X509_PURPOSE_SSL_SERVER, /* purpose */
572 X509_TRUST_SSL_SERVER, /* trust */
579 static STACK_OF(X509_VERIFY_PARAM) *param_table = NULL;
581 static int table_cmp(const X509_VERIFY_PARAM *a, const X509_VERIFY_PARAM *b)
583 return strcmp(a->name, b->name);
586 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
587 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
589 static int param_cmp(const X509_VERIFY_PARAM *const *a,
590 const X509_VERIFY_PARAM *const *b)
592 return strcmp((*a)->name, (*b)->name);
595 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param)
598 X509_VERIFY_PARAM *ptmp;
599 if (param_table == NULL) {
600 param_table = sk_X509_VERIFY_PARAM_new(param_cmp);
601 if (param_table == NULL)
604 idx = sk_X509_VERIFY_PARAM_find(param_table, param);
606 ptmp = sk_X509_VERIFY_PARAM_value(param_table, idx);
607 X509_VERIFY_PARAM_free(ptmp);
608 (void)sk_X509_VERIFY_PARAM_delete(param_table, idx);
611 if (!sk_X509_VERIFY_PARAM_push(param_table, param))
616 int X509_VERIFY_PARAM_get_count(void)
618 int num = OSSL_NELEM(default_table);
620 num += sk_X509_VERIFY_PARAM_num(param_table);
624 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_get0(int id)
626 int num = OSSL_NELEM(default_table);
628 return default_table + id;
629 return sk_X509_VERIFY_PARAM_value(param_table, id - num);
632 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name)
635 X509_VERIFY_PARAM pm;
637 pm.name = (char *)name;
639 idx = sk_X509_VERIFY_PARAM_find(param_table, &pm);
641 return sk_X509_VERIFY_PARAM_value(param_table, idx);
643 return OBJ_bsearch_table(&pm, default_table, OSSL_NELEM(default_table));
646 void X509_VERIFY_PARAM_table_cleanup(void)
648 sk_X509_VERIFY_PARAM_pop_free(param_table, X509_VERIFY_PARAM_free);