1 /*! \file ssl/ssl_cert.c */
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) 1999 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 * ====================================================================
109 #include "openssl/e_os.h"
111 #ifndef NO_SYS_TYPES_H
112 # include <sys/types.h>
115 #if !defined(WIN32) && !defined(VSM) && !defined(NeXT) && !defined(MAC_OS_pre_X)
121 #define dirent direct
124 #include <openssl/objects.h>
125 #include <openssl/bio.h>
126 #include <openssl/pem.h>
127 #include <openssl/x509v3.h>
128 #include "ssl_locl.h"
130 int SSL_get_ex_data_X509_STORE_CTX_idx(void)
132 static volatile int ssl_x509_store_ctx_idx= -1;
134 if (ssl_x509_store_ctx_idx < 0)
136 /* any write lock will do; usually this branch
137 * will only be taken once anyway */
138 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
140 if (ssl_x509_store_ctx_idx < 0)
142 ssl_x509_store_ctx_idx=X509_STORE_CTX_get_ex_new_index(
143 0,"SSL for verify callback",NULL,NULL,NULL);
146 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
148 return ssl_x509_store_ctx_idx;
151 CERT *ssl_cert_new(void)
155 ret=(CERT *)OPENSSL_malloc(sizeof(CERT));
158 SSLerr(SSL_F_SSL_CERT_NEW,ERR_R_MALLOC_FAILURE);
161 memset(ret,0,sizeof(CERT));
163 ret->key= &(ret->pkeys[SSL_PKEY_RSA_ENC]);
169 CERT *ssl_cert_dup(CERT *cert)
174 ret = (CERT *)OPENSSL_malloc(sizeof(CERT));
177 SSLerr(SSL_F_SSL_CERT_DUP, ERR_R_MALLOC_FAILURE);
181 memset(ret, 0, sizeof(CERT));
183 ret->key = &ret->pkeys[cert->key - &cert->pkeys[0]];
184 /* or ret->key = ret->pkeys + (cert->key - cert->pkeys),
185 * if you find that more readable */
187 ret->valid = cert->valid;
188 ret->mask = cert->mask;
189 ret->export_mask = cert->export_mask;
192 if (cert->rsa_tmp != NULL)
194 ret->rsa_tmp = cert->rsa_tmp;
195 CRYPTO_add(&ret->rsa_tmp->references, 1, CRYPTO_LOCK_RSA);
197 ret->rsa_tmp_cb = cert->rsa_tmp_cb;
201 if (cert->dh_tmp != NULL)
203 /* DH parameters don't have a reference count */
204 ret->dh_tmp = DHparams_dup(cert->dh_tmp);
205 if (ret->dh_tmp == NULL)
207 SSLerr(SSL_F_SSL_CERT_DUP, ERR_R_DH_LIB);
210 if (cert->dh_tmp->priv_key)
212 BIGNUM *b = BN_dup(cert->dh_tmp->priv_key);
215 SSLerr(SSL_F_SSL_CERT_DUP, ERR_R_BN_LIB);
218 ret->dh_tmp->priv_key = b;
220 if (cert->dh_tmp->pub_key)
222 BIGNUM *b = BN_dup(cert->dh_tmp->pub_key);
225 SSLerr(SSL_F_SSL_CERT_DUP, ERR_R_BN_LIB);
228 ret->dh_tmp->pub_key = b;
231 ret->dh_tmp_cb = cert->dh_tmp_cb;
234 for (i = 0; i < SSL_PKEY_NUM; i++)
236 if (cert->pkeys[i].x509 != NULL)
238 ret->pkeys[i].x509 = cert->pkeys[i].x509;
239 CRYPTO_add(&ret->pkeys[i].x509->references, 1,
243 if (cert->pkeys[i].privatekey != NULL)
245 ret->pkeys[i].privatekey = cert->pkeys[i].privatekey;
246 CRYPTO_add(&ret->pkeys[i].privatekey->references, 1,
247 CRYPTO_LOCK_EVP_PKEY);
251 /* If there was anything special to do for
252 * certain types of keys, we'd do it here.
253 * (Nothing at the moment, I think.) */
255 case SSL_PKEY_RSA_ENC:
256 case SSL_PKEY_RSA_SIGN:
257 /* We have an RSA key. */
260 case SSL_PKEY_DSA_SIGN:
261 /* We have a DSA key. */
264 case SSL_PKEY_DH_RSA:
265 case SSL_PKEY_DH_DSA:
266 /* We have a DH key. */
271 SSLerr(SSL_F_SSL_CERT_DUP, SSL_R_LIBRARY_BUG);
276 /* ret->extra_certs *should* exist, but currently the own certificate
277 * chain is held inside SSL_CTX */
283 #ifndef NO_DH /* avoid 'unreferenced label' warning if NO_DH is defined */
287 if (ret->rsa_tmp != NULL)
288 RSA_free(ret->rsa_tmp);
291 if (ret->dh_tmp != NULL)
292 DH_free(ret->dh_tmp);
295 for (i = 0; i < SSL_PKEY_NUM; i++)
297 if (ret->pkeys[i].x509 != NULL)
298 X509_free(ret->pkeys[i].x509);
299 if (ret->pkeys[i].privatekey != NULL)
300 EVP_PKEY_free(ret->pkeys[i].privatekey);
307 void ssl_cert_free(CERT *c)
314 i=CRYPTO_add(&c->references,-1,CRYPTO_LOCK_SSL_CERT);
322 fprintf(stderr,"ssl_cert_free, bad reference count\n");
328 if (c->rsa_tmp) RSA_free(c->rsa_tmp);
331 if (c->dh_tmp) DH_free(c->dh_tmp);
334 for (i=0; i<SSL_PKEY_NUM; i++)
336 if (c->pkeys[i].x509 != NULL)
337 X509_free(c->pkeys[i].x509);
338 if (c->pkeys[i].privatekey != NULL)
339 EVP_PKEY_free(c->pkeys[i].privatekey);
341 if (c->pkeys[i].publickey != NULL)
342 EVP_PKEY_free(c->pkeys[i].publickey);
348 int ssl_cert_inst(CERT **o)
350 /* Create a CERT if there isn't already one
351 * (which cannot really happen, as it is initially created in
352 * SSL_CTX_new; but the earlier code usually allows for that one
353 * being non-existant, so we follow that behaviour, as it might
354 * turn out that there actually is a reason for it -- but I'm
355 * not sure that *all* of the existing code could cope with
356 * s->cert being NULL, otherwise we could do without the
357 * initialization in SSL_CTX_new).
362 SSLerr(SSL_F_SSL_CERT_INST, ERR_R_PASSED_NULL_PARAMETER);
367 if ((*o = ssl_cert_new()) == NULL)
369 SSLerr(SSL_F_SSL_CERT_INST, ERR_R_MALLOC_FAILURE);
377 SESS_CERT *ssl_sess_cert_new(void)
381 ret = OPENSSL_malloc(sizeof *ret);
384 SSLerr(SSL_F_SSL_SESS_CERT_NEW, ERR_R_MALLOC_FAILURE);
388 memset(ret, 0 ,sizeof *ret);
389 ret->peer_key = &(ret->peer_pkeys[SSL_PKEY_RSA_ENC]);
395 void ssl_sess_cert_free(SESS_CERT *sc)
402 i = CRYPTO_add(&sc->references, -1, CRYPTO_LOCK_SSL_SESS_CERT);
404 REF_PRINT("SESS_CERT", sc);
411 fprintf(stderr,"ssl_sess_cert_free, bad reference count\n");
417 if (sc->cert_chain != NULL)
418 sk_X509_pop_free(sc->cert_chain, X509_free);
419 for (i = 0; i < SSL_PKEY_NUM; i++)
421 if (sc->peer_pkeys[i].x509 != NULL)
422 X509_free(sc->peer_pkeys[i].x509);
423 #if 0 /* We don't have the peer's private key. These lines are just
424 * here as a reminder that we're still using a not-quite-appropriate
426 if (sc->peer_pkeys[i].privatekey != NULL)
427 EVP_PKEY_free(sc->peer_pkeys[i].privatekey);
432 if (sc->peer_rsa_tmp != NULL)
433 RSA_free(sc->peer_rsa_tmp);
436 if (sc->peer_dh_tmp != NULL)
437 DH_free(sc->peer_dh_tmp);
443 int ssl_set_peer_cert_type(SESS_CERT *sc,int type)
445 sc->peer_cert_type = type;
449 int ssl_verify_cert_chain(SSL *s,STACK_OF(X509) *sk)
455 if ((sk == NULL) || (sk_X509_num(sk) == 0))
458 x=sk_X509_value(sk,0);
459 X509_STORE_CTX_init(&ctx,s->ctx->cert_store,x,sk);
460 if (SSL_get_verify_depth(s) >= 0)
461 X509_STORE_CTX_set_depth(&ctx, SSL_get_verify_depth(s));
462 X509_STORE_CTX_set_ex_data(&ctx,SSL_get_ex_data_X509_STORE_CTX_idx(),s);
464 /* We need to set the verify purpose. The purpose can be determined by
465 * the context: if its a server it will verify SSL client certificates
469 i = X509_PURPOSE_SSL_CLIENT;
471 i = X509_PURPOSE_SSL_SERVER;
473 X509_STORE_CTX_purpose_inherit(&ctx, i, s->purpose, s->trust);
475 if (s->ctx->app_verify_callback != NULL)
476 i=s->ctx->app_verify_callback(&ctx); /* should pass app_verify_arg */
479 #ifndef NO_X509_VERIFY
480 i=X509_verify_cert(&ctx);
483 ctx.error=X509_V_ERR_APPLICATION_VERIFICATION;
484 SSLerr(SSL_F_SSL_VERIFY_CERT_CHAIN,SSL_R_NO_VERIFY_CALLBACK);
488 s->verify_result=ctx.error;
489 X509_STORE_CTX_cleanup(&ctx);
494 static void set_client_CA_list(STACK_OF(X509_NAME) **ca_list,STACK_OF(X509_NAME) *list)
496 if (*ca_list != NULL)
497 sk_X509_NAME_pop_free(*ca_list,X509_NAME_free);
502 STACK_OF(X509_NAME) *SSL_dup_CA_list(STACK_OF(X509_NAME) *sk)
505 STACK_OF(X509_NAME) *ret;
508 ret=sk_X509_NAME_new_null();
509 for (i=0; i<sk_X509_NAME_num(sk); i++)
511 name=X509_NAME_dup(sk_X509_NAME_value(sk,i));
512 if ((name == NULL) || !sk_X509_NAME_push(ret,name))
514 sk_X509_NAME_pop_free(ret,X509_NAME_free);
521 void SSL_set_client_CA_list(SSL *s,STACK_OF(X509_NAME) *list)
523 set_client_CA_list(&(s->client_CA),list);
526 void SSL_CTX_set_client_CA_list(SSL_CTX *ctx,STACK_OF(X509_NAME) *list)
528 set_client_CA_list(&(ctx->client_CA),list);
531 STACK_OF(X509_NAME) *SSL_CTX_get_client_CA_list(SSL_CTX *ctx)
533 return(ctx->client_CA);
536 STACK_OF(X509_NAME) *SSL_get_client_CA_list(SSL *s)
538 if (s->type == SSL_ST_CONNECT)
539 { /* we are in the client */
540 if (((s->version>>8) == SSL3_VERSION_MAJOR) &&
542 return(s->s3->tmp.ca_names);
548 if (s->client_CA != NULL)
549 return(s->client_CA);
551 return(s->ctx->client_CA);
555 static int add_client_CA(STACK_OF(X509_NAME) **sk,X509 *x)
559 if (x == NULL) return(0);
560 if ((*sk == NULL) && ((*sk=sk_X509_NAME_new_null()) == NULL))
563 if ((name=X509_NAME_dup(X509_get_subject_name(x))) == NULL)
566 if (!sk_X509_NAME_push(*sk,name))
568 X509_NAME_free(name);
574 int SSL_add_client_CA(SSL *ssl,X509 *x)
576 return(add_client_CA(&(ssl->client_CA),x));
579 int SSL_CTX_add_client_CA(SSL_CTX *ctx,X509 *x)
581 return(add_client_CA(&(ctx->client_CA),x));
584 static int xname_cmp(const X509_NAME * const *a, const X509_NAME * const *b)
586 return(X509_NAME_cmp(*a,*b));
591 * Load CA certs from a file into a ::STACK. Note that it is somewhat misnamed;
592 * it doesn't really have anything to do with clients (except that a common use
593 * for a stack of CAs is to send it to the client). Actually, it doesn't have
594 * much to do with CAs, either, since it will load any old cert.
595 * \param file the file containing one or more certs.
596 * \return a ::STACK containing the certs.
598 STACK_OF(X509_NAME) *SSL_load_client_CA_file(const char *file)
603 STACK_OF(X509_NAME) *ret,*sk;
605 ret=sk_X509_NAME_new_null();
606 sk=sk_X509_NAME_new(xname_cmp);
608 in=BIO_new(BIO_s_file_internal());
610 if ((ret == NULL) || (sk == NULL) || (in == NULL))
612 SSLerr(SSL_F_SSL_LOAD_CLIENT_CA_FILE,ERR_R_MALLOC_FAILURE);
616 if (!BIO_read_filename(in,file))
621 if (PEM_read_bio_X509(in,&x,NULL,NULL) == NULL)
623 if ((xn=X509_get_subject_name(x)) == NULL) goto err;
624 /* check for duplicates */
625 xn=X509_NAME_dup(xn);
626 if (xn == NULL) goto err;
627 if (sk_X509_NAME_find(sk,xn) >= 0)
631 sk_X509_NAME_push(sk,xn);
632 sk_X509_NAME_push(ret,xn);
639 if (ret != NULL) sk_X509_NAME_pop_free(ret,X509_NAME_free);
642 if (sk != NULL) sk_X509_NAME_free(sk);
643 if (in != NULL) BIO_free(in);
644 if (x != NULL) X509_free(x);
650 * Add a file of certs to a stack.
651 * \param stack the stack to add to.
652 * \param file the file to add from. All certs in this file that are not
653 * already in the stack will be added.
654 * \return 1 for success, 0 for failure. Note that in the case of failure some
655 * certs may have been added to \c stack.
658 int SSL_add_file_cert_subjects_to_stack(STACK_OF(X509_NAME) *stack,
665 int (*oldcmp)(const X509_NAME * const *a, const X509_NAME * const *b);
667 oldcmp=sk_X509_NAME_set_cmp_func(stack,xname_cmp);
669 in=BIO_new(BIO_s_file_internal());
673 SSLerr(SSL_F_SSL_ADD_FILE_CERT_SUBJECTS_TO_STACK,ERR_R_MALLOC_FAILURE);
677 if (!BIO_read_filename(in,file))
682 if (PEM_read_bio_X509(in,&x,NULL,NULL) == NULL)
684 if ((xn=X509_get_subject_name(x)) == NULL) goto err;
685 xn=X509_NAME_dup(xn);
686 if (xn == NULL) goto err;
687 if (sk_X509_NAME_find(stack,xn) >= 0)
690 sk_X509_NAME_push(stack,xn);
703 sk_X509_NAME_set_cmp_func(stack,oldcmp);
709 * Add a directory of certs to a stack.
710 * \param stack the stack to append to.
711 * \param dir the directory to append from. All files in this directory will be
712 * examined as potential certs. Any that are acceptable to
713 * SSL_add_dir_cert_subjects_to_stack() that are not already in the stack will be
715 * \return 1 for success, 0 for failure. Note that in the case of failure some
716 * certs may have been added to \c stack.
720 #ifndef VMS /* XXXX This may be fixed in the future */
723 int SSL_add_dir_cert_subjects_to_stack(STACK_OF(X509_NAME) *stack,
727 struct dirent *dstruct;
730 CRYPTO_w_lock(CRYPTO_LOCK_READDIR);
733 /* Note that a side effect is that the CAs will be sorted by name */
736 SYSerr(SYS_F_OPENDIR, get_last_sys_error());
737 ERR_add_error_data(3, "opendir('", dir, "')");
738 SSLerr(SSL_F_SSL_ADD_DIR_CERT_SUBJECTS_TO_STACK, ERR_R_SYS_LIB);
742 while((dstruct=readdir(d)))
747 if(strlen(dir)+strlen(dstruct->d_name)+2 > sizeof buf)
749 SSLerr(SSL_F_SSL_ADD_DIR_CERT_SUBJECTS_TO_STACK,SSL_R_PATH_TOO_LONG);
753 r = BIO_snprintf(buf,sizeof buf,"%s/%s",dir,dstruct->d_name);
754 if (r <= 0 || r >= sizeof buf)
756 if(!SSL_add_file_cert_subjects_to_stack(stack,buf))
762 CRYPTO_w_unlock(CRYPTO_LOCK_READDIR);