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 ) {
180 Debug( LDAP_DEBUG_ANY,
181 "TLS: could not allocate default ctx (%d).\n",
182 ERR_peek_error(),0,0);
185 if ( tls_opt_ciphersuite &&
186 !SSL_CTX_set_cipher_list( tls_def_ctx,
187 tls_opt_ciphersuite ) )
189 Debug( LDAP_DEBUG_ANY,
190 "TLS: could not set cipher list %s.\n",
191 tls_opt_ciphersuite, 0, 0 );
195 if (tls_opt_cacertfile != NULL || tls_opt_cacertdir != NULL) {
196 if ( !SSL_CTX_load_verify_locations( tls_def_ctx,
199 || !SSL_CTX_set_default_verify_paths( tls_def_ctx ) )
201 Debug( LDAP_DEBUG_ANY, "TLS: "
202 "could not load verify locations (file:`%s',dir:`%s').\n",
203 tls_opt_cacertfile ? tls_opt_cacertfile : "",
204 tls_opt_cacertdir ? tls_opt_cacertdir : "",
209 calist = get_ca_list( tls_opt_cacertfile, tls_opt_cacertdir );
211 Debug( LDAP_DEBUG_ANY, "TLS: "
212 "could not load client CA list (file:`%s',dir:`%s').\n",
213 tls_opt_cacertfile ? tls_opt_cacertfile : "",
214 tls_opt_cacertdir ? tls_opt_cacertdir : "",
219 SSL_CTX_set_client_CA_list( tls_def_ctx, calist );
221 if ( tls_opt_keyfile &&
222 !SSL_CTX_use_PrivateKey_file( tls_def_ctx,
226 Debug( LDAP_DEBUG_ANY,
227 "TLS: could not use key file `%s'.\n",
228 tls_opt_keyfile,0,0);
232 if ( tls_opt_certfile &&
233 !SSL_CTX_use_certificate_file( tls_def_ctx,
237 Debug( LDAP_DEBUG_ANY,
238 "TLS: could not use certificate `%s'.\n",
239 tls_opt_certfile,0,0);
243 if ( ( tls_opt_certfile || tls_opt_keyfile ) &&
244 !SSL_CTX_check_private_key( tls_def_ctx ) )
246 Debug( LDAP_DEBUG_ANY,
247 "TLS: private key mismatch.\n",
252 if ( tls_opt_trace ) {
253 SSL_CTX_set_info_callback( tls_def_ctx, tls_info_cb );
256 if ( tls_opt_require_cert ) {
258 if ( tls_opt_require_cert == LDAP_OPT_X_TLS_DEMAND ||
259 tls_opt_require_cert == LDAP_OPT_X_TLS_HARD ) {
260 i |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
263 SSL_CTX_set_verify( tls_def_ctx, i,
264 tls_opt_require_cert == LDAP_OPT_X_TLS_ALLOW ?
265 tls_verify_ok : tls_verify_cb );
266 SSL_CTX_set_tmp_rsa_callback( tls_def_ctx, tls_tmp_rsa_cb );
267 /* SSL_CTX_set_tmp_dh_callback( tls_def_ctx, tls_tmp_dh_cb ); */
269 #ifdef LDAP_R_COMPILE
270 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
274 if ( tls_def_ctx != NULL ) {
275 SSL_CTX_free( tls_def_ctx );
278 #ifdef LDAP_R_COMPILE
279 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
284 static STACK_OF(X509_NAME) *
285 get_ca_list( char * bundle, char * dir )
287 STACK_OF(X509_NAME) *ca_list = NULL;
290 ca_list = SSL_load_client_CA_file( bundle );
293 * FIXME: We have now to go over all files in dir, load them
294 * and add every certificate there to ca_list.
300 alloc_handle( void *ctx_arg )
306 ctx = (SSL_CTX *) ctx_arg;
308 if ( ldap_pvt_tls_init_def_ctx() < 0 ) return NULL;
312 ssl = SSL_new( ctx );
314 Debug( LDAP_DEBUG_ANY,"TLS: can't create ssl handle.\n",0,0,0);
321 update_flags( Sockbuf *sb, SSL * ssl, int rc )
323 int err = SSL_get_error(ssl, rc);
325 sb->sb_trans_needs_read = 0;
326 sb->sb_trans_needs_write = 0;
327 if (err == SSL_ERROR_WANT_READ)
329 sb->sb_trans_needs_read = 1;
331 } else if (err == SSL_ERROR_WANT_WRITE)
333 sb->sb_trans_needs_write = 1;
335 } else if (err == SSL_ERROR_WANT_CONNECT)
343 * TLS support for LBER Sockbufs
348 Sockbuf_IO_Desc *sbiod;
351 static BIO_METHOD sb_tls_bio_method;
354 sb_tls_setup( Sockbuf_IO_Desc *sbiod, void *arg )
359 assert( sbiod != NULL );
361 p = LBER_MALLOC( sizeof( *p ) );
367 bio = BIO_new( &sb_tls_bio_method );
368 bio->ptr = (void *)p;
369 SSL_set_bio( p->ssl, bio, bio );
370 sbiod->sbiod_pvt = p;
375 sb_tls_remove( Sockbuf_IO_Desc *sbiod )
379 assert( sbiod != NULL );
380 assert( sbiod->sbiod_pvt != NULL );
382 p = (struct tls_data *)sbiod->sbiod_pvt;
384 LBER_FREE( sbiod->sbiod_pvt );
385 sbiod->sbiod_pvt = NULL;
390 sb_tls_close( Sockbuf_IO_Desc *sbiod )
394 assert( sbiod != NULL );
395 assert( sbiod->sbiod_pvt != NULL );
397 p = (struct tls_data *)sbiod->sbiod_pvt;
398 SSL_shutdown( p->ssl );
403 sb_tls_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
407 assert( sbiod != NULL );
408 assert( sbiod->sbiod_pvt != NULL );
410 p = (struct tls_data *)sbiod->sbiod_pvt;
412 if ( opt == LBER_SB_OPT_GET_SSL ) {
413 *((SSL **)arg) = p->ssl;
416 } else if ( opt == LBER_SB_OPT_DATA_READY ) {
417 if( SSL_pending( p->ssl ) > 0 ) {
422 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
426 sb_tls_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
432 assert( sbiod != NULL );
433 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
435 p = (struct tls_data *)sbiod->sbiod_pvt;
437 ret = SSL_read( p->ssl, (char *)buf, len );
439 errno = WSAGetLastError();
441 err = SSL_get_error( p->ssl, ret );
442 if (err == SSL_ERROR_WANT_READ ) {
443 sbiod->sbiod_sb->sb_trans_needs_read = 1;
447 sbiod->sbiod_sb->sb_trans_needs_read = 0;
452 sb_tls_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
458 assert( sbiod != NULL );
459 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
461 p = (struct tls_data *)sbiod->sbiod_pvt;
463 ret = SSL_write( p->ssl, (char *)buf, len );
465 errno = WSAGetLastError();
467 err = SSL_get_error( p->ssl, ret );
468 if (err == SSL_ERROR_WANT_WRITE ) {
469 sbiod->sbiod_sb->sb_trans_needs_write = 1;
473 sbiod->sbiod_sb->sb_trans_needs_write = 0;
477 static Sockbuf_IO sb_tls_sbio =
479 sb_tls_setup, /* sbi_setup */
480 sb_tls_remove, /* sbi_remove */
481 sb_tls_ctrl, /* sbi_ctrl */
482 sb_tls_read, /* sbi_read */
483 sb_tls_write, /* sbi_write */
484 sb_tls_close /* sbi_close */
488 sb_tls_bio_create( BIO *b ) {
497 sb_tls_bio_destroy( BIO *b )
502 b->ptr = NULL; /* sb_tls_remove() will free it */
509 sb_tls_bio_read( BIO *b, char *buf, int len )
514 if ( buf == NULL || len <= 0 )
517 p = (struct tls_data *)b->ptr;
519 if ( p == NULL || p->sbiod == NULL )
522 ret = LBER_SBIOD_READ_NEXT( p->sbiod, buf, len );
524 BIO_clear_retry_flags( b );
525 if ( ret < 0 && errno == EWOULDBLOCK )
526 BIO_set_retry_read( b );
532 sb_tls_bio_write( BIO *b, const char *buf, int len )
537 if ( buf == NULL || len <= 0 )
540 p = (struct tls_data *)b->ptr;
542 if ( p == NULL || p->sbiod == NULL )
545 ret = LBER_SBIOD_WRITE_NEXT( p->sbiod, (char *)buf, len );
547 BIO_clear_retry_flags( b );
548 if ( ret < 0 && errno == EWOULDBLOCK )
549 BIO_set_retry_write( b );
555 sb_tls_bio_ctrl( BIO *b, int cmd, long num, void *ptr )
557 if ( cmd == BIO_CTRL_FLUSH ) {
558 /* The OpenSSL library needs this */
565 sb_tls_bio_gets( BIO *b, char *buf, int len )
571 sb_tls_bio_puts( BIO *b, const char *str )
573 return sb_tls_bio_write( b, str, strlen( str ) );
576 static BIO_METHOD sb_tls_bio_method =
578 ( 100 | 0x400 ), /* it's a source/sink BIO */
590 * Call this to do a TLS connect on a sockbuf. ctx_arg can be
591 * a SSL_CTX * or NULL, in which case the default ctx is used.
595 * 0 - Success. Connection is ready for communication.
596 * <0 - Error. Can't create a TLS stream.
597 * >0 - Partial success.
598 * Do a select (using information from lber_pvt_sb_needs_{read,write}
603 ldap_int_tls_connect( LDAP *ld, LDAPConn *conn )
605 Sockbuf *sb = conn->lconn_sb;
609 if ( HAS_TLS( sb ) ) {
610 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
613 void *ctx = ld->ld_defconn
614 ? ld->ld_defconn->lconn_tls_ctx : NULL;
616 ssl = alloc_handle( ctx );
618 if ( ssl == NULL ) return -1;
621 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
622 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
624 ber_sockbuf_add_io( sb, &sb_tls_sbio,
625 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
628 conn->lconn_tls_ctx = tls_def_ctx;
632 err = SSL_connect( ssl );
635 errno = WSAGetLastError();
638 if ( update_flags( sb, ssl, err )) {
641 if ((err = ERR_peek_error())) {
643 ld->ld_error = LDAP_STRDUP(ERR_error_string(err, buf));
645 Debug( LDAP_DEBUG_ANY,"TLS: can't connect.\n",0,0,0);
646 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
647 LBER_SBIOD_LEVEL_TRANSPORT );
649 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
650 LBER_SBIOD_LEVEL_TRANSPORT );
659 * Call this to do a TLS accept on a sockbuf.
660 * Everything else is the same as with tls_connect.
663 ldap_pvt_tls_accept( Sockbuf *sb, void *ctx_arg )
668 if ( HAS_TLS( sb ) ) {
669 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
671 ssl = alloc_handle( ctx_arg );
675 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
676 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
678 ber_sockbuf_add_io( sb, &sb_tls_sbio,
679 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
682 err = SSL_accept( ssl );
685 errno = WSAGetLastError();
688 if ( update_flags( sb, ssl, err ))
690 Debug( LDAP_DEBUG_ANY,"TLS: can't accept.\n",0,0,0 );
692 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
693 LBER_SBIOD_LEVEL_TRANSPORT );
695 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
696 LBER_SBIOD_LEVEL_TRANSPORT );
705 ldap_pvt_tls_inplace ( Sockbuf *sb )
713 ldap_pvt_tls_sb_ctx( Sockbuf *sb )
718 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&p );
726 ldap_pvt_tls_get_strength( void *s )
730 c = SSL_get_current_cipher((SSL *)s);
731 return SSL_CIPHER_get_bits(c, NULL);
736 ldap_pvt_tls_get_peer( void *s )
742 /* If peer cert was bad, treat as if no cert was given */
743 if (SSL_get_verify_result((SSL *)s))
746 x = SSL_get_peer_certificate((SSL *)s);
751 xn = X509_get_subject_name(x);
752 p = LDAP_STRDUP(X509_NAME_oneline(xn, buf, sizeof(buf)));
758 ldap_pvt_tls_get_peer_dn( void *s )
762 char buf[2048], *p, *dn;
764 if (SSL_get_verify_result((SSL *)s))
767 x = SSL_get_peer_certificate((SSL *)s);
771 xn = X509_get_subject_name(x);
772 p = X509_NAME_oneline(xn, buf, sizeof(buf));
774 dn = ldap_dcedn2dn( p );
781 ldap_pvt_tls_get_peer_hostname( void *s )
788 if (SSL_get_verify_result((SSL *)s))
791 x = SSL_get_peer_certificate((SSL *)s);
796 xn = X509_get_subject_name(x);
798 ret = X509_NAME_get_text_by_NID(xn, NID_commonName, buf, sizeof(buf));
804 p = LDAP_STRDUP(buf);
810 ldap_pvt_tls_check_hostname( void *s, const char *name_in )
812 int i, ret = LDAP_LOCAL_ERROR;
816 if( ldap_int_hostname &&
817 ( !name_in || !strcasecmp( name_in, "localhost" ) ) )
819 name = ldap_int_hostname;
824 if (SSL_get_verify_result((SSL *)s))
825 return LDAP_CONNECT_ERROR;
827 x = SSL_get_peer_certificate((SSL *)s);
830 Debug( LDAP_DEBUG_ANY,
831 "TLS: unable to get peer certificate.\n",
836 i = X509_get_ext_by_NID(x, NID_subject_alt_name, -1);
840 STACK_OF(GENERAL_NAME) *alt;
842 ex = X509_get_ext(x, i);
843 alt = X509V3_EXT_d2i(ex);
849 X509V3_EXT_METHOD *method;
852 n = sk_GENERAL_NAME_num(alt);
853 domain = strchr(name, '.');
855 len2 = len1 - (domain-name);
858 gn = sk_GENERAL_NAME_value(alt, i);
859 if (gn->type == GEN_DNS)
861 char *sn = ASN1_STRING_data(gn->d.ia5);
862 int sl = ASN1_STRING_length(gn->d.ia5);
864 /* Is this an exact match? */
865 if ((len1 == sl) && !strncasecmp(name, sn, len1))
868 /* Is this a wildcard match? */
869 if ((*sn == '*') && domain && (len2 == sl-1) &&
870 !strncasecmp(domain, sn+1, len2))
874 method = X509V3_EXT_get(ex);
875 method->ext_free(alt);
876 if (i < n) /* Found a match */
881 if (ret != LDAP_SUCCESS)
886 xn = X509_get_subject_name(x);
888 if (X509_NAME_get_text_by_NID(xn, NID_commonName, buf, sizeof(buf))
891 Debug( LDAP_DEBUG_ANY,
892 "TLS: unable to get common name from peer certificate.\n",
894 } else if (strcasecmp(name, buf))
896 Debug( LDAP_DEBUG_ANY, "TLS: hostname (%s) does not match "
897 "common name in certificate (%s).\n",
899 ret = LDAP_CONNECT_ERROR;
910 ldap_pvt_tls_get_peer_issuer( void *s )
912 #if 0 /* currently unused; see ldap_pvt_tls_get_peer() if needed */
917 x = SSL_get_peer_certificate((SSL *)s);
922 xn = X509_get_issuer_name(x);
923 p = LDAP_STRDUP(X509_NAME_oneline(xn, buf, sizeof(buf)));
932 ldap_int_tls_config( LDAP *ld, int option, const char *arg )
937 case LDAP_OPT_X_TLS_CACERTFILE:
938 case LDAP_OPT_X_TLS_CACERTDIR:
939 case LDAP_OPT_X_TLS_CERTFILE:
940 case LDAP_OPT_X_TLS_KEYFILE:
941 case LDAP_OPT_X_TLS_RANDOM_FILE:
942 return ldap_pvt_tls_set_option( ld, option, (void *) arg );
944 case LDAP_OPT_X_TLS_REQUIRE_CERT:
947 if ( strcasecmp( arg, "never" ) == 0 )
948 i = LDAP_OPT_X_TLS_NEVER ;
949 if ( strcasecmp( arg, "demand" ) == 0 )
950 i = LDAP_OPT_X_TLS_DEMAND ;
951 if ( strcasecmp( arg, "allow" ) == 0 )
952 i = LDAP_OPT_X_TLS_ALLOW ;
953 if ( strcasecmp( arg, "try" ) == 0 )
954 i = LDAP_OPT_X_TLS_TRY ;
955 if ( ( strcasecmp( arg, "hard" ) == 0 ) ||
956 ( strcasecmp( arg, "on" ) == 0 ) ||
957 ( strcasecmp( arg, "yes" ) == 0) ||
958 ( strcasecmp( arg, "true" ) == 0 ) )
959 i = LDAP_OPT_X_TLS_HARD ;
962 return ldap_pvt_tls_set_option( ld, option, &i );
971 ldap_pvt_tls_get_option( LDAP *ld, int option, void *arg )
973 struct ldapoptions *lo;
976 assert( LDAP_VALID( ld ) );
978 if( !LDAP_VALID( ld ) ) {
979 return LDAP_OPT_ERROR;
982 lo = &ld->ld_options;
985 /* Get pointer to global option structure */
986 lo = LDAP_INT_GLOBAL_OPT();
988 return LDAP_NO_MEMORY;
994 *(int *)arg = lo->ldo_tls_mode;
996 case LDAP_OPT_X_TLS_CTX:
998 *(void **)arg = (void *) tls_def_ctx;
1000 *(void **)arg = ld->ld_defconn->lconn_tls_ctx;
1002 case LDAP_OPT_X_TLS_CACERTFILE:
1003 *(char **)arg = tls_opt_cacertfile ?
1004 LDAP_STRDUP( tls_opt_cacertfile ) : NULL;
1006 case LDAP_OPT_X_TLS_CACERTDIR:
1007 *(char **)arg = tls_opt_cacertdir ?
1008 LDAP_STRDUP( tls_opt_cacertdir ) : NULL;
1010 case LDAP_OPT_X_TLS_CERTFILE:
1011 *(char **)arg = tls_opt_certfile ?
1012 LDAP_STRDUP( tls_opt_certfile ) : NULL;
1014 case LDAP_OPT_X_TLS_KEYFILE:
1015 *(char **)arg = tls_opt_keyfile ?
1016 LDAP_STRDUP( tls_opt_keyfile ) : NULL;
1018 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1019 *(int *)arg = tls_opt_require_cert;
1021 case LDAP_OPT_X_TLS_RANDOM_FILE:
1022 *(char **)arg = tls_opt_randfile ?
1023 LDAP_STRDUP( tls_opt_randfile ) : NULL;
1032 ldap_pvt_tls_set_option( LDAP *ld, int option, void *arg )
1034 struct ldapoptions *lo;
1037 assert( LDAP_VALID( ld ) );
1039 if( !LDAP_VALID( ld ) ) {
1040 return LDAP_OPT_ERROR;
1043 lo = &ld->ld_options;
1046 /* Get pointer to global option structure */
1047 lo = LDAP_INT_GLOBAL_OPT();
1049 return LDAP_NO_MEMORY;
1054 case LDAP_OPT_X_TLS:
1055 switch( *(int *) arg ) {
1056 case LDAP_OPT_X_TLS_NEVER:
1057 case LDAP_OPT_X_TLS_DEMAND:
1058 case LDAP_OPT_X_TLS_ALLOW:
1059 case LDAP_OPT_X_TLS_TRY:
1060 case LDAP_OPT_X_TLS_HARD:
1062 lo->ldo_tls_mode = *(int *)arg;
1069 case LDAP_OPT_X_TLS_CTX:
1071 tls_def_ctx = (SSL_CTX *) arg;
1074 ld->ld_defconn->lconn_tls_ctx = arg;
1084 case LDAP_OPT_X_TLS_CACERTFILE:
1085 if ( tls_opt_cacertfile ) LDAP_FREE( tls_opt_cacertfile );
1086 tls_opt_cacertfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1088 case LDAP_OPT_X_TLS_CACERTDIR:
1089 if ( tls_opt_cacertdir ) LDAP_FREE( tls_opt_cacertdir );
1090 tls_opt_cacertdir = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1092 case LDAP_OPT_X_TLS_CERTFILE:
1093 if ( tls_opt_certfile ) LDAP_FREE( tls_opt_certfile );
1094 tls_opt_certfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1096 case LDAP_OPT_X_TLS_KEYFILE:
1097 if ( tls_opt_keyfile ) LDAP_FREE( tls_opt_keyfile );
1098 tls_opt_keyfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1100 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1101 switch( *(int *) arg ) {
1102 case LDAP_OPT_X_TLS_NEVER:
1103 case LDAP_OPT_X_TLS_DEMAND:
1104 case LDAP_OPT_X_TLS_ALLOW:
1105 case LDAP_OPT_X_TLS_TRY:
1106 case LDAP_OPT_X_TLS_HARD:
1107 tls_opt_require_cert = * (int *) arg;
1111 case LDAP_OPT_X_TLS_CIPHER_SUITE:
1112 if ( tls_opt_ciphersuite ) LDAP_FREE( tls_opt_ciphersuite );
1113 tls_opt_ciphersuite = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1115 case LDAP_OPT_X_TLS_RANDOM_FILE:
1116 if (tls_opt_randfile ) LDAP_FREE (tls_opt_randfile );
1117 tls_opt_randfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1126 ldap_int_tls_start ( LDAP *ld, LDAPConn *conn, LDAPURLDesc *srv )
1128 Sockbuf *sb = conn->lconn_sb;
1133 host = srv->lud_host;
1135 host = conn->lconn_server->lud_host;
1138 /* avoid NULL host */
1139 if( host == NULL ) {
1143 (void) ldap_pvt_tls_init();
1146 * Fortunately, the lib uses blocking io...
1148 if ( ldap_int_tls_connect( ld, conn ) < 0 ) {
1149 ld->ld_errno = LDAP_CONNECT_ERROR;
1150 return (ld->ld_errno);
1153 ssl = (void *) ldap_pvt_tls_sb_ctx( sb );
1154 assert( ssl != NULL );
1157 * compare host with name(s) in certificate
1159 ld->ld_errno = ldap_pvt_tls_check_hostname( ssl, host );
1160 if (ld->ld_errno != LDAP_SUCCESS) {
1161 return ld->ld_errno;
1165 * set SASL properties to TLS ssf and authid
1171 /* we need to let SASL know */
1172 ssf = ldap_pvt_tls_get_strength( ssl );
1173 authid = ldap_pvt_tls_get_peer( ssl );
1175 (void) ldap_int_sasl_external( ld, conn, authid, ssf );
1178 return LDAP_SUCCESS;
1181 /* Derived from openssl/apps/s_cb.c */
1183 tls_info_cb( SSL *ssl, int where, int ret )
1188 w = where & ~SSL_ST_MASK;
1189 if ( w & SSL_ST_CONNECT ) {
1191 } else if ( w & SSL_ST_ACCEPT ) {
1197 if ( where & SSL_CB_LOOP ) {
1198 Debug( LDAP_DEBUG_TRACE,
1199 "TLS trace: %s:%s\n",
1200 op, SSL_state_string_long( ssl ), 0 );
1201 } else if ( where & SSL_CB_ALERT ) {
1202 op = ( where & SSL_CB_READ ) ? "read" : "write";
1203 Debug( LDAP_DEBUG_TRACE,
1204 "TLS trace: SSL3 alert %s:%s:%s\n",
1206 SSL_alert_type_string_long( ret ),
1207 SSL_alert_desc_string_long( ret) );
1208 } else if ( where & SSL_CB_EXIT ) {
1210 Debug( LDAP_DEBUG_TRACE,
1211 "TLS trace: %s:failed in %s\n",
1212 op, SSL_state_string_long( ssl ), 0 );
1213 } else if ( ret < 0 ) {
1214 Debug( LDAP_DEBUG_TRACE,
1215 "TLS trace: %s:error in %s\n",
1216 op, SSL_state_string_long( ssl ), 0 );
1222 tls_verify_cb( int ok, X509_STORE_CTX *ctx )
1232 cert = X509_STORE_CTX_get_current_cert( ctx );
1233 errnum = X509_STORE_CTX_get_error( ctx );
1234 errdepth = X509_STORE_CTX_get_error_depth( ctx );
1237 * X509_get_*_name return pointers to the internal copies of
1238 * those things requested. So do not free them.
1240 subject = X509_get_subject_name( cert );
1241 issuer = X509_get_issuer_name( cert );
1242 /* X509_NAME_oneline, if passed a NULL buf, allocate memomry */
1243 sname = X509_NAME_oneline( subject, NULL, 0 );
1244 iname = X509_NAME_oneline( issuer, NULL, 0 );
1245 Debug( LDAP_DEBUG_TRACE,
1246 "TLS certificate verification: depth: %d, subject: %s, issuer: %s\n",
1248 sname ? sname : "-unknown-",
1249 iname ? iname : "-unknown-" );
1251 CRYPTO_free ( sname );
1253 CRYPTO_free ( iname );
1259 tls_verify_ok( int ok, X509_STORE_CTX *ctx )
1261 (void) tls_verify_cb( ok, ctx );
1265 /* Inspired by ERR_print_errors in OpenSSL */
1267 tls_report_error( void )
1274 while ( ( l = ERR_get_error_line( &file, &line ) ) != 0 ) {
1275 Debug( LDAP_DEBUG_ANY, "TLS: %s %s:%d\n",
1276 ERR_error_string( l, buf ), file, line );
1281 tls_tmp_rsa_cb( SSL *ssl, int is_export, int key_length )
1285 /* FIXME: Pregenerate the key on startup */
1286 /* FIXME: Who frees the key? */
1287 tmp_rsa = RSA_generate_key( key_length, RSA_F4, NULL, NULL );
1290 Debug( LDAP_DEBUG_ANY,
1291 "TLS: Failed to generate temporary %d-bit %s RSA key\n",
1292 key_length, is_export ? "export" : "domestic", 0 );
1299 tls_seed_PRNG( const char *randfile )
1301 #ifndef URANDOM_DEVICE
1302 /* no /dev/urandom (or equiv) */
1304 char buffer[MAXPATHLEN];
1306 if (randfile == NULL) {
1307 /* The seed file is $RANDFILE if defined, otherwise $HOME/.rnd.
1308 * If $HOME is not set or buffer too small to hold the pathname,
1309 * an error occurs. - From RAND_file_name() man page.
1310 * The fact is that when $HOME is NULL, .rnd is used.
1312 randfile = RAND_file_name( buffer, sizeof( buffer ) );
1314 } else if (RAND_egd(randfile) > 0) {
1319 if (randfile == NULL) {
1320 Debug( LDAP_DEBUG_ANY,
1321 "TLS: Use configuration file or $RANDFILE to define seed PRNG\n",
1326 total = RAND_load_file(randfile, -1);
1328 if (RAND_status() == 0) {
1329 Debug( LDAP_DEBUG_ANY,
1330 "TLS: PRNG not been seeded with enough data\n",
1335 /* assume if there was enough bits to seed that it's okay
1336 * to write derived bits to the file
1338 RAND_write_file(randfile);
1347 tls_tmp_dh_cb( SSL *ssl, int is_export, int key_length )
1355 ldap_start_tls_s ( LDAP *ld,
1356 LDAPControl **serverctrls,
1357 LDAPControl **clientctrls )
1362 char *rspoid = NULL;
1363 struct berval *rspdata = NULL;
1365 /* XXYYZ: this initiates operation only on default connection! */
1367 if ( ld->ld_sb != NULL && ldap_pvt_tls_inplace( ld->ld_sb ) != 0 ) {
1368 return LDAP_LOCAL_ERROR;
1371 rc = ldap_extended_operation_s( ld, LDAP_EXOP_START_TLS,
1372 NULL, serverctrls, clientctrls, &rspoid, &rspdata );
1373 if ( rc != LDAP_SUCCESS ) {
1377 if ( rspoid != NULL ) {
1381 if ( rspdata != NULL ) {
1382 ber_bvfree( rspdata );
1385 rc = ldap_int_tls_start( ld, ld->ld_defconn, NULL );
1387 rc = LDAP_NOT_SUPPORTED;