1 /* tls.c - Handle tls/ssl using SSLeay or OpenSSL. */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2005 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
12 * A copy of this license is available in the file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
18 #include "ldap_config.h"
22 #include <ac/stdlib.h>
24 #include <ac/socket.h>
25 #include <ac/string.h>
28 #include <ac/unistd.h>
30 #include <ac/dirent.h>
37 #include <ldap_pvt_thread.h>
40 #ifdef HAVE_OPENSSL_SSL_H
41 #include <openssl/ssl.h>
42 #include <openssl/x509v3.h>
43 #include <openssl/err.h>
44 #include <openssl/rand.h>
45 #include <openssl/safestack.h>
46 #elif defined( HAVE_SSL_H )
50 static int tls_opt_trace = 1;
51 static char *tls_opt_certfile = NULL;
52 static char *tls_opt_keyfile = NULL;
53 static char *tls_opt_cacertfile = NULL;
54 static char *tls_opt_cacertdir = NULL;
55 static int tls_opt_require_cert = LDAP_OPT_X_TLS_DEMAND;
56 static char *tls_opt_ciphersuite = NULL;
57 static char *tls_opt_randfile = NULL;
59 #define HAS_TLS( sb ) ber_sockbuf_ctrl( sb, LBER_SB_OPT_HAS_IO, \
60 (void *)&sb_tls_sbio )
62 static void tls_report_error( void );
64 static void tls_info_cb( const SSL *ssl, int where, int ret );
65 static int tls_verify_cb( int ok, X509_STORE_CTX *ctx );
66 static int tls_verify_ok( int ok, X509_STORE_CTX *ctx );
67 static RSA * tls_tmp_rsa_cb( SSL *ssl, int is_export, int key_length );
68 static STACK_OF(X509_NAME) * get_ca_list( char * bundle, char * dir );
70 #if 0 /* Currently this is not used by anyone */
71 static DH * tls_tmp_dh_cb( SSL *ssl, int is_export, int key_length );
74 static SSL_CTX *tls_def_ctx = NULL;
76 static int tls_seed_PRNG( const char *randfile );
80 * provide mutexes for the SSLeay library.
82 static ldap_pvt_thread_mutex_t tls_mutexes[CRYPTO_NUM_LOCKS];
84 static void tls_locking_cb( int mode, int type, const char *file, int line )
86 if ( mode & CRYPTO_LOCK ) {
87 ldap_pvt_thread_mutex_lock( &tls_mutexes[type] );
89 ldap_pvt_thread_mutex_unlock( &tls_mutexes[type] );
94 * an extra mutex for the default ctx.
97 static ldap_pvt_thread_mutex_t tls_def_ctx_mutex;
99 static void tls_init_threads( void )
103 for( i=0; i< CRYPTO_NUM_LOCKS ; i++ ) {
104 ldap_pvt_thread_mutex_init( &tls_mutexes[i] );
106 CRYPTO_set_locking_callback( tls_locking_cb );
107 /* FIXME: the thread id should be added somehow... */
109 ldap_pvt_thread_mutex_init( &tls_def_ctx_mutex );
111 #endif /* LDAP_R_COMPILE */
114 * Tear down the TLS subsystem. Should only be called once.
117 ldap_pvt_tls_destroy( void )
119 SSL_CTX_free(tls_def_ctx);
126 if ( tls_opt_certfile ) {
127 LDAP_FREE( tls_opt_certfile );
128 tls_opt_certfile = NULL;
130 if ( tls_opt_keyfile ) {
131 LDAP_FREE( tls_opt_keyfile );
132 tls_opt_keyfile = NULL;
134 if ( tls_opt_cacertfile ) {
135 LDAP_FREE( tls_opt_cacertfile );
136 tls_opt_cacertfile = NULL;
138 if ( tls_opt_cacertdir ) {
139 LDAP_FREE( tls_opt_cacertdir );
140 tls_opt_cacertdir = NULL;
142 if ( tls_opt_ciphersuite ) {
143 LDAP_FREE( tls_opt_ciphersuite );
144 tls_opt_ciphersuite = NULL;
146 if ( tls_opt_randfile ) {
147 LDAP_FREE( tls_opt_randfile );
148 tls_opt_randfile = NULL;
153 * Initialize TLS subsystem. Should be called only once.
156 ldap_pvt_tls_init( void )
158 static int tls_initialized = 0;
160 if ( tls_initialized++ ) return 0;
164 char *file = LDAP_STRDUP( tls_opt_randfile );
165 if ( file ) __atoe( file );
166 (void) tls_seed_PRNG( file );
170 (void) tls_seed_PRNG( tls_opt_randfile );
173 #ifdef LDAP_R_COMPILE
177 SSL_load_error_strings();
178 SSLeay_add_ssl_algorithms();
180 /* FIXME: mod_ssl does this */
181 X509V3_add_standard_extensions();
186 * initialize the default context
189 ldap_pvt_tls_init_def_ctx( void )
191 STACK_OF(X509_NAME) *calist;
193 char *ciphersuite = tls_opt_ciphersuite;
194 char *cacertfile = tls_opt_cacertfile;
195 char *cacertdir = tls_opt_cacertdir;
196 char *certfile = tls_opt_certfile;
197 char *keyfile = tls_opt_keyfile;
200 /* This ASCII/EBCDIC handling is a real pain! */
202 ciphersuite = LDAP_STRDUP( ciphersuite );
203 __atoe( ciphersuite );
206 cacertfile = LDAP_STRDUP( cacertfile );
207 __atoe( cacertfile );
210 cacertdir = LDAP_STRDUP( cacertdir );
214 certfile = LDAP_STRDUP( certfile );
218 keyfile = LDAP_STRDUP( keyfile );
223 #ifdef LDAP_R_COMPILE
224 ldap_pvt_thread_mutex_lock( &tls_def_ctx_mutex );
226 if ( tls_def_ctx == NULL ) {
228 tls_def_ctx = SSL_CTX_new( SSLv23_method() );
229 if ( tls_def_ctx == NULL ) {
231 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
232 "TLS could not allocate default ctx (%d).\n",
233 ERR_peek_error(), 0, 0 );
235 Debug( LDAP_DEBUG_ANY,
236 "TLS: could not allocate default ctx (%lu).\n",
237 ERR_peek_error(),0,0);
243 SSL_CTX_set_session_id_context( tls_def_ctx,
244 (const unsigned char *) "OpenLDAP", sizeof("OpenLDAP")-1 );
246 if ( tls_opt_ciphersuite &&
247 !SSL_CTX_set_cipher_list( tls_def_ctx, ciphersuite ) )
250 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
251 "TLS could not set cipher list %s.\n",
252 tls_opt_ciphersuite, 0, 0 );
254 Debug( LDAP_DEBUG_ANY,
255 "TLS: could not set cipher list %s.\n",
256 tls_opt_ciphersuite, 0, 0 );
263 if (tls_opt_cacertfile != NULL || tls_opt_cacertdir != NULL) {
264 if ( !SSL_CTX_load_verify_locations( tls_def_ctx,
265 cacertfile, cacertdir ) ||
266 !SSL_CTX_set_default_verify_paths( tls_def_ctx ) )
269 LDAP_LOG ( TRANSPORT, ERR,
270 "ldap_pvt_tls_init_def_ctx: "
271 "TLS could not load verify locations "
272 "(file:`%s',dir:`%s').\n",
273 tls_opt_cacertfile ? tls_opt_cacertfile : "",
274 tls_opt_cacertdir ? tls_opt_cacertdir : "", 0 );
276 Debug( LDAP_DEBUG_ANY, "TLS: "
277 "could not load verify locations (file:`%s',dir:`%s').\n",
278 tls_opt_cacertfile ? tls_opt_cacertfile : "",
279 tls_opt_cacertdir ? tls_opt_cacertdir : "",
287 calist = get_ca_list( cacertfile, cacertdir );
290 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
291 "TLS could not load client CA list (file: `%s',dir:`%s')\n",
292 tls_opt_cacertfile ? tls_opt_cacertfile : "",
293 tls_opt_cacertdir ? tls_opt_cacertdir : "", 0 );
295 Debug( LDAP_DEBUG_ANY, "TLS: "
296 "could not load client CA list (file:`%s',dir:`%s').\n",
297 tls_opt_cacertfile ? tls_opt_cacertfile : "",
298 tls_opt_cacertdir ? tls_opt_cacertdir : "",
306 SSL_CTX_set_client_CA_list( tls_def_ctx, calist );
309 if ( tls_opt_keyfile &&
310 !SSL_CTX_use_PrivateKey_file( tls_def_ctx,
311 keyfile, SSL_FILETYPE_PEM ) )
314 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
315 "TLS could not use key file `%s'.\n", tls_opt_keyfile, 0, 0 );
317 Debug( LDAP_DEBUG_ANY,
318 "TLS: could not use key file `%s'.\n",
319 tls_opt_keyfile,0,0);
326 if ( tls_opt_certfile &&
327 !SSL_CTX_use_certificate_file( tls_def_ctx,
328 certfile, SSL_FILETYPE_PEM ) )
331 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
332 "TLS could not use certificate `%s'.\n",
333 tls_opt_certfile, 0, 0 );
335 Debug( LDAP_DEBUG_ANY,
336 "TLS: could not use certificate `%s'.\n",
337 tls_opt_certfile,0,0);
344 if ( ( tls_opt_certfile || tls_opt_keyfile ) &&
345 !SSL_CTX_check_private_key( tls_def_ctx ) )
348 LDAP_LOG ( TRANSPORT, ERR,
349 "ldap_pvt_tls_init_def_ctx: TLS private key mismatch.\n",
352 Debug( LDAP_DEBUG_ANY,
353 "TLS: private key mismatch.\n",
361 if ( tls_opt_trace ) {
362 SSL_CTX_set_info_callback( tls_def_ctx, tls_info_cb );
366 if ( tls_opt_require_cert ) {
368 if ( tls_opt_require_cert == LDAP_OPT_X_TLS_DEMAND ||
369 tls_opt_require_cert == LDAP_OPT_X_TLS_HARD ) {
370 i |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
374 SSL_CTX_set_verify( tls_def_ctx, i,
375 tls_opt_require_cert == LDAP_OPT_X_TLS_ALLOW ?
376 tls_verify_ok : tls_verify_cb );
377 SSL_CTX_set_tmp_rsa_callback( tls_def_ctx, tls_tmp_rsa_cb );
378 /* SSL_CTX_set_tmp_dh_callback( tls_def_ctx, tls_tmp_dh_cb ); */
381 if ( rc == -1 && tls_def_ctx != NULL ) {
382 SSL_CTX_free( tls_def_ctx );
386 LDAP_FREE( ciphersuite );
387 LDAP_FREE( cacertfile );
388 LDAP_FREE( cacertdir );
389 LDAP_FREE( certfile );
390 LDAP_FREE( keyfile );
392 #ifdef LDAP_R_COMPILE
393 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
398 static STACK_OF(X509_NAME) *
399 get_ca_list( char * bundle, char * dir )
401 STACK_OF(X509_NAME) *ca_list = NULL;
404 ca_list = SSL_load_client_CA_file( bundle );
406 #if defined(HAVE_DIRENT_H) || defined(dirent)
411 ca_list = sk_X509_NAME_new_null();
414 if ( !SSL_add_dir_cert_subjects_to_stack( ca_list, dir ) &&
416 sk_X509_NAME_free( ca_list );
425 alloc_handle( void *ctx_arg )
431 ctx = (SSL_CTX *) ctx_arg;
433 if ( ldap_pvt_tls_init_def_ctx() < 0 ) return NULL;
437 ssl = SSL_new( ctx );
440 LDAP_LOG ( TRANSPORT, ERR,
441 "alloc_handle: TLS can't create ssl handle.\n", 0, 0, 0 );
443 Debug( LDAP_DEBUG_ANY,"TLS: can't create ssl handle.\n",0,0,0);
451 update_flags( Sockbuf *sb, SSL * ssl, int rc )
453 int err = SSL_get_error(ssl, rc);
455 sb->sb_trans_needs_read = 0;
456 sb->sb_trans_needs_write = 0;
458 if (err == SSL_ERROR_WANT_READ) {
459 sb->sb_trans_needs_read = 1;
462 } else if (err == SSL_ERROR_WANT_WRITE) {
463 sb->sb_trans_needs_write = 1;
466 } else if (err == SSL_ERROR_WANT_CONNECT) {
473 * TLS support for LBER Sockbufs
478 Sockbuf_IO_Desc *sbiod;
481 static BIO_METHOD sb_tls_bio_method;
484 sb_tls_setup( Sockbuf_IO_Desc *sbiod, void *arg )
489 assert( sbiod != NULL );
491 p = LBER_MALLOC( sizeof( *p ) );
498 bio = BIO_new( &sb_tls_bio_method );
499 bio->ptr = (void *)p;
500 SSL_set_bio( p->ssl, bio, bio );
501 sbiod->sbiod_pvt = p;
506 sb_tls_remove( Sockbuf_IO_Desc *sbiod )
510 assert( sbiod != NULL );
511 assert( sbiod->sbiod_pvt != NULL );
513 p = (struct tls_data *)sbiod->sbiod_pvt;
515 LBER_FREE( sbiod->sbiod_pvt );
516 sbiod->sbiod_pvt = NULL;
521 sb_tls_close( Sockbuf_IO_Desc *sbiod )
525 assert( sbiod != NULL );
526 assert( sbiod->sbiod_pvt != NULL );
528 p = (struct tls_data *)sbiod->sbiod_pvt;
529 SSL_shutdown( p->ssl );
534 sb_tls_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
538 assert( sbiod != NULL );
539 assert( sbiod->sbiod_pvt != NULL );
541 p = (struct tls_data *)sbiod->sbiod_pvt;
543 if ( opt == LBER_SB_OPT_GET_SSL ) {
544 *((SSL **)arg) = p->ssl;
547 } else if ( opt == LBER_SB_OPT_DATA_READY ) {
548 if( SSL_pending( p->ssl ) > 0 ) {
553 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
557 sb_tls_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
563 assert( sbiod != NULL );
564 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
566 p = (struct tls_data *)sbiod->sbiod_pvt;
568 ret = SSL_read( p->ssl, (char *)buf, len );
570 errno = WSAGetLastError();
572 err = SSL_get_error( p->ssl, ret );
573 if (err == SSL_ERROR_WANT_READ ) {
574 sbiod->sbiod_sb->sb_trans_needs_read = 1;
578 sbiod->sbiod_sb->sb_trans_needs_read = 0;
583 sb_tls_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
589 assert( sbiod != NULL );
590 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
592 p = (struct tls_data *)sbiod->sbiod_pvt;
594 ret = SSL_write( p->ssl, (char *)buf, len );
596 errno = WSAGetLastError();
598 err = SSL_get_error( p->ssl, ret );
599 if (err == SSL_ERROR_WANT_WRITE ) {
600 sbiod->sbiod_sb->sb_trans_needs_write = 1;
604 sbiod->sbiod_sb->sb_trans_needs_write = 0;
609 static Sockbuf_IO sb_tls_sbio =
611 sb_tls_setup, /* sbi_setup */
612 sb_tls_remove, /* sbi_remove */
613 sb_tls_ctrl, /* sbi_ctrl */
614 sb_tls_read, /* sbi_read */
615 sb_tls_write, /* sbi_write */
616 sb_tls_close /* sbi_close */
620 sb_tls_bio_create( BIO *b ) {
629 sb_tls_bio_destroy( BIO *b )
631 if ( b == NULL ) return 0;
633 b->ptr = NULL; /* sb_tls_remove() will free it */
640 sb_tls_bio_read( BIO *b, char *buf, int len )
645 if ( buf == NULL || len <= 0 ) return 0;
647 p = (struct tls_data *)b->ptr;
649 if ( p == NULL || p->sbiod == NULL ) {
653 ret = LBER_SBIOD_READ_NEXT( p->sbiod, buf, len );
655 BIO_clear_retry_flags( b );
658 if ( err == EAGAIN || err == EWOULDBLOCK ) {
659 BIO_set_retry_read( b );
667 sb_tls_bio_write( BIO *b, const char *buf, int len )
672 if ( buf == NULL || len <= 0 ) return 0;
674 p = (struct tls_data *)b->ptr;
676 if ( p == NULL || p->sbiod == NULL ) {
680 ret = LBER_SBIOD_WRITE_NEXT( p->sbiod, (char *)buf, len );
682 BIO_clear_retry_flags( b );
685 if ( err == EAGAIN || err == EWOULDBLOCK ) {
686 BIO_set_retry_write( b );
694 sb_tls_bio_ctrl( BIO *b, int cmd, long num, void *ptr )
696 if ( cmd == BIO_CTRL_FLUSH ) {
697 /* The OpenSSL library needs this */
704 sb_tls_bio_gets( BIO *b, char *buf, int len )
710 sb_tls_bio_puts( BIO *b, const char *str )
712 return sb_tls_bio_write( b, str, strlen( str ) );
715 static BIO_METHOD sb_tls_bio_method =
717 ( 100 | 0x400 ), /* it's a source/sink BIO */
729 * Call this to do a TLS connect on a sockbuf. ctx_arg can be
730 * a SSL_CTX * or NULL, in which case the default ctx is used.
734 * 0 - Success. Connection is ready for communication.
735 * <0 - Error. Can't create a TLS stream.
736 * >0 - Partial success.
737 * Do a select (using information from lber_pvt_sb_needs_{read,write}
742 ldap_int_tls_connect( LDAP *ld, LDAPConn *conn )
744 Sockbuf *sb = conn->lconn_sb;
748 if ( HAS_TLS( sb ) ) {
749 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
752 void *ctx = ld->ld_defconn
753 ? ld->ld_defconn->lconn_tls_ctx : NULL;
755 ssl = alloc_handle( ctx );
757 if ( ssl == NULL ) return -1;
760 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
761 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
763 ber_sockbuf_add_io( sb, &sb_tls_sbio,
764 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
767 conn->lconn_tls_ctx = tls_def_ctx;
771 err = SSL_connect( ssl );
774 errno = WSAGetLastError();
778 if ( update_flags( sb, ssl, err )) {
782 if ((err = ERR_peek_error())) {
784 ld->ld_error = LDAP_STRDUP(ERR_error_string(err, buf));
786 if ( ld->ld_error ) __etoa(ld->ld_error);
791 LDAP_LOG ( TRANSPORT, ERR,
792 "ldap_int_tls_connect: TLS can't connect.\n", 0, 0, 0 );
794 Debug( LDAP_DEBUG_ANY,"TLS: can't connect.\n",0,0,0);
797 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
798 LBER_SBIOD_LEVEL_TRANSPORT );
800 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
801 LBER_SBIOD_LEVEL_TRANSPORT );
810 * Call this to do a TLS accept on a sockbuf.
811 * Everything else is the same as with tls_connect.
814 ldap_pvt_tls_accept( Sockbuf *sb, void *ctx_arg )
819 if ( HAS_TLS( sb ) ) {
820 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
823 ssl = alloc_handle( ctx_arg );
824 if ( ssl == NULL ) return -1;
827 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
828 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
830 ber_sockbuf_add_io( sb, &sb_tls_sbio,
831 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
834 err = SSL_accept( ssl );
837 errno = WSAGetLastError();
840 if ( update_flags( sb, ssl, err )) return 1;
843 LDAP_LOG ( TRANSPORT, ERR,
844 "ldap_pvt_tls_accept: TLS can't accept.\n", 0, 0, 0 );
846 Debug( LDAP_DEBUG_ANY,"TLS: can't accept.\n",0,0,0 );
850 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
851 LBER_SBIOD_LEVEL_TRANSPORT );
853 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
854 LBER_SBIOD_LEVEL_TRANSPORT );
863 ldap_pvt_tls_inplace ( Sockbuf *sb )
865 return HAS_TLS( sb ) ? 1 : 0;
869 tls_get_cert( SSL *s )
871 /* If peer cert was bad, treat as if no cert was given */
872 if (SSL_get_verify_result(s)) {
873 /* If we can send an alert, do so */
874 if (SSL_version(s) != SSL2_VERSION) {
875 ssl3_send_alert(s,SSL3_AL_WARNING,SSL3_AD_BAD_CERTIFICATE);
879 return SSL_get_peer_certificate(s);
883 ldap_pvt_tls_get_peer_dn( void *s, struct berval *dn,
884 LDAPDN_rewrite_dummy *func, unsigned flags )
890 x = tls_get_cert((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);
901 ldap_pvt_tls_get_peer_hostname( void *s )
908 x = tls_get_cert((SSL *)s);
911 xn = X509_get_subject_name(x);
913 ret = X509_NAME_get_text_by_NID(xn, NID_commonName, buf, sizeof(buf));
919 p = LDAP_STRDUP(buf);
924 /* what kind of hostname were we given? */
930 ldap_pvt_tls_check_hostname( LDAP *ld, void *s, const char *name_in )
932 int i, ret = LDAP_LOCAL_ERROR;
938 struct in6_addr addr;
943 if( ldap_int_hostname &&
944 ( !name_in || !strcasecmp( name_in, "localhost" ) ) )
946 name = ldap_int_hostname;
951 x = tls_get_cert((SSL *)s);
954 LDAP_LOG ( TRANSPORT, ERR,
955 "ldap_pvt_tls_check_hostname: "
956 "TLS unable to get peer certificate.\n" , 0, 0, 0 );
958 Debug( LDAP_DEBUG_ANY,
959 "TLS: unable to get peer certificate.\n",
962 /* If this was a fatal condition, things would have
963 * aborted long before now.
969 if (name[0] == '[' && strchr(name, ']')) {
970 char *n2 = ldap_strdup(name+1);
971 *strchr(n2, ']') = 2;
972 if (inet_pton(AF_INET6, n2, &addr))
977 if ((ptr = strrchr(name, '.')) && isdigit((unsigned char)ptr[1])) {
978 if (inet_aton(name, (struct in_addr *)&addr)) ntype = IS_IP4;
981 i = X509_get_ext_by_NID(x, NID_subject_alt_name, -1);
984 STACK_OF(GENERAL_NAME) *alt;
986 ex = X509_get_ext(x, i);
987 alt = X509V3_EXT_d2i(ex);
989 int n, len1 = 0, len2 = 0;
993 if (ntype == IS_DNS) {
995 domain = strchr(name, '.');
997 len2 = len1 - (domain-name);
1000 n = sk_GENERAL_NAME_num(alt);
1001 for (i=0; i<n; i++) {
1004 gn = sk_GENERAL_NAME_value(alt, i);
1005 if (gn->type == GEN_DNS) {
1006 if (ntype != IS_DNS) continue;
1008 sn = (char *) ASN1_STRING_data(gn->d.ia5);
1009 sl = ASN1_STRING_length(gn->d.ia5);
1012 if (sl == 0) continue;
1014 /* Is this an exact match? */
1015 if ((len1 == sl) && !strncasecmp(name, sn, len1)) {
1019 /* Is this a wildcard match? */
1020 if (domain && (sn[0] == '*') && (sn[1] == '.') &&
1021 (len2 == sl-1) && !strncasecmp(domain, &sn[1], len2))
1026 } else if (gn->type == GEN_IPADD) {
1027 if (ntype == IS_DNS) continue;
1029 sn = (char *) ASN1_STRING_data(gn->d.ia5);
1030 sl = ASN1_STRING_length(gn->d.ia5);
1032 #ifdef LDAP_PF_INET6
1033 if (ntype == IS_IP6 && sl != sizeof(struct in6_addr)) {
1037 if (ntype == IS_IP4 && sl != sizeof(struct in_addr)) {
1040 if (!memcmp(sn, &addr, sl)) {
1046 GENERAL_NAMES_free(alt);
1047 if (i < n) { /* Found a match */
1053 if (ret != LDAP_SUCCESS) {
1058 xn = X509_get_subject_name(x);
1059 if( X509_NAME_get_text_by_NID( xn, NID_commonName,
1060 buf, sizeof(buf)) == -1)
1063 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_check_hostname: "
1064 "TLS unable to get common name from peer certificate.\n",
1067 Debug( LDAP_DEBUG_ANY,
1068 "TLS: unable to get common name from peer certificate.\n",
1071 ret = LDAP_CONNECT_ERROR;
1072 ld->ld_error = LDAP_STRDUP(
1073 _("TLS: unable to get CN from peer certificate"));
1075 } else if (strcasecmp(name, buf) == 0 ) {
1078 } else if (( buf[0] == '*' ) && ( buf[1] == '.' )) {
1079 char *domain = strchr(name, '.');
1085 dlen = sl - (domain-name);
1088 /* Is this a wildcard match? */
1089 if ((dlen == sl-1) && !strncasecmp(domain, &buf[1], dlen)) {
1095 if( ret == LDAP_LOCAL_ERROR ) {
1097 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_check_hostname: "
1098 "TLS hostname (%s) does not match "
1099 "common name in certificate (%s).\n", name, buf, 0 );
1101 Debug( LDAP_DEBUG_ANY, "TLS: hostname (%s) does not match "
1102 "common name in certificate (%s).\n",
1105 ret = LDAP_CONNECT_ERROR;
1106 ld->ld_error = LDAP_STRDUP(
1107 _("TLS: hostname does not match CN in peer certificate"));
1115 ldap_pvt_tls_get_peer_issuer( void *s )
1117 #if 0 /* currently unused; see ldap_pvt_tls_get_peer_dn() if needed */
1122 x = SSL_get_peer_certificate((SSL *)s);
1124 if (!x) return NULL;
1126 xn = X509_get_issuer_name(x);
1127 p = LDAP_STRDUP(X509_NAME_oneline(xn, buf, sizeof(buf)));
1136 ldap_int_tls_config( LDAP *ld, int option, const char *arg )
1141 case LDAP_OPT_X_TLS_CACERTFILE:
1142 case LDAP_OPT_X_TLS_CACERTDIR:
1143 case LDAP_OPT_X_TLS_CERTFILE:
1144 case LDAP_OPT_X_TLS_KEYFILE:
1145 case LDAP_OPT_X_TLS_RANDOM_FILE:
1146 case LDAP_OPT_X_TLS_CIPHER_SUITE:
1147 return ldap_pvt_tls_set_option( ld, option, (void *) arg );
1149 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1150 case LDAP_OPT_X_TLS:
1152 if ( strcasecmp( arg, "never" ) == 0 ) {
1153 i = LDAP_OPT_X_TLS_NEVER ;
1155 } else if ( strcasecmp( arg, "demand" ) == 0 ) {
1156 i = LDAP_OPT_X_TLS_DEMAND ;
1158 } else if ( strcasecmp( arg, "allow" ) == 0 ) {
1159 i = LDAP_OPT_X_TLS_ALLOW ;
1161 } else if ( strcasecmp( arg, "try" ) == 0 ) {
1162 i = LDAP_OPT_X_TLS_TRY ;
1164 } else if ( ( strcasecmp( arg, "hard" ) == 0 ) ||
1165 ( strcasecmp( arg, "on" ) == 0 ) ||
1166 ( strcasecmp( arg, "yes" ) == 0) ||
1167 ( strcasecmp( arg, "true" ) == 0 ) )
1169 i = LDAP_OPT_X_TLS_HARD ;
1173 return ldap_pvt_tls_set_option( ld, option, &i );
1182 ldap_pvt_tls_get_option( LDAP *ld, int option, void *arg )
1184 struct ldapoptions *lo;
1187 assert( LDAP_VALID( ld ) );
1189 if( !LDAP_VALID( ld ) ) {
1190 return LDAP_OPT_ERROR;
1193 lo = &ld->ld_options;
1196 /* Get pointer to global option structure */
1197 lo = LDAP_INT_GLOBAL_OPT();
1199 return LDAP_NO_MEMORY;
1204 case LDAP_OPT_X_TLS:
1205 *(int *)arg = lo->ldo_tls_mode;
1207 case LDAP_OPT_X_TLS_CTX:
1209 *(void **)arg = (void *) tls_def_ctx;
1211 *(void **)arg = ld->ld_defconn->lconn_tls_ctx;
1214 case LDAP_OPT_X_TLS_CACERTFILE:
1215 *(char **)arg = tls_opt_cacertfile ?
1216 LDAP_STRDUP( tls_opt_cacertfile ) : NULL;
1218 case LDAP_OPT_X_TLS_CACERTDIR:
1219 *(char **)arg = tls_opt_cacertdir ?
1220 LDAP_STRDUP( tls_opt_cacertdir ) : NULL;
1222 case LDAP_OPT_X_TLS_CERTFILE:
1223 *(char **)arg = tls_opt_certfile ?
1224 LDAP_STRDUP( tls_opt_certfile ) : NULL;
1226 case LDAP_OPT_X_TLS_KEYFILE:
1227 *(char **)arg = tls_opt_keyfile ?
1228 LDAP_STRDUP( tls_opt_keyfile ) : NULL;
1230 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1231 *(int *)arg = tls_opt_require_cert;
1233 case LDAP_OPT_X_TLS_RANDOM_FILE:
1234 *(char **)arg = tls_opt_randfile ?
1235 LDAP_STRDUP( tls_opt_randfile ) : NULL;
1237 case LDAP_OPT_X_TLS_SSL_CTX: {
1240 LDAPConn *conn = ld->ld_defconn;
1241 if ( conn != NULL ) {
1242 Sockbuf *sb = conn->lconn_sb;
1243 retval = ldap_pvt_tls_sb_ctx( sb );
1246 *(void **)arg = retval;
1256 ldap_pvt_tls_set_option( LDAP *ld, int option, void *arg )
1258 struct ldapoptions *lo;
1261 assert( LDAP_VALID( ld ) );
1263 if( !LDAP_VALID( ld ) ) {
1264 return LDAP_OPT_ERROR;
1267 lo = &ld->ld_options;
1270 /* Get pointer to global option structure */
1271 lo = LDAP_INT_GLOBAL_OPT();
1273 return LDAP_NO_MEMORY;
1278 case LDAP_OPT_X_TLS:
1279 switch( *(int *) arg ) {
1280 case LDAP_OPT_X_TLS_NEVER:
1281 case LDAP_OPT_X_TLS_DEMAND:
1282 case LDAP_OPT_X_TLS_ALLOW:
1283 case LDAP_OPT_X_TLS_TRY:
1284 case LDAP_OPT_X_TLS_HARD:
1286 lo->ldo_tls_mode = *(int *)arg;
1293 case LDAP_OPT_X_TLS_CTX:
1295 tls_def_ctx = (SSL_CTX *) arg;
1298 ld->ld_defconn->lconn_tls_ctx = arg;
1308 case LDAP_OPT_X_TLS_CACERTFILE:
1309 if ( tls_opt_cacertfile ) LDAP_FREE( tls_opt_cacertfile );
1310 tls_opt_cacertfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1312 case LDAP_OPT_X_TLS_CACERTDIR:
1313 if ( tls_opt_cacertdir ) LDAP_FREE( tls_opt_cacertdir );
1314 tls_opt_cacertdir = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1316 case LDAP_OPT_X_TLS_CERTFILE:
1317 if ( tls_opt_certfile ) LDAP_FREE( tls_opt_certfile );
1318 tls_opt_certfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1320 case LDAP_OPT_X_TLS_KEYFILE:
1321 if ( tls_opt_keyfile ) LDAP_FREE( tls_opt_keyfile );
1322 tls_opt_keyfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1324 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1325 switch( *(int *) arg ) {
1326 case LDAP_OPT_X_TLS_NEVER:
1327 case LDAP_OPT_X_TLS_DEMAND:
1328 case LDAP_OPT_X_TLS_ALLOW:
1329 case LDAP_OPT_X_TLS_TRY:
1330 case LDAP_OPT_X_TLS_HARD:
1331 tls_opt_require_cert = * (int *) arg;
1335 case LDAP_OPT_X_TLS_CIPHER_SUITE:
1336 if ( tls_opt_ciphersuite ) LDAP_FREE( tls_opt_ciphersuite );
1337 tls_opt_ciphersuite = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1339 case LDAP_OPT_X_TLS_RANDOM_FILE:
1340 if (tls_opt_randfile ) LDAP_FREE (tls_opt_randfile );
1341 tls_opt_randfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1350 ldap_int_tls_start ( LDAP *ld, LDAPConn *conn, LDAPURLDesc *srv )
1352 Sockbuf *sb = conn->lconn_sb;
1357 host = srv->lud_host;
1359 host = conn->lconn_server->lud_host;
1362 /* avoid NULL host */
1363 if( host == NULL ) {
1367 (void) ldap_pvt_tls_init();
1370 * Fortunately, the lib uses blocking io...
1372 if ( ldap_int_tls_connect( ld, conn ) < 0 ) {
1373 ld->ld_errno = LDAP_CONNECT_ERROR;
1374 return (ld->ld_errno);
1377 ssl = ldap_pvt_tls_sb_ctx( sb );
1378 assert( ssl != NULL );
1381 * compare host with name(s) in certificate
1383 if (tls_opt_require_cert != LDAP_OPT_X_TLS_NEVER) {
1384 ld->ld_errno = ldap_pvt_tls_check_hostname( ld, ssl, host );
1385 if (ld->ld_errno != LDAP_SUCCESS) {
1386 return ld->ld_errno;
1390 return LDAP_SUCCESS;
1393 /* Derived from openssl/apps/s_cb.c */
1395 tls_info_cb( const SSL *ssl, int where, int ret )
1399 char *state = (char *) SSL_state_string_long( (SSL *)ssl );
1401 w = where & ~SSL_ST_MASK;
1402 if ( w & SSL_ST_CONNECT ) {
1404 } else if ( w & SSL_ST_ACCEPT ) {
1412 state = LDAP_STRDUP( state );
1416 if ( where & SSL_CB_LOOP ) {
1418 LDAP_LOG ( TRANSPORT, DETAIL1, "tls_info_cb: "
1419 "TLS trace: %s:%s\n", op, state, 0 );
1421 Debug( LDAP_DEBUG_TRACE,
1422 "TLS trace: %s:%s\n",
1426 } else if ( where & SSL_CB_ALERT ) {
1427 char *atype = (char *) SSL_alert_type_string_long( ret );
1428 char *adesc = (char *) SSL_alert_desc_string_long( ret );
1429 op = ( where & SSL_CB_READ ) ? "read" : "write";
1432 atype = LDAP_STRDUP( atype );
1436 adesc = LDAP_STRDUP( adesc );
1441 LDAP_LOG ( TRANSPORT, DETAIL1,
1442 "tls_info_cb: TLS trace: SSL3 alert %s:%s:%s\n",
1445 Debug( LDAP_DEBUG_TRACE,
1446 "TLS trace: SSL3 alert %s:%s:%s\n",
1450 if ( atype ) LDAP_FREE( atype );
1451 if ( adesc ) LDAP_FREE( adesc );
1453 } else if ( where & SSL_CB_EXIT ) {
1456 LDAP_LOG ( TRANSPORT, ERR,
1457 "tls_info_cb: TLS trace: %s:failed in %s\n",
1460 Debug( LDAP_DEBUG_TRACE,
1461 "TLS trace: %s:failed in %s\n",
1464 } else if ( ret < 0 ) {
1466 LDAP_LOG ( TRANSPORT, ERR,
1467 "tls_info_cb: TLS trace: %s:error in %s\n",
1470 Debug( LDAP_DEBUG_TRACE,
1471 "TLS trace: %s:error in %s\n",
1477 if ( state ) LDAP_FREE( state );
1482 tls_verify_cb( int ok, X509_STORE_CTX *ctx )
1491 char *certerr = NULL;
1493 cert = X509_STORE_CTX_get_current_cert( ctx );
1494 errnum = X509_STORE_CTX_get_error( ctx );
1495 errdepth = X509_STORE_CTX_get_error_depth( ctx );
1498 * X509_get_*_name return pointers to the internal copies of
1499 * those things requested. So do not free them.
1501 subject = X509_get_subject_name( cert );
1502 issuer = X509_get_issuer_name( cert );
1503 /* X509_NAME_oneline, if passed a NULL buf, allocate memomry */
1504 sname = X509_NAME_oneline( subject, NULL, 0 );
1505 iname = X509_NAME_oneline( issuer, NULL, 0 );
1506 if ( !ok ) certerr = (char *)X509_verify_cert_error_string( errnum );
1508 if ( sname ) __etoa( sname );
1509 if ( iname ) __etoa( iname );
1511 certerr = LDAP_STRDUP( certerr );
1516 LDAP_LOG( TRANSPORT, ERR,
1517 "TLS certificate verification: depth: %d, err: %d, subject: %s,",
1519 sname ? sname : "-unknown-" );
1520 LDAP_LOG( TRANSPORT, ERR, " issuer: %s\n", iname ? iname : "-unknown-", 0, 0 );
1522 LDAP_LOG ( TRANSPORT, ERR,
1523 "TLS certificate verification: Error, %s\n",
1527 Debug( LDAP_DEBUG_TRACE,
1528 "TLS certificate verification: depth: %d, err: %d, subject: %s,",
1530 sname ? sname : "-unknown-" );
1531 Debug( LDAP_DEBUG_TRACE, " issuer: %s\n", iname ? iname : "-unknown-", 0, 0 );
1533 Debug( LDAP_DEBUG_ANY,
1534 "TLS certificate verification: Error, %s\n",
1539 CRYPTO_free ( sname );
1541 CRYPTO_free ( iname );
1543 if ( certerr ) LDAP_FREE( certerr );
1549 tls_verify_ok( int ok, X509_STORE_CTX *ctx )
1551 (void) tls_verify_cb( ok, ctx );
1555 /* Inspired by ERR_print_errors in OpenSSL */
1557 tls_report_error( void )
1564 while ( ( l = ERR_get_error_line( &file, &line ) ) != 0 ) {
1565 ERR_error_string_n( l, buf, sizeof( buf ) );
1568 file = LDAP_STRDUP( file );
1569 __etoa( (char *)file );
1574 LDAP_LOG ( TRANSPORT, ERR,
1575 "tls_report_error: TLS %s %s:%d\n",
1578 Debug( LDAP_DEBUG_ANY, "TLS: %s %s:%d\n",
1582 if ( file ) LDAP_FREE( (void *)file );
1588 tls_tmp_rsa_cb( SSL *ssl, int is_export, int key_length )
1592 /* FIXME: Pregenerate the key on startup */
1593 /* FIXME: Who frees the key? */
1594 tmp_rsa = RSA_generate_key( key_length, RSA_F4, NULL, NULL );
1598 LDAP_LOG ( TRANSPORT, ERR,
1599 "tls_tmp_rsa_cb: TLS Failed to generate temporary %d-bit %s "
1600 "RSA key\n", key_length, is_export ? "export" : "domestic", 0 );
1602 Debug( LDAP_DEBUG_ANY,
1603 "TLS: Failed to generate temporary %d-bit %s RSA key\n",
1604 key_length, is_export ? "export" : "domestic", 0 );
1612 tls_seed_PRNG( const char *randfile )
1614 #ifndef URANDOM_DEVICE
1615 /* no /dev/urandom (or equiv) */
1617 char buffer[MAXPATHLEN];
1619 if (randfile == NULL) {
1620 /* The seed file is $RANDFILE if defined, otherwise $HOME/.rnd.
1621 * If $HOME is not set or buffer too small to hold the pathname,
1622 * an error occurs. - From RAND_file_name() man page.
1623 * The fact is that when $HOME is NULL, .rnd is used.
1625 randfile = RAND_file_name( buffer, sizeof( buffer ) );
1627 } else if (RAND_egd(randfile) > 0) {
1632 if (randfile == NULL) {
1634 LDAP_LOG ( TRANSPORT, DETAIL1,
1635 "tls_seed_PRNG: TLS Use configuration file or "
1636 "$RANDFILE to define seed PRNG\n", 0, 0, 0 );
1638 Debug( LDAP_DEBUG_ANY,
1639 "TLS: Use configuration file or $RANDFILE to define seed PRNG\n",
1645 total = RAND_load_file(randfile, -1);
1647 if (RAND_status() == 0) {
1649 LDAP_LOG ( TRANSPORT, DETAIL1,
1650 "tls_seed_PRNG: TLS PRNG not been seeded with enough data\n",
1653 Debug( LDAP_DEBUG_ANY,
1654 "TLS: PRNG not been seeded with enough data\n",
1660 /* assume if there was enough bits to seed that it's okay
1661 * to write derived bits to the file
1663 RAND_write_file(randfile);
1672 tls_tmp_dh_cb( SSL *ssl, int is_export, int key_length )
1680 ldap_pvt_tls_sb_ctx( Sockbuf *sb )
1685 if (HAS_TLS( sb )) {
1686 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&p );
1695 ldap_pvt_tls_get_strength( void *s )
1700 c = SSL_get_current_cipher((SSL *)s);
1701 return SSL_CIPHER_get_bits(c, NULL);
1709 ldap_pvt_tls_get_my_dn( void *s, struct berval *dn, LDAPDN_rewrite_dummy *func, unsigned flags )
1716 x = SSL_get_certificate((SSL *)s);
1718 if (!x) return LDAP_INVALID_CREDENTIALS;
1720 xn = X509_get_subject_name(x);
1721 rc = ldap_X509dn2bv(xn, dn, (LDAPDN_rewrite_func *)func, flags );
1724 return LDAP_NOT_SUPPORTED;
1729 ldap_start_tls_s ( LDAP *ld,
1730 LDAPControl **serverctrls,
1731 LDAPControl **clientctrls )
1736 char *rspoid = NULL;
1737 struct berval *rspdata = NULL;
1739 /* XXYYZ: this initiates operation only on default connection! */
1741 if ( ld->ld_sb != NULL && ldap_pvt_tls_inplace( ld->ld_sb ) != 0 ) {
1742 return LDAP_LOCAL_ERROR;
1745 rc = ldap_extended_operation_s( ld, LDAP_EXOP_START_TLS,
1746 NULL, serverctrls, clientctrls, &rspoid, &rspdata );
1748 if ( rspoid != NULL ) {
1752 if ( rspdata != NULL ) {
1753 ber_bvfree( rspdata );
1756 if ( rc == LDAP_SUCCESS ) {
1757 rc = ldap_int_tls_start( ld, ld->ld_defconn, NULL );
1761 rc = LDAP_NOT_SUPPORTED;