2 * Copyright 2004-2021 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 /* 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;
48 && memchr(name
, '\0', namelen
> 1 ? namelen
- 1 : namelen
) != NULL
)
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
);
82 X509_VERIFY_PARAM
*X509_VERIFY_PARAM_new(void)
84 X509_VERIFY_PARAM
*param
;
86 param
= OPENSSL_zalloc(sizeof(*param
));
88 ERR_raise(ERR_LIB_X509
, ERR_R_MALLOC_FAILURE
);
91 param
->trust
= X509_TRUST_DEFAULT
;
92 /* param->inh_flags = X509_VP_FLAG_DEFAULT; */
94 param
->auth_level
= -1; /* -1 means unset, 0 is explicit */
98 void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM
*param
)
102 sk_ASN1_OBJECT_pop_free(param
->policies
, ASN1_OBJECT_free
);
103 sk_OPENSSL_STRING_pop_free(param
->hosts
, str_free
);
104 OPENSSL_free(param
->peername
);
105 OPENSSL_free(param
->email
);
106 OPENSSL_free(param
->ip
);
111 * This function determines how parameters are "inherited" from one structure
112 * to another. There are several different ways this can happen.
114 * 1. If a child structure needs to have its values initialized from a parent
115 * they are simply copied across. For example SSL_CTX copied to SSL.
116 * 2. If the structure should take on values only if they are currently unset.
117 * For example the values in an SSL structure will take appropriate value
118 * for SSL servers or clients but only if the application has not set new
121 * The "inh_flags" field determines how this function behaves.
123 * Normally any values which are set in the default are not copied from the
124 * destination and verify flags are ORed together.
126 * If X509_VP_FLAG_DEFAULT is set then anything set in the source is copied
127 * to the destination. Effectively the values in "to" become default values
128 * which will be used only if nothing new is set in "from".
130 * If X509_VP_FLAG_OVERWRITE is set then all value are copied across whether
131 * they are set or not. Flags is still Ored though.
133 * If X509_VP_FLAG_RESET_FLAGS is set then the flags value is copied instead
136 * If X509_VP_FLAG_LOCKED is set then no values are copied.
138 * If X509_VP_FLAG_ONCE is set then the current inh_flags setting is zeroed
139 * after the next call.
142 /* Macro to test if a field should be copied from src to dest */
144 #define test_x509_verify_param_copy(field, def) \
145 (to_overwrite || (src->field != def && (to_default || dest->field == def)))
147 /* Macro to test and copy a field if necessary */
149 #define x509_verify_param_copy(field, def) \
150 if (test_x509_verify_param_copy(field, def)) \
151 dest->field = src->field;
153 int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM
*dest
,
154 const X509_VERIFY_PARAM
*src
)
156 unsigned long inh_flags
;
157 int to_default
, to_overwrite
;
161 inh_flags
= dest
->inh_flags
| src
->inh_flags
;
163 if ((inh_flags
& X509_VP_FLAG_ONCE
) != 0)
166 if ((inh_flags
& X509_VP_FLAG_LOCKED
) != 0)
169 to_default
= (inh_flags
& X509_VP_FLAG_DEFAULT
) != 0;
170 to_overwrite
= (inh_flags
& X509_VP_FLAG_OVERWRITE
) != 0;
172 x509_verify_param_copy(purpose
, 0);
173 x509_verify_param_copy(trust
, X509_TRUST_DEFAULT
);
174 x509_verify_param_copy(depth
, -1);
175 x509_verify_param_copy(auth_level
, -1);
177 /* If overwrite or check time not set, copy across */
179 if (to_overwrite
|| (dest
->flags
& X509_V_FLAG_USE_CHECK_TIME
) == 0) {
180 dest
->check_time
= src
->check_time
;
181 dest
->flags
&= ~X509_V_FLAG_USE_CHECK_TIME
;
182 /* Don't need to copy flag: that is done below */
185 if ((inh_flags
& X509_VP_FLAG_RESET_FLAGS
) != 0)
188 dest
->flags
|= src
->flags
;
190 if (test_x509_verify_param_copy(policies
, NULL
)) {
191 if (!X509_VERIFY_PARAM_set1_policies(dest
, src
->policies
))
195 x509_verify_param_copy(hostflags
, 0);
197 if (test_x509_verify_param_copy(hosts
, NULL
)) {
198 sk_OPENSSL_STRING_pop_free(dest
->hosts
, str_free
);
200 if (src
->hosts
!= NULL
) {
202 sk_OPENSSL_STRING_deep_copy(src
->hosts
, str_copy
, str_free
);
203 if (dest
->hosts
== NULL
)
208 if (test_x509_verify_param_copy(email
, NULL
)) {
209 if (!X509_VERIFY_PARAM_set1_email(dest
, src
->email
, src
->emaillen
))
213 if (test_x509_verify_param_copy(ip
, NULL
)) {
214 if (!X509_VERIFY_PARAM_set1_ip(dest
, src
->ip
, src
->iplen
))
221 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM
*to
,
222 const X509_VERIFY_PARAM
*from
)
224 unsigned long save_flags
;
228 ERR_raise(ERR_LIB_X509
, ERR_R_PASSED_NULL_PARAMETER
);
231 save_flags
= to
->inh_flags
;
232 to
->inh_flags
|= X509_VP_FLAG_DEFAULT
;
233 ret
= X509_VERIFY_PARAM_inherit(to
, from
);
234 to
->inh_flags
= save_flags
;
238 static int int_x509_param_set1(char **pdest
, size_t *pdestlen
,
239 const char *src
, size_t srclen
)
245 srclen
= strlen(src
);
247 tmp
= OPENSSL_malloc(srclen
+ 1);
250 memcpy(tmp
, src
, srclen
);
251 tmp
[srclen
] = '\0'; /* enforce NUL termination */
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
);
267 return param
->name
!= NULL
;
270 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM
*param
, unsigned long flags
)
272 param
->flags
|= flags
;
273 if ((flags
& X509_V_FLAG_POLICY_MASK
) != 0)
274 param
->flags
|= X509_V_FLAG_POLICY_CHECK
;
278 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM
*param
,
281 param
->flags
&= ~flags
;
285 unsigned long X509_VERIFY_PARAM_get_flags(const X509_VERIFY_PARAM
*param
)
290 uint32_t X509_VERIFY_PARAM_get_inh_flags(const X509_VERIFY_PARAM
*param
)
292 return param
->inh_flags
;
295 int X509_VERIFY_PARAM_set_inh_flags(X509_VERIFY_PARAM
*param
, uint32_t flags
)
297 param
->inh_flags
= flags
;
301 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM
*param
, int purpose
)
303 return X509_PURPOSE_set(¶m
->purpose
, purpose
);
306 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM
*param
, int trust
)
308 return X509_TRUST_set(¶m
->trust
, trust
);
311 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM
*param
, int depth
)
313 param
->depth
= depth
;
316 void X509_VERIFY_PARAM_set_auth_level(X509_VERIFY_PARAM
*param
, int auth_level
)
318 param
->auth_level
= auth_level
;
321 time_t X509_VERIFY_PARAM_get_time(const X509_VERIFY_PARAM
*param
)
323 return param
->check_time
;
326 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM
*param
, time_t t
)
328 param
->check_time
= t
;
329 param
->flags
|= X509_V_FLAG_USE_CHECK_TIME
;
332 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM
*param
,
335 if (param
->policies
== NULL
) {
336 param
->policies
= sk_ASN1_OBJECT_new_null();
337 if (param
->policies
== NULL
)
340 return sk_ASN1_OBJECT_push(param
->policies
, policy
);
343 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM
*param
,
344 STACK_OF(ASN1_OBJECT
) *policies
)
347 ASN1_OBJECT
*oid
, *doid
;
350 ERR_raise(ERR_LIB_X509
, ERR_R_PASSED_NULL_PARAMETER
);
353 sk_ASN1_OBJECT_pop_free(param
->policies
, ASN1_OBJECT_free
);
355 if (policies
== NULL
) {
356 param
->policies
= NULL
;
360 param
->policies
= sk_ASN1_OBJECT_new_null();
361 if (param
->policies
== NULL
)
364 for (i
= 0; i
< sk_ASN1_OBJECT_num(policies
); i
++) {
365 oid
= sk_ASN1_OBJECT_value(policies
, i
);
369 if (!sk_ASN1_OBJECT_push(param
->policies
, doid
)) {
370 ASN1_OBJECT_free(doid
);
374 param
->flags
|= X509_V_FLAG_POLICY_CHECK
;
378 char *X509_VERIFY_PARAM_get0_host(X509_VERIFY_PARAM
*param
, int idx
)
380 return sk_OPENSSL_STRING_value(param
->hosts
, idx
);
383 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM
*param
,
384 const char *name
, size_t namelen
)
386 return int_x509_param_set_hosts(param
, SET_HOST
, name
, namelen
);
389 int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM
*param
,
390 const char *name
, size_t namelen
)
392 return int_x509_param_set_hosts(param
, ADD_HOST
, name
, namelen
);
395 void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM
*param
,
398 param
->hostflags
= flags
;
401 unsigned int X509_VERIFY_PARAM_get_hostflags(const X509_VERIFY_PARAM
*param
)
403 return param
->hostflags
;
406 char *X509_VERIFY_PARAM_get0_peername(const X509_VERIFY_PARAM
*param
)
408 return param
->peername
;
412 * Move peername from one param structure to another, freeing any name present
413 * at the target. If the source is a NULL parameter structure, free and zero
414 * the target peername.
416 void X509_VERIFY_PARAM_move_peername(X509_VERIFY_PARAM
*to
,
417 X509_VERIFY_PARAM
*from
)
419 char *peername
= (from
!= NULL
) ? from
->peername
: NULL
;
421 if (to
->peername
!= peername
) {
422 OPENSSL_free(to
->peername
);
423 to
->peername
= peername
;
426 from
->peername
= NULL
;
429 char *X509_VERIFY_PARAM_get0_email(X509_VERIFY_PARAM
*param
)
434 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM
*param
,
435 const char *email
, size_t emaillen
)
437 return int_x509_param_set1(¶m
->email
, ¶m
->emaillen
,
442 *int_X509_VERIFY_PARAM_get0_ip(X509_VERIFY_PARAM
*param
, size_t *plen
)
444 if (param
== NULL
|| param
->ip
== NULL
) {
445 ERR_raise(ERR_LIB_X509
, ERR_R_PASSED_NULL_PARAMETER
);
449 *plen
= param
->iplen
;
453 char *X509_VERIFY_PARAM_get1_ip_asc(X509_VERIFY_PARAM
*param
)
456 unsigned char *ip
= int_X509_VERIFY_PARAM_get0_ip(param
, &iplen
);
458 return ip
== NULL
? NULL
: ossl_ipaddr_to_asc(ip
, iplen
);
461 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM
*param
,
462 const unsigned char *ip
, size_t iplen
)
464 if (iplen
!= 0 && iplen
!= 4 && iplen
!= 16) {
465 ERR_raise(ERR_LIB_X509
, ERR_R_PASSED_INVALID_ARGUMENT
);
468 return int_x509_param_set1((char **)¶m
->ip
, ¶m
->iplen
,
472 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM
*param
, const char *ipasc
)
474 unsigned char ipout
[16];
475 size_t iplen
= (size_t)ossl_a2i_ipadd(ipout
, ipasc
);
479 return X509_VERIFY_PARAM_set1_ip(param
, ipout
, iplen
);
482 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM
*param
)
487 int X509_VERIFY_PARAM_get_auth_level(const X509_VERIFY_PARAM
*param
)
489 return param
->auth_level
;
492 const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM
*param
)
497 #define vpm_empty_id NULL, 0U, NULL, NULL, 0, NULL, 0
500 * Default verify parameters: these are used for various applications and can
501 * be overridden by the user specified table. NB: the 'name' field *must* be
502 * in alphabetical order because it will be searched using OBJ_search.
505 static const X509_VERIFY_PARAM default_table
[] = {
507 "code_sign", /* Code sign parameters */
508 0, /* check time to use */
509 0, /* inheritance flags */
511 X509_PURPOSE_CODE_SIGN
, /* purpose */
512 X509_TRUST_OBJECT_SIGN
, /* trust */
519 "default", /* X509 default parameters */
520 0, /* check time to use */
521 0, /* inheritance flags */
522 X509_V_FLAG_TRUSTED_FIRST
, /* flags */
531 "pkcs7", /* S/MIME sign parameters */
532 0, /* check time to use */
533 0, /* inheritance flags */
535 X509_PURPOSE_SMIME_SIGN
, /* purpose */
536 X509_TRUST_EMAIL
, /* trust */
543 "smime_sign", /* S/MIME sign parameters */
544 0, /* check time to use */
545 0, /* inheritance flags */
547 X509_PURPOSE_SMIME_SIGN
, /* purpose */
548 X509_TRUST_EMAIL
, /* trust */
555 "ssl_client", /* SSL/TLS client parameters */
556 0, /* check time to use */
557 0, /* inheritance flags */
559 X509_PURPOSE_SSL_CLIENT
, /* purpose */
560 X509_TRUST_SSL_CLIENT
, /* trust */
567 "ssl_server", /* SSL/TLS server parameters */
568 0, /* check time to use */
569 0, /* inheritance flags */
571 X509_PURPOSE_SSL_SERVER
, /* purpose */
572 X509_TRUST_SSL_SERVER
, /* trust */
580 static STACK_OF(X509_VERIFY_PARAM
) *param_table
= NULL
;
582 static int table_cmp(const X509_VERIFY_PARAM
*a
, const X509_VERIFY_PARAM
*b
)
584 return strcmp(a
->name
, b
->name
);
587 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM
, X509_VERIFY_PARAM
, table
);
588 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM
, X509_VERIFY_PARAM
, table
);
590 static int param_cmp(const X509_VERIFY_PARAM
*const *a
,
591 const X509_VERIFY_PARAM
*const *b
)
593 return strcmp((*a
)->name
, (*b
)->name
);
596 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM
*param
)
599 X509_VERIFY_PARAM
*ptmp
;
601 if (param_table
== NULL
) {
602 param_table
= sk_X509_VERIFY_PARAM_new(param_cmp
);
603 if (param_table
== NULL
)
606 idx
= sk_X509_VERIFY_PARAM_find(param_table
, param
);
608 ptmp
= sk_X509_VERIFY_PARAM_delete(param_table
, idx
);
609 X509_VERIFY_PARAM_free(ptmp
);
612 return sk_X509_VERIFY_PARAM_push(param_table
, param
);
615 int X509_VERIFY_PARAM_get_count(void)
617 int num
= OSSL_NELEM(default_table
);
619 if (param_table
!= NULL
)
620 num
+= sk_X509_VERIFY_PARAM_num(param_table
);
624 const X509_VERIFY_PARAM
*X509_VERIFY_PARAM_get0(int id
)
626 int num
= OSSL_NELEM(default_table
);
629 return default_table
+ id
;
630 return sk_X509_VERIFY_PARAM_value(param_table
, id
- num
);
633 const X509_VERIFY_PARAM
*X509_VERIFY_PARAM_lookup(const char *name
)
636 X509_VERIFY_PARAM pm
;
638 pm
.name
= (char *)name
;
639 if (param_table
!= NULL
) {
640 idx
= sk_X509_VERIFY_PARAM_find(param_table
, &pm
);
642 return sk_X509_VERIFY_PARAM_value(param_table
, idx
);
644 return OBJ_bsearch_table(&pm
, default_table
, OSSL_NELEM(default_table
));
647 void X509_VERIFY_PARAM_table_cleanup(void)
649 sk_X509_VERIFY_PARAM_pop_free(param_table
, X509_VERIFY_PARAM_free
);