2 * Copyright 2004-2020 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (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/buffer.h>
15 #include <openssl/x509.h>
16 #include <openssl/x509v3.h>
17 #include "crypto/x509.h"
19 #include "x509_local.h"
21 DEFINE_STACK_OF(ASN1_OBJECT)
22 DEFINE_STACK_OF(X509_VERIFY_PARAM)
23 DEFINE_STACK_OF_STRING()
25 /* X509_VERIFY_PARAM functions */
30 static char *str_copy(const char *s)
32 return OPENSSL_strdup(s);
35 static void str_free(char *s)
40 static int int_x509_param_set_hosts(X509_VERIFY_PARAM *vpm, int mode,
41 const char *name, size_t namelen)
46 * Refuse names with embedded NUL bytes, except perhaps as final byte.
47 * XXX: Do we need to push an error onto the error stack?
49 if (namelen == 0 || name == NULL)
50 namelen = name ? strlen(name) : 0;
51 else if (name && memchr(name, '\0', namelen > 1 ? namelen - 1 : namelen))
53 if (namelen > 0 && name[namelen - 1] == '\0')
56 if (mode == SET_HOST) {
57 sk_OPENSSL_STRING_pop_free(vpm->hosts, str_free);
60 if (name == NULL || namelen == 0)
63 copy = OPENSSL_strndup(name, namelen);
67 if (vpm->hosts == NULL &&
68 (vpm->hosts = sk_OPENSSL_STRING_new_null()) == NULL) {
73 if (!sk_OPENSSL_STRING_push(vpm->hosts, copy)) {
75 if (sk_OPENSSL_STRING_num(vpm->hosts) == 0) {
76 sk_OPENSSL_STRING_free(vpm->hosts);
86 X509_VERIFY_PARAM *X509_VERIFY_PARAM_new(void)
88 X509_VERIFY_PARAM *param;
90 param = OPENSSL_zalloc(sizeof(*param));
92 X509err(X509_F_X509_VERIFY_PARAM_NEW, ERR_R_MALLOC_FAILURE);
95 param->trust = X509_TRUST_DEFAULT;
96 /* param->inh_flags = X509_VP_FLAG_DEFAULT; */
98 param->auth_level = -1; /* -1 means unset, 0 is explicit */
102 void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM *param)
106 sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
107 sk_OPENSSL_STRING_pop_free(param->hosts, str_free);
108 OPENSSL_free(param->peername);
109 OPENSSL_free(param->email);
110 OPENSSL_free(param->ip);
115 * This function determines how parameters are "inherited" from one structure
116 * to another. There are several different ways this can happen.
118 * 1. If a child structure needs to have its values initialized from a parent
119 * they are simply copied across. For example SSL_CTX copied to SSL.
120 * 2. If the structure should take on values only if they are currently unset.
121 * For example the values in an SSL structure will take appropriate value
122 * for SSL servers or clients but only if the application has not set new
125 * The "inh_flags" field determines how this function behaves.
127 * Normally any values which are set in the default are not copied from the
128 * destination and verify flags are ORed together.
130 * If X509_VP_FLAG_DEFAULT is set then anything set in the source is copied
131 * to the destination. Effectively the values in "to" become default values
132 * which will be used only if nothing new is set in "from".
134 * If X509_VP_FLAG_OVERWRITE is set then all value are copied across whether
135 * they are set or not. Flags is still Ored though.
137 * If X509_VP_FLAG_RESET_FLAGS is set then the flags value is copied instead
140 * If X509_VP_FLAG_LOCKED is set then no values are copied.
142 * If X509_VP_FLAG_ONCE is set then the current inh_flags setting is zeroed
143 * after the next call.
146 /* Macro to test if a field should be copied from src to dest */
148 #define test_x509_verify_param_copy(field, def) \
150 || ((src->field != def) && (to_default || (dest->field == def))))
152 /* Macro to test and copy a field if necessary */
154 #define x509_verify_param_copy(field, def) \
155 if (test_x509_verify_param_copy(field, def)) \
156 dest->field = src->field;
158 int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM *dest,
159 const X509_VERIFY_PARAM *src)
161 unsigned long inh_flags;
162 int to_default, to_overwrite;
165 inh_flags = dest->inh_flags | src->inh_flags;
167 if (inh_flags & X509_VP_FLAG_ONCE)
170 if (inh_flags & X509_VP_FLAG_LOCKED)
173 if (inh_flags & X509_VP_FLAG_DEFAULT)
178 if (inh_flags & X509_VP_FLAG_OVERWRITE)
183 x509_verify_param_copy(purpose, 0);
184 x509_verify_param_copy(trust, X509_TRUST_DEFAULT);
185 x509_verify_param_copy(depth, -1);
186 x509_verify_param_copy(auth_level, -1);
188 /* If overwrite or check time not set, copy across */
190 if (to_overwrite || !(dest->flags & X509_V_FLAG_USE_CHECK_TIME)) {
191 dest->check_time = src->check_time;
192 dest->flags &= ~X509_V_FLAG_USE_CHECK_TIME;
193 /* Don't need to copy flag: that is done below */
196 if (inh_flags & X509_VP_FLAG_RESET_FLAGS)
199 dest->flags |= src->flags;
201 if (test_x509_verify_param_copy(policies, NULL)) {
202 if (!X509_VERIFY_PARAM_set1_policies(dest, src->policies))
206 /* Copy the host flags if and only if we're copying the host list */
207 if (test_x509_verify_param_copy(hosts, NULL)) {
208 sk_OPENSSL_STRING_pop_free(dest->hosts, str_free);
212 sk_OPENSSL_STRING_deep_copy(src->hosts, str_copy, str_free);
213 if (dest->hosts == NULL)
215 dest->hostflags = src->hostflags;
219 if (test_x509_verify_param_copy(email, NULL)) {
220 if (!X509_VERIFY_PARAM_set1_email(dest, src->email, src->emaillen))
224 if (test_x509_verify_param_copy(ip, NULL)) {
225 if (!X509_VERIFY_PARAM_set1_ip(dest, src->ip, src->iplen))
232 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to,
233 const X509_VERIFY_PARAM *from)
235 unsigned long save_flags = to->inh_flags;
237 to->inh_flags |= X509_VP_FLAG_DEFAULT;
238 ret = X509_VERIFY_PARAM_inherit(to, from);
239 to->inh_flags = save_flags;
243 static int int_x509_param_set1(char **pdest, size_t *pdestlen,
244 const char *src, size_t srclen)
249 srclen = strlen(src);
251 tmp = OPENSSL_malloc(srclen + 1);
254 memcpy(tmp, src, srclen);
255 tmp[srclen] = '\0'; /* enforce NUL termination */
260 OPENSSL_free(*pdest);
262 if (pdestlen != NULL)
267 int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name)
269 OPENSSL_free(param->name);
270 param->name = OPENSSL_strdup(name);
276 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags)
278 param->flags |= flags;
279 if (flags & X509_V_FLAG_POLICY_MASK)
280 param->flags |= X509_V_FLAG_POLICY_CHECK;
284 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param,
287 param->flags &= ~flags;
291 unsigned long X509_VERIFY_PARAM_get_flags(const X509_VERIFY_PARAM *param)
296 uint32_t X509_VERIFY_PARAM_get_inh_flags(const X509_VERIFY_PARAM *param)
298 return param->inh_flags;
301 int X509_VERIFY_PARAM_set_inh_flags(X509_VERIFY_PARAM *param, uint32_t flags)
303 param->inh_flags = flags;
307 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose)
309 return X509_PURPOSE_set(¶m->purpose, purpose);
312 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust)
314 return X509_TRUST_set(¶m->trust, trust);
317 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth)
319 param->depth = depth;
322 void X509_VERIFY_PARAM_set_auth_level(X509_VERIFY_PARAM *param, int auth_level)
324 param->auth_level = auth_level;
327 time_t X509_VERIFY_PARAM_get_time(const X509_VERIFY_PARAM *param)
329 return param->check_time;
332 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t)
334 param->check_time = t;
335 param->flags |= X509_V_FLAG_USE_CHECK_TIME;
338 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param,
341 if (param->policies == NULL) {
342 param->policies = sk_ASN1_OBJECT_new_null();
343 if (param->policies == NULL)
346 if (!sk_ASN1_OBJECT_push(param->policies, policy))
351 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
352 STACK_OF(ASN1_OBJECT) *policies)
355 ASN1_OBJECT *oid, *doid;
359 sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
361 if (policies == NULL) {
362 param->policies = NULL;
366 param->policies = sk_ASN1_OBJECT_new_null();
367 if (param->policies == NULL)
370 for (i = 0; i < sk_ASN1_OBJECT_num(policies); i++) {
371 oid = sk_ASN1_OBJECT_value(policies, i);
375 if (!sk_ASN1_OBJECT_push(param->policies, doid)) {
376 ASN1_OBJECT_free(doid);
380 param->flags |= X509_V_FLAG_POLICY_CHECK;
384 char *X509_VERIFY_PARAM_get0_host(X509_VERIFY_PARAM *param, int idx)
386 return sk_OPENSSL_STRING_value(param->hosts, idx);
389 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
390 const char *name, size_t namelen)
392 return int_x509_param_set_hosts(param, SET_HOST, name, namelen);
395 int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param,
396 const char *name, size_t namelen)
398 return int_x509_param_set_hosts(param, ADD_HOST, name, namelen);
401 void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
404 param->hostflags = flags;
407 unsigned int X509_VERIFY_PARAM_get_hostflags(const X509_VERIFY_PARAM *param)
409 return param->hostflags;
412 char *X509_VERIFY_PARAM_get0_peername(const X509_VERIFY_PARAM *param)
414 return param->peername;
418 * Move peername from one param structure to another, freeing any name present
419 * at the target. If the source is a NULL parameter structure, free and zero
420 * the target peername.
422 void X509_VERIFY_PARAM_move_peername(X509_VERIFY_PARAM *to,
423 X509_VERIFY_PARAM *from)
425 char *peername = (from != NULL) ? from->peername : NULL;
427 if (to->peername != peername) {
428 OPENSSL_free(to->peername);
429 to->peername = peername;
432 from->peername = NULL;
435 char *X509_VERIFY_PARAM_get0_email(X509_VERIFY_PARAM *param)
440 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
441 const char *email, size_t emaillen)
443 return int_x509_param_set1(¶m->email, ¶m->emaillen,
448 *int_X509_VERIFY_PARAM_get0_ip(X509_VERIFY_PARAM *param, size_t *plen)
450 if (param == NULL || param->ip == NULL)
453 *plen = param->iplen;
457 char *X509_VERIFY_PARAM_get1_ip_asc(X509_VERIFY_PARAM *param)
460 unsigned char *ip = int_X509_VERIFY_PARAM_get0_ip(param, &iplen);
462 return ip == NULL ? NULL : ipaddr_to_asc(ip, iplen);
465 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
466 const unsigned char *ip, size_t iplen)
468 if (iplen != 0 && iplen != 4 && iplen != 16)
470 return int_x509_param_set1((char **)¶m->ip, ¶m->iplen,
474 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param, const char *ipasc)
476 unsigned char ipout[16];
479 iplen = (size_t)a2i_ipadd(ipout, ipasc);
482 return X509_VERIFY_PARAM_set1_ip(param, ipout, iplen);
485 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param)
490 int X509_VERIFY_PARAM_get_auth_level(const X509_VERIFY_PARAM *param)
492 return param->auth_level;
495 const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM *param)
500 #define vpm_empty_id NULL, 0U, NULL, NULL, 0, NULL, 0
503 * Default verify parameters: these are used for various applications and can
504 * be overridden by the user specified table. NB: the 'name' field *must* be
505 * in alphabetical order because it will be searched using OBJ_search.
508 static const X509_VERIFY_PARAM default_table[] = {
510 "default", /* X509 default parameters */
512 0, /* internal flags */
513 X509_V_FLAG_TRUSTED_FIRST, /* flags */
521 "pkcs7", /* S/MIME sign parameters */
523 0, /* internal flags */
525 X509_PURPOSE_SMIME_SIGN, /* purpose */
526 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 */
543 "ssl_client", /* SSL/TLS client parameters */
545 0, /* internal flags */
547 X509_PURPOSE_SSL_CLIENT, /* purpose */
548 X509_TRUST_SSL_CLIENT, /* trust */
554 "ssl_server", /* SSL/TLS server parameters */
556 0, /* internal flags */
558 X509_PURPOSE_SSL_SERVER, /* purpose */
559 X509_TRUST_SSL_SERVER, /* trust */
566 static STACK_OF(X509_VERIFY_PARAM) *param_table = NULL;
568 static int table_cmp(const X509_VERIFY_PARAM *a, const X509_VERIFY_PARAM *b)
570 return strcmp(a->name, b->name);
573 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
574 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
576 static int param_cmp(const X509_VERIFY_PARAM *const *a,
577 const X509_VERIFY_PARAM *const *b)
579 return strcmp((*a)->name, (*b)->name);
582 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param)
585 X509_VERIFY_PARAM *ptmp;
586 if (param_table == NULL) {
587 param_table = sk_X509_VERIFY_PARAM_new(param_cmp);
588 if (param_table == NULL)
591 idx = sk_X509_VERIFY_PARAM_find(param_table, param);
593 ptmp = sk_X509_VERIFY_PARAM_delete(param_table, idx);
594 X509_VERIFY_PARAM_free(ptmp);
597 if (!sk_X509_VERIFY_PARAM_push(param_table, param))
602 int X509_VERIFY_PARAM_get_count(void)
604 int num = OSSL_NELEM(default_table);
606 num += sk_X509_VERIFY_PARAM_num(param_table);
610 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_get0(int id)
612 int num = OSSL_NELEM(default_table);
614 return default_table + id;
615 return sk_X509_VERIFY_PARAM_value(param_table, id - num);
618 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name)
621 X509_VERIFY_PARAM pm;
623 pm.name = (char *)name;
624 if (param_table != NULL) {
625 idx = sk_X509_VERIFY_PARAM_find(param_table, &pm);
627 return sk_X509_VERIFY_PARAM_value(param_table, idx);
629 return OBJ_bsearch_table(&pm, default_table, OSSL_NELEM(default_table));
632 void X509_VERIFY_PARAM_table_cleanup(void)
634 sk_X509_VERIFY_PARAM_pop_free(param_table, X509_VERIFY_PARAM_free);