3 * Copyright 1998-2003 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>
20 #include <ac/unistd.h>
22 #include <ac/dirent.h>
29 #include <ldap_pvt_thread.h>
32 #ifdef HAVE_OPENSSL_SSL_H
33 #include <openssl/ssl.h>
34 #include <openssl/x509v3.h>
35 #include <openssl/err.h>
36 #include <openssl/rand.h>
37 #include <openssl/safestack.h>
38 #elif defined( HAVE_SSL_H )
42 static int tls_opt_trace = 1;
43 static char *tls_opt_certfile = NULL;
44 static char *tls_opt_keyfile = NULL;
45 static char *tls_opt_cacertfile = NULL;
46 static char *tls_opt_cacertdir = NULL;
47 static int tls_opt_require_cert = LDAP_OPT_X_TLS_DEMAND;
48 static char *tls_opt_ciphersuite = NULL;
49 static char *tls_opt_randfile = NULL;
51 #define HAS_TLS( sb ) ber_sockbuf_ctrl( sb, LBER_SB_OPT_HAS_IO, \
52 (void *)&sb_tls_sbio )
54 static void tls_report_error( void );
56 static void tls_info_cb( const SSL *ssl, int where, int ret );
57 static int tls_verify_cb( int ok, X509_STORE_CTX *ctx );
58 static int tls_verify_ok( int ok, X509_STORE_CTX *ctx );
59 static RSA * tls_tmp_rsa_cb( SSL *ssl, int is_export, int key_length );
60 static STACK_OF(X509_NAME) * get_ca_list( char * bundle, char * dir );
62 #if 0 /* Currently this is not used by anyone */
63 static DH * tls_tmp_dh_cb( SSL *ssl, int is_export, int key_length );
66 static SSL_CTX *tls_def_ctx = NULL;
68 static int tls_seed_PRNG( const char *randfile );
72 * provide mutexes for the SSLeay library.
74 static ldap_pvt_thread_mutex_t tls_mutexes[CRYPTO_NUM_LOCKS];
76 static void tls_locking_cb( int mode, int type, const char *file, int line )
78 if ( mode & CRYPTO_LOCK ) {
79 ldap_pvt_thread_mutex_lock( &tls_mutexes[type] );
81 ldap_pvt_thread_mutex_unlock( &tls_mutexes[type] );
86 * an extra mutex for the default ctx.
89 static ldap_pvt_thread_mutex_t tls_def_ctx_mutex;
91 static void tls_init_threads( void )
95 for( i=0; i< CRYPTO_NUM_LOCKS ; i++ ) {
96 ldap_pvt_thread_mutex_init( &tls_mutexes[i] );
98 CRYPTO_set_locking_callback( tls_locking_cb );
99 /* FIXME: the thread id should be added somehow... */
101 ldap_pvt_thread_mutex_init( &tls_def_ctx_mutex );
103 #endif /* LDAP_R_COMPILE */
106 * Tear down the TLS subsystem. Should only be called once.
109 ldap_pvt_tls_destroy( void )
111 SSL_CTX_free(tls_def_ctx);
117 if ( tls_opt_certfile ) {
118 LDAP_FREE( tls_opt_certfile );
119 tls_opt_certfile = NULL;
121 if ( tls_opt_keyfile ) {
122 LDAP_FREE( tls_opt_keyfile );
123 tls_opt_keyfile = NULL;
125 if ( tls_opt_cacertfile ) {
126 LDAP_FREE( tls_opt_cacertfile );
127 tls_opt_cacertfile = NULL;
129 if ( tls_opt_cacertdir ) {
130 LDAP_FREE( tls_opt_cacertdir );
131 tls_opt_cacertdir = NULL;
133 if ( tls_opt_ciphersuite ) {
134 LDAP_FREE( tls_opt_ciphersuite );
135 tls_opt_ciphersuite = NULL;
137 if ( tls_opt_randfile ) {
138 LDAP_FREE( tls_opt_randfile );
139 tls_opt_randfile = NULL;
144 * Initialize TLS subsystem. Should be called only once.
147 ldap_pvt_tls_init( void )
149 static int tls_initialized = 0;
151 if ( tls_initialized ) return 0;
156 char *file = LDAP_STRDUP( tls_opt_randfile );
157 if ( file ) __atoe( file );
158 (void) tls_seed_PRNG( file );
162 (void) tls_seed_PRNG( tls_opt_randfile );
165 #ifdef LDAP_R_COMPILE
169 SSL_load_error_strings();
170 SSLeay_add_ssl_algorithms();
172 /* FIXME: mod_ssl does this */
173 X509V3_add_standard_extensions();
178 * initialize the default context
181 ldap_pvt_tls_init_def_ctx( void )
183 STACK_OF(X509_NAME) *calist;
185 char *ciphersuite = tls_opt_ciphersuite;
186 char *cacertfile = tls_opt_cacertfile;
187 char *cacertdir = tls_opt_cacertdir;
188 char *certfile = tls_opt_certfile;
189 char *keyfile = tls_opt_keyfile;
192 /* This ASCII/EBCDIC handling is a real pain! */
194 ciphersuite = LDAP_STRDUP( ciphersuite );
195 __atoe( ciphersuite );
198 cacertfile = LDAP_STRDUP( cacertfile );
199 __atoe( cacertfile );
202 cacertdir = LDAP_STRDUP( cacertdir );
206 certfile = LDAP_STRDUP( certfile );
210 keyfile = LDAP_STRDUP( keyfile );
215 #ifdef LDAP_R_COMPILE
216 ldap_pvt_thread_mutex_lock( &tls_def_ctx_mutex );
218 if ( tls_def_ctx == NULL ) {
220 tls_def_ctx = SSL_CTX_new( SSLv23_method() );
221 if ( tls_def_ctx == NULL ) {
223 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
224 "TLS could not allocate default ctx (%d).\n",
225 ERR_peek_error(), 0, 0 );
227 Debug( LDAP_DEBUG_ANY,
228 "TLS: could not allocate default ctx (%lu).\n",
229 ERR_peek_error(),0,0);
235 SSL_CTX_set_session_id_context( tls_def_ctx,
236 "OpenLDAP", sizeof("OpenLDAP")-1 );
238 if ( tls_opt_ciphersuite &&
239 !SSL_CTX_set_cipher_list( tls_def_ctx, ciphersuite ) )
242 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
243 "TLS could not set cipher list %s.\n",
244 tls_opt_ciphersuite, 0, 0 );
246 Debug( LDAP_DEBUG_ANY,
247 "TLS: could not set cipher list %s.\n",
248 tls_opt_ciphersuite, 0, 0 );
255 if (tls_opt_cacertfile != NULL || tls_opt_cacertdir != NULL) {
256 if ( !SSL_CTX_load_verify_locations( tls_def_ctx,
257 cacertfile, cacertdir ) ||
258 !SSL_CTX_set_default_verify_paths( tls_def_ctx ) )
261 LDAP_LOG ( TRANSPORT, ERR,
262 "ldap_pvt_tls_init_def_ctx: "
263 "TLS could not load verify locations "
264 "(file:`%s',dir:`%s').\n",
265 tls_opt_cacertfile ? tls_opt_cacertfile : "",
266 tls_opt_cacertdir ? tls_opt_cacertdir : "", 0 );
268 Debug( LDAP_DEBUG_ANY, "TLS: "
269 "could not load verify locations (file:`%s',dir:`%s').\n",
270 tls_opt_cacertfile ? tls_opt_cacertfile : "",
271 tls_opt_cacertdir ? tls_opt_cacertdir : "",
279 calist = get_ca_list( cacertfile, cacertdir );
282 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
283 "TLS could not load client CA list (file: `%s',dir:`%s')\n",
284 tls_opt_cacertfile ? tls_opt_cacertfile : "",
285 tls_opt_cacertdir ? tls_opt_cacertdir : "", 0 );
287 Debug( LDAP_DEBUG_ANY, "TLS: "
288 "could not load client CA list (file:`%s',dir:`%s').\n",
289 tls_opt_cacertfile ? tls_opt_cacertfile : "",
290 tls_opt_cacertdir ? tls_opt_cacertdir : "",
298 SSL_CTX_set_client_CA_list( tls_def_ctx, calist );
301 if ( tls_opt_keyfile &&
302 !SSL_CTX_use_PrivateKey_file( tls_def_ctx,
303 keyfile, SSL_FILETYPE_PEM ) )
306 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
307 "TLS could not use key file `%s'.\n", tls_opt_keyfile, 0, 0 );
309 Debug( LDAP_DEBUG_ANY,
310 "TLS: could not use key file `%s'.\n",
311 tls_opt_keyfile,0,0);
318 if ( tls_opt_certfile &&
319 !SSL_CTX_use_certificate_file( tls_def_ctx,
320 certfile, SSL_FILETYPE_PEM ) )
323 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
324 "TLS could not use certificate `%s'.\n",
325 tls_opt_certfile, 0, 0 );
327 Debug( LDAP_DEBUG_ANY,
328 "TLS: could not use certificate `%s'.\n",
329 tls_opt_certfile,0,0);
336 if ( ( tls_opt_certfile || tls_opt_keyfile ) &&
337 !SSL_CTX_check_private_key( tls_def_ctx ) )
340 LDAP_LOG ( TRANSPORT, ERR,
341 "ldap_pvt_tls_init_def_ctx: TLS private key mismatch.\n",
344 Debug( LDAP_DEBUG_ANY,
345 "TLS: private key mismatch.\n",
353 if ( tls_opt_trace ) {
354 SSL_CTX_set_info_callback( tls_def_ctx, tls_info_cb );
358 if ( tls_opt_require_cert ) {
360 if ( tls_opt_require_cert == LDAP_OPT_X_TLS_DEMAND ||
361 tls_opt_require_cert == LDAP_OPT_X_TLS_HARD ) {
362 i |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
366 SSL_CTX_set_verify( tls_def_ctx, i,
367 tls_opt_require_cert == LDAP_OPT_X_TLS_ALLOW ?
368 tls_verify_ok : tls_verify_cb );
369 SSL_CTX_set_tmp_rsa_callback( tls_def_ctx, tls_tmp_rsa_cb );
370 /* SSL_CTX_set_tmp_dh_callback( tls_def_ctx, tls_tmp_dh_cb ); */
373 if ( rc == -1 && tls_def_ctx != NULL ) {
374 SSL_CTX_free( tls_def_ctx );
378 LDAP_FREE( ciphersuite );
379 LDAP_FREE( cacertfile );
380 LDAP_FREE( cacertdir );
381 LDAP_FREE( certfile );
382 LDAP_FREE( keyfile );
384 #ifdef LDAP_R_COMPILE
385 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
390 static STACK_OF(X509_NAME) *
391 get_ca_list( char * bundle, char * dir )
393 STACK_OF(X509_NAME) *ca_list = NULL;
396 ca_list = SSL_load_client_CA_file( bundle );
398 #if defined(HAVE_DIRENT_H) || defined(dirent)
403 ca_list = sk_X509_NAME_new_null();
406 if ( !SSL_add_dir_cert_subjects_to_stack( ca_list, dir ) &&
408 sk_X509_NAME_free( ca_list );
417 alloc_handle( void *ctx_arg )
423 ctx = (SSL_CTX *) ctx_arg;
425 if ( ldap_pvt_tls_init_def_ctx() < 0 ) return NULL;
429 ssl = SSL_new( ctx );
432 LDAP_LOG ( TRANSPORT, ERR,
433 "alloc_handle: TLS can't create ssl handle.\n", 0, 0, 0 );
435 Debug( LDAP_DEBUG_ANY,"TLS: can't create ssl handle.\n",0,0,0);
443 update_flags( Sockbuf *sb, SSL * ssl, int rc )
445 int err = SSL_get_error(ssl, rc);
447 sb->sb_trans_needs_read = 0;
448 sb->sb_trans_needs_write = 0;
450 if (err == SSL_ERROR_WANT_READ) {
451 sb->sb_trans_needs_read = 1;
454 } else if (err == SSL_ERROR_WANT_WRITE) {
455 sb->sb_trans_needs_write = 1;
458 } else if (err == SSL_ERROR_WANT_CONNECT) {
465 * TLS support for LBER Sockbufs
470 Sockbuf_IO_Desc *sbiod;
473 static BIO_METHOD sb_tls_bio_method;
476 sb_tls_setup( Sockbuf_IO_Desc *sbiod, void *arg )
481 assert( sbiod != NULL );
483 p = LBER_MALLOC( sizeof( *p ) );
490 bio = BIO_new( &sb_tls_bio_method );
491 bio->ptr = (void *)p;
492 SSL_set_bio( p->ssl, bio, bio );
493 sbiod->sbiod_pvt = p;
498 sb_tls_remove( Sockbuf_IO_Desc *sbiod )
502 assert( sbiod != NULL );
503 assert( sbiod->sbiod_pvt != NULL );
505 p = (struct tls_data *)sbiod->sbiod_pvt;
507 LBER_FREE( sbiod->sbiod_pvt );
508 sbiod->sbiod_pvt = NULL;
513 sb_tls_close( Sockbuf_IO_Desc *sbiod )
517 assert( sbiod != NULL );
518 assert( sbiod->sbiod_pvt != NULL );
520 p = (struct tls_data *)sbiod->sbiod_pvt;
521 SSL_shutdown( p->ssl );
526 sb_tls_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
530 assert( sbiod != NULL );
531 assert( sbiod->sbiod_pvt != NULL );
533 p = (struct tls_data *)sbiod->sbiod_pvt;
535 if ( opt == LBER_SB_OPT_GET_SSL ) {
536 *((SSL **)arg) = p->ssl;
539 } else if ( opt == LBER_SB_OPT_DATA_READY ) {
540 if( SSL_pending( p->ssl ) > 0 ) {
545 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
549 sb_tls_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
555 assert( sbiod != NULL );
556 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
558 p = (struct tls_data *)sbiod->sbiod_pvt;
560 ret = SSL_read( p->ssl, (char *)buf, len );
562 errno = WSAGetLastError();
564 err = SSL_get_error( p->ssl, ret );
565 if (err == SSL_ERROR_WANT_READ ) {
566 sbiod->sbiod_sb->sb_trans_needs_read = 1;
570 sbiod->sbiod_sb->sb_trans_needs_read = 0;
575 sb_tls_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
581 assert( sbiod != NULL );
582 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
584 p = (struct tls_data *)sbiod->sbiod_pvt;
586 ret = SSL_write( p->ssl, (char *)buf, len );
588 errno = WSAGetLastError();
590 err = SSL_get_error( p->ssl, ret );
591 if (err == SSL_ERROR_WANT_WRITE ) {
592 sbiod->sbiod_sb->sb_trans_needs_write = 1;
596 sbiod->sbiod_sb->sb_trans_needs_write = 0;
601 static Sockbuf_IO sb_tls_sbio =
603 sb_tls_setup, /* sbi_setup */
604 sb_tls_remove, /* sbi_remove */
605 sb_tls_ctrl, /* sbi_ctrl */
606 sb_tls_read, /* sbi_read */
607 sb_tls_write, /* sbi_write */
608 sb_tls_close /* sbi_close */
612 sb_tls_bio_create( BIO *b ) {
621 sb_tls_bio_destroy( BIO *b )
623 if ( b == NULL ) return 0;
625 b->ptr = NULL; /* sb_tls_remove() will free it */
632 sb_tls_bio_read( BIO *b, char *buf, int len )
637 if ( buf == NULL || len <= 0 ) return 0;
639 p = (struct tls_data *)b->ptr;
641 if ( p == NULL || p->sbiod == NULL ) {
645 ret = LBER_SBIOD_READ_NEXT( p->sbiod, buf, len );
647 BIO_clear_retry_flags( b );
650 if ( err == EAGAIN || err == EWOULDBLOCK ) {
651 BIO_set_retry_read( b );
659 sb_tls_bio_write( BIO *b, const char *buf, int len )
664 if ( buf == NULL || len <= 0 ) return 0;
666 p = (struct tls_data *)b->ptr;
668 if ( p == NULL || p->sbiod == NULL ) {
672 ret = LBER_SBIOD_WRITE_NEXT( p->sbiod, (char *)buf, len );
674 BIO_clear_retry_flags( b );
677 if ( err == EAGAIN || err == EWOULDBLOCK ) {
678 BIO_set_retry_write( b );
686 sb_tls_bio_ctrl( BIO *b, int cmd, long num, void *ptr )
688 if ( cmd == BIO_CTRL_FLUSH ) {
689 /* The OpenSSL library needs this */
696 sb_tls_bio_gets( BIO *b, char *buf, int len )
702 sb_tls_bio_puts( BIO *b, const char *str )
704 return sb_tls_bio_write( b, str, strlen( str ) );
707 static BIO_METHOD sb_tls_bio_method =
709 ( 100 | 0x400 ), /* it's a source/sink BIO */
721 * Call this to do a TLS connect on a sockbuf. ctx_arg can be
722 * a SSL_CTX * or NULL, in which case the default ctx is used.
726 * 0 - Success. Connection is ready for communication.
727 * <0 - Error. Can't create a TLS stream.
728 * >0 - Partial success.
729 * Do a select (using information from lber_pvt_sb_needs_{read,write}
734 ldap_int_tls_connect( LDAP *ld, LDAPConn *conn )
736 Sockbuf *sb = conn->lconn_sb;
740 if ( HAS_TLS( sb ) ) {
741 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
744 void *ctx = ld->ld_defconn
745 ? ld->ld_defconn->lconn_tls_ctx : NULL;
747 ssl = alloc_handle( ctx );
749 if ( ssl == NULL ) return -1;
752 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
753 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
755 ber_sockbuf_add_io( sb, &sb_tls_sbio,
756 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
759 conn->lconn_tls_ctx = tls_def_ctx;
763 err = SSL_connect( ssl );
766 errno = WSAGetLastError();
770 if ( update_flags( sb, ssl, err )) {
774 if ((err = ERR_peek_error())) {
776 ld->ld_error = LDAP_STRDUP(ERR_error_string(err, buf));
778 if ( ld->ld_error ) __etoa(ld->ld_error);
783 LDAP_LOG ( TRANSPORT, ERR,
784 "ldap_int_tls_connect: TLS can't connect.\n", 0, 0, 0 );
786 Debug( LDAP_DEBUG_ANY,"TLS: can't connect.\n",0,0,0);
789 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
790 LBER_SBIOD_LEVEL_TRANSPORT );
792 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
793 LBER_SBIOD_LEVEL_TRANSPORT );
802 * Call this to do a TLS accept on a sockbuf.
803 * Everything else is the same as with tls_connect.
806 ldap_pvt_tls_accept( Sockbuf *sb, void *ctx_arg )
811 if ( HAS_TLS( sb ) ) {
812 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
815 ssl = alloc_handle( ctx_arg );
816 if ( ssl == NULL ) return -1;
819 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
820 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
822 ber_sockbuf_add_io( sb, &sb_tls_sbio,
823 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
826 err = SSL_accept( ssl );
829 errno = WSAGetLastError();
832 if ( update_flags( sb, ssl, err )) return 1;
835 LDAP_LOG ( TRANSPORT, ERR,
836 "ldap_pvt_tls_accept: TLS can't accept.\n", 0, 0, 0 );
838 Debug( LDAP_DEBUG_ANY,"TLS: can't accept.\n",0,0,0 );
842 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
843 LBER_SBIOD_LEVEL_TRANSPORT );
845 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
846 LBER_SBIOD_LEVEL_TRANSPORT );
855 ldap_pvt_tls_inplace ( Sockbuf *sb )
857 return HAS_TLS( sb ) ? 1 : 0;
861 ldap_pvt_tls_sb_ctx( Sockbuf *sb )
866 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&p );
874 ldap_pvt_tls_get_strength( void *s )
878 c = SSL_get_current_cipher((SSL *)s);
879 return SSL_CIPHER_get_bits(c, NULL);
884 ldap_pvt_tls_get_my_dn( void *s, struct berval *dn, LDAPDN_rewrite_dummy *func, unsigned flags )
890 x = SSL_get_certificate((SSL *)s);
892 if (!x) return LDAP_INVALID_CREDENTIALS;
894 xn = X509_get_subject_name(x);
895 rc = ldap_X509dn2bv(xn, dn, (LDAPDN_rewrite_func *)func, flags );
900 tls_get_cert( SSL *s )
902 /* If peer cert was bad, treat as if no cert was given */
903 if (SSL_get_verify_result(s)) {
904 /* If we can send an alert, do so */
905 if (SSL_version(s) != SSL2_VERSION) {
906 ssl3_send_alert(s,SSL3_AL_WARNING,SSL3_AD_BAD_CERTIFICATE);
910 return SSL_get_peer_certificate(s);
914 ldap_pvt_tls_get_peer_dn( void *s, struct berval *dn, LDAPDN_rewrite_dummy *func, unsigned flags )
920 x = tls_get_cert((SSL *)s);
922 if (!x) return LDAP_INVALID_CREDENTIALS;
924 xn = X509_get_subject_name(x);
925 rc = ldap_X509dn2bv(xn, dn, (LDAPDN_rewrite_func *)func, flags);
931 ldap_pvt_tls_get_peer_hostname( void *s )
938 x = tls_get_cert((SSL *)s);
941 xn = X509_get_subject_name(x);
943 ret = X509_NAME_get_text_by_NID(xn, NID_commonName, buf, sizeof(buf));
949 p = LDAP_STRDUP(buf);
954 /* what kind of hostname were we given? */
960 ldap_pvt_tls_check_hostname( LDAP *ld, void *s, const char *name_in )
962 int i, ret = LDAP_LOCAL_ERROR;
968 struct in6_addr addr;
973 if( ldap_int_hostname &&
974 ( !name_in || !strcasecmp( name_in, "localhost" ) ) )
976 name = ldap_int_hostname;
981 x = tls_get_cert((SSL *)s);
984 LDAP_LOG ( TRANSPORT, ERR,
985 "ldap_pvt_tls_check_hostname: "
986 "TLS unable to get peer certificate.\n" , 0, 0, 0 );
988 Debug( LDAP_DEBUG_ANY,
989 "TLS: unable to get peer certificate.\n",
992 /* If this was a fatal condition, things would have
993 * aborted long before now.
999 if (name[0] == '[' && strchr(name, ']')) {
1000 char *n2 = ldap_strdup(name+1);
1001 *strchr(n2, ']') = 2;
1002 if (inet_pton(AF_INET6, n2, &addr))
1007 if ((ptr = strrchr(name, '.')) && isdigit((unsigned char)ptr[1])) {
1008 if (inet_aton(name, (struct in_addr *)&addr))
1012 i = X509_get_ext_by_NID(x, NID_subject_alt_name, -1);
1015 STACK_OF(GENERAL_NAME) *alt;
1017 ex = X509_get_ext(x, i);
1018 alt = X509V3_EXT_d2i(ex);
1020 int n, len1 = 0, len2 = 0;
1021 char *domain = NULL;
1024 if (ntype == IS_DNS) {
1025 len1 = strlen(name);
1026 domain = strchr(name, '.');
1028 len2 = len1 - (domain-name);
1031 n = sk_GENERAL_NAME_num(alt);
1032 for (i=0; i<n; i++) {
1035 gn = sk_GENERAL_NAME_value(alt, i);
1036 if (gn->type == GEN_DNS) {
1037 if (ntype != IS_DNS) continue;
1039 sn = ASN1_STRING_data(gn->d.ia5);
1040 sl = ASN1_STRING_length(gn->d.ia5);
1042 /* Is this an exact match? */
1043 if ((len1 == sl) && !strncasecmp(name, sn, len1)) {
1047 /* Is this a wildcard match? */
1048 if ((*sn == '*') && domain && (len2 == sl-1) &&
1049 !strncasecmp(domain, sn+1, len2)) {
1054 /* Is this a RFC 2459 style wildcard match? */
1055 if ((*sn == '.') && domain && (len2 == sl) &&
1056 !strncasecmp(domain, sn, len2)) {
1060 } else if (gn->type == GEN_IPADD) {
1061 if (ntype == IS_DNS) continue;
1063 sn = ASN1_STRING_data(gn->d.ia5);
1064 sl = ASN1_STRING_length(gn->d.ia5);
1066 #ifdef LDAP_PF_INET6
1067 if (ntype == IS_IP6 && sl != sizeof(struct in6_addr)) {
1071 if (ntype == IS_IP4 && sl != sizeof(struct in_addr)) {
1074 if (!memcmp(sn, &addr, sl)) {
1080 GENERAL_NAMES_free(alt);
1081 if (i < n) { /* Found a match */
1087 if (ret != LDAP_SUCCESS) {
1091 xn = X509_get_subject_name(x);
1093 if( X509_NAME_get_text_by_NID( xn, NID_commonName,
1094 buf, sizeof(buf)) == -1)
1097 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_check_hostname: "
1098 "TLS unable to get common name from peer certificate.\n",
1101 Debug( LDAP_DEBUG_ANY,
1102 "TLS: unable to get common name from peer certificate.\n",
1105 ld->ld_error = LDAP_STRDUP("TLS: unable to get CN from peer certificate");
1107 } else if (strcasecmp(name, buf)) {
1109 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_check_hostname: "
1110 "TLS hostname (%s) does not match "
1111 "common name in certificate (%s).\n", name, buf, 0 );
1113 Debug( LDAP_DEBUG_ANY, "TLS: hostname (%s) does not match "
1114 "common name in certificate (%s).\n",
1117 ret = LDAP_CONNECT_ERROR;
1118 ld->ld_error = LDAP_STRDUP("TLS: hostname does not match CN in peer certificate");
1129 ldap_pvt_tls_get_peer_issuer( void *s )
1131 #if 0 /* currently unused; see ldap_pvt_tls_get_peer_dn() if needed */
1136 x = SSL_get_peer_certificate((SSL *)s);
1138 if (!x) return NULL;
1140 xn = X509_get_issuer_name(x);
1141 p = LDAP_STRDUP(X509_NAME_oneline(xn, buf, sizeof(buf)));
1150 ldap_int_tls_config( LDAP *ld, int option, const char *arg )
1155 case LDAP_OPT_X_TLS_CACERTFILE:
1156 case LDAP_OPT_X_TLS_CACERTDIR:
1157 case LDAP_OPT_X_TLS_CERTFILE:
1158 case LDAP_OPT_X_TLS_KEYFILE:
1159 case LDAP_OPT_X_TLS_RANDOM_FILE:
1160 return ldap_pvt_tls_set_option( ld, option, (void *) arg );
1162 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1163 case LDAP_OPT_X_TLS:
1165 if ( strcasecmp( arg, "never" ) == 0 ) {
1166 i = LDAP_OPT_X_TLS_NEVER ;
1168 } else if ( strcasecmp( arg, "demand" ) == 0 ) {
1169 i = LDAP_OPT_X_TLS_DEMAND ;
1171 } else if ( strcasecmp( arg, "allow" ) == 0 ) {
1172 i = LDAP_OPT_X_TLS_ALLOW ;
1174 } else if ( strcasecmp( arg, "try" ) == 0 ) {
1175 i = LDAP_OPT_X_TLS_TRY ;
1177 } else if ( ( strcasecmp( arg, "hard" ) == 0 ) ||
1178 ( strcasecmp( arg, "on" ) == 0 ) ||
1179 ( strcasecmp( arg, "yes" ) == 0) ||
1180 ( strcasecmp( arg, "true" ) == 0 ) )
1182 i = LDAP_OPT_X_TLS_HARD ;
1186 return ldap_pvt_tls_set_option( ld, option, &i );
1195 ldap_pvt_tls_get_option( LDAP *ld, int option, void *arg )
1197 struct ldapoptions *lo;
1200 assert( LDAP_VALID( ld ) );
1202 if( !LDAP_VALID( ld ) ) {
1203 return LDAP_OPT_ERROR;
1206 lo = &ld->ld_options;
1209 /* Get pointer to global option structure */
1210 lo = LDAP_INT_GLOBAL_OPT();
1212 return LDAP_NO_MEMORY;
1217 case LDAP_OPT_X_TLS:
1218 *(int *)arg = lo->ldo_tls_mode;
1220 case LDAP_OPT_X_TLS_CTX:
1222 *(void **)arg = (void *) tls_def_ctx;
1224 *(void **)arg = ld->ld_defconn->lconn_tls_ctx;
1227 case LDAP_OPT_X_TLS_CACERTFILE:
1228 *(char **)arg = tls_opt_cacertfile ?
1229 LDAP_STRDUP( tls_opt_cacertfile ) : NULL;
1231 case LDAP_OPT_X_TLS_CACERTDIR:
1232 *(char **)arg = tls_opt_cacertdir ?
1233 LDAP_STRDUP( tls_opt_cacertdir ) : NULL;
1235 case LDAP_OPT_X_TLS_CERTFILE:
1236 *(char **)arg = tls_opt_certfile ?
1237 LDAP_STRDUP( tls_opt_certfile ) : NULL;
1239 case LDAP_OPT_X_TLS_KEYFILE:
1240 *(char **)arg = tls_opt_keyfile ?
1241 LDAP_STRDUP( tls_opt_keyfile ) : NULL;
1243 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1244 *(int *)arg = tls_opt_require_cert;
1246 case LDAP_OPT_X_TLS_RANDOM_FILE:
1247 *(char **)arg = tls_opt_randfile ?
1248 LDAP_STRDUP( tls_opt_randfile ) : NULL;
1250 case LDAP_OPT_X_TLS_SSL_CTX: {
1253 LDAPConn *conn = ld->ld_defconn;
1254 if ( conn != NULL ) {
1255 Sockbuf *sb = conn->lconn_sb;
1256 retval = ldap_pvt_tls_sb_ctx( sb );
1259 *(void **)arg = retval;
1269 ldap_pvt_tls_set_option( LDAP *ld, int option, void *arg )
1271 struct ldapoptions *lo;
1274 assert( LDAP_VALID( ld ) );
1276 if( !LDAP_VALID( ld ) ) {
1277 return LDAP_OPT_ERROR;
1280 lo = &ld->ld_options;
1283 /* Get pointer to global option structure */
1284 lo = LDAP_INT_GLOBAL_OPT();
1286 return LDAP_NO_MEMORY;
1291 case LDAP_OPT_X_TLS:
1292 switch( *(int *) arg ) {
1293 case LDAP_OPT_X_TLS_NEVER:
1294 case LDAP_OPT_X_TLS_DEMAND:
1295 case LDAP_OPT_X_TLS_ALLOW:
1296 case LDAP_OPT_X_TLS_TRY:
1297 case LDAP_OPT_X_TLS_HARD:
1299 lo->ldo_tls_mode = *(int *)arg;
1306 case LDAP_OPT_X_TLS_CTX:
1308 tls_def_ctx = (SSL_CTX *) arg;
1311 ld->ld_defconn->lconn_tls_ctx = arg;
1321 case LDAP_OPT_X_TLS_CACERTFILE:
1322 if ( tls_opt_cacertfile ) LDAP_FREE( tls_opt_cacertfile );
1323 tls_opt_cacertfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1325 case LDAP_OPT_X_TLS_CACERTDIR:
1326 if ( tls_opt_cacertdir ) LDAP_FREE( tls_opt_cacertdir );
1327 tls_opt_cacertdir = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1329 case LDAP_OPT_X_TLS_CERTFILE:
1330 if ( tls_opt_certfile ) LDAP_FREE( tls_opt_certfile );
1331 tls_opt_certfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1333 case LDAP_OPT_X_TLS_KEYFILE:
1334 if ( tls_opt_keyfile ) LDAP_FREE( tls_opt_keyfile );
1335 tls_opt_keyfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1337 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1338 switch( *(int *) arg ) {
1339 case LDAP_OPT_X_TLS_NEVER:
1340 case LDAP_OPT_X_TLS_DEMAND:
1341 case LDAP_OPT_X_TLS_ALLOW:
1342 case LDAP_OPT_X_TLS_TRY:
1343 case LDAP_OPT_X_TLS_HARD:
1344 tls_opt_require_cert = * (int *) arg;
1348 case LDAP_OPT_X_TLS_CIPHER_SUITE:
1349 if ( tls_opt_ciphersuite ) LDAP_FREE( tls_opt_ciphersuite );
1350 tls_opt_ciphersuite = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1352 case LDAP_OPT_X_TLS_RANDOM_FILE:
1353 if (tls_opt_randfile ) LDAP_FREE (tls_opt_randfile );
1354 tls_opt_randfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1363 ldap_int_tls_start ( LDAP *ld, LDAPConn *conn, LDAPURLDesc *srv )
1365 Sockbuf *sb = conn->lconn_sb;
1370 host = srv->lud_host;
1372 host = conn->lconn_server->lud_host;
1375 /* avoid NULL host */
1376 if( host == NULL ) {
1380 (void) ldap_pvt_tls_init();
1383 * Fortunately, the lib uses blocking io...
1385 if ( ldap_int_tls_connect( ld, conn ) < 0 ) {
1386 ld->ld_errno = LDAP_CONNECT_ERROR;
1387 return (ld->ld_errno);
1390 ssl = ldap_pvt_tls_sb_ctx( sb );
1391 assert( ssl != NULL );
1394 * compare host with name(s) in certificate
1396 if (tls_opt_require_cert != LDAP_OPT_X_TLS_NEVER) {
1397 ld->ld_errno = ldap_pvt_tls_check_hostname( ld, ssl, host );
1398 if (ld->ld_errno != LDAP_SUCCESS) {
1399 return ld->ld_errno;
1404 * set SASL properties to TLS ssf and authid
1407 struct berval authid = { 0, NULL };
1410 /* we need to let SASL know */
1411 ssf = ldap_pvt_tls_get_strength( ssl );
1412 /* failure is OK, we just can't use SASL EXTERNAL */
1413 (void) ldap_pvt_tls_get_my_dn( ssl, &authid, NULL, 0 );
1415 (void) ldap_int_sasl_external( ld, conn, authid.bv_val, ssf );
1416 LDAP_FREE( authid.bv_val );
1419 return LDAP_SUCCESS;
1422 /* Derived from openssl/apps/s_cb.c */
1424 tls_info_cb( const SSL *ssl, int where, int ret )
1428 char *state = (char *) SSL_state_string_long( (SSL *)ssl );
1430 w = where & ~SSL_ST_MASK;
1431 if ( w & SSL_ST_CONNECT ) {
1433 } else if ( w & SSL_ST_ACCEPT ) {
1441 state = LDAP_STRDUP( state );
1445 if ( where & SSL_CB_LOOP ) {
1447 LDAP_LOG ( TRANSPORT, DETAIL1, "tls_info_cb: "
1448 "TLS trace: %s:%s\n", op, state, 0 );
1450 Debug( LDAP_DEBUG_TRACE,
1451 "TLS trace: %s:%s\n",
1455 } else if ( where & SSL_CB_ALERT ) {
1456 char *atype = (char *) SSL_alert_type_string_long( ret );
1457 char *adesc = (char *) SSL_alert_desc_string_long( ret );
1458 op = ( where & SSL_CB_READ ) ? "read" : "write";
1461 atype = LDAP_STRDUP( atype );
1465 adesc = LDAP_STRDUP( adesc );
1470 LDAP_LOG ( TRANSPORT, DETAIL1,
1471 "tls_info_cb: TLS trace: SSL3 alert %s:%s:%s\n",
1474 Debug( LDAP_DEBUG_TRACE,
1475 "TLS trace: SSL3 alert %s:%s:%s\n",
1479 if ( atype ) LDAP_FREE( atype );
1480 if ( adesc ) LDAP_FREE( adesc );
1482 } else if ( where & SSL_CB_EXIT ) {
1485 LDAP_LOG ( TRANSPORT, ERR,
1486 "tls_info_cb: TLS trace: %s:failed in %s\n",
1489 Debug( LDAP_DEBUG_TRACE,
1490 "TLS trace: %s:failed in %s\n",
1493 } else if ( ret < 0 ) {
1495 LDAP_LOG ( TRANSPORT, ERR,
1496 "tls_info_cb: TLS trace: %s:error in %s\n",
1499 Debug( LDAP_DEBUG_TRACE,
1500 "TLS trace: %s:error in %s\n",
1506 if ( state ) LDAP_FREE( state );
1511 tls_verify_cb( int ok, X509_STORE_CTX *ctx )
1520 char *certerr = NULL;
1522 cert = X509_STORE_CTX_get_current_cert( ctx );
1523 errnum = X509_STORE_CTX_get_error( ctx );
1524 errdepth = X509_STORE_CTX_get_error_depth( ctx );
1527 * X509_get_*_name return pointers to the internal copies of
1528 * those things requested. So do not free them.
1530 subject = X509_get_subject_name( cert );
1531 issuer = X509_get_issuer_name( cert );
1532 /* X509_NAME_oneline, if passed a NULL buf, allocate memomry */
1533 sname = X509_NAME_oneline( subject, NULL, 0 );
1534 iname = X509_NAME_oneline( issuer, NULL, 0 );
1535 if ( !ok ) certerr = (char *)X509_verify_cert_error_string( errnum );
1537 if ( sname ) __etoa( sname );
1538 if ( iname ) __etoa( iname );
1540 certerr = LDAP_STRDUP( certerr );
1545 LDAP_LOG( TRANSPORT, ERR,
1546 "TLS certificate verification: depth: %d, err: %d, subject: %s,",
1548 sname ? sname : "-unknown-" );
1549 LDAP_LOG( TRANSPORT, ERR, " issuer: %s\n", iname ? iname : "-unknown-", 0, 0 );
1551 LDAP_LOG ( TRANSPORT, ERR,
1552 "TLS certificate verification: Error, %s\n",
1556 Debug( LDAP_DEBUG_TRACE,
1557 "TLS certificate verification: depth: %d, err: %d, subject: %s,",
1559 sname ? sname : "-unknown-" );
1560 Debug( LDAP_DEBUG_TRACE, " issuer: %s\n", iname ? iname : "-unknown-", 0, 0 );
1562 Debug( LDAP_DEBUG_ANY,
1563 "TLS certificate verification: Error, %s\n",
1568 CRYPTO_free ( sname );
1570 CRYPTO_free ( iname );
1572 if ( certerr ) LDAP_FREE( certerr );
1578 tls_verify_ok( int ok, X509_STORE_CTX *ctx )
1580 (void) tls_verify_cb( ok, ctx );
1584 /* Inspired by ERR_print_errors in OpenSSL */
1586 tls_report_error( void )
1593 while ( ( l = ERR_get_error_line( &file, &line ) ) != 0 ) {
1594 ERR_error_string_n( l, buf, sizeof( buf ) );
1597 file = LDAP_STRDUP( file );
1598 __etoa( (char *)file );
1603 LDAP_LOG ( TRANSPORT, ERR,
1604 "tls_report_error: TLS %s %s:%d\n",
1607 Debug( LDAP_DEBUG_ANY, "TLS: %s %s:%d\n",
1611 if ( file ) LDAP_FREE( (void *)file );
1617 tls_tmp_rsa_cb( SSL *ssl, int is_export, int key_length )
1621 /* FIXME: Pregenerate the key on startup */
1622 /* FIXME: Who frees the key? */
1623 tmp_rsa = RSA_generate_key( key_length, RSA_F4, NULL, NULL );
1627 LDAP_LOG ( TRANSPORT, ERR,
1628 "tls_tmp_rsa_cb: TLS Failed to generate temporary %d-bit %s "
1629 "RSA key\n", key_length, is_export ? "export" : "domestic", 0 );
1631 Debug( LDAP_DEBUG_ANY,
1632 "TLS: Failed to generate temporary %d-bit %s RSA key\n",
1633 key_length, is_export ? "export" : "domestic", 0 );
1641 tls_seed_PRNG( const char *randfile )
1643 #ifndef URANDOM_DEVICE
1644 /* no /dev/urandom (or equiv) */
1646 char buffer[MAXPATHLEN];
1648 if (randfile == NULL) {
1649 /* The seed file is $RANDFILE if defined, otherwise $HOME/.rnd.
1650 * If $HOME is not set or buffer too small to hold the pathname,
1651 * an error occurs. - From RAND_file_name() man page.
1652 * The fact is that when $HOME is NULL, .rnd is used.
1654 randfile = RAND_file_name( buffer, sizeof( buffer ) );
1656 } else if (RAND_egd(randfile) > 0) {
1661 if (randfile == NULL) {
1663 LDAP_LOG ( TRANSPORT, DETAIL1,
1664 "tls_seed_PRNG: TLS Use configuration file or "
1665 "$RANDFILE to define seed PRNG\n", 0, 0, 0 );
1667 Debug( LDAP_DEBUG_ANY,
1668 "TLS: Use configuration file or $RANDFILE to define seed PRNG\n",
1674 total = RAND_load_file(randfile, -1);
1676 if (RAND_status() == 0) {
1678 LDAP_LOG ( TRANSPORT, DETAIL1,
1679 "tls_seed_PRNG: TLS PRNG not been seeded with enough data\n",
1682 Debug( LDAP_DEBUG_ANY,
1683 "TLS: PRNG not been seeded with enough data\n",
1689 /* assume if there was enough bits to seed that it's okay
1690 * to write derived bits to the file
1692 RAND_write_file(randfile);
1701 tls_tmp_dh_cb( SSL *ssl, int is_export, int key_length )
1709 ldap_start_tls_s ( LDAP *ld,
1710 LDAPControl **serverctrls,
1711 LDAPControl **clientctrls )
1716 char *rspoid = NULL;
1717 struct berval *rspdata = NULL;
1719 /* XXYYZ: this initiates operation only on default connection! */
1721 if ( ld->ld_sb != NULL && ldap_pvt_tls_inplace( ld->ld_sb ) != 0 ) {
1722 return LDAP_LOCAL_ERROR;
1725 rc = ldap_extended_operation_s( ld, LDAP_EXOP_START_TLS,
1726 NULL, serverctrls, clientctrls, &rspoid, &rspdata );
1727 if ( rc != LDAP_SUCCESS ) {
1731 if ( rspoid != NULL ) {
1735 if ( rspdata != NULL ) {
1736 ber_bvfree( rspdata );
1739 rc = ldap_int_tls_start( ld, ld->ld_defconn, NULL );
1741 rc = LDAP_NOT_SUPPORTED;