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);
118 if ( tls_opt_certfile ) {
119 LDAP_FREE( tls_opt_certfile );
120 tls_opt_certfile = NULL;
122 if ( tls_opt_keyfile ) {
123 LDAP_FREE( tls_opt_keyfile );
124 tls_opt_keyfile = NULL;
126 if ( tls_opt_cacertfile ) {
127 LDAP_FREE( tls_opt_cacertfile );
128 tls_opt_cacertfile = NULL;
130 if ( tls_opt_cacertdir ) {
131 LDAP_FREE( tls_opt_cacertdir );
132 tls_opt_cacertdir = NULL;
134 if ( tls_opt_ciphersuite ) {
135 LDAP_FREE( tls_opt_ciphersuite );
136 tls_opt_ciphersuite = NULL;
138 if ( tls_opt_randfile ) {
139 LDAP_FREE( tls_opt_randfile );
140 tls_opt_randfile = NULL;
145 * Initialize TLS subsystem. Should be called only once.
148 ldap_pvt_tls_init( void )
150 static int tls_initialized = 0;
152 if ( tls_initialized ) return 0;
157 char *file = LDAP_STRDUP( tls_opt_randfile );
158 if ( file ) __atoe( file );
159 (void) tls_seed_PRNG( file );
163 (void) tls_seed_PRNG( tls_opt_randfile );
166 #ifdef LDAP_R_COMPILE
170 SSL_load_error_strings();
171 SSLeay_add_ssl_algorithms();
173 /* FIXME: mod_ssl does this */
174 X509V3_add_standard_extensions();
179 * initialize the default context
182 ldap_pvt_tls_init_def_ctx( void )
184 STACK_OF(X509_NAME) *calist;
186 char *ciphersuite = tls_opt_ciphersuite;
187 char *cacertfile = tls_opt_cacertfile;
188 char *cacertdir = tls_opt_cacertdir;
189 char *certfile = tls_opt_certfile;
190 char *keyfile = tls_opt_keyfile;
193 /* This ASCII/EBCDIC handling is a real pain! */
195 ciphersuite = LDAP_STRDUP( ciphersuite );
196 __atoe( ciphersuite );
199 cacertfile = LDAP_STRDUP( cacertfile );
200 __atoe( cacertfile );
203 cacertdir = LDAP_STRDUP( cacertdir );
207 certfile = LDAP_STRDUP( certfile );
211 keyfile = LDAP_STRDUP( keyfile );
216 #ifdef LDAP_R_COMPILE
217 ldap_pvt_thread_mutex_lock( &tls_def_ctx_mutex );
219 if ( tls_def_ctx == NULL ) {
221 tls_def_ctx = SSL_CTX_new( SSLv23_method() );
222 if ( tls_def_ctx == NULL ) {
224 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
225 "TLS could not allocate default ctx (%d).\n",
226 ERR_peek_error(), 0, 0 );
228 Debug( LDAP_DEBUG_ANY,
229 "TLS: could not allocate default ctx (%lu).\n",
230 ERR_peek_error(),0,0);
236 SSL_CTX_set_session_id_context( tls_def_ctx,
237 (const unsigned char *) "OpenLDAP", sizeof("OpenLDAP")-1 );
239 if ( tls_opt_ciphersuite &&
240 !SSL_CTX_set_cipher_list( tls_def_ctx, ciphersuite ) )
243 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
244 "TLS could not set cipher list %s.\n",
245 tls_opt_ciphersuite, 0, 0 );
247 Debug( LDAP_DEBUG_ANY,
248 "TLS: could not set cipher list %s.\n",
249 tls_opt_ciphersuite, 0, 0 );
256 if (tls_opt_cacertfile != NULL || tls_opt_cacertdir != NULL) {
257 if ( !SSL_CTX_load_verify_locations( tls_def_ctx,
258 cacertfile, cacertdir ) ||
259 !SSL_CTX_set_default_verify_paths( tls_def_ctx ) )
262 LDAP_LOG ( TRANSPORT, ERR,
263 "ldap_pvt_tls_init_def_ctx: "
264 "TLS could not load verify locations "
265 "(file:`%s',dir:`%s').\n",
266 tls_opt_cacertfile ? tls_opt_cacertfile : "",
267 tls_opt_cacertdir ? tls_opt_cacertdir : "", 0 );
269 Debug( LDAP_DEBUG_ANY, "TLS: "
270 "could not load verify locations (file:`%s',dir:`%s').\n",
271 tls_opt_cacertfile ? tls_opt_cacertfile : "",
272 tls_opt_cacertdir ? tls_opt_cacertdir : "",
280 calist = get_ca_list( cacertfile, cacertdir );
283 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
284 "TLS could not load client CA list (file: `%s',dir:`%s')\n",
285 tls_opt_cacertfile ? tls_opt_cacertfile : "",
286 tls_opt_cacertdir ? tls_opt_cacertdir : "", 0 );
288 Debug( LDAP_DEBUG_ANY, "TLS: "
289 "could not load client CA list (file:`%s',dir:`%s').\n",
290 tls_opt_cacertfile ? tls_opt_cacertfile : "",
291 tls_opt_cacertdir ? tls_opt_cacertdir : "",
299 SSL_CTX_set_client_CA_list( tls_def_ctx, calist );
302 if ( tls_opt_keyfile &&
303 !SSL_CTX_use_PrivateKey_file( tls_def_ctx,
304 keyfile, SSL_FILETYPE_PEM ) )
307 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
308 "TLS could not use key file `%s'.\n", tls_opt_keyfile, 0, 0 );
310 Debug( LDAP_DEBUG_ANY,
311 "TLS: could not use key file `%s'.\n",
312 tls_opt_keyfile,0,0);
319 if ( tls_opt_certfile &&
320 !SSL_CTX_use_certificate_file( tls_def_ctx,
321 certfile, SSL_FILETYPE_PEM ) )
324 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
325 "TLS could not use certificate `%s'.\n",
326 tls_opt_certfile, 0, 0 );
328 Debug( LDAP_DEBUG_ANY,
329 "TLS: could not use certificate `%s'.\n",
330 tls_opt_certfile,0,0);
337 if ( ( tls_opt_certfile || tls_opt_keyfile ) &&
338 !SSL_CTX_check_private_key( tls_def_ctx ) )
341 LDAP_LOG ( TRANSPORT, ERR,
342 "ldap_pvt_tls_init_def_ctx: TLS private key mismatch.\n",
345 Debug( LDAP_DEBUG_ANY,
346 "TLS: private key mismatch.\n",
354 if ( tls_opt_trace ) {
355 SSL_CTX_set_info_callback( tls_def_ctx, tls_info_cb );
359 if ( tls_opt_require_cert ) {
361 if ( tls_opt_require_cert == LDAP_OPT_X_TLS_DEMAND ||
362 tls_opt_require_cert == LDAP_OPT_X_TLS_HARD ) {
363 i |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
367 SSL_CTX_set_verify( tls_def_ctx, i,
368 tls_opt_require_cert == LDAP_OPT_X_TLS_ALLOW ?
369 tls_verify_ok : tls_verify_cb );
370 SSL_CTX_set_tmp_rsa_callback( tls_def_ctx, tls_tmp_rsa_cb );
371 /* SSL_CTX_set_tmp_dh_callback( tls_def_ctx, tls_tmp_dh_cb ); */
374 if ( rc == -1 && tls_def_ctx != NULL ) {
375 SSL_CTX_free( tls_def_ctx );
379 LDAP_FREE( ciphersuite );
380 LDAP_FREE( cacertfile );
381 LDAP_FREE( cacertdir );
382 LDAP_FREE( certfile );
383 LDAP_FREE( keyfile );
385 #ifdef LDAP_R_COMPILE
386 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
391 static STACK_OF(X509_NAME) *
392 get_ca_list( char * bundle, char * dir )
394 STACK_OF(X509_NAME) *ca_list = NULL;
397 ca_list = SSL_load_client_CA_file( bundle );
399 #if defined(HAVE_DIRENT_H) || defined(dirent)
404 ca_list = sk_X509_NAME_new_null();
407 if ( !SSL_add_dir_cert_subjects_to_stack( ca_list, dir ) &&
409 sk_X509_NAME_free( ca_list );
418 alloc_handle( void *ctx_arg )
424 ctx = (SSL_CTX *) ctx_arg;
426 if ( ldap_pvt_tls_init_def_ctx() < 0 ) return NULL;
430 ssl = SSL_new( ctx );
433 LDAP_LOG ( TRANSPORT, ERR,
434 "alloc_handle: TLS can't create ssl handle.\n", 0, 0, 0 );
436 Debug( LDAP_DEBUG_ANY,"TLS: can't create ssl handle.\n",0,0,0);
444 update_flags( Sockbuf *sb, SSL * ssl, int rc )
446 int err = SSL_get_error(ssl, rc);
448 sb->sb_trans_needs_read = 0;
449 sb->sb_trans_needs_write = 0;
451 if (err == SSL_ERROR_WANT_READ) {
452 sb->sb_trans_needs_read = 1;
455 } else if (err == SSL_ERROR_WANT_WRITE) {
456 sb->sb_trans_needs_write = 1;
459 } else if (err == SSL_ERROR_WANT_CONNECT) {
466 * TLS support for LBER Sockbufs
471 Sockbuf_IO_Desc *sbiod;
474 static BIO_METHOD sb_tls_bio_method;
477 sb_tls_setup( Sockbuf_IO_Desc *sbiod, void *arg )
482 assert( sbiod != NULL );
484 p = LBER_MALLOC( sizeof( *p ) );
491 bio = BIO_new( &sb_tls_bio_method );
492 bio->ptr = (void *)p;
493 SSL_set_bio( p->ssl, bio, bio );
494 sbiod->sbiod_pvt = p;
499 sb_tls_remove( Sockbuf_IO_Desc *sbiod )
503 assert( sbiod != NULL );
504 assert( sbiod->sbiod_pvt != NULL );
506 p = (struct tls_data *)sbiod->sbiod_pvt;
508 LBER_FREE( sbiod->sbiod_pvt );
509 sbiod->sbiod_pvt = NULL;
514 sb_tls_close( Sockbuf_IO_Desc *sbiod )
518 assert( sbiod != NULL );
519 assert( sbiod->sbiod_pvt != NULL );
521 p = (struct tls_data *)sbiod->sbiod_pvt;
522 SSL_shutdown( p->ssl );
527 sb_tls_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
531 assert( sbiod != NULL );
532 assert( sbiod->sbiod_pvt != NULL );
534 p = (struct tls_data *)sbiod->sbiod_pvt;
536 if ( opt == LBER_SB_OPT_GET_SSL ) {
537 *((SSL **)arg) = p->ssl;
540 } else if ( opt == LBER_SB_OPT_DATA_READY ) {
541 if( SSL_pending( p->ssl ) > 0 ) {
546 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
550 sb_tls_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
556 assert( sbiod != NULL );
557 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
559 p = (struct tls_data *)sbiod->sbiod_pvt;
561 ret = SSL_read( p->ssl, (char *)buf, len );
563 errno = WSAGetLastError();
565 err = SSL_get_error( p->ssl, ret );
566 if (err == SSL_ERROR_WANT_READ ) {
567 sbiod->sbiod_sb->sb_trans_needs_read = 1;
571 sbiod->sbiod_sb->sb_trans_needs_read = 0;
576 sb_tls_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
582 assert( sbiod != NULL );
583 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
585 p = (struct tls_data *)sbiod->sbiod_pvt;
587 ret = SSL_write( p->ssl, (char *)buf, len );
589 errno = WSAGetLastError();
591 err = SSL_get_error( p->ssl, ret );
592 if (err == SSL_ERROR_WANT_WRITE ) {
593 sbiod->sbiod_sb->sb_trans_needs_write = 1;
597 sbiod->sbiod_sb->sb_trans_needs_write = 0;
602 static Sockbuf_IO sb_tls_sbio =
604 sb_tls_setup, /* sbi_setup */
605 sb_tls_remove, /* sbi_remove */
606 sb_tls_ctrl, /* sbi_ctrl */
607 sb_tls_read, /* sbi_read */
608 sb_tls_write, /* sbi_write */
609 sb_tls_close /* sbi_close */
613 sb_tls_bio_create( BIO *b ) {
622 sb_tls_bio_destroy( BIO *b )
624 if ( b == NULL ) return 0;
626 b->ptr = NULL; /* sb_tls_remove() will free it */
633 sb_tls_bio_read( BIO *b, char *buf, int len )
638 if ( buf == NULL || len <= 0 ) return 0;
640 p = (struct tls_data *)b->ptr;
642 if ( p == NULL || p->sbiod == NULL ) {
646 ret = LBER_SBIOD_READ_NEXT( p->sbiod, buf, len );
648 BIO_clear_retry_flags( b );
651 if ( err == EAGAIN || err == EWOULDBLOCK ) {
652 BIO_set_retry_read( b );
660 sb_tls_bio_write( BIO *b, const char *buf, int len )
665 if ( buf == NULL || len <= 0 ) return 0;
667 p = (struct tls_data *)b->ptr;
669 if ( p == NULL || p->sbiod == NULL ) {
673 ret = LBER_SBIOD_WRITE_NEXT( p->sbiod, (char *)buf, len );
675 BIO_clear_retry_flags( b );
678 if ( err == EAGAIN || err == EWOULDBLOCK ) {
679 BIO_set_retry_write( b );
687 sb_tls_bio_ctrl( BIO *b, int cmd, long num, void *ptr )
689 if ( cmd == BIO_CTRL_FLUSH ) {
690 /* The OpenSSL library needs this */
697 sb_tls_bio_gets( BIO *b, char *buf, int len )
703 sb_tls_bio_puts( BIO *b, const char *str )
705 return sb_tls_bio_write( b, str, strlen( str ) );
708 static BIO_METHOD sb_tls_bio_method =
710 ( 100 | 0x400 ), /* it's a source/sink BIO */
722 * Call this to do a TLS connect on a sockbuf. ctx_arg can be
723 * a SSL_CTX * or NULL, in which case the default ctx is used.
727 * 0 - Success. Connection is ready for communication.
728 * <0 - Error. Can't create a TLS stream.
729 * >0 - Partial success.
730 * Do a select (using information from lber_pvt_sb_needs_{read,write}
735 ldap_int_tls_connect( LDAP *ld, LDAPConn *conn )
737 Sockbuf *sb = conn->lconn_sb;
741 if ( HAS_TLS( sb ) ) {
742 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
745 void *ctx = ld->ld_defconn
746 ? ld->ld_defconn->lconn_tls_ctx : NULL;
748 ssl = alloc_handle( ctx );
750 if ( ssl == NULL ) return -1;
753 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
754 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
756 ber_sockbuf_add_io( sb, &sb_tls_sbio,
757 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
760 conn->lconn_tls_ctx = tls_def_ctx;
764 err = SSL_connect( ssl );
767 errno = WSAGetLastError();
771 if ( update_flags( sb, ssl, err )) {
775 if ((err = ERR_peek_error())) {
777 ld->ld_error = LDAP_STRDUP(ERR_error_string(err, buf));
779 if ( ld->ld_error ) __etoa(ld->ld_error);
784 LDAP_LOG ( TRANSPORT, ERR,
785 "ldap_int_tls_connect: TLS can't connect.\n", 0, 0, 0 );
787 Debug( LDAP_DEBUG_ANY,"TLS: can't connect.\n",0,0,0);
790 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
791 LBER_SBIOD_LEVEL_TRANSPORT );
793 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
794 LBER_SBIOD_LEVEL_TRANSPORT );
803 * Call this to do a TLS accept on a sockbuf.
804 * Everything else is the same as with tls_connect.
807 ldap_pvt_tls_accept( Sockbuf *sb, void *ctx_arg )
812 if ( HAS_TLS( sb ) ) {
813 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
816 ssl = alloc_handle( ctx_arg );
817 if ( ssl == NULL ) return -1;
820 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
821 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
823 ber_sockbuf_add_io( sb, &sb_tls_sbio,
824 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
827 err = SSL_accept( ssl );
830 errno = WSAGetLastError();
833 if ( update_flags( sb, ssl, err )) return 1;
836 LDAP_LOG ( TRANSPORT, ERR,
837 "ldap_pvt_tls_accept: TLS can't accept.\n", 0, 0, 0 );
839 Debug( LDAP_DEBUG_ANY,"TLS: can't accept.\n",0,0,0 );
843 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
844 LBER_SBIOD_LEVEL_TRANSPORT );
846 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
847 LBER_SBIOD_LEVEL_TRANSPORT );
856 ldap_pvt_tls_inplace ( Sockbuf *sb )
858 return HAS_TLS( sb ) ? 1 : 0;
862 tls_get_cert( SSL *s )
864 /* If peer cert was bad, treat as if no cert was given */
865 if (SSL_get_verify_result(s)) {
866 /* If we can send an alert, do so */
867 if (SSL_version(s) != SSL2_VERSION) {
868 ssl3_send_alert(s,SSL3_AL_WARNING,SSL3_AD_BAD_CERTIFICATE);
872 return SSL_get_peer_certificate(s);
876 ldap_pvt_tls_get_peer_dn( void *s, struct berval *dn, LDAPDN_rewrite_dummy *func, unsigned flags )
882 x = tls_get_cert((SSL *)s);
884 if (!x) return LDAP_INVALID_CREDENTIALS;
886 xn = X509_get_subject_name(x);
887 rc = ldap_X509dn2bv(xn, dn, (LDAPDN_rewrite_func *)func, flags);
893 ldap_pvt_tls_get_peer_hostname( void *s )
900 x = tls_get_cert((SSL *)s);
903 xn = X509_get_subject_name(x);
905 ret = X509_NAME_get_text_by_NID(xn, NID_commonName, buf, sizeof(buf));
911 p = LDAP_STRDUP(buf);
916 /* what kind of hostname were we given? */
922 ldap_pvt_tls_check_hostname( LDAP *ld, void *s, const char *name_in )
924 int i, ret = LDAP_LOCAL_ERROR;
930 struct in6_addr addr;
935 if( ldap_int_hostname &&
936 ( !name_in || !strcasecmp( name_in, "localhost" ) ) )
938 name = ldap_int_hostname;
943 x = tls_get_cert((SSL *)s);
946 LDAP_LOG ( TRANSPORT, ERR,
947 "ldap_pvt_tls_check_hostname: "
948 "TLS unable to get peer certificate.\n" , 0, 0, 0 );
950 Debug( LDAP_DEBUG_ANY,
951 "TLS: unable to get peer certificate.\n",
954 /* If this was a fatal condition, things would have
955 * aborted long before now.
961 if (name[0] == '[' && strchr(name, ']')) {
962 char *n2 = ldap_strdup(name+1);
963 *strchr(n2, ']') = 2;
964 if (inet_pton(AF_INET6, n2, &addr))
969 if ((ptr = strrchr(name, '.')) && isdigit((unsigned char)ptr[1])) {
970 if (inet_aton(name, (struct in_addr *)&addr))
974 i = X509_get_ext_by_NID(x, NID_subject_alt_name, -1);
977 STACK_OF(GENERAL_NAME) *alt;
979 ex = X509_get_ext(x, i);
980 alt = X509V3_EXT_d2i(ex);
982 int n, len1 = 0, len2 = 0;
986 if (ntype == IS_DNS) {
988 domain = strchr(name, '.');
990 len2 = len1 - (domain-name);
993 n = sk_GENERAL_NAME_num(alt);
994 for (i=0; i<n; i++) {
997 gn = sk_GENERAL_NAME_value(alt, i);
998 if (gn->type == GEN_DNS) {
999 if (ntype != IS_DNS) continue;
1001 sn = (char *) ASN1_STRING_data(gn->d.ia5);
1002 sl = ASN1_STRING_length(gn->d.ia5);
1004 /* Is this an exact match? */
1005 if ((len1 == sl) && !strncasecmp(name, sn, len1)) {
1009 /* Is this a wildcard match? */
1010 if ((*sn == '*') && domain && (len2 == sl-1) &&
1011 !strncasecmp(domain, sn+1, len2)) {
1016 /* Is this a RFC 2459 style wildcard match? */
1017 if ((*sn == '.') && domain && (len2 == sl) &&
1018 !strncasecmp(domain, sn, len2)) {
1022 } else if (gn->type == GEN_IPADD) {
1023 if (ntype == IS_DNS) continue;
1025 sn = (char *) ASN1_STRING_data(gn->d.ia5);
1026 sl = ASN1_STRING_length(gn->d.ia5);
1028 #ifdef LDAP_PF_INET6
1029 if (ntype == IS_IP6 && sl != sizeof(struct in6_addr)) {
1033 if (ntype == IS_IP4 && sl != sizeof(struct in_addr)) {
1036 if (!memcmp(sn, &addr, sl)) {
1042 GENERAL_NAMES_free(alt);
1043 if (i < n) { /* Found a match */
1049 if (ret != LDAP_SUCCESS) {
1053 xn = X509_get_subject_name(x);
1055 if( X509_NAME_get_text_by_NID( xn, NID_commonName,
1056 buf, sizeof(buf)) == -1)
1059 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_check_hostname: "
1060 "TLS unable to get common name from peer certificate.\n",
1063 Debug( LDAP_DEBUG_ANY,
1064 "TLS: unable to get common name from peer certificate.\n",
1067 ld->ld_error = LDAP_STRDUP(
1068 _("TLS: unable to get CN from peer certificate"));
1070 } else if (strcasecmp(name, buf)) {
1072 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_check_hostname: "
1073 "TLS hostname (%s) does not match "
1074 "common name in certificate (%s).\n", name, buf, 0 );
1076 Debug( LDAP_DEBUG_ANY, "TLS: hostname (%s) does not match "
1077 "common name in certificate (%s).\n",
1080 ret = LDAP_CONNECT_ERROR;
1081 ld->ld_error = LDAP_STRDUP(
1082 _("TLS: hostname does not match CN in peer certificate"));
1093 ldap_pvt_tls_get_peer_issuer( void *s )
1095 #if 0 /* currently unused; see ldap_pvt_tls_get_peer_dn() if needed */
1100 x = SSL_get_peer_certificate((SSL *)s);
1102 if (!x) return NULL;
1104 xn = X509_get_issuer_name(x);
1105 p = LDAP_STRDUP(X509_NAME_oneline(xn, buf, sizeof(buf)));
1114 ldap_int_tls_config( LDAP *ld, int option, const char *arg )
1119 case LDAP_OPT_X_TLS_CACERTFILE:
1120 case LDAP_OPT_X_TLS_CACERTDIR:
1121 case LDAP_OPT_X_TLS_CERTFILE:
1122 case LDAP_OPT_X_TLS_KEYFILE:
1123 case LDAP_OPT_X_TLS_RANDOM_FILE:
1124 return ldap_pvt_tls_set_option( ld, option, (void *) arg );
1126 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1127 case LDAP_OPT_X_TLS:
1129 if ( strcasecmp( arg, "never" ) == 0 ) {
1130 i = LDAP_OPT_X_TLS_NEVER ;
1132 } else if ( strcasecmp( arg, "demand" ) == 0 ) {
1133 i = LDAP_OPT_X_TLS_DEMAND ;
1135 } else if ( strcasecmp( arg, "allow" ) == 0 ) {
1136 i = LDAP_OPT_X_TLS_ALLOW ;
1138 } else if ( strcasecmp( arg, "try" ) == 0 ) {
1139 i = LDAP_OPT_X_TLS_TRY ;
1141 } else if ( ( strcasecmp( arg, "hard" ) == 0 ) ||
1142 ( strcasecmp( arg, "on" ) == 0 ) ||
1143 ( strcasecmp( arg, "yes" ) == 0) ||
1144 ( strcasecmp( arg, "true" ) == 0 ) )
1146 i = LDAP_OPT_X_TLS_HARD ;
1150 return ldap_pvt_tls_set_option( ld, option, &i );
1159 ldap_pvt_tls_get_option( LDAP *ld, int option, void *arg )
1161 struct ldapoptions *lo;
1164 assert( LDAP_VALID( ld ) );
1166 if( !LDAP_VALID( ld ) ) {
1167 return LDAP_OPT_ERROR;
1170 lo = &ld->ld_options;
1173 /* Get pointer to global option structure */
1174 lo = LDAP_INT_GLOBAL_OPT();
1176 return LDAP_NO_MEMORY;
1181 case LDAP_OPT_X_TLS:
1182 *(int *)arg = lo->ldo_tls_mode;
1184 case LDAP_OPT_X_TLS_CTX:
1186 *(void **)arg = (void *) tls_def_ctx;
1188 *(void **)arg = ld->ld_defconn->lconn_tls_ctx;
1191 case LDAP_OPT_X_TLS_CACERTFILE:
1192 *(char **)arg = tls_opt_cacertfile ?
1193 LDAP_STRDUP( tls_opt_cacertfile ) : NULL;
1195 case LDAP_OPT_X_TLS_CACERTDIR:
1196 *(char **)arg = tls_opt_cacertdir ?
1197 LDAP_STRDUP( tls_opt_cacertdir ) : NULL;
1199 case LDAP_OPT_X_TLS_CERTFILE:
1200 *(char **)arg = tls_opt_certfile ?
1201 LDAP_STRDUP( tls_opt_certfile ) : NULL;
1203 case LDAP_OPT_X_TLS_KEYFILE:
1204 *(char **)arg = tls_opt_keyfile ?
1205 LDAP_STRDUP( tls_opt_keyfile ) : NULL;
1207 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1208 *(int *)arg = tls_opt_require_cert;
1210 case LDAP_OPT_X_TLS_RANDOM_FILE:
1211 *(char **)arg = tls_opt_randfile ?
1212 LDAP_STRDUP( tls_opt_randfile ) : NULL;
1214 case LDAP_OPT_X_TLS_SSL_CTX: {
1217 LDAPConn *conn = ld->ld_defconn;
1218 if ( conn != NULL ) {
1219 Sockbuf *sb = conn->lconn_sb;
1220 retval = ldap_pvt_tls_sb_ctx( sb );
1223 *(void **)arg = retval;
1233 ldap_pvt_tls_set_option( LDAP *ld, int option, void *arg )
1235 struct ldapoptions *lo;
1238 assert( LDAP_VALID( ld ) );
1240 if( !LDAP_VALID( ld ) ) {
1241 return LDAP_OPT_ERROR;
1244 lo = &ld->ld_options;
1247 /* Get pointer to global option structure */
1248 lo = LDAP_INT_GLOBAL_OPT();
1250 return LDAP_NO_MEMORY;
1255 case LDAP_OPT_X_TLS:
1256 switch( *(int *) arg ) {
1257 case LDAP_OPT_X_TLS_NEVER:
1258 case LDAP_OPT_X_TLS_DEMAND:
1259 case LDAP_OPT_X_TLS_ALLOW:
1260 case LDAP_OPT_X_TLS_TRY:
1261 case LDAP_OPT_X_TLS_HARD:
1263 lo->ldo_tls_mode = *(int *)arg;
1270 case LDAP_OPT_X_TLS_CTX:
1272 tls_def_ctx = (SSL_CTX *) arg;
1275 ld->ld_defconn->lconn_tls_ctx = arg;
1285 case LDAP_OPT_X_TLS_CACERTFILE:
1286 if ( tls_opt_cacertfile ) LDAP_FREE( tls_opt_cacertfile );
1287 tls_opt_cacertfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1289 case LDAP_OPT_X_TLS_CACERTDIR:
1290 if ( tls_opt_cacertdir ) LDAP_FREE( tls_opt_cacertdir );
1291 tls_opt_cacertdir = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1293 case LDAP_OPT_X_TLS_CERTFILE:
1294 if ( tls_opt_certfile ) LDAP_FREE( tls_opt_certfile );
1295 tls_opt_certfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1297 case LDAP_OPT_X_TLS_KEYFILE:
1298 if ( tls_opt_keyfile ) LDAP_FREE( tls_opt_keyfile );
1299 tls_opt_keyfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1301 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1302 switch( *(int *) arg ) {
1303 case LDAP_OPT_X_TLS_NEVER:
1304 case LDAP_OPT_X_TLS_DEMAND:
1305 case LDAP_OPT_X_TLS_ALLOW:
1306 case LDAP_OPT_X_TLS_TRY:
1307 case LDAP_OPT_X_TLS_HARD:
1308 tls_opt_require_cert = * (int *) arg;
1312 case LDAP_OPT_X_TLS_CIPHER_SUITE:
1313 if ( tls_opt_ciphersuite ) LDAP_FREE( tls_opt_ciphersuite );
1314 tls_opt_ciphersuite = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1316 case LDAP_OPT_X_TLS_RANDOM_FILE:
1317 if (tls_opt_randfile ) LDAP_FREE (tls_opt_randfile );
1318 tls_opt_randfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1327 ldap_int_tls_start ( LDAP *ld, LDAPConn *conn, LDAPURLDesc *srv )
1329 Sockbuf *sb = conn->lconn_sb;
1334 host = srv->lud_host;
1336 host = conn->lconn_server->lud_host;
1339 /* avoid NULL host */
1340 if( host == NULL ) {
1344 (void) ldap_pvt_tls_init();
1347 * Fortunately, the lib uses blocking io...
1349 if ( ldap_int_tls_connect( ld, conn ) < 0 ) {
1350 ld->ld_errno = LDAP_CONNECT_ERROR;
1351 return (ld->ld_errno);
1354 ssl = ldap_pvt_tls_sb_ctx( sb );
1355 assert( ssl != NULL );
1358 * compare host with name(s) in certificate
1360 if (tls_opt_require_cert != LDAP_OPT_X_TLS_NEVER) {
1361 ld->ld_errno = ldap_pvt_tls_check_hostname( ld, ssl, host );
1362 if (ld->ld_errno != LDAP_SUCCESS) {
1363 return ld->ld_errno;
1367 return LDAP_SUCCESS;
1370 /* Derived from openssl/apps/s_cb.c */
1372 tls_info_cb( const SSL *ssl, int where, int ret )
1376 char *state = (char *) SSL_state_string_long( (SSL *)ssl );
1378 w = where & ~SSL_ST_MASK;
1379 if ( w & SSL_ST_CONNECT ) {
1381 } else if ( w & SSL_ST_ACCEPT ) {
1389 state = LDAP_STRDUP( state );
1393 if ( where & SSL_CB_LOOP ) {
1395 LDAP_LOG ( TRANSPORT, DETAIL1, "tls_info_cb: "
1396 "TLS trace: %s:%s\n", op, state, 0 );
1398 Debug( LDAP_DEBUG_TRACE,
1399 "TLS trace: %s:%s\n",
1403 } else if ( where & SSL_CB_ALERT ) {
1404 char *atype = (char *) SSL_alert_type_string_long( ret );
1405 char *adesc = (char *) SSL_alert_desc_string_long( ret );
1406 op = ( where & SSL_CB_READ ) ? "read" : "write";
1409 atype = LDAP_STRDUP( atype );
1413 adesc = LDAP_STRDUP( adesc );
1418 LDAP_LOG ( TRANSPORT, DETAIL1,
1419 "tls_info_cb: TLS trace: SSL3 alert %s:%s:%s\n",
1422 Debug( LDAP_DEBUG_TRACE,
1423 "TLS trace: SSL3 alert %s:%s:%s\n",
1427 if ( atype ) LDAP_FREE( atype );
1428 if ( adesc ) LDAP_FREE( adesc );
1430 } else if ( where & SSL_CB_EXIT ) {
1433 LDAP_LOG ( TRANSPORT, ERR,
1434 "tls_info_cb: TLS trace: %s:failed in %s\n",
1437 Debug( LDAP_DEBUG_TRACE,
1438 "TLS trace: %s:failed in %s\n",
1441 } else if ( ret < 0 ) {
1443 LDAP_LOG ( TRANSPORT, ERR,
1444 "tls_info_cb: TLS trace: %s:error in %s\n",
1447 Debug( LDAP_DEBUG_TRACE,
1448 "TLS trace: %s:error in %s\n",
1454 if ( state ) LDAP_FREE( state );
1459 tls_verify_cb( int ok, X509_STORE_CTX *ctx )
1468 char *certerr = NULL;
1470 cert = X509_STORE_CTX_get_current_cert( ctx );
1471 errnum = X509_STORE_CTX_get_error( ctx );
1472 errdepth = X509_STORE_CTX_get_error_depth( ctx );
1475 * X509_get_*_name return pointers to the internal copies of
1476 * those things requested. So do not free them.
1478 subject = X509_get_subject_name( cert );
1479 issuer = X509_get_issuer_name( cert );
1480 /* X509_NAME_oneline, if passed a NULL buf, allocate memomry */
1481 sname = X509_NAME_oneline( subject, NULL, 0 );
1482 iname = X509_NAME_oneline( issuer, NULL, 0 );
1483 if ( !ok ) certerr = (char *)X509_verify_cert_error_string( errnum );
1485 if ( sname ) __etoa( sname );
1486 if ( iname ) __etoa( iname );
1488 certerr = LDAP_STRDUP( certerr );
1493 LDAP_LOG( TRANSPORT, ERR,
1494 "TLS certificate verification: depth: %d, err: %d, subject: %s,",
1496 sname ? sname : "-unknown-" );
1497 LDAP_LOG( TRANSPORT, ERR, " issuer: %s\n", iname ? iname : "-unknown-", 0, 0 );
1499 LDAP_LOG ( TRANSPORT, ERR,
1500 "TLS certificate verification: Error, %s\n",
1504 Debug( LDAP_DEBUG_TRACE,
1505 "TLS certificate verification: depth: %d, err: %d, subject: %s,",
1507 sname ? sname : "-unknown-" );
1508 Debug( LDAP_DEBUG_TRACE, " issuer: %s\n", iname ? iname : "-unknown-", 0, 0 );
1510 Debug( LDAP_DEBUG_ANY,
1511 "TLS certificate verification: Error, %s\n",
1516 CRYPTO_free ( sname );
1518 CRYPTO_free ( iname );
1520 if ( certerr ) LDAP_FREE( certerr );
1526 tls_verify_ok( int ok, X509_STORE_CTX *ctx )
1528 (void) tls_verify_cb( ok, ctx );
1532 /* Inspired by ERR_print_errors in OpenSSL */
1534 tls_report_error( void )
1541 while ( ( l = ERR_get_error_line( &file, &line ) ) != 0 ) {
1542 ERR_error_string_n( l, buf, sizeof( buf ) );
1545 file = LDAP_STRDUP( file );
1546 __etoa( (char *)file );
1551 LDAP_LOG ( TRANSPORT, ERR,
1552 "tls_report_error: TLS %s %s:%d\n",
1555 Debug( LDAP_DEBUG_ANY, "TLS: %s %s:%d\n",
1559 if ( file ) LDAP_FREE( (void *)file );
1565 tls_tmp_rsa_cb( SSL *ssl, int is_export, int key_length )
1569 /* FIXME: Pregenerate the key on startup */
1570 /* FIXME: Who frees the key? */
1571 tmp_rsa = RSA_generate_key( key_length, RSA_F4, NULL, NULL );
1575 LDAP_LOG ( TRANSPORT, ERR,
1576 "tls_tmp_rsa_cb: TLS Failed to generate temporary %d-bit %s "
1577 "RSA key\n", key_length, is_export ? "export" : "domestic", 0 );
1579 Debug( LDAP_DEBUG_ANY,
1580 "TLS: Failed to generate temporary %d-bit %s RSA key\n",
1581 key_length, is_export ? "export" : "domestic", 0 );
1589 tls_seed_PRNG( const char *randfile )
1591 #ifndef URANDOM_DEVICE
1592 /* no /dev/urandom (or equiv) */
1594 char buffer[MAXPATHLEN];
1596 if (randfile == NULL) {
1597 /* The seed file is $RANDFILE if defined, otherwise $HOME/.rnd.
1598 * If $HOME is not set or buffer too small to hold the pathname,
1599 * an error occurs. - From RAND_file_name() man page.
1600 * The fact is that when $HOME is NULL, .rnd is used.
1602 randfile = RAND_file_name( buffer, sizeof( buffer ) );
1604 } else if (RAND_egd(randfile) > 0) {
1609 if (randfile == NULL) {
1611 LDAP_LOG ( TRANSPORT, DETAIL1,
1612 "tls_seed_PRNG: TLS Use configuration file or "
1613 "$RANDFILE to define seed PRNG\n", 0, 0, 0 );
1615 Debug( LDAP_DEBUG_ANY,
1616 "TLS: Use configuration file or $RANDFILE to define seed PRNG\n",
1622 total = RAND_load_file(randfile, -1);
1624 if (RAND_status() == 0) {
1626 LDAP_LOG ( TRANSPORT, DETAIL1,
1627 "tls_seed_PRNG: TLS PRNG not been seeded with enough data\n",
1630 Debug( LDAP_DEBUG_ANY,
1631 "TLS: PRNG not been seeded with enough data\n",
1637 /* assume if there was enough bits to seed that it's okay
1638 * to write derived bits to the file
1640 RAND_write_file(randfile);
1649 tls_tmp_dh_cb( SSL *ssl, int is_export, int key_length )
1657 ldap_pvt_tls_sb_ctx( Sockbuf *sb )
1662 if (HAS_TLS( sb )) {
1663 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&p );
1672 ldap_pvt_tls_get_strength( void *s )
1677 c = SSL_get_current_cipher((SSL *)s);
1678 return SSL_CIPHER_get_bits(c, NULL);
1686 ldap_pvt_tls_get_my_dn( void *s, struct berval *dn, LDAPDN_rewrite_dummy *func, unsigned flags )
1693 x = SSL_get_certificate((SSL *)s);
1695 if (!x) return LDAP_INVALID_CREDENTIALS;
1697 xn = X509_get_subject_name(x);
1698 rc = ldap_X509dn2bv(xn, dn, (LDAPDN_rewrite_func *)func, flags );
1701 return LDAP_NOT_SUPPORTED;
1706 ldap_start_tls_s ( LDAP *ld,
1707 LDAPControl **serverctrls,
1708 LDAPControl **clientctrls )
1713 char *rspoid = NULL;
1714 struct berval *rspdata = NULL;
1716 /* XXYYZ: this initiates operation only on default connection! */
1718 if ( ld->ld_sb != NULL && ldap_pvt_tls_inplace( ld->ld_sb ) != 0 ) {
1719 return LDAP_LOCAL_ERROR;
1722 rc = ldap_extended_operation_s( ld, LDAP_EXOP_START_TLS,
1723 NULL, serverctrls, clientctrls, &rspoid, &rspdata );
1725 if ( rspoid != NULL ) {
1729 if ( rspdata != NULL ) {
1730 ber_bvfree( rspdata );
1733 if ( rc == LDAP_SUCCESS ) {
1734 rc = ldap_int_tls_start( ld, ld->ld_defconn, NULL );
1738 rc = LDAP_NOT_SUPPORTED;