3 * Copyright 1998-2000 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
6 * tls.c - Handle tls/ssl using SSLeay or OpenSSL.
15 #include <ac/stdlib.h>
17 #include <ac/socket.h>
18 #include <ac/string.h>
20 #include <ac/unistd.h>
25 #include <ldap_pvt_thread.h>
28 #ifdef HAVE_OPENSSL_SSL_H
29 #include <openssl/ssl.h>
30 #include <openssl/x509v3.h>
31 #include <openssl/err.h>
32 #elif defined( HAVE_SSL_H )
36 static int tls_opt_trace = 1;
37 static char *tls_opt_certfile = NULL;
38 static char *tls_opt_keyfile = NULL;
39 static char *tls_opt_cacertfile = NULL;
40 static char *tls_opt_cacertdir = NULL;
41 static int tls_opt_require_cert = 0;
42 static char *tls_opt_ciphersuite = NULL;
44 #define HAS_TLS( sb ) ber_sockbuf_ctrl( sb, LBER_SB_OPT_HAS_IO, \
45 (void *)&ldap_pvt_sockbuf_io_tls )
47 static void tls_report_error( void );
49 static void tls_info_cb( SSL *ssl, int where, int ret );
50 static int tls_verify_cb( int ok, X509_STORE_CTX *ctx );
51 static RSA * tls_tmp_rsa_cb( SSL *ssl, int is_export, int key_length );
52 static STACK_OF(X509_NAME) * get_ca_list( char * bundle, char * dir );
54 #if 0 /* Currently this is not used by anyone */
55 static DH * tls_tmp_dh_cb( SSL *ssl, int is_export, int key_length );
58 static SSL_CTX *tls_def_ctx = NULL;
62 * provide mutexes for the SSLeay library.
64 static ldap_pvt_thread_mutex_t tls_mutexes[CRYPTO_NUM_LOCKS];
66 static void tls_locking_cb( int mode, int type, const char *file, int line )
68 if ( mode & CRYPTO_LOCK ) {
69 ldap_pvt_thread_mutex_lock( &tls_mutexes[type] );
71 ldap_pvt_thread_mutex_unlock( &tls_mutexes[type] );
76 * an extra mutex for the default ctx.
79 static ldap_pvt_thread_mutex_t tls_def_ctx_mutex;
81 static void tls_init_threads( void )
85 for( i=0; i< CRYPTO_NUM_LOCKS ; i++ ) {
86 ldap_pvt_thread_mutex_init( &tls_mutexes[i] );
88 CRYPTO_set_locking_callback( tls_locking_cb );
89 /* FIXME: the thread id should be added somehow... */
91 ldap_pvt_thread_mutex_init( &tls_def_ctx_mutex );
93 #endif /* LDAP_R_COMPILE */
96 * Initialize tls system. Should be called only once.
99 ldap_pvt_tls_init( void )
101 static int tls_initialized = 0;
103 if ( tls_initialized )
106 #ifdef LDAP_R_COMPILE
109 SSL_load_error_strings();
110 SSLeay_add_ssl_algorithms();
111 /* FIXME: mod_ssl does this */
112 X509V3_add_standard_extensions();
117 * initialize the default context
120 ldap_pvt_tls_init_def_ctx( void )
122 STACK_OF(X509_NAME) *calist;
124 #ifdef LDAP_R_COMPILE
125 ldap_pvt_thread_mutex_lock( &tls_def_ctx_mutex );
127 if ( tls_def_ctx == NULL ) {
128 tls_def_ctx = SSL_CTX_new( SSLv23_method() );
129 if ( tls_def_ctx == NULL ) {
130 Debug( LDAP_DEBUG_ANY,
131 "TLS: could not allocate default ctx.\n",0,0,0);
134 if ( tls_opt_ciphersuite &&
135 !SSL_CTX_set_cipher_list( tls_def_ctx,
136 tls_opt_ciphersuite ) ) {
137 Debug( LDAP_DEBUG_ANY,
138 "TLS: could not set cipher list %s.\n",
139 tls_opt_ciphersuite, 0, 0 );
143 if (tls_opt_cacertfile != NULL || tls_opt_cacertdir != NULL) {
144 if ( !SSL_CTX_load_verify_locations( tls_def_ctx,
147 || !SSL_CTX_set_default_verify_paths( tls_def_ctx ) )
149 Debug( LDAP_DEBUG_ANY,
150 "TLS: could not load verify locations (file:`%s',dir:`%s').\n",
151 tls_opt_cacertfile,tls_opt_cacertdir,0);
155 calist = get_ca_list( tls_opt_cacertfile, tls_opt_cacertdir );
157 Debug( LDAP_DEBUG_ANY,
158 "TLS: could not load client CA list (file:`%s',dir:`%s').\n",
159 tls_opt_cacertfile,tls_opt_cacertdir,0);
163 SSL_CTX_set_client_CA_list( tls_def_ctx, calist );
165 if ( tls_opt_keyfile &&
166 !SSL_CTX_use_PrivateKey_file( tls_def_ctx,
168 SSL_FILETYPE_PEM ) ) {
169 Debug( LDAP_DEBUG_ANY,
170 "TLS: could not use key file `%s'.\n",
171 tls_opt_keyfile,0,0);
175 if ( tls_opt_certfile &&
176 !SSL_CTX_use_certificate_file( tls_def_ctx,
178 SSL_FILETYPE_PEM ) ) {
179 Debug( LDAP_DEBUG_ANY,
180 "TLS: could not use certificate `%s'.\n",
181 tls_opt_certfile,0,0);
185 if ( ( tls_opt_certfile || tls_opt_keyfile ) &&
186 !SSL_CTX_check_private_key( tls_def_ctx ) ) {
187 Debug( LDAP_DEBUG_ANY,
188 "TLS: private key mismatch.\n",
193 if ( tls_opt_trace ) {
194 SSL_CTX_set_info_callback( tls_def_ctx, tls_info_cb );
196 SSL_CTX_set_verify( tls_def_ctx, (tls_opt_require_cert) ?
197 (SSL_VERIFY_PEER|SSL_VERIFY_FAIL_IF_NO_PEER_CERT) :
198 SSL_VERIFY_PEER, tls_verify_cb );
199 SSL_CTX_set_tmp_rsa_callback( tls_def_ctx, tls_tmp_rsa_cb );
200 /* SSL_CTX_set_tmp_dh_callback( tls_def_ctx, tls_tmp_dh_cb ); */
202 #ifdef LDAP_R_COMPILE
203 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
207 if ( tls_def_ctx != NULL ) {
208 SSL_CTX_free( tls_def_ctx );
211 #ifdef LDAP_R_COMPILE
212 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
217 static STACK_OF(X509_NAME) *
218 get_ca_list( char * bundle, char * dir )
220 STACK_OF(X509_NAME) *ca_list = NULL;
223 ca_list = SSL_load_client_CA_file( bundle );
226 * FIXME: We have now to go over all files in dir, load them
227 * and add every certificate there to ca_list.
233 alloc_handle( void *ctx_arg )
239 ctx = (SSL_CTX *) ctx_arg;
241 if ( ldap_pvt_tls_init_def_ctx() < 0 )
246 ssl = SSL_new( ctx );
248 Debug( LDAP_DEBUG_ANY,"TLS: can't create ssl handle.\n",0,0,0);
252 if ( tls_opt_trace ) {
253 SSL_set_info_callback( ssl, tls_info_cb );
259 update_flags( Sockbuf *sb, SSL * ssl, int rc )
261 int err = SSL_get_error(ssl, rc);
263 sb->sb_trans_needs_read = 0;
264 sb->sb_trans_needs_write = 0;
265 if (err == SSL_ERROR_WANT_READ)
267 sb->sb_trans_needs_read = 1;
269 } else if (err == SSL_ERROR_WANT_WRITE)
271 sb->sb_trans_needs_write = 1;
273 } else if (err == SSL_ERROR_WANT_CONNECT)
281 * TLS support for LBER Sockbufs
286 Sockbuf_IO_Desc *sbiod;
289 extern BIO_METHOD ldap_pvt_sb_bio_method;
292 sb_tls_setup( Sockbuf_IO_Desc *sbiod, void *arg )
297 assert( sbiod != NULL );
299 p = LBER_MALLOC( sizeof( *p ) );
305 bio = BIO_new( &ldap_pvt_sb_bio_method );
306 bio->ptr = (void *)p;
307 SSL_set_bio( p->ssl, bio, bio );
308 sbiod->sbiod_pvt = p;
313 sb_tls_remove( Sockbuf_IO_Desc *sbiod )
317 assert( sbiod != NULL );
318 assert( sbiod->sbiod_pvt != NULL );
320 p = (struct tls_data *)sbiod->sbiod_pvt;
322 LBER_FREE( sbiod->sbiod_pvt );
323 sbiod->sbiod_pvt = NULL;
328 sb_tls_close( Sockbuf_IO_Desc *sbiod )
332 assert( sbiod != NULL );
333 assert( sbiod->sbiod_pvt != NULL );
335 p = (struct tls_data *)sbiod->sbiod_pvt;
336 SSL_shutdown( p->ssl );
341 sb_tls_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
345 assert( sbiod != NULL );
346 assert( sbiod->sbiod_pvt != NULL );
348 p = (struct tls_data *)sbiod->sbiod_pvt;
350 if ( opt == LBER_SB_OPT_GET_SSL ) {
351 *((SSL **)arg) = p->ssl;
355 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
359 sb_tls_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
365 assert( sbiod != NULL );
366 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
368 p = (struct tls_data *)sbiod->sbiod_pvt;
370 ret = SSL_read( p->ssl, (char *)buf, len );
372 errno = WSAGetLastError();
374 err = SSL_get_error( p->ssl, ret );
375 if (err == SSL_ERROR_WANT_READ ) {
376 sbiod->sbiod_sb->sb_trans_needs_read = 1;
382 sbiod->sbiod_sb->sb_trans_needs_read = 0;
387 sb_tls_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
393 assert( sbiod != NULL );
394 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
396 p = (struct tls_data *)sbiod->sbiod_pvt;
398 ret = SSL_write( p->ssl, (char *)buf, len );
400 errno = WSAGetLastError();
402 err = SSL_get_error( p->ssl, ret );
403 if (err == SSL_ERROR_WANT_WRITE ) {
404 sbiod->sbiod_sb->sb_trans_needs_write = 1;
410 sbiod->sbiod_sb->sb_trans_needs_write = 0;
414 Sockbuf_IO ldap_pvt_sockbuf_io_tls =
416 sb_tls_setup, /* sbi_setup */
417 sb_tls_remove, /* sbi_remove */
418 sb_tls_ctrl, /* sbi_ctrl */
419 sb_tls_read, /* sbi_read */
420 sb_tls_write, /* sbi_write */
421 sb_tls_close /* sbi_close */
425 sb_tls_bio_create( BIO *b ) {
434 sb_tls_bio_destroy( BIO *b )
439 b->ptr = NULL; /* sb_tls_remove() will free it */
446 sb_tls_bio_read( BIO *b, char *buf, int len )
451 if ( buf == NULL || len <= 0 )
454 p = (struct tls_data *)b->ptr;
456 if ( p == NULL || p->sbiod == NULL )
459 ret = LBER_SBIOD_READ_NEXT( p->sbiod, buf, len );
461 BIO_clear_retry_flags( b );
462 if ( ret < 0 && errno == EWOULDBLOCK )
463 BIO_set_retry_read( b );
469 sb_tls_bio_write( BIO *b, char *buf, int len )
474 if ( buf == NULL || len <= 0 )
477 p = (struct tls_data *)b->ptr;
479 if ( p == NULL || p->sbiod == NULL )
482 ret = LBER_SBIOD_WRITE_NEXT( p->sbiod, buf, len );
484 BIO_clear_retry_flags( b );
485 if ( ret < 0 && errno == EWOULDBLOCK )
486 BIO_set_retry_write( b );
492 sb_tls_bio_ctrl( BIO *b, int cmd, long num, char *ptr )
494 if ( cmd == BIO_CTRL_FLUSH ) {
495 /* The OpenSSL library needs this */
502 sb_tls_bio_gets( BIO *b, char *buf, int len )
508 sb_tls_bio_puts( BIO *b, char *str )
510 return sb_tls_bio_write( b, str, strlen( str ) );
513 BIO_METHOD ldap_pvt_sb_bio_method =
515 ( 100 | 0x400 ), /* it's a source/sink BIO */
527 * Call this to do a TLS connect on a sockbuf. ctx_arg can be
528 * a SSL_CTX * or NULL, in which case the default ctx is used.
532 * 0 - Success. Connection is ready for communication.
533 * <0 - Error. Can't create a TLS stream.
534 * >0 - Partial success.
535 * Do a select (using information from lber_pvt_sb_needs_{read,write}
540 ldap_pvt_tls_connect( LDAP *ld, Sockbuf *sb, void *ctx_arg )
545 if ( HAS_TLS( sb ) ) {
546 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
548 ssl = alloc_handle( ctx_arg );
552 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
553 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
555 ber_sockbuf_add_io( sb, &ldap_pvt_sockbuf_io_tls,
556 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
559 err = SSL_connect( ssl );
562 errno = WSAGetLastError();
565 if ( update_flags( sb, ssl, err ))
567 if ((err = ERR_peek_error())) {
569 ld->ld_error = LDAP_STRDUP(ERR_error_string(err, buf));
571 Debug( LDAP_DEBUG_ANY,"TLS: can't connect.\n",0,0,0);
572 ber_sockbuf_remove_io( sb, &ldap_pvt_sockbuf_io_tls,
573 LBER_SBIOD_LEVEL_TRANSPORT );
575 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
576 LBER_SBIOD_LEVEL_TRANSPORT );
584 * Call this to do a TLS accept on a sockbuf.
585 * Everything else is the same as with tls_connect.
588 ldap_pvt_tls_accept( Sockbuf *sb, void *ctx_arg )
593 if ( HAS_TLS( sb ) ) {
594 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
596 ssl = alloc_handle( ctx_arg );
600 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
601 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
603 ber_sockbuf_add_io( sb, &ldap_pvt_sockbuf_io_tls,
604 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
607 err = SSL_accept( ssl );
610 errno = WSAGetLastError();
613 if ( update_flags( sb, ssl, err ))
615 Debug( LDAP_DEBUG_ANY,"TLS: can't accept.\n",0,0,0 );
617 ber_sockbuf_remove_io( sb, &ldap_pvt_sockbuf_io_tls,
618 LBER_SBIOD_LEVEL_TRANSPORT );
620 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
621 LBER_SBIOD_LEVEL_TRANSPORT );
629 ldap_pvt_tls_inplace ( Sockbuf *sb )
637 ldap_pvt_tls_sb_handle( Sockbuf *sb )
642 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&p );
649 ldap_pvt_tls_get_handle( LDAP *ld )
651 return ldap_pvt_tls_sb_handle( ld->ld_sb );
655 ldap_pvt_tls_get_peer( LDAP *ld )
661 ldap_pvt_tls_get_peer_issuer( LDAP *ld )
667 ldap_pvt_tls_config( struct ldapoptions *lo, int option, const char *arg )
672 case LDAP_OPT_X_TLS_CACERTFILE:
673 case LDAP_OPT_X_TLS_CACERTDIR:
674 case LDAP_OPT_X_TLS_CERTFILE:
675 case LDAP_OPT_X_TLS_KEYFILE:
676 return ldap_pvt_tls_set_option( NULL, option, (void *) arg );
677 case LDAP_OPT_X_TLS_REQUIRE_CERT:
678 i = ( ( strcasecmp( arg, "on" ) == 0 ) ||
679 ( strcasecmp( arg, "yes" ) == 0) ||
680 ( strcasecmp( arg, "true" ) == 0 ) );
681 return ldap_pvt_tls_set_option( NULL, option, (void *) &i );
684 if ( strcasecmp( arg, "never" ) == 0 )
685 i = LDAP_OPT_X_TLS_NEVER ;
686 if ( strcasecmp( arg, "demand" ) == 0 )
687 i = LDAP_OPT_X_TLS_DEMAND ;
688 if ( strcasecmp( arg, "allow" ) == 0 )
689 i = LDAP_OPT_X_TLS_ALLOW ;
690 if ( strcasecmp( arg, "try" ) == 0 )
691 i = LDAP_OPT_X_TLS_TRY ;
692 if ( strcasecmp( arg, "hard" ) == 0 )
693 i = LDAP_OPT_X_TLS_HARD ;
695 return ldap_pvt_tls_set_option( lo, option, &i );
703 ldap_pvt_tls_get_option( struct ldapoptions *lo, int option, void *arg )
707 *(int *)arg = lo->ldo_tls_mode;
709 case LDAP_OPT_X_TLS_CERT:
711 *(void **)arg = (void *) tls_def_ctx;
713 *(void **)arg = lo->ldo_tls_ctx;
715 case LDAP_OPT_X_TLS_CACERTFILE:
716 *(char **)arg = tls_opt_cacertfile ?
717 LDAP_STRDUP( tls_opt_cacertfile ) : NULL;
719 case LDAP_OPT_X_TLS_CACERTDIR:
720 *(char **)arg = tls_opt_cacertdir ?
721 LDAP_STRDUP( tls_opt_cacertdir ) : NULL;
723 case LDAP_OPT_X_TLS_CERTFILE:
724 *(char **)arg = tls_opt_certfile ?
725 LDAP_STRDUP( tls_opt_certfile ) : NULL;
727 case LDAP_OPT_X_TLS_KEYFILE:
728 *(char **)arg = tls_opt_keyfile ?
729 LDAP_STRDUP( tls_opt_keyfile ) : NULL;
731 case LDAP_OPT_X_TLS_REQUIRE_CERT:
732 *(int *)arg = tls_opt_require_cert;
741 ldap_pvt_tls_set_option( struct ldapoptions *lo, int option, void *arg )
745 switch( *(int *) arg ) {
746 case LDAP_OPT_X_TLS_NEVER:
747 case LDAP_OPT_X_TLS_DEMAND:
748 case LDAP_OPT_X_TLS_ALLOW:
749 case LDAP_OPT_X_TLS_TRY:
750 case LDAP_OPT_X_TLS_HARD:
752 lo->ldo_tls_mode = *(int *)arg;
759 case LDAP_OPT_X_TLS_CERT:
761 tls_def_ctx = (SSL_CTX *) arg;
764 lo->ldo_tls_ctx = arg;
774 case LDAP_OPT_X_TLS_CACERTFILE:
775 if ( tls_opt_cacertfile ) free( tls_opt_cacertfile );
776 tls_opt_cacertfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
778 case LDAP_OPT_X_TLS_CACERTDIR:
779 if ( tls_opt_cacertdir ) free( tls_opt_cacertdir );
780 tls_opt_cacertdir = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
782 case LDAP_OPT_X_TLS_CERTFILE:
783 if ( tls_opt_certfile ) free( tls_opt_certfile );
784 tls_opt_certfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
786 case LDAP_OPT_X_TLS_KEYFILE:
787 if ( tls_opt_keyfile ) free( tls_opt_keyfile );
788 tls_opt_keyfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
790 case LDAP_OPT_X_TLS_REQUIRE_CERT:
791 tls_opt_require_cert = * (int *) arg;
793 case LDAP_OPT_X_TLS_CIPHER_SUITE:
794 if ( tls_opt_ciphersuite ) free( tls_opt_ciphersuite );
795 tls_opt_ciphersuite = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
804 ldap_pvt_tls_start ( LDAP *ld, Sockbuf *sb, void *ctx_arg )
807 * Fortunately, the lib uses blocking io...
809 if ( ldap_pvt_tls_connect( ld, sb, ctx_arg ) < 0 ) {
810 return LDAP_CONNECT_ERROR;
813 /* FIXME: hostname of server must be compared with name in
820 /* Derived from openssl/apps/s_cb.c */
822 tls_info_cb( SSL *ssl, int where, int ret )
827 w = where & ~SSL_ST_MASK;
828 if ( w & SSL_ST_CONNECT ) {
830 } else if ( w & SSL_ST_ACCEPT ) {
836 if ( where & SSL_CB_LOOP ) {
837 Debug( LDAP_DEBUG_TRACE,
838 "TLS trace: %s:%s\n",
839 op, SSL_state_string_long( ssl ), 0 );
840 } else if ( where & SSL_CB_ALERT ) {
841 op = ( where & SSL_CB_READ ) ? "read" : "write";
842 Debug( LDAP_DEBUG_TRACE,
843 "TLS trace: SSL3 alert %s:%s:%s\n",
845 SSL_alert_type_string_long( ret ),
846 SSL_alert_desc_string_long( ret) );
847 } else if ( where & SSL_CB_EXIT ) {
849 Debug( LDAP_DEBUG_TRACE,
850 "TLS trace: %s:failed in %s\n",
851 op, SSL_state_string_long( ssl ), 0 );
852 } else if ( ret < 0 ) {
853 Debug( LDAP_DEBUG_TRACE,
854 "TLS trace: %s:error in %s\n",
855 op, SSL_state_string_long( ssl ), 0 );
861 tls_verify_cb( int ok, X509_STORE_CTX *ctx )
871 cert = X509_STORE_CTX_get_current_cert( ctx );
872 errnum = X509_STORE_CTX_get_error( ctx );
873 errdepth = X509_STORE_CTX_get_error_depth( ctx );
876 * X509_get_*_name return pointers to the internal copies of
877 * those things requested. So do not free them.
879 subject = X509_get_subject_name( cert );
880 issuer = X509_get_issuer_name( cert );
881 /* X509_NAME_oneline, if passed a NULL buf, allocate memomry */
882 sname = X509_NAME_oneline( subject, NULL, 0 );
883 iname = X509_NAME_oneline( issuer, NULL, 0 );
884 Debug( LDAP_DEBUG_TRACE,
885 "TLS certificate verification: depth: %d, subject: %s, issuer: %s\n",
887 sname ? sname : "-unknown-",
888 iname ? iname : "-unknown-" );
890 CRYPTO_free ( sname );
892 CRYPTO_free ( iname );
897 /* Inspired by ERR_print_errors in OpenSSL */
899 tls_report_error( void )
906 while ( ( l = ERR_get_error_line( &file, &line ) ) != 0 ) {
907 Debug( LDAP_DEBUG_ANY, "TLS: %s %s:%d\n",
908 ERR_error_string( l, buf ), file, line );
913 tls_tmp_rsa_cb( SSL *ssl, int is_export, int key_length )
917 /* FIXME: Pregenerate the key on startup */
918 /* FIXME: Who frees the key? */
919 tmp_rsa = RSA_generate_key( key_length, RSA_F4, NULL, NULL );
922 Debug( LDAP_DEBUG_ANY, "TLS: Failed to generate temporary %d-bit %s RSA key\n",
923 key_length, is_export ? "export" : "domestic", 0 );
931 tls_tmp_dh_cb( SSL *ssl, int is_export, int key_length )