3 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
6 /* ====================================================================
7 * Copyright (c) 2004 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgment:
23 * "This product includes software developed by the OpenSSL Project
24 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 * endorse or promote products derived from this software without
28 * prior written permission. For written permission, please contact
29 * licensing@OpenSSL.org.
31 * 5. Products derived from this software may not be called "OpenSSL"
32 * nor may "OpenSSL" appear in their names without prior written
33 * permission of the OpenSSL Project.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 * OF THE POSSIBILITY OF SUCH DAMAGE.
52 * ====================================================================
54 * This product includes cryptographic software written by Eric Young
55 * (eay@cryptsoft.com). This product includes software written by Tim
56 * Hudson (tjh@cryptsoft.com).
63 #include <openssl/crypto.h>
64 #include <openssl/lhash.h>
65 #include <openssl/buffer.h>
66 #include <openssl/x509.h>
67 #include <openssl/x509v3.h>
71 /* X509_VERIFY_PARAM functions */
76 static char *str_copy(const char *s
)
78 return OPENSSL_strdup(s
);
81 static void str_free(char *s
)
86 #define string_stack_free(sk) sk_OPENSSL_STRING_pop_free(sk, str_free)
88 static int int_x509_param_set_hosts(X509_VERIFY_PARAM_ID
*id
, int mode
,
89 const char *name
, size_t namelen
)
94 * Refuse names with embedded NUL bytes, except perhaps as final byte.
95 * XXX: Do we need to push an error onto the error stack?
97 if (namelen
== 0 || name
== NULL
)
98 namelen
= name
? strlen(name
) : 0;
99 else if (name
&& memchr(name
, '\0', namelen
> 1 ? namelen
- 1 : namelen
))
101 if (namelen
> 0 && name
[namelen
- 1] == '\0')
104 if (mode
== SET_HOST
&& id
->hosts
) {
105 string_stack_free(id
->hosts
);
108 if (name
== NULL
|| namelen
== 0)
111 copy
= BUF_strndup(name
, namelen
);
115 if (id
->hosts
== NULL
&&
116 (id
->hosts
= sk_OPENSSL_STRING_new_null()) == NULL
) {
121 if (!sk_OPENSSL_STRING_push(id
->hosts
, copy
)) {
123 if (sk_OPENSSL_STRING_num(id
->hosts
) == 0) {
124 sk_OPENSSL_STRING_free(id
->hosts
);
133 static void x509_verify_param_zero(X509_VERIFY_PARAM
*param
)
135 X509_VERIFY_PARAM_ID
*paramid
;
142 * param->inh_flags = X509_VP_FLAG_DEFAULT;
144 param
->inh_flags
= 0;
147 if (param
->policies
) {
148 sk_ASN1_OBJECT_pop_free(param
->policies
, ASN1_OBJECT_free
);
149 param
->policies
= NULL
;
152 if (paramid
->hosts
) {
153 string_stack_free(paramid
->hosts
);
154 paramid
->hosts
= NULL
;
156 if (paramid
->peername
)
157 OPENSSL_free(paramid
->peername
);
158 paramid
->peername
= NULL
;
159 if (paramid
->email
) {
160 OPENSSL_free(paramid
->email
);
161 paramid
->email
= NULL
;
162 paramid
->emaillen
= 0;
165 OPENSSL_free(paramid
->ip
);
171 X509_VERIFY_PARAM
*X509_VERIFY_PARAM_new(void)
173 X509_VERIFY_PARAM
*param
;
174 X509_VERIFY_PARAM_ID
*paramid
;
176 param
= OPENSSL_malloc(sizeof *param
);
179 memset(param
, 0, sizeof(*param
));
181 paramid
= OPENSSL_malloc(sizeof(*paramid
));
186 memset(paramid
, 0, sizeof(*paramid
));
187 /* Exotic platforms may have non-zero bit representation of NULL */
188 paramid
->hosts
= NULL
;
189 paramid
->peername
= NULL
;
190 paramid
->email
= NULL
;
194 x509_verify_param_zero(param
);
198 void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM
*param
)
202 x509_verify_param_zero(param
);
203 OPENSSL_free(param
->id
);
208 * This function determines how parameters are "inherited" from one structure
209 * to another. There are several different ways this can happen.
211 * 1. If a child structure needs to have its values initialized from a parent
212 * they are simply copied across. For example SSL_CTX copied to SSL.
213 * 2. If the structure should take on values only if they are currently unset.
214 * For example the values in an SSL structure will take appropriate value
215 * for SSL servers or clients but only if the application has not set new
218 * The "inh_flags" field determines how this function behaves.
220 * Normally any values which are set in the default are not copied from the
221 * destination and verify flags are ORed together.
223 * If X509_VP_FLAG_DEFAULT is set then anything set in the source is copied
224 * to the destination. Effectively the values in "to" become default values
225 * which will be used only if nothing new is set in "from".
227 * If X509_VP_FLAG_OVERWRITE is set then all value are copied across whether
228 * they are set or not. Flags is still Ored though.
230 * If X509_VP_FLAG_RESET_FLAGS is set then the flags value is copied instead
233 * If X509_VP_FLAG_LOCKED is set then no values are copied.
235 * If X509_VP_FLAG_ONCE is set then the current inh_flags setting is zeroed
236 * after the next call.
239 /* Macro to test if a field should be copied from src to dest */
241 #define test_x509_verify_param_copy(field, def) \
243 ((src->field != def) && (to_default || (dest->field == def))))
245 /* As above but for ID fields */
247 #define test_x509_verify_param_copy_id(idf, def) \
248 test_x509_verify_param_copy(id->idf, def)
250 /* Macro to test and copy a field if necessary */
252 #define x509_verify_param_copy(field, def) \
253 if (test_x509_verify_param_copy(field, def)) \
254 dest->field = src->field
256 int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM
*dest
,
257 const X509_VERIFY_PARAM
*src
)
259 unsigned long inh_flags
;
260 int to_default
, to_overwrite
;
261 X509_VERIFY_PARAM_ID
*id
;
265 inh_flags
= dest
->inh_flags
| src
->inh_flags
;
267 if (inh_flags
& X509_VP_FLAG_ONCE
)
270 if (inh_flags
& X509_VP_FLAG_LOCKED
)
273 if (inh_flags
& X509_VP_FLAG_DEFAULT
)
278 if (inh_flags
& X509_VP_FLAG_OVERWRITE
)
283 x509_verify_param_copy(purpose
, 0);
284 x509_verify_param_copy(trust
, 0);
285 x509_verify_param_copy(depth
, -1);
287 /* If overwrite or check time not set, copy across */
289 if (to_overwrite
|| !(dest
->flags
& X509_V_FLAG_USE_CHECK_TIME
)) {
290 dest
->check_time
= src
->check_time
;
291 dest
->flags
&= ~X509_V_FLAG_USE_CHECK_TIME
;
292 /* Don't need to copy flag: that is done below */
295 if (inh_flags
& X509_VP_FLAG_RESET_FLAGS
)
298 dest
->flags
|= src
->flags
;
300 if (test_x509_verify_param_copy(policies
, NULL
)) {
301 if (!X509_VERIFY_PARAM_set1_policies(dest
, src
->policies
))
305 /* Copy the host flags if and only if we're copying the host list */
306 if (test_x509_verify_param_copy_id(hosts
, NULL
)) {
307 if (dest
->id
->hosts
) {
308 string_stack_free(dest
->id
->hosts
);
309 dest
->id
->hosts
= NULL
;
313 sk_OPENSSL_STRING_deep_copy(id
->hosts
, str_copy
, str_free
);
314 if (dest
->id
->hosts
== NULL
)
316 dest
->id
->hostflags
= id
->hostflags
;
320 if (test_x509_verify_param_copy_id(email
, NULL
)) {
321 if (!X509_VERIFY_PARAM_set1_email(dest
, id
->email
, id
->emaillen
))
325 if (test_x509_verify_param_copy_id(ip
, NULL
)) {
326 if (!X509_VERIFY_PARAM_set1_ip(dest
, id
->ip
, id
->iplen
))
333 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM
*to
,
334 const X509_VERIFY_PARAM
*from
)
336 unsigned long save_flags
= to
->inh_flags
;
338 to
->inh_flags
|= X509_VP_FLAG_DEFAULT
;
339 ret
= X509_VERIFY_PARAM_inherit(to
, from
);
340 to
->inh_flags
= save_flags
;
344 static int int_x509_param_set1(char **pdest
, size_t *pdestlen
,
345 const char *src
, size_t srclen
)
350 tmp
= BUF_strdup(src
);
351 srclen
= strlen(src
);
353 tmp
= BUF_memdup(src
, srclen
);
361 OPENSSL_free(*pdest
);
368 int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM
*param
, const char *name
)
371 OPENSSL_free(param
->name
);
372 param
->name
= BUF_strdup(name
);
378 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM
*param
, unsigned long flags
)
380 param
->flags
|= flags
;
381 if (flags
& X509_V_FLAG_POLICY_MASK
)
382 param
->flags
|= X509_V_FLAG_POLICY_CHECK
;
386 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM
*param
,
389 param
->flags
&= ~flags
;
393 unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM
*param
)
398 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM
*param
, int purpose
)
400 return X509_PURPOSE_set(¶m
->purpose
, purpose
);
403 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM
*param
, int trust
)
405 return X509_TRUST_set(¶m
->trust
, trust
);
408 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM
*param
, int depth
)
410 param
->depth
= depth
;
413 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM
*param
, time_t t
)
415 param
->check_time
= t
;
416 param
->flags
|= X509_V_FLAG_USE_CHECK_TIME
;
419 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM
*param
,
422 if (!param
->policies
) {
423 param
->policies
= sk_ASN1_OBJECT_new_null();
424 if (!param
->policies
)
427 if (!sk_ASN1_OBJECT_push(param
->policies
, policy
))
432 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM
*param
,
433 STACK_OF(ASN1_OBJECT
) *policies
)
436 ASN1_OBJECT
*oid
, *doid
;
440 sk_ASN1_OBJECT_pop_free(param
->policies
, ASN1_OBJECT_free
);
443 param
->policies
= NULL
;
447 param
->policies
= sk_ASN1_OBJECT_new_null();
448 if (!param
->policies
)
451 for (i
= 0; i
< sk_ASN1_OBJECT_num(policies
); i
++) {
452 oid
= sk_ASN1_OBJECT_value(policies
, i
);
456 if (!sk_ASN1_OBJECT_push(param
->policies
, doid
)) {
457 ASN1_OBJECT_free(doid
);
461 param
->flags
|= X509_V_FLAG_POLICY_CHECK
;
465 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM
*param
,
466 const char *name
, size_t namelen
)
468 return int_x509_param_set_hosts(param
->id
, SET_HOST
, name
, namelen
);
471 int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM
*param
,
472 const char *name
, size_t namelen
)
474 return int_x509_param_set_hosts(param
->id
, ADD_HOST
, name
, namelen
);
477 void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM
*param
,
480 param
->id
->hostflags
= flags
;
483 char *X509_VERIFY_PARAM_get0_peername(X509_VERIFY_PARAM
*param
)
485 return param
->id
->peername
;
488 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM
*param
,
489 const char *email
, size_t emaillen
)
491 return int_x509_param_set1(¶m
->id
->email
, ¶m
->id
->emaillen
,
495 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM
*param
,
496 const unsigned char *ip
, size_t iplen
)
498 if (iplen
!= 0 && iplen
!= 4 && iplen
!= 16)
500 return int_x509_param_set1((char **)¶m
->id
->ip
, ¶m
->id
->iplen
,
504 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM
*param
, const char *ipasc
)
506 unsigned char ipout
[16];
509 iplen
= (size_t)a2i_ipadd(ipout
, ipasc
);
512 return X509_VERIFY_PARAM_set1_ip(param
, ipout
, iplen
);
515 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM
*param
)
520 const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM
*param
)
525 static X509_VERIFY_PARAM_ID _empty_id
= { NULL
, 0U, NULL
, NULL
, 0, NULL
, 0 };
527 #define vpm_empty_id (X509_VERIFY_PARAM_ID *)&_empty_id
530 * Default verify parameters: these are used for various applications and can
531 * be overridden by the user specified table. NB: the 'name' field *must* be
532 * in alphabetical order because it will be searched using OBJ_search.
535 static const X509_VERIFY_PARAM default_table
[] = {
537 "default", /* X509 default parameters */
539 0, /* internal flags */
547 "pkcs7", /* S/MIME sign parameters */
549 0, /* internal flags */
551 X509_PURPOSE_SMIME_SIGN
, /* purpose */
552 X509_TRUST_EMAIL
, /* trust */
557 "smime_sign", /* S/MIME sign parameters */
559 0, /* internal flags */
561 X509_PURPOSE_SMIME_SIGN
, /* purpose */
562 X509_TRUST_EMAIL
, /* trust */
567 "ssl_client", /* SSL/TLS client parameters */
569 0, /* internal flags */
571 X509_PURPOSE_SSL_CLIENT
, /* purpose */
572 X509_TRUST_SSL_CLIENT
, /* trust */
577 "ssl_server", /* SSL/TLS server parameters */
579 0, /* internal flags */
581 X509_PURPOSE_SSL_SERVER
, /* purpose */
582 X509_TRUST_SSL_SERVER
, /* trust */
588 static STACK_OF(X509_VERIFY_PARAM
) *param_table
= NULL
;
590 static int table_cmp(const X509_VERIFY_PARAM
*a
, const X509_VERIFY_PARAM
*b
)
592 return strcmp(a
->name
, b
->name
);
595 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM
, X509_VERIFY_PARAM
, table
);
596 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM
, X509_VERIFY_PARAM
, table
);
598 static int param_cmp(const X509_VERIFY_PARAM
*const *a
,
599 const X509_VERIFY_PARAM
*const *b
)
601 return strcmp((*a
)->name
, (*b
)->name
);
604 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM
*param
)
607 X509_VERIFY_PARAM
*ptmp
;
609 param_table
= sk_X509_VERIFY_PARAM_new(param_cmp
);
613 idx
= sk_X509_VERIFY_PARAM_find(param_table
, param
);
615 ptmp
= sk_X509_VERIFY_PARAM_value(param_table
, idx
);
616 X509_VERIFY_PARAM_free(ptmp
);
617 (void)sk_X509_VERIFY_PARAM_delete(param_table
, idx
);
620 if (!sk_X509_VERIFY_PARAM_push(param_table
, param
))
625 int X509_VERIFY_PARAM_get_count(void)
627 int num
= sizeof(default_table
) / sizeof(X509_VERIFY_PARAM
);
629 num
+= sk_X509_VERIFY_PARAM_num(param_table
);
633 const X509_VERIFY_PARAM
*X509_VERIFY_PARAM_get0(int id
)
635 int num
= sizeof(default_table
) / sizeof(X509_VERIFY_PARAM
);
637 return default_table
+ id
;
638 return sk_X509_VERIFY_PARAM_value(param_table
, id
- num
);
641 const X509_VERIFY_PARAM
*X509_VERIFY_PARAM_lookup(const char *name
)
644 X509_VERIFY_PARAM pm
;
646 pm
.name
= (char *)name
;
648 idx
= sk_X509_VERIFY_PARAM_find(param_table
, &pm
);
650 return sk_X509_VERIFY_PARAM_value(param_table
, idx
);
652 return OBJ_bsearch_table(&pm
, default_table
,
653 sizeof(default_table
) /
654 sizeof(X509_VERIFY_PARAM
));
657 void X509_VERIFY_PARAM_table_cleanup(void)
660 sk_X509_VERIFY_PARAM_pop_free(param_table
, X509_VERIFY_PARAM_free
);