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.
10 #include "ldap_config.h"
14 #include <ac/stdlib.h>
16 #include <ac/socket.h>
17 #include <ac/string.h>
19 #include <ac/unistd.h>
21 #include <ac/dirent.h>
28 #include <ldap_pvt_thread.h>
31 #ifdef HAVE_OPENSSL_SSL_H
32 #include <openssl/ssl.h>
33 #include <openssl/x509v3.h>
34 #include <openssl/err.h>
35 #include <openssl/rand.h>
36 #include <openssl/safestack.h>
37 #elif defined( HAVE_SSL_H )
41 static int tls_opt_trace = 1;
42 static char *tls_opt_certfile = NULL;
43 static char *tls_opt_keyfile = NULL;
44 static char *tls_opt_cacertfile = NULL;
45 static char *tls_opt_cacertdir = NULL;
46 static int tls_opt_require_cert = LDAP_OPT_X_TLS_DEMAND;
47 static char *tls_opt_ciphersuite = NULL;
48 static char *tls_opt_randfile = NULL;
50 #define HAS_TLS( sb ) ber_sockbuf_ctrl( sb, LBER_SB_OPT_HAS_IO, \
51 (void *)&sb_tls_sbio )
53 static void tls_report_error( void );
55 static void tls_info_cb( SSL *ssl, int where, int ret );
56 static int tls_verify_cb( int ok, X509_STORE_CTX *ctx );
57 static int tls_verify_ok( int ok, X509_STORE_CTX *ctx );
58 static RSA * tls_tmp_rsa_cb( SSL *ssl, int is_export, int key_length );
59 static STACK_OF(X509_NAME) * get_ca_list( char * bundle, char * dir );
61 #if 0 /* Currently this is not used by anyone */
62 static DH * tls_tmp_dh_cb( SSL *ssl, int is_export, int key_length );
65 static SSL_CTX *tls_def_ctx = NULL;
67 static int tls_seed_PRNG( const char *randfile );
71 * provide mutexes for the SSLeay library.
73 static ldap_pvt_thread_mutex_t tls_mutexes[CRYPTO_NUM_LOCKS];
75 static void tls_locking_cb( int mode, int type, const char *file, int line )
77 if ( mode & CRYPTO_LOCK ) {
78 ldap_pvt_thread_mutex_lock( &tls_mutexes[type] );
80 ldap_pvt_thread_mutex_unlock( &tls_mutexes[type] );
85 * an extra mutex for the default ctx.
88 static ldap_pvt_thread_mutex_t tls_def_ctx_mutex;
90 static void tls_init_threads( void )
94 for( i=0; i< CRYPTO_NUM_LOCKS ; i++ ) {
95 ldap_pvt_thread_mutex_init( &tls_mutexes[i] );
97 CRYPTO_set_locking_callback( tls_locking_cb );
98 /* FIXME: the thread id should be added somehow... */
100 ldap_pvt_thread_mutex_init( &tls_def_ctx_mutex );
102 #endif /* LDAP_R_COMPILE */
105 * Tear down the TLS subsystem. Should only be called once.
108 ldap_pvt_tls_destroy( void )
110 SSL_CTX_free(tls_def_ctx);
116 if ( tls_opt_certfile ) {
117 LDAP_FREE( tls_opt_certfile );
118 tls_opt_certfile = NULL;
120 if ( tls_opt_keyfile ) {
121 LDAP_FREE( tls_opt_keyfile );
122 tls_opt_keyfile = NULL;
124 if ( tls_opt_cacertfile ) {
125 LDAP_FREE( tls_opt_cacertfile );
126 tls_opt_cacertfile = NULL;
128 if ( tls_opt_cacertdir ) {
129 LDAP_FREE( tls_opt_cacertdir );
130 tls_opt_cacertdir = NULL;
132 if ( tls_opt_ciphersuite ) {
133 LDAP_FREE( tls_opt_ciphersuite );
134 tls_opt_ciphersuite = NULL;
136 if ( tls_opt_randfile ) {
137 LDAP_FREE( tls_opt_randfile );
138 tls_opt_randfile = NULL;
143 * Initialize TLS subsystem. Should be called only once.
146 ldap_pvt_tls_init( void )
148 static int tls_initialized = 0;
150 if ( tls_initialized ) return 0;
155 char *file = LDAP_STRDUP( tls_opt_randfile );
156 if ( file ) __atoe( file );
157 (void) tls_seed_PRNG( file );
161 (void) tls_seed_PRNG( tls_opt_randfile );
164 #ifdef LDAP_R_COMPILE
168 SSL_load_error_strings();
169 SSLeay_add_ssl_algorithms();
171 /* FIXME: mod_ssl does this */
172 X509V3_add_standard_extensions();
177 * initialize the default context
180 ldap_pvt_tls_init_def_ctx( void )
182 STACK_OF(X509_NAME) *calist;
184 char *ciphersuite = tls_opt_ciphersuite;
185 char *cacertfile = tls_opt_cacertfile;
186 char *cacertdir = tls_opt_cacertdir;
187 char *certfile = tls_opt_certfile;
188 char *keyfile = tls_opt_keyfile;
191 /* This ASCII/EBCDIC handling is a real pain! */
193 ciphersuite = LDAP_STRDUP( ciphersuite );
194 __atoe( ciphersuite );
197 cacertfile = LDAP_STRDUP( cacertfile );
198 __atoe( cacertfile );
201 cacertdir = LDAP_STRDUP( cacertdir );
205 certfile = LDAP_STRDUP( certfile );
209 keyfile = LDAP_STRDUP( keyfile );
214 #ifdef LDAP_R_COMPILE
215 ldap_pvt_thread_mutex_lock( &tls_def_ctx_mutex );
217 if ( tls_def_ctx == NULL ) {
219 tls_def_ctx = SSL_CTX_new( SSLv23_method() );
220 if ( tls_def_ctx == NULL ) {
222 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
223 "TLS could not allocate default ctx (%d).\n",
224 ERR_peek_error(), 0, 0 );
226 Debug( LDAP_DEBUG_ANY,
227 "TLS: could not allocate default ctx (%lu).\n",
228 ERR_peek_error(),0,0);
234 SSL_CTX_set_session_id_context( tls_def_ctx,
235 "OpenLDAP", sizeof("OpenLDAP")-1 );
237 if ( tls_opt_ciphersuite &&
238 !SSL_CTX_set_cipher_list( tls_def_ctx, ciphersuite ) )
241 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
242 "TLS could not set cipher list %s.\n",
243 tls_opt_ciphersuite, 0, 0 );
245 Debug( LDAP_DEBUG_ANY,
246 "TLS: could not set cipher list %s.\n",
247 tls_opt_ciphersuite, 0, 0 );
254 if (tls_opt_cacertfile != NULL || tls_opt_cacertdir != NULL) {
255 if ( !SSL_CTX_load_verify_locations( tls_def_ctx,
256 cacertfile, cacertdir ) ||
257 !SSL_CTX_set_default_verify_paths( tls_def_ctx ) )
260 LDAP_LOG ( TRANSPORT, ERR,
261 "ldap_pvt_tls_init_def_ctx: "
262 "TLS could not load verify locations "
263 "(file:`%s',dir:`%s').\n",
264 tls_opt_cacertfile ? tls_opt_cacertfile : "",
265 tls_opt_cacertdir ? tls_opt_cacertdir : "", 0 );
267 Debug( LDAP_DEBUG_ANY, "TLS: "
268 "could not load verify locations (file:`%s',dir:`%s').\n",
269 tls_opt_cacertfile ? tls_opt_cacertfile : "",
270 tls_opt_cacertdir ? tls_opt_cacertdir : "",
278 calist = get_ca_list( cacertfile, cacertdir );
281 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
282 "TLS could not load client CA list (file: `%s',dir:`%s')\n",
283 tls_opt_cacertfile ? tls_opt_cacertfile : "",
284 tls_opt_cacertdir ? tls_opt_cacertdir : "", 0 );
286 Debug( LDAP_DEBUG_ANY, "TLS: "
287 "could not load client CA list (file:`%s',dir:`%s').\n",
288 tls_opt_cacertfile ? tls_opt_cacertfile : "",
289 tls_opt_cacertdir ? tls_opt_cacertdir : "",
297 SSL_CTX_set_client_CA_list( tls_def_ctx, calist );
300 if ( tls_opt_keyfile &&
301 !SSL_CTX_use_PrivateKey_file( tls_def_ctx,
302 keyfile, SSL_FILETYPE_PEM ) )
305 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
306 "TLS could not use key file `%s'.\n", tls_opt_keyfile, 0, 0 );
308 Debug( LDAP_DEBUG_ANY,
309 "TLS: could not use key file `%s'.\n",
310 tls_opt_keyfile,0,0);
317 if ( tls_opt_certfile &&
318 !SSL_CTX_use_certificate_file( tls_def_ctx,
319 certfile, SSL_FILETYPE_PEM ) )
322 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
323 "TLS could not use certificate `%s'.\n",
324 tls_opt_certfile, 0, 0 );
326 Debug( LDAP_DEBUG_ANY,
327 "TLS: could not use certificate `%s'.\n",
328 tls_opt_certfile,0,0);
335 if ( ( tls_opt_certfile || tls_opt_keyfile ) &&
336 !SSL_CTX_check_private_key( tls_def_ctx ) )
339 LDAP_LOG ( TRANSPORT, ERR,
340 "ldap_pvt_tls_init_def_ctx: TLS private key mismatch.\n",
343 Debug( LDAP_DEBUG_ANY,
344 "TLS: private key mismatch.\n",
352 if ( tls_opt_trace ) {
353 SSL_CTX_set_info_callback( tls_def_ctx, tls_info_cb );
357 if ( tls_opt_require_cert ) {
359 if ( tls_opt_require_cert == LDAP_OPT_X_TLS_DEMAND ||
360 tls_opt_require_cert == LDAP_OPT_X_TLS_HARD ) {
361 i |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
365 SSL_CTX_set_verify( tls_def_ctx, i,
366 tls_opt_require_cert == LDAP_OPT_X_TLS_ALLOW ?
367 tls_verify_ok : tls_verify_cb );
368 SSL_CTX_set_tmp_rsa_callback( tls_def_ctx, tls_tmp_rsa_cb );
369 /* SSL_CTX_set_tmp_dh_callback( tls_def_ctx, tls_tmp_dh_cb ); */
372 if ( rc == -1 && tls_def_ctx != NULL ) {
373 SSL_CTX_free( tls_def_ctx );
377 LDAP_FREE( ciphersuite );
378 LDAP_FREE( cacertfile );
379 LDAP_FREE( cacertdir );
380 LDAP_FREE( certfile );
381 LDAP_FREE( keyfile );
383 #ifdef LDAP_R_COMPILE
384 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
389 static STACK_OF(X509_NAME) *
390 get_ca_list( char * bundle, char * dir )
392 STACK_OF(X509_NAME) *ca_list = NULL;
395 ca_list = SSL_load_client_CA_file( bundle );
397 #if defined(HAVE_DIRENT_H) || defined(dirent)
402 ca_list = sk_X509_NAME_new_null();
405 if ( !SSL_add_dir_cert_subjects_to_stack( ca_list, dir ) &&
407 sk_X509_NAME_free( ca_list );
417 alloc_handle( void *ctx_arg )
423 ctx = (SSL_CTX *) ctx_arg;
425 if ( ldap_pvt_tls_init_def_ctx() < 0 ) return NULL;
429 ssl = SSL_new( ctx );
432 LDAP_LOG ( TRANSPORT, ERR,
433 "alloc_handle: TLS can't create ssl handle.\n", 0, 0, 0 );
435 Debug( LDAP_DEBUG_ANY,"TLS: can't create ssl handle.\n",0,0,0);
443 update_flags( Sockbuf *sb, SSL * ssl, int rc )
445 int err = SSL_get_error(ssl, rc);
447 sb->sb_trans_needs_read = 0;
448 sb->sb_trans_needs_write = 0;
450 if (err == SSL_ERROR_WANT_READ) {
451 sb->sb_trans_needs_read = 1;
454 } else if (err == SSL_ERROR_WANT_WRITE) {
455 sb->sb_trans_needs_write = 1;
458 } else if (err == SSL_ERROR_WANT_CONNECT) {
465 * TLS support for LBER Sockbufs
470 Sockbuf_IO_Desc *sbiod;
473 static BIO_METHOD sb_tls_bio_method;
476 sb_tls_setup( Sockbuf_IO_Desc *sbiod, void *arg )
481 assert( sbiod != NULL );
483 p = LBER_MALLOC( sizeof( *p ) );
490 bio = BIO_new( &sb_tls_bio_method );
491 bio->ptr = (void *)p;
492 SSL_set_bio( p->ssl, bio, bio );
493 sbiod->sbiod_pvt = p;
498 sb_tls_remove( Sockbuf_IO_Desc *sbiod )
502 assert( sbiod != NULL );
503 assert( sbiod->sbiod_pvt != NULL );
505 p = (struct tls_data *)sbiod->sbiod_pvt;
507 LBER_FREE( sbiod->sbiod_pvt );
508 sbiod->sbiod_pvt = NULL;
513 sb_tls_close( Sockbuf_IO_Desc *sbiod )
517 assert( sbiod != NULL );
518 assert( sbiod->sbiod_pvt != NULL );
520 p = (struct tls_data *)sbiod->sbiod_pvt;
521 SSL_shutdown( p->ssl );
526 sb_tls_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
530 assert( sbiod != NULL );
531 assert( sbiod->sbiod_pvt != NULL );
533 p = (struct tls_data *)sbiod->sbiod_pvt;
535 if ( opt == LBER_SB_OPT_GET_SSL ) {
536 *((SSL **)arg) = p->ssl;
539 } else if ( opt == LBER_SB_OPT_DATA_READY ) {
540 if( SSL_pending( p->ssl ) > 0 ) {
545 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
549 sb_tls_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
555 assert( sbiod != NULL );
556 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
558 p = (struct tls_data *)sbiod->sbiod_pvt;
560 ret = SSL_read( p->ssl, (char *)buf, len );
562 errno = WSAGetLastError();
564 err = SSL_get_error( p->ssl, ret );
565 if (err == SSL_ERROR_WANT_READ ) {
566 sbiod->sbiod_sb->sb_trans_needs_read = 1;
570 sbiod->sbiod_sb->sb_trans_needs_read = 0;
575 sb_tls_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
581 assert( sbiod != NULL );
582 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
584 p = (struct tls_data *)sbiod->sbiod_pvt;
586 ret = SSL_write( p->ssl, (char *)buf, len );
588 errno = WSAGetLastError();
590 err = SSL_get_error( p->ssl, ret );
591 if (err == SSL_ERROR_WANT_WRITE ) {
592 sbiod->sbiod_sb->sb_trans_needs_write = 1;
596 sbiod->sbiod_sb->sb_trans_needs_write = 0;
601 static Sockbuf_IO sb_tls_sbio =
603 sb_tls_setup, /* sbi_setup */
604 sb_tls_remove, /* sbi_remove */
605 sb_tls_ctrl, /* sbi_ctrl */
606 sb_tls_read, /* sbi_read */
607 sb_tls_write, /* sbi_write */
608 sb_tls_close /* sbi_close */
612 sb_tls_bio_create( BIO *b ) {
621 sb_tls_bio_destroy( BIO *b )
623 if ( b == NULL ) return 0;
625 b->ptr = NULL; /* sb_tls_remove() will free it */
632 sb_tls_bio_read( BIO *b, char *buf, int len )
637 if ( buf == NULL || len <= 0 ) return 0;
639 p = (struct tls_data *)b->ptr;
641 if ( p == NULL || p->sbiod == NULL ) {
645 ret = LBER_SBIOD_READ_NEXT( p->sbiod, buf, len );
647 BIO_clear_retry_flags( b );
648 if ( ret < 0 && errno == EWOULDBLOCK ) {
649 BIO_set_retry_read( b );
656 sb_tls_bio_write( BIO *b, const char *buf, int len )
661 if ( buf == NULL || len <= 0 ) return 0;
663 p = (struct tls_data *)b->ptr;
665 if ( p == NULL || p->sbiod == NULL ) {
669 ret = LBER_SBIOD_WRITE_NEXT( p->sbiod, (char *)buf, len );
671 BIO_clear_retry_flags( b );
672 if ( ret < 0 && errno == EWOULDBLOCK ) {
673 BIO_set_retry_write( b );
680 sb_tls_bio_ctrl( BIO *b, int cmd, long num, void *ptr )
682 if ( cmd == BIO_CTRL_FLUSH ) {
683 /* The OpenSSL library needs this */
690 sb_tls_bio_gets( BIO *b, char *buf, int len )
696 sb_tls_bio_puts( BIO *b, const char *str )
698 return sb_tls_bio_write( b, str, strlen( str ) );
701 static BIO_METHOD sb_tls_bio_method =
703 ( 100 | 0x400 ), /* it's a source/sink BIO */
715 * Call this to do a TLS connect on a sockbuf. ctx_arg can be
716 * a SSL_CTX * or NULL, in which case the default ctx is used.
720 * 0 - Success. Connection is ready for communication.
721 * <0 - Error. Can't create a TLS stream.
722 * >0 - Partial success.
723 * Do a select (using information from lber_pvt_sb_needs_{read,write}
728 ldap_int_tls_connect( LDAP *ld, LDAPConn *conn )
730 Sockbuf *sb = conn->lconn_sb;
734 if ( HAS_TLS( sb ) ) {
735 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
738 void *ctx = ld->ld_defconn
739 ? ld->ld_defconn->lconn_tls_ctx : NULL;
741 ssl = alloc_handle( ctx );
743 if ( ssl == NULL ) return -1;
746 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
747 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
749 ber_sockbuf_add_io( sb, &sb_tls_sbio,
750 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
753 conn->lconn_tls_ctx = tls_def_ctx;
757 err = SSL_connect( ssl );
760 errno = WSAGetLastError();
764 if ( update_flags( sb, ssl, err )) {
768 if ((err = ERR_peek_error())) {
770 ld->ld_error = LDAP_STRDUP(ERR_error_string(err, buf));
772 if ( ld->ld_error ) __etoa(ld->ld_error);
777 LDAP_LOG ( TRANSPORT, ERR,
778 "ldap_int_tls_connect: TLS can't connect.\n", 0, 0, 0 );
780 Debug( LDAP_DEBUG_ANY,"TLS: can't connect.\n",0,0,0);
783 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
784 LBER_SBIOD_LEVEL_TRANSPORT );
786 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
787 LBER_SBIOD_LEVEL_TRANSPORT );
796 * Call this to do a TLS accept on a sockbuf.
797 * Everything else is the same as with tls_connect.
800 ldap_pvt_tls_accept( Sockbuf *sb, void *ctx_arg )
805 if ( HAS_TLS( sb ) ) {
806 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
809 ssl = alloc_handle( ctx_arg );
810 if ( ssl == NULL ) return -1;
813 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
814 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
816 ber_sockbuf_add_io( sb, &sb_tls_sbio,
817 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
820 err = SSL_accept( ssl );
823 errno = WSAGetLastError();
826 if ( update_flags( sb, ssl, err )) return 1;
829 LDAP_LOG ( TRANSPORT, ERR,
830 "ldap_pvt_tls_accept: TLS can't accept.\n", 0, 0, 0 );
832 Debug( LDAP_DEBUG_ANY,"TLS: can't accept.\n",0,0,0 );
836 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
837 LBER_SBIOD_LEVEL_TRANSPORT );
839 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
840 LBER_SBIOD_LEVEL_TRANSPORT );
849 ldap_pvt_tls_inplace ( Sockbuf *sb )
851 return HAS_TLS( sb ) ? 1 : 0;
855 ldap_pvt_tls_sb_ctx( Sockbuf *sb )
860 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&p );
868 ldap_pvt_tls_get_strength( void *s )
872 c = SSL_get_current_cipher((SSL *)s);
873 return SSL_CIPHER_get_bits(c, NULL);
878 ldap_pvt_tls_get_my_dn( void *s, struct berval *dn, LDAPDN_rewrite_dummy *func, unsigned flags )
884 x = SSL_get_certificate((SSL *)s);
886 if (!x) return LDAP_INVALID_CREDENTIALS;
888 xn = X509_get_subject_name(x);
889 rc = ldap_X509dn2bv(xn, dn, (LDAPDN_rewrite_func *)func, flags );
894 tls_get_cert( SSL *s )
896 /* If peer cert was bad, treat as if no cert was given */
897 if (SSL_get_verify_result(s)) {
898 /* If we can send an alert, do so */
899 if (SSL_version(s) != SSL2_VERSION) {
900 ssl3_send_alert(s,SSL3_AL_WARNING,SSL3_AD_BAD_CERTIFICATE);
904 return SSL_get_peer_certificate(s);
908 ldap_pvt_tls_get_peer_dn( void *s, struct berval *dn, LDAPDN_rewrite_dummy *func, unsigned flags )
914 x = tls_get_cert((SSL *)s);
916 if (!x) return LDAP_INVALID_CREDENTIALS;
918 xn = X509_get_subject_name(x);
919 rc = ldap_X509dn2bv(xn, dn, (LDAPDN_rewrite_func *)func, flags);
925 ldap_pvt_tls_get_peer_hostname( void *s )
932 x = tls_get_cert((SSL *)s);
935 xn = X509_get_subject_name(x);
937 ret = X509_NAME_get_text_by_NID(xn, NID_commonName, buf, sizeof(buf));
943 p = LDAP_STRDUP(buf);
949 ldap_pvt_tls_check_hostname( LDAP *ld, void *s, const char *name_in )
951 int i, ret = LDAP_LOCAL_ERROR;
955 if( ldap_int_hostname &&
956 ( !name_in || !strcasecmp( name_in, "localhost" ) ) )
958 name = ldap_int_hostname;
963 x = tls_get_cert((SSL *)s);
966 LDAP_LOG ( TRANSPORT, ERR,
967 "ldap_pvt_tls_check_hostname: "
968 "TLS unable to get peer certificate.\n" , 0, 0, 0 );
970 Debug( LDAP_DEBUG_ANY,
971 "TLS: unable to get peer certificate.\n",
974 /* If this was a fatal condition, things would have
975 * aborted long before now.
980 i = X509_get_ext_by_NID(x, NID_subject_alt_name, -1);
983 STACK_OF(GENERAL_NAME) *alt;
985 ex = X509_get_ext(x, i);
986 alt = X509V3_EXT_d2i(ex);
988 int n, len1, len2 = 0;
993 n = sk_GENERAL_NAME_num(alt);
994 domain = strchr(name, '.');
996 len2 = len1 - (domain-name);
998 for (i=0; i<n; i++) {
999 gn = sk_GENERAL_NAME_value(alt, i);
1000 if (gn->type == GEN_DNS) {
1001 char *sn = ASN1_STRING_data(gn->d.ia5);
1002 int sl = ASN1_STRING_length(gn->d.ia5);
1004 /* Is this an exact match? */
1005 if ((len1 == sl) && !strncasecmp(name, sn, len1)) {
1009 /* Is this a wildcard match? */
1010 if ((*sn == '*') && domain && (len2 == sl-1) &&
1011 !strncasecmp(domain, sn+1, len2))
1017 /* Is this a RFC 2549 style wildcard match? */
1018 if ((*sn == '.') && domain && (len2 == sl) &&
1019 !strncasecmp(domain, sn, len2))
1027 GENERAL_NAMES_free(alt);
1028 if (i < n) { /* Found a match */
1034 if (ret != LDAP_SUCCESS) {
1038 xn = X509_get_subject_name(x);
1040 if( X509_NAME_get_text_by_NID( xn, NID_commonName,
1041 buf, sizeof(buf)) == -1)
1044 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_check_hostname: "
1045 "TLS unable to get common name from peer certificate.\n",
1048 Debug( LDAP_DEBUG_ANY,
1049 "TLS: unable to get common name from peer certificate.\n",
1052 ld->ld_error = LDAP_STRDUP("TLS: unable to get CN from peer certificate");
1054 } else if (strcasecmp(name, buf)) {
1056 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_check_hostname: "
1057 "TLS hostname (%s) does not match "
1058 "common name in certificate (%s).\n", name, buf, 0 );
1060 Debug( LDAP_DEBUG_ANY, "TLS: hostname (%s) does not match "
1061 "common name in certificate (%s).\n",
1064 ret = LDAP_CONNECT_ERROR;
1065 ld->ld_error = LDAP_STRDUP("TLS: hostname does not match CN in peer certificate");
1076 ldap_pvt_tls_get_peer_issuer( void *s )
1078 #if 0 /* currently unused; see ldap_pvt_tls_get_peer_dn() if needed */
1083 x = SSL_get_peer_certificate((SSL *)s);
1085 if (!x) return NULL;
1087 xn = X509_get_issuer_name(x);
1088 p = LDAP_STRDUP(X509_NAME_oneline(xn, buf, sizeof(buf)));
1097 ldap_int_tls_config( LDAP *ld, int option, const char *arg )
1102 case LDAP_OPT_X_TLS_CACERTFILE:
1103 case LDAP_OPT_X_TLS_CACERTDIR:
1104 case LDAP_OPT_X_TLS_CERTFILE:
1105 case LDAP_OPT_X_TLS_KEYFILE:
1106 case LDAP_OPT_X_TLS_RANDOM_FILE:
1107 return ldap_pvt_tls_set_option( ld, option, (void *) arg );
1109 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1110 case LDAP_OPT_X_TLS:
1112 if ( strcasecmp( arg, "never" ) == 0 ) {
1113 i = LDAP_OPT_X_TLS_NEVER ;
1115 } else if ( strcasecmp( arg, "demand" ) == 0 ) {
1116 i = LDAP_OPT_X_TLS_DEMAND ;
1118 } else if ( strcasecmp( arg, "allow" ) == 0 ) {
1119 i = LDAP_OPT_X_TLS_ALLOW ;
1121 } else if ( strcasecmp( arg, "try" ) == 0 ) {
1122 i = LDAP_OPT_X_TLS_TRY ;
1124 } else if ( ( strcasecmp( arg, "hard" ) == 0 ) ||
1125 ( strcasecmp( arg, "on" ) == 0 ) ||
1126 ( strcasecmp( arg, "yes" ) == 0) ||
1127 ( strcasecmp( arg, "true" ) == 0 ) )
1129 i = LDAP_OPT_X_TLS_HARD ;
1133 return ldap_pvt_tls_set_option( ld, option, &i );
1142 ldap_pvt_tls_get_option( LDAP *ld, int option, void *arg )
1144 struct ldapoptions *lo;
1147 assert( LDAP_VALID( ld ) );
1149 if( !LDAP_VALID( ld ) ) {
1150 return LDAP_OPT_ERROR;
1153 lo = &ld->ld_options;
1156 /* Get pointer to global option structure */
1157 lo = LDAP_INT_GLOBAL_OPT();
1159 return LDAP_NO_MEMORY;
1164 case LDAP_OPT_X_TLS:
1165 *(int *)arg = lo->ldo_tls_mode;
1167 case LDAP_OPT_X_TLS_CTX:
1169 *(void **)arg = (void *) tls_def_ctx;
1171 *(void **)arg = ld->ld_defconn->lconn_tls_ctx;
1174 case LDAP_OPT_X_TLS_CACERTFILE:
1175 *(char **)arg = tls_opt_cacertfile ?
1176 LDAP_STRDUP( tls_opt_cacertfile ) : NULL;
1178 case LDAP_OPT_X_TLS_CACERTDIR:
1179 *(char **)arg = tls_opt_cacertdir ?
1180 LDAP_STRDUP( tls_opt_cacertdir ) : NULL;
1182 case LDAP_OPT_X_TLS_CERTFILE:
1183 *(char **)arg = tls_opt_certfile ?
1184 LDAP_STRDUP( tls_opt_certfile ) : NULL;
1186 case LDAP_OPT_X_TLS_KEYFILE:
1187 *(char **)arg = tls_opt_keyfile ?
1188 LDAP_STRDUP( tls_opt_keyfile ) : NULL;
1190 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1191 *(int *)arg = tls_opt_require_cert;
1193 case LDAP_OPT_X_TLS_RANDOM_FILE:
1194 *(char **)arg = tls_opt_randfile ?
1195 LDAP_STRDUP( tls_opt_randfile ) : NULL;
1197 case LDAP_OPT_X_TLS_SSL_CTX: {
1200 LDAPConn *conn = ld->ld_defconn;
1201 if ( conn != NULL ) {
1202 Sockbuf *sb = conn->lconn_sb;
1203 retval = ldap_pvt_tls_sb_ctx( sb );
1206 *(void **)arg = retval;
1216 ldap_pvt_tls_set_option( LDAP *ld, int option, void *arg )
1218 struct ldapoptions *lo;
1221 assert( LDAP_VALID( ld ) );
1223 if( !LDAP_VALID( ld ) ) {
1224 return LDAP_OPT_ERROR;
1227 lo = &ld->ld_options;
1230 /* Get pointer to global option structure */
1231 lo = LDAP_INT_GLOBAL_OPT();
1233 return LDAP_NO_MEMORY;
1238 case LDAP_OPT_X_TLS:
1239 switch( *(int *) arg ) {
1240 case LDAP_OPT_X_TLS_NEVER:
1241 case LDAP_OPT_X_TLS_DEMAND:
1242 case LDAP_OPT_X_TLS_ALLOW:
1243 case LDAP_OPT_X_TLS_TRY:
1244 case LDAP_OPT_X_TLS_HARD:
1246 lo->ldo_tls_mode = *(int *)arg;
1253 case LDAP_OPT_X_TLS_CTX:
1255 tls_def_ctx = (SSL_CTX *) arg;
1258 ld->ld_defconn->lconn_tls_ctx = arg;
1268 case LDAP_OPT_X_TLS_CACERTFILE:
1269 if ( tls_opt_cacertfile ) LDAP_FREE( tls_opt_cacertfile );
1270 tls_opt_cacertfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1272 case LDAP_OPT_X_TLS_CACERTDIR:
1273 if ( tls_opt_cacertdir ) LDAP_FREE( tls_opt_cacertdir );
1274 tls_opt_cacertdir = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1276 case LDAP_OPT_X_TLS_CERTFILE:
1277 if ( tls_opt_certfile ) LDAP_FREE( tls_opt_certfile );
1278 tls_opt_certfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1280 case LDAP_OPT_X_TLS_KEYFILE:
1281 if ( tls_opt_keyfile ) LDAP_FREE( tls_opt_keyfile );
1282 tls_opt_keyfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1284 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1285 switch( *(int *) arg ) {
1286 case LDAP_OPT_X_TLS_NEVER:
1287 case LDAP_OPT_X_TLS_DEMAND:
1288 case LDAP_OPT_X_TLS_ALLOW:
1289 case LDAP_OPT_X_TLS_TRY:
1290 case LDAP_OPT_X_TLS_HARD:
1291 tls_opt_require_cert = * (int *) arg;
1295 case LDAP_OPT_X_TLS_CIPHER_SUITE:
1296 if ( tls_opt_ciphersuite ) LDAP_FREE( tls_opt_ciphersuite );
1297 tls_opt_ciphersuite = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1299 case LDAP_OPT_X_TLS_RANDOM_FILE:
1300 if (tls_opt_randfile ) LDAP_FREE (tls_opt_randfile );
1301 tls_opt_randfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1310 ldap_int_tls_start ( LDAP *ld, LDAPConn *conn, LDAPURLDesc *srv )
1312 Sockbuf *sb = conn->lconn_sb;
1317 host = srv->lud_host;
1319 host = conn->lconn_server->lud_host;
1322 /* avoid NULL host */
1323 if( host == NULL ) {
1327 (void) ldap_pvt_tls_init();
1330 * Fortunately, the lib uses blocking io...
1332 if ( ldap_int_tls_connect( ld, conn ) < 0 ) {
1333 ld->ld_errno = LDAP_CONNECT_ERROR;
1334 return (ld->ld_errno);
1337 ssl = ldap_pvt_tls_sb_ctx( sb );
1338 assert( ssl != NULL );
1341 * compare host with name(s) in certificate
1343 ld->ld_errno = ldap_pvt_tls_check_hostname( ld, ssl, host );
1344 if (ld->ld_errno != LDAP_SUCCESS) {
1345 return ld->ld_errno;
1349 * set SASL properties to TLS ssf and authid
1352 struct berval authid = { 0, NULL };
1355 /* we need to let SASL know */
1356 ssf = ldap_pvt_tls_get_strength( ssl );
1357 /* failure is OK, we just can't use SASL EXTERNAL */
1358 (void) ldap_pvt_tls_get_my_dn( ssl, &authid, NULL, 0 );
1360 (void) ldap_int_sasl_external( ld, conn, authid.bv_val, ssf );
1361 LDAP_FREE( authid.bv_val );
1364 return LDAP_SUCCESS;
1367 /* Derived from openssl/apps/s_cb.c */
1369 tls_info_cb( SSL *ssl, int where, int ret )
1373 char *state = SSL_state_string_long( ssl );
1375 w = where & ~SSL_ST_MASK;
1376 if ( w & SSL_ST_CONNECT ) {
1378 } else if ( w & SSL_ST_ACCEPT ) {
1386 state = LDAP_STRDUP( state );
1390 if ( where & SSL_CB_LOOP ) {
1392 LDAP_LOG ( TRANSPORT, DETAIL1, "tls_info_cb: "
1393 "TLS trace: %s:%s\n", op, state, 0 );
1395 Debug( LDAP_DEBUG_TRACE,
1396 "TLS trace: %s:%s\n",
1400 } else if ( where & SSL_CB_ALERT ) {
1401 char *atype = SSL_alert_type_string_long( ret );
1402 char *adesc = SSL_alert_desc_string_long( ret );
1403 op = ( where & SSL_CB_READ ) ? "read" : "write";
1406 atype = LDAP_STRDUP( atype );
1410 adesc = LDAP_STRDUP( adesc );
1415 LDAP_LOG ( TRANSPORT, DETAIL1,
1416 "tls_info_cb: TLS trace: SSL3 alert %s:%s:%s\n",
1419 Debug( LDAP_DEBUG_TRACE,
1420 "TLS trace: SSL3 alert %s:%s:%s\n",
1424 if ( atype ) LDAP_FREE( atype );
1425 if ( adesc ) LDAP_FREE( adesc );
1427 } else if ( where & SSL_CB_EXIT ) {
1430 LDAP_LOG ( TRANSPORT, ERR,
1431 "tls_info_cb: TLS trace: %s:failed in %s\n",
1434 Debug( LDAP_DEBUG_TRACE,
1435 "TLS trace: %s:failed in %s\n",
1438 } else if ( ret < 0 ) {
1440 LDAP_LOG ( TRANSPORT, ERR,
1441 "tls_info_cb: TLS trace: %s:error in %s\n",
1444 Debug( LDAP_DEBUG_TRACE,
1445 "TLS trace: %s:error in %s\n",
1451 if ( state ) LDAP_FREE( state );
1456 tls_verify_cb( int ok, X509_STORE_CTX *ctx )
1465 char *certerr = NULL;
1467 cert = X509_STORE_CTX_get_current_cert( ctx );
1468 errnum = X509_STORE_CTX_get_error( ctx );
1469 errdepth = X509_STORE_CTX_get_error_depth( ctx );
1472 * X509_get_*_name return pointers to the internal copies of
1473 * those things requested. So do not free them.
1475 subject = X509_get_subject_name( cert );
1476 issuer = X509_get_issuer_name( cert );
1477 /* X509_NAME_oneline, if passed a NULL buf, allocate memomry */
1478 sname = X509_NAME_oneline( subject, NULL, 0 );
1479 iname = X509_NAME_oneline( issuer, NULL, 0 );
1480 if ( !ok ) certerr = (char *)X509_verify_cert_error_string( errnum );
1482 if ( sname ) __etoa( sname );
1483 if ( iname ) __etoa( iname );
1485 certerr = LDAP_STRDUP( certerr );
1490 LDAP_LOG( TRANSPORT, ERR,
1491 "TLS certificate verification: depth: %d, err: %d, subject: %s,",
1493 sname ? sname : "-unknown-" );
1494 LDAP_LOG( TRANSPORT, ERR, " issuer: %s\n", iname ? iname : "-unknown-", 0, 0 );
1496 LDAP_LOG ( TRANSPORT, ERR,
1497 "TLS certificate verification: Error, %s\n",
1501 Debug( LDAP_DEBUG_TRACE,
1502 "TLS certificate verification: depth: %d, err: %d, subject: %s,",
1504 sname ? sname : "-unknown-" );
1505 Debug( LDAP_DEBUG_TRACE, " issuer: %s\n", iname ? iname : "-unknown-", 0, 0 );
1507 Debug( LDAP_DEBUG_ANY,
1508 "TLS certificate verification: Error, %s\n",
1513 CRYPTO_free ( sname );
1515 CRYPTO_free ( iname );
1517 if ( certerr ) LDAP_FREE( certerr );
1523 tls_verify_ok( int ok, X509_STORE_CTX *ctx )
1525 (void) tls_verify_cb( ok, ctx );
1529 /* Inspired by ERR_print_errors in OpenSSL */
1531 tls_report_error( void )
1538 while ( ( l = ERR_get_error_line( &file, &line ) ) != 0 ) {
1539 ERR_error_string_n( l, buf, sizeof( buf ) );
1542 file = LDAP_STRDUP( file );
1543 __etoa( (char *)file );
1548 LDAP_LOG ( TRANSPORT, ERR,
1549 "tls_report_error: TLS %s %s:%d\n",
1552 Debug( LDAP_DEBUG_ANY, "TLS: %s %s:%d\n",
1556 if ( file ) LDAP_FREE( (void *)file );
1562 tls_tmp_rsa_cb( SSL *ssl, int is_export, int key_length )
1566 /* FIXME: Pregenerate the key on startup */
1567 /* FIXME: Who frees the key? */
1568 tmp_rsa = RSA_generate_key( key_length, RSA_F4, NULL, NULL );
1572 LDAP_LOG ( TRANSPORT, ERR,
1573 "tls_tmp_rsa_cb: TLS Failed to generate temporary %d-bit %s "
1574 "RSA key\n", key_length, is_export ? "export" : "domestic", 0 );
1576 Debug( LDAP_DEBUG_ANY,
1577 "TLS: Failed to generate temporary %d-bit %s RSA key\n",
1578 key_length, is_export ? "export" : "domestic", 0 );
1586 tls_seed_PRNG( const char *randfile )
1588 #ifndef URANDOM_DEVICE
1589 /* no /dev/urandom (or equiv) */
1591 char buffer[MAXPATHLEN];
1593 if (randfile == NULL) {
1594 /* The seed file is $RANDFILE if defined, otherwise $HOME/.rnd.
1595 * If $HOME is not set or buffer too small to hold the pathname,
1596 * an error occurs. - From RAND_file_name() man page.
1597 * The fact is that when $HOME is NULL, .rnd is used.
1599 randfile = RAND_file_name( buffer, sizeof( buffer ) );
1601 } else if (RAND_egd(randfile) > 0) {
1606 if (randfile == NULL) {
1608 LDAP_LOG ( TRANSPORT, DETAIL1,
1609 "tls_seed_PRNG: TLS Use configuration file or "
1610 "$RANDFILE to define seed PRNG\n", 0, 0, 0 );
1612 Debug( LDAP_DEBUG_ANY,
1613 "TLS: Use configuration file or $RANDFILE to define seed PRNG\n",
1619 total = RAND_load_file(randfile, -1);
1621 if (RAND_status() == 0) {
1623 LDAP_LOG ( TRANSPORT, DETAIL1,
1624 "tls_seed_PRNG: TLS PRNG not been seeded with enough data\n",
1627 Debug( LDAP_DEBUG_ANY,
1628 "TLS: PRNG not been seeded with enough data\n",
1634 /* assume if there was enough bits to seed that it's okay
1635 * to write derived bits to the file
1637 RAND_write_file(randfile);
1646 tls_tmp_dh_cb( SSL *ssl, int is_export, int key_length )
1654 ldap_start_tls_s ( LDAP *ld,
1655 LDAPControl **serverctrls,
1656 LDAPControl **clientctrls )
1661 char *rspoid = NULL;
1662 struct berval *rspdata = NULL;
1664 /* XXYYZ: this initiates operation only on default connection! */
1666 if ( ld->ld_sb != NULL && ldap_pvt_tls_inplace( ld->ld_sb ) != 0 ) {
1667 return LDAP_LOCAL_ERROR;
1670 rc = ldap_extended_operation_s( ld, LDAP_EXOP_START_TLS,
1671 NULL, serverctrls, clientctrls, &rspoid, &rspdata );
1672 if ( rc != LDAP_SUCCESS ) {
1676 if ( rspoid != NULL ) {
1680 if ( rspdata != NULL ) {
1681 ber_bvfree( rspdata );
1684 rc = ldap_int_tls_start( ld, ld->ld_defconn, NULL );
1686 rc = LDAP_NOT_SUPPORTED;