2 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
5 /* ====================================================================
6 * Copyright (c) 2004 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * licensing@OpenSSL.org.
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
53 * This product includes cryptographic software written by Eric Young
54 * (eay@cryptsoft.com). This product includes software written by Tim
55 * Hudson (tjh@cryptsoft.com).
61 #include "internal/cryptlib.h"
62 #include <openssl/crypto.h>
63 #include <openssl/lhash.h>
64 #include <openssl/buffer.h>
65 #include <openssl/x509.h>
66 #include <openssl/x509v3.h>
70 /* X509_VERIFY_PARAM functions */
75 static char *str_copy(const char *s
)
77 return OPENSSL_strdup(s
);
80 static void str_free(char *s
)
85 static int int_x509_param_set_hosts(X509_VERIFY_PARAM
*vpm
, int mode
,
86 const char *name
, size_t namelen
)
91 * Refuse names with embedded NUL bytes, except perhaps as final byte.
92 * XXX: Do we need to push an error onto the error stack?
94 if (namelen
== 0 || name
== NULL
)
95 namelen
= name
? strlen(name
) : 0;
96 else if (name
&& memchr(name
, '\0', namelen
> 1 ? namelen
- 1 : namelen
))
98 if (namelen
> 0 && name
[namelen
- 1] == '\0')
101 if (mode
== SET_HOST
) {
102 sk_OPENSSL_STRING_pop_free(vpm
->hosts
, str_free
);
105 if (name
== NULL
|| namelen
== 0)
108 copy
= OPENSSL_strndup(name
, namelen
);
112 if (vpm
->hosts
== NULL
&&
113 (vpm
->hosts
= sk_OPENSSL_STRING_new_null()) == NULL
) {
118 if (!sk_OPENSSL_STRING_push(vpm
->hosts
, copy
)) {
120 if (sk_OPENSSL_STRING_num(vpm
->hosts
) == 0) {
121 sk_OPENSSL_STRING_free(vpm
->hosts
);
130 static void x509_verify_param_zero(X509_VERIFY_PARAM
*param
)
138 * param->inh_flags = X509_VP_FLAG_DEFAULT;
140 param
->inh_flags
= 0;
143 sk_ASN1_OBJECT_pop_free(param
->policies
, ASN1_OBJECT_free
);
144 param
->policies
= NULL
;
145 sk_OPENSSL_STRING_pop_free(param
->hosts
, str_free
);
147 OPENSSL_free(param
->peername
);
148 param
->peername
= NULL
;
149 OPENSSL_free(param
->email
);
152 OPENSSL_free(param
->ip
);
157 X509_VERIFY_PARAM
*X509_VERIFY_PARAM_new(void)
159 X509_VERIFY_PARAM
*param
;
161 param
= OPENSSL_zalloc(sizeof(*param
));
164 x509_verify_param_zero(param
);
168 void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM
*param
)
172 x509_verify_param_zero(param
);
177 * This function determines how parameters are "inherited" from one structure
178 * to another. There are several different ways this can happen.
180 * 1. If a child structure needs to have its values initialized from a parent
181 * they are simply copied across. For example SSL_CTX copied to SSL.
182 * 2. If the structure should take on values only if they are currently unset.
183 * For example the values in an SSL structure will take appropriate value
184 * for SSL servers or clients but only if the application has not set new
187 * The "inh_flags" field determines how this function behaves.
189 * Normally any values which are set in the default are not copied from the
190 * destination and verify flags are ORed together.
192 * If X509_VP_FLAG_DEFAULT is set then anything set in the source is copied
193 * to the destination. Effectively the values in "to" become default values
194 * which will be used only if nothing new is set in "from".
196 * If X509_VP_FLAG_OVERWRITE is set then all value are copied across whether
197 * they are set or not. Flags is still Ored though.
199 * If X509_VP_FLAG_RESET_FLAGS is set then the flags value is copied instead
202 * If X509_VP_FLAG_LOCKED is set then no values are copied.
204 * If X509_VP_FLAG_ONCE is set then the current inh_flags setting is zeroed
205 * after the next call.
208 /* Macro to test if a field should be copied from src to dest */
210 #define test_x509_verify_param_copy(field, def) \
212 ((src->field != def) && (to_default || (dest->field == def))))
214 /* Macro to test and copy a field if necessary */
216 #define x509_verify_param_copy(field, def) \
217 if (test_x509_verify_param_copy(field, def)) \
218 dest->field = src->field
220 int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM
*dest
,
221 const X509_VERIFY_PARAM
*src
)
223 unsigned long inh_flags
;
224 int to_default
, to_overwrite
;
227 inh_flags
= dest
->inh_flags
| src
->inh_flags
;
229 if (inh_flags
& X509_VP_FLAG_ONCE
)
232 if (inh_flags
& X509_VP_FLAG_LOCKED
)
235 if (inh_flags
& X509_VP_FLAG_DEFAULT
)
240 if (inh_flags
& X509_VP_FLAG_OVERWRITE
)
245 x509_verify_param_copy(purpose
, 0);
246 x509_verify_param_copy(trust
, 0);
247 x509_verify_param_copy(depth
, -1);
249 /* If overwrite or check time not set, copy across */
251 if (to_overwrite
|| !(dest
->flags
& X509_V_FLAG_USE_CHECK_TIME
)) {
252 dest
->check_time
= src
->check_time
;
253 dest
->flags
&= ~X509_V_FLAG_USE_CHECK_TIME
;
254 /* Don't need to copy flag: that is done below */
257 if (inh_flags
& X509_VP_FLAG_RESET_FLAGS
)
260 dest
->flags
|= src
->flags
;
262 if (test_x509_verify_param_copy(policies
, NULL
)) {
263 if (!X509_VERIFY_PARAM_set1_policies(dest
, src
->policies
))
267 /* Copy the host flags if and only if we're copying the host list */
268 if (test_x509_verify_param_copy(hosts
, NULL
)) {
269 sk_OPENSSL_STRING_pop_free(dest
->hosts
, str_free
);
273 sk_OPENSSL_STRING_deep_copy(src
->hosts
, str_copy
, str_free
);
274 if (dest
->hosts
== NULL
)
276 dest
->hostflags
= src
->hostflags
;
280 if (test_x509_verify_param_copy(email
, NULL
)) {
281 if (!X509_VERIFY_PARAM_set1_email(dest
, src
->email
, src
->emaillen
))
285 if (test_x509_verify_param_copy(ip
, NULL
)) {
286 if (!X509_VERIFY_PARAM_set1_ip(dest
, src
->ip
, src
->iplen
))
293 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM
*to
,
294 const X509_VERIFY_PARAM
*from
)
296 unsigned long save_flags
= to
->inh_flags
;
298 to
->inh_flags
|= X509_VP_FLAG_DEFAULT
;
299 ret
= X509_VERIFY_PARAM_inherit(to
, from
);
300 to
->inh_flags
= save_flags
;
304 static int int_x509_param_set1(char **pdest
, size_t *pdestlen
,
305 const char *src
, size_t srclen
)
310 tmp
= OPENSSL_strdup(src
);
311 srclen
= strlen(src
);
313 tmp
= OPENSSL_memdup(src
, srclen
);
320 OPENSSL_free(*pdest
);
327 int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM
*param
, const char *name
)
329 OPENSSL_free(param
->name
);
330 param
->name
= OPENSSL_strdup(name
);
336 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM
*param
, unsigned long flags
)
338 param
->flags
|= flags
;
339 if (flags
& X509_V_FLAG_POLICY_MASK
)
340 param
->flags
|= X509_V_FLAG_POLICY_CHECK
;
344 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM
*param
,
347 param
->flags
&= ~flags
;
351 unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM
*param
)
356 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM
*param
, int purpose
)
358 return X509_PURPOSE_set(¶m
->purpose
, purpose
);
361 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM
*param
, int trust
)
363 return X509_TRUST_set(¶m
->trust
, trust
);
366 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM
*param
, int depth
)
368 param
->depth
= depth
;
371 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM
*param
, time_t t
)
373 param
->check_time
= t
;
374 param
->flags
|= X509_V_FLAG_USE_CHECK_TIME
;
377 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM
*param
,
380 if (!param
->policies
) {
381 param
->policies
= sk_ASN1_OBJECT_new_null();
382 if (!param
->policies
)
385 if (!sk_ASN1_OBJECT_push(param
->policies
, policy
))
390 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM
*param
,
391 STACK_OF(ASN1_OBJECT
) *policies
)
394 ASN1_OBJECT
*oid
, *doid
;
398 sk_ASN1_OBJECT_pop_free(param
->policies
, ASN1_OBJECT_free
);
401 param
->policies
= NULL
;
405 param
->policies
= sk_ASN1_OBJECT_new_null();
406 if (!param
->policies
)
409 for (i
= 0; i
< sk_ASN1_OBJECT_num(policies
); i
++) {
410 oid
= sk_ASN1_OBJECT_value(policies
, i
);
414 if (!sk_ASN1_OBJECT_push(param
->policies
, doid
)) {
415 ASN1_OBJECT_free(doid
);
419 param
->flags
|= X509_V_FLAG_POLICY_CHECK
;
423 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM
*param
,
424 const char *name
, size_t namelen
)
426 return int_x509_param_set_hosts(param
, SET_HOST
, name
, namelen
);
429 int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM
*param
,
430 const char *name
, size_t namelen
)
432 return int_x509_param_set_hosts(param
, ADD_HOST
, name
, namelen
);
435 void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM
*param
,
438 param
->hostflags
= flags
;
441 char *X509_VERIFY_PARAM_get0_peername(X509_VERIFY_PARAM
*param
)
443 return param
->peername
;
447 * Move peername from one param structure to another, freeing any name present
448 * at the target. If the source is a NULL parameter structure, free and zero
449 * the target peername.
451 void X509_VERIFY_PARAM_move_peername(X509_VERIFY_PARAM
*to
,
452 X509_VERIFY_PARAM
*from
)
454 char *peername
= (from
!= NULL
) ? from
->peername
: NULL
;
456 if (to
->peername
!= peername
) {
457 OPENSSL_free(to
->peername
);
458 to
->peername
= peername
;
461 from
->peername
= NULL
;
464 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM
*param
,
465 const char *email
, size_t emaillen
)
467 return int_x509_param_set1(¶m
->email
, ¶m
->emaillen
,
471 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM
*param
,
472 const unsigned char *ip
, size_t iplen
)
474 if (iplen
!= 0 && iplen
!= 4 && iplen
!= 16)
476 return int_x509_param_set1((char **)¶m
->ip
, ¶m
->iplen
,
480 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM
*param
, const char *ipasc
)
482 unsigned char ipout
[16];
485 iplen
= (size_t)a2i_ipadd(ipout
, ipasc
);
488 return X509_VERIFY_PARAM_set1_ip(param
, ipout
, iplen
);
491 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM
*param
)
496 const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM
*param
)
501 #define vpm_empty_id NULL, 0U, NULL, NULL, 0, NULL, 0
504 * Default verify parameters: these are used for various applications and can
505 * be overridden by the user specified table. NB: the 'name' field *must* be
506 * in alphabetical order because it will be searched using OBJ_search.
509 static const X509_VERIFY_PARAM default_table
[] = {
511 "default", /* X509 default parameters */
513 0, /* internal flags */
521 "pkcs7", /* S/MIME sign parameters */
523 0, /* internal flags */
525 X509_PURPOSE_SMIME_SIGN
, /* purpose */
526 X509_TRUST_EMAIL
, /* trust */
531 "smime_sign", /* S/MIME sign parameters */
533 0, /* internal flags */
535 X509_PURPOSE_SMIME_SIGN
, /* purpose */
536 X509_TRUST_EMAIL
, /* trust */
541 "ssl_client", /* SSL/TLS client parameters */
543 0, /* internal flags */
545 X509_PURPOSE_SSL_CLIENT
, /* purpose */
546 X509_TRUST_SSL_CLIENT
, /* trust */
551 "ssl_server", /* SSL/TLS server parameters */
553 0, /* internal flags */
555 X509_PURPOSE_SSL_SERVER
, /* purpose */
556 X509_TRUST_SSL_SERVER
, /* trust */
562 static STACK_OF(X509_VERIFY_PARAM
) *param_table
= NULL
;
564 static int table_cmp(const X509_VERIFY_PARAM
*a
, const X509_VERIFY_PARAM
*b
)
566 return strcmp(a
->name
, b
->name
);
569 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM
, X509_VERIFY_PARAM
, table
);
570 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM
, X509_VERIFY_PARAM
, table
);
572 static int param_cmp(const X509_VERIFY_PARAM
*const *a
,
573 const X509_VERIFY_PARAM
*const *b
)
575 return strcmp((*a
)->name
, (*b
)->name
);
578 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM
*param
)
581 X509_VERIFY_PARAM
*ptmp
;
582 if (param_table
== NULL
) {
583 param_table
= sk_X509_VERIFY_PARAM_new(param_cmp
);
584 if (param_table
== NULL
)
587 idx
= sk_X509_VERIFY_PARAM_find(param_table
, param
);
589 ptmp
= sk_X509_VERIFY_PARAM_value(param_table
, idx
);
590 X509_VERIFY_PARAM_free(ptmp
);
591 (void)sk_X509_VERIFY_PARAM_delete(param_table
, idx
);
594 if (!sk_X509_VERIFY_PARAM_push(param_table
, param
))
599 int X509_VERIFY_PARAM_get_count(void)
601 int num
= OSSL_NELEM(default_table
);
603 num
+= sk_X509_VERIFY_PARAM_num(param_table
);
607 const X509_VERIFY_PARAM
*X509_VERIFY_PARAM_get0(int id
)
609 int num
= OSSL_NELEM(default_table
);
611 return default_table
+ id
;
612 return sk_X509_VERIFY_PARAM_value(param_table
, id
- num
);
615 const X509_VERIFY_PARAM
*X509_VERIFY_PARAM_lookup(const char *name
)
618 X509_VERIFY_PARAM pm
;
620 pm
.name
= (char *)name
;
622 idx
= sk_X509_VERIFY_PARAM_find(param_table
, &pm
);
624 return sk_X509_VERIFY_PARAM_value(param_table
, idx
);
626 return OBJ_bsearch_table(&pm
, default_table
, OSSL_NELEM(default_table
));
629 void X509_VERIFY_PARAM_table_cleanup(void)
631 sk_X509_VERIFY_PARAM_pop_free(param_table
, X509_VERIFY_PARAM_free
);