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 int ssl_x509_store_ctx_idx= -1;
134 /* FIXME: should do locking */
135 if (ssl_x509_store_ctx_idx < 0)
137 ssl_x509_store_ctx_idx=X509_STORE_CTX_get_ex_new_index(
138 0,"SSL for verify callback",NULL,NULL,NULL);
140 return(ssl_x509_store_ctx_idx);
143 CERT *ssl_cert_new(void)
147 ret=(CERT *)OPENSSL_malloc(sizeof(CERT));
150 SSLerr(SSL_F_SSL_CERT_NEW,ERR_R_MALLOC_FAILURE);
153 memset(ret,0,sizeof(CERT));
155 ret->key= &(ret->pkeys[SSL_PKEY_RSA_ENC]);
161 CERT *ssl_cert_dup(CERT *cert)
166 ret = (CERT *)OPENSSL_malloc(sizeof(CERT));
169 SSLerr(SSL_F_SSL_CERT_DUP, ERR_R_MALLOC_FAILURE);
173 memset(ret, 0, sizeof(CERT));
175 ret->key = &ret->pkeys[cert->key - &cert->pkeys[0]];
176 /* or ret->key = ret->pkeys + (cert->key - cert->pkeys),
177 * if you find that more readable */
179 ret->valid = cert->valid;
180 ret->mask = cert->mask;
181 ret->export_mask = cert->export_mask;
184 if (cert->rsa_tmp != NULL)
186 ret->rsa_tmp = cert->rsa_tmp;
187 CRYPTO_add(&ret->rsa_tmp->references, 1, CRYPTO_LOCK_RSA);
189 ret->rsa_tmp_cb = cert->rsa_tmp_cb;
193 if (cert->dh_tmp != NULL)
195 /* DH parameters don't have a reference count */
196 ret->dh_tmp = DHparams_dup(cert->dh_tmp);
197 if (ret->dh_tmp == NULL)
199 SSLerr(SSL_F_SSL_CERT_DUP, ERR_R_DH_LIB);
202 if (cert->dh_tmp->priv_key)
204 BIGNUM *b = BN_dup(cert->dh_tmp->priv_key);
207 SSLerr(SSL_F_SSL_CERT_DUP, ERR_R_BN_LIB);
210 ret->dh_tmp->priv_key = b;
212 if (cert->dh_tmp->pub_key)
214 BIGNUM *b = BN_dup(cert->dh_tmp->pub_key);
217 SSLerr(SSL_F_SSL_CERT_DUP, ERR_R_BN_LIB);
220 ret->dh_tmp->pub_key = b;
223 ret->dh_tmp_cb = cert->dh_tmp_cb;
226 for (i = 0; i < SSL_PKEY_NUM; i++)
228 if (cert->pkeys[i].x509 != NULL)
230 ret->pkeys[i].x509 = cert->pkeys[i].x509;
231 CRYPTO_add(&ret->pkeys[i].x509->references, 1,
235 if (cert->pkeys[i].privatekey != NULL)
237 ret->pkeys[i].privatekey = cert->pkeys[i].privatekey;
238 CRYPTO_add(&ret->pkeys[i].privatekey->references, 1,
239 CRYPTO_LOCK_EVP_PKEY);
243 /* If there was anything special to do for
244 * certain types of keys, we'd do it here.
245 * (Nothing at the moment, I think.) */
247 case SSL_PKEY_RSA_ENC:
248 case SSL_PKEY_RSA_SIGN:
249 /* We have an RSA key. */
252 case SSL_PKEY_DSA_SIGN:
253 /* We have a DSA key. */
256 case SSL_PKEY_DH_RSA:
257 case SSL_PKEY_DH_DSA:
258 /* We have a DH key. */
263 SSLerr(SSL_F_SSL_CERT_DUP, SSL_R_LIBRARY_BUG);
268 /* ret->extra_certs *should* exist, but currently the own certificate
269 * chain is held inside SSL_CTX */
275 #ifndef NO_DH /* avoid 'unreferenced label' warning if NO_DH is defined */
279 if (ret->rsa_tmp != NULL)
280 RSA_free(ret->rsa_tmp);
283 if (ret->dh_tmp != NULL)
284 DH_free(ret->dh_tmp);
287 for (i = 0; i < SSL_PKEY_NUM; i++)
289 if (ret->pkeys[i].x509 != NULL)
290 X509_free(ret->pkeys[i].x509);
291 if (ret->pkeys[i].privatekey != NULL)
292 EVP_PKEY_free(ret->pkeys[i].privatekey);
299 void ssl_cert_free(CERT *c)
306 i=CRYPTO_add(&c->references,-1,CRYPTO_LOCK_SSL_CERT);
314 fprintf(stderr,"ssl_cert_free, bad reference count\n");
320 if (c->rsa_tmp) RSA_free(c->rsa_tmp);
323 if (c->dh_tmp) DH_free(c->dh_tmp);
326 for (i=0; i<SSL_PKEY_NUM; i++)
328 if (c->pkeys[i].x509 != NULL)
329 X509_free(c->pkeys[i].x509);
330 if (c->pkeys[i].privatekey != NULL)
331 EVP_PKEY_free(c->pkeys[i].privatekey);
333 if (c->pkeys[i].publickey != NULL)
334 EVP_PKEY_free(c->pkeys[i].publickey);
340 int ssl_cert_inst(CERT **o)
342 /* Create a CERT if there isn't already one
343 * (which cannot really happen, as it is initially created in
344 * SSL_CTX_new; but the earlier code usually allows for that one
345 * being non-existant, so we follow that behaviour, as it might
346 * turn out that there actually is a reason for it -- but I'm
347 * not sure that *all* of the existing code could cope with
348 * s->cert being NULL, otherwise we could do without the
349 * initialization in SSL_CTX_new).
354 SSLerr(SSL_F_SSL_CERT_INST, ERR_R_PASSED_NULL_PARAMETER);
359 if ((*o = ssl_cert_new()) == NULL)
361 SSLerr(SSL_F_SSL_CERT_INST, ERR_R_MALLOC_FAILURE);
369 SESS_CERT *ssl_sess_cert_new(void)
373 ret = OPENSSL_malloc(sizeof *ret);
376 SSLerr(SSL_F_SSL_SESS_CERT_NEW, ERR_R_MALLOC_FAILURE);
380 memset(ret, 0 ,sizeof *ret);
381 ret->peer_key = &(ret->peer_pkeys[SSL_PKEY_RSA_ENC]);
387 void ssl_sess_cert_free(SESS_CERT *sc)
394 i = CRYPTO_add(&sc->references, -1, CRYPTO_LOCK_SSL_SESS_CERT);
396 REF_PRINT("SESS_CERT", sc);
403 fprintf(stderr,"ssl_sess_cert_free, bad reference count\n");
409 if (sc->cert_chain != NULL)
410 sk_X509_pop_free(sc->cert_chain, X509_free);
411 for (i = 0; i < SSL_PKEY_NUM; i++)
413 if (sc->peer_pkeys[i].x509 != NULL)
414 X509_free(sc->peer_pkeys[i].x509);
415 #if 0 /* We don't have the peer's private key. These lines are just
416 * here as a reminder that we're still using a not-quite-appropriate
418 if (sc->peer_pkeys[i].privatekey != NULL)
419 EVP_PKEY_free(sc->peer_pkeys[i].privatekey);
424 if (sc->peer_rsa_tmp != NULL)
425 RSA_free(sc->peer_rsa_tmp);
428 if (sc->peer_dh_tmp != NULL)
429 DH_free(sc->peer_dh_tmp);
435 int ssl_set_peer_cert_type(SESS_CERT *sc,int type)
437 sc->peer_cert_type = type;
441 int ssl_verify_cert_chain(SSL *s,STACK_OF(X509) *sk)
447 if ((sk == NULL) || (sk_X509_num(sk) == 0))
450 x=sk_X509_value(sk,0);
451 X509_STORE_CTX_init(&ctx,s->ctx->cert_store,x,sk);
452 if (SSL_get_verify_depth(s) >= 0)
453 X509_STORE_CTX_set_depth(&ctx, SSL_get_verify_depth(s));
454 X509_STORE_CTX_set_ex_data(&ctx,SSL_get_ex_data_X509_STORE_CTX_idx(),s);
455 /* We need to set the verify purpose. The purpose can be determined by
456 * the context: if its a server it will verify SSL client certificates
460 if(s->server) i = X509_PURPOSE_SSL_CLIENT;
461 else i = X509_PURPOSE_SSL_SERVER;
463 X509_STORE_CTX_purpose_inherit(&ctx, i, s->purpose, s->trust);
465 if (s->ctx->app_verify_callback != NULL)
466 i=s->ctx->app_verify_callback(&ctx); /* should pass app_verify_arg */
469 #ifndef NO_X509_VERIFY
470 i=X509_verify_cert(&ctx);
473 ctx.error=X509_V_ERR_APPLICATION_VERIFICATION;
474 SSLerr(SSL_F_SSL_VERIFY_CERT_CHAIN,SSL_R_NO_VERIFY_CALLBACK);
478 s->verify_result=ctx.error;
479 X509_STORE_CTX_cleanup(&ctx);
484 static void set_client_CA_list(STACK_OF(X509_NAME) **ca_list,STACK_OF(X509_NAME) *list)
486 if (*ca_list != NULL)
487 sk_X509_NAME_pop_free(*ca_list,X509_NAME_free);
492 STACK_OF(X509_NAME) *SSL_dup_CA_list(STACK_OF(X509_NAME) *sk)
495 STACK_OF(X509_NAME) *ret;
498 ret=sk_X509_NAME_new_null();
499 for (i=0; i<sk_X509_NAME_num(sk); i++)
501 name=X509_NAME_dup(sk_X509_NAME_value(sk,i));
502 if ((name == NULL) || !sk_X509_NAME_push(ret,name))
504 sk_X509_NAME_pop_free(ret,X509_NAME_free);
511 void SSL_set_client_CA_list(SSL *s,STACK_OF(X509_NAME) *list)
513 set_client_CA_list(&(s->client_CA),list);
516 void SSL_CTX_set_client_CA_list(SSL_CTX *ctx,STACK_OF(X509_NAME) *list)
518 set_client_CA_list(&(ctx->client_CA),list);
521 STACK_OF(X509_NAME) *SSL_CTX_get_client_CA_list(SSL_CTX *ctx)
523 return(ctx->client_CA);
526 STACK_OF(X509_NAME) *SSL_get_client_CA_list(SSL *s)
528 if (s->type == SSL_ST_CONNECT)
529 { /* we are in the client */
530 if (((s->version>>8) == SSL3_VERSION_MAJOR) &&
532 return(s->s3->tmp.ca_names);
538 if (s->client_CA != NULL)
539 return(s->client_CA);
541 return(s->ctx->client_CA);
545 static int add_client_CA(STACK_OF(X509_NAME) **sk,X509 *x)
549 if (x == NULL) return(0);
550 if ((*sk == NULL) && ((*sk=sk_X509_NAME_new_null()) == NULL))
553 if ((name=X509_NAME_dup(X509_get_subject_name(x))) == NULL)
556 if (!sk_X509_NAME_push(*sk,name))
558 X509_NAME_free(name);
564 int SSL_add_client_CA(SSL *ssl,X509 *x)
566 return(add_client_CA(&(ssl->client_CA),x));
569 int SSL_CTX_add_client_CA(SSL_CTX *ctx,X509 *x)
571 return(add_client_CA(&(ctx->client_CA),x));
574 static int xname_cmp(const X509_NAME * const *a, const X509_NAME * const *b)
576 return(X509_NAME_cmp(*a,*b));
581 * Load CA certs from a file into a ::STACK. Note that it is somewhat misnamed;
582 * it doesn't really have anything to do with clients (except that a common use
583 * for a stack of CAs is to send it to the client). Actually, it doesn't have
584 * much to do with CAs, either, since it will load any old cert.
585 * \param file the file containing one or more certs.
586 * \return a ::STACK containing the certs.
588 STACK_OF(X509_NAME) *SSL_load_client_CA_file(const char *file)
593 STACK_OF(X509_NAME) *ret,*sk;
595 ret=sk_X509_NAME_new_null();
596 sk=sk_X509_NAME_new(xname_cmp);
598 in=BIO_new(BIO_s_file_internal());
600 if ((ret == NULL) || (sk == NULL) || (in == NULL))
602 SSLerr(SSL_F_SSL_LOAD_CLIENT_CA_FILE,ERR_R_MALLOC_FAILURE);
606 if (!BIO_read_filename(in,file))
611 if (PEM_read_bio_X509(in,&x,NULL,NULL) == NULL)
613 if ((xn=X509_get_subject_name(x)) == NULL) goto err;
614 /* check for duplicates */
615 xn=X509_NAME_dup(xn);
616 if (xn == NULL) goto err;
617 if (sk_X509_NAME_find(sk,xn) >= 0)
621 sk_X509_NAME_push(sk,xn);
622 sk_X509_NAME_push(ret,xn);
629 if (ret != NULL) sk_X509_NAME_pop_free(ret,X509_NAME_free);
632 if (sk != NULL) sk_X509_NAME_free(sk);
633 if (in != NULL) BIO_free(in);
634 if (x != NULL) X509_free(x);
640 * Add a file of certs to a stack.
641 * \param stack the stack to add to.
642 * \param file the file to add from. All certs in this file that are not
643 * already in the stack will be added.
644 * \return 1 for success, 0 for failure. Note that in the case of failure some
645 * certs may have been added to \c stack.
648 int SSL_add_file_cert_subjects_to_stack(STACK_OF(X509_NAME) *stack,
655 int (*oldcmp)(const X509_NAME * const *a, const X509_NAME * const *b);
657 oldcmp=sk_X509_NAME_set_cmp_func(stack,xname_cmp);
659 in=BIO_new(BIO_s_file_internal());
663 SSLerr(SSL_F_SSL_ADD_FILE_CERT_SUBJECTS_TO_STACK,ERR_R_MALLOC_FAILURE);
667 if (!BIO_read_filename(in,file))
672 if (PEM_read_bio_X509(in,&x,NULL,NULL) == NULL)
674 if ((xn=X509_get_subject_name(x)) == NULL) goto err;
675 xn=X509_NAME_dup(xn);
676 if (xn == NULL) goto err;
677 if (sk_X509_NAME_find(stack,xn) >= 0)
680 sk_X509_NAME_push(stack,xn);
693 sk_X509_NAME_set_cmp_func(stack,oldcmp);
699 * Add a directory of certs to a stack.
700 * \param stack the stack to append to.
701 * \param dir the directory to append from. All files in this directory will be
702 * examined as potential certs. Any that are acceptable to
703 * SSL_add_dir_cert_subjects_to_stack() that are not already in the stack will be
705 * \return 1 for success, 0 for failure. Note that in the case of failure some
706 * certs may have been added to \c stack.
710 #ifndef VMS /* XXXX This may be fixed in the future */
713 int SSL_add_dir_cert_subjects_to_stack(STACK_OF(X509_NAME) *stack,
717 struct dirent *dstruct;
720 CRYPTO_w_lock(CRYPTO_LOCK_READDIR);
723 /* Note that a side effect is that the CAs will be sorted by name */
726 SYSerr(SYS_F_OPENDIR, get_last_sys_error());
727 ERR_add_error_data(3, "opendir('", dir, "')");
728 SSLerr(SSL_F_SSL_ADD_DIR_CERT_SUBJECTS_TO_STACK, ERR_R_SYS_LIB);
732 while((dstruct=readdir(d)))
737 if(strlen(dir)+strlen(dstruct->d_name)+2 > sizeof buf)
739 SSLerr(SSL_F_SSL_ADD_DIR_CERT_SUBJECTS_TO_STACK,SSL_R_PATH_TOO_LONG);
743 r = BIO_snprintf(buf,sizeof buf,"%s/%s",dir,dstruct->d_name);
744 if (r <= 0 || r >= sizeof buf)
746 if(!SSL_add_file_cert_subjects_to_stack(stack,buf))
752 CRYPTO_w_unlock(CRYPTO_LOCK_READDIR);