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;
153 (void) tls_seed_PRNG( tls_opt_randfile );
155 #ifdef LDAP_R_COMPILE
159 SSL_load_error_strings();
160 SSLeay_add_ssl_algorithms();
162 /* FIXME: mod_ssl does this */
163 X509V3_add_standard_extensions();
168 * initialize the default context
171 ldap_pvt_tls_init_def_ctx( void )
173 STACK_OF(X509_NAME) *calist;
175 #ifdef LDAP_R_COMPILE
176 ldap_pvt_thread_mutex_lock( &tls_def_ctx_mutex );
178 if ( tls_def_ctx == NULL ) {
180 tls_def_ctx = SSL_CTX_new( SSLv23_method() );
181 if ( tls_def_ctx == NULL ) {
183 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
184 "TLS could not allocate default ctx (%d).\n",
185 ERR_peek_error(), 0, 0 );
187 Debug( LDAP_DEBUG_ANY,
188 "TLS: could not allocate default ctx (%lu).\n",
189 ERR_peek_error(),0,0);
194 if ( tls_opt_ciphersuite &&
195 !SSL_CTX_set_cipher_list( tls_def_ctx, tls_opt_ciphersuite ) )
198 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
199 "TLS could not set cipher list %s.\n",
200 tls_opt_ciphersuite, 0, 0 );
202 Debug( LDAP_DEBUG_ANY,
203 "TLS: could not set cipher list %s.\n",
204 tls_opt_ciphersuite, 0, 0 );
210 if (tls_opt_cacertfile != NULL || tls_opt_cacertdir != NULL) {
211 if ( !SSL_CTX_load_verify_locations( tls_def_ctx,
212 tls_opt_cacertfile, tls_opt_cacertdir ) ||
213 !SSL_CTX_set_default_verify_paths( tls_def_ctx ) )
216 LDAP_LOG ( TRANSPORT, ERR,
217 "ldap_pvt_tls_init_def_ctx: "
218 "TLS could not load verify locations "
219 "(file:`%s',dir:`%s').\n",
220 tls_opt_cacertfile ? tls_opt_cacertfile : "",
221 tls_opt_cacertdir ? tls_opt_cacertdir : "", 0 );
223 Debug( LDAP_DEBUG_ANY, "TLS: "
224 "could not load verify locations (file:`%s',dir:`%s').\n",
225 tls_opt_cacertfile ? tls_opt_cacertfile : "",
226 tls_opt_cacertdir ? tls_opt_cacertdir : "",
233 calist = get_ca_list( tls_opt_cacertfile, tls_opt_cacertdir );
236 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
237 "TLS 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 : "", 0 );
241 Debug( LDAP_DEBUG_ANY, "TLS: "
242 "could not load client CA list (file:`%s',dir:`%s').\n",
243 tls_opt_cacertfile ? tls_opt_cacertfile : "",
244 tls_opt_cacertdir ? tls_opt_cacertdir : "",
251 SSL_CTX_set_client_CA_list( tls_def_ctx, calist );
254 if ( tls_opt_keyfile &&
255 !SSL_CTX_use_PrivateKey_file( tls_def_ctx,
256 tls_opt_keyfile, SSL_FILETYPE_PEM ) )
259 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
260 "TLS could not use key file `%s'.\n", tls_opt_keyfile, 0, 0 );
262 Debug( LDAP_DEBUG_ANY,
263 "TLS: could not use key file `%s'.\n",
264 tls_opt_keyfile,0,0);
270 if ( tls_opt_certfile &&
271 !SSL_CTX_use_certificate_file( tls_def_ctx,
272 tls_opt_certfile, SSL_FILETYPE_PEM ) )
275 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
276 "TLS could not use certificate `%s'.\n",
277 tls_opt_certfile, 0, 0 );
279 Debug( LDAP_DEBUG_ANY,
280 "TLS: could not use certificate `%s'.\n",
281 tls_opt_certfile,0,0);
287 if ( ( tls_opt_certfile || tls_opt_keyfile ) &&
288 !SSL_CTX_check_private_key( tls_def_ctx ) )
291 LDAP_LOG ( TRANSPORT, ERR,
292 "ldap_pvt_tls_init_def_ctx: TLS private key mismatch.\n",
295 Debug( LDAP_DEBUG_ANY,
296 "TLS: private key mismatch.\n",
303 if ( tls_opt_trace ) {
304 SSL_CTX_set_info_callback( tls_def_ctx, tls_info_cb );
308 if ( tls_opt_require_cert ) {
310 if ( tls_opt_require_cert == LDAP_OPT_X_TLS_DEMAND ||
311 tls_opt_require_cert == LDAP_OPT_X_TLS_HARD ) {
312 i |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
316 SSL_CTX_set_verify( tls_def_ctx, i,
317 tls_opt_require_cert == LDAP_OPT_X_TLS_ALLOW ?
318 tls_verify_ok : tls_verify_cb );
319 SSL_CTX_set_tmp_rsa_callback( tls_def_ctx, tls_tmp_rsa_cb );
320 /* SSL_CTX_set_tmp_dh_callback( tls_def_ctx, tls_tmp_dh_cb ); */
322 #ifdef LDAP_R_COMPILE
323 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
328 if ( tls_def_ctx != NULL ) {
329 SSL_CTX_free( tls_def_ctx );
332 #ifdef LDAP_R_COMPILE
333 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
338 static STACK_OF(X509_NAME) *
339 get_ca_list( char * bundle, char * dir )
341 STACK_OF(X509_NAME) *ca_list = NULL;
344 ca_list = SSL_load_client_CA_file( bundle );
346 #if defined(HAVE_DIRENT_H) || defined(dirent)
350 char buf[MAXPATHLEN];
351 int l = strlen(dir), freeit = 0;
356 dirp = opendir( dir );
359 ca_list = sk_X509_NAME_new_null();
366 if ( ( d = readdir( dirp )) == NULL) {
370 if (l + sizeof(LDAP_DIRSEP) + NAMLEN(d) > sizeof(buf))
373 sprintf( buf+l, LDAP_DIRSEP "%s", d->d_name );
374 if ( SSL_add_file_cert_subjects_to_stack(ca_list, buf)) {
379 sk_X509_NAME_free( ca_list );
389 alloc_handle( void *ctx_arg )
395 ctx = (SSL_CTX *) ctx_arg;
397 if ( ldap_pvt_tls_init_def_ctx() < 0 ) return NULL;
401 ssl = SSL_new( ctx );
404 LDAP_LOG ( TRANSPORT, ERR,
405 "alloc_handle: TLS can't create ssl handle.\n", 0, 0, 0 );
407 Debug( LDAP_DEBUG_ANY,"TLS: can't create ssl handle.\n",0,0,0);
415 update_flags( Sockbuf *sb, SSL * ssl, int rc )
417 int err = SSL_get_error(ssl, rc);
419 sb->sb_trans_needs_read = 0;
420 sb->sb_trans_needs_write = 0;
422 if (err == SSL_ERROR_WANT_READ) {
423 sb->sb_trans_needs_read = 1;
426 } else if (err == SSL_ERROR_WANT_WRITE) {
427 sb->sb_trans_needs_write = 1;
430 } else if (err == SSL_ERROR_WANT_CONNECT) {
437 * TLS support for LBER Sockbufs
442 Sockbuf_IO_Desc *sbiod;
445 static BIO_METHOD sb_tls_bio_method;
448 sb_tls_setup( Sockbuf_IO_Desc *sbiod, void *arg )
453 assert( sbiod != NULL );
455 p = LBER_MALLOC( sizeof( *p ) );
462 bio = BIO_new( &sb_tls_bio_method );
463 bio->ptr = (void *)p;
464 SSL_set_bio( p->ssl, bio, bio );
465 sbiod->sbiod_pvt = p;
470 sb_tls_remove( Sockbuf_IO_Desc *sbiod )
474 assert( sbiod != NULL );
475 assert( sbiod->sbiod_pvt != NULL );
477 p = (struct tls_data *)sbiod->sbiod_pvt;
479 LBER_FREE( sbiod->sbiod_pvt );
480 sbiod->sbiod_pvt = NULL;
485 sb_tls_close( Sockbuf_IO_Desc *sbiod )
489 assert( sbiod != NULL );
490 assert( sbiod->sbiod_pvt != NULL );
492 p = (struct tls_data *)sbiod->sbiod_pvt;
493 SSL_shutdown( p->ssl );
498 sb_tls_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
502 assert( sbiod != NULL );
503 assert( sbiod->sbiod_pvt != NULL );
505 p = (struct tls_data *)sbiod->sbiod_pvt;
507 if ( opt == LBER_SB_OPT_GET_SSL ) {
508 *((SSL **)arg) = p->ssl;
511 } else if ( opt == LBER_SB_OPT_DATA_READY ) {
512 if( SSL_pending( p->ssl ) > 0 ) {
517 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
521 sb_tls_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
527 assert( sbiod != NULL );
528 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
530 p = (struct tls_data *)sbiod->sbiod_pvt;
532 ret = SSL_read( p->ssl, (char *)buf, len );
534 errno = WSAGetLastError();
536 err = SSL_get_error( p->ssl, ret );
537 if (err == SSL_ERROR_WANT_READ ) {
538 sbiod->sbiod_sb->sb_trans_needs_read = 1;
542 sbiod->sbiod_sb->sb_trans_needs_read = 0;
547 sb_tls_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
553 assert( sbiod != NULL );
554 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
556 p = (struct tls_data *)sbiod->sbiod_pvt;
558 ret = SSL_write( p->ssl, (char *)buf, len );
560 errno = WSAGetLastError();
562 err = SSL_get_error( p->ssl, ret );
563 if (err == SSL_ERROR_WANT_WRITE ) {
564 sbiod->sbiod_sb->sb_trans_needs_write = 1;
568 sbiod->sbiod_sb->sb_trans_needs_write = 0;
573 static Sockbuf_IO sb_tls_sbio =
575 sb_tls_setup, /* sbi_setup */
576 sb_tls_remove, /* sbi_remove */
577 sb_tls_ctrl, /* sbi_ctrl */
578 sb_tls_read, /* sbi_read */
579 sb_tls_write, /* sbi_write */
580 sb_tls_close /* sbi_close */
584 sb_tls_bio_create( BIO *b ) {
593 sb_tls_bio_destroy( BIO *b )
595 if ( b == NULL ) return 0;
597 b->ptr = NULL; /* sb_tls_remove() will free it */
604 sb_tls_bio_read( BIO *b, char *buf, int len )
609 if ( buf == NULL || len <= 0 ) return 0;
611 p = (struct tls_data *)b->ptr;
613 if ( p == NULL || p->sbiod == NULL ) {
617 ret = LBER_SBIOD_READ_NEXT( p->sbiod, buf, len );
619 BIO_clear_retry_flags( b );
620 if ( ret < 0 && errno == EWOULDBLOCK ) {
621 BIO_set_retry_read( b );
628 sb_tls_bio_write( BIO *b, const char *buf, int len )
633 if ( buf == NULL || len <= 0 ) return 0;
635 p = (struct tls_data *)b->ptr;
637 if ( p == NULL || p->sbiod == NULL ) {
641 ret = LBER_SBIOD_WRITE_NEXT( p->sbiod, (char *)buf, len );
643 BIO_clear_retry_flags( b );
644 if ( ret < 0 && errno == EWOULDBLOCK ) {
645 BIO_set_retry_write( b );
652 sb_tls_bio_ctrl( BIO *b, int cmd, long num, void *ptr )
654 if ( cmd == BIO_CTRL_FLUSH ) {
655 /* The OpenSSL library needs this */
662 sb_tls_bio_gets( BIO *b, char *buf, int len )
668 sb_tls_bio_puts( BIO *b, const char *str )
670 return sb_tls_bio_write( b, str, strlen( str ) );
673 static BIO_METHOD sb_tls_bio_method =
675 ( 100 | 0x400 ), /* it's a source/sink BIO */
687 * Call this to do a TLS connect on a sockbuf. ctx_arg can be
688 * a SSL_CTX * or NULL, in which case the default ctx is used.
692 * 0 - Success. Connection is ready for communication.
693 * <0 - Error. Can't create a TLS stream.
694 * >0 - Partial success.
695 * Do a select (using information from lber_pvt_sb_needs_{read,write}
700 ldap_int_tls_connect( LDAP *ld, LDAPConn *conn )
702 Sockbuf *sb = conn->lconn_sb;
706 if ( HAS_TLS( sb ) ) {
707 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
710 void *ctx = ld->ld_defconn
711 ? ld->ld_defconn->lconn_tls_ctx : NULL;
713 ssl = alloc_handle( ctx );
715 if ( ssl == NULL ) return -1;
718 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
719 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
721 ber_sockbuf_add_io( sb, &sb_tls_sbio,
722 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
725 conn->lconn_tls_ctx = tls_def_ctx;
729 err = SSL_connect( ssl );
732 errno = WSAGetLastError();
736 if ( update_flags( sb, ssl, err )) {
740 if ((err = ERR_peek_error())) {
742 ld->ld_error = LDAP_STRDUP(ERR_error_string(err, buf));
746 LDAP_LOG ( TRANSPORT, ERR,
747 "ldap_int_tls_connect: TLS can't connect.\n", 0, 0, 0 );
749 Debug( LDAP_DEBUG_ANY,"TLS: can't connect.\n",0,0,0);
752 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
753 LBER_SBIOD_LEVEL_TRANSPORT );
755 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
756 LBER_SBIOD_LEVEL_TRANSPORT );
765 * Call this to do a TLS accept on a sockbuf.
766 * Everything else is the same as with tls_connect.
769 ldap_pvt_tls_accept( Sockbuf *sb, void *ctx_arg )
774 if ( HAS_TLS( sb ) ) {
775 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
778 ssl = alloc_handle( ctx_arg );
779 if ( ssl == NULL ) return -1;
782 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
783 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
785 ber_sockbuf_add_io( sb, &sb_tls_sbio,
786 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
789 err = SSL_accept( ssl );
792 errno = WSAGetLastError();
795 if ( update_flags( sb, ssl, err )) return 1;
798 LDAP_LOG ( TRANSPORT, ERR,
799 "ldap_pvt_tls_accept: TLS can't accept.\n", 0, 0, 0 );
801 Debug( LDAP_DEBUG_ANY,"TLS: can't accept.\n",0,0,0 );
805 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
806 LBER_SBIOD_LEVEL_TRANSPORT );
808 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
809 LBER_SBIOD_LEVEL_TRANSPORT );
818 ldap_pvt_tls_inplace ( Sockbuf *sb )
820 return HAS_TLS( sb ) ? 1 : 0;
824 ldap_pvt_tls_sb_ctx( Sockbuf *sb )
829 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&p );
837 ldap_pvt_tls_get_strength( void *s )
841 c = SSL_get_current_cipher((SSL *)s);
842 return SSL_CIPHER_get_bits(c, NULL);
847 ldap_pvt_tls_get_my_dn( void *s, struct berval *dn, LDAPDN_rewrite_dummy *func, unsigned flags )
853 x = SSL_get_certificate((SSL *)s);
855 if (!x) return LDAP_INVALID_CREDENTIALS;
857 xn = X509_get_subject_name(x);
858 rc = ldap_X509dn2bv(xn, dn, (LDAPDN_rewrite_func *)func, flags );
864 tls_get_cert( SSL *s )
866 /* If peer cert was bad, treat as if no cert was given */
867 if (SSL_get_verify_result(s)) {
868 /* If we can send an alert, do so */
869 if (SSL_version(s) != SSL2_VERSION) {
870 ssl3_send_alert(s,SSL3_AL_WARNING,SSL3_AD_BAD_CERTIFICATE);
874 return SSL_get_peer_certificate(s);
878 ldap_pvt_tls_get_peer_dn( void *s, struct berval *dn, LDAPDN_rewrite_dummy *func, unsigned flags )
884 x = tls_get_cert((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);
895 ldap_pvt_tls_get_peer_hostname( void *s )
902 x = tls_get_cert((SSL *)s);
905 xn = X509_get_subject_name(x);
907 ret = X509_NAME_get_text_by_NID(xn, NID_commonName, buf, sizeof(buf));
913 p = LDAP_STRDUP(buf);
919 ldap_pvt_tls_check_hostname( LDAP *ld, void *s, const char *name_in )
921 int i, ret = LDAP_LOCAL_ERROR;
925 if( ldap_int_hostname &&
926 ( !name_in || !strcasecmp( name_in, "localhost" ) ) )
928 name = ldap_int_hostname;
933 x = tls_get_cert((SSL *)s);
936 LDAP_LOG ( TRANSPORT, ERR,
937 "ldap_pvt_tls_check_hostname: "
938 "TLS unable to get peer certificate.\n" , 0, 0, 0 );
940 Debug( LDAP_DEBUG_ANY,
941 "TLS: unable to get peer certificate.\n",
944 /* If this was a fatal condition, things would have
945 * aborted long before now.
950 i = X509_get_ext_by_NID(x, NID_subject_alt_name, -1);
953 STACK_OF(GENERAL_NAME) *alt;
955 ex = X509_get_ext(x, i);
956 alt = X509V3_EXT_d2i(ex);
958 int n, len1, len2 = 0;
963 n = sk_GENERAL_NAME_num(alt);
964 domain = strchr(name, '.');
966 len2 = len1 - (domain-name);
968 for (i=0; i<n; i++) {
969 gn = sk_GENERAL_NAME_value(alt, i);
970 if (gn->type == GEN_DNS) {
971 char *sn = ASN1_STRING_data(gn->d.ia5);
972 int sl = ASN1_STRING_length(gn->d.ia5);
974 /* Is this an exact match? */
975 if ((len1 == sl) && !strncasecmp(name, sn, len1)) {
979 /* Is this a wildcard match? */
980 if ((*sn == '*') && domain && (len2 == sl-1) &&
981 !strncasecmp(domain, sn+1, len2))
987 /* Is this a RFC 2549 style wildcard match? */
988 if ((*sn == '.') && domain && (len2 == sl) &&
989 !strncasecmp(domain, sn, len2))
997 GENERAL_NAMES_free(alt);
998 if (i < n) { /* Found a match */
1004 if (ret != LDAP_SUCCESS) {
1008 xn = X509_get_subject_name(x);
1010 if( X509_NAME_get_text_by_NID( xn, NID_commonName,
1011 buf, sizeof(buf)) == -1)
1014 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_check_hostname: "
1015 "TLS unable to get common name from peer certificate.\n",
1018 Debug( LDAP_DEBUG_ANY,
1019 "TLS: unable to get common name from peer certificate.\n",
1022 ld->ld_error = LDAP_STRDUP("TLS: unable to get CN from peer certificate");
1024 } else if (strcasecmp(name, buf)) {
1026 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_check_hostname: "
1027 "TLS hostname (%s) does not match "
1028 "common name in certificate (%s).\n", name, buf, 0 );
1030 Debug( LDAP_DEBUG_ANY, "TLS: hostname (%s) does not match "
1031 "common name in certificate (%s).\n",
1034 ret = LDAP_CONNECT_ERROR;
1035 ld->ld_error = LDAP_STRDUP("TLS: hostname does not match CN in peer certificate");
1046 ldap_pvt_tls_get_peer_issuer( void *s )
1048 #if 0 /* currently unused; see ldap_pvt_tls_get_peer_dn() if needed */
1053 x = SSL_get_peer_certificate((SSL *)s);
1055 if (!x) return NULL;
1057 xn = X509_get_issuer_name(x);
1058 p = LDAP_STRDUP(X509_NAME_oneline(xn, buf, sizeof(buf)));
1067 ldap_int_tls_config( LDAP *ld, int option, const char *arg )
1072 case LDAP_OPT_X_TLS_CACERTFILE:
1073 case LDAP_OPT_X_TLS_CACERTDIR:
1074 case LDAP_OPT_X_TLS_CERTFILE:
1075 case LDAP_OPT_X_TLS_KEYFILE:
1076 case LDAP_OPT_X_TLS_RANDOM_FILE:
1077 return ldap_pvt_tls_set_option( ld, option, (void *) arg );
1079 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1080 case LDAP_OPT_X_TLS:
1082 if ( strcasecmp( arg, "never" ) == 0 ) {
1083 i = LDAP_OPT_X_TLS_NEVER ;
1085 } else if ( strcasecmp( arg, "demand" ) == 0 ) {
1086 i = LDAP_OPT_X_TLS_DEMAND ;
1088 } else if ( strcasecmp( arg, "allow" ) == 0 ) {
1089 i = LDAP_OPT_X_TLS_ALLOW ;
1091 } else if ( strcasecmp( arg, "try" ) == 0 ) {
1092 i = LDAP_OPT_X_TLS_TRY ;
1094 } else if ( ( strcasecmp( arg, "hard" ) == 0 ) ||
1095 ( strcasecmp( arg, "on" ) == 0 ) ||
1096 ( strcasecmp( arg, "yes" ) == 0) ||
1097 ( strcasecmp( arg, "true" ) == 0 ) )
1099 i = LDAP_OPT_X_TLS_HARD ;
1103 return ldap_pvt_tls_set_option( ld, option, &i );
1112 ldap_pvt_tls_get_option( LDAP *ld, int option, void *arg )
1114 struct ldapoptions *lo;
1117 assert( LDAP_VALID( ld ) );
1119 if( !LDAP_VALID( ld ) ) {
1120 return LDAP_OPT_ERROR;
1123 lo = &ld->ld_options;
1126 /* Get pointer to global option structure */
1127 lo = LDAP_INT_GLOBAL_OPT();
1129 return LDAP_NO_MEMORY;
1134 case LDAP_OPT_X_TLS:
1135 *(int *)arg = lo->ldo_tls_mode;
1137 case LDAP_OPT_X_TLS_CTX:
1139 *(void **)arg = (void *) tls_def_ctx;
1141 *(void **)arg = ld->ld_defconn->lconn_tls_ctx;
1144 case LDAP_OPT_X_TLS_CACERTFILE:
1145 *(char **)arg = tls_opt_cacertfile ?
1146 LDAP_STRDUP( tls_opt_cacertfile ) : NULL;
1148 case LDAP_OPT_X_TLS_CACERTDIR:
1149 *(char **)arg = tls_opt_cacertdir ?
1150 LDAP_STRDUP( tls_opt_cacertdir ) : NULL;
1152 case LDAP_OPT_X_TLS_CERTFILE:
1153 *(char **)arg = tls_opt_certfile ?
1154 LDAP_STRDUP( tls_opt_certfile ) : NULL;
1156 case LDAP_OPT_X_TLS_KEYFILE:
1157 *(char **)arg = tls_opt_keyfile ?
1158 LDAP_STRDUP( tls_opt_keyfile ) : NULL;
1160 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1161 *(int *)arg = tls_opt_require_cert;
1163 case LDAP_OPT_X_TLS_RANDOM_FILE:
1164 *(char **)arg = tls_opt_randfile ?
1165 LDAP_STRDUP( tls_opt_randfile ) : NULL;
1167 case LDAP_OPT_X_TLS_SSL_CTX: {
1170 LDAPConn *conn = ld->ld_defconn;
1171 if ( conn != NULL ) {
1172 Sockbuf *sb = conn->lconn_sb;
1173 retval = ldap_pvt_tls_sb_ctx( sb );
1176 *(void **)arg = retval;
1186 ldap_pvt_tls_set_option( LDAP *ld, int option, void *arg )
1188 struct ldapoptions *lo;
1191 assert( LDAP_VALID( ld ) );
1193 if( !LDAP_VALID( ld ) ) {
1194 return LDAP_OPT_ERROR;
1197 lo = &ld->ld_options;
1200 /* Get pointer to global option structure */
1201 lo = LDAP_INT_GLOBAL_OPT();
1203 return LDAP_NO_MEMORY;
1208 case LDAP_OPT_X_TLS:
1209 switch( *(int *) arg ) {
1210 case LDAP_OPT_X_TLS_NEVER:
1211 case LDAP_OPT_X_TLS_DEMAND:
1212 case LDAP_OPT_X_TLS_ALLOW:
1213 case LDAP_OPT_X_TLS_TRY:
1214 case LDAP_OPT_X_TLS_HARD:
1216 lo->ldo_tls_mode = *(int *)arg;
1223 case LDAP_OPT_X_TLS_CTX:
1225 tls_def_ctx = (SSL_CTX *) arg;
1228 ld->ld_defconn->lconn_tls_ctx = arg;
1238 case LDAP_OPT_X_TLS_CACERTFILE:
1239 if ( tls_opt_cacertfile ) LDAP_FREE( tls_opt_cacertfile );
1240 tls_opt_cacertfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1242 case LDAP_OPT_X_TLS_CACERTDIR:
1243 if ( tls_opt_cacertdir ) LDAP_FREE( tls_opt_cacertdir );
1244 tls_opt_cacertdir = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1246 case LDAP_OPT_X_TLS_CERTFILE:
1247 if ( tls_opt_certfile ) LDAP_FREE( tls_opt_certfile );
1248 tls_opt_certfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1250 case LDAP_OPT_X_TLS_KEYFILE:
1251 if ( tls_opt_keyfile ) LDAP_FREE( tls_opt_keyfile );
1252 tls_opt_keyfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1254 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1255 switch( *(int *) arg ) {
1256 case LDAP_OPT_X_TLS_NEVER:
1257 case LDAP_OPT_X_TLS_DEMAND:
1258 case LDAP_OPT_X_TLS_ALLOW:
1259 case LDAP_OPT_X_TLS_TRY:
1260 case LDAP_OPT_X_TLS_HARD:
1261 tls_opt_require_cert = * (int *) arg;
1265 case LDAP_OPT_X_TLS_CIPHER_SUITE:
1266 if ( tls_opt_ciphersuite ) LDAP_FREE( tls_opt_ciphersuite );
1267 tls_opt_ciphersuite = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1269 case LDAP_OPT_X_TLS_RANDOM_FILE:
1270 if (tls_opt_randfile ) LDAP_FREE (tls_opt_randfile );
1271 tls_opt_randfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1280 ldap_int_tls_start ( LDAP *ld, LDAPConn *conn, LDAPURLDesc *srv )
1282 Sockbuf *sb = conn->lconn_sb;
1287 host = srv->lud_host;
1289 host = conn->lconn_server->lud_host;
1292 /* avoid NULL host */
1293 if( host == NULL ) {
1297 (void) ldap_pvt_tls_init();
1300 * Fortunately, the lib uses blocking io...
1302 if ( ldap_int_tls_connect( ld, conn ) < 0 ) {
1303 ld->ld_errno = LDAP_CONNECT_ERROR;
1304 return (ld->ld_errno);
1307 ssl = ldap_pvt_tls_sb_ctx( sb );
1308 assert( ssl != NULL );
1311 * compare host with name(s) in certificate
1313 ld->ld_errno = ldap_pvt_tls_check_hostname( ld, ssl, host );
1314 if (ld->ld_errno != LDAP_SUCCESS) {
1315 return ld->ld_errno;
1319 * set SASL properties to TLS ssf and authid
1322 struct berval authid = { 0, NULL };
1325 /* we need to let SASL know */
1326 ssf = ldap_pvt_tls_get_strength( ssl );
1327 /* failure is OK, we just can't use SASL EXTERNAL */
1328 (void) ldap_pvt_tls_get_my_dn( ssl, &authid, NULL, 0 );
1330 (void) ldap_int_sasl_external( ld, conn, authid.bv_val, ssf );
1331 LDAP_FREE( authid.bv_val );
1334 return LDAP_SUCCESS;
1337 /* Derived from openssl/apps/s_cb.c */
1339 tls_info_cb( SSL *ssl, int where, int ret )
1344 w = where & ~SSL_ST_MASK;
1345 if ( w & SSL_ST_CONNECT ) {
1347 } else if ( w & SSL_ST_ACCEPT ) {
1353 if ( where & SSL_CB_LOOP ) {
1355 LDAP_LOG ( TRANSPORT, DETAIL1, "tls_info_cb: "
1356 "TLS trace: %s:%s\n", op, SSL_state_string_long( ssl ), 0 );
1358 Debug( LDAP_DEBUG_TRACE,
1359 "TLS trace: %s:%s\n",
1360 op, SSL_state_string_long( ssl ), 0 );
1363 } else if ( where & SSL_CB_ALERT ) {
1364 op = ( where & SSL_CB_READ ) ? "read" : "write";
1366 LDAP_LOG ( TRANSPORT, DETAIL1,
1367 "tls_info_cb: TLS trace: SSL3 alert %s:%s:%s\n",
1368 op, SSL_alert_type_string_long( ret ),
1369 SSL_alert_desc_string_long( ret) );
1371 Debug( LDAP_DEBUG_TRACE,
1372 "TLS trace: SSL3 alert %s:%s:%s\n",
1374 SSL_alert_type_string_long( ret ),
1375 SSL_alert_desc_string_long( ret) );
1378 } else if ( where & SSL_CB_EXIT ) {
1381 LDAP_LOG ( TRANSPORT, ERR,
1382 "tls_info_cb: TLS trace: %s:failed in %s\n",
1383 op, SSL_state_string_long( ssl ), 0 );
1385 Debug( LDAP_DEBUG_TRACE,
1386 "TLS trace: %s:failed in %s\n",
1387 op, SSL_state_string_long( ssl ), 0 );
1389 } else if ( ret < 0 ) {
1391 LDAP_LOG ( TRANSPORT, ERR,
1392 "tls_info_cb: TLS trace: %s:error in %s\n",
1393 op, SSL_state_string_long( ssl ), 0 );
1395 Debug( LDAP_DEBUG_TRACE,
1396 "TLS trace: %s:error in %s\n",
1397 op, SSL_state_string_long( ssl ), 0 );
1404 tls_verify_cb( int ok, X509_STORE_CTX *ctx )
1414 cert = X509_STORE_CTX_get_current_cert( ctx );
1415 errnum = X509_STORE_CTX_get_error( ctx );
1416 errdepth = X509_STORE_CTX_get_error_depth( ctx );
1419 * X509_get_*_name return pointers to the internal copies of
1420 * those things requested. So do not free them.
1422 subject = X509_get_subject_name( cert );
1423 issuer = X509_get_issuer_name( cert );
1424 /* X509_NAME_oneline, if passed a NULL buf, allocate memomry */
1425 sname = X509_NAME_oneline( subject, NULL, 0 );
1426 iname = X509_NAME_oneline( issuer, NULL, 0 );
1428 LDAP_LOG( TRANSPORT, ERR,
1429 "TLS certificate verification: depth: %d, err: %d, subject: %s,",
1431 sname ? sname : "-unknown-" );
1432 LDAP_LOG( TRANSPORT, ERR, " issuer: %s\n", iname ? iname : "-unknown-", 0, 0 );
1434 LDAP_LOG ( TRANSPORT, ERR,
1435 "TLS certificate verification: Error, %s\n",
1436 X509_verify_cert_error_string(errnum), 0, 0 );
1439 Debug( LDAP_DEBUG_TRACE,
1440 "TLS certificate verification: depth: %d, err: %d, subject: %s,",
1442 sname ? sname : "-unknown-" );
1443 Debug( LDAP_DEBUG_TRACE, " issuer: %s\n", iname ? iname : "-unknown-", 0, 0 );
1445 Debug( LDAP_DEBUG_ANY,
1446 "TLS certificate verification: Error, %s\n",
1447 X509_verify_cert_error_string(errnum), 0, 0 );
1451 CRYPTO_free ( sname );
1453 CRYPTO_free ( iname );
1459 tls_verify_ok( int ok, X509_STORE_CTX *ctx )
1461 (void) tls_verify_cb( ok, ctx );
1465 /* Inspired by ERR_print_errors in OpenSSL */
1467 tls_report_error( void )
1474 while ( ( l = ERR_get_error_line( &file, &line ) ) != 0 ) {
1476 LDAP_LOG ( TRANSPORT, ERR,
1477 "tls_report_error: TLS %s %s:%d\n",
1478 ERR_error_string( l, buf ), file, line );
1480 Debug( LDAP_DEBUG_ANY, "TLS: %s %s:%d\n",
1481 ERR_error_string( l, buf ), file, line );
1487 tls_tmp_rsa_cb( SSL *ssl, int is_export, int key_length )
1491 /* FIXME: Pregenerate the key on startup */
1492 /* FIXME: Who frees the key? */
1493 tmp_rsa = RSA_generate_key( key_length, RSA_F4, NULL, NULL );
1497 LDAP_LOG ( TRANSPORT, ERR,
1498 "tls_tmp_rsa_cb: TLS Failed to generate temporary %d-bit %s "
1499 "RSA key\n", key_length, is_export ? "export" : "domestic", 0 );
1501 Debug( LDAP_DEBUG_ANY,
1502 "TLS: Failed to generate temporary %d-bit %s RSA key\n",
1503 key_length, is_export ? "export" : "domestic", 0 );
1511 tls_seed_PRNG( const char *randfile )
1513 #ifndef URANDOM_DEVICE
1514 /* no /dev/urandom (or equiv) */
1516 char buffer[MAXPATHLEN];
1518 if (randfile == NULL) {
1519 /* The seed file is $RANDFILE if defined, otherwise $HOME/.rnd.
1520 * If $HOME is not set or buffer too small to hold the pathname,
1521 * an error occurs. - From RAND_file_name() man page.
1522 * The fact is that when $HOME is NULL, .rnd is used.
1524 randfile = RAND_file_name( buffer, sizeof( buffer ) );
1526 } else if (RAND_egd(randfile) > 0) {
1531 if (randfile == NULL) {
1533 LDAP_LOG ( TRANSPORT, DETAIL1,
1534 "tls_seed_PRNG: TLS Use configuration file or "
1535 "$RANDFILE to define seed PRNG\n", 0, 0, 0 );
1537 Debug( LDAP_DEBUG_ANY,
1538 "TLS: Use configuration file or $RANDFILE to define seed PRNG\n",
1544 total = RAND_load_file(randfile, -1);
1546 if (RAND_status() == 0) {
1548 LDAP_LOG ( TRANSPORT, DETAIL1,
1549 "tls_seed_PRNG: TLS PRNG not been seeded with enough data\n",
1552 Debug( LDAP_DEBUG_ANY,
1553 "TLS: PRNG not been seeded with enough data\n",
1559 /* assume if there was enough bits to seed that it's okay
1560 * to write derived bits to the file
1562 RAND_write_file(randfile);
1571 tls_tmp_dh_cb( SSL *ssl, int is_export, int key_length )
1579 ldap_start_tls_s ( LDAP *ld,
1580 LDAPControl **serverctrls,
1581 LDAPControl **clientctrls )
1586 char *rspoid = NULL;
1587 struct berval *rspdata = NULL;
1589 /* XXYYZ: this initiates operation only on default connection! */
1591 if ( ld->ld_sb != NULL && ldap_pvt_tls_inplace( ld->ld_sb ) != 0 ) {
1592 return LDAP_LOCAL_ERROR;
1595 rc = ldap_extended_operation_s( ld, LDAP_EXOP_START_TLS,
1596 NULL, serverctrls, clientctrls, &rspoid, &rspdata );
1597 if ( rc != LDAP_SUCCESS ) {
1601 if ( rspoid != NULL ) {
1605 if ( rspdata != NULL ) {
1606 ber_bvfree( rspdata );
1609 rc = ldap_int_tls_start( ld, ld->ld_defconn, NULL );
1611 rc = LDAP_NOT_SUPPORTED;