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-2004 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;
165 char *file = LDAP_STRDUP( tls_opt_randfile );
166 if ( file ) __atoe( file );
167 (void) tls_seed_PRNG( file );
171 (void) tls_seed_PRNG( tls_opt_randfile );
174 #ifdef LDAP_R_COMPILE
178 SSL_load_error_strings();
179 SSLeay_add_ssl_algorithms();
181 /* FIXME: mod_ssl does this */
182 X509V3_add_standard_extensions();
187 * initialize the default context
190 ldap_pvt_tls_init_def_ctx( void )
192 STACK_OF(X509_NAME) *calist;
194 char *ciphersuite = tls_opt_ciphersuite;
195 char *cacertfile = tls_opt_cacertfile;
196 char *cacertdir = tls_opt_cacertdir;
197 char *certfile = tls_opt_certfile;
198 char *keyfile = tls_opt_keyfile;
201 /* This ASCII/EBCDIC handling is a real pain! */
203 ciphersuite = LDAP_STRDUP( ciphersuite );
204 __atoe( ciphersuite );
207 cacertfile = LDAP_STRDUP( cacertfile );
208 __atoe( cacertfile );
211 cacertdir = LDAP_STRDUP( cacertdir );
215 certfile = LDAP_STRDUP( certfile );
219 keyfile = LDAP_STRDUP( keyfile );
224 #ifdef LDAP_R_COMPILE
225 ldap_pvt_thread_mutex_lock( &tls_def_ctx_mutex );
227 if ( tls_def_ctx == NULL ) {
229 tls_def_ctx = SSL_CTX_new( SSLv23_method() );
230 if ( tls_def_ctx == NULL ) {
232 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
233 "TLS could not allocate default ctx (%d).\n",
234 ERR_peek_error(), 0, 0 );
236 Debug( LDAP_DEBUG_ANY,
237 "TLS: could not allocate default ctx (%lu).\n",
238 ERR_peek_error(),0,0);
244 SSL_CTX_set_session_id_context( tls_def_ctx,
245 (const unsigned char *) "OpenLDAP", sizeof("OpenLDAP")-1 );
247 if ( tls_opt_ciphersuite &&
248 !SSL_CTX_set_cipher_list( tls_def_ctx, ciphersuite ) )
251 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
252 "TLS could not set cipher list %s.\n",
253 tls_opt_ciphersuite, 0, 0 );
255 Debug( LDAP_DEBUG_ANY,
256 "TLS: could not set cipher list %s.\n",
257 tls_opt_ciphersuite, 0, 0 );
264 if (tls_opt_cacertfile != NULL || tls_opt_cacertdir != NULL) {
265 if ( !SSL_CTX_load_verify_locations( tls_def_ctx,
266 cacertfile, cacertdir ) ||
267 !SSL_CTX_set_default_verify_paths( tls_def_ctx ) )
270 LDAP_LOG ( TRANSPORT, ERR,
271 "ldap_pvt_tls_init_def_ctx: "
272 "TLS could not load verify locations "
273 "(file:`%s',dir:`%s').\n",
274 tls_opt_cacertfile ? tls_opt_cacertfile : "",
275 tls_opt_cacertdir ? tls_opt_cacertdir : "", 0 );
277 Debug( LDAP_DEBUG_ANY, "TLS: "
278 "could not load verify locations (file:`%s',dir:`%s').\n",
279 tls_opt_cacertfile ? tls_opt_cacertfile : "",
280 tls_opt_cacertdir ? tls_opt_cacertdir : "",
288 calist = get_ca_list( cacertfile, cacertdir );
291 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
292 "TLS could not load client CA list (file: `%s',dir:`%s')\n",
293 tls_opt_cacertfile ? tls_opt_cacertfile : "",
294 tls_opt_cacertdir ? tls_opt_cacertdir : "", 0 );
296 Debug( LDAP_DEBUG_ANY, "TLS: "
297 "could not load client CA list (file:`%s',dir:`%s').\n",
298 tls_opt_cacertfile ? tls_opt_cacertfile : "",
299 tls_opt_cacertdir ? tls_opt_cacertdir : "",
307 SSL_CTX_set_client_CA_list( tls_def_ctx, calist );
310 if ( tls_opt_keyfile &&
311 !SSL_CTX_use_PrivateKey_file( tls_def_ctx,
312 keyfile, SSL_FILETYPE_PEM ) )
315 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
316 "TLS could not use key file `%s'.\n", tls_opt_keyfile, 0, 0 );
318 Debug( LDAP_DEBUG_ANY,
319 "TLS: could not use key file `%s'.\n",
320 tls_opt_keyfile,0,0);
327 if ( tls_opt_certfile &&
328 !SSL_CTX_use_certificate_file( tls_def_ctx,
329 certfile, SSL_FILETYPE_PEM ) )
332 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_init_def_ctx: "
333 "TLS could not use certificate `%s'.\n",
334 tls_opt_certfile, 0, 0 );
336 Debug( LDAP_DEBUG_ANY,
337 "TLS: could not use certificate `%s'.\n",
338 tls_opt_certfile,0,0);
345 if ( ( tls_opt_certfile || tls_opt_keyfile ) &&
346 !SSL_CTX_check_private_key( tls_def_ctx ) )
349 LDAP_LOG ( TRANSPORT, ERR,
350 "ldap_pvt_tls_init_def_ctx: TLS private key mismatch.\n",
353 Debug( LDAP_DEBUG_ANY,
354 "TLS: private key mismatch.\n",
362 if ( tls_opt_trace ) {
363 SSL_CTX_set_info_callback( tls_def_ctx, tls_info_cb );
367 if ( tls_opt_require_cert ) {
369 if ( tls_opt_require_cert == LDAP_OPT_X_TLS_DEMAND ||
370 tls_opt_require_cert == LDAP_OPT_X_TLS_HARD ) {
371 i |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
375 SSL_CTX_set_verify( tls_def_ctx, i,
376 tls_opt_require_cert == LDAP_OPT_X_TLS_ALLOW ?
377 tls_verify_ok : tls_verify_cb );
378 SSL_CTX_set_tmp_rsa_callback( tls_def_ctx, tls_tmp_rsa_cb );
379 /* SSL_CTX_set_tmp_dh_callback( tls_def_ctx, tls_tmp_dh_cb ); */
382 if ( rc == -1 && tls_def_ctx != NULL ) {
383 SSL_CTX_free( tls_def_ctx );
387 LDAP_FREE( ciphersuite );
388 LDAP_FREE( cacertfile );
389 LDAP_FREE( cacertdir );
390 LDAP_FREE( certfile );
391 LDAP_FREE( keyfile );
393 #ifdef LDAP_R_COMPILE
394 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
399 static STACK_OF(X509_NAME) *
400 get_ca_list( char * bundle, char * dir )
402 STACK_OF(X509_NAME) *ca_list = NULL;
405 ca_list = SSL_load_client_CA_file( bundle );
407 #if defined(HAVE_DIRENT_H) || defined(dirent)
412 ca_list = sk_X509_NAME_new_null();
415 if ( !SSL_add_dir_cert_subjects_to_stack( ca_list, dir ) &&
417 sk_X509_NAME_free( ca_list );
426 alloc_handle( void *ctx_arg )
432 ctx = (SSL_CTX *) ctx_arg;
434 if ( ldap_pvt_tls_init_def_ctx() < 0 ) return NULL;
438 ssl = SSL_new( ctx );
441 LDAP_LOG ( TRANSPORT, ERR,
442 "alloc_handle: TLS can't create ssl handle.\n", 0, 0, 0 );
444 Debug( LDAP_DEBUG_ANY,"TLS: can't create ssl handle.\n",0,0,0);
452 update_flags( Sockbuf *sb, SSL * ssl, int rc )
454 int err = SSL_get_error(ssl, rc);
456 sb->sb_trans_needs_read = 0;
457 sb->sb_trans_needs_write = 0;
459 if (err == SSL_ERROR_WANT_READ) {
460 sb->sb_trans_needs_read = 1;
463 } else if (err == SSL_ERROR_WANT_WRITE) {
464 sb->sb_trans_needs_write = 1;
467 } else if (err == SSL_ERROR_WANT_CONNECT) {
474 * TLS support for LBER Sockbufs
479 Sockbuf_IO_Desc *sbiod;
482 static BIO_METHOD sb_tls_bio_method;
485 sb_tls_setup( Sockbuf_IO_Desc *sbiod, void *arg )
490 assert( sbiod != NULL );
492 p = LBER_MALLOC( sizeof( *p ) );
499 bio = BIO_new( &sb_tls_bio_method );
500 bio->ptr = (void *)p;
501 SSL_set_bio( p->ssl, bio, bio );
502 sbiod->sbiod_pvt = p;
507 sb_tls_remove( Sockbuf_IO_Desc *sbiod )
511 assert( sbiod != NULL );
512 assert( sbiod->sbiod_pvt != NULL );
514 p = (struct tls_data *)sbiod->sbiod_pvt;
516 LBER_FREE( sbiod->sbiod_pvt );
517 sbiod->sbiod_pvt = NULL;
522 sb_tls_close( Sockbuf_IO_Desc *sbiod )
526 assert( sbiod != NULL );
527 assert( sbiod->sbiod_pvt != NULL );
529 p = (struct tls_data *)sbiod->sbiod_pvt;
530 SSL_shutdown( p->ssl );
535 sb_tls_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
539 assert( sbiod != NULL );
540 assert( sbiod->sbiod_pvt != NULL );
542 p = (struct tls_data *)sbiod->sbiod_pvt;
544 if ( opt == LBER_SB_OPT_GET_SSL ) {
545 *((SSL **)arg) = p->ssl;
548 } else if ( opt == LBER_SB_OPT_DATA_READY ) {
549 if( SSL_pending( p->ssl ) > 0 ) {
554 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
558 sb_tls_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
564 assert( sbiod != NULL );
565 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
567 p = (struct tls_data *)sbiod->sbiod_pvt;
569 ret = SSL_read( p->ssl, (char *)buf, len );
571 errno = WSAGetLastError();
573 err = SSL_get_error( p->ssl, ret );
574 if (err == SSL_ERROR_WANT_READ ) {
575 sbiod->sbiod_sb->sb_trans_needs_read = 1;
579 sbiod->sbiod_sb->sb_trans_needs_read = 0;
584 sb_tls_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
590 assert( sbiod != NULL );
591 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
593 p = (struct tls_data *)sbiod->sbiod_pvt;
595 ret = SSL_write( p->ssl, (char *)buf, len );
597 errno = WSAGetLastError();
599 err = SSL_get_error( p->ssl, ret );
600 if (err == SSL_ERROR_WANT_WRITE ) {
601 sbiod->sbiod_sb->sb_trans_needs_write = 1;
605 sbiod->sbiod_sb->sb_trans_needs_write = 0;
610 static Sockbuf_IO sb_tls_sbio =
612 sb_tls_setup, /* sbi_setup */
613 sb_tls_remove, /* sbi_remove */
614 sb_tls_ctrl, /* sbi_ctrl */
615 sb_tls_read, /* sbi_read */
616 sb_tls_write, /* sbi_write */
617 sb_tls_close /* sbi_close */
621 sb_tls_bio_create( BIO *b ) {
630 sb_tls_bio_destroy( BIO *b )
632 if ( b == NULL ) return 0;
634 b->ptr = NULL; /* sb_tls_remove() will free it */
641 sb_tls_bio_read( BIO *b, char *buf, int len )
646 if ( buf == NULL || len <= 0 ) return 0;
648 p = (struct tls_data *)b->ptr;
650 if ( p == NULL || p->sbiod == NULL ) {
654 ret = LBER_SBIOD_READ_NEXT( p->sbiod, buf, len );
656 BIO_clear_retry_flags( b );
659 if ( err == EAGAIN || err == EWOULDBLOCK ) {
660 BIO_set_retry_read( b );
668 sb_tls_bio_write( BIO *b, const char *buf, int len )
673 if ( buf == NULL || len <= 0 ) return 0;
675 p = (struct tls_data *)b->ptr;
677 if ( p == NULL || p->sbiod == NULL ) {
681 ret = LBER_SBIOD_WRITE_NEXT( p->sbiod, (char *)buf, len );
683 BIO_clear_retry_flags( b );
686 if ( err == EAGAIN || err == EWOULDBLOCK ) {
687 BIO_set_retry_write( b );
695 sb_tls_bio_ctrl( BIO *b, int cmd, long num, void *ptr )
697 if ( cmd == BIO_CTRL_FLUSH ) {
698 /* The OpenSSL library needs this */
705 sb_tls_bio_gets( BIO *b, char *buf, int len )
711 sb_tls_bio_puts( BIO *b, const char *str )
713 return sb_tls_bio_write( b, str, strlen( str ) );
716 static BIO_METHOD sb_tls_bio_method =
718 ( 100 | 0x400 ), /* it's a source/sink BIO */
730 * Call this to do a TLS connect on a sockbuf. ctx_arg can be
731 * a SSL_CTX * or NULL, in which case the default ctx is used.
735 * 0 - Success. Connection is ready for communication.
736 * <0 - Error. Can't create a TLS stream.
737 * >0 - Partial success.
738 * Do a select (using information from lber_pvt_sb_needs_{read,write}
743 ldap_int_tls_connect( LDAP *ld, LDAPConn *conn )
745 Sockbuf *sb = conn->lconn_sb;
749 if ( HAS_TLS( sb ) ) {
750 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
753 void *ctx = ld->ld_defconn
754 ? ld->ld_defconn->lconn_tls_ctx : NULL;
756 ssl = alloc_handle( ctx );
758 if ( ssl == NULL ) return -1;
761 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
762 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
764 ber_sockbuf_add_io( sb, &sb_tls_sbio,
765 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
768 conn->lconn_tls_ctx = tls_def_ctx;
772 err = SSL_connect( ssl );
775 errno = WSAGetLastError();
779 if ( update_flags( sb, ssl, err )) {
783 if ((err = ERR_peek_error())) {
785 ld->ld_error = LDAP_STRDUP(ERR_error_string(err, buf));
787 if ( ld->ld_error ) __etoa(ld->ld_error);
792 LDAP_LOG ( TRANSPORT, ERR,
793 "ldap_int_tls_connect: TLS can't connect.\n", 0, 0, 0 );
795 Debug( LDAP_DEBUG_ANY,"TLS: can't connect.\n",0,0,0);
798 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
799 LBER_SBIOD_LEVEL_TRANSPORT );
801 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
802 LBER_SBIOD_LEVEL_TRANSPORT );
811 * Call this to do a TLS accept on a sockbuf.
812 * Everything else is the same as with tls_connect.
815 ldap_pvt_tls_accept( Sockbuf *sb, void *ctx_arg )
820 if ( HAS_TLS( sb ) ) {
821 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
824 ssl = alloc_handle( ctx_arg );
825 if ( ssl == NULL ) return -1;
828 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
829 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
831 ber_sockbuf_add_io( sb, &sb_tls_sbio,
832 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
835 err = SSL_accept( ssl );
838 errno = WSAGetLastError();
841 if ( update_flags( sb, ssl, err )) return 1;
844 LDAP_LOG ( TRANSPORT, ERR,
845 "ldap_pvt_tls_accept: TLS can't accept.\n", 0, 0, 0 );
847 Debug( LDAP_DEBUG_ANY,"TLS: can't accept.\n",0,0,0 );
851 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
852 LBER_SBIOD_LEVEL_TRANSPORT );
854 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
855 LBER_SBIOD_LEVEL_TRANSPORT );
864 ldap_pvt_tls_inplace ( Sockbuf *sb )
866 return HAS_TLS( sb ) ? 1 : 0;
870 tls_get_cert( SSL *s )
872 /* If peer cert was bad, treat as if no cert was given */
873 if (SSL_get_verify_result(s)) {
874 /* If we can send an alert, do so */
875 if (SSL_version(s) != SSL2_VERSION) {
876 ssl3_send_alert(s,SSL3_AL_WARNING,SSL3_AD_BAD_CERTIFICATE);
880 return SSL_get_peer_certificate(s);
884 ldap_pvt_tls_get_peer_dn( void *s, struct berval *dn, 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))
982 i = X509_get_ext_by_NID(x, NID_subject_alt_name, -1);
985 STACK_OF(GENERAL_NAME) *alt;
987 ex = X509_get_ext(x, i);
988 alt = X509V3_EXT_d2i(ex);
990 int n, len1 = 0, len2 = 0;
994 if (ntype == IS_DNS) {
996 domain = strchr(name, '.');
998 len2 = len1 - (domain-name);
1001 n = sk_GENERAL_NAME_num(alt);
1002 for (i=0; i<n; i++) {
1005 gn = sk_GENERAL_NAME_value(alt, i);
1006 if (gn->type == GEN_DNS) {
1007 if (ntype != IS_DNS) continue;
1009 sn = (char *) ASN1_STRING_data(gn->d.ia5);
1010 sl = ASN1_STRING_length(gn->d.ia5);
1012 /* Is this an exact match? */
1013 if ((len1 == sl) && !strncasecmp(name, sn, len1)) {
1017 /* Is this a wildcard match? */
1018 if ((*sn == '*') && domain && (len2 == sl-1) &&
1019 !strncasecmp(domain, sn+1, len2)) {
1024 /* Is this a RFC 2459 style wildcard match? */
1025 if ((*sn == '.') && domain && (len2 == sl) &&
1026 !strncasecmp(domain, sn, len2)) {
1030 } else if (gn->type == GEN_IPADD) {
1031 if (ntype == IS_DNS) continue;
1033 sn = (char *) ASN1_STRING_data(gn->d.ia5);
1034 sl = ASN1_STRING_length(gn->d.ia5);
1036 #ifdef LDAP_PF_INET6
1037 if (ntype == IS_IP6 && sl != sizeof(struct in6_addr)) {
1041 if (ntype == IS_IP4 && sl != sizeof(struct in_addr)) {
1044 if (!memcmp(sn, &addr, sl)) {
1050 GENERAL_NAMES_free(alt);
1051 if (i < n) { /* Found a match */
1057 if (ret != LDAP_SUCCESS) {
1061 xn = X509_get_subject_name(x);
1063 if( X509_NAME_get_text_by_NID( xn, NID_commonName,
1064 buf, sizeof(buf)) == -1)
1067 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_check_hostname: "
1068 "TLS unable to get common name from peer certificate.\n",
1071 Debug( LDAP_DEBUG_ANY,
1072 "TLS: unable to get common name from peer certificate.\n",
1075 ld->ld_error = LDAP_STRDUP(
1076 _("TLS: unable to get CN from peer certificate"));
1078 } else if (strcasecmp(name, buf)) {
1080 LDAP_LOG ( TRANSPORT, ERR, "ldap_pvt_tls_check_hostname: "
1081 "TLS hostname (%s) does not match "
1082 "common name in certificate (%s).\n", name, buf, 0 );
1084 Debug( LDAP_DEBUG_ANY, "TLS: hostname (%s) does not match "
1085 "common name in certificate (%s).\n",
1088 ret = LDAP_CONNECT_ERROR;
1089 ld->ld_error = LDAP_STRDUP(
1090 _("TLS: hostname does not match CN in peer certificate"));
1101 ldap_pvt_tls_get_peer_issuer( void *s )
1103 #if 0 /* currently unused; see ldap_pvt_tls_get_peer_dn() if needed */
1108 x = SSL_get_peer_certificate((SSL *)s);
1110 if (!x) return NULL;
1112 xn = X509_get_issuer_name(x);
1113 p = LDAP_STRDUP(X509_NAME_oneline(xn, buf, sizeof(buf)));
1122 ldap_int_tls_config( LDAP *ld, int option, const char *arg )
1127 case LDAP_OPT_X_TLS_CACERTFILE:
1128 case LDAP_OPT_X_TLS_CACERTDIR:
1129 case LDAP_OPT_X_TLS_CERTFILE:
1130 case LDAP_OPT_X_TLS_KEYFILE:
1131 case LDAP_OPT_X_TLS_RANDOM_FILE:
1132 return ldap_pvt_tls_set_option( ld, option, (void *) arg );
1134 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1135 case LDAP_OPT_X_TLS:
1137 if ( strcasecmp( arg, "never" ) == 0 ) {
1138 i = LDAP_OPT_X_TLS_NEVER ;
1140 } else if ( strcasecmp( arg, "demand" ) == 0 ) {
1141 i = LDAP_OPT_X_TLS_DEMAND ;
1143 } else if ( strcasecmp( arg, "allow" ) == 0 ) {
1144 i = LDAP_OPT_X_TLS_ALLOW ;
1146 } else if ( strcasecmp( arg, "try" ) == 0 ) {
1147 i = LDAP_OPT_X_TLS_TRY ;
1149 } else if ( ( strcasecmp( arg, "hard" ) == 0 ) ||
1150 ( strcasecmp( arg, "on" ) == 0 ) ||
1151 ( strcasecmp( arg, "yes" ) == 0) ||
1152 ( strcasecmp( arg, "true" ) == 0 ) )
1154 i = LDAP_OPT_X_TLS_HARD ;
1158 return ldap_pvt_tls_set_option( ld, option, &i );
1167 ldap_pvt_tls_get_option( LDAP *ld, int option, void *arg )
1169 struct ldapoptions *lo;
1172 assert( LDAP_VALID( ld ) );
1174 if( !LDAP_VALID( ld ) ) {
1175 return LDAP_OPT_ERROR;
1178 lo = &ld->ld_options;
1181 /* Get pointer to global option structure */
1182 lo = LDAP_INT_GLOBAL_OPT();
1184 return LDAP_NO_MEMORY;
1189 case LDAP_OPT_X_TLS:
1190 *(int *)arg = lo->ldo_tls_mode;
1192 case LDAP_OPT_X_TLS_CTX:
1194 *(void **)arg = (void *) tls_def_ctx;
1196 *(void **)arg = ld->ld_defconn->lconn_tls_ctx;
1199 case LDAP_OPT_X_TLS_CACERTFILE:
1200 *(char **)arg = tls_opt_cacertfile ?
1201 LDAP_STRDUP( tls_opt_cacertfile ) : NULL;
1203 case LDAP_OPT_X_TLS_CACERTDIR:
1204 *(char **)arg = tls_opt_cacertdir ?
1205 LDAP_STRDUP( tls_opt_cacertdir ) : NULL;
1207 case LDAP_OPT_X_TLS_CERTFILE:
1208 *(char **)arg = tls_opt_certfile ?
1209 LDAP_STRDUP( tls_opt_certfile ) : NULL;
1211 case LDAP_OPT_X_TLS_KEYFILE:
1212 *(char **)arg = tls_opt_keyfile ?
1213 LDAP_STRDUP( tls_opt_keyfile ) : NULL;
1215 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1216 *(int *)arg = tls_opt_require_cert;
1218 case LDAP_OPT_X_TLS_RANDOM_FILE:
1219 *(char **)arg = tls_opt_randfile ?
1220 LDAP_STRDUP( tls_opt_randfile ) : NULL;
1222 case LDAP_OPT_X_TLS_SSL_CTX: {
1225 LDAPConn *conn = ld->ld_defconn;
1226 if ( conn != NULL ) {
1227 Sockbuf *sb = conn->lconn_sb;
1228 retval = ldap_pvt_tls_sb_ctx( sb );
1231 *(void **)arg = retval;
1241 ldap_pvt_tls_set_option( LDAP *ld, int option, void *arg )
1243 struct ldapoptions *lo;
1246 assert( LDAP_VALID( ld ) );
1248 if( !LDAP_VALID( ld ) ) {
1249 return LDAP_OPT_ERROR;
1252 lo = &ld->ld_options;
1255 /* Get pointer to global option structure */
1256 lo = LDAP_INT_GLOBAL_OPT();
1258 return LDAP_NO_MEMORY;
1263 case LDAP_OPT_X_TLS:
1264 switch( *(int *) arg ) {
1265 case LDAP_OPT_X_TLS_NEVER:
1266 case LDAP_OPT_X_TLS_DEMAND:
1267 case LDAP_OPT_X_TLS_ALLOW:
1268 case LDAP_OPT_X_TLS_TRY:
1269 case LDAP_OPT_X_TLS_HARD:
1271 lo->ldo_tls_mode = *(int *)arg;
1278 case LDAP_OPT_X_TLS_CTX:
1280 tls_def_ctx = (SSL_CTX *) arg;
1283 ld->ld_defconn->lconn_tls_ctx = arg;
1293 case LDAP_OPT_X_TLS_CACERTFILE:
1294 if ( tls_opt_cacertfile ) LDAP_FREE( tls_opt_cacertfile );
1295 tls_opt_cacertfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1297 case LDAP_OPT_X_TLS_CACERTDIR:
1298 if ( tls_opt_cacertdir ) LDAP_FREE( tls_opt_cacertdir );
1299 tls_opt_cacertdir = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1301 case LDAP_OPT_X_TLS_CERTFILE:
1302 if ( tls_opt_certfile ) LDAP_FREE( tls_opt_certfile );
1303 tls_opt_certfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1305 case LDAP_OPT_X_TLS_KEYFILE:
1306 if ( tls_opt_keyfile ) LDAP_FREE( tls_opt_keyfile );
1307 tls_opt_keyfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1309 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1310 switch( *(int *) arg ) {
1311 case LDAP_OPT_X_TLS_NEVER:
1312 case LDAP_OPT_X_TLS_DEMAND:
1313 case LDAP_OPT_X_TLS_ALLOW:
1314 case LDAP_OPT_X_TLS_TRY:
1315 case LDAP_OPT_X_TLS_HARD:
1316 tls_opt_require_cert = * (int *) arg;
1320 case LDAP_OPT_X_TLS_CIPHER_SUITE:
1321 if ( tls_opt_ciphersuite ) LDAP_FREE( tls_opt_ciphersuite );
1322 tls_opt_ciphersuite = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1324 case LDAP_OPT_X_TLS_RANDOM_FILE:
1325 if (tls_opt_randfile ) LDAP_FREE (tls_opt_randfile );
1326 tls_opt_randfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1335 ldap_int_tls_start ( LDAP *ld, LDAPConn *conn, LDAPURLDesc *srv )
1337 Sockbuf *sb = conn->lconn_sb;
1342 host = srv->lud_host;
1344 host = conn->lconn_server->lud_host;
1347 /* avoid NULL host */
1348 if( host == NULL ) {
1352 (void) ldap_pvt_tls_init();
1355 * Fortunately, the lib uses blocking io...
1357 if ( ldap_int_tls_connect( ld, conn ) < 0 ) {
1358 ld->ld_errno = LDAP_CONNECT_ERROR;
1359 return (ld->ld_errno);
1362 ssl = ldap_pvt_tls_sb_ctx( sb );
1363 assert( ssl != NULL );
1366 * compare host with name(s) in certificate
1368 if (tls_opt_require_cert != LDAP_OPT_X_TLS_NEVER) {
1369 ld->ld_errno = ldap_pvt_tls_check_hostname( ld, ssl, host );
1370 if (ld->ld_errno != LDAP_SUCCESS) {
1371 return ld->ld_errno;
1375 return LDAP_SUCCESS;
1378 /* Derived from openssl/apps/s_cb.c */
1380 tls_info_cb( const SSL *ssl, int where, int ret )
1384 char *state = (char *) SSL_state_string_long( (SSL *)ssl );
1386 w = where & ~SSL_ST_MASK;
1387 if ( w & SSL_ST_CONNECT ) {
1389 } else if ( w & SSL_ST_ACCEPT ) {
1397 state = LDAP_STRDUP( state );
1401 if ( where & SSL_CB_LOOP ) {
1403 LDAP_LOG ( TRANSPORT, DETAIL1, "tls_info_cb: "
1404 "TLS trace: %s:%s\n", op, state, 0 );
1406 Debug( LDAP_DEBUG_TRACE,
1407 "TLS trace: %s:%s\n",
1411 } else if ( where & SSL_CB_ALERT ) {
1412 char *atype = (char *) SSL_alert_type_string_long( ret );
1413 char *adesc = (char *) SSL_alert_desc_string_long( ret );
1414 op = ( where & SSL_CB_READ ) ? "read" : "write";
1417 atype = LDAP_STRDUP( atype );
1421 adesc = LDAP_STRDUP( adesc );
1426 LDAP_LOG ( TRANSPORT, DETAIL1,
1427 "tls_info_cb: TLS trace: SSL3 alert %s:%s:%s\n",
1430 Debug( LDAP_DEBUG_TRACE,
1431 "TLS trace: SSL3 alert %s:%s:%s\n",
1435 if ( atype ) LDAP_FREE( atype );
1436 if ( adesc ) LDAP_FREE( adesc );
1438 } else if ( where & SSL_CB_EXIT ) {
1441 LDAP_LOG ( TRANSPORT, ERR,
1442 "tls_info_cb: TLS trace: %s:failed in %s\n",
1445 Debug( LDAP_DEBUG_TRACE,
1446 "TLS trace: %s:failed in %s\n",
1449 } else if ( ret < 0 ) {
1451 LDAP_LOG ( TRANSPORT, ERR,
1452 "tls_info_cb: TLS trace: %s:error in %s\n",
1455 Debug( LDAP_DEBUG_TRACE,
1456 "TLS trace: %s:error in %s\n",
1462 if ( state ) LDAP_FREE( state );
1467 tls_verify_cb( int ok, X509_STORE_CTX *ctx )
1476 char *certerr = NULL;
1478 cert = X509_STORE_CTX_get_current_cert( ctx );
1479 errnum = X509_STORE_CTX_get_error( ctx );
1480 errdepth = X509_STORE_CTX_get_error_depth( ctx );
1483 * X509_get_*_name return pointers to the internal copies of
1484 * those things requested. So do not free them.
1486 subject = X509_get_subject_name( cert );
1487 issuer = X509_get_issuer_name( cert );
1488 /* X509_NAME_oneline, if passed a NULL buf, allocate memomry */
1489 sname = X509_NAME_oneline( subject, NULL, 0 );
1490 iname = X509_NAME_oneline( issuer, NULL, 0 );
1491 if ( !ok ) certerr = (char *)X509_verify_cert_error_string( errnum );
1493 if ( sname ) __etoa( sname );
1494 if ( iname ) __etoa( iname );
1496 certerr = LDAP_STRDUP( certerr );
1501 LDAP_LOG( TRANSPORT, ERR,
1502 "TLS certificate verification: depth: %d, err: %d, subject: %s,",
1504 sname ? sname : "-unknown-" );
1505 LDAP_LOG( TRANSPORT, ERR, " issuer: %s\n", iname ? iname : "-unknown-", 0, 0 );
1507 LDAP_LOG ( TRANSPORT, ERR,
1508 "TLS certificate verification: Error, %s\n",
1512 Debug( LDAP_DEBUG_TRACE,
1513 "TLS certificate verification: depth: %d, err: %d, subject: %s,",
1515 sname ? sname : "-unknown-" );
1516 Debug( LDAP_DEBUG_TRACE, " issuer: %s\n", iname ? iname : "-unknown-", 0, 0 );
1518 Debug( LDAP_DEBUG_ANY,
1519 "TLS certificate verification: Error, %s\n",
1524 CRYPTO_free ( sname );
1526 CRYPTO_free ( iname );
1528 if ( certerr ) LDAP_FREE( certerr );
1534 tls_verify_ok( int ok, X509_STORE_CTX *ctx )
1536 (void) tls_verify_cb( ok, ctx );
1540 /* Inspired by ERR_print_errors in OpenSSL */
1542 tls_report_error( void )
1549 while ( ( l = ERR_get_error_line( &file, &line ) ) != 0 ) {
1550 ERR_error_string_n( l, buf, sizeof( buf ) );
1553 file = LDAP_STRDUP( file );
1554 __etoa( (char *)file );
1559 LDAP_LOG ( TRANSPORT, ERR,
1560 "tls_report_error: TLS %s %s:%d\n",
1563 Debug( LDAP_DEBUG_ANY, "TLS: %s %s:%d\n",
1567 if ( file ) LDAP_FREE( (void *)file );
1573 tls_tmp_rsa_cb( SSL *ssl, int is_export, int key_length )
1577 /* FIXME: Pregenerate the key on startup */
1578 /* FIXME: Who frees the key? */
1579 tmp_rsa = RSA_generate_key( key_length, RSA_F4, NULL, NULL );
1583 LDAP_LOG ( TRANSPORT, ERR,
1584 "tls_tmp_rsa_cb: TLS Failed to generate temporary %d-bit %s "
1585 "RSA key\n", key_length, is_export ? "export" : "domestic", 0 );
1587 Debug( LDAP_DEBUG_ANY,
1588 "TLS: Failed to generate temporary %d-bit %s RSA key\n",
1589 key_length, is_export ? "export" : "domestic", 0 );
1597 tls_seed_PRNG( const char *randfile )
1599 #ifndef URANDOM_DEVICE
1600 /* no /dev/urandom (or equiv) */
1602 char buffer[MAXPATHLEN];
1604 if (randfile == NULL) {
1605 /* The seed file is $RANDFILE if defined, otherwise $HOME/.rnd.
1606 * If $HOME is not set or buffer too small to hold the pathname,
1607 * an error occurs. - From RAND_file_name() man page.
1608 * The fact is that when $HOME is NULL, .rnd is used.
1610 randfile = RAND_file_name( buffer, sizeof( buffer ) );
1612 } else if (RAND_egd(randfile) > 0) {
1617 if (randfile == NULL) {
1619 LDAP_LOG ( TRANSPORT, DETAIL1,
1620 "tls_seed_PRNG: TLS Use configuration file or "
1621 "$RANDFILE to define seed PRNG\n", 0, 0, 0 );
1623 Debug( LDAP_DEBUG_ANY,
1624 "TLS: Use configuration file or $RANDFILE to define seed PRNG\n",
1630 total = RAND_load_file(randfile, -1);
1632 if (RAND_status() == 0) {
1634 LDAP_LOG ( TRANSPORT, DETAIL1,
1635 "tls_seed_PRNG: TLS PRNG not been seeded with enough data\n",
1638 Debug( LDAP_DEBUG_ANY,
1639 "TLS: PRNG not been seeded with enough data\n",
1645 /* assume if there was enough bits to seed that it's okay
1646 * to write derived bits to the file
1648 RAND_write_file(randfile);
1657 tls_tmp_dh_cb( SSL *ssl, int is_export, int key_length )
1665 ldap_pvt_tls_sb_ctx( Sockbuf *sb )
1670 if (HAS_TLS( sb )) {
1671 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&p );
1680 ldap_pvt_tls_get_strength( void *s )
1685 c = SSL_get_current_cipher((SSL *)s);
1686 return SSL_CIPHER_get_bits(c, NULL);
1694 ldap_pvt_tls_get_my_dn( void *s, struct berval *dn, LDAPDN_rewrite_dummy *func, unsigned flags )
1701 x = SSL_get_certificate((SSL *)s);
1703 if (!x) return LDAP_INVALID_CREDENTIALS;
1705 xn = X509_get_subject_name(x);
1706 rc = ldap_X509dn2bv(xn, dn, (LDAPDN_rewrite_func *)func, flags );
1709 return LDAP_NOT_SUPPORTED;
1714 ldap_start_tls_s ( LDAP *ld,
1715 LDAPControl **serverctrls,
1716 LDAPControl **clientctrls )
1721 char *rspoid = NULL;
1722 struct berval *rspdata = NULL;
1724 /* XXYYZ: this initiates operation only on default connection! */
1726 if ( ld->ld_sb != NULL && ldap_pvt_tls_inplace( ld->ld_sb ) != 0 ) {
1727 return LDAP_LOCAL_ERROR;
1730 rc = ldap_extended_operation_s( ld, LDAP_EXOP_START_TLS,
1731 NULL, serverctrls, clientctrls, &rspoid, &rspdata );
1733 if ( rspoid != NULL ) {
1737 if ( rspdata != NULL ) {
1738 ber_bvfree( rspdata );
1741 if ( rc == LDAP_SUCCESS ) {
1742 rc = ldap_int_tls_start( ld, ld->ld_defconn, NULL );
1746 rc = LDAP_NOT_SUPPORTED;