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>
18 #include "internal/x509_int.h"
22 /* X509_VERIFY_PARAM functions */
27 static char *str_copy(const char *s
)
29 return OPENSSL_strdup(s
);
32 static void str_free(char *s
)
37 static int int_x509_param_set_hosts(X509_VERIFY_PARAM
*vpm
, int mode
,
38 const char *name
, size_t namelen
)
43 * Refuse names with embedded NUL bytes, except perhaps as final byte.
44 * XXX: Do we need to push an error onto the error stack?
46 if (namelen
== 0 || name
== NULL
)
47 namelen
= name
? strlen(name
) : 0;
48 else if (name
&& memchr(name
, '\0', namelen
> 1 ? namelen
- 1 : namelen
))
50 if (namelen
> 0 && name
[namelen
- 1] == '\0')
53 if (mode
== SET_HOST
) {
54 sk_OPENSSL_STRING_pop_free(vpm
->hosts
, str_free
);
57 if (name
== NULL
|| namelen
== 0)
60 copy
= OPENSSL_strndup(name
, namelen
);
64 if (vpm
->hosts
== NULL
&&
65 (vpm
->hosts
= sk_OPENSSL_STRING_new_null()) == NULL
) {
70 if (!sk_OPENSSL_STRING_push(vpm
->hosts
, copy
)) {
72 if (sk_OPENSSL_STRING_num(vpm
->hosts
) == 0) {
73 sk_OPENSSL_STRING_free(vpm
->hosts
);
83 X509_VERIFY_PARAM
*X509_VERIFY_PARAM_new(void)
85 X509_VERIFY_PARAM
*param
;
87 param
= OPENSSL_zalloc(sizeof(*param
));
90 param
->trust
= X509_TRUST_DEFAULT
;
92 * param->inh_flags = X509_VP_FLAG_DEFAULT;
96 param
->auth_level
= -1; /* -1 means unset, 0 is explicit */
100 void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM
*param
)
104 sk_ASN1_OBJECT_pop_free(param
->policies
, ASN1_OBJECT_free
);
105 sk_OPENSSL_STRING_pop_free(param
->hosts
, str_free
);
106 OPENSSL_free(param
->peername
);
107 OPENSSL_free(param
->email
);
108 OPENSSL_free(param
->ip
);
113 * This function determines how parameters are "inherited" from one structure
114 * to another. There are several different ways this can happen.
116 * 1. If a child structure needs to have its values initialized from a parent
117 * they are simply copied across. For example SSL_CTX copied to SSL.
118 * 2. If the structure should take on values only if they are currently unset.
119 * For example the values in an SSL structure will take appropriate value
120 * for SSL servers or clients but only if the application has not set new
123 * The "inh_flags" field determines how this function behaves.
125 * Normally any values which are set in the default are not copied from the
126 * destination and verify flags are ORed together.
128 * If X509_VP_FLAG_DEFAULT is set then anything set in the source is copied
129 * to the destination. Effectively the values in "to" become default values
130 * which will be used only if nothing new is set in "from".
132 * If X509_VP_FLAG_OVERWRITE is set then all value are copied across whether
133 * they are set or not. Flags is still Ored though.
135 * If X509_VP_FLAG_RESET_FLAGS is set then the flags value is copied instead
138 * If X509_VP_FLAG_LOCKED is set then no values are copied.
140 * If X509_VP_FLAG_ONCE is set then the current inh_flags setting is zeroed
141 * after the next call.
144 /* Macro to test if a field should be copied from src to dest */
146 #define test_x509_verify_param_copy(field, def) \
148 ((src->field != def) && (to_default || (dest->field == def))))
150 /* Macro to test and copy a field if necessary */
152 #define x509_verify_param_copy(field, def) \
153 if (test_x509_verify_param_copy(field, def)) \
154 dest->field = src->field
156 int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM
*dest
,
157 const X509_VERIFY_PARAM
*src
)
159 unsigned long inh_flags
;
160 int to_default
, to_overwrite
;
163 inh_flags
= dest
->inh_flags
| src
->inh_flags
;
165 if (inh_flags
& X509_VP_FLAG_ONCE
)
168 if (inh_flags
& X509_VP_FLAG_LOCKED
)
171 if (inh_flags
& X509_VP_FLAG_DEFAULT
)
176 if (inh_flags
& X509_VP_FLAG_OVERWRITE
)
181 x509_verify_param_copy(purpose
, 0);
182 x509_verify_param_copy(trust
, X509_TRUST_DEFAULT
);
183 x509_verify_param_copy(depth
, -1);
184 x509_verify_param_copy(auth_level
, -1);
186 /* If overwrite or check time not set, copy across */
188 if (to_overwrite
|| !(dest
->flags
& X509_V_FLAG_USE_CHECK_TIME
)) {
189 dest
->check_time
= src
->check_time
;
190 dest
->flags
&= ~X509_V_FLAG_USE_CHECK_TIME
;
191 /* Don't need to copy flag: that is done below */
194 if (inh_flags
& X509_VP_FLAG_RESET_FLAGS
)
197 dest
->flags
|= src
->flags
;
199 if (test_x509_verify_param_copy(policies
, NULL
)) {
200 if (!X509_VERIFY_PARAM_set1_policies(dest
, src
->policies
))
204 /* Copy the host flags if and only if we're copying the host list */
205 if (test_x509_verify_param_copy(hosts
, NULL
)) {
206 sk_OPENSSL_STRING_pop_free(dest
->hosts
, str_free
);
210 sk_OPENSSL_STRING_deep_copy(src
->hosts
, str_copy
, str_free
);
211 if (dest
->hosts
== NULL
)
213 dest
->hostflags
= src
->hostflags
;
217 if (test_x509_verify_param_copy(email
, NULL
)) {
218 if (!X509_VERIFY_PARAM_set1_email(dest
, src
->email
, src
->emaillen
))
222 if (test_x509_verify_param_copy(ip
, NULL
)) {
223 if (!X509_VERIFY_PARAM_set1_ip(dest
, src
->ip
, src
->iplen
))
230 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM
*to
,
231 const X509_VERIFY_PARAM
*from
)
233 unsigned long save_flags
= to
->inh_flags
;
235 to
->inh_flags
|= X509_VP_FLAG_DEFAULT
;
236 ret
= X509_VERIFY_PARAM_inherit(to
, from
);
237 to
->inh_flags
= save_flags
;
241 static int int_x509_param_set1(char **pdest
, size_t *pdestlen
,
242 const char *src
, size_t srclen
)
247 srclen
= strlen(src
);
249 tmp
= OPENSSL_memdup(src
, srclen
);
256 OPENSSL_free(*pdest
);
258 if (pdestlen
!= NULL
)
263 int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM
*param
, const char *name
)
265 OPENSSL_free(param
->name
);
266 param
->name
= OPENSSL_strdup(name
);
272 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM
*param
, unsigned long flags
)
274 param
->flags
|= flags
;
275 if (flags
& X509_V_FLAG_POLICY_MASK
)
276 param
->flags
|= X509_V_FLAG_POLICY_CHECK
;
280 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM
*param
,
283 param
->flags
&= ~flags
;
287 unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM
*param
)
292 uint32_t X509_VERIFY_PARAM_get_inh_flags(const X509_VERIFY_PARAM
*param
)
294 return param
->inh_flags
;
297 int X509_VERIFY_PARAM_set_inh_flags(X509_VERIFY_PARAM
*param
, uint32_t flags
)
299 param
->inh_flags
= flags
;
303 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM
*param
, int purpose
)
305 return X509_PURPOSE_set(¶m
->purpose
, purpose
);
308 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM
*param
, int trust
)
310 return X509_TRUST_set(¶m
->trust
, trust
);
313 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM
*param
, int depth
)
315 param
->depth
= depth
;
318 void X509_VERIFY_PARAM_set_auth_level(X509_VERIFY_PARAM
*param
, int auth_level
)
320 param
->auth_level
= auth_level
;
323 time_t X509_VERIFY_PARAM_get_time(const X509_VERIFY_PARAM
*param
)
325 return param
->check_time
;
328 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM
*param
, time_t t
)
330 param
->check_time
= t
;
331 param
->flags
|= X509_V_FLAG_USE_CHECK_TIME
;
334 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM
*param
,
337 if (!param
->policies
) {
338 param
->policies
= sk_ASN1_OBJECT_new_null();
339 if (!param
->policies
)
342 if (!sk_ASN1_OBJECT_push(param
->policies
, policy
))
347 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM
*param
,
348 STACK_OF(ASN1_OBJECT
) *policies
)
351 ASN1_OBJECT
*oid
, *doid
;
355 sk_ASN1_OBJECT_pop_free(param
->policies
, ASN1_OBJECT_free
);
358 param
->policies
= NULL
;
362 param
->policies
= sk_ASN1_OBJECT_new_null();
363 if (!param
->policies
)
366 for (i
= 0; i
< sk_ASN1_OBJECT_num(policies
); i
++) {
367 oid
= sk_ASN1_OBJECT_value(policies
, i
);
371 if (!sk_ASN1_OBJECT_push(param
->policies
, doid
)) {
372 ASN1_OBJECT_free(doid
);
376 param
->flags
|= X509_V_FLAG_POLICY_CHECK
;
380 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM
*param
,
381 const char *name
, size_t namelen
)
383 return int_x509_param_set_hosts(param
, SET_HOST
, name
, namelen
);
386 int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM
*param
,
387 const char *name
, size_t namelen
)
389 return int_x509_param_set_hosts(param
, ADD_HOST
, name
, namelen
);
392 void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM
*param
,
395 param
->hostflags
= flags
;
398 char *X509_VERIFY_PARAM_get0_peername(X509_VERIFY_PARAM
*param
)
400 return param
->peername
;
404 * Move peername from one param structure to another, freeing any name present
405 * at the target. If the source is a NULL parameter structure, free and zero
406 * the target peername.
408 void X509_VERIFY_PARAM_move_peername(X509_VERIFY_PARAM
*to
,
409 X509_VERIFY_PARAM
*from
)
411 char *peername
= (from
!= NULL
) ? from
->peername
: NULL
;
413 if (to
->peername
!= peername
) {
414 OPENSSL_free(to
->peername
);
415 to
->peername
= peername
;
418 from
->peername
= NULL
;
421 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM
*param
,
422 const char *email
, size_t emaillen
)
424 return int_x509_param_set1(¶m
->email
, ¶m
->emaillen
,
428 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM
*param
,
429 const unsigned char *ip
, size_t iplen
)
431 if (iplen
!= 0 && iplen
!= 4 && iplen
!= 16)
433 return int_x509_param_set1((char **)¶m
->ip
, ¶m
->iplen
,
437 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM
*param
, const char *ipasc
)
439 unsigned char ipout
[16];
442 iplen
= (size_t)a2i_ipadd(ipout
, ipasc
);
445 return X509_VERIFY_PARAM_set1_ip(param
, ipout
, iplen
);
448 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM
*param
)
453 int X509_VERIFY_PARAM_get_auth_level(const X509_VERIFY_PARAM
*param
)
455 return param
->auth_level
;
458 const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM
*param
)
463 #define vpm_empty_id NULL, 0U, NULL, NULL, 0, NULL, 0
466 * Default verify parameters: these are used for various applications and can
467 * be overridden by the user specified table. NB: the 'name' field *must* be
468 * in alphabetical order because it will be searched using OBJ_search.
471 static const X509_VERIFY_PARAM default_table
[] = {
473 "default", /* X509 default parameters */
475 0, /* internal flags */
476 X509_V_FLAG_TRUSTED_FIRST
, /* flags */
484 "pkcs7", /* S/MIME sign parameters */
486 0, /* internal flags */
488 X509_PURPOSE_SMIME_SIGN
, /* purpose */
489 X509_TRUST_EMAIL
, /* trust */
495 "smime_sign", /* S/MIME sign parameters */
497 0, /* internal flags */
499 X509_PURPOSE_SMIME_SIGN
, /* purpose */
500 X509_TRUST_EMAIL
, /* trust */
506 "ssl_client", /* SSL/TLS client parameters */
508 0, /* internal flags */
510 X509_PURPOSE_SSL_CLIENT
, /* purpose */
511 X509_TRUST_SSL_CLIENT
, /* trust */
517 "ssl_server", /* SSL/TLS server parameters */
519 0, /* internal flags */
521 X509_PURPOSE_SSL_SERVER
, /* purpose */
522 X509_TRUST_SSL_SERVER
, /* trust */
529 static STACK_OF(X509_VERIFY_PARAM
) *param_table
= NULL
;
531 static int table_cmp(const X509_VERIFY_PARAM
*a
, const X509_VERIFY_PARAM
*b
)
533 return strcmp(a
->name
, b
->name
);
536 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM
, X509_VERIFY_PARAM
, table
);
537 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM
, X509_VERIFY_PARAM
, table
);
539 static int param_cmp(const X509_VERIFY_PARAM
*const *a
,
540 const X509_VERIFY_PARAM
*const *b
)
542 return strcmp((*a
)->name
, (*b
)->name
);
545 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM
*param
)
548 X509_VERIFY_PARAM
*ptmp
;
549 if (param_table
== NULL
) {
550 param_table
= sk_X509_VERIFY_PARAM_new(param_cmp
);
551 if (param_table
== NULL
)
554 idx
= sk_X509_VERIFY_PARAM_find(param_table
, param
);
556 ptmp
= sk_X509_VERIFY_PARAM_value(param_table
, idx
);
557 X509_VERIFY_PARAM_free(ptmp
);
558 (void)sk_X509_VERIFY_PARAM_delete(param_table
, idx
);
561 if (!sk_X509_VERIFY_PARAM_push(param_table
, param
))
566 int X509_VERIFY_PARAM_get_count(void)
568 int num
= OSSL_NELEM(default_table
);
570 num
+= sk_X509_VERIFY_PARAM_num(param_table
);
574 const X509_VERIFY_PARAM
*X509_VERIFY_PARAM_get0(int id
)
576 int num
= OSSL_NELEM(default_table
);
578 return default_table
+ id
;
579 return sk_X509_VERIFY_PARAM_value(param_table
, id
- num
);
582 const X509_VERIFY_PARAM
*X509_VERIFY_PARAM_lookup(const char *name
)
585 X509_VERIFY_PARAM pm
;
587 pm
.name
= (char *)name
;
589 idx
= sk_X509_VERIFY_PARAM_find(param_table
, &pm
);
591 return sk_X509_VERIFY_PARAM_value(param_table
, idx
);
593 return OBJ_bsearch_table(&pm
, default_table
, OSSL_NELEM(default_table
));
596 void X509_VERIFY_PARAM_table_cleanup(void)
598 sk_X509_VERIFY_PARAM_pop_free(param_table
, X509_VERIFY_PARAM_free
);