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 #ifdef HAVE_OPENSSL_CRL
57 static int tls_opt_crlcheck = LDAP_OPT_X_TLS_CRL_NONE;
59 static char *tls_opt_ciphersuite = NULL;
60 static char *tls_opt_randfile = NULL;
62 #define HAS_TLS( sb ) ber_sockbuf_ctrl( sb, LBER_SB_OPT_HAS_IO, \
63 (void *)&sb_tls_sbio )
65 static void tls_report_error( void );
67 static void tls_info_cb( const SSL *ssl, int where, int ret );
68 static int tls_verify_cb( int ok, X509_STORE_CTX *ctx );
69 static int tls_verify_ok( int ok, X509_STORE_CTX *ctx );
70 static RSA * tls_tmp_rsa_cb( SSL *ssl, int is_export, int key_length );
71 static STACK_OF(X509_NAME) * get_ca_list( char * bundle, char * dir );
73 #if 0 /* Currently this is not used by anyone */
74 static DH * tls_tmp_dh_cb( SSL *ssl, int is_export, int key_length );
77 static SSL_CTX *tls_def_ctx = NULL;
79 static int tls_seed_PRNG( const char *randfile );
83 * provide mutexes for the SSLeay library.
85 static ldap_pvt_thread_mutex_t tls_mutexes[CRYPTO_NUM_LOCKS];
87 static void tls_locking_cb( int mode, int type, const char *file, int line )
89 if ( mode & CRYPTO_LOCK ) {
90 ldap_pvt_thread_mutex_lock( &tls_mutexes[type] );
92 ldap_pvt_thread_mutex_unlock( &tls_mutexes[type] );
97 * an extra mutex for the default ctx.
100 static ldap_pvt_thread_mutex_t tls_def_ctx_mutex;
102 static void tls_init_threads( void )
106 for( i=0; i< CRYPTO_NUM_LOCKS ; i++ ) {
107 ldap_pvt_thread_mutex_init( &tls_mutexes[i] );
109 CRYPTO_set_locking_callback( tls_locking_cb );
110 /* FIXME: the thread id should be added somehow... */
112 ldap_pvt_thread_mutex_init( &tls_def_ctx_mutex );
114 #endif /* LDAP_R_COMPILE */
117 * Tear down the TLS subsystem. Should only be called once.
120 ldap_pvt_tls_destroy( void )
122 SSL_CTX_free(tls_def_ctx);
129 if ( tls_opt_certfile ) {
130 LDAP_FREE( tls_opt_certfile );
131 tls_opt_certfile = NULL;
133 if ( tls_opt_keyfile ) {
134 LDAP_FREE( tls_opt_keyfile );
135 tls_opt_keyfile = NULL;
137 if ( tls_opt_cacertfile ) {
138 LDAP_FREE( tls_opt_cacertfile );
139 tls_opt_cacertfile = NULL;
141 if ( tls_opt_cacertdir ) {
142 LDAP_FREE( tls_opt_cacertdir );
143 tls_opt_cacertdir = NULL;
145 if ( tls_opt_ciphersuite ) {
146 LDAP_FREE( tls_opt_ciphersuite );
147 tls_opt_ciphersuite = NULL;
149 if ( tls_opt_randfile ) {
150 LDAP_FREE( tls_opt_randfile );
151 tls_opt_randfile = NULL;
156 * Initialize TLS subsystem. Should be called only once.
159 ldap_pvt_tls_init( void )
161 static int tls_initialized = 0;
163 if ( tls_initialized++ ) return 0;
167 char *file = LDAP_STRDUP( tls_opt_randfile );
168 if ( file ) __atoe( file );
169 (void) tls_seed_PRNG( file );
173 (void) tls_seed_PRNG( tls_opt_randfile );
176 #ifdef LDAP_R_COMPILE
180 SSL_load_error_strings();
181 SSLeay_add_ssl_algorithms();
183 /* FIXME: mod_ssl does this */
184 X509V3_add_standard_extensions();
189 * initialize the default context
192 ldap_pvt_tls_init_def_ctx( void )
194 STACK_OF(X509_NAME) *calist;
196 char *ciphersuite = tls_opt_ciphersuite;
197 char *cacertfile = tls_opt_cacertfile;
198 char *cacertdir = tls_opt_cacertdir;
199 char *certfile = tls_opt_certfile;
200 char *keyfile = tls_opt_keyfile;
203 /* This ASCII/EBCDIC handling is a real pain! */
205 ciphersuite = LDAP_STRDUP( ciphersuite );
206 __atoe( ciphersuite );
209 cacertfile = LDAP_STRDUP( cacertfile );
210 __atoe( cacertfile );
213 cacertdir = LDAP_STRDUP( cacertdir );
217 certfile = LDAP_STRDUP( certfile );
221 keyfile = LDAP_STRDUP( keyfile );
226 #ifdef LDAP_R_COMPILE
227 ldap_pvt_thread_mutex_lock( &tls_def_ctx_mutex );
229 if ( tls_def_ctx == NULL ) {
231 tls_def_ctx = SSL_CTX_new( SSLv23_method() );
232 if ( tls_def_ctx == NULL ) {
233 Debug( LDAP_DEBUG_ANY,
234 "TLS: could not allocate default ctx (%lu).\n",
235 ERR_peek_error(),0,0);
240 SSL_CTX_set_session_id_context( tls_def_ctx,
241 (const unsigned char *) "OpenLDAP", sizeof("OpenLDAP")-1 );
243 if ( tls_opt_ciphersuite &&
244 !SSL_CTX_set_cipher_list( tls_def_ctx, ciphersuite ) )
246 Debug( LDAP_DEBUG_ANY,
247 "TLS: could not set cipher list %s.\n",
248 tls_opt_ciphersuite, 0, 0 );
254 if (tls_opt_cacertfile != NULL || tls_opt_cacertdir != NULL) {
255 if ( !SSL_CTX_load_verify_locations( tls_def_ctx,
256 cacertfile, cacertdir ) ||
257 !SSL_CTX_set_default_verify_paths( tls_def_ctx ) )
259 Debug( LDAP_DEBUG_ANY, "TLS: "
260 "could not load verify locations (file:`%s',dir:`%s').\n",
261 tls_opt_cacertfile ? tls_opt_cacertfile : "",
262 tls_opt_cacertdir ? tls_opt_cacertdir : "",
269 calist = get_ca_list( cacertfile, cacertdir );
271 Debug( LDAP_DEBUG_ANY, "TLS: "
272 "could not load client CA list (file:`%s',dir:`%s').\n",
273 tls_opt_cacertfile ? tls_opt_cacertfile : "",
274 tls_opt_cacertdir ? tls_opt_cacertdir : "",
281 SSL_CTX_set_client_CA_list( tls_def_ctx, calist );
284 if ( tls_opt_keyfile &&
285 !SSL_CTX_use_PrivateKey_file( tls_def_ctx,
286 keyfile, SSL_FILETYPE_PEM ) )
288 Debug( LDAP_DEBUG_ANY,
289 "TLS: could not use key file `%s'.\n",
290 tls_opt_keyfile,0,0);
296 if ( tls_opt_certfile &&
297 !SSL_CTX_use_certificate_file( tls_def_ctx,
298 certfile, SSL_FILETYPE_PEM ) )
300 Debug( LDAP_DEBUG_ANY,
301 "TLS: could not use certificate `%s'.\n",
302 tls_opt_certfile,0,0);
308 if ( ( tls_opt_certfile || tls_opt_keyfile ) &&
309 !SSL_CTX_check_private_key( tls_def_ctx ) )
311 Debug( LDAP_DEBUG_ANY,
312 "TLS: private key mismatch.\n",
319 if ( tls_opt_trace ) {
320 SSL_CTX_set_info_callback( tls_def_ctx, tls_info_cb );
324 if ( tls_opt_require_cert ) {
326 if ( tls_opt_require_cert == LDAP_OPT_X_TLS_DEMAND ||
327 tls_opt_require_cert == LDAP_OPT_X_TLS_HARD ) {
328 i |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
332 SSL_CTX_set_verify( tls_def_ctx, i,
333 tls_opt_require_cert == LDAP_OPT_X_TLS_ALLOW ?
334 tls_verify_ok : tls_verify_cb );
335 SSL_CTX_set_tmp_rsa_callback( tls_def_ctx, tls_tmp_rsa_cb );
336 /* SSL_CTX_set_tmp_dh_callback( tls_def_ctx, tls_tmp_dh_cb ); */
337 #ifdef HAVE_OPENSSL_CRL
338 if ( tls_opt_crlcheck ) {
339 X509_STORE *x509_s = SSL_CTX_get_cert_store( tls_def_ctx );
340 if ( tls_opt_crlcheck == LDAP_OPT_X_TLS_CRL_PEER ) {
341 X509_STORE_set_flags( x509_s, X509_V_FLAG_CRL_CHECK );
342 } else if ( tls_opt_crlcheck == LDAP_OPT_X_TLS_CRL_ALL ) {
343 X509_STORE_set_flags( x509_s,
344 X509_V_FLAG_CRL_CHECK | X509_V_FLAG_CRL_CHECK_ALL );
350 if ( rc == -1 && tls_def_ctx != NULL ) {
351 SSL_CTX_free( tls_def_ctx );
355 LDAP_FREE( ciphersuite );
356 LDAP_FREE( cacertfile );
357 LDAP_FREE( cacertdir );
358 LDAP_FREE( certfile );
359 LDAP_FREE( keyfile );
361 #ifdef LDAP_R_COMPILE
362 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
367 static STACK_OF(X509_NAME) *
368 get_ca_list( char * bundle, char * dir )
370 STACK_OF(X509_NAME) *ca_list = NULL;
373 ca_list = SSL_load_client_CA_file( bundle );
375 #if defined(HAVE_DIRENT_H) || defined(dirent)
380 ca_list = sk_X509_NAME_new_null();
383 if ( !SSL_add_dir_cert_subjects_to_stack( ca_list, dir ) &&
385 sk_X509_NAME_free( ca_list );
394 alloc_handle( void *ctx_arg )
400 ctx = (SSL_CTX *) ctx_arg;
402 if ( ldap_pvt_tls_init_def_ctx() < 0 ) return NULL;
406 ssl = SSL_new( ctx );
408 Debug( LDAP_DEBUG_ANY,"TLS: can't create ssl handle.\n",0,0,0);
415 update_flags( Sockbuf *sb, SSL * ssl, int rc )
417 int err = SSL_get_error(ssl, rc);
419 sb->sb_trans_needs_read = 0;
420 sb->sb_trans_needs_write = 0;
422 if (err == SSL_ERROR_WANT_READ) {
423 sb->sb_trans_needs_read = 1;
426 } else if (err == SSL_ERROR_WANT_WRITE) {
427 sb->sb_trans_needs_write = 1;
430 } else if (err == SSL_ERROR_WANT_CONNECT) {
437 * TLS support for LBER Sockbufs
442 Sockbuf_IO_Desc *sbiod;
445 static BIO_METHOD sb_tls_bio_method;
448 sb_tls_setup( Sockbuf_IO_Desc *sbiod, void *arg )
453 assert( sbiod != NULL );
455 p = LBER_MALLOC( sizeof( *p ) );
462 bio = BIO_new( &sb_tls_bio_method );
463 bio->ptr = (void *)p;
464 SSL_set_bio( p->ssl, bio, bio );
465 sbiod->sbiod_pvt = p;
470 sb_tls_remove( Sockbuf_IO_Desc *sbiod )
474 assert( sbiod != NULL );
475 assert( sbiod->sbiod_pvt != NULL );
477 p = (struct tls_data *)sbiod->sbiod_pvt;
479 LBER_FREE( sbiod->sbiod_pvt );
480 sbiod->sbiod_pvt = NULL;
485 sb_tls_close( Sockbuf_IO_Desc *sbiod )
489 assert( sbiod != NULL );
490 assert( sbiod->sbiod_pvt != NULL );
492 p = (struct tls_data *)sbiod->sbiod_pvt;
493 SSL_shutdown( p->ssl );
498 sb_tls_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
502 assert( sbiod != NULL );
503 assert( sbiod->sbiod_pvt != NULL );
505 p = (struct tls_data *)sbiod->sbiod_pvt;
507 if ( opt == LBER_SB_OPT_GET_SSL ) {
508 *((SSL **)arg) = p->ssl;
511 } else if ( opt == LBER_SB_OPT_DATA_READY ) {
512 if( SSL_pending( p->ssl ) > 0 ) {
517 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
521 sb_tls_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
527 assert( sbiod != NULL );
528 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
530 p = (struct tls_data *)sbiod->sbiod_pvt;
532 ret = SSL_read( p->ssl, (char *)buf, len );
534 errno = WSAGetLastError();
536 err = SSL_get_error( p->ssl, ret );
537 if (err == SSL_ERROR_WANT_READ ) {
538 sbiod->sbiod_sb->sb_trans_needs_read = 1;
542 sbiod->sbiod_sb->sb_trans_needs_read = 0;
547 sb_tls_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
553 assert( sbiod != NULL );
554 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
556 p = (struct tls_data *)sbiod->sbiod_pvt;
558 ret = SSL_write( p->ssl, (char *)buf, len );
560 errno = WSAGetLastError();
562 err = SSL_get_error( p->ssl, ret );
563 if (err == SSL_ERROR_WANT_WRITE ) {
564 sbiod->sbiod_sb->sb_trans_needs_write = 1;
568 sbiod->sbiod_sb->sb_trans_needs_write = 0;
573 static Sockbuf_IO sb_tls_sbio =
575 sb_tls_setup, /* sbi_setup */
576 sb_tls_remove, /* sbi_remove */
577 sb_tls_ctrl, /* sbi_ctrl */
578 sb_tls_read, /* sbi_read */
579 sb_tls_write, /* sbi_write */
580 sb_tls_close /* sbi_close */
584 sb_tls_bio_create( BIO *b ) {
593 sb_tls_bio_destroy( BIO *b )
595 if ( b == NULL ) return 0;
597 b->ptr = NULL; /* sb_tls_remove() will free it */
604 sb_tls_bio_read( BIO *b, char *buf, int len )
609 if ( buf == NULL || len <= 0 ) return 0;
611 p = (struct tls_data *)b->ptr;
613 if ( p == NULL || p->sbiod == NULL ) {
617 ret = LBER_SBIOD_READ_NEXT( p->sbiod, buf, len );
619 BIO_clear_retry_flags( b );
622 if ( err == EAGAIN || err == EWOULDBLOCK ) {
623 BIO_set_retry_read( b );
631 sb_tls_bio_write( BIO *b, const char *buf, int len )
636 if ( buf == NULL || len <= 0 ) return 0;
638 p = (struct tls_data *)b->ptr;
640 if ( p == NULL || p->sbiod == NULL ) {
644 ret = LBER_SBIOD_WRITE_NEXT( p->sbiod, (char *)buf, len );
646 BIO_clear_retry_flags( b );
649 if ( err == EAGAIN || err == EWOULDBLOCK ) {
650 BIO_set_retry_write( b );
658 sb_tls_bio_ctrl( BIO *b, int cmd, long num, void *ptr )
660 if ( cmd == BIO_CTRL_FLUSH ) {
661 /* The OpenSSL library needs this */
668 sb_tls_bio_gets( BIO *b, char *buf, int len )
674 sb_tls_bio_puts( BIO *b, const char *str )
676 return sb_tls_bio_write( b, str, strlen( str ) );
679 static BIO_METHOD sb_tls_bio_method =
681 ( 100 | 0x400 ), /* it's a source/sink BIO */
693 * Call this to do a TLS connect on a sockbuf. ctx_arg can be
694 * a SSL_CTX * or NULL, in which case the default ctx is used.
698 * 0 - Success. Connection is ready for communication.
699 * <0 - Error. Can't create a TLS stream.
700 * >0 - Partial success.
701 * Do a select (using information from lber_pvt_sb_needs_{read,write}
706 ldap_int_tls_connect( LDAP *ld, LDAPConn *conn )
708 Sockbuf *sb = conn->lconn_sb;
712 if ( HAS_TLS( sb ) ) {
713 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
716 struct ldapoptions *lo;
717 void *ctx = ld->ld_defconn
718 ? ld->ld_defconn->lconn_tls_ctx : NULL;
720 ssl = alloc_handle( ctx );
722 if ( ssl == NULL ) return -1;
725 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
726 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
728 ber_sockbuf_add_io( sb, &sb_tls_sbio,
729 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
733 conn->lconn_tls_ctx = tls_def_ctx;
735 lo = &ld->ld_options;
736 if ( lo->ldo_tls_connect_cb )
737 lo->ldo_tls_connect_cb( ld, ssl, ctx, lo->ldo_tls_connect_arg );
738 lo = LDAP_INT_GLOBAL_OPT();
739 if ( lo && lo->ldo_tls_connect_cb )
740 lo->ldo_tls_connect_cb( ld, ssl, ctx, lo->ldo_tls_connect_arg );
743 err = SSL_connect( ssl );
746 errno = WSAGetLastError();
750 if ( update_flags( sb, ssl, err )) {
754 if ((err = ERR_peek_error())) {
757 if ( ld->ld_error ) {
758 LDAP_FREE( ld->ld_error );
760 ld->ld_error = LDAP_STRDUP(ERR_error_string(err, buf));
762 if ( ld->ld_error ) __etoa(ld->ld_error);
766 Debug( LDAP_DEBUG_ANY,"TLS: can't connect.\n",0,0,0);
768 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
769 LBER_SBIOD_LEVEL_TRANSPORT );
771 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
772 LBER_SBIOD_LEVEL_TRANSPORT );
781 * Call this to do a TLS accept on a sockbuf.
782 * Everything else is the same as with tls_connect.
785 ldap_pvt_tls_accept( Sockbuf *sb, void *ctx_arg )
790 if ( HAS_TLS( sb ) ) {
791 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
794 ssl = alloc_handle( ctx_arg );
795 if ( ssl == NULL ) return -1;
798 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
799 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
801 ber_sockbuf_add_io( sb, &sb_tls_sbio,
802 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
805 err = SSL_accept( ssl );
808 errno = WSAGetLastError();
811 if ( update_flags( sb, ssl, err )) return 1;
813 Debug( LDAP_DEBUG_ANY,"TLS: can't accept.\n",0,0,0 );
816 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
817 LBER_SBIOD_LEVEL_TRANSPORT );
819 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
820 LBER_SBIOD_LEVEL_TRANSPORT );
829 ldap_pvt_tls_inplace ( Sockbuf *sb )
831 return HAS_TLS( sb ) ? 1 : 0;
835 ldap_tls_inplace( LDAP *ld )
839 if ( ld->ld_defconn && ld->ld_defconn->lconn_sb ) {
840 sb = ld->ld_defconn->lconn_sb;
842 } else if ( ld->ld_sb ) {
849 return ldap_pvt_tls_inplace( sb );
853 tls_get_cert( SSL *s )
855 /* If peer cert was bad, treat as if no cert was given */
856 if (SSL_get_verify_result(s)) {
857 /* If we can send an alert, do so */
858 if (SSL_version(s) != SSL2_VERSION) {
859 ssl3_send_alert(s,SSL3_AL_WARNING,SSL3_AD_BAD_CERTIFICATE);
863 return SSL_get_peer_certificate(s);
867 ldap_pvt_tls_get_peer_dn( void *s, struct berval *dn,
868 LDAPDN_rewrite_dummy *func, unsigned flags )
874 x = tls_get_cert((SSL *)s);
876 if (!x) return LDAP_INVALID_CREDENTIALS;
878 xn = X509_get_subject_name(x);
879 rc = ldap_X509dn2bv(xn, dn, (LDAPDN_rewrite_func *)func, flags);
885 ldap_pvt_tls_get_peer_hostname( void *s )
892 x = tls_get_cert((SSL *)s);
895 xn = X509_get_subject_name(x);
897 ret = X509_NAME_get_text_by_NID(xn, NID_commonName, buf, sizeof(buf));
903 p = LDAP_STRDUP(buf);
908 /* what kind of hostname were we given? */
914 ldap_pvt_tls_check_hostname( LDAP *ld, void *s, const char *name_in )
916 int i, ret = LDAP_LOCAL_ERROR;
922 struct in6_addr addr;
927 if( ldap_int_hostname &&
928 ( !name_in || !strcasecmp( name_in, "localhost" ) ) )
930 name = ldap_int_hostname;
935 x = tls_get_cert((SSL *)s);
937 Debug( LDAP_DEBUG_ANY,
938 "TLS: unable to get peer certificate.\n",
940 /* If this was a fatal condition, things would have
941 * aborted long before now.
947 if (name[0] == '[' && strchr(name, ']')) {
948 char *n2 = ldap_strdup(name+1);
949 *strchr(n2, ']') = 2;
950 if (inet_pton(AF_INET6, n2, &addr))
955 if ((ptr = strrchr(name, '.')) && isdigit((unsigned char)ptr[1])) {
956 if (inet_aton(name, (struct in_addr *)&addr)) ntype = IS_IP4;
959 i = X509_get_ext_by_NID(x, NID_subject_alt_name, -1);
962 STACK_OF(GENERAL_NAME) *alt;
964 ex = X509_get_ext(x, i);
965 alt = X509V3_EXT_d2i(ex);
967 int n, len1 = 0, len2 = 0;
971 if (ntype == IS_DNS) {
973 domain = strchr(name, '.');
975 len2 = len1 - (domain-name);
978 n = sk_GENERAL_NAME_num(alt);
979 for (i=0; i<n; i++) {
982 gn = sk_GENERAL_NAME_value(alt, i);
983 if (gn->type == GEN_DNS) {
984 if (ntype != IS_DNS) continue;
986 sn = (char *) ASN1_STRING_data(gn->d.ia5);
987 sl = ASN1_STRING_length(gn->d.ia5);
990 if (sl == 0) continue;
992 /* Is this an exact match? */
993 if ((len1 == sl) && !strncasecmp(name, sn, len1)) {
997 /* Is this a wildcard match? */
998 if (domain && (sn[0] == '*') && (sn[1] == '.') &&
999 (len2 == sl-1) && !strncasecmp(domain, &sn[1], len2))
1004 } else if (gn->type == GEN_IPADD) {
1005 if (ntype == IS_DNS) continue;
1007 sn = (char *) ASN1_STRING_data(gn->d.ia5);
1008 sl = ASN1_STRING_length(gn->d.ia5);
1010 #ifdef LDAP_PF_INET6
1011 if (ntype == IS_IP6 && sl != sizeof(struct in6_addr)) {
1015 if (ntype == IS_IP4 && sl != sizeof(struct in_addr)) {
1018 if (!memcmp(sn, &addr, sl)) {
1024 GENERAL_NAMES_free(alt);
1025 if (i < n) { /* Found a match */
1031 if (ret != LDAP_SUCCESS) {
1036 xn = X509_get_subject_name(x);
1037 if( X509_NAME_get_text_by_NID( xn, NID_commonName,
1038 buf, sizeof(buf)) == -1)
1040 Debug( LDAP_DEBUG_ANY,
1041 "TLS: unable to get common name from peer certificate.\n",
1043 ret = LDAP_CONNECT_ERROR;
1044 if ( ld->ld_error ) {
1045 LDAP_FREE( ld->ld_error );
1047 ld->ld_error = LDAP_STRDUP(
1048 _("TLS: unable to get CN from peer certificate"));
1050 } else if (strcasecmp(name, buf) == 0 ) {
1053 } else if (( buf[0] == '*' ) && ( buf[1] == '.' )) {
1054 char *domain = strchr(name, '.');
1060 dlen = sl - (domain-name);
1063 /* Is this a wildcard match? */
1064 if ((dlen == sl-1) && !strncasecmp(domain, &buf[1], dlen)) {
1070 if( ret == LDAP_LOCAL_ERROR ) {
1071 Debug( LDAP_DEBUG_ANY, "TLS: hostname (%s) does not match "
1072 "common name in certificate (%s).\n",
1074 ret = LDAP_CONNECT_ERROR;
1075 if ( ld->ld_error ) {
1076 LDAP_FREE( ld->ld_error );
1078 ld->ld_error = LDAP_STRDUP(
1079 _("TLS: hostname does not match CN in peer certificate"));
1087 ldap_pvt_tls_get_peer_issuer( void *s )
1089 #if 0 /* currently unused; see ldap_pvt_tls_get_peer_dn() if needed */
1094 x = SSL_get_peer_certificate((SSL *)s);
1096 if (!x) return NULL;
1098 xn = X509_get_issuer_name(x);
1099 p = LDAP_STRDUP(X509_NAME_oneline(xn, buf, sizeof(buf)));
1108 ldap_int_tls_config( LDAP *ld, int option, const char *arg )
1113 case LDAP_OPT_X_TLS_CACERTFILE:
1114 case LDAP_OPT_X_TLS_CACERTDIR:
1115 case LDAP_OPT_X_TLS_CERTFILE:
1116 case LDAP_OPT_X_TLS_KEYFILE:
1117 case LDAP_OPT_X_TLS_RANDOM_FILE:
1118 case LDAP_OPT_X_TLS_CIPHER_SUITE:
1119 return ldap_pvt_tls_set_option( ld, option, (void *) arg );
1121 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1122 case LDAP_OPT_X_TLS:
1124 if ( strcasecmp( arg, "never" ) == 0 ) {
1125 i = LDAP_OPT_X_TLS_NEVER ;
1127 } else if ( strcasecmp( arg, "demand" ) == 0 ) {
1128 i = LDAP_OPT_X_TLS_DEMAND ;
1130 } else if ( strcasecmp( arg, "allow" ) == 0 ) {
1131 i = LDAP_OPT_X_TLS_ALLOW ;
1133 } else if ( strcasecmp( arg, "try" ) == 0 ) {
1134 i = LDAP_OPT_X_TLS_TRY ;
1136 } else if ( ( strcasecmp( arg, "hard" ) == 0 ) ||
1137 ( strcasecmp( arg, "on" ) == 0 ) ||
1138 ( strcasecmp( arg, "yes" ) == 0) ||
1139 ( strcasecmp( arg, "true" ) == 0 ) )
1141 i = LDAP_OPT_X_TLS_HARD ;
1145 return ldap_pvt_tls_set_option( ld, option, &i );
1148 #ifdef HAVE_OPENSSL_CRL
1149 case LDAP_OPT_X_TLS_CRLCHECK:
1151 if ( strcasecmp( arg, "none" ) == 0 ) {
1152 i = LDAP_OPT_X_TLS_CRL_NONE ;
1153 } else if ( strcasecmp( arg, "peer" ) == 0 ) {
1154 i = LDAP_OPT_X_TLS_CRL_PEER ;
1155 } else if ( strcasecmp( arg, "all" ) == 0 ) {
1156 i = LDAP_OPT_X_TLS_CRL_ALL ;
1159 return ldap_pvt_tls_set_option( ld, option, &i );
1168 ldap_pvt_tls_get_option( LDAP *ld, int option, void *arg )
1170 struct ldapoptions *lo;
1173 assert( LDAP_VALID( ld ) );
1175 if( !LDAP_VALID( ld ) ) {
1176 return LDAP_OPT_ERROR;
1179 lo = &ld->ld_options;
1182 /* Get pointer to global option structure */
1183 lo = LDAP_INT_GLOBAL_OPT();
1185 return LDAP_NO_MEMORY;
1190 case LDAP_OPT_X_TLS:
1191 *(int *)arg = lo->ldo_tls_mode;
1193 case LDAP_OPT_X_TLS_CTX:
1195 *(void **)arg = (void *) tls_def_ctx;
1197 *(void **)arg = ld->ld_defconn->lconn_tls_ctx;
1200 case LDAP_OPT_X_TLS_CACERTFILE:
1201 *(char **)arg = tls_opt_cacertfile ?
1202 LDAP_STRDUP( tls_opt_cacertfile ) : NULL;
1204 case LDAP_OPT_X_TLS_CACERTDIR:
1205 *(char **)arg = tls_opt_cacertdir ?
1206 LDAP_STRDUP( tls_opt_cacertdir ) : NULL;
1208 case LDAP_OPT_X_TLS_CERTFILE:
1209 *(char **)arg = tls_opt_certfile ?
1210 LDAP_STRDUP( tls_opt_certfile ) : NULL;
1212 case LDAP_OPT_X_TLS_KEYFILE:
1213 *(char **)arg = tls_opt_keyfile ?
1214 LDAP_STRDUP( tls_opt_keyfile ) : NULL;
1216 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1217 *(int *)arg = tls_opt_require_cert;
1219 #ifdef HAVE_OPENSSL_CRL
1220 case LDAP_OPT_X_TLS_CRLCHECK:
1221 *(int *)arg = tls_opt_crlcheck;
1224 case LDAP_OPT_X_TLS_RANDOM_FILE:
1225 *(char **)arg = tls_opt_randfile ?
1226 LDAP_STRDUP( tls_opt_randfile ) : NULL;
1228 case LDAP_OPT_X_TLS_SSL_CTX: {
1231 LDAPConn *conn = ld->ld_defconn;
1232 if ( conn != NULL ) {
1233 Sockbuf *sb = conn->lconn_sb;
1234 retval = ldap_pvt_tls_sb_ctx( sb );
1237 *(void **)arg = retval;
1240 case LDAP_OPT_X_TLS_CONNECT_CB:
1241 *(LDAP_TLS_CONNECT_CB **)arg = lo->ldo_tls_connect_cb;
1243 case LDAP_OPT_X_TLS_CONNECT_ARG:
1244 *(void **)arg = lo->ldo_tls_connect_arg;
1253 ldap_pvt_tls_set_option( LDAP *ld, int option, void *arg )
1255 struct ldapoptions *lo;
1258 assert( LDAP_VALID( ld ) );
1260 if( !LDAP_VALID( ld ) ) {
1261 return LDAP_OPT_ERROR;
1264 lo = &ld->ld_options;
1267 /* Get pointer to global option structure */
1268 lo = LDAP_INT_GLOBAL_OPT();
1270 return LDAP_NO_MEMORY;
1275 case LDAP_OPT_X_TLS:
1276 switch( *(int *) arg ) {
1277 case LDAP_OPT_X_TLS_NEVER:
1278 case LDAP_OPT_X_TLS_DEMAND:
1279 case LDAP_OPT_X_TLS_ALLOW:
1280 case LDAP_OPT_X_TLS_TRY:
1281 case LDAP_OPT_X_TLS_HARD:
1283 lo->ldo_tls_mode = *(int *)arg;
1290 case LDAP_OPT_X_TLS_CTX:
1292 tls_def_ctx = (SSL_CTX *) arg;
1295 ld->ld_defconn->lconn_tls_ctx = arg;
1298 case LDAP_OPT_X_TLS_CONNECT_CB:
1299 lo->ldo_tls_connect_cb = (LDAP_TLS_CONNECT_CB *)arg;
1301 case LDAP_OPT_X_TLS_CONNECT_ARG:
1302 lo->ldo_tls_connect_arg = arg;
1311 case LDAP_OPT_X_TLS_CACERTFILE:
1312 if ( tls_opt_cacertfile ) LDAP_FREE( tls_opt_cacertfile );
1313 tls_opt_cacertfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1315 case LDAP_OPT_X_TLS_CACERTDIR:
1316 if ( tls_opt_cacertdir ) LDAP_FREE( tls_opt_cacertdir );
1317 tls_opt_cacertdir = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1319 case LDAP_OPT_X_TLS_CERTFILE:
1320 if ( tls_opt_certfile ) LDAP_FREE( tls_opt_certfile );
1321 tls_opt_certfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1323 case LDAP_OPT_X_TLS_KEYFILE:
1324 if ( tls_opt_keyfile ) LDAP_FREE( tls_opt_keyfile );
1325 tls_opt_keyfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1327 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1328 switch( *(int *) arg ) {
1329 case LDAP_OPT_X_TLS_NEVER:
1330 case LDAP_OPT_X_TLS_DEMAND:
1331 case LDAP_OPT_X_TLS_ALLOW:
1332 case LDAP_OPT_X_TLS_TRY:
1333 case LDAP_OPT_X_TLS_HARD:
1334 tls_opt_require_cert = * (int *) arg;
1338 #ifdef HAVE_OPENSSL_CRL
1339 case LDAP_OPT_X_TLS_CRLCHECK:
1340 switch( *(int *) arg ) {
1341 case LDAP_OPT_X_TLS_CRL_NONE:
1342 case LDAP_OPT_X_TLS_CRL_PEER:
1343 case LDAP_OPT_X_TLS_CRL_ALL:
1344 tls_opt_crlcheck = * (int *) arg;
1349 case LDAP_OPT_X_TLS_CIPHER_SUITE:
1350 if ( tls_opt_ciphersuite ) LDAP_FREE( tls_opt_ciphersuite );
1351 tls_opt_ciphersuite = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1353 case LDAP_OPT_X_TLS_RANDOM_FILE:
1354 if (tls_opt_randfile ) LDAP_FREE (tls_opt_randfile );
1355 tls_opt_randfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1364 ldap_int_tls_start ( LDAP *ld, LDAPConn *conn, LDAPURLDesc *srv )
1366 Sockbuf *sb = conn->lconn_sb;
1371 host = srv->lud_host;
1373 host = conn->lconn_server->lud_host;
1376 /* avoid NULL host */
1377 if( host == NULL ) {
1381 (void) ldap_pvt_tls_init();
1384 * Fortunately, the lib uses blocking io...
1386 if ( ldap_int_tls_connect( ld, conn ) < 0 ) {
1387 ld->ld_errno = LDAP_CONNECT_ERROR;
1388 return (ld->ld_errno);
1391 ssl = ldap_pvt_tls_sb_ctx( sb );
1392 assert( ssl != NULL );
1395 * compare host with name(s) in certificate
1397 if (tls_opt_require_cert != LDAP_OPT_X_TLS_NEVER) {
1398 ld->ld_errno = ldap_pvt_tls_check_hostname( ld, ssl, host );
1399 if (ld->ld_errno != LDAP_SUCCESS) {
1400 return ld->ld_errno;
1404 return LDAP_SUCCESS;
1407 /* Derived from openssl/apps/s_cb.c */
1409 tls_info_cb( const SSL *ssl, int where, int ret )
1413 char *state = (char *) SSL_state_string_long( (SSL *)ssl );
1415 w = where & ~SSL_ST_MASK;
1416 if ( w & SSL_ST_CONNECT ) {
1418 } else if ( w & SSL_ST_ACCEPT ) {
1426 state = LDAP_STRDUP( state );
1430 if ( where & SSL_CB_LOOP ) {
1431 Debug( LDAP_DEBUG_TRACE,
1432 "TLS trace: %s:%s\n",
1435 } else if ( where & SSL_CB_ALERT ) {
1436 char *atype = (char *) SSL_alert_type_string_long( ret );
1437 char *adesc = (char *) SSL_alert_desc_string_long( ret );
1438 op = ( where & SSL_CB_READ ) ? "read" : "write";
1441 atype = LDAP_STRDUP( atype );
1445 adesc = LDAP_STRDUP( adesc );
1449 Debug( LDAP_DEBUG_TRACE,
1450 "TLS trace: SSL3 alert %s:%s:%s\n",
1453 if ( atype ) LDAP_FREE( atype );
1454 if ( adesc ) LDAP_FREE( adesc );
1456 } else if ( where & SSL_CB_EXIT ) {
1458 Debug( LDAP_DEBUG_TRACE,
1459 "TLS trace: %s:failed in %s\n",
1461 } else if ( ret < 0 ) {
1462 Debug( LDAP_DEBUG_TRACE,
1463 "TLS trace: %s:error in %s\n",
1468 if ( state ) LDAP_FREE( state );
1473 tls_verify_cb( int ok, X509_STORE_CTX *ctx )
1482 char *certerr = NULL;
1484 cert = X509_STORE_CTX_get_current_cert( ctx );
1485 errnum = X509_STORE_CTX_get_error( ctx );
1486 errdepth = X509_STORE_CTX_get_error_depth( ctx );
1489 * X509_get_*_name return pointers to the internal copies of
1490 * those things requested. So do not free them.
1492 subject = X509_get_subject_name( cert );
1493 issuer = X509_get_issuer_name( cert );
1494 /* X509_NAME_oneline, if passed a NULL buf, allocate memomry */
1495 sname = X509_NAME_oneline( subject, NULL, 0 );
1496 iname = X509_NAME_oneline( issuer, NULL, 0 );
1497 if ( !ok ) certerr = (char *)X509_verify_cert_error_string( errnum );
1499 if ( sname ) __etoa( sname );
1500 if ( iname ) __etoa( iname );
1502 certerr = LDAP_STRDUP( certerr );
1506 Debug( LDAP_DEBUG_TRACE,
1507 "TLS certificate verification: depth: %d, err: %d, subject: %s,",
1509 sname ? sname : "-unknown-" );
1510 Debug( LDAP_DEBUG_TRACE, " issuer: %s\n", iname ? iname : "-unknown-", 0, 0 );
1512 Debug( LDAP_DEBUG_ANY,
1513 "TLS certificate verification: Error, %s\n",
1517 CRYPTO_free ( sname );
1519 CRYPTO_free ( iname );
1521 if ( certerr ) LDAP_FREE( certerr );
1527 tls_verify_ok( int ok, X509_STORE_CTX *ctx )
1529 (void) tls_verify_cb( ok, ctx );
1533 /* Inspired by ERR_print_errors in OpenSSL */
1535 tls_report_error( void )
1542 while ( ( l = ERR_get_error_line( &file, &line ) ) != 0 ) {
1543 ERR_error_string_n( l, buf, sizeof( buf ) );
1546 file = LDAP_STRDUP( file );
1547 __etoa( (char *)file );
1551 Debug( LDAP_DEBUG_ANY, "TLS: %s %s:%d\n",
1554 if ( file ) LDAP_FREE( (void *)file );
1560 tls_tmp_rsa_cb( SSL *ssl, int is_export, int key_length )
1564 /* FIXME: Pregenerate the key on startup */
1565 /* FIXME: Who frees the key? */
1566 tmp_rsa = RSA_generate_key( key_length, RSA_F4, NULL, NULL );
1569 Debug( LDAP_DEBUG_ANY,
1570 "TLS: Failed to generate temporary %d-bit %s RSA key\n",
1571 key_length, is_export ? "export" : "domestic", 0 );
1578 tls_seed_PRNG( const char *randfile )
1580 #ifndef URANDOM_DEVICE
1581 /* no /dev/urandom (or equiv) */
1583 char buffer[MAXPATHLEN];
1585 if (randfile == NULL) {
1586 /* The seed file is $RANDFILE if defined, otherwise $HOME/.rnd.
1587 * If $HOME is not set or buffer too small to hold the pathname,
1588 * an error occurs. - From RAND_file_name() man page.
1589 * The fact is that when $HOME is NULL, .rnd is used.
1591 randfile = RAND_file_name( buffer, sizeof( buffer ) );
1593 } else if (RAND_egd(randfile) > 0) {
1598 if (randfile == NULL) {
1599 Debug( LDAP_DEBUG_ANY,
1600 "TLS: Use configuration file or $RANDFILE to define seed PRNG\n",
1605 total = RAND_load_file(randfile, -1);
1607 if (RAND_status() == 0) {
1608 Debug( LDAP_DEBUG_ANY,
1609 "TLS: PRNG not been seeded with enough data\n",
1614 /* assume if there was enough bits to seed that it's okay
1615 * to write derived bits to the file
1617 RAND_write_file(randfile);
1626 tls_tmp_dh_cb( SSL *ssl, int is_export, int key_length )
1634 ldap_pvt_tls_sb_ctx( Sockbuf *sb )
1639 if (HAS_TLS( sb )) {
1640 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&p );
1649 ldap_pvt_tls_get_strength( void *s )
1654 c = SSL_get_current_cipher((SSL *)s);
1655 return SSL_CIPHER_get_bits(c, NULL);
1663 ldap_pvt_tls_get_my_dn( void *s, struct berval *dn, LDAPDN_rewrite_dummy *func, unsigned flags )
1670 x = SSL_get_certificate((SSL *)s);
1672 if (!x) return LDAP_INVALID_CREDENTIALS;
1674 xn = X509_get_subject_name(x);
1675 rc = ldap_X509dn2bv(xn, dn, (LDAPDN_rewrite_func *)func, flags );
1678 return LDAP_NOT_SUPPORTED;
1683 ldap_start_tls( LDAP *ld,
1684 LDAPControl **serverctrls,
1685 LDAPControl **clientctrls,
1688 return ldap_extended_operation( ld, LDAP_EXOP_START_TLS,
1689 NULL, serverctrls, clientctrls, msgidp );
1693 ldap_install_tls( LDAP *ld )
1696 return LDAP_NOT_SUPPORTED;
1698 if ( ldap_tls_inplace( ld ) ) {
1699 return LDAP_LOCAL_ERROR;
1702 return ldap_int_tls_start( ld, ld->ld_defconn, NULL );
1707 ldap_start_tls_s ( LDAP *ld,
1708 LDAPControl **serverctrls,
1709 LDAPControl **clientctrls )
1712 return LDAP_NOT_SUPPORTED;
1715 char *rspoid = NULL;
1716 struct berval *rspdata = NULL;
1718 /* XXYYZ: this initiates operation only on default connection! */
1720 if ( ldap_tls_inplace( ld ) ) {
1721 return LDAP_LOCAL_ERROR;
1724 rc = ldap_extended_operation_s( ld, LDAP_EXOP_START_TLS,
1725 NULL, serverctrls, clientctrls, &rspoid, &rspdata );
1727 if ( rspoid != NULL ) {
1731 if ( rspdata != NULL ) {
1732 ber_bvfree( rspdata );
1735 if ( rc == LDAP_SUCCESS ) {
1736 rc = ldap_int_tls_start( ld, ld->ld_defconn, NULL );