2 * Copyright 2004-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
12 #include "internal/cryptlib.h"
13 #include <openssl/crypto.h>
14 #include <openssl/lhash.h>
15 #include <openssl/buffer.h>
16 #include <openssl/x509.h>
17 #include <openssl/x509v3.h>
21 /* X509_VERIFY_PARAM functions */
26 static char *str_copy(const char *s)
28 return OPENSSL_strdup(s);
31 static void str_free(char *s)
36 static int int_x509_param_set_hosts(X509_VERIFY_PARAM *vpm, int mode,
37 const char *name, size_t namelen)
42 * Refuse names with embedded NUL bytes, except perhaps as final byte.
43 * XXX: Do we need to push an error onto the error stack?
45 if (namelen == 0 || name == NULL)
46 namelen = name ? strlen(name) : 0;
47 else if (name && memchr(name, '\0', namelen > 1 ? namelen - 1 : namelen))
49 if (namelen > 0 && name[namelen - 1] == '\0')
52 if (mode == SET_HOST) {
53 sk_OPENSSL_STRING_pop_free(vpm->hosts, str_free);
56 if (name == NULL || namelen == 0)
59 copy = OPENSSL_strndup(name, namelen);
63 if (vpm->hosts == NULL &&
64 (vpm->hosts = sk_OPENSSL_STRING_new_null()) == NULL) {
69 if (!sk_OPENSSL_STRING_push(vpm->hosts, copy)) {
71 if (sk_OPENSSL_STRING_num(vpm->hosts) == 0) {
72 sk_OPENSSL_STRING_free(vpm->hosts);
81 static void x509_verify_param_zero(X509_VERIFY_PARAM *param)
87 param->trust = X509_TRUST_DEFAULT;
89 * param->inh_flags = X509_VP_FLAG_DEFAULT;
94 param->auth_level = -1; /* -1 means unset, 0 is explicit */
95 sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
96 param->policies = NULL;
97 sk_OPENSSL_STRING_pop_free(param->hosts, str_free);
99 OPENSSL_free(param->peername);
100 param->peername = NULL;
101 OPENSSL_free(param->email);
104 OPENSSL_free(param->ip);
109 X509_VERIFY_PARAM *X509_VERIFY_PARAM_new(void)
111 X509_VERIFY_PARAM *param;
113 param = OPENSSL_zalloc(sizeof(*param));
116 x509_verify_param_zero(param);
120 void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM *param)
124 x509_verify_param_zero(param);
129 * This function determines how parameters are "inherited" from one structure
130 * to another. There are several different ways this can happen.
132 * 1. If a child structure needs to have its values initialized from a parent
133 * they are simply copied across. For example SSL_CTX copied to SSL.
134 * 2. If the structure should take on values only if they are currently unset.
135 * For example the values in an SSL structure will take appropriate value
136 * for SSL servers or clients but only if the application has not set new
139 * The "inh_flags" field determines how this function behaves.
141 * Normally any values which are set in the default are not copied from the
142 * destination and verify flags are ORed together.
144 * If X509_VP_FLAG_DEFAULT is set then anything set in the source is copied
145 * to the destination. Effectively the values in "to" become default values
146 * which will be used only if nothing new is set in "from".
148 * If X509_VP_FLAG_OVERWRITE is set then all value are copied across whether
149 * they are set or not. Flags is still Ored though.
151 * If X509_VP_FLAG_RESET_FLAGS is set then the flags value is copied instead
154 * If X509_VP_FLAG_LOCKED is set then no values are copied.
156 * If X509_VP_FLAG_ONCE is set then the current inh_flags setting is zeroed
157 * after the next call.
160 /* Macro to test if a field should be copied from src to dest */
162 #define test_x509_verify_param_copy(field, def) \
164 ((src->field != def) && (to_default || (dest->field == def))))
166 /* Macro to test and copy a field if necessary */
168 #define x509_verify_param_copy(field, def) \
169 if (test_x509_verify_param_copy(field, def)) \
170 dest->field = src->field
172 int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM *dest,
173 const X509_VERIFY_PARAM *src)
175 unsigned long inh_flags;
176 int to_default, to_overwrite;
179 inh_flags = dest->inh_flags | src->inh_flags;
181 if (inh_flags & X509_VP_FLAG_ONCE)
184 if (inh_flags & X509_VP_FLAG_LOCKED)
187 if (inh_flags & X509_VP_FLAG_DEFAULT)
192 if (inh_flags & X509_VP_FLAG_OVERWRITE)
197 x509_verify_param_copy(purpose, 0);
198 x509_verify_param_copy(trust, X509_TRUST_DEFAULT);
199 x509_verify_param_copy(depth, -1);
200 x509_verify_param_copy(auth_level, -1);
202 /* If overwrite or check time not set, copy across */
204 if (to_overwrite || !(dest->flags & X509_V_FLAG_USE_CHECK_TIME)) {
205 dest->check_time = src->check_time;
206 dest->flags &= ~X509_V_FLAG_USE_CHECK_TIME;
207 /* Don't need to copy flag: that is done below */
210 if (inh_flags & X509_VP_FLAG_RESET_FLAGS)
213 dest->flags |= src->flags;
215 if (test_x509_verify_param_copy(policies, NULL)) {
216 if (!X509_VERIFY_PARAM_set1_policies(dest, src->policies))
220 /* Copy the host flags if and only if we're copying the host list */
221 if (test_x509_verify_param_copy(hosts, NULL)) {
222 sk_OPENSSL_STRING_pop_free(dest->hosts, str_free);
226 sk_OPENSSL_STRING_deep_copy(src->hosts, str_copy, str_free);
227 if (dest->hosts == NULL)
229 dest->hostflags = src->hostflags;
233 if (test_x509_verify_param_copy(email, NULL)) {
234 if (!X509_VERIFY_PARAM_set1_email(dest, src->email, src->emaillen))
238 if (test_x509_verify_param_copy(ip, NULL)) {
239 if (!X509_VERIFY_PARAM_set1_ip(dest, src->ip, src->iplen))
246 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to,
247 const X509_VERIFY_PARAM *from)
249 unsigned long save_flags = to->inh_flags;
251 to->inh_flags |= X509_VP_FLAG_DEFAULT;
252 ret = X509_VERIFY_PARAM_inherit(to, from);
253 to->inh_flags = save_flags;
257 static int int_x509_param_set1(char **pdest, size_t *pdestlen,
258 const char *src, size_t srclen)
263 tmp = OPENSSL_strdup(src);
264 srclen = strlen(src);
266 tmp = OPENSSL_memdup(src, srclen);
273 OPENSSL_free(*pdest);
280 int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name)
282 OPENSSL_free(param->name);
283 param->name = OPENSSL_strdup(name);
289 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags)
291 param->flags |= flags;
292 if (flags & X509_V_FLAG_POLICY_MASK)
293 param->flags |= X509_V_FLAG_POLICY_CHECK;
297 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param,
300 param->flags &= ~flags;
304 unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM *param)
309 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose)
311 return X509_PURPOSE_set(¶m->purpose, purpose);
314 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust)
316 return X509_TRUST_set(¶m->trust, trust);
319 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth)
321 param->depth = depth;
324 void X509_VERIFY_PARAM_set_auth_level(X509_VERIFY_PARAM *param, int auth_level)
326 param->auth_level = auth_level;
329 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t)
331 param->check_time = t;
332 param->flags |= X509_V_FLAG_USE_CHECK_TIME;
335 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param,
338 if (!param->policies) {
339 param->policies = sk_ASN1_OBJECT_new_null();
340 if (!param->policies)
343 if (!sk_ASN1_OBJECT_push(param->policies, policy))
348 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
349 STACK_OF(ASN1_OBJECT) *policies)
352 ASN1_OBJECT *oid, *doid;
356 sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
359 param->policies = NULL;
363 param->policies = sk_ASN1_OBJECT_new_null();
364 if (!param->policies)
367 for (i = 0; i < sk_ASN1_OBJECT_num(policies); i++) {
368 oid = sk_ASN1_OBJECT_value(policies, i);
372 if (!sk_ASN1_OBJECT_push(param->policies, doid)) {
373 ASN1_OBJECT_free(doid);
377 param->flags |= X509_V_FLAG_POLICY_CHECK;
381 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
382 const char *name, size_t namelen)
384 return int_x509_param_set_hosts(param, SET_HOST, name, namelen);
387 int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param,
388 const char *name, size_t namelen)
390 return int_x509_param_set_hosts(param, ADD_HOST, name, namelen);
393 void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
396 param->hostflags = flags;
399 char *X509_VERIFY_PARAM_get0_peername(X509_VERIFY_PARAM *param)
401 return param->peername;
405 * Move peername from one param structure to another, freeing any name present
406 * at the target. If the source is a NULL parameter structure, free and zero
407 * the target peername.
409 void X509_VERIFY_PARAM_move_peername(X509_VERIFY_PARAM *to,
410 X509_VERIFY_PARAM *from)
412 char *peername = (from != NULL) ? from->peername : NULL;
414 if (to->peername != peername) {
415 OPENSSL_free(to->peername);
416 to->peername = peername;
419 from->peername = NULL;
422 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
423 const char *email, size_t emaillen)
425 return int_x509_param_set1(¶m->email, ¶m->emaillen,
429 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
430 const unsigned char *ip, size_t iplen)
432 if (iplen != 0 && iplen != 4 && iplen != 16)
434 return int_x509_param_set1((char **)¶m->ip, ¶m->iplen,
438 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param, const char *ipasc)
440 unsigned char ipout[16];
443 iplen = (size_t)a2i_ipadd(ipout, ipasc);
446 return X509_VERIFY_PARAM_set1_ip(param, ipout, iplen);
449 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param)
454 int X509_VERIFY_PARAM_get_auth_level(const X509_VERIFY_PARAM *param)
456 return param->auth_level;
459 const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM *param)
464 #define vpm_empty_id NULL, 0U, NULL, NULL, 0, NULL, 0
467 * Default verify parameters: these are used for various applications and can
468 * be overridden by the user specified table. NB: the 'name' field *must* be
469 * in alphabetical order because it will be searched using OBJ_search.
472 static const X509_VERIFY_PARAM default_table[] = {
474 "default", /* X509 default parameters */
476 0, /* internal flags */
477 X509_V_FLAG_TRUSTED_FIRST, /* flags */
485 "pkcs7", /* S/MIME sign parameters */
487 0, /* internal flags */
489 X509_PURPOSE_SMIME_SIGN, /* purpose */
490 X509_TRUST_EMAIL, /* trust */
496 "smime_sign", /* S/MIME sign parameters */
498 0, /* internal flags */
500 X509_PURPOSE_SMIME_SIGN, /* purpose */
501 X509_TRUST_EMAIL, /* trust */
507 "ssl_client", /* SSL/TLS client parameters */
509 0, /* internal flags */
511 X509_PURPOSE_SSL_CLIENT, /* purpose */
512 X509_TRUST_SSL_CLIENT, /* trust */
518 "ssl_server", /* SSL/TLS server parameters */
520 0, /* internal flags */
522 X509_PURPOSE_SSL_SERVER, /* purpose */
523 X509_TRUST_SSL_SERVER, /* trust */
530 static STACK_OF(X509_VERIFY_PARAM) *param_table = NULL;
532 static int table_cmp(const X509_VERIFY_PARAM *a, const X509_VERIFY_PARAM *b)
534 return strcmp(a->name, b->name);
537 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
538 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
540 static int param_cmp(const X509_VERIFY_PARAM *const *a,
541 const X509_VERIFY_PARAM *const *b)
543 return strcmp((*a)->name, (*b)->name);
546 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param)
549 X509_VERIFY_PARAM *ptmp;
550 if (param_table == NULL) {
551 param_table = sk_X509_VERIFY_PARAM_new(param_cmp);
552 if (param_table == NULL)
555 idx = sk_X509_VERIFY_PARAM_find(param_table, param);
557 ptmp = sk_X509_VERIFY_PARAM_value(param_table, idx);
558 X509_VERIFY_PARAM_free(ptmp);
559 (void)sk_X509_VERIFY_PARAM_delete(param_table, idx);
562 if (!sk_X509_VERIFY_PARAM_push(param_table, param))
567 int X509_VERIFY_PARAM_get_count(void)
569 int num = OSSL_NELEM(default_table);
571 num += sk_X509_VERIFY_PARAM_num(param_table);
575 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_get0(int id)
577 int num = OSSL_NELEM(default_table);
579 return default_table + id;
580 return sk_X509_VERIFY_PARAM_value(param_table, id - num);
583 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name)
586 X509_VERIFY_PARAM pm;
588 pm.name = (char *)name;
590 idx = sk_X509_VERIFY_PARAM_find(param_table, &pm);
592 return sk_X509_VERIFY_PARAM_value(param_table, idx);
594 return OBJ_bsearch_table(&pm, default_table, OSSL_NELEM(default_table));
597 void X509_VERIFY_PARAM_table_cleanup(void)
599 sk_X509_VERIFY_PARAM_pop_free(param_table, X509_VERIFY_PARAM_free);