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 (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_init_def_ctx: "
184 "TLS could not allocate default ctx (%d).\n",
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 (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_init_def_ctx: "
199 "TLS could not set cipher list %s.\n",
200 tls_opt_ciphersuite ));
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 (( "tls", LDAP_LEVEL_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 : "" ));
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 (( "tls", LDAP_LEVEL_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 : "" ));
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 (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_init_def_ctx: "
260 "TLS could not use key file `%s'.\n", tls_opt_keyfile ));
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 (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_init_def_ctx: "
276 "TLS could not use certificate `%s'.\n", tls_opt_certfile ));
278 Debug( LDAP_DEBUG_ANY,
279 "TLS: could not use certificate `%s'.\n",
280 tls_opt_certfile,0,0);
286 if ( ( tls_opt_certfile || tls_opt_keyfile ) &&
287 !SSL_CTX_check_private_key( tls_def_ctx ) )
290 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_init_def_ctx: "
291 "TLS private key mismatch.\n" ));
293 Debug( LDAP_DEBUG_ANY,
294 "TLS: private key mismatch.\n",
301 if ( tls_opt_trace ) {
302 SSL_CTX_set_info_callback( tls_def_ctx, tls_info_cb );
306 if ( tls_opt_require_cert ) {
308 if ( tls_opt_require_cert == LDAP_OPT_X_TLS_DEMAND ||
309 tls_opt_require_cert == LDAP_OPT_X_TLS_HARD ) {
310 i |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
314 SSL_CTX_set_verify( tls_def_ctx, i,
315 tls_opt_require_cert == LDAP_OPT_X_TLS_ALLOW ?
316 tls_verify_ok : tls_verify_cb );
317 SSL_CTX_set_tmp_rsa_callback( tls_def_ctx, tls_tmp_rsa_cb );
318 /* SSL_CTX_set_tmp_dh_callback( tls_def_ctx, tls_tmp_dh_cb ); */
320 #ifdef LDAP_R_COMPILE
321 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
326 if ( tls_def_ctx != NULL ) {
327 SSL_CTX_free( tls_def_ctx );
330 #ifdef LDAP_R_COMPILE
331 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
336 static STACK_OF(X509_NAME) *
337 get_ca_list( char * bundle, char * dir )
339 STACK_OF(X509_NAME) *ca_list = NULL;
342 ca_list = SSL_load_client_CA_file( bundle );
347 char buf[MAXPATHLEN];
348 int l = strlen(dir), freeit = 0;
353 dirp = opendir( dir );
356 ca_list = sk_X509_NAME_new_null();
363 if ( ( d = readdir( dirp )) == NULL) {
367 if (l + sizeof(LDAP_DIRSEP) + NAMLEN(d) > sizeof(buf))
370 sprintf( buf+l, LDAP_DIRSEP "%s", d->d_name );
371 if ( SSL_add_file_cert_subjects_to_stack(ca_list, buf)) {
376 sk_X509_NAME_free( ca_list );
385 alloc_handle( void *ctx_arg )
391 ctx = (SSL_CTX *) ctx_arg;
393 if ( ldap_pvt_tls_init_def_ctx() < 0 ) return NULL;
397 ssl = SSL_new( ctx );
400 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "alloc_handle: "
401 "TLS can't create ssl handle.\n" ));
403 Debug( LDAP_DEBUG_ANY,"TLS: can't create ssl handle.\n",0,0,0);
411 update_flags( Sockbuf *sb, SSL * ssl, int rc )
413 int err = SSL_get_error(ssl, rc);
415 sb->sb_trans_needs_read = 0;
416 sb->sb_trans_needs_write = 0;
418 if (err == SSL_ERROR_WANT_READ) {
419 sb->sb_trans_needs_read = 1;
422 } else if (err == SSL_ERROR_WANT_WRITE) {
423 sb->sb_trans_needs_write = 1;
426 } else if (err == SSL_ERROR_WANT_CONNECT) {
433 * TLS support for LBER Sockbufs
438 Sockbuf_IO_Desc *sbiod;
441 static BIO_METHOD sb_tls_bio_method;
444 sb_tls_setup( Sockbuf_IO_Desc *sbiod, void *arg )
449 assert( sbiod != NULL );
451 p = LBER_MALLOC( sizeof( *p ) );
458 bio = BIO_new( &sb_tls_bio_method );
459 bio->ptr = (void *)p;
460 SSL_set_bio( p->ssl, bio, bio );
461 sbiod->sbiod_pvt = p;
466 sb_tls_remove( Sockbuf_IO_Desc *sbiod )
470 assert( sbiod != NULL );
471 assert( sbiod->sbiod_pvt != NULL );
473 p = (struct tls_data *)sbiod->sbiod_pvt;
475 LBER_FREE( sbiod->sbiod_pvt );
476 sbiod->sbiod_pvt = NULL;
481 sb_tls_close( Sockbuf_IO_Desc *sbiod )
485 assert( sbiod != NULL );
486 assert( sbiod->sbiod_pvt != NULL );
488 p = (struct tls_data *)sbiod->sbiod_pvt;
489 SSL_shutdown( p->ssl );
494 sb_tls_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
498 assert( sbiod != NULL );
499 assert( sbiod->sbiod_pvt != NULL );
501 p = (struct tls_data *)sbiod->sbiod_pvt;
503 if ( opt == LBER_SB_OPT_GET_SSL ) {
504 *((SSL **)arg) = p->ssl;
507 } else if ( opt == LBER_SB_OPT_DATA_READY ) {
508 if( SSL_pending( p->ssl ) > 0 ) {
513 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
517 sb_tls_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
523 assert( sbiod != NULL );
524 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
526 p = (struct tls_data *)sbiod->sbiod_pvt;
528 ret = SSL_read( p->ssl, (char *)buf, len );
530 errno = WSAGetLastError();
532 err = SSL_get_error( p->ssl, ret );
533 if (err == SSL_ERROR_WANT_READ ) {
534 sbiod->sbiod_sb->sb_trans_needs_read = 1;
538 sbiod->sbiod_sb->sb_trans_needs_read = 0;
543 sb_tls_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
549 assert( sbiod != NULL );
550 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
552 p = (struct tls_data *)sbiod->sbiod_pvt;
554 ret = SSL_write( p->ssl, (char *)buf, len );
556 errno = WSAGetLastError();
558 err = SSL_get_error( p->ssl, ret );
559 if (err == SSL_ERROR_WANT_WRITE ) {
560 sbiod->sbiod_sb->sb_trans_needs_write = 1;
564 sbiod->sbiod_sb->sb_trans_needs_write = 0;
569 static Sockbuf_IO sb_tls_sbio =
571 sb_tls_setup, /* sbi_setup */
572 sb_tls_remove, /* sbi_remove */
573 sb_tls_ctrl, /* sbi_ctrl */
574 sb_tls_read, /* sbi_read */
575 sb_tls_write, /* sbi_write */
576 sb_tls_close /* sbi_close */
580 sb_tls_bio_create( BIO *b ) {
589 sb_tls_bio_destroy( BIO *b )
591 if ( b == NULL ) return 0;
593 b->ptr = NULL; /* sb_tls_remove() will free it */
600 sb_tls_bio_read( BIO *b, char *buf, int len )
605 if ( buf == NULL || len <= 0 ) return 0;
607 p = (struct tls_data *)b->ptr;
609 if ( p == NULL || p->sbiod == NULL ) {
613 ret = LBER_SBIOD_READ_NEXT( p->sbiod, buf, len );
615 BIO_clear_retry_flags( b );
616 if ( ret < 0 && errno == EWOULDBLOCK ) {
617 BIO_set_retry_read( b );
624 sb_tls_bio_write( BIO *b, const char *buf, int len )
629 if ( buf == NULL || len <= 0 ) return 0;
631 p = (struct tls_data *)b->ptr;
633 if ( p == NULL || p->sbiod == NULL ) {
637 ret = LBER_SBIOD_WRITE_NEXT( p->sbiod, (char *)buf, len );
639 BIO_clear_retry_flags( b );
640 if ( ret < 0 && errno == EWOULDBLOCK ) {
641 BIO_set_retry_write( b );
648 sb_tls_bio_ctrl( BIO *b, int cmd, long num, void *ptr )
650 if ( cmd == BIO_CTRL_FLUSH ) {
651 /* The OpenSSL library needs this */
658 sb_tls_bio_gets( BIO *b, char *buf, int len )
664 sb_tls_bio_puts( BIO *b, const char *str )
666 return sb_tls_bio_write( b, str, strlen( str ) );
669 static BIO_METHOD sb_tls_bio_method =
671 ( 100 | 0x400 ), /* it's a source/sink BIO */
683 * Call this to do a TLS connect on a sockbuf. ctx_arg can be
684 * a SSL_CTX * or NULL, in which case the default ctx is used.
688 * 0 - Success. Connection is ready for communication.
689 * <0 - Error. Can't create a TLS stream.
690 * >0 - Partial success.
691 * Do a select (using information from lber_pvt_sb_needs_{read,write}
696 ldap_int_tls_connect( LDAP *ld, LDAPConn *conn )
698 Sockbuf *sb = conn->lconn_sb;
702 if ( HAS_TLS( sb ) ) {
703 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
706 void *ctx = ld->ld_defconn
707 ? ld->ld_defconn->lconn_tls_ctx : NULL;
709 ssl = alloc_handle( ctx );
711 if ( ssl == NULL ) return -1;
714 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
715 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
717 ber_sockbuf_add_io( sb, &sb_tls_sbio,
718 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
721 conn->lconn_tls_ctx = tls_def_ctx;
725 err = SSL_connect( ssl );
728 errno = WSAGetLastError();
732 if ( update_flags( sb, ssl, err )) {
736 if ((err = ERR_peek_error())) {
738 ld->ld_error = LDAP_STRDUP(ERR_error_string(err, buf));
742 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_int_tls_connect: "
743 "TLS can't connect.\n" ));
745 Debug( LDAP_DEBUG_ANY,"TLS: can't connect.\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 * Call this to do a TLS accept on a sockbuf.
762 * Everything else is the same as with tls_connect.
765 ldap_pvt_tls_accept( Sockbuf *sb, void *ctx_arg )
770 if ( HAS_TLS( sb ) ) {
771 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
774 ssl = alloc_handle( ctx_arg );
775 if ( ssl == NULL ) return -1;
778 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
779 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
781 ber_sockbuf_add_io( sb, &sb_tls_sbio,
782 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
785 err = SSL_accept( ssl );
788 errno = WSAGetLastError();
791 if ( update_flags( sb, ssl, err )) return 1;
794 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_accept: "
795 "TLS can't accept.\n" ));
797 Debug( LDAP_DEBUG_ANY,"TLS: can't accept.\n",0,0,0 );
801 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
802 LBER_SBIOD_LEVEL_TRANSPORT );
804 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
805 LBER_SBIOD_LEVEL_TRANSPORT );
814 ldap_pvt_tls_inplace ( Sockbuf *sb )
816 return HAS_TLS( sb ) ? 1 : 0;
820 ldap_pvt_tls_sb_ctx( Sockbuf *sb )
825 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&p );
833 ldap_pvt_tls_get_strength( void *s )
837 c = SSL_get_current_cipher((SSL *)s);
838 return SSL_CIPHER_get_bits(c, NULL);
843 ldap_pvt_tls_get_my_dn( void *s, struct berval *dn, LDAPDN_rewrite_dummy *func, unsigned flags )
849 x = SSL_get_certificate((SSL *)s);
851 if (!x) return LDAP_INVALID_CREDENTIALS;
853 xn = X509_get_subject_name(x);
854 rc = ldap_X509dn2bv(xn, dn, (LDAPDN_rewrite_func *)func, flags );
860 tls_get_cert( SSL *s )
862 /* If peer cert was bad, treat as if no cert was given */
863 if (SSL_get_verify_result(s)) {
864 /* If we can send an alert, do so */
865 if (SSL_version(s) != SSL2_VERSION) {
866 ssl3_send_alert(s,SSL3_AL_WARNING,SSL3_AD_BAD_CERTIFICATE);
870 return SSL_get_peer_certificate(s);
874 ldap_pvt_tls_get_peer_dn( void *s, struct berval *dn, LDAPDN_rewrite_dummy *func, unsigned flags )
880 x = tls_get_cert((SSL *)s);
882 if (!x) return LDAP_INVALID_CREDENTIALS;
884 xn = X509_get_subject_name(x);
885 rc = ldap_X509dn2bv(xn, dn, (LDAPDN_rewrite_func *)func, flags);
891 ldap_pvt_tls_get_peer_hostname( void *s )
898 x = tls_get_cert((SSL *)s);
901 xn = X509_get_subject_name(x);
903 ret = X509_NAME_get_text_by_NID(xn, NID_commonName, buf, sizeof(buf));
909 p = LDAP_STRDUP(buf);
915 ldap_pvt_tls_check_hostname( void *s, const char *name_in )
917 int i, ret = LDAP_LOCAL_ERROR;
921 if( ldap_int_hostname &&
922 ( !name_in || !strcasecmp( name_in, "localhost" ) ) )
924 name = ldap_int_hostname;
929 x = tls_get_cert((SSL *)s);
932 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_check_hostname: "
933 "TLS unable to get peer certificate.\n" ));
935 Debug( LDAP_DEBUG_ANY,
936 "TLS: unable to get peer certificate.\n",
939 /* If this was a fatal condition, things would have
940 * aborted long before now.
945 i = X509_get_ext_by_NID(x, NID_subject_alt_name, -1);
948 STACK_OF(GENERAL_NAME) *alt;
950 ex = X509_get_ext(x, i);
951 alt = X509V3_EXT_d2i(ex);
953 int n, len1, len2 = 0;
956 X509V3_EXT_METHOD *method;
959 n = sk_GENERAL_NAME_num(alt);
960 domain = strchr(name, '.');
962 len2 = len1 - (domain-name);
964 for (i=0; i<n; i++) {
965 gn = sk_GENERAL_NAME_value(alt, i);
966 if (gn->type == GEN_DNS) {
967 char *sn = ASN1_STRING_data(gn->d.ia5);
968 int sl = ASN1_STRING_length(gn->d.ia5);
970 /* Is this an exact match? */
971 if ((len1 == sl) && !strncasecmp(name, sn, len1)) {
975 /* Is this a wildcard match? */
976 if ((*sn == '*') && domain && (len2 == sl-1) &&
977 !strncasecmp(domain, sn+1, len2))
983 /* Is this a RFC 2549 style wildcard match? */
984 if ((*sn == '.') && domain && (len2 == sl) &&
985 !strncasecmp(domain, sn, len2))
993 method = X509V3_EXT_get(ex);
994 method->ext_free(alt);
995 if (i < n) { /* Found a match */
1001 if (ret != LDAP_SUCCESS) {
1005 xn = X509_get_subject_name(x);
1007 if( X509_NAME_get_text_by_NID( xn, NID_commonName,
1008 buf, sizeof(buf)) == -1)
1011 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_check_hostname: "
1012 "TLS unable to get common name from peer certificate.\n" ));
1014 Debug( LDAP_DEBUG_ANY,
1015 "TLS: unable to get common name from peer certificate.\n",
1019 } else if (strcasecmp(name, buf)) {
1021 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "ldap_pvt_tls_check_hostname: "
1022 "TLS hostname (%s) does not match "
1023 "common name in certificate (%s).\n", name, buf ));
1025 Debug( LDAP_DEBUG_ANY, "TLS: hostname (%s) does not match "
1026 "common name in certificate (%s).\n",
1029 ret = LDAP_CONNECT_ERROR;
1040 ldap_pvt_tls_get_peer_issuer( void *s )
1042 #if 0 /* currently unused; see ldap_pvt_tls_get_peer_dn() if needed */
1047 x = SSL_get_peer_certificate((SSL *)s);
1049 if (!x) return NULL;
1051 xn = X509_get_issuer_name(x);
1052 p = LDAP_STRDUP(X509_NAME_oneline(xn, buf, sizeof(buf)));
1061 ldap_int_tls_config( LDAP *ld, int option, const char *arg )
1066 case LDAP_OPT_X_TLS_CACERTFILE:
1067 case LDAP_OPT_X_TLS_CACERTDIR:
1068 case LDAP_OPT_X_TLS_CERTFILE:
1069 case LDAP_OPT_X_TLS_KEYFILE:
1070 case LDAP_OPT_X_TLS_RANDOM_FILE:
1071 return ldap_pvt_tls_set_option( ld, option, (void *) arg );
1073 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1074 case LDAP_OPT_X_TLS:
1076 if ( strcasecmp( arg, "never" ) == 0 ) {
1077 i = LDAP_OPT_X_TLS_NEVER ;
1079 } else if ( strcasecmp( arg, "demand" ) == 0 ) {
1080 i = LDAP_OPT_X_TLS_DEMAND ;
1082 } else if ( strcasecmp( arg, "allow" ) == 0 ) {
1083 i = LDAP_OPT_X_TLS_ALLOW ;
1085 } else if ( strcasecmp( arg, "try" ) == 0 ) {
1086 i = LDAP_OPT_X_TLS_TRY ;
1088 } else if ( ( strcasecmp( arg, "hard" ) == 0 ) ||
1089 ( strcasecmp( arg, "on" ) == 0 ) ||
1090 ( strcasecmp( arg, "yes" ) == 0) ||
1091 ( strcasecmp( arg, "true" ) == 0 ) )
1093 i = LDAP_OPT_X_TLS_HARD ;
1097 return ldap_pvt_tls_set_option( ld, option, &i );
1106 ldap_pvt_tls_get_option( LDAP *ld, int option, void *arg )
1108 struct ldapoptions *lo;
1111 assert( LDAP_VALID( ld ) );
1113 if( !LDAP_VALID( ld ) ) {
1114 return LDAP_OPT_ERROR;
1117 lo = &ld->ld_options;
1120 /* Get pointer to global option structure */
1121 lo = LDAP_INT_GLOBAL_OPT();
1123 return LDAP_NO_MEMORY;
1128 case LDAP_OPT_X_TLS:
1129 *(int *)arg = lo->ldo_tls_mode;
1131 case LDAP_OPT_X_TLS_CTX:
1133 *(void **)arg = (void *) tls_def_ctx;
1135 *(void **)arg = ld->ld_defconn->lconn_tls_ctx;
1138 case LDAP_OPT_X_TLS_CACERTFILE:
1139 *(char **)arg = tls_opt_cacertfile ?
1140 LDAP_STRDUP( tls_opt_cacertfile ) : NULL;
1142 case LDAP_OPT_X_TLS_CACERTDIR:
1143 *(char **)arg = tls_opt_cacertdir ?
1144 LDAP_STRDUP( tls_opt_cacertdir ) : NULL;
1146 case LDAP_OPT_X_TLS_CERTFILE:
1147 *(char **)arg = tls_opt_certfile ?
1148 LDAP_STRDUP( tls_opt_certfile ) : NULL;
1150 case LDAP_OPT_X_TLS_KEYFILE:
1151 *(char **)arg = tls_opt_keyfile ?
1152 LDAP_STRDUP( tls_opt_keyfile ) : NULL;
1154 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1155 *(int *)arg = tls_opt_require_cert;
1157 case LDAP_OPT_X_TLS_RANDOM_FILE:
1158 *(char **)arg = tls_opt_randfile ?
1159 LDAP_STRDUP( tls_opt_randfile ) : NULL;
1161 case LDAP_OPT_X_TLS_SSL_CTX: {
1164 LDAPConn *conn = ld->ld_defconn;
1165 if ( conn != NULL ) {
1166 Sockbuf *sb = conn->lconn_sb;
1167 retval = ldap_pvt_tls_sb_ctx( sb );
1170 *(void **)arg = retval;
1180 ldap_pvt_tls_set_option( LDAP *ld, int option, void *arg )
1182 struct ldapoptions *lo;
1185 assert( LDAP_VALID( ld ) );
1187 if( !LDAP_VALID( ld ) ) {
1188 return LDAP_OPT_ERROR;
1191 lo = &ld->ld_options;
1194 /* Get pointer to global option structure */
1195 lo = LDAP_INT_GLOBAL_OPT();
1197 return LDAP_NO_MEMORY;
1202 case LDAP_OPT_X_TLS:
1203 switch( *(int *) arg ) {
1204 case LDAP_OPT_X_TLS_NEVER:
1205 case LDAP_OPT_X_TLS_DEMAND:
1206 case LDAP_OPT_X_TLS_ALLOW:
1207 case LDAP_OPT_X_TLS_TRY:
1208 case LDAP_OPT_X_TLS_HARD:
1210 lo->ldo_tls_mode = *(int *)arg;
1217 case LDAP_OPT_X_TLS_CTX:
1219 tls_def_ctx = (SSL_CTX *) arg;
1222 ld->ld_defconn->lconn_tls_ctx = arg;
1232 case LDAP_OPT_X_TLS_CACERTFILE:
1233 if ( tls_opt_cacertfile ) LDAP_FREE( tls_opt_cacertfile );
1234 tls_opt_cacertfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1236 case LDAP_OPT_X_TLS_CACERTDIR:
1237 if ( tls_opt_cacertdir ) LDAP_FREE( tls_opt_cacertdir );
1238 tls_opt_cacertdir = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1240 case LDAP_OPT_X_TLS_CERTFILE:
1241 if ( tls_opt_certfile ) LDAP_FREE( tls_opt_certfile );
1242 tls_opt_certfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1244 case LDAP_OPT_X_TLS_KEYFILE:
1245 if ( tls_opt_keyfile ) LDAP_FREE( tls_opt_keyfile );
1246 tls_opt_keyfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1248 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1249 switch( *(int *) arg ) {
1250 case LDAP_OPT_X_TLS_NEVER:
1251 case LDAP_OPT_X_TLS_DEMAND:
1252 case LDAP_OPT_X_TLS_ALLOW:
1253 case LDAP_OPT_X_TLS_TRY:
1254 case LDAP_OPT_X_TLS_HARD:
1255 tls_opt_require_cert = * (int *) arg;
1259 case LDAP_OPT_X_TLS_CIPHER_SUITE:
1260 if ( tls_opt_ciphersuite ) LDAP_FREE( tls_opt_ciphersuite );
1261 tls_opt_ciphersuite = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1263 case LDAP_OPT_X_TLS_RANDOM_FILE:
1264 if (tls_opt_randfile ) LDAP_FREE (tls_opt_randfile );
1265 tls_opt_randfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1274 ldap_int_tls_start ( LDAP *ld, LDAPConn *conn, LDAPURLDesc *srv )
1276 Sockbuf *sb = conn->lconn_sb;
1281 host = srv->lud_host;
1283 host = conn->lconn_server->lud_host;
1286 /* avoid NULL host */
1287 if( host == NULL ) {
1291 (void) ldap_pvt_tls_init();
1294 * Fortunately, the lib uses blocking io...
1296 if ( ldap_int_tls_connect( ld, conn ) < 0 ) {
1297 ld->ld_errno = LDAP_CONNECT_ERROR;
1298 return (ld->ld_errno);
1301 ssl = ldap_pvt_tls_sb_ctx( sb );
1302 assert( ssl != NULL );
1305 * compare host with name(s) in certificate
1307 ld->ld_errno = ldap_pvt_tls_check_hostname( ssl, host );
1308 if (ld->ld_errno != LDAP_SUCCESS) {
1309 return ld->ld_errno;
1313 * set SASL properties to TLS ssf and authid
1316 struct berval authid = { 0, NULL };
1319 /* we need to let SASL know */
1320 ssf = ldap_pvt_tls_get_strength( ssl );
1321 /* failure is OK, we just can't use SASL EXTERNAL */
1322 (void) ldap_pvt_tls_get_my_dn( ssl, &authid, NULL, 0 );
1324 (void) ldap_int_sasl_external( ld, conn, authid.bv_val, ssf );
1325 LDAP_FREE( authid.bv_val );
1328 return LDAP_SUCCESS;
1331 /* Derived from openssl/apps/s_cb.c */
1333 tls_info_cb( SSL *ssl, int where, int ret )
1338 w = where & ~SSL_ST_MASK;
1339 if ( w & SSL_ST_CONNECT ) {
1341 } else if ( w & SSL_ST_ACCEPT ) {
1347 if ( where & SSL_CB_LOOP ) {
1349 LDAP_LOG (( "tls", LDAP_LEVEL_DETAIL1, "tls_info_cb: "
1350 "TLS trace: %s:%s\n", op, SSL_state_string_long( ssl ) ));
1352 Debug( LDAP_DEBUG_TRACE,
1353 "TLS trace: %s:%s\n",
1354 op, SSL_state_string_long( ssl ), 0 );
1357 } else if ( where & SSL_CB_ALERT ) {
1358 op = ( where & SSL_CB_READ ) ? "read" : "write";
1360 LDAP_LOG (( "tls", LDAP_LEVEL_DETAIL1, "tls_info_cb: "
1361 "TLS trace: SSL3 alert %s:%s:%s\n", op,
1362 SSL_alert_type_string_long( ret ),
1363 SSL_alert_desc_string_long( ret) ));
1365 Debug( LDAP_DEBUG_TRACE,
1366 "TLS trace: SSL3 alert %s:%s:%s\n",
1368 SSL_alert_type_string_long( ret ),
1369 SSL_alert_desc_string_long( ret) );
1372 } else if ( where & SSL_CB_EXIT ) {
1375 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "tls_info_cb: "
1376 "TLS trace: %s:failed in %s\n", op, SSL_state_string_long( ssl ) ));
1378 Debug( LDAP_DEBUG_TRACE,
1379 "TLS trace: %s:failed in %s\n",
1380 op, SSL_state_string_long( ssl ), 0 );
1382 } else if ( ret < 0 ) {
1384 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "tls_info_cb: "
1385 "TLS trace: %s:error in %s\n", op, SSL_state_string_long( ssl ) ));
1387 Debug( LDAP_DEBUG_TRACE,
1388 "TLS trace: %s:error in %s\n",
1389 op, SSL_state_string_long( ssl ), 0 );
1396 tls_verify_cb( int ok, X509_STORE_CTX *ctx )
1406 cert = X509_STORE_CTX_get_current_cert( ctx );
1407 errnum = X509_STORE_CTX_get_error( ctx );
1408 errdepth = X509_STORE_CTX_get_error_depth( ctx );
1411 * X509_get_*_name return pointers to the internal copies of
1412 * those things requested. So do not free them.
1414 subject = X509_get_subject_name( cert );
1415 issuer = X509_get_issuer_name( cert );
1416 /* X509_NAME_oneline, if passed a NULL buf, allocate memomry */
1417 sname = X509_NAME_oneline( subject, NULL, 0 );
1418 iname = X509_NAME_oneline( issuer, NULL, 0 );
1420 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "tls_verify_cb"
1421 "TLS certificate verification: depth: %d, err: %d: "
1422 "subject: %s, issuer: %s\n", errdepth, errnum,
1423 sname ? sname : "-unknown-", iname ? iname : "-unknown-" ));
1425 LDAP_LOG (( "tls", LDAP_LEVEL_ERR, "TLS certificate verification: Error, %s\n",
1426 X509_verify_cert_error_string(errnum)));
1429 Debug( LDAP_DEBUG_TRACE,
1430 "TLS certificate verification: depth: %d, err: %d, subject: %s,",
1432 sname ? sname : "-unknown-" );
1433 Debug( LDAP_DEBUG_TRACE, " issuer: %s\n", iname ? iname : "-unknown-", 0, 0 );
1435 Debug( LDAP_DEBUG_ANY,
1436 "TLS certificate verification: Error, %s\n",
1437 X509_verify_cert_error_string(errnum), 0, 0 );
1441 CRYPTO_free ( sname );
1443 CRYPTO_free ( iname );
1449 tls_verify_ok( int ok, X509_STORE_CTX *ctx )
1451 (void) tls_verify_cb( ok, ctx );
1455 /* Inspired by ERR_print_errors in OpenSSL */
1457 tls_report_error( void )
1464 while ( ( l = ERR_get_error_line( &file, &line ) ) != 0 ) {
1466 LDAP_LOG (( "tls", LDAP_LEVEL_ERR,
1467 "tls_report_error: TLS %s %s:%d\n",
1468 ERR_error_string( l, buf ), file, line ));
1470 Debug( LDAP_DEBUG_ANY, "TLS: %s %s:%d\n",
1471 ERR_error_string( l, buf ), file, line );
1477 tls_tmp_rsa_cb( SSL *ssl, int is_export, int key_length )
1481 /* FIXME: Pregenerate the key on startup */
1482 /* FIXME: Who frees the key? */
1483 tmp_rsa = RSA_generate_key( key_length, RSA_F4, NULL, NULL );
1487 LDAP_LOG (( "tls", LDAP_LEVEL_ERR,
1488 "tls_tmp_rsa_cb: TLS Failed to generate temporary %d-bit %s RSA key\n",
1489 key_length, is_export ? "export" : "domestic" ));
1491 Debug( LDAP_DEBUG_ANY,
1492 "TLS: Failed to generate temporary %d-bit %s RSA key\n",
1493 key_length, is_export ? "export" : "domestic", 0 );
1501 tls_seed_PRNG( const char *randfile )
1503 #ifndef URANDOM_DEVICE
1504 /* no /dev/urandom (or equiv) */
1506 char buffer[MAXPATHLEN];
1508 if (randfile == NULL) {
1509 /* The seed file is $RANDFILE if defined, otherwise $HOME/.rnd.
1510 * If $HOME is not set or buffer too small to hold the pathname,
1511 * an error occurs. - From RAND_file_name() man page.
1512 * The fact is that when $HOME is NULL, .rnd is used.
1514 randfile = RAND_file_name( buffer, sizeof( buffer ) );
1516 } else if (RAND_egd(randfile) > 0) {
1521 if (randfile == NULL) {
1523 LDAP_LOG (( "tls", LDAP_LEVEL_DETAIL1,
1524 "tls_seed_PRNG: TLS Use configuration file or "
1525 "$RANDFILE to define seed PRNG\n" ));
1527 Debug( LDAP_DEBUG_ANY,
1528 "TLS: Use configuration file or $RANDFILE to define seed PRNG\n",
1534 total = RAND_load_file(randfile, -1);
1536 if (RAND_status() == 0) {
1538 LDAP_LOG (( "tls", LDAP_LEVEL_DETAIL1,
1539 "tls_seed_PRNG: TLS PRNG not been seeded with enough data\n" ));
1541 Debug( LDAP_DEBUG_ANY,
1542 "TLS: PRNG not been seeded with enough data\n",
1548 /* assume if there was enough bits to seed that it's okay
1549 * to write derived bits to the file
1551 RAND_write_file(randfile);
1560 tls_tmp_dh_cb( SSL *ssl, int is_export, int key_length )
1568 ldap_start_tls_s ( LDAP *ld,
1569 LDAPControl **serverctrls,
1570 LDAPControl **clientctrls )
1575 char *rspoid = NULL;
1576 struct berval *rspdata = NULL;
1578 /* XXYYZ: this initiates operation only on default connection! */
1580 if ( ld->ld_sb != NULL && ldap_pvt_tls_inplace( ld->ld_sb ) != 0 ) {
1581 return LDAP_LOCAL_ERROR;
1584 rc = ldap_extended_operation_s( ld, LDAP_EXOP_START_TLS,
1585 NULL, serverctrls, clientctrls, &rspoid, &rspdata );
1586 if ( rc != LDAP_SUCCESS ) {
1590 if ( rspoid != NULL ) {
1594 if ( rspdata != NULL ) {
1595 ber_bvfree( rspdata );
1598 rc = ldap_int_tls_start( ld, ld->ld_defconn, NULL );
1600 rc = LDAP_NOT_SUPPORTED;