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 int tls_opt_crlcheck = LDAP_OPT_X_TLS_CRL_NONE;
57 static char *tls_opt_ciphersuite = NULL;
58 static char *tls_opt_randfile = NULL;
60 #define HAS_TLS( sb ) ber_sockbuf_ctrl( sb, LBER_SB_OPT_HAS_IO, \
61 (void *)&sb_tls_sbio )
63 static void tls_report_error( void );
65 static void tls_info_cb( const SSL *ssl, int where, int ret );
66 static int tls_verify_cb( int ok, X509_STORE_CTX *ctx );
67 static int tls_verify_ok( int ok, X509_STORE_CTX *ctx );
68 static RSA * tls_tmp_rsa_cb( SSL *ssl, int is_export, int key_length );
69 static STACK_OF(X509_NAME) * get_ca_list( char * bundle, char * dir );
71 #if 0 /* Currently this is not used by anyone */
72 static DH * tls_tmp_dh_cb( SSL *ssl, int is_export, int key_length );
75 static SSL_CTX *tls_def_ctx = NULL;
77 static int tls_seed_PRNG( const char *randfile );
81 * provide mutexes for the SSLeay library.
83 static ldap_pvt_thread_mutex_t tls_mutexes[CRYPTO_NUM_LOCKS];
85 static void tls_locking_cb( int mode, int type, const char *file, int line )
87 if ( mode & CRYPTO_LOCK ) {
88 ldap_pvt_thread_mutex_lock( &tls_mutexes[type] );
90 ldap_pvt_thread_mutex_unlock( &tls_mutexes[type] );
95 * an extra mutex for the default ctx.
98 static ldap_pvt_thread_mutex_t tls_def_ctx_mutex;
100 static void tls_init_threads( void )
104 for( i=0; i< CRYPTO_NUM_LOCKS ; i++ ) {
105 ldap_pvt_thread_mutex_init( &tls_mutexes[i] );
107 CRYPTO_set_locking_callback( tls_locking_cb );
108 /* FIXME: the thread id should be added somehow... */
110 ldap_pvt_thread_mutex_init( &tls_def_ctx_mutex );
112 #endif /* LDAP_R_COMPILE */
115 * Tear down the TLS subsystem. Should only be called once.
118 ldap_pvt_tls_destroy( void )
120 SSL_CTX_free(tls_def_ctx);
127 if ( tls_opt_certfile ) {
128 LDAP_FREE( tls_opt_certfile );
129 tls_opt_certfile = NULL;
131 if ( tls_opt_keyfile ) {
132 LDAP_FREE( tls_opt_keyfile );
133 tls_opt_keyfile = NULL;
135 if ( tls_opt_cacertfile ) {
136 LDAP_FREE( tls_opt_cacertfile );
137 tls_opt_cacertfile = NULL;
139 if ( tls_opt_cacertdir ) {
140 LDAP_FREE( tls_opt_cacertdir );
141 tls_opt_cacertdir = NULL;
143 if ( tls_opt_ciphersuite ) {
144 LDAP_FREE( tls_opt_ciphersuite );
145 tls_opt_ciphersuite = NULL;
147 if ( tls_opt_randfile ) {
148 LDAP_FREE( tls_opt_randfile );
149 tls_opt_randfile = NULL;
154 * Initialize TLS subsystem. Should be called only once.
157 ldap_pvt_tls_init( void )
159 static int tls_initialized = 0;
161 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 ) {
231 Debug( LDAP_DEBUG_ANY,
232 "TLS: could not allocate default ctx (%lu).\n",
233 ERR_peek_error(),0,0);
238 SSL_CTX_set_session_id_context( tls_def_ctx,
239 (const unsigned char *) "OpenLDAP", sizeof("OpenLDAP")-1 );
241 if ( tls_opt_ciphersuite &&
242 !SSL_CTX_set_cipher_list( tls_def_ctx, ciphersuite ) )
244 Debug( LDAP_DEBUG_ANY,
245 "TLS: could not set cipher list %s.\n",
246 tls_opt_ciphersuite, 0, 0 );
252 if (tls_opt_cacertfile != NULL || tls_opt_cacertdir != NULL) {
253 if ( !SSL_CTX_load_verify_locations( tls_def_ctx,
254 cacertfile, cacertdir ) ||
255 !SSL_CTX_set_default_verify_paths( tls_def_ctx ) )
257 Debug( LDAP_DEBUG_ANY, "TLS: "
258 "could not load verify locations (file:`%s',dir:`%s').\n",
259 tls_opt_cacertfile ? tls_opt_cacertfile : "",
260 tls_opt_cacertdir ? tls_opt_cacertdir : "",
267 calist = get_ca_list( cacertfile, cacertdir );
269 Debug( LDAP_DEBUG_ANY, "TLS: "
270 "could not load client CA list (file:`%s',dir:`%s').\n",
271 tls_opt_cacertfile ? tls_opt_cacertfile : "",
272 tls_opt_cacertdir ? tls_opt_cacertdir : "",
279 SSL_CTX_set_client_CA_list( tls_def_ctx, calist );
282 if ( tls_opt_keyfile &&
283 !SSL_CTX_use_PrivateKey_file( tls_def_ctx,
284 keyfile, SSL_FILETYPE_PEM ) )
286 Debug( LDAP_DEBUG_ANY,
287 "TLS: could not use key file `%s'.\n",
288 tls_opt_keyfile,0,0);
294 if ( tls_opt_certfile &&
295 !SSL_CTX_use_certificate_file( tls_def_ctx,
296 certfile, SSL_FILETYPE_PEM ) )
298 Debug( LDAP_DEBUG_ANY,
299 "TLS: could not use certificate `%s'.\n",
300 tls_opt_certfile,0,0);
306 if ( ( tls_opt_certfile || tls_opt_keyfile ) &&
307 !SSL_CTX_check_private_key( tls_def_ctx ) )
309 Debug( LDAP_DEBUG_ANY,
310 "TLS: private key mismatch.\n",
317 if ( tls_opt_trace ) {
318 SSL_CTX_set_info_callback( tls_def_ctx, tls_info_cb );
322 if ( tls_opt_require_cert ) {
324 if ( tls_opt_require_cert == LDAP_OPT_X_TLS_DEMAND ||
325 tls_opt_require_cert == LDAP_OPT_X_TLS_HARD ) {
326 i |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
330 SSL_CTX_set_verify( tls_def_ctx, i,
331 tls_opt_require_cert == LDAP_OPT_X_TLS_ALLOW ?
332 tls_verify_ok : tls_verify_cb );
333 SSL_CTX_set_tmp_rsa_callback( tls_def_ctx, tls_tmp_rsa_cb );
334 /* SSL_CTX_set_tmp_dh_callback( tls_def_ctx, tls_tmp_dh_cb ); */
335 if ( tls_opt_crlcheck ) {
336 X509_STORE *x509_s = SSL_CTX_get_cert_store( tls_def_ctx );
337 if ( tls_opt_crlcheck == LDAP_OPT_X_TLS_CRL_PEER ) {
338 X509_STORE_set_flags( x509_s, X509_V_FLAG_CRL_CHECK );
339 } else if ( tls_opt_crlcheck == LDAP_OPT_X_TLS_CRL_ALL ) {
340 X509_STORE_set_flags( x509_s,
341 X509_V_FLAG_CRL_CHECK | X509_V_FLAG_CRL_CHECK_ALL );
346 if ( rc == -1 && tls_def_ctx != NULL ) {
347 SSL_CTX_free( tls_def_ctx );
351 LDAP_FREE( ciphersuite );
352 LDAP_FREE( cacertfile );
353 LDAP_FREE( cacertdir );
354 LDAP_FREE( certfile );
355 LDAP_FREE( keyfile );
357 #ifdef LDAP_R_COMPILE
358 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
363 static STACK_OF(X509_NAME) *
364 get_ca_list( char * bundle, char * dir )
366 STACK_OF(X509_NAME) *ca_list = NULL;
369 ca_list = SSL_load_client_CA_file( bundle );
371 #if defined(HAVE_DIRENT_H) || defined(dirent)
376 ca_list = sk_X509_NAME_new_null();
379 if ( !SSL_add_dir_cert_subjects_to_stack( ca_list, dir ) &&
381 sk_X509_NAME_free( ca_list );
390 alloc_handle( void *ctx_arg )
396 ctx = (SSL_CTX *) ctx_arg;
398 if ( ldap_pvt_tls_init_def_ctx() < 0 ) return NULL;
402 ssl = SSL_new( ctx );
404 Debug( LDAP_DEBUG_ANY,"TLS: can't create ssl handle.\n",0,0,0);
411 update_flags( Sockbuf *sb, SSL * ssl, int rc )
413 int err = SSL_get_error(ssl, rc);
415 sb->sb_trans_needs_read = 0;
416 sb->sb_trans_needs_write = 0;
418 if (err == SSL_ERROR_WANT_READ) {
419 sb->sb_trans_needs_read = 1;
422 } else if (err == SSL_ERROR_WANT_WRITE) {
423 sb->sb_trans_needs_write = 1;
426 } else if (err == SSL_ERROR_WANT_CONNECT) {
433 * TLS support for LBER Sockbufs
438 Sockbuf_IO_Desc *sbiod;
441 static BIO_METHOD sb_tls_bio_method;
444 sb_tls_setup( Sockbuf_IO_Desc *sbiod, void *arg )
449 assert( sbiod != NULL );
451 p = LBER_MALLOC( sizeof( *p ) );
458 bio = BIO_new( &sb_tls_bio_method );
459 bio->ptr = (void *)p;
460 SSL_set_bio( p->ssl, bio, bio );
461 sbiod->sbiod_pvt = p;
466 sb_tls_remove( Sockbuf_IO_Desc *sbiod )
470 assert( sbiod != NULL );
471 assert( sbiod->sbiod_pvt != NULL );
473 p = (struct tls_data *)sbiod->sbiod_pvt;
475 LBER_FREE( sbiod->sbiod_pvt );
476 sbiod->sbiod_pvt = NULL;
481 sb_tls_close( Sockbuf_IO_Desc *sbiod )
485 assert( sbiod != NULL );
486 assert( sbiod->sbiod_pvt != NULL );
488 p = (struct tls_data *)sbiod->sbiod_pvt;
489 SSL_shutdown( p->ssl );
494 sb_tls_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
498 assert( sbiod != NULL );
499 assert( sbiod->sbiod_pvt != NULL );
501 p = (struct tls_data *)sbiod->sbiod_pvt;
503 if ( opt == LBER_SB_OPT_GET_SSL ) {
504 *((SSL **)arg) = p->ssl;
507 } else if ( opt == LBER_SB_OPT_DATA_READY ) {
508 if( SSL_pending( p->ssl ) > 0 ) {
513 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
517 sb_tls_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
523 assert( sbiod != NULL );
524 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
526 p = (struct tls_data *)sbiod->sbiod_pvt;
528 ret = SSL_read( p->ssl, (char *)buf, len );
530 errno = WSAGetLastError();
532 err = SSL_get_error( p->ssl, ret );
533 if (err == SSL_ERROR_WANT_READ ) {
534 sbiod->sbiod_sb->sb_trans_needs_read = 1;
538 sbiod->sbiod_sb->sb_trans_needs_read = 0;
543 sb_tls_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
549 assert( sbiod != NULL );
550 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
552 p = (struct tls_data *)sbiod->sbiod_pvt;
554 ret = SSL_write( p->ssl, (char *)buf, len );
556 errno = WSAGetLastError();
558 err = SSL_get_error( p->ssl, ret );
559 if (err == SSL_ERROR_WANT_WRITE ) {
560 sbiod->sbiod_sb->sb_trans_needs_write = 1;
564 sbiod->sbiod_sb->sb_trans_needs_write = 0;
569 static Sockbuf_IO sb_tls_sbio =
571 sb_tls_setup, /* sbi_setup */
572 sb_tls_remove, /* sbi_remove */
573 sb_tls_ctrl, /* sbi_ctrl */
574 sb_tls_read, /* sbi_read */
575 sb_tls_write, /* sbi_write */
576 sb_tls_close /* sbi_close */
580 sb_tls_bio_create( BIO *b ) {
589 sb_tls_bio_destroy( BIO *b )
591 if ( b == NULL ) return 0;
593 b->ptr = NULL; /* sb_tls_remove() will free it */
600 sb_tls_bio_read( BIO *b, char *buf, int len )
605 if ( buf == NULL || len <= 0 ) return 0;
607 p = (struct tls_data *)b->ptr;
609 if ( p == NULL || p->sbiod == NULL ) {
613 ret = LBER_SBIOD_READ_NEXT( p->sbiod, buf, len );
615 BIO_clear_retry_flags( b );
618 if ( err == EAGAIN || err == EWOULDBLOCK ) {
619 BIO_set_retry_read( b );
627 sb_tls_bio_write( BIO *b, const char *buf, int len )
632 if ( buf == NULL || len <= 0 ) return 0;
634 p = (struct tls_data *)b->ptr;
636 if ( p == NULL || p->sbiod == NULL ) {
640 ret = LBER_SBIOD_WRITE_NEXT( p->sbiod, (char *)buf, len );
642 BIO_clear_retry_flags( b );
645 if ( err == EAGAIN || err == EWOULDBLOCK ) {
646 BIO_set_retry_write( b );
654 sb_tls_bio_ctrl( BIO *b, int cmd, long num, void *ptr )
656 if ( cmd == BIO_CTRL_FLUSH ) {
657 /* The OpenSSL library needs this */
664 sb_tls_bio_gets( BIO *b, char *buf, int len )
670 sb_tls_bio_puts( BIO *b, const char *str )
672 return sb_tls_bio_write( b, str, strlen( str ) );
675 static BIO_METHOD sb_tls_bio_method =
677 ( 100 | 0x400 ), /* it's a source/sink BIO */
689 * Call this to do a TLS connect on a sockbuf. ctx_arg can be
690 * a SSL_CTX * or NULL, in which case the default ctx is used.
694 * 0 - Success. Connection is ready for communication.
695 * <0 - Error. Can't create a TLS stream.
696 * >0 - Partial success.
697 * Do a select (using information from lber_pvt_sb_needs_{read,write}
702 ldap_int_tls_connect( LDAP *ld, LDAPConn *conn )
704 Sockbuf *sb = conn->lconn_sb;
708 if ( HAS_TLS( sb ) ) {
709 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
712 void *ctx = ld->ld_defconn
713 ? ld->ld_defconn->lconn_tls_ctx : NULL;
715 ssl = alloc_handle( ctx );
717 if ( ssl == NULL ) return -1;
720 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
721 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
723 ber_sockbuf_add_io( sb, &sb_tls_sbio,
724 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
727 conn->lconn_tls_ctx = tls_def_ctx;
731 err = SSL_connect( ssl );
734 errno = WSAGetLastError();
738 if ( update_flags( sb, ssl, err )) {
742 if ((err = ERR_peek_error())) {
744 ld->ld_error = LDAP_STRDUP(ERR_error_string(err, buf));
746 if ( ld->ld_error ) __etoa(ld->ld_error);
750 Debug( LDAP_DEBUG_ANY,"TLS: can't connect.\n",0,0,0);
752 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
753 LBER_SBIOD_LEVEL_TRANSPORT );
755 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
756 LBER_SBIOD_LEVEL_TRANSPORT );
765 * Call this to do a TLS accept on a sockbuf.
766 * Everything else is the same as with tls_connect.
769 ldap_pvt_tls_accept( Sockbuf *sb, void *ctx_arg )
774 if ( HAS_TLS( sb ) ) {
775 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
778 ssl = alloc_handle( ctx_arg );
779 if ( ssl == NULL ) return -1;
782 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
783 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
785 ber_sockbuf_add_io( sb, &sb_tls_sbio,
786 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
789 err = SSL_accept( ssl );
792 errno = WSAGetLastError();
795 if ( update_flags( sb, ssl, err )) return 1;
797 Debug( LDAP_DEBUG_ANY,"TLS: can't accept.\n",0,0,0 );
800 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
801 LBER_SBIOD_LEVEL_TRANSPORT );
803 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
804 LBER_SBIOD_LEVEL_TRANSPORT );
813 ldap_pvt_tls_inplace ( Sockbuf *sb )
815 return HAS_TLS( sb ) ? 1 : 0;
819 tls_get_cert( SSL *s )
821 /* If peer cert was bad, treat as if no cert was given */
822 if (SSL_get_verify_result(s)) {
823 /* If we can send an alert, do so */
824 if (SSL_version(s) != SSL2_VERSION) {
825 ssl3_send_alert(s,SSL3_AL_WARNING,SSL3_AD_BAD_CERTIFICATE);
829 return SSL_get_peer_certificate(s);
833 ldap_pvt_tls_get_peer_dn( void *s, struct berval *dn,
834 LDAPDN_rewrite_dummy *func, unsigned flags )
840 x = tls_get_cert((SSL *)s);
842 if (!x) return LDAP_INVALID_CREDENTIALS;
844 xn = X509_get_subject_name(x);
845 rc = ldap_X509dn2bv(xn, dn, (LDAPDN_rewrite_func *)func, flags);
851 ldap_pvt_tls_get_peer_hostname( void *s )
858 x = tls_get_cert((SSL *)s);
861 xn = X509_get_subject_name(x);
863 ret = X509_NAME_get_text_by_NID(xn, NID_commonName, buf, sizeof(buf));
869 p = LDAP_STRDUP(buf);
874 /* what kind of hostname were we given? */
880 ldap_pvt_tls_check_hostname( LDAP *ld, void *s, const char *name_in )
882 int i, ret = LDAP_LOCAL_ERROR;
888 struct in6_addr addr;
893 if( ldap_int_hostname &&
894 ( !name_in || !strcasecmp( name_in, "localhost" ) ) )
896 name = ldap_int_hostname;
901 x = tls_get_cert((SSL *)s);
903 Debug( LDAP_DEBUG_ANY,
904 "TLS: unable to get peer certificate.\n",
906 /* If this was a fatal condition, things would have
907 * aborted long before now.
913 if (name[0] == '[' && strchr(name, ']')) {
914 char *n2 = ldap_strdup(name+1);
915 *strchr(n2, ']') = 2;
916 if (inet_pton(AF_INET6, n2, &addr))
921 if ((ptr = strrchr(name, '.')) && isdigit((unsigned char)ptr[1])) {
922 if (inet_aton(name, (struct in_addr *)&addr)) ntype = IS_IP4;
925 i = X509_get_ext_by_NID(x, NID_subject_alt_name, -1);
928 STACK_OF(GENERAL_NAME) *alt;
930 ex = X509_get_ext(x, i);
931 alt = X509V3_EXT_d2i(ex);
933 int n, len1 = 0, len2 = 0;
937 if (ntype == IS_DNS) {
939 domain = strchr(name, '.');
941 len2 = len1 - (domain-name);
944 n = sk_GENERAL_NAME_num(alt);
945 for (i=0; i<n; i++) {
948 gn = sk_GENERAL_NAME_value(alt, i);
949 if (gn->type == GEN_DNS) {
950 if (ntype != IS_DNS) continue;
952 sn = (char *) ASN1_STRING_data(gn->d.ia5);
953 sl = ASN1_STRING_length(gn->d.ia5);
956 if (sl == 0) continue;
958 /* Is this an exact match? */
959 if ((len1 == sl) && !strncasecmp(name, sn, len1)) {
963 /* Is this a wildcard match? */
964 if (domain && (sn[0] == '*') && (sn[1] == '.') &&
965 (len2 == sl-1) && !strncasecmp(domain, &sn[1], len2))
970 } else if (gn->type == GEN_IPADD) {
971 if (ntype == IS_DNS) continue;
973 sn = (char *) ASN1_STRING_data(gn->d.ia5);
974 sl = ASN1_STRING_length(gn->d.ia5);
977 if (ntype == IS_IP6 && sl != sizeof(struct in6_addr)) {
981 if (ntype == IS_IP4 && sl != sizeof(struct in_addr)) {
984 if (!memcmp(sn, &addr, sl)) {
990 GENERAL_NAMES_free(alt);
991 if (i < n) { /* Found a match */
997 if (ret != LDAP_SUCCESS) {
1002 xn = X509_get_subject_name(x);
1003 if( X509_NAME_get_text_by_NID( xn, NID_commonName,
1004 buf, sizeof(buf)) == -1)
1006 Debug( LDAP_DEBUG_ANY,
1007 "TLS: unable to get common name from peer certificate.\n",
1009 ret = LDAP_CONNECT_ERROR;
1010 ld->ld_error = LDAP_STRDUP(
1011 _("TLS: unable to get CN from peer certificate"));
1013 } else if (strcasecmp(name, buf) == 0 ) {
1016 } else if (( buf[0] == '*' ) && ( buf[1] == '.' )) {
1017 char *domain = strchr(name, '.');
1023 dlen = sl - (domain-name);
1026 /* Is this a wildcard match? */
1027 if ((dlen == sl-1) && !strncasecmp(domain, &buf[1], dlen)) {
1033 if( ret == LDAP_LOCAL_ERROR ) {
1034 Debug( LDAP_DEBUG_ANY, "TLS: hostname (%s) does not match "
1035 "common name in certificate (%s).\n",
1037 ret = LDAP_CONNECT_ERROR;
1038 ld->ld_error = LDAP_STRDUP(
1039 _("TLS: hostname does not match CN in peer certificate"));
1047 ldap_pvt_tls_get_peer_issuer( void *s )
1049 #if 0 /* currently unused; see ldap_pvt_tls_get_peer_dn() if needed */
1054 x = SSL_get_peer_certificate((SSL *)s);
1056 if (!x) return NULL;
1058 xn = X509_get_issuer_name(x);
1059 p = LDAP_STRDUP(X509_NAME_oneline(xn, buf, sizeof(buf)));
1068 ldap_int_tls_config( LDAP *ld, int option, const char *arg )
1073 case LDAP_OPT_X_TLS_CACERTFILE:
1074 case LDAP_OPT_X_TLS_CACERTDIR:
1075 case LDAP_OPT_X_TLS_CERTFILE:
1076 case LDAP_OPT_X_TLS_KEYFILE:
1077 case LDAP_OPT_X_TLS_RANDOM_FILE:
1078 case LDAP_OPT_X_TLS_CIPHER_SUITE:
1079 return ldap_pvt_tls_set_option( ld, option, (void *) arg );
1081 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1082 case LDAP_OPT_X_TLS:
1084 if ( strcasecmp( arg, "never" ) == 0 ) {
1085 i = LDAP_OPT_X_TLS_NEVER ;
1087 } else if ( strcasecmp( arg, "demand" ) == 0 ) {
1088 i = LDAP_OPT_X_TLS_DEMAND ;
1090 } else if ( strcasecmp( arg, "allow" ) == 0 ) {
1091 i = LDAP_OPT_X_TLS_ALLOW ;
1093 } else if ( strcasecmp( arg, "try" ) == 0 ) {
1094 i = LDAP_OPT_X_TLS_TRY ;
1096 } else if ( ( strcasecmp( arg, "hard" ) == 0 ) ||
1097 ( strcasecmp( arg, "on" ) == 0 ) ||
1098 ( strcasecmp( arg, "yes" ) == 0) ||
1099 ( strcasecmp( arg, "true" ) == 0 ) )
1101 i = LDAP_OPT_X_TLS_HARD ;
1105 return ldap_pvt_tls_set_option( ld, option, &i );
1108 case LDAP_OPT_X_TLS_CRLCHECK:
1110 if ( strcasecmp( arg, "none" ) == 0 ) {
1111 i = LDAP_OPT_X_TLS_CRL_NONE ;
1112 } else if ( strcasecmp( arg, "peer" ) == 0 ) {
1113 i = LDAP_OPT_X_TLS_CRL_PEER ;
1114 } else if ( strcasecmp( arg, "all" ) == 0 ) {
1115 i = LDAP_OPT_X_TLS_CRL_ALL ;
1118 return ldap_pvt_tls_set_option( ld, option, &i );
1126 ldap_pvt_tls_get_option( LDAP *ld, int option, void *arg )
1128 struct ldapoptions *lo;
1131 assert( LDAP_VALID( ld ) );
1133 if( !LDAP_VALID( ld ) ) {
1134 return LDAP_OPT_ERROR;
1137 lo = &ld->ld_options;
1140 /* Get pointer to global option structure */
1141 lo = LDAP_INT_GLOBAL_OPT();
1143 return LDAP_NO_MEMORY;
1148 case LDAP_OPT_X_TLS:
1149 *(int *)arg = lo->ldo_tls_mode;
1151 case LDAP_OPT_X_TLS_CTX:
1153 *(void **)arg = (void *) tls_def_ctx;
1155 *(void **)arg = ld->ld_defconn->lconn_tls_ctx;
1158 case LDAP_OPT_X_TLS_CACERTFILE:
1159 *(char **)arg = tls_opt_cacertfile ?
1160 LDAP_STRDUP( tls_opt_cacertfile ) : NULL;
1162 case LDAP_OPT_X_TLS_CACERTDIR:
1163 *(char **)arg = tls_opt_cacertdir ?
1164 LDAP_STRDUP( tls_opt_cacertdir ) : NULL;
1166 case LDAP_OPT_X_TLS_CERTFILE:
1167 *(char **)arg = tls_opt_certfile ?
1168 LDAP_STRDUP( tls_opt_certfile ) : NULL;
1170 case LDAP_OPT_X_TLS_KEYFILE:
1171 *(char **)arg = tls_opt_keyfile ?
1172 LDAP_STRDUP( tls_opt_keyfile ) : NULL;
1174 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1175 *(int *)arg = tls_opt_require_cert;
1177 case LDAP_OPT_X_TLS_CRLCHECK:
1178 *(int *)arg = tls_opt_crlcheck;
1180 case LDAP_OPT_X_TLS_RANDOM_FILE:
1181 *(char **)arg = tls_opt_randfile ?
1182 LDAP_STRDUP( tls_opt_randfile ) : NULL;
1184 case LDAP_OPT_X_TLS_SSL_CTX: {
1187 LDAPConn *conn = ld->ld_defconn;
1188 if ( conn != NULL ) {
1189 Sockbuf *sb = conn->lconn_sb;
1190 retval = ldap_pvt_tls_sb_ctx( sb );
1193 *(void **)arg = retval;
1203 ldap_pvt_tls_set_option( LDAP *ld, int option, void *arg )
1205 struct ldapoptions *lo;
1208 assert( LDAP_VALID( ld ) );
1210 if( !LDAP_VALID( ld ) ) {
1211 return LDAP_OPT_ERROR;
1214 lo = &ld->ld_options;
1217 /* Get pointer to global option structure */
1218 lo = LDAP_INT_GLOBAL_OPT();
1220 return LDAP_NO_MEMORY;
1225 case LDAP_OPT_X_TLS:
1226 switch( *(int *) arg ) {
1227 case LDAP_OPT_X_TLS_NEVER:
1228 case LDAP_OPT_X_TLS_DEMAND:
1229 case LDAP_OPT_X_TLS_ALLOW:
1230 case LDAP_OPT_X_TLS_TRY:
1231 case LDAP_OPT_X_TLS_HARD:
1233 lo->ldo_tls_mode = *(int *)arg;
1240 case LDAP_OPT_X_TLS_CTX:
1242 tls_def_ctx = (SSL_CTX *) arg;
1245 ld->ld_defconn->lconn_tls_ctx = arg;
1255 case LDAP_OPT_X_TLS_CACERTFILE:
1256 if ( tls_opt_cacertfile ) LDAP_FREE( tls_opt_cacertfile );
1257 tls_opt_cacertfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1259 case LDAP_OPT_X_TLS_CACERTDIR:
1260 if ( tls_opt_cacertdir ) LDAP_FREE( tls_opt_cacertdir );
1261 tls_opt_cacertdir = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1263 case LDAP_OPT_X_TLS_CERTFILE:
1264 if ( tls_opt_certfile ) LDAP_FREE( tls_opt_certfile );
1265 tls_opt_certfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1267 case LDAP_OPT_X_TLS_KEYFILE:
1268 if ( tls_opt_keyfile ) LDAP_FREE( tls_opt_keyfile );
1269 tls_opt_keyfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1271 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1272 switch( *(int *) arg ) {
1273 case LDAP_OPT_X_TLS_NEVER:
1274 case LDAP_OPT_X_TLS_DEMAND:
1275 case LDAP_OPT_X_TLS_ALLOW:
1276 case LDAP_OPT_X_TLS_TRY:
1277 case LDAP_OPT_X_TLS_HARD:
1278 tls_opt_require_cert = * (int *) arg;
1282 case LDAP_OPT_X_TLS_CRLCHECK:
1283 switch( *(int *) arg ) {
1284 case LDAP_OPT_X_TLS_CRL_NONE:
1285 case LDAP_OPT_X_TLS_CRL_PEER:
1286 case LDAP_OPT_X_TLS_CRL_ALL:
1287 tls_opt_crlcheck = * (int *) arg;
1291 case LDAP_OPT_X_TLS_CIPHER_SUITE:
1292 if ( tls_opt_ciphersuite ) LDAP_FREE( tls_opt_ciphersuite );
1293 tls_opt_ciphersuite = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1295 case LDAP_OPT_X_TLS_RANDOM_FILE:
1296 if (tls_opt_randfile ) LDAP_FREE (tls_opt_randfile );
1297 tls_opt_randfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1306 ldap_int_tls_start ( LDAP *ld, LDAPConn *conn, LDAPURLDesc *srv )
1308 Sockbuf *sb = conn->lconn_sb;
1313 host = srv->lud_host;
1315 host = conn->lconn_server->lud_host;
1318 /* avoid NULL host */
1319 if( host == NULL ) {
1323 (void) ldap_pvt_tls_init();
1326 * Fortunately, the lib uses blocking io...
1328 if ( ldap_int_tls_connect( ld, conn ) < 0 ) {
1329 ld->ld_errno = LDAP_CONNECT_ERROR;
1330 return (ld->ld_errno);
1333 ssl = ldap_pvt_tls_sb_ctx( sb );
1334 assert( ssl != NULL );
1337 * compare host with name(s) in certificate
1339 if (tls_opt_require_cert != LDAP_OPT_X_TLS_NEVER) {
1340 ld->ld_errno = ldap_pvt_tls_check_hostname( ld, ssl, host );
1341 if (ld->ld_errno != LDAP_SUCCESS) {
1342 return ld->ld_errno;
1346 return LDAP_SUCCESS;
1349 /* Derived from openssl/apps/s_cb.c */
1351 tls_info_cb( const SSL *ssl, int where, int ret )
1355 char *state = (char *) SSL_state_string_long( (SSL *)ssl );
1357 w = where & ~SSL_ST_MASK;
1358 if ( w & SSL_ST_CONNECT ) {
1360 } else if ( w & SSL_ST_ACCEPT ) {
1368 state = LDAP_STRDUP( state );
1372 if ( where & SSL_CB_LOOP ) {
1373 Debug( LDAP_DEBUG_TRACE,
1374 "TLS trace: %s:%s\n",
1377 } else if ( where & SSL_CB_ALERT ) {
1378 char *atype = (char *) SSL_alert_type_string_long( ret );
1379 char *adesc = (char *) SSL_alert_desc_string_long( ret );
1380 op = ( where & SSL_CB_READ ) ? "read" : "write";
1383 atype = LDAP_STRDUP( atype );
1387 adesc = LDAP_STRDUP( adesc );
1391 Debug( LDAP_DEBUG_TRACE,
1392 "TLS trace: SSL3 alert %s:%s:%s\n",
1395 if ( atype ) LDAP_FREE( atype );
1396 if ( adesc ) LDAP_FREE( adesc );
1398 } else if ( where & SSL_CB_EXIT ) {
1400 Debug( LDAP_DEBUG_TRACE,
1401 "TLS trace: %s:failed in %s\n",
1403 } else if ( ret < 0 ) {
1404 Debug( LDAP_DEBUG_TRACE,
1405 "TLS trace: %s:error in %s\n",
1410 if ( state ) LDAP_FREE( state );
1415 tls_verify_cb( int ok, X509_STORE_CTX *ctx )
1424 char *certerr = NULL;
1426 cert = X509_STORE_CTX_get_current_cert( ctx );
1427 errnum = X509_STORE_CTX_get_error( ctx );
1428 errdepth = X509_STORE_CTX_get_error_depth( ctx );
1431 * X509_get_*_name return pointers to the internal copies of
1432 * those things requested. So do not free them.
1434 subject = X509_get_subject_name( cert );
1435 issuer = X509_get_issuer_name( cert );
1436 /* X509_NAME_oneline, if passed a NULL buf, allocate memomry */
1437 sname = X509_NAME_oneline( subject, NULL, 0 );
1438 iname = X509_NAME_oneline( issuer, NULL, 0 );
1439 if ( !ok ) certerr = (char *)X509_verify_cert_error_string( errnum );
1441 if ( sname ) __etoa( sname );
1442 if ( iname ) __etoa( iname );
1444 certerr = LDAP_STRDUP( certerr );
1448 Debug( LDAP_DEBUG_TRACE,
1449 "TLS certificate verification: depth: %d, err: %d, subject: %s,",
1451 sname ? sname : "-unknown-" );
1452 Debug( LDAP_DEBUG_TRACE, " issuer: %s\n", iname ? iname : "-unknown-", 0, 0 );
1454 Debug( LDAP_DEBUG_ANY,
1455 "TLS certificate verification: Error, %s\n",
1459 CRYPTO_free ( sname );
1461 CRYPTO_free ( iname );
1463 if ( certerr ) LDAP_FREE( certerr );
1469 tls_verify_ok( int ok, X509_STORE_CTX *ctx )
1471 (void) tls_verify_cb( ok, ctx );
1475 /* Inspired by ERR_print_errors in OpenSSL */
1477 tls_report_error( void )
1484 while ( ( l = ERR_get_error_line( &file, &line ) ) != 0 ) {
1485 ERR_error_string_n( l, buf, sizeof( buf ) );
1488 file = LDAP_STRDUP( file );
1489 __etoa( (char *)file );
1493 Debug( LDAP_DEBUG_ANY, "TLS: %s %s:%d\n",
1496 if ( file ) LDAP_FREE( (void *)file );
1502 tls_tmp_rsa_cb( SSL *ssl, int is_export, int key_length )
1506 /* FIXME: Pregenerate the key on startup */
1507 /* FIXME: Who frees the key? */
1508 tmp_rsa = RSA_generate_key( key_length, RSA_F4, NULL, NULL );
1511 Debug( LDAP_DEBUG_ANY,
1512 "TLS: Failed to generate temporary %d-bit %s RSA key\n",
1513 key_length, is_export ? "export" : "domestic", 0 );
1520 tls_seed_PRNG( const char *randfile )
1522 #ifndef URANDOM_DEVICE
1523 /* no /dev/urandom (or equiv) */
1525 char buffer[MAXPATHLEN];
1527 if (randfile == NULL) {
1528 /* The seed file is $RANDFILE if defined, otherwise $HOME/.rnd.
1529 * If $HOME is not set or buffer too small to hold the pathname,
1530 * an error occurs. - From RAND_file_name() man page.
1531 * The fact is that when $HOME is NULL, .rnd is used.
1533 randfile = RAND_file_name( buffer, sizeof( buffer ) );
1535 } else if (RAND_egd(randfile) > 0) {
1540 if (randfile == NULL) {
1541 Debug( LDAP_DEBUG_ANY,
1542 "TLS: Use configuration file or $RANDFILE to define seed PRNG\n",
1547 total = RAND_load_file(randfile, -1);
1549 if (RAND_status() == 0) {
1550 Debug( LDAP_DEBUG_ANY,
1551 "TLS: PRNG not been seeded with enough data\n",
1556 /* assume if there was enough bits to seed that it's okay
1557 * to write derived bits to the file
1559 RAND_write_file(randfile);
1568 tls_tmp_dh_cb( SSL *ssl, int is_export, int key_length )
1576 ldap_pvt_tls_sb_ctx( Sockbuf *sb )
1581 if (HAS_TLS( sb )) {
1582 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&p );
1591 ldap_pvt_tls_get_strength( void *s )
1596 c = SSL_get_current_cipher((SSL *)s);
1597 return SSL_CIPHER_get_bits(c, NULL);
1605 ldap_pvt_tls_get_my_dn( void *s, struct berval *dn, LDAPDN_rewrite_dummy *func, unsigned flags )
1612 x = SSL_get_certificate((SSL *)s);
1614 if (!x) return LDAP_INVALID_CREDENTIALS;
1616 xn = X509_get_subject_name(x);
1617 rc = ldap_X509dn2bv(xn, dn, (LDAPDN_rewrite_func *)func, flags );
1620 return LDAP_NOT_SUPPORTED;
1625 ldap_start_tls_s ( LDAP *ld,
1626 LDAPControl **serverctrls,
1627 LDAPControl **clientctrls )
1632 char *rspoid = NULL;
1633 struct berval *rspdata = NULL;
1635 /* XXYYZ: this initiates operation only on default connection! */
1637 if ( ld->ld_sb != NULL && ldap_pvt_tls_inplace( ld->ld_sb ) != 0 ) {
1638 return LDAP_LOCAL_ERROR;
1641 rc = ldap_extended_operation_s( ld, LDAP_EXOP_START_TLS,
1642 NULL, serverctrls, clientctrls, &rspoid, &rspdata );
1644 if ( rspoid != NULL ) {
1648 if ( rspdata != NULL ) {
1649 ber_bvfree( rspdata );
1652 if ( rc == LDAP_SUCCESS ) {
1653 rc = ldap_int_tls_start( ld, ld->ld_defconn, NULL );
1657 rc = LDAP_NOT_SUPPORTED;