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).
62 #include "internal/cryptlib.h"
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 static int int_x509_param_set_hosts(X509_VERIFY_PARAM *vpm, int mode,
87 const char *name, size_t namelen)
92 * Refuse names with embedded NUL bytes, except perhaps as final byte.
93 * XXX: Do we need to push an error onto the error stack?
96 namelen = name ? strlen(name) : 0;
97 else if (name && memchr(name, '\0', namelen > 1 ? namelen - 1 : namelen))
99 if (name && name[namelen - 1] == '\0')
102 if (mode == SET_HOST) {
103 sk_OPENSSL_STRING_pop_free(vpm->hosts, str_free);
106 if (name == NULL || namelen == 0)
109 copy = OPENSSL_strndup(name, namelen);
113 if (vpm->hosts == NULL &&
114 (vpm->hosts = sk_OPENSSL_STRING_new_null()) == NULL) {
119 if (!sk_OPENSSL_STRING_push(vpm->hosts, copy)) {
121 if (sk_OPENSSL_STRING_num(vpm->hosts) == 0) {
122 sk_OPENSSL_STRING_free(vpm->hosts);
131 static void x509_verify_param_zero(X509_VERIFY_PARAM *param)
139 * param->inh_flags = X509_VP_FLAG_DEFAULT;
141 param->inh_flags = 0;
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, 0);
248 x509_verify_param_copy(depth, -1);
250 /* If overwrite or check time not set, copy across */
252 if (to_overwrite || !(dest->flags & X509_V_FLAG_USE_CHECK_TIME)) {
253 dest->check_time = src->check_time;
254 dest->flags &= ~X509_V_FLAG_USE_CHECK_TIME;
255 /* Don't need to copy flag: that is done below */
258 if (inh_flags & X509_VP_FLAG_RESET_FLAGS)
261 dest->flags |= src->flags;
263 if (test_x509_verify_param_copy(policies, NULL)) {
264 if (!X509_VERIFY_PARAM_set1_policies(dest, src->policies))
268 /* Copy the host flags if and only if we're copying the host list */
269 if (test_x509_verify_param_copy(hosts, NULL)) {
270 sk_OPENSSL_STRING_pop_free(dest->hosts, str_free);
274 sk_OPENSSL_STRING_deep_copy(src->hosts, str_copy, str_free);
275 if (dest->hosts == NULL)
277 dest->hostflags = src->hostflags;
281 if (test_x509_verify_param_copy(email, NULL)) {
282 if (!X509_VERIFY_PARAM_set1_email(dest, src->email, src->emaillen))
286 if (test_x509_verify_param_copy(ip, NULL)) {
287 if (!X509_VERIFY_PARAM_set1_ip(dest, src->ip, src->iplen))
294 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to,
295 const X509_VERIFY_PARAM *from)
297 unsigned long save_flags = to->inh_flags;
299 to->inh_flags |= X509_VP_FLAG_DEFAULT;
300 ret = X509_VERIFY_PARAM_inherit(to, from);
301 to->inh_flags = save_flags;
305 static int int_x509_param_set1(char **pdest, size_t *pdestlen,
306 const char *src, size_t srclen)
311 tmp = OPENSSL_strdup(src);
312 srclen = strlen(src);
314 tmp = OPENSSL_memdup(src, srclen);
321 OPENSSL_free(*pdest);
328 int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name)
330 OPENSSL_free(param->name);
331 param->name = OPENSSL_strdup(name);
337 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags)
339 param->flags |= flags;
340 if (flags & X509_V_FLAG_POLICY_MASK)
341 param->flags |= X509_V_FLAG_POLICY_CHECK;
345 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param,
348 param->flags &= ~flags;
352 unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM *param)
357 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose)
359 return X509_PURPOSE_set(¶m->purpose, purpose);
362 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust)
364 return X509_TRUST_set(¶m->trust, trust);
367 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth)
369 param->depth = depth;
372 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t)
374 param->check_time = t;
375 param->flags |= X509_V_FLAG_USE_CHECK_TIME;
378 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param,
381 if (!param->policies) {
382 param->policies = sk_ASN1_OBJECT_new_null();
383 if (!param->policies)
386 if (!sk_ASN1_OBJECT_push(param->policies, policy))
391 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
392 STACK_OF(ASN1_OBJECT) *policies)
395 ASN1_OBJECT *oid, *doid;
399 sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
402 param->policies = NULL;
406 param->policies = sk_ASN1_OBJECT_new_null();
407 if (!param->policies)
410 for (i = 0; i < sk_ASN1_OBJECT_num(policies); i++) {
411 oid = sk_ASN1_OBJECT_value(policies, i);
415 if (!sk_ASN1_OBJECT_push(param->policies, doid)) {
416 ASN1_OBJECT_free(doid);
420 param->flags |= X509_V_FLAG_POLICY_CHECK;
424 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
425 const char *name, size_t namelen)
427 return int_x509_param_set_hosts(param, SET_HOST, name, namelen);
430 int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param,
431 const char *name, size_t namelen)
433 return int_x509_param_set_hosts(param, ADD_HOST, name, namelen);
436 void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
439 param->hostflags = flags;
442 char *X509_VERIFY_PARAM_get0_peername(X509_VERIFY_PARAM *param)
444 return param->peername;
448 * Move peername from one param structure to another, freeing any name present
449 * at the target. If the source is a NULL parameter structure, free and zero
450 * the target peername.
452 void X509_VERIFY_PARAM_move_peername(X509_VERIFY_PARAM *to,
453 X509_VERIFY_PARAM *from)
455 char *peername = (from != NULL) ? from->peername : NULL;
457 if (to->peername != peername) {
458 OPENSSL_free(to->peername);
459 to->peername = peername;
462 from->peername = NULL;
465 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
466 const char *email, size_t emaillen)
468 return int_x509_param_set1(¶m->email, ¶m->emaillen,
472 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
473 const unsigned char *ip, size_t iplen)
475 if (iplen != 0 && iplen != 4 && iplen != 16)
477 return int_x509_param_set1((char **)¶m->ip, ¶m->iplen,
481 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param, const char *ipasc)
483 unsigned char ipout[16];
486 iplen = (size_t)a2i_ipadd(ipout, ipasc);
489 return X509_VERIFY_PARAM_set1_ip(param, ipout, iplen);
492 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param)
497 const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM *param)
502 #define vpm_empty_id NULL, 0U, NULL, NULL, 0, NULL, 0
505 * Default verify parameters: these are used for various applications and can
506 * be overridden by the user specified table. NB: the 'name' field *must* be
507 * in alphabetical order because it will be searched using OBJ_search.
510 static const X509_VERIFY_PARAM default_table[] = {
512 "default", /* X509 default parameters */
514 0, /* internal flags */
522 "pkcs7", /* S/MIME sign parameters */
524 0, /* internal flags */
526 X509_PURPOSE_SMIME_SIGN, /* purpose */
527 X509_TRUST_EMAIL, /* trust */
532 "smime_sign", /* S/MIME sign parameters */
534 0, /* internal flags */
536 X509_PURPOSE_SMIME_SIGN, /* purpose */
537 X509_TRUST_EMAIL, /* trust */
542 "ssl_client", /* SSL/TLS client parameters */
544 0, /* internal flags */
546 X509_PURPOSE_SSL_CLIENT, /* purpose */
547 X509_TRUST_SSL_CLIENT, /* trust */
552 "ssl_server", /* SSL/TLS server parameters */
554 0, /* internal flags */
556 X509_PURPOSE_SSL_SERVER, /* purpose */
557 X509_TRUST_SSL_SERVER, /* trust */
563 static STACK_OF(X509_VERIFY_PARAM) *param_table = NULL;
565 static int table_cmp(const X509_VERIFY_PARAM *a, const X509_VERIFY_PARAM *b)
567 return strcmp(a->name, b->name);
570 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
571 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
573 static int param_cmp(const X509_VERIFY_PARAM *const *a,
574 const X509_VERIFY_PARAM *const *b)
576 return strcmp((*a)->name, (*b)->name);
579 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param)
582 X509_VERIFY_PARAM *ptmp;
583 if (param_table == NULL) {
584 param_table = sk_X509_VERIFY_PARAM_new(param_cmp);
585 if (param_table == NULL)
588 idx = sk_X509_VERIFY_PARAM_find(param_table, param);
590 ptmp = sk_X509_VERIFY_PARAM_value(param_table, idx);
591 X509_VERIFY_PARAM_free(ptmp);
592 (void)sk_X509_VERIFY_PARAM_delete(param_table, idx);
595 if (!sk_X509_VERIFY_PARAM_push(param_table, param))
600 int X509_VERIFY_PARAM_get_count(void)
602 int num = OSSL_NELEM(default_table);
604 num += sk_X509_VERIFY_PARAM_num(param_table);
608 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_get0(int id)
610 int num = OSSL_NELEM(default_table);
612 return default_table + id;
613 return sk_X509_VERIFY_PARAM_value(param_table, id - num);
616 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name)
619 X509_VERIFY_PARAM pm;
621 pm.name = (char *)name;
623 idx = sk_X509_VERIFY_PARAM_find(param_table, &pm);
625 return sk_X509_VERIFY_PARAM_value(param_table, idx);
627 return OBJ_bsearch_table(&pm, default_table, OSSL_NELEM(default_table));
630 void X509_VERIFY_PARAM_table_cleanup(void)
632 sk_X509_VERIFY_PARAM_pop_free(param_table, X509_VERIFY_PARAM_free);