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);
191 if ( tls_opt_ciphersuite &&
192 !SSL_CTX_set_cipher_list( tls_def_ctx,
193 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 );
207 if (tls_opt_cacertfile != NULL || tls_opt_cacertdir != NULL) {
208 if ( !SSL_CTX_load_verify_locations( tls_def_ctx,
211 || !SSL_CTX_set_default_verify_paths( tls_def_ctx ) )
214 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_init_def_ctx: "
215 "TLS could not load verify locations (file:`%s',dir:`%s').\n",
216 tls_opt_cacertfile ? tls_opt_cacertfile : "",
217 tls_opt_cacertdir ? tls_opt_cacertdir : "" ));
219 Debug( LDAP_DEBUG_ANY, "TLS: "
220 "could not load verify locations (file:`%s',dir:`%s').\n",
221 tls_opt_cacertfile ? tls_opt_cacertfile : "",
222 tls_opt_cacertdir ? tls_opt_cacertdir : "",
228 calist = get_ca_list( tls_opt_cacertfile, tls_opt_cacertdir );
231 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_init_def_ctx: "
232 "TLS could not load client CA list (file: `%s',dir:`%s')\n",
233 tls_opt_cacertfile ? tls_opt_cacertfile : "",
234 tls_opt_cacertdir ? tls_opt_cacertdir : "" ));
236 Debug( LDAP_DEBUG_ANY, "TLS: "
237 "could not load client CA list (file:`%s',dir:`%s').\n",
238 tls_opt_cacertfile ? tls_opt_cacertfile : "",
239 tls_opt_cacertdir ? tls_opt_cacertdir : "",
245 SSL_CTX_set_client_CA_list( tls_def_ctx, calist );
247 if ( tls_opt_keyfile &&
248 !SSL_CTX_use_PrivateKey_file( tls_def_ctx,
253 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_init_def_ctx: "
254 "TLS could not use key file `%s'.\n", tls_opt_keyfile ));
256 Debug( LDAP_DEBUG_ANY,
257 "TLS: could not use key file `%s'.\n",
258 tls_opt_keyfile,0,0);
263 if ( tls_opt_certfile &&
264 !SSL_CTX_use_certificate_file( tls_def_ctx,
269 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_init_def_ctx: "
270 "TLS could not use certificate `%s'.\n", tls_opt_certfile ));
272 Debug( LDAP_DEBUG_ANY,
273 "TLS: could not use certificate `%s'.\n",
274 tls_opt_certfile,0,0);
279 if ( ( tls_opt_certfile || tls_opt_keyfile ) &&
280 !SSL_CTX_check_private_key( tls_def_ctx ) )
283 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_init_def_ctx: "
284 "TLS private key mismatch.\n" ));
286 Debug( LDAP_DEBUG_ANY,
287 "TLS: private key mismatch.\n",
293 if ( tls_opt_trace ) {
294 SSL_CTX_set_info_callback( tls_def_ctx, tls_info_cb );
297 if ( tls_opt_require_cert ) {
299 if ( tls_opt_require_cert == LDAP_OPT_X_TLS_DEMAND ||
300 tls_opt_require_cert == LDAP_OPT_X_TLS_HARD ) {
301 i |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
304 SSL_CTX_set_verify( tls_def_ctx, i,
305 tls_opt_require_cert == LDAP_OPT_X_TLS_ALLOW ?
306 tls_verify_ok : tls_verify_cb );
307 SSL_CTX_set_tmp_rsa_callback( tls_def_ctx, tls_tmp_rsa_cb );
308 /* SSL_CTX_set_tmp_dh_callback( tls_def_ctx, tls_tmp_dh_cb ); */
310 #ifdef LDAP_R_COMPILE
311 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
315 if ( tls_def_ctx != NULL ) {
316 SSL_CTX_free( tls_def_ctx );
319 #ifdef LDAP_R_COMPILE
320 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
325 static STACK_OF(X509_NAME) *
326 get_ca_list( char * bundle, char * dir )
328 STACK_OF(X509_NAME) *ca_list = NULL;
331 ca_list = SSL_load_client_CA_file( bundle );
334 * FIXME: We have now to go over all files in dir, load them
335 * and add every certificate there to ca_list.
341 alloc_handle( void *ctx_arg )
347 ctx = (SSL_CTX *) ctx_arg;
349 if ( ldap_pvt_tls_init_def_ctx() < 0 ) return NULL;
353 ssl = SSL_new( ctx );
356 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "alloc_handle: "
357 "TLS can't create ssl handle.\n" ));
359 Debug( LDAP_DEBUG_ANY,"TLS: can't create ssl handle.\n",0,0,0);
367 update_flags( Sockbuf *sb, SSL * ssl, int rc )
369 int err = SSL_get_error(ssl, rc);
371 sb->sb_trans_needs_read = 0;
372 sb->sb_trans_needs_write = 0;
373 if (err == SSL_ERROR_WANT_READ)
375 sb->sb_trans_needs_read = 1;
377 } else if (err == SSL_ERROR_WANT_WRITE)
379 sb->sb_trans_needs_write = 1;
381 } else if (err == SSL_ERROR_WANT_CONNECT)
389 * TLS support for LBER Sockbufs
394 Sockbuf_IO_Desc *sbiod;
397 static BIO_METHOD sb_tls_bio_method;
400 sb_tls_setup( Sockbuf_IO_Desc *sbiod, void *arg )
405 assert( sbiod != NULL );
407 p = LBER_MALLOC( sizeof( *p ) );
413 bio = BIO_new( &sb_tls_bio_method );
414 bio->ptr = (void *)p;
415 SSL_set_bio( p->ssl, bio, bio );
416 sbiod->sbiod_pvt = p;
421 sb_tls_remove( Sockbuf_IO_Desc *sbiod )
425 assert( sbiod != NULL );
426 assert( sbiod->sbiod_pvt != NULL );
428 p = (struct tls_data *)sbiod->sbiod_pvt;
430 LBER_FREE( sbiod->sbiod_pvt );
431 sbiod->sbiod_pvt = NULL;
436 sb_tls_close( Sockbuf_IO_Desc *sbiod )
440 assert( sbiod != NULL );
441 assert( sbiod->sbiod_pvt != NULL );
443 p = (struct tls_data *)sbiod->sbiod_pvt;
444 SSL_shutdown( p->ssl );
449 sb_tls_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
453 assert( sbiod != NULL );
454 assert( sbiod->sbiod_pvt != NULL );
456 p = (struct tls_data *)sbiod->sbiod_pvt;
458 if ( opt == LBER_SB_OPT_GET_SSL ) {
459 *((SSL **)arg) = p->ssl;
462 } else if ( opt == LBER_SB_OPT_DATA_READY ) {
463 if( SSL_pending( p->ssl ) > 0 ) {
468 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
472 sb_tls_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
478 assert( sbiod != NULL );
479 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
481 p = (struct tls_data *)sbiod->sbiod_pvt;
483 ret = SSL_read( p->ssl, (char *)buf, len );
485 errno = WSAGetLastError();
487 err = SSL_get_error( p->ssl, ret );
488 if (err == SSL_ERROR_WANT_READ ) {
489 sbiod->sbiod_sb->sb_trans_needs_read = 1;
493 sbiod->sbiod_sb->sb_trans_needs_read = 0;
498 sb_tls_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
504 assert( sbiod != NULL );
505 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
507 p = (struct tls_data *)sbiod->sbiod_pvt;
509 ret = SSL_write( p->ssl, (char *)buf, len );
511 errno = WSAGetLastError();
513 err = SSL_get_error( p->ssl, ret );
514 if (err == SSL_ERROR_WANT_WRITE ) {
515 sbiod->sbiod_sb->sb_trans_needs_write = 1;
519 sbiod->sbiod_sb->sb_trans_needs_write = 0;
523 static Sockbuf_IO sb_tls_sbio =
525 sb_tls_setup, /* sbi_setup */
526 sb_tls_remove, /* sbi_remove */
527 sb_tls_ctrl, /* sbi_ctrl */
528 sb_tls_read, /* sbi_read */
529 sb_tls_write, /* sbi_write */
530 sb_tls_close /* sbi_close */
534 sb_tls_bio_create( BIO *b ) {
543 sb_tls_bio_destroy( BIO *b )
548 b->ptr = NULL; /* sb_tls_remove() will free it */
555 sb_tls_bio_read( BIO *b, char *buf, int len )
560 if ( buf == NULL || len <= 0 )
563 p = (struct tls_data *)b->ptr;
565 if ( p == NULL || p->sbiod == NULL )
568 ret = LBER_SBIOD_READ_NEXT( p->sbiod, buf, len );
570 BIO_clear_retry_flags( b );
571 if ( ret < 0 && errno == EWOULDBLOCK )
572 BIO_set_retry_read( b );
578 sb_tls_bio_write( BIO *b, const char *buf, int len )
583 if ( buf == NULL || len <= 0 )
586 p = (struct tls_data *)b->ptr;
588 if ( p == NULL || p->sbiod == NULL )
591 ret = LBER_SBIOD_WRITE_NEXT( p->sbiod, (char *)buf, len );
593 BIO_clear_retry_flags( b );
594 if ( ret < 0 && errno == EWOULDBLOCK )
595 BIO_set_retry_write( b );
601 sb_tls_bio_ctrl( BIO *b, int cmd, long num, void *ptr )
603 if ( cmd == BIO_CTRL_FLUSH ) {
604 /* The OpenSSL library needs this */
611 sb_tls_bio_gets( BIO *b, char *buf, int len )
617 sb_tls_bio_puts( BIO *b, const char *str )
619 return sb_tls_bio_write( b, str, strlen( str ) );
622 static BIO_METHOD sb_tls_bio_method =
624 ( 100 | 0x400 ), /* it's a source/sink BIO */
636 * Call this to do a TLS connect on a sockbuf. ctx_arg can be
637 * a SSL_CTX * or NULL, in which case the default ctx is used.
641 * 0 - Success. Connection is ready for communication.
642 * <0 - Error. Can't create a TLS stream.
643 * >0 - Partial success.
644 * Do a select (using information from lber_pvt_sb_needs_{read,write}
649 ldap_int_tls_connect( LDAP *ld, LDAPConn *conn )
651 Sockbuf *sb = conn->lconn_sb;
655 if ( HAS_TLS( sb ) ) {
656 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
659 void *ctx = ld->ld_defconn
660 ? ld->ld_defconn->lconn_tls_ctx : NULL;
662 ssl = alloc_handle( ctx );
664 if ( ssl == NULL ) return -1;
667 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
668 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
670 ber_sockbuf_add_io( sb, &sb_tls_sbio,
671 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
674 conn->lconn_tls_ctx = tls_def_ctx;
678 err = SSL_connect( ssl );
681 errno = WSAGetLastError();
684 if ( update_flags( sb, ssl, err )) {
687 if ((err = ERR_peek_error())) {
689 ld->ld_error = LDAP_STRDUP(ERR_error_string(err, buf));
692 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_int_tls_connect: "
693 "TLS can't connect.\n" ));
695 Debug( LDAP_DEBUG_ANY,"TLS: can't connect.\n",0,0,0);
697 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
698 LBER_SBIOD_LEVEL_TRANSPORT );
700 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
701 LBER_SBIOD_LEVEL_TRANSPORT );
710 * Call this to do a TLS accept on a sockbuf.
711 * Everything else is the same as with tls_connect.
714 ldap_pvt_tls_accept( Sockbuf *sb, void *ctx_arg )
719 if ( HAS_TLS( sb ) ) {
720 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
722 ssl = alloc_handle( ctx_arg );
726 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
727 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
729 ber_sockbuf_add_io( sb, &sb_tls_sbio,
730 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
733 err = SSL_accept( ssl );
736 errno = WSAGetLastError();
739 if ( update_flags( sb, ssl, err ))
742 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_accept: "
743 "TLS can't accept.\n" ));
745 Debug( LDAP_DEBUG_ANY,"TLS: can't accept.\n",0,0,0 );
748 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
749 LBER_SBIOD_LEVEL_TRANSPORT );
751 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
752 LBER_SBIOD_LEVEL_TRANSPORT );
761 ldap_pvt_tls_inplace ( Sockbuf *sb )
769 ldap_pvt_tls_sb_ctx( Sockbuf *sb )
774 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&p );
782 ldap_pvt_tls_get_strength( void *s )
786 c = SSL_get_current_cipher((SSL *)s);
787 return SSL_CIPHER_get_bits(c, NULL);
792 tls_get_cert( SSL *s )
794 /* If peer cert was bad, treat as if no cert was given */
795 if (SSL_get_verify_result(s)) {
796 /* If we can send an alert, do so */
797 if (SSL_version(s) != SSL2_VERSION) {
798 ssl3_send_alert(s,SSL3_AL_WARNING,SSL3_AD_BAD_CERTIFICATE);
802 return SSL_get_peer_certificate(s);
806 ldap_pvt_tls_get_peer( void *s )
813 x = tls_get_cert((SSL *)s);
818 xn = X509_get_subject_name(x);
819 p = LDAP_STRDUP(X509_NAME_oneline(xn, buf, sizeof(buf)));
825 ldap_pvt_tls_get_peer_dn( void *s )
829 char buf[2048], *p, *dn;
831 x = tls_get_cert((SSL *)s);
835 xn = X509_get_subject_name(x);
836 p = X509_NAME_oneline(xn, buf, sizeof(buf));
838 dn = ldap_dcedn2dn( p );
845 ldap_pvt_tls_get_peer_hostname( void *s )
852 x = tls_get_cert((SSL *)s);
857 xn = X509_get_subject_name(x);
859 ret = X509_NAME_get_text_by_NID(xn, NID_commonName, buf, sizeof(buf));
865 p = LDAP_STRDUP(buf);
871 ldap_pvt_tls_check_hostname( void *s, const char *name_in )
873 int i, ret = LDAP_LOCAL_ERROR;
877 if( ldap_int_hostname &&
878 ( !name_in || !strcasecmp( name_in, "localhost" ) ) )
880 name = ldap_int_hostname;
885 x = tls_get_cert((SSL *)s);
889 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_check_hostname: "
890 "TLS unable to get peer certificate.\n" ));
892 Debug( LDAP_DEBUG_ANY,
893 "TLS: unable to get peer certificate.\n",
899 i = X509_get_ext_by_NID(x, NID_subject_alt_name, -1);
903 STACK_OF(GENERAL_NAME) *alt;
905 ex = X509_get_ext(x, i);
906 alt = X509V3_EXT_d2i(ex);
909 int n, len1, len2 = 0;
912 X509V3_EXT_METHOD *method;
915 n = sk_GENERAL_NAME_num(alt);
916 domain = strchr(name, '.');
918 len2 = len1 - (domain-name);
921 gn = sk_GENERAL_NAME_value(alt, i);
922 if (gn->type == GEN_DNS)
924 char *sn = ASN1_STRING_data(gn->d.ia5);
925 int sl = ASN1_STRING_length(gn->d.ia5);
927 /* Is this an exact match? */
928 if ((len1 == sl) && !strncasecmp(name, sn, len1))
931 /* Is this a wildcard match? */
932 if ((*sn == '*') && domain && (len2 == sl-1) &&
933 !strncasecmp(domain, sn+1, len2))
937 method = X509V3_EXT_get(ex);
938 method->ext_free(alt);
939 if (i < n) /* Found a match */
944 if (ret != LDAP_SUCCESS)
949 xn = X509_get_subject_name(x);
951 if (X509_NAME_get_text_by_NID(xn, NID_commonName, buf, sizeof(buf))
955 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_check_hostname: "
956 "TLS unable to get common name from peer certificate.\n" ));
958 Debug( LDAP_DEBUG_ANY,
959 "TLS: unable to get common name from peer certificate.\n",
962 } else if (strcasecmp(name, buf))
965 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_check_hostname: "
966 "TLS hostname (%s) does not match "
967 "common name in certificate (%s).\n", name, buf ));
969 Debug( LDAP_DEBUG_ANY, "TLS: hostname (%s) does not match "
970 "common name in certificate (%s).\n",
973 ret = LDAP_CONNECT_ERROR;
984 ldap_pvt_tls_get_peer_issuer( void *s )
986 #if 0 /* currently unused; see ldap_pvt_tls_get_peer() if needed */
991 x = SSL_get_peer_certificate((SSL *)s);
996 xn = X509_get_issuer_name(x);
997 p = LDAP_STRDUP(X509_NAME_oneline(xn, buf, sizeof(buf)));
1006 ldap_int_tls_config( LDAP *ld, int option, const char *arg )
1011 case LDAP_OPT_X_TLS_CACERTFILE:
1012 case LDAP_OPT_X_TLS_CACERTDIR:
1013 case LDAP_OPT_X_TLS_CERTFILE:
1014 case LDAP_OPT_X_TLS_KEYFILE:
1015 case LDAP_OPT_X_TLS_RANDOM_FILE:
1016 return ldap_pvt_tls_set_option( ld, option, (void *) arg );
1018 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1019 case LDAP_OPT_X_TLS:
1021 if ( strcasecmp( arg, "never" ) == 0 )
1022 i = LDAP_OPT_X_TLS_NEVER ;
1023 if ( strcasecmp( arg, "demand" ) == 0 )
1024 i = LDAP_OPT_X_TLS_DEMAND ;
1025 if ( strcasecmp( arg, "allow" ) == 0 )
1026 i = LDAP_OPT_X_TLS_ALLOW ;
1027 if ( strcasecmp( arg, "try" ) == 0 )
1028 i = LDAP_OPT_X_TLS_TRY ;
1029 if ( ( strcasecmp( arg, "hard" ) == 0 ) ||
1030 ( strcasecmp( arg, "on" ) == 0 ) ||
1031 ( strcasecmp( arg, "yes" ) == 0) ||
1032 ( strcasecmp( arg, "true" ) == 0 ) )
1033 i = LDAP_OPT_X_TLS_HARD ;
1036 return ldap_pvt_tls_set_option( ld, option, &i );
1045 ldap_pvt_tls_get_option( LDAP *ld, int option, void *arg )
1047 struct ldapoptions *lo;
1050 assert( LDAP_VALID( ld ) );
1052 if( !LDAP_VALID( ld ) ) {
1053 return LDAP_OPT_ERROR;
1056 lo = &ld->ld_options;
1059 /* Get pointer to global option structure */
1060 lo = LDAP_INT_GLOBAL_OPT();
1062 return LDAP_NO_MEMORY;
1067 case LDAP_OPT_X_TLS:
1068 *(int *)arg = lo->ldo_tls_mode;
1070 case LDAP_OPT_X_TLS_CTX:
1072 *(void **)arg = (void *) tls_def_ctx;
1074 *(void **)arg = ld->ld_defconn->lconn_tls_ctx;
1076 case LDAP_OPT_X_TLS_CACERTFILE:
1077 *(char **)arg = tls_opt_cacertfile ?
1078 LDAP_STRDUP( tls_opt_cacertfile ) : NULL;
1080 case LDAP_OPT_X_TLS_CACERTDIR:
1081 *(char **)arg = tls_opt_cacertdir ?
1082 LDAP_STRDUP( tls_opt_cacertdir ) : NULL;
1084 case LDAP_OPT_X_TLS_CERTFILE:
1085 *(char **)arg = tls_opt_certfile ?
1086 LDAP_STRDUP( tls_opt_certfile ) : NULL;
1088 case LDAP_OPT_X_TLS_KEYFILE:
1089 *(char **)arg = tls_opt_keyfile ?
1090 LDAP_STRDUP( tls_opt_keyfile ) : NULL;
1092 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1093 *(int *)arg = tls_opt_require_cert;
1095 case LDAP_OPT_X_TLS_RANDOM_FILE:
1096 *(char **)arg = tls_opt_randfile ?
1097 LDAP_STRDUP( tls_opt_randfile ) : NULL;
1099 case LDAP_OPT_X_TLS_SSL_CTX: {
1102 LDAPConn *conn = ld->ld_defconn;
1103 if ( conn != NULL ) {
1104 Sockbuf *sb = conn->lconn_sb;
1105 retval = ldap_pvt_tls_sb_ctx( sb );
1108 *(void **)arg = retval;
1118 ldap_pvt_tls_set_option( LDAP *ld, int option, void *arg )
1120 struct ldapoptions *lo;
1123 assert( LDAP_VALID( ld ) );
1125 if( !LDAP_VALID( ld ) ) {
1126 return LDAP_OPT_ERROR;
1129 lo = &ld->ld_options;
1132 /* Get pointer to global option structure */
1133 lo = LDAP_INT_GLOBAL_OPT();
1135 return LDAP_NO_MEMORY;
1140 case LDAP_OPT_X_TLS:
1141 switch( *(int *) arg ) {
1142 case LDAP_OPT_X_TLS_NEVER:
1143 case LDAP_OPT_X_TLS_DEMAND:
1144 case LDAP_OPT_X_TLS_ALLOW:
1145 case LDAP_OPT_X_TLS_TRY:
1146 case LDAP_OPT_X_TLS_HARD:
1148 lo->ldo_tls_mode = *(int *)arg;
1155 case LDAP_OPT_X_TLS_CTX:
1157 tls_def_ctx = (SSL_CTX *) arg;
1160 ld->ld_defconn->lconn_tls_ctx = arg;
1170 case LDAP_OPT_X_TLS_CACERTFILE:
1171 if ( tls_opt_cacertfile ) LDAP_FREE( tls_opt_cacertfile );
1172 tls_opt_cacertfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1174 case LDAP_OPT_X_TLS_CACERTDIR:
1175 if ( tls_opt_cacertdir ) LDAP_FREE( tls_opt_cacertdir );
1176 tls_opt_cacertdir = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1178 case LDAP_OPT_X_TLS_CERTFILE:
1179 if ( tls_opt_certfile ) LDAP_FREE( tls_opt_certfile );
1180 tls_opt_certfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1182 case LDAP_OPT_X_TLS_KEYFILE:
1183 if ( tls_opt_keyfile ) LDAP_FREE( tls_opt_keyfile );
1184 tls_opt_keyfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1186 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1187 switch( *(int *) arg ) {
1188 case LDAP_OPT_X_TLS_NEVER:
1189 case LDAP_OPT_X_TLS_DEMAND:
1190 case LDAP_OPT_X_TLS_ALLOW:
1191 case LDAP_OPT_X_TLS_TRY:
1192 case LDAP_OPT_X_TLS_HARD:
1193 tls_opt_require_cert = * (int *) arg;
1197 case LDAP_OPT_X_TLS_CIPHER_SUITE:
1198 if ( tls_opt_ciphersuite ) LDAP_FREE( tls_opt_ciphersuite );
1199 tls_opt_ciphersuite = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1201 case LDAP_OPT_X_TLS_RANDOM_FILE:
1202 if (tls_opt_randfile ) LDAP_FREE (tls_opt_randfile );
1203 tls_opt_randfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1212 ldap_int_tls_start ( LDAP *ld, LDAPConn *conn, LDAPURLDesc *srv )
1214 Sockbuf *sb = conn->lconn_sb;
1219 host = srv->lud_host;
1221 host = conn->lconn_server->lud_host;
1224 /* avoid NULL host */
1225 if( host == NULL ) {
1229 (void) ldap_pvt_tls_init();
1232 * Fortunately, the lib uses blocking io...
1234 if ( ldap_int_tls_connect( ld, conn ) < 0 ) {
1235 ld->ld_errno = LDAP_CONNECT_ERROR;
1236 return (ld->ld_errno);
1239 ssl = ldap_pvt_tls_sb_ctx( sb );
1240 assert( ssl != NULL );
1243 * compare host with name(s) in certificate
1245 ld->ld_errno = ldap_pvt_tls_check_hostname( ssl, host );
1246 if (ld->ld_errno != LDAP_SUCCESS) {
1247 return ld->ld_errno;
1251 * set SASL properties to TLS ssf and authid
1257 /* we need to let SASL know */
1258 ssf = ldap_pvt_tls_get_strength( ssl );
1259 authid = ldap_pvt_tls_get_peer( ssl );
1261 (void) ldap_int_sasl_external( ld, conn, authid, ssf );
1264 return LDAP_SUCCESS;
1267 /* Derived from openssl/apps/s_cb.c */
1269 tls_info_cb( SSL *ssl, int where, int ret )
1274 w = where & ~SSL_ST_MASK;
1275 if ( w & SSL_ST_CONNECT ) {
1277 } else if ( w & SSL_ST_ACCEPT ) {
1283 if ( where & SSL_CB_LOOP ) {
1285 LDAP_LOG (( "tls", LDAP_LEVEL_DETAIL1, "tls_info_cb: "
1286 "TLS trace: %s:%s\n", op, SSL_state_string_long( ssl ) ));
1288 Debug( LDAP_DEBUG_TRACE,
1289 "TLS trace: %s:%s\n",
1290 op, SSL_state_string_long( ssl ), 0 );
1292 } else if ( where & SSL_CB_ALERT ) {
1293 op = ( where & SSL_CB_READ ) ? "read" : "write";
1295 LDAP_LOG (( "tls", LDAP_LEVEL_DETAIL1, "tls_info_cb: "
1296 "TLS trace: SSL3 alert %s:%s:%s\n", op,
1297 SSL_alert_type_string_long( ret ),
1298 SSL_alert_desc_string_long( ret) ));
1300 Debug( LDAP_DEBUG_TRACE,
1301 "TLS trace: SSL3 alert %s:%s:%s\n",
1303 SSL_alert_type_string_long( ret ),
1304 SSL_alert_desc_string_long( ret) );
1306 } else if ( where & SSL_CB_EXIT ) {
1309 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "tls_info_cb: "
1310 "TLS trace: %s:failed in %s\n", op, SSL_state_string_long( ssl ) ));
1312 Debug( LDAP_DEBUG_TRACE,
1313 "TLS trace: %s:failed in %s\n",
1314 op, SSL_state_string_long( ssl ), 0 );
1316 } else if ( ret < 0 ) {
1318 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "tls_info_cb: "
1319 "TLS trace: %s:error in %s\n", op, SSL_state_string_long( ssl ) ));
1321 Debug( LDAP_DEBUG_TRACE,
1322 "TLS trace: %s:error in %s\n",
1323 op, SSL_state_string_long( ssl ), 0 );
1330 tls_verify_cb( int ok, X509_STORE_CTX *ctx )
1340 cert = X509_STORE_CTX_get_current_cert( ctx );
1341 errnum = X509_STORE_CTX_get_error( ctx );
1342 errdepth = X509_STORE_CTX_get_error_depth( ctx );
1345 * X509_get_*_name return pointers to the internal copies of
1346 * those things requested. So do not free them.
1348 subject = X509_get_subject_name( cert );
1349 issuer = X509_get_issuer_name( cert );
1350 /* X509_NAME_oneline, if passed a NULL buf, allocate memomry */
1351 sname = X509_NAME_oneline( subject, NULL, 0 );
1352 iname = X509_NAME_oneline( issuer, NULL, 0 );
1354 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "tls_verify_cb"
1355 "TLS certificate verification: depth: %d, err: %d: "
1356 "subject: %s, issuer: %s\n", errdepth, errnum,
1357 sname ? sname : "-unknown-", iname ? iname : "-unknown-" ));
1359 Debug( LDAP_DEBUG_TRACE,
1360 "TLS certificate verification: depth: %d, err: %d, subject: %s,",
1362 sname ? sname : "-unknown-" );
1363 Debug( LDAP_DEBUG_TRACE, " issuer: %s\n", iname ? iname : "-unknown-", 0, 0 );
1366 CRYPTO_free ( sname );
1368 CRYPTO_free ( iname );
1374 tls_verify_ok( int ok, X509_STORE_CTX *ctx )
1376 (void) tls_verify_cb( ok, ctx );
1380 /* Inspired by ERR_print_errors in OpenSSL */
1382 tls_report_error( void )
1389 while ( ( l = ERR_get_error_line( &file, &line ) ) != 0 ) {
1391 LDAP_LOG (( "tls", LDAP_LEVEL_ERR,
1392 "tls_report_error: TLS %s %s:%d\n",
1393 ERR_error_string( l, buf ), file, line ));
1395 Debug( LDAP_DEBUG_ANY, "TLS: %s %s:%d\n",
1396 ERR_error_string( l, buf ), file, line );
1402 tls_tmp_rsa_cb( SSL *ssl, int is_export, int key_length )
1406 /* FIXME: Pregenerate the key on startup */
1407 /* FIXME: Who frees the key? */
1408 tmp_rsa = RSA_generate_key( key_length, RSA_F4, NULL, NULL );
1412 LDAP_LOG (( "tls", LDAP_LEVEL_ERR,
1413 "tls_tmp_rsa_cb: TLS Failed to generate temporary %d-bit %s RSA key\n",
1414 key_length, is_export ? "export" : "domestic" ));
1416 Debug( LDAP_DEBUG_ANY,
1417 "TLS: Failed to generate temporary %d-bit %s RSA key\n",
1418 key_length, is_export ? "export" : "domestic", 0 );
1426 tls_seed_PRNG( const char *randfile )
1428 #ifndef URANDOM_DEVICE
1429 /* no /dev/urandom (or equiv) */
1431 char buffer[MAXPATHLEN];
1433 if (randfile == NULL) {
1434 /* The seed file is $RANDFILE if defined, otherwise $HOME/.rnd.
1435 * If $HOME is not set or buffer too small to hold the pathname,
1436 * an error occurs. - From RAND_file_name() man page.
1437 * The fact is that when $HOME is NULL, .rnd is used.
1439 randfile = RAND_file_name( buffer, sizeof( buffer ) );
1441 } else if (RAND_egd(randfile) > 0) {
1446 if (randfile == NULL) {
1448 LDAP_LOG (( "tls", LDAP_LEVEL_DETAIL1,
1449 "tls_seed_PRNG: TLS Use configuration file or "
1450 "$RANDFILE to define seed PRNG\n" ));
1452 Debug( LDAP_DEBUG_ANY,
1453 "TLS: Use configuration file or $RANDFILE to define seed PRNG\n",
1459 total = RAND_load_file(randfile, -1);
1461 if (RAND_status() == 0) {
1463 LDAP_LOG (( "tls", LDAP_LEVEL_DETAIL1,
1464 "tls_seed_PRNG: TLS PRNG not been seeded with enough data\n" ));
1466 Debug( LDAP_DEBUG_ANY,
1467 "TLS: PRNG not been seeded with enough data\n",
1473 /* assume if there was enough bits to seed that it's okay
1474 * to write derived bits to the file
1476 RAND_write_file(randfile);
1485 tls_tmp_dh_cb( SSL *ssl, int is_export, int key_length )
1493 ldap_start_tls_s ( LDAP *ld,
1494 LDAPControl **serverctrls,
1495 LDAPControl **clientctrls )
1500 char *rspoid = NULL;
1501 struct berval *rspdata = NULL;
1503 /* XXYYZ: this initiates operation only on default connection! */
1505 if ( ld->ld_sb != NULL && ldap_pvt_tls_inplace( ld->ld_sb ) != 0 ) {
1506 return LDAP_LOCAL_ERROR;
1509 rc = ldap_extended_operation_s( ld, LDAP_EXOP_START_TLS,
1510 NULL, serverctrls, clientctrls, &rspoid, &rspdata );
1511 if ( rc != LDAP_SUCCESS ) {
1515 if ( rspoid != NULL ) {
1519 if ( rspdata != NULL ) {
1520 ber_bvfree( rspdata );
1523 rc = ldap_int_tls_start( ld, ld->ld_defconn, NULL );
1525 rc = LDAP_NOT_SUPPORTED;