3 * Copyright 1998-2002 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
6 * tls.c - Handle tls/ssl using SSLeay or OpenSSL.
13 #include <ac/stdlib.h>
15 #include <ac/socket.h>
16 #include <ac/string.h>
18 #include <ac/unistd.h>
26 #include <ldap_pvt_thread.h>
29 #ifdef HAVE_OPENSSL_SSL_H
30 #include <openssl/ssl.h>
31 #include <openssl/x509v3.h>
32 #include <openssl/err.h>
33 #include <openssl/rand.h>
34 #include <openssl/safestack.h>
35 #elif defined( HAVE_SSL_H )
39 static int tls_opt_trace = 1;
40 static char *tls_opt_certfile = NULL;
41 static char *tls_opt_keyfile = NULL;
42 static char *tls_opt_cacertfile = NULL;
43 static char *tls_opt_cacertdir = NULL;
44 static int tls_opt_require_cert = 0;
45 static char *tls_opt_ciphersuite = NULL;
46 static char *tls_opt_randfile = NULL;
48 #define HAS_TLS( sb ) ber_sockbuf_ctrl( sb, LBER_SB_OPT_HAS_IO, \
49 (void *)&sb_tls_sbio )
51 static void tls_report_error( void );
53 static void tls_info_cb( SSL *ssl, int where, int ret );
54 static int tls_verify_cb( int ok, X509_STORE_CTX *ctx );
55 static int tls_verify_ok( int ok, X509_STORE_CTX *ctx );
56 static RSA * tls_tmp_rsa_cb( SSL *ssl, int is_export, int key_length );
57 static STACK_OF(X509_NAME) * get_ca_list( char * bundle, char * dir );
59 #if 0 /* Currently this is not used by anyone */
60 static DH * tls_tmp_dh_cb( SSL *ssl, int is_export, int key_length );
63 static SSL_CTX *tls_def_ctx = NULL;
65 static int tls_seed_PRNG( const char *randfile );
69 * provide mutexes for the SSLeay library.
71 static ldap_pvt_thread_mutex_t tls_mutexes[CRYPTO_NUM_LOCKS];
73 static void tls_locking_cb( int mode, int type, const char *file, int line )
75 if ( mode & CRYPTO_LOCK ) {
76 ldap_pvt_thread_mutex_lock( &tls_mutexes[type] );
78 ldap_pvt_thread_mutex_unlock( &tls_mutexes[type] );
83 * an extra mutex for the default ctx.
86 static ldap_pvt_thread_mutex_t tls_def_ctx_mutex;
88 static void tls_init_threads( void )
92 for( i=0; i< CRYPTO_NUM_LOCKS ; i++ ) {
93 ldap_pvt_thread_mutex_init( &tls_mutexes[i] );
95 CRYPTO_set_locking_callback( tls_locking_cb );
96 /* FIXME: the thread id should be added somehow... */
98 ldap_pvt_thread_mutex_init( &tls_def_ctx_mutex );
100 #endif /* LDAP_R_COMPILE */
103 * Tear down the TLS subsystem. Should only be called once.
106 ldap_pvt_tls_destroy( void )
108 SSL_CTX_free(tls_def_ctx);
114 if ( tls_opt_certfile ) {
115 LDAP_FREE( tls_opt_certfile );
116 tls_opt_certfile = NULL;
118 if ( tls_opt_keyfile ) {
119 LDAP_FREE( tls_opt_keyfile );
120 tls_opt_keyfile = NULL;
122 if ( tls_opt_cacertfile ) {
123 LDAP_FREE( tls_opt_cacertfile );
124 tls_opt_cacertfile = NULL;
126 if ( tls_opt_cacertdir ) {
127 LDAP_FREE( tls_opt_cacertdir );
128 tls_opt_cacertdir = NULL;
130 if ( tls_opt_ciphersuite ) {
131 LDAP_FREE( tls_opt_ciphersuite );
132 tls_opt_ciphersuite = NULL;
134 if ( tls_opt_randfile ) {
135 LDAP_FREE( tls_opt_randfile );
136 tls_opt_randfile = NULL;
141 * Initialize TLS subsystem. Should be called only once.
144 ldap_pvt_tls_init( void )
146 static int tls_initialized = 0;
148 if ( tls_initialized ) return 0;
151 (void) tls_seed_PRNG( tls_opt_randfile );
153 #ifdef LDAP_R_COMPILE
157 SSL_load_error_strings();
158 SSLeay_add_ssl_algorithms();
160 /* FIXME: mod_ssl does this */
161 X509V3_add_standard_extensions();
166 * initialize the default context
169 ldap_pvt_tls_init_def_ctx( void )
171 STACK_OF(X509_NAME) *calist;
173 #ifdef LDAP_R_COMPILE
174 ldap_pvt_thread_mutex_lock( &tls_def_ctx_mutex );
176 if ( tls_def_ctx == NULL ) {
178 tls_def_ctx = SSL_CTX_new( SSLv23_method() );
179 if ( tls_def_ctx == NULL ) {
181 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_init_def_ctx: "
182 "TLS could not allocate default ctx (%d).\n",
185 Debug( LDAP_DEBUG_ANY,
186 "TLS: could not allocate default ctx (%lu).\n",
187 ERR_peek_error(),0,0);
192 if ( tls_opt_ciphersuite &&
193 !SSL_CTX_set_cipher_list( tls_def_ctx, tls_opt_ciphersuite ) )
196 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_init_def_ctx: "
197 "TLS could not set cipher list %s.\n",
198 tls_opt_ciphersuite ));
200 Debug( LDAP_DEBUG_ANY,
201 "TLS: could not set cipher list %s.\n",
202 tls_opt_ciphersuite, 0, 0 );
208 if (tls_opt_cacertfile != NULL || tls_opt_cacertdir != NULL) {
209 if ( !SSL_CTX_load_verify_locations( tls_def_ctx,
210 tls_opt_cacertfile, tls_opt_cacertdir ) ||
211 !SSL_CTX_set_default_verify_paths( tls_def_ctx ) )
214 LDAP_LOG (( "tls", LDAP_LEVEL_ERR,
215 "ldap_pvt_tls_init_def_ctx: "
216 "TLS could not load verify locations "
217 "(file:`%s',dir:`%s').\n",
218 tls_opt_cacertfile ? tls_opt_cacertfile : "",
219 tls_opt_cacertdir ? tls_opt_cacertdir : "" ));
221 Debug( LDAP_DEBUG_ANY, "TLS: "
222 "could not load verify locations (file:`%s',dir:`%s').\n",
223 tls_opt_cacertfile ? tls_opt_cacertfile : "",
224 tls_opt_cacertdir ? tls_opt_cacertdir : "",
231 calist = get_ca_list( tls_opt_cacertfile, tls_opt_cacertdir );
234 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_init_def_ctx: "
235 "TLS could not load client CA list (file: `%s',dir:`%s')\n",
236 tls_opt_cacertfile ? tls_opt_cacertfile : "",
237 tls_opt_cacertdir ? tls_opt_cacertdir : "" ));
239 Debug( LDAP_DEBUG_ANY, "TLS: "
240 "could not load client CA list (file:`%s',dir:`%s').\n",
241 tls_opt_cacertfile ? tls_opt_cacertfile : "",
242 tls_opt_cacertdir ? tls_opt_cacertdir : "",
249 SSL_CTX_set_client_CA_list( tls_def_ctx, calist );
252 if ( tls_opt_keyfile &&
253 !SSL_CTX_use_PrivateKey_file( tls_def_ctx,
254 tls_opt_keyfile, SSL_FILETYPE_PEM ) )
257 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_init_def_ctx: "
258 "TLS could not use key file `%s'.\n", tls_opt_keyfile ));
260 Debug( LDAP_DEBUG_ANY,
261 "TLS: could not use key file `%s'.\n",
262 tls_opt_keyfile,0,0);
268 if ( tls_opt_certfile &&
269 !SSL_CTX_use_certificate_file( tls_def_ctx,
270 tls_opt_certfile, SSL_FILETYPE_PEM ) )
273 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_init_def_ctx: "
274 "TLS could not use certificate `%s'.\n", tls_opt_certfile ));
276 Debug( LDAP_DEBUG_ANY,
277 "TLS: could not use certificate `%s'.\n",
278 tls_opt_certfile,0,0);
284 if ( ( tls_opt_certfile || tls_opt_keyfile ) &&
285 !SSL_CTX_check_private_key( tls_def_ctx ) )
288 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_init_def_ctx: "
289 "TLS private key mismatch.\n" ));
291 Debug( LDAP_DEBUG_ANY,
292 "TLS: private key mismatch.\n",
299 if ( tls_opt_trace ) {
300 SSL_CTX_set_info_callback( tls_def_ctx, tls_info_cb );
304 if ( tls_opt_require_cert ) {
306 if ( tls_opt_require_cert == LDAP_OPT_X_TLS_DEMAND ||
307 tls_opt_require_cert == LDAP_OPT_X_TLS_HARD ) {
308 i |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
312 SSL_CTX_set_verify( tls_def_ctx, i,
313 tls_opt_require_cert == LDAP_OPT_X_TLS_ALLOW ?
314 tls_verify_ok : tls_verify_cb );
315 SSL_CTX_set_tmp_rsa_callback( tls_def_ctx, tls_tmp_rsa_cb );
316 /* SSL_CTX_set_tmp_dh_callback( tls_def_ctx, tls_tmp_dh_cb ); */
318 #ifdef LDAP_R_COMPILE
319 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
324 if ( tls_def_ctx != NULL ) {
325 SSL_CTX_free( tls_def_ctx );
328 #ifdef LDAP_R_COMPILE
329 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
334 static STACK_OF(X509_NAME) *
335 get_ca_list( char * bundle, char * dir )
337 STACK_OF(X509_NAME) *ca_list = NULL;
340 ca_list = SSL_load_client_CA_file( bundle );
343 * FIXME: We have now to go over all files in dir, load them
344 * and add every certificate there to ca_list.
350 alloc_handle( void *ctx_arg )
356 ctx = (SSL_CTX *) ctx_arg;
358 if ( ldap_pvt_tls_init_def_ctx() < 0 ) return NULL;
362 ssl = SSL_new( ctx );
365 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "alloc_handle: "
366 "TLS can't create ssl handle.\n" ));
368 Debug( LDAP_DEBUG_ANY,"TLS: can't create ssl handle.\n",0,0,0);
376 update_flags( Sockbuf *sb, SSL * ssl, int rc )
378 int err = SSL_get_error(ssl, rc);
380 sb->sb_trans_needs_read = 0;
381 sb->sb_trans_needs_write = 0;
383 if (err == SSL_ERROR_WANT_READ) {
384 sb->sb_trans_needs_read = 1;
387 } else if (err == SSL_ERROR_WANT_WRITE) {
388 sb->sb_trans_needs_write = 1;
391 } else if (err == SSL_ERROR_WANT_CONNECT) {
398 * TLS support for LBER Sockbufs
403 Sockbuf_IO_Desc *sbiod;
406 static BIO_METHOD sb_tls_bio_method;
409 sb_tls_setup( Sockbuf_IO_Desc *sbiod, void *arg )
414 assert( sbiod != NULL );
416 p = LBER_MALLOC( sizeof( *p ) );
423 bio = BIO_new( &sb_tls_bio_method );
424 bio->ptr = (void *)p;
425 SSL_set_bio( p->ssl, bio, bio );
426 sbiod->sbiod_pvt = p;
431 sb_tls_remove( Sockbuf_IO_Desc *sbiod )
435 assert( sbiod != NULL );
436 assert( sbiod->sbiod_pvt != NULL );
438 p = (struct tls_data *)sbiod->sbiod_pvt;
440 LBER_FREE( sbiod->sbiod_pvt );
441 sbiod->sbiod_pvt = NULL;
446 sb_tls_close( Sockbuf_IO_Desc *sbiod )
450 assert( sbiod != NULL );
451 assert( sbiod->sbiod_pvt != NULL );
453 p = (struct tls_data *)sbiod->sbiod_pvt;
454 SSL_shutdown( p->ssl );
459 sb_tls_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
463 assert( sbiod != NULL );
464 assert( sbiod->sbiod_pvt != NULL );
466 p = (struct tls_data *)sbiod->sbiod_pvt;
468 if ( opt == LBER_SB_OPT_GET_SSL ) {
469 *((SSL **)arg) = p->ssl;
472 } else if ( opt == LBER_SB_OPT_DATA_READY ) {
473 if( SSL_pending( p->ssl ) > 0 ) {
478 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
482 sb_tls_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
488 assert( sbiod != NULL );
489 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
491 p = (struct tls_data *)sbiod->sbiod_pvt;
493 ret = SSL_read( p->ssl, (char *)buf, len );
495 errno = WSAGetLastError();
497 err = SSL_get_error( p->ssl, ret );
498 if (err == SSL_ERROR_WANT_READ ) {
499 sbiod->sbiod_sb->sb_trans_needs_read = 1;
503 sbiod->sbiod_sb->sb_trans_needs_read = 0;
508 sb_tls_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
514 assert( sbiod != NULL );
515 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
517 p = (struct tls_data *)sbiod->sbiod_pvt;
519 ret = SSL_write( p->ssl, (char *)buf, len );
521 errno = WSAGetLastError();
523 err = SSL_get_error( p->ssl, ret );
524 if (err == SSL_ERROR_WANT_WRITE ) {
525 sbiod->sbiod_sb->sb_trans_needs_write = 1;
529 sbiod->sbiod_sb->sb_trans_needs_write = 0;
534 static Sockbuf_IO sb_tls_sbio =
536 sb_tls_setup, /* sbi_setup */
537 sb_tls_remove, /* sbi_remove */
538 sb_tls_ctrl, /* sbi_ctrl */
539 sb_tls_read, /* sbi_read */
540 sb_tls_write, /* sbi_write */
541 sb_tls_close /* sbi_close */
545 sb_tls_bio_create( BIO *b ) {
554 sb_tls_bio_destroy( BIO *b )
556 if ( b == NULL ) return 0;
558 b->ptr = NULL; /* sb_tls_remove() will free it */
565 sb_tls_bio_read( BIO *b, char *buf, int len )
570 if ( buf == NULL || len <= 0 ) return 0;
572 p = (struct tls_data *)b->ptr;
574 if ( p == NULL || p->sbiod == NULL ) {
578 ret = LBER_SBIOD_READ_NEXT( p->sbiod, buf, len );
580 BIO_clear_retry_flags( b );
581 if ( ret < 0 && errno == EWOULDBLOCK ) {
582 BIO_set_retry_read( b );
589 sb_tls_bio_write( BIO *b, const char *buf, int len )
594 if ( buf == NULL || len <= 0 ) return 0;
596 p = (struct tls_data *)b->ptr;
598 if ( p == NULL || p->sbiod == NULL ) {
602 ret = LBER_SBIOD_WRITE_NEXT( p->sbiod, (char *)buf, len );
604 BIO_clear_retry_flags( b );
605 if ( ret < 0 && errno == EWOULDBLOCK ) {
606 BIO_set_retry_write( b );
613 sb_tls_bio_ctrl( BIO *b, int cmd, long num, void *ptr )
615 if ( cmd == BIO_CTRL_FLUSH ) {
616 /* The OpenSSL library needs this */
623 sb_tls_bio_gets( BIO *b, char *buf, int len )
629 sb_tls_bio_puts( BIO *b, const char *str )
631 return sb_tls_bio_write( b, str, strlen( str ) );
634 static BIO_METHOD sb_tls_bio_method =
636 ( 100 | 0x400 ), /* it's a source/sink BIO */
648 * Call this to do a TLS connect on a sockbuf. ctx_arg can be
649 * a SSL_CTX * or NULL, in which case the default ctx is used.
653 * 0 - Success. Connection is ready for communication.
654 * <0 - Error. Can't create a TLS stream.
655 * >0 - Partial success.
656 * Do a select (using information from lber_pvt_sb_needs_{read,write}
661 ldap_int_tls_connect( LDAP *ld, LDAPConn *conn )
663 Sockbuf *sb = conn->lconn_sb;
667 if ( HAS_TLS( sb ) ) {
668 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
671 void *ctx = ld->ld_defconn
672 ? ld->ld_defconn->lconn_tls_ctx : NULL;
674 ssl = alloc_handle( ctx );
676 if ( ssl == NULL ) return -1;
679 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
680 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
682 ber_sockbuf_add_io( sb, &sb_tls_sbio,
683 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
686 conn->lconn_tls_ctx = tls_def_ctx;
690 err = SSL_connect( ssl );
693 errno = WSAGetLastError();
697 if ( update_flags( sb, ssl, err )) {
701 if ((err = ERR_peek_error())) {
703 ld->ld_error = LDAP_STRDUP(ERR_error_string(err, buf));
707 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_int_tls_connect: "
708 "TLS can't connect.\n" ));
710 Debug( LDAP_DEBUG_ANY,"TLS: can't connect.\n",0,0,0);
713 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
714 LBER_SBIOD_LEVEL_TRANSPORT );
716 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
717 LBER_SBIOD_LEVEL_TRANSPORT );
726 * Call this to do a TLS accept on a sockbuf.
727 * Everything else is the same as with tls_connect.
730 ldap_pvt_tls_accept( Sockbuf *sb, void *ctx_arg )
735 if ( HAS_TLS( sb ) ) {
736 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
739 ssl = alloc_handle( ctx_arg );
740 if ( ssl == NULL ) return -1;
743 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
744 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
746 ber_sockbuf_add_io( sb, &sb_tls_sbio,
747 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
750 err = SSL_accept( ssl );
753 errno = WSAGetLastError();
756 if ( update_flags( sb, ssl, err )) return 1;
759 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_accept: "
760 "TLS can't accept.\n" ));
762 Debug( LDAP_DEBUG_ANY,"TLS: can't accept.\n",0,0,0 );
766 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
767 LBER_SBIOD_LEVEL_TRANSPORT );
769 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
770 LBER_SBIOD_LEVEL_TRANSPORT );
779 ldap_pvt_tls_inplace ( Sockbuf *sb )
781 return HAS_TLS( sb ) ? 1 : 0;
785 ldap_pvt_tls_sb_ctx( Sockbuf *sb )
790 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&p );
798 ldap_pvt_tls_get_strength( void *s )
802 c = SSL_get_current_cipher((SSL *)s);
803 return SSL_CIPHER_get_bits(c, NULL);
808 ldap_pvt_tls_get_my_dn( void *s, struct berval *dn, LDAPDN_rewrite_dummy *func, unsigned flags )
814 x = SSL_get_certificate((SSL *)s);
816 if (!x) return LDAP_INVALID_CREDENTIALS;
818 xn = X509_get_subject_name(x);
819 rc = ldap_X509dn2bv(xn, dn, (LDAPDN_rewrite_func *)func, flags );
825 tls_get_cert( SSL *s )
827 /* If peer cert was bad, treat as if no cert was given */
828 if (SSL_get_verify_result(s)) {
829 /* If we can send an alert, do so */
830 if (SSL_version(s) != SSL2_VERSION) {
831 ssl3_send_alert(s,SSL3_AL_WARNING,SSL3_AD_BAD_CERTIFICATE);
835 return SSL_get_peer_certificate(s);
839 ldap_pvt_tls_get_peer_dn( void *s, struct berval *dn, LDAPDN_rewrite_dummy *func, unsigned flags )
845 x = tls_get_cert((SSL *)s);
847 if (!x) return LDAP_INVALID_CREDENTIALS;
849 xn = X509_get_subject_name(x);
850 rc = ldap_X509dn2bv(xn, dn, (LDAPDN_rewrite_func *)func, flags);
856 ldap_pvt_tls_get_peer_hostname( void *s )
863 x = tls_get_cert((SSL *)s);
866 xn = X509_get_subject_name(x);
868 ret = X509_NAME_get_text_by_NID(xn, NID_commonName, buf, sizeof(buf));
874 p = LDAP_STRDUP(buf);
880 ldap_pvt_tls_check_hostname( void *s, const char *name_in )
882 int i, ret = LDAP_LOCAL_ERROR;
886 if( ldap_int_hostname &&
887 ( !name_in || !strcasecmp( name_in, "localhost" ) ) )
889 name = ldap_int_hostname;
894 x = tls_get_cert((SSL *)s);
897 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_check_hostname: "
898 "TLS unable to get peer certificate.\n" ));
900 Debug( LDAP_DEBUG_ANY,
901 "TLS: unable to get peer certificate.\n",
907 i = X509_get_ext_by_NID(x, NID_subject_alt_name, -1);
910 STACK_OF(GENERAL_NAME) *alt;
912 ex = X509_get_ext(x, i);
913 alt = X509V3_EXT_d2i(ex);
915 int n, len1, len2 = 0;
918 X509V3_EXT_METHOD *method;
921 n = sk_GENERAL_NAME_num(alt);
922 domain = strchr(name, '.');
924 len2 = len1 - (domain-name);
926 for (i=0; i<n; i++) {
927 gn = sk_GENERAL_NAME_value(alt, i);
928 if (gn->type == GEN_DNS) {
929 char *sn = ASN1_STRING_data(gn->d.ia5);
930 int sl = ASN1_STRING_length(gn->d.ia5);
932 /* Is this an exact match? */
933 if ((len1 == sl) && !strncasecmp(name, sn, len1)) {
937 /* Is this a wildcard match? */
938 if ((*sn == '*') && domain && (len2 == sl-1) &&
939 !strncasecmp(domain, sn+1, len2))
946 method = X509V3_EXT_get(ex);
947 method->ext_free(alt);
948 if (i < n) { /* Found a match */
954 if (ret != LDAP_SUCCESS) {
958 xn = X509_get_subject_name(x);
960 if( X509_NAME_get_text_by_NID( xn, NID_commonName,
961 buf, sizeof(buf)) == -1)
964 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_check_hostname: "
965 "TLS unable to get common name from peer certificate.\n" ));
967 Debug( LDAP_DEBUG_ANY,
968 "TLS: unable to get common name from peer certificate.\n",
972 } else if (strcasecmp(name, buf)) {
974 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_check_hostname: "
975 "TLS hostname (%s) does not match "
976 "common name in certificate (%s).\n", name, buf ));
978 Debug( LDAP_DEBUG_ANY, "TLS: hostname (%s) does not match "
979 "common name in certificate (%s).\n",
982 ret = LDAP_CONNECT_ERROR;
993 ldap_pvt_tls_get_peer_issuer( void *s )
995 #if 0 /* currently unused; see ldap_pvt_tls_get_peer_dn() if needed */
1000 x = SSL_get_peer_certificate((SSL *)s);
1002 if (!x) return NULL;
1004 xn = X509_get_issuer_name(x);
1005 p = LDAP_STRDUP(X509_NAME_oneline(xn, buf, sizeof(buf)));
1014 ldap_int_tls_config( LDAP *ld, int option, const char *arg )
1019 case LDAP_OPT_X_TLS_CACERTFILE:
1020 case LDAP_OPT_X_TLS_CACERTDIR:
1021 case LDAP_OPT_X_TLS_CERTFILE:
1022 case LDAP_OPT_X_TLS_KEYFILE:
1023 case LDAP_OPT_X_TLS_RANDOM_FILE:
1024 return ldap_pvt_tls_set_option( ld, option, (void *) arg );
1026 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1027 case LDAP_OPT_X_TLS:
1029 if ( strcasecmp( arg, "never" ) == 0 ) {
1030 i = LDAP_OPT_X_TLS_NEVER ;
1032 } else if ( strcasecmp( arg, "demand" ) == 0 ) {
1033 i = LDAP_OPT_X_TLS_DEMAND ;
1035 } else if ( strcasecmp( arg, "allow" ) == 0 ) {
1036 i = LDAP_OPT_X_TLS_ALLOW ;
1038 } else if ( strcasecmp( arg, "try" ) == 0 ) {
1039 i = LDAP_OPT_X_TLS_TRY ;
1041 } else if ( ( strcasecmp( arg, "hard" ) == 0 ) ||
1042 ( strcasecmp( arg, "on" ) == 0 ) ||
1043 ( strcasecmp( arg, "yes" ) == 0) ||
1044 ( strcasecmp( arg, "true" ) == 0 ) )
1046 i = LDAP_OPT_X_TLS_HARD ;
1050 return ldap_pvt_tls_set_option( ld, option, &i );
1059 ldap_pvt_tls_get_option( LDAP *ld, int option, void *arg )
1061 struct ldapoptions *lo;
1064 assert( LDAP_VALID( ld ) );
1066 if( !LDAP_VALID( ld ) ) {
1067 return LDAP_OPT_ERROR;
1070 lo = &ld->ld_options;
1073 /* Get pointer to global option structure */
1074 lo = LDAP_INT_GLOBAL_OPT();
1076 return LDAP_NO_MEMORY;
1081 case LDAP_OPT_X_TLS:
1082 *(int *)arg = lo->ldo_tls_mode;
1084 case LDAP_OPT_X_TLS_CTX:
1086 *(void **)arg = (void *) tls_def_ctx;
1088 *(void **)arg = ld->ld_defconn->lconn_tls_ctx;
1091 case LDAP_OPT_X_TLS_CACERTFILE:
1092 *(char **)arg = tls_opt_cacertfile ?
1093 LDAP_STRDUP( tls_opt_cacertfile ) : NULL;
1095 case LDAP_OPT_X_TLS_CACERTDIR:
1096 *(char **)arg = tls_opt_cacertdir ?
1097 LDAP_STRDUP( tls_opt_cacertdir ) : NULL;
1099 case LDAP_OPT_X_TLS_CERTFILE:
1100 *(char **)arg = tls_opt_certfile ?
1101 LDAP_STRDUP( tls_opt_certfile ) : NULL;
1103 case LDAP_OPT_X_TLS_KEYFILE:
1104 *(char **)arg = tls_opt_keyfile ?
1105 LDAP_STRDUP( tls_opt_keyfile ) : NULL;
1107 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1108 *(int *)arg = tls_opt_require_cert;
1110 case LDAP_OPT_X_TLS_RANDOM_FILE:
1111 *(char **)arg = tls_opt_randfile ?
1112 LDAP_STRDUP( tls_opt_randfile ) : NULL;
1114 case LDAP_OPT_X_TLS_SSL_CTX: {
1117 LDAPConn *conn = ld->ld_defconn;
1118 if ( conn != NULL ) {
1119 Sockbuf *sb = conn->lconn_sb;
1120 retval = ldap_pvt_tls_sb_ctx( sb );
1123 *(void **)arg = retval;
1133 ldap_pvt_tls_set_option( LDAP *ld, int option, void *arg )
1135 struct ldapoptions *lo;
1138 assert( LDAP_VALID( ld ) );
1140 if( !LDAP_VALID( ld ) ) {
1141 return LDAP_OPT_ERROR;
1144 lo = &ld->ld_options;
1147 /* Get pointer to global option structure */
1148 lo = LDAP_INT_GLOBAL_OPT();
1150 return LDAP_NO_MEMORY;
1155 case LDAP_OPT_X_TLS:
1156 switch( *(int *) arg ) {
1157 case LDAP_OPT_X_TLS_NEVER:
1158 case LDAP_OPT_X_TLS_DEMAND:
1159 case LDAP_OPT_X_TLS_ALLOW:
1160 case LDAP_OPT_X_TLS_TRY:
1161 case LDAP_OPT_X_TLS_HARD:
1163 lo->ldo_tls_mode = *(int *)arg;
1170 case LDAP_OPT_X_TLS_CTX:
1172 tls_def_ctx = (SSL_CTX *) arg;
1175 ld->ld_defconn->lconn_tls_ctx = arg;
1185 case LDAP_OPT_X_TLS_CACERTFILE:
1186 if ( tls_opt_cacertfile ) LDAP_FREE( tls_opt_cacertfile );
1187 tls_opt_cacertfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1189 case LDAP_OPT_X_TLS_CACERTDIR:
1190 if ( tls_opt_cacertdir ) LDAP_FREE( tls_opt_cacertdir );
1191 tls_opt_cacertdir = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1193 case LDAP_OPT_X_TLS_CERTFILE:
1194 if ( tls_opt_certfile ) LDAP_FREE( tls_opt_certfile );
1195 tls_opt_certfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1197 case LDAP_OPT_X_TLS_KEYFILE:
1198 if ( tls_opt_keyfile ) LDAP_FREE( tls_opt_keyfile );
1199 tls_opt_keyfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1201 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1202 switch( *(int *) arg ) {
1203 case LDAP_OPT_X_TLS_NEVER:
1204 case LDAP_OPT_X_TLS_DEMAND:
1205 case LDAP_OPT_X_TLS_ALLOW:
1206 case LDAP_OPT_X_TLS_TRY:
1207 case LDAP_OPT_X_TLS_HARD:
1208 tls_opt_require_cert = * (int *) arg;
1212 case LDAP_OPT_X_TLS_CIPHER_SUITE:
1213 if ( tls_opt_ciphersuite ) LDAP_FREE( tls_opt_ciphersuite );
1214 tls_opt_ciphersuite = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1216 case LDAP_OPT_X_TLS_RANDOM_FILE:
1217 if (tls_opt_randfile ) LDAP_FREE (tls_opt_randfile );
1218 tls_opt_randfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1227 ldap_int_tls_start ( LDAP *ld, LDAPConn *conn, LDAPURLDesc *srv )
1229 Sockbuf *sb = conn->lconn_sb;
1234 host = srv->lud_host;
1236 host = conn->lconn_server->lud_host;
1239 /* avoid NULL host */
1240 if( host == NULL ) {
1244 (void) ldap_pvt_tls_init();
1247 * Fortunately, the lib uses blocking io...
1249 if ( ldap_int_tls_connect( ld, conn ) < 0 ) {
1250 ld->ld_errno = LDAP_CONNECT_ERROR;
1251 return (ld->ld_errno);
1254 ssl = ldap_pvt_tls_sb_ctx( sb );
1255 assert( ssl != NULL );
1258 * compare host with name(s) in certificate
1260 ld->ld_errno = ldap_pvt_tls_check_hostname( ssl, host );
1261 if (ld->ld_errno != LDAP_SUCCESS) {
1262 return ld->ld_errno;
1266 * set SASL properties to TLS ssf and authid
1269 struct berval authid;
1272 /* we need to let SASL know */
1273 ssf = ldap_pvt_tls_get_strength( ssl );
1274 /* failure is OK, we just can't use SASL EXTERNAL */
1275 (void) ldap_pvt_tls_get_my_dn( ssl, &authid, NULL, 0 );
1277 (void) ldap_int_sasl_external( ld, conn, authid.bv_val, ssf );
1278 LDAP_FREE( authid.bv_val );
1281 return LDAP_SUCCESS;
1284 /* Derived from openssl/apps/s_cb.c */
1286 tls_info_cb( SSL *ssl, int where, int ret )
1291 w = where & ~SSL_ST_MASK;
1292 if ( w & SSL_ST_CONNECT ) {
1294 } else if ( w & SSL_ST_ACCEPT ) {
1300 if ( where & SSL_CB_LOOP ) {
1302 LDAP_LOG (( "tls", LDAP_LEVEL_DETAIL1, "tls_info_cb: "
1303 "TLS trace: %s:%s\n", op, SSL_state_string_long( ssl ) ));
1305 Debug( LDAP_DEBUG_TRACE,
1306 "TLS trace: %s:%s\n",
1307 op, SSL_state_string_long( ssl ), 0 );
1310 } else if ( where & SSL_CB_ALERT ) {
1311 op = ( where & SSL_CB_READ ) ? "read" : "write";
1313 LDAP_LOG (( "tls", LDAP_LEVEL_DETAIL1, "tls_info_cb: "
1314 "TLS trace: SSL3 alert %s:%s:%s\n", op,
1315 SSL_alert_type_string_long( ret ),
1316 SSL_alert_desc_string_long( ret) ));
1318 Debug( LDAP_DEBUG_TRACE,
1319 "TLS trace: SSL3 alert %s:%s:%s\n",
1321 SSL_alert_type_string_long( ret ),
1322 SSL_alert_desc_string_long( ret) );
1325 } else if ( where & SSL_CB_EXIT ) {
1328 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "tls_info_cb: "
1329 "TLS trace: %s:failed in %s\n", op, SSL_state_string_long( ssl ) ));
1331 Debug( LDAP_DEBUG_TRACE,
1332 "TLS trace: %s:failed in %s\n",
1333 op, SSL_state_string_long( ssl ), 0 );
1335 } else if ( ret < 0 ) {
1337 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "tls_info_cb: "
1338 "TLS trace: %s:error in %s\n", op, SSL_state_string_long( ssl ) ));
1340 Debug( LDAP_DEBUG_TRACE,
1341 "TLS trace: %s:error in %s\n",
1342 op, SSL_state_string_long( ssl ), 0 );
1349 tls_verify_cb( int ok, X509_STORE_CTX *ctx )
1359 cert = X509_STORE_CTX_get_current_cert( ctx );
1360 errnum = X509_STORE_CTX_get_error( ctx );
1361 errdepth = X509_STORE_CTX_get_error_depth( ctx );
1364 * X509_get_*_name return pointers to the internal copies of
1365 * those things requested. So do not free them.
1367 subject = X509_get_subject_name( cert );
1368 issuer = X509_get_issuer_name( cert );
1369 /* X509_NAME_oneline, if passed a NULL buf, allocate memomry */
1370 sname = X509_NAME_oneline( subject, NULL, 0 );
1371 iname = X509_NAME_oneline( issuer, NULL, 0 );
1373 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "tls_verify_cb"
1374 "TLS certificate verification: depth: %d, err: %d: "
1375 "subject: %s, issuer: %s\n", errdepth, errnum,
1376 sname ? sname : "-unknown-", iname ? iname : "-unknown-" ));
1378 Debug( LDAP_DEBUG_TRACE,
1379 "TLS certificate verification: depth: %d, err: %d, subject: %s,",
1381 sname ? sname : "-unknown-" );
1382 Debug( LDAP_DEBUG_TRACE, " issuer: %s\n", iname ? iname : "-unknown-", 0, 0 );
1385 CRYPTO_free ( sname );
1387 CRYPTO_free ( iname );
1393 tls_verify_ok( int ok, X509_STORE_CTX *ctx )
1395 (void) tls_verify_cb( ok, ctx );
1399 /* Inspired by ERR_print_errors in OpenSSL */
1401 tls_report_error( void )
1408 while ( ( l = ERR_get_error_line( &file, &line ) ) != 0 ) {
1410 LDAP_LOG (( "tls", LDAP_LEVEL_ERR,
1411 "tls_report_error: TLS %s %s:%d\n",
1412 ERR_error_string( l, buf ), file, line ));
1414 Debug( LDAP_DEBUG_ANY, "TLS: %s %s:%d\n",
1415 ERR_error_string( l, buf ), file, line );
1421 tls_tmp_rsa_cb( SSL *ssl, int is_export, int key_length )
1425 /* FIXME: Pregenerate the key on startup */
1426 /* FIXME: Who frees the key? */
1427 tmp_rsa = RSA_generate_key( key_length, RSA_F4, NULL, NULL );
1431 LDAP_LOG (( "tls", LDAP_LEVEL_ERR,
1432 "tls_tmp_rsa_cb: TLS Failed to generate temporary %d-bit %s RSA key\n",
1433 key_length, is_export ? "export" : "domestic" ));
1435 Debug( LDAP_DEBUG_ANY,
1436 "TLS: Failed to generate temporary %d-bit %s RSA key\n",
1437 key_length, is_export ? "export" : "domestic", 0 );
1445 tls_seed_PRNG( const char *randfile )
1447 #ifndef URANDOM_DEVICE
1448 /* no /dev/urandom (or equiv) */
1450 char buffer[MAXPATHLEN];
1452 if (randfile == NULL) {
1453 /* The seed file is $RANDFILE if defined, otherwise $HOME/.rnd.
1454 * If $HOME is not set or buffer too small to hold the pathname,
1455 * an error occurs. - From RAND_file_name() man page.
1456 * The fact is that when $HOME is NULL, .rnd is used.
1458 randfile = RAND_file_name( buffer, sizeof( buffer ) );
1460 } else if (RAND_egd(randfile) > 0) {
1465 if (randfile == NULL) {
1467 LDAP_LOG (( "tls", LDAP_LEVEL_DETAIL1,
1468 "tls_seed_PRNG: TLS Use configuration file or "
1469 "$RANDFILE to define seed PRNG\n" ));
1471 Debug( LDAP_DEBUG_ANY,
1472 "TLS: Use configuration file or $RANDFILE to define seed PRNG\n",
1478 total = RAND_load_file(randfile, -1);
1480 if (RAND_status() == 0) {
1482 LDAP_LOG (( "tls", LDAP_LEVEL_DETAIL1,
1483 "tls_seed_PRNG: TLS PRNG not been seeded with enough data\n" ));
1485 Debug( LDAP_DEBUG_ANY,
1486 "TLS: PRNG not been seeded with enough data\n",
1492 /* assume if there was enough bits to seed that it's okay
1493 * to write derived bits to the file
1495 RAND_write_file(randfile);
1504 tls_tmp_dh_cb( SSL *ssl, int is_export, int key_length )
1512 ldap_start_tls_s ( LDAP *ld,
1513 LDAPControl **serverctrls,
1514 LDAPControl **clientctrls )
1519 char *rspoid = NULL;
1520 struct berval *rspdata = NULL;
1522 /* XXYYZ: this initiates operation only on default connection! */
1524 if ( ld->ld_sb != NULL && ldap_pvt_tls_inplace( ld->ld_sb ) != 0 ) {
1525 return LDAP_LOCAL_ERROR;
1528 rc = ldap_extended_operation_s( ld, LDAP_EXOP_START_TLS,
1529 NULL, serverctrls, clientctrls, &rspoid, &rspdata );
1530 if ( rc != LDAP_SUCCESS ) {
1534 if ( rspoid != NULL ) {
1538 if ( rspdata != NULL ) {
1539 ber_bvfree( rspdata );
1542 rc = ldap_int_tls_start( ld, ld->ld_defconn, NULL );
1544 rc = LDAP_NOT_SUPPORTED;