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 if (paramid->peername)
153 OPENSSL_free(paramid->peername);
154 if (paramid->email) {
155 OPENSSL_free(paramid->email);
156 paramid->email = NULL;
157 paramid->emaillen = 0;
160 OPENSSL_free(paramid->ip);
167 X509_VERIFY_PARAM *X509_VERIFY_PARAM_new(void)
169 X509_VERIFY_PARAM *param;
170 X509_VERIFY_PARAM_ID *paramid;
171 param = OPENSSL_malloc(sizeof(X509_VERIFY_PARAM));
174 paramid = OPENSSL_malloc(sizeof(X509_VERIFY_PARAM));
179 memset(param, 0, sizeof(X509_VERIFY_PARAM));
180 memset(paramid, 0, sizeof(X509_VERIFY_PARAM_ID));
182 x509_verify_param_zero(param);
186 void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM *param)
190 x509_verify_param_zero(param);
191 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
244 int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM *dest,
245 const X509_VERIFY_PARAM *src)
247 unsigned long inh_flags;
248 int to_default, to_overwrite;
249 X509_VERIFY_PARAM_ID *id;
253 inh_flags = dest->inh_flags | src->inh_flags;
255 if (inh_flags & X509_VP_FLAG_ONCE)
258 if (inh_flags & X509_VP_FLAG_LOCKED)
261 if (inh_flags & X509_VP_FLAG_DEFAULT)
266 if (inh_flags & X509_VP_FLAG_OVERWRITE)
271 x509_verify_param_copy(purpose, 0);
272 x509_verify_param_copy(trust, 0);
273 x509_verify_param_copy(depth, -1);
275 /* If overwrite or check time not set, copy across */
277 if (to_overwrite || !(dest->flags & X509_V_FLAG_USE_CHECK_TIME)) {
278 dest->check_time = src->check_time;
279 dest->flags &= ~X509_V_FLAG_USE_CHECK_TIME;
280 /* Don't need to copy flag: that is done below */
283 if (inh_flags & X509_VP_FLAG_RESET_FLAGS)
286 dest->flags |= src->flags;
288 if (test_x509_verify_param_copy(policies, NULL)) {
289 if (!X509_VERIFY_PARAM_set1_policies(dest, src->policies))
293 /* Copy the host flags if and only if we're copying the host list */
294 if (test_x509_verify_param_copy_id(hosts, NULL)) {
295 if (dest->id->hosts) {
296 string_stack_free(dest->id->hosts);
297 dest->id->hosts = NULL;
301 sk_OPENSSL_STRING_deep_copy(id->hosts, str_copy, str_free);
302 if (dest->id->hosts == NULL)
304 dest->id->hostflags = id->hostflags;
308 if (test_x509_verify_param_copy_id(email, NULL)) {
309 if (!X509_VERIFY_PARAM_set1_email(dest, id->email, id->emaillen))
313 if (test_x509_verify_param_copy_id(ip, NULL)) {
314 if (!X509_VERIFY_PARAM_set1_ip(dest, id->ip, id->iplen))
321 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to,
322 const X509_VERIFY_PARAM *from)
324 unsigned long save_flags = to->inh_flags;
326 to->inh_flags |= X509_VP_FLAG_DEFAULT;
327 ret = X509_VERIFY_PARAM_inherit(to, from);
328 to->inh_flags = save_flags;
332 static int int_x509_param_set1(char **pdest, size_t *pdestlen,
333 const char *src, size_t srclen)
338 tmp = BUF_strdup(src);
339 srclen = strlen(src);
341 tmp = BUF_memdup(src, srclen);
349 OPENSSL_free(*pdest);
356 int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name)
359 OPENSSL_free(param->name);
360 param->name = BUF_strdup(name);
366 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags)
368 param->flags |= flags;
369 if (flags & X509_V_FLAG_POLICY_MASK)
370 param->flags |= X509_V_FLAG_POLICY_CHECK;
374 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param,
377 param->flags &= ~flags;
381 unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM *param)
386 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose)
388 return X509_PURPOSE_set(¶m->purpose, purpose);
391 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust)
393 return X509_TRUST_set(¶m->trust, trust);
396 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth)
398 param->depth = depth;
401 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t)
403 param->check_time = t;
404 param->flags |= X509_V_FLAG_USE_CHECK_TIME;
407 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param,
410 if (!param->policies) {
411 param->policies = sk_ASN1_OBJECT_new_null();
412 if (!param->policies)
415 if (!sk_ASN1_OBJECT_push(param->policies, policy))
420 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
421 STACK_OF(ASN1_OBJECT) *policies)
424 ASN1_OBJECT *oid, *doid;
428 sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
431 param->policies = NULL;
435 param->policies = sk_ASN1_OBJECT_new_null();
436 if (!param->policies)
439 for (i = 0; i < sk_ASN1_OBJECT_num(policies); i++) {
440 oid = sk_ASN1_OBJECT_value(policies, i);
444 if (!sk_ASN1_OBJECT_push(param->policies, doid)) {
445 ASN1_OBJECT_free(doid);
449 param->flags |= X509_V_FLAG_POLICY_CHECK;
453 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
454 const char *name, size_t namelen)
456 return int_x509_param_set_hosts(param->id, SET_HOST, name, namelen);
459 int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param,
460 const char *name, size_t namelen)
462 return int_x509_param_set_hosts(param->id, ADD_HOST, name, namelen);
465 void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
468 param->id->hostflags = flags;
471 char *X509_VERIFY_PARAM_get0_peername(X509_VERIFY_PARAM *param)
473 return param->id->peername;
476 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
477 const char *email, size_t emaillen)
479 return int_x509_param_set1(¶m->id->email, ¶m->id->emaillen,
483 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
484 const unsigned char *ip, size_t iplen)
486 if (iplen != 0 && iplen != 4 && iplen != 16)
488 return int_x509_param_set1((char **)¶m->id->ip, ¶m->id->iplen,
492 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param, const char *ipasc)
494 unsigned char ipout[16];
497 iplen = (size_t)a2i_ipadd(ipout, ipasc);
500 return X509_VERIFY_PARAM_set1_ip(param, ipout, iplen);
503 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param)
508 const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM *param)
513 static X509_VERIFY_PARAM_ID _empty_id = { NULL, 0U, NULL, NULL, 0, NULL, 0 };
515 #define vpm_empty_id (X509_VERIFY_PARAM_ID *)&_empty_id
518 * Default verify parameters: these are used for various applications and can
519 * be overridden by the user specified table. NB: the 'name' field *must* be
520 * in alphabetical order because it will be searched using OBJ_search.
523 static const X509_VERIFY_PARAM default_table[] = {
525 "default", /* X509 default parameters */
527 0, /* internal flags */
535 "pkcs7", /* S/MIME sign parameters */
537 0, /* internal flags */
539 X509_PURPOSE_SMIME_SIGN, /* purpose */
540 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 */
555 "ssl_client", /* SSL/TLS client parameters */
557 0, /* internal flags */
559 X509_PURPOSE_SSL_CLIENT, /* purpose */
560 X509_TRUST_SSL_CLIENT, /* trust */
565 "ssl_server", /* SSL/TLS server parameters */
567 0, /* internal flags */
569 X509_PURPOSE_SSL_SERVER, /* purpose */
570 X509_TRUST_SSL_SERVER, /* trust */
576 static STACK_OF(X509_VERIFY_PARAM) *param_table = NULL;
578 static int table_cmp(const X509_VERIFY_PARAM *a, const X509_VERIFY_PARAM *b)
580 return strcmp(a->name, b->name);
583 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
584 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
586 static int param_cmp(const X509_VERIFY_PARAM *const *a,
587 const X509_VERIFY_PARAM *const *b)
589 return strcmp((*a)->name, (*b)->name);
592 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param)
595 X509_VERIFY_PARAM *ptmp;
597 param_table = sk_X509_VERIFY_PARAM_new(param_cmp);
601 idx = sk_X509_VERIFY_PARAM_find(param_table, param);
603 ptmp = sk_X509_VERIFY_PARAM_value(param_table, idx);
604 X509_VERIFY_PARAM_free(ptmp);
605 (void)sk_X509_VERIFY_PARAM_delete(param_table, idx);
608 if (!sk_X509_VERIFY_PARAM_push(param_table, param))
613 int X509_VERIFY_PARAM_get_count(void)
615 int num = sizeof(default_table) / sizeof(X509_VERIFY_PARAM);
617 num += sk_X509_VERIFY_PARAM_num(param_table);
621 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_get0(int id)
623 int num = sizeof(default_table) / sizeof(X509_VERIFY_PARAM);
625 return default_table + id;
626 return sk_X509_VERIFY_PARAM_value(param_table, id - num);
629 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name)
632 X509_VERIFY_PARAM pm;
634 pm.name = (char *)name;
636 idx = sk_X509_VERIFY_PARAM_find(param_table, &pm);
638 return sk_X509_VERIFY_PARAM_value(param_table, idx);
640 return OBJ_bsearch_table(&pm, default_table,
641 sizeof(default_table) /
642 sizeof(X509_VERIFY_PARAM));
645 void X509_VERIFY_PARAM_table_cleanup(void)
648 sk_X509_VERIFY_PARAM_pop_free(param_table, X509_VERIFY_PARAM_free);