1 /* $OpenBSD: ssl_cert.c,v 1.66 2017/08/12 02:55:22 jsing Exp $ */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
5 * This package is an SSL implementation written
6 * by Eric Young (eay@cryptsoft.com).
7 * The implementation was written so as to conform with Netscapes SSL.
9 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to. The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
16 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
26 * 1. Redistributions of source code must retain the copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 * must display the following acknowledgement:
33 * "This product includes cryptographic software written by
34 * Eric Young (eay@cryptsoft.com)"
35 * The word 'cryptographic' can be left out if the rouines from the library
36 * being used are not cryptographic related :-).
37 * 4. If you include any Windows specific code (or a derivative thereof) from
38 * the apps directory (application code) you must include an acknowledgement:
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.]
58 /* ====================================================================
59 * Copyright (c) 1998-2007 The OpenSSL Project. All rights reserved.
61 * Redistribution and use in source and binary forms, with or without
62 * modification, are permitted provided that the following conditions
65 * 1. Redistributions of source code must retain the above copyright
66 * notice, this list of conditions and the following disclaimer.
68 * 2. Redistributions in binary form must reproduce the above copyright
69 * notice, this list of conditions and the following disclaimer in
70 * the documentation and/or other materials provided with the
73 * 3. All advertising materials mentioning features or use of this
74 * software must display the following acknowledgment:
75 * "This product includes software developed by the OpenSSL Project
76 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
78 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79 * endorse or promote products derived from this software without
80 * prior written permission. For written permission, please contact
81 * openssl-core@openssl.org.
83 * 5. Products derived from this software may not be called "OpenSSL"
84 * nor may "OpenSSL" appear in their names without prior written
85 * permission of the OpenSSL Project.
87 * 6. Redistributions of any form whatsoever must retain the following
89 * "This product includes software developed by the OpenSSL Project
90 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
92 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
96 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103 * OF THE POSSIBILITY OF SUCH DAMAGE.
104 * ====================================================================
106 * This product includes cryptographic software written by Eric Young
107 * (eay@cryptsoft.com). This product includes software written by Tim
108 * Hudson (tjh@cryptsoft.com).
111 /* ====================================================================
112 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
113 * ECC cipher suite support in OpenSSL originally developed by
114 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
117 #include <sys/types.h>
123 #include <openssl/bio.h>
124 #include <openssl/bn.h>
125 #include <openssl/dh.h>
126 #include <openssl/objects.h>
127 #include <openssl/opensslconf.h>
128 #include <openssl/pem.h>
129 #include <openssl/x509v3.h>
131 #include "ssl_locl.h"
134 SSL_get_ex_data_X509_STORE_CTX_idx(void)
136 static volatile int ssl_x509_store_ctx_idx
= -1;
137 int got_write_lock
= 0;
139 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX
);
141 if (ssl_x509_store_ctx_idx
< 0) {
142 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX
);
143 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX
);
146 if (ssl_x509_store_ctx_idx
< 0) {
147 ssl_x509_store_ctx_idx
=
148 X509_STORE_CTX_get_ex_new_index(
149 0, "SSL for verify callback", NULL
, NULL
, NULL
);
154 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX
);
156 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX
);
158 return ssl_x509_store_ctx_idx
;
162 ssl_cert_set_default_md(CERT
*cert
)
164 /* Set digest values to defaults */
165 cert
->pkeys
[SSL_PKEY_RSA_SIGN
].digest
= EVP_sha1();
166 cert
->pkeys
[SSL_PKEY_RSA_ENC
].digest
= EVP_sha1();
167 cert
->pkeys
[SSL_PKEY_ECC
].digest
= EVP_sha1();
168 #ifndef OPENSSL_NO_GOST
169 cert
->pkeys
[SSL_PKEY_GOST01
].digest
= EVP_gostr341194();
178 ret
= calloc(1, sizeof(CERT
));
180 SSLerrorx(ERR_R_MALLOC_FAILURE
);
183 ret
->key
= &(ret
->pkeys
[SSL_PKEY_RSA_ENC
]);
185 ssl_cert_set_default_md(ret
);
190 ssl_cert_dup(CERT
*cert
)
195 ret
= calloc(1, sizeof(CERT
));
197 SSLerrorx(ERR_R_MALLOC_FAILURE
);
202 * same as ret->key = ret->pkeys + (cert->key - cert->pkeys),
203 * if you find that more readable
205 ret
->key
= &ret
->pkeys
[cert
->key
- &cert
->pkeys
[0]];
207 ret
->valid
= cert
->valid
;
208 ret
->mask_k
= cert
->mask_k
;
209 ret
->mask_a
= cert
->mask_a
;
211 if (cert
->dh_tmp
!= NULL
) {
212 ret
->dh_tmp
= DHparams_dup(cert
->dh_tmp
);
213 if (ret
->dh_tmp
== NULL
) {
214 SSLerrorx(ERR_R_DH_LIB
);
217 if (cert
->dh_tmp
->priv_key
) {
218 BIGNUM
*b
= BN_dup(cert
->dh_tmp
->priv_key
);
220 SSLerrorx(ERR_R_BN_LIB
);
223 ret
->dh_tmp
->priv_key
= b
;
225 if (cert
->dh_tmp
->pub_key
) {
226 BIGNUM
*b
= BN_dup(cert
->dh_tmp
->pub_key
);
228 SSLerrorx(ERR_R_BN_LIB
);
231 ret
->dh_tmp
->pub_key
= b
;
234 ret
->dh_tmp_cb
= cert
->dh_tmp_cb
;
235 ret
->dh_tmp_auto
= cert
->dh_tmp_auto
;
237 if (cert
->ecdh_tmp
) {
238 ret
->ecdh_tmp
= EC_KEY_dup(cert
->ecdh_tmp
);
239 if (ret
->ecdh_tmp
== NULL
) {
240 SSLerrorx(ERR_R_EC_LIB
);
245 for (i
= 0; i
< SSL_PKEY_NUM
; i
++) {
246 if (cert
->pkeys
[i
].x509
!= NULL
) {
247 ret
->pkeys
[i
].x509
= cert
->pkeys
[i
].x509
;
248 CRYPTO_add(&ret
->pkeys
[i
].x509
->references
, 1,
252 if (cert
->pkeys
[i
].privatekey
!= NULL
) {
253 ret
->pkeys
[i
].privatekey
= cert
->pkeys
[i
].privatekey
;
254 CRYPTO_add(&ret
->pkeys
[i
].privatekey
->references
, 1,
255 CRYPTO_LOCK_EVP_PKEY
);
259 * If there was anything special to do for
260 * certain types of keys, we'd do it here.
261 * (Nothing at the moment, I think.)
264 case SSL_PKEY_RSA_ENC
:
265 case SSL_PKEY_RSA_SIGN
:
266 /* We have an RSA key. */
269 case SSL_PKEY_DH_RSA
:
270 /* We have a DH key. */
274 /* We have an ECC key */
279 SSLerrorx(SSL_R_LIBRARY_BUG
);
285 * ret->extra_certs *should* exist, but currently the own certificate
286 * chain is held inside SSL_CTX
291 * Set digests to defaults. NB: we don't copy existing values
292 * as they will be set during handshake.
294 ssl_cert_set_default_md(ret
);
299 DH_free(ret
->dh_tmp
);
300 EC_KEY_free(ret
->ecdh_tmp
);
302 for (i
= 0; i
< SSL_PKEY_NUM
; i
++) {
303 X509_free(ret
->pkeys
[i
].x509
);
304 EVP_PKEY_free(ret
->pkeys
[i
].privatekey
);
312 ssl_cert_free(CERT
*c
)
319 i
= CRYPTO_add(&c
->references
, -1, CRYPTO_LOCK_SSL_CERT
);
324 EC_KEY_free(c
->ecdh_tmp
);
326 for (i
= 0; i
< SSL_PKEY_NUM
; i
++) {
327 X509_free(c
->pkeys
[i
].x509
);
328 EVP_PKEY_free(c
->pkeys
[i
].privatekey
);
335 ssl_cert_inst(CERT
**o
)
338 * Create a CERT if there isn't already one
339 * (which cannot really happen, as it is initially created in
340 * SSL_CTX_new; but the earlier code usually allows for that one
341 * being non-existant, so we follow that behaviour, as it might
342 * turn out that there actually is a reason for it -- but I'm
343 * not sure that *all* of the existing code could cope with
344 * s->cert being NULL, otherwise we could do without the
345 * initialization in SSL_CTX_new).
349 SSLerrorx(ERR_R_PASSED_NULL_PARAMETER
);
353 if ((*o
= ssl_cert_new()) == NULL
) {
354 SSLerrorx(ERR_R_MALLOC_FAILURE
);
363 ssl_sess_cert_new(void)
367 ret
= calloc(1, sizeof *ret
);
369 SSLerrorx(ERR_R_MALLOC_FAILURE
);
372 ret
->peer_key
= &(ret
->peer_pkeys
[SSL_PKEY_RSA_ENC
]);
379 ssl_sess_cert_free(SESS_CERT
*sc
)
386 i
= CRYPTO_add(&sc
->references
, -1, CRYPTO_LOCK_SSL_SESS_CERT
);
390 sk_X509_pop_free(sc
->cert_chain
, X509_free
);
391 for (i
= 0; i
< SSL_PKEY_NUM
; i
++)
392 X509_free(sc
->peer_pkeys
[i
].x509
);
394 DH_free(sc
->peer_dh_tmp
);
395 EC_KEY_free(sc
->peer_ecdh_tmp
);
396 free(sc
->peer_x25519_tmp
);
402 ssl_verify_cert_chain(SSL
*s
, STACK_OF(X509
) *sk
)
408 if ((sk
== NULL
) || (sk_X509_num(sk
) == 0))
411 x
= sk_X509_value(sk
, 0);
412 if (!X509_STORE_CTX_init(&ctx
, s
->ctx
->cert_store
, x
, sk
)) {
413 SSLerror(s
, ERR_R_X509_LIB
);
416 X509_STORE_CTX_set_ex_data(&ctx
,
417 SSL_get_ex_data_X509_STORE_CTX_idx(), s
);
420 * We need to inherit the verify parameters. These can be
421 * determined by the context: if its a server it will verify
422 * SSL client certificates or vice versa.
424 X509_STORE_CTX_set_default(&ctx
,
425 s
->server
? "ssl_client" : "ssl_server");
428 * Anything non-default in "param" should overwrite anything
431 X509_VERIFY_PARAM_set1(X509_STORE_CTX_get0_param(&ctx
), s
->param
);
433 if (s
->internal
->verify_callback
)
434 X509_STORE_CTX_set_verify_cb(&ctx
, s
->internal
->verify_callback
);
436 if (s
->ctx
->internal
->app_verify_callback
!= NULL
)
437 ret
= s
->ctx
->internal
->app_verify_callback(&ctx
,
438 s
->ctx
->internal
->app_verify_arg
);
440 ret
= X509_verify_cert(&ctx
);
442 s
->verify_result
= ctx
.error
;
443 X509_STORE_CTX_cleanup(&ctx
);
449 set_client_CA_list(STACK_OF(X509_NAME
) **ca_list
,
450 STACK_OF(X509_NAME
) *name_list
)
452 sk_X509_NAME_pop_free(*ca_list
, X509_NAME_free
);
453 *ca_list
= name_list
;
456 STACK_OF(X509_NAME
) *
457 SSL_dup_CA_list(STACK_OF(X509_NAME
) *sk
)
460 STACK_OF(X509_NAME
) *ret
;
463 ret
= sk_X509_NAME_new_null();
464 for (i
= 0; i
< sk_X509_NAME_num(sk
); i
++) {
465 name
= X509_NAME_dup(sk_X509_NAME_value(sk
, i
));
466 if ((name
== NULL
) || !sk_X509_NAME_push(ret
, name
)) {
467 sk_X509_NAME_pop_free(ret
, X509_NAME_free
);
475 SSL_set_client_CA_list(SSL
*s
, STACK_OF(X509_NAME
) *name_list
)
477 set_client_CA_list(&(s
->internal
->client_CA
), name_list
);
481 SSL_CTX_set_client_CA_list(SSL_CTX
*ctx
, STACK_OF(X509_NAME
) *name_list
)
483 set_client_CA_list(&(ctx
->internal
->client_CA
), name_list
);
486 STACK_OF(X509_NAME
) *
487 SSL_CTX_get_client_CA_list(const SSL_CTX
*ctx
)
489 return (ctx
->internal
->client_CA
);
492 STACK_OF(X509_NAME
) *
493 SSL_get_client_CA_list(const SSL
*s
)
495 if (s
->internal
->type
== SSL_ST_CONNECT
) {
496 /* We are in the client. */
497 if (((s
->version
>> 8) == SSL3_VERSION_MAJOR
) &&
499 return (S3I(s
)->tmp
.ca_names
);
503 if (s
->internal
->client_CA
!= NULL
)
504 return (s
->internal
->client_CA
);
506 return (s
->ctx
->internal
->client_CA
);
511 add_client_CA(STACK_OF(X509_NAME
) **sk
, X509
*x
)
517 if ((*sk
== NULL
) && ((*sk
= sk_X509_NAME_new_null()) == NULL
))
520 if ((name
= X509_NAME_dup(X509_get_subject_name(x
))) == NULL
)
523 if (!sk_X509_NAME_push(*sk
, name
)) {
524 X509_NAME_free(name
);
531 SSL_add_client_CA(SSL
*ssl
, X509
*x
)
533 return (add_client_CA(&(ssl
->internal
->client_CA
), x
));
537 SSL_CTX_add_client_CA(SSL_CTX
*ctx
, X509
*x
)
539 return (add_client_CA(&(ctx
->internal
->client_CA
), x
));
543 xname_cmp(const X509_NAME
* const *a
, const X509_NAME
* const *b
)
545 return (X509_NAME_cmp(*a
, *b
));
549 * Load CA certs from a file into a ::STACK. Note that it is somewhat misnamed;
550 * it doesn't really have anything to do with clients (except that a common use
551 * for a stack of CAs is to send it to the client). Actually, it doesn't have
552 * much to do with CAs, either, since it will load any old cert.
553 * \param file the file containing one or more certs.
554 * \return a ::STACK containing the certs.
556 STACK_OF(X509_NAME
) *
557 SSL_load_client_CA_file(const char *file
)
561 X509_NAME
*xn
= NULL
;
562 STACK_OF(X509_NAME
) *ret
= NULL
, *sk
;
564 sk
= sk_X509_NAME_new(xname_cmp
);
566 in
= BIO_new(BIO_s_file_internal());
568 if ((sk
== NULL
) || (in
== NULL
)) {
569 SSLerrorx(ERR_R_MALLOC_FAILURE
);
573 if (!BIO_read_filename(in
, file
))
577 if (PEM_read_bio_X509(in
, &x
, NULL
, NULL
) == NULL
)
580 ret
= sk_X509_NAME_new_null();
582 SSLerrorx(ERR_R_MALLOC_FAILURE
);
586 if ((xn
= X509_get_subject_name(x
)) == NULL
) goto err
;
587 /* check for duplicates */
588 xn
= X509_NAME_dup(xn
);
591 if (sk_X509_NAME_find(sk
, xn
) >= 0)
594 sk_X509_NAME_push(sk
, xn
);
595 sk_X509_NAME_push(ret
, xn
);
601 sk_X509_NAME_pop_free(ret
, X509_NAME_free
);
604 sk_X509_NAME_free(sk
);
614 * Add a file of certs to a stack.
615 * \param stack the stack to add to.
616 * \param file the file to add from. All certs in this file that are not
617 * already in the stack will be added.
618 * \return 1 for success, 0 for failure. Note that in the case of failure some
619 * certs may have been added to \c stack.
623 SSL_add_file_cert_subjects_to_stack(STACK_OF(X509_NAME
) *stack
,
628 X509_NAME
*xn
= NULL
;
630 int (*oldcmp
)(const X509_NAME
* const *a
, const X509_NAME
* const *b
);
632 oldcmp
= sk_X509_NAME_set_cmp_func(stack
, xname_cmp
);
634 in
= BIO_new(BIO_s_file_internal());
637 SSLerrorx(ERR_R_MALLOC_FAILURE
);
641 if (!BIO_read_filename(in
, file
))
645 if (PEM_read_bio_X509(in
, &x
, NULL
, NULL
) == NULL
)
647 if ((xn
= X509_get_subject_name(x
)) == NULL
) goto err
;
648 xn
= X509_NAME_dup(xn
);
651 if (sk_X509_NAME_find(stack
, xn
) >= 0)
654 sk_X509_NAME_push(stack
, xn
);
666 (void)sk_X509_NAME_set_cmp_func(stack
, oldcmp
);
672 * Add a directory of certs to a stack.
673 * \param stack the stack to append to.
674 * \param dir the directory to append from. All files in this directory will be
675 * examined as potential certs. Any that are acceptable to
676 * SSL_add_dir_cert_subjects_to_stack() that are not already in the stack will
678 * \return 1 for success, 0 for failure. Note that in the case of failure some
679 * certs may have been added to \c stack.
683 SSL_add_dir_cert_subjects_to_stack(STACK_OF(X509_NAME
) *stack
, const char *dir
)
692 while ((dp
= readdir(dirp
)) != NULL
) {
693 if (asprintf(&path
, "%s/%s", dir
, dp
->d_name
) != -1) {
694 ret
= SSL_add_file_cert_subjects_to_stack(
701 (void) closedir(dirp
);
705 ERR_asprintf_error_data("opendir ('%s')", dir
);
706 SSLerrorx(ERR_R_SYS_LIB
);