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;
202 #ifdef LDAP_R_COMPILE
203 ldap_pvt_thread_mutex_lock( &tls_def_ctx_mutex );
205 if (( !cacertfile && !cacertdir ) || !certfile || !keyfile )
206 return LDAP_NOT_SUPPORTED;
209 /* This ASCII/EBCDIC handling is a real pain! */
211 ciphersuite = LDAP_STRDUP( ciphersuite );
212 __atoe( ciphersuite );
215 cacertfile = LDAP_STRDUP( cacertfile );
216 __atoe( cacertfile );
219 cacertdir = LDAP_STRDUP( cacertdir );
223 certfile = LDAP_STRDUP( certfile );
227 keyfile = LDAP_STRDUP( keyfile );
231 if ( tls_def_ctx == NULL ) {
233 tls_def_ctx = SSL_CTX_new( SSLv23_method() );
234 if ( tls_def_ctx == NULL ) {
235 Debug( LDAP_DEBUG_ANY,
236 "TLS: could not allocate default ctx (%lu).\n",
237 ERR_peek_error(),0,0);
242 SSL_CTX_set_session_id_context( tls_def_ctx,
243 (const unsigned char *) "OpenLDAP", sizeof("OpenLDAP")-1 );
245 if ( tls_opt_ciphersuite &&
246 !SSL_CTX_set_cipher_list( tls_def_ctx, ciphersuite ) )
248 Debug( LDAP_DEBUG_ANY,
249 "TLS: could not set cipher list %s.\n",
250 tls_opt_ciphersuite, 0, 0 );
256 if (tls_opt_cacertfile != NULL || tls_opt_cacertdir != NULL) {
257 if ( !SSL_CTX_load_verify_locations( tls_def_ctx,
258 cacertfile, cacertdir ) ||
259 !SSL_CTX_set_default_verify_paths( tls_def_ctx ) )
261 Debug( LDAP_DEBUG_ANY, "TLS: "
262 "could not load verify locations (file:`%s',dir:`%s').\n",
263 tls_opt_cacertfile ? tls_opt_cacertfile : "",
264 tls_opt_cacertdir ? tls_opt_cacertdir : "",
271 calist = get_ca_list( cacertfile, cacertdir );
273 Debug( LDAP_DEBUG_ANY, "TLS: "
274 "could not load client CA list (file:`%s',dir:`%s').\n",
275 tls_opt_cacertfile ? tls_opt_cacertfile : "",
276 tls_opt_cacertdir ? tls_opt_cacertdir : "",
283 SSL_CTX_set_client_CA_list( tls_def_ctx, calist );
286 if ( tls_opt_keyfile &&
287 !SSL_CTX_use_PrivateKey_file( tls_def_ctx,
288 keyfile, SSL_FILETYPE_PEM ) )
290 Debug( LDAP_DEBUG_ANY,
291 "TLS: could not use key file `%s'.\n",
292 tls_opt_keyfile,0,0);
298 if ( tls_opt_certfile &&
299 !SSL_CTX_use_certificate_file( tls_def_ctx,
300 certfile, SSL_FILETYPE_PEM ) )
302 Debug( LDAP_DEBUG_ANY,
303 "TLS: could not use certificate `%s'.\n",
304 tls_opt_certfile,0,0);
310 if ( ( tls_opt_certfile || tls_opt_keyfile ) &&
311 !SSL_CTX_check_private_key( tls_def_ctx ) )
313 Debug( LDAP_DEBUG_ANY,
314 "TLS: private key mismatch.\n",
321 if ( tls_opt_trace ) {
322 SSL_CTX_set_info_callback( tls_def_ctx, tls_info_cb );
326 if ( tls_opt_require_cert ) {
328 if ( tls_opt_require_cert == LDAP_OPT_X_TLS_DEMAND ||
329 tls_opt_require_cert == LDAP_OPT_X_TLS_HARD ) {
330 i |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
334 SSL_CTX_set_verify( tls_def_ctx, i,
335 tls_opt_require_cert == LDAP_OPT_X_TLS_ALLOW ?
336 tls_verify_ok : tls_verify_cb );
337 SSL_CTX_set_tmp_rsa_callback( tls_def_ctx, tls_tmp_rsa_cb );
338 /* SSL_CTX_set_tmp_dh_callback( tls_def_ctx, tls_tmp_dh_cb ); */
339 #ifdef HAVE_OPENSSL_CRL
340 if ( tls_opt_crlcheck ) {
341 X509_STORE *x509_s = SSL_CTX_get_cert_store( tls_def_ctx );
342 if ( tls_opt_crlcheck == LDAP_OPT_X_TLS_CRL_PEER ) {
343 X509_STORE_set_flags( x509_s, X509_V_FLAG_CRL_CHECK );
344 } else if ( tls_opt_crlcheck == LDAP_OPT_X_TLS_CRL_ALL ) {
345 X509_STORE_set_flags( x509_s,
346 X509_V_FLAG_CRL_CHECK | X509_V_FLAG_CRL_CHECK_ALL );
352 if ( rc == -1 && tls_def_ctx != NULL ) {
353 SSL_CTX_free( tls_def_ctx );
357 LDAP_FREE( ciphersuite );
358 LDAP_FREE( cacertfile );
359 LDAP_FREE( cacertdir );
360 LDAP_FREE( certfile );
361 LDAP_FREE( keyfile );
363 #ifdef LDAP_R_COMPILE
364 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
369 static STACK_OF(X509_NAME) *
370 get_ca_list( char * bundle, char * dir )
372 STACK_OF(X509_NAME) *ca_list = NULL;
375 ca_list = SSL_load_client_CA_file( bundle );
377 #if defined(HAVE_DIRENT_H) || defined(dirent)
382 ca_list = sk_X509_NAME_new_null();
385 if ( !SSL_add_dir_cert_subjects_to_stack( ca_list, dir ) &&
387 sk_X509_NAME_free( ca_list );
396 alloc_handle( void *ctx_arg )
402 ctx = (SSL_CTX *) ctx_arg;
404 if ( ldap_pvt_tls_init_def_ctx() < 0 ) return NULL;
408 ssl = SSL_new( ctx );
410 Debug( LDAP_DEBUG_ANY,"TLS: can't create ssl handle.\n",0,0,0);
417 update_flags( Sockbuf *sb, SSL * ssl, int rc )
419 int err = SSL_get_error(ssl, rc);
421 sb->sb_trans_needs_read = 0;
422 sb->sb_trans_needs_write = 0;
424 if (err == SSL_ERROR_WANT_READ) {
425 sb->sb_trans_needs_read = 1;
428 } else if (err == SSL_ERROR_WANT_WRITE) {
429 sb->sb_trans_needs_write = 1;
432 } else if (err == SSL_ERROR_WANT_CONNECT) {
439 * TLS support for LBER Sockbufs
444 Sockbuf_IO_Desc *sbiod;
447 static BIO_METHOD sb_tls_bio_method;
450 sb_tls_setup( Sockbuf_IO_Desc *sbiod, void *arg )
455 assert( sbiod != NULL );
457 p = LBER_MALLOC( sizeof( *p ) );
464 bio = BIO_new( &sb_tls_bio_method );
465 bio->ptr = (void *)p;
466 SSL_set_bio( p->ssl, bio, bio );
467 sbiod->sbiod_pvt = p;
472 sb_tls_remove( Sockbuf_IO_Desc *sbiod )
476 assert( sbiod != NULL );
477 assert( sbiod->sbiod_pvt != NULL );
479 p = (struct tls_data *)sbiod->sbiod_pvt;
481 LBER_FREE( sbiod->sbiod_pvt );
482 sbiod->sbiod_pvt = NULL;
487 sb_tls_close( Sockbuf_IO_Desc *sbiod )
491 assert( sbiod != NULL );
492 assert( sbiod->sbiod_pvt != NULL );
494 p = (struct tls_data *)sbiod->sbiod_pvt;
495 SSL_shutdown( p->ssl );
500 sb_tls_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
504 assert( sbiod != NULL );
505 assert( sbiod->sbiod_pvt != NULL );
507 p = (struct tls_data *)sbiod->sbiod_pvt;
509 if ( opt == LBER_SB_OPT_GET_SSL ) {
510 *((SSL **)arg) = p->ssl;
513 } else if ( opt == LBER_SB_OPT_DATA_READY ) {
514 if( SSL_pending( p->ssl ) > 0 ) {
519 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
523 sb_tls_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
529 assert( sbiod != NULL );
530 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
532 p = (struct tls_data *)sbiod->sbiod_pvt;
534 ret = SSL_read( p->ssl, (char *)buf, len );
536 errno = WSAGetLastError();
538 err = SSL_get_error( p->ssl, ret );
539 if (err == SSL_ERROR_WANT_READ ) {
540 sbiod->sbiod_sb->sb_trans_needs_read = 1;
544 sbiod->sbiod_sb->sb_trans_needs_read = 0;
549 sb_tls_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
555 assert( sbiod != NULL );
556 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
558 p = (struct tls_data *)sbiod->sbiod_pvt;
560 ret = SSL_write( p->ssl, (char *)buf, len );
562 errno = WSAGetLastError();
564 err = SSL_get_error( p->ssl, ret );
565 if (err == SSL_ERROR_WANT_WRITE ) {
566 sbiod->sbiod_sb->sb_trans_needs_write = 1;
570 sbiod->sbiod_sb->sb_trans_needs_write = 0;
575 static Sockbuf_IO sb_tls_sbio =
577 sb_tls_setup, /* sbi_setup */
578 sb_tls_remove, /* sbi_remove */
579 sb_tls_ctrl, /* sbi_ctrl */
580 sb_tls_read, /* sbi_read */
581 sb_tls_write, /* sbi_write */
582 sb_tls_close /* sbi_close */
586 sb_tls_bio_create( BIO *b ) {
595 sb_tls_bio_destroy( BIO *b )
597 if ( b == NULL ) return 0;
599 b->ptr = NULL; /* sb_tls_remove() will free it */
606 sb_tls_bio_read( BIO *b, char *buf, int len )
611 if ( buf == NULL || len <= 0 ) return 0;
613 p = (struct tls_data *)b->ptr;
615 if ( p == NULL || p->sbiod == NULL ) {
619 ret = LBER_SBIOD_READ_NEXT( p->sbiod, buf, len );
621 BIO_clear_retry_flags( b );
624 if ( err == EAGAIN || err == EWOULDBLOCK ) {
625 BIO_set_retry_read( b );
633 sb_tls_bio_write( BIO *b, const char *buf, int len )
638 if ( buf == NULL || len <= 0 ) return 0;
640 p = (struct tls_data *)b->ptr;
642 if ( p == NULL || p->sbiod == NULL ) {
646 ret = LBER_SBIOD_WRITE_NEXT( p->sbiod, (char *)buf, len );
648 BIO_clear_retry_flags( b );
651 if ( err == EAGAIN || err == EWOULDBLOCK ) {
652 BIO_set_retry_write( b );
660 sb_tls_bio_ctrl( BIO *b, int cmd, long num, void *ptr )
662 if ( cmd == BIO_CTRL_FLUSH ) {
663 /* The OpenSSL library needs this */
670 sb_tls_bio_gets( BIO *b, char *buf, int len )
676 sb_tls_bio_puts( BIO *b, const char *str )
678 return sb_tls_bio_write( b, str, strlen( str ) );
681 static BIO_METHOD sb_tls_bio_method =
683 ( 100 | 0x400 ), /* it's a source/sink BIO */
695 * Call this to do a TLS connect on a sockbuf. ctx_arg can be
696 * a SSL_CTX * or NULL, in which case the default ctx is used.
700 * 0 - Success. Connection is ready for communication.
701 * <0 - Error. Can't create a TLS stream.
702 * >0 - Partial success.
703 * Do a select (using information from lber_pvt_sb_needs_{read,write}
708 ldap_int_tls_connect( LDAP *ld, LDAPConn *conn )
710 Sockbuf *sb = conn->lconn_sb;
714 if ( HAS_TLS( sb ) ) {
715 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
718 struct ldapoptions *lo;
719 void *ctx = ld->ld_defconn
720 ? ld->ld_defconn->lconn_tls_ctx : NULL;
722 ssl = alloc_handle( ctx );
724 if ( ssl == NULL ) return -1;
727 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
728 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
730 ber_sockbuf_add_io( sb, &sb_tls_sbio,
731 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
735 conn->lconn_tls_ctx = tls_def_ctx;
737 lo = &ld->ld_options;
738 if ( lo->ldo_tls_connect_cb )
739 lo->ldo_tls_connect_cb( ld, ssl, ctx, lo->ldo_tls_connect_arg );
740 lo = LDAP_INT_GLOBAL_OPT();
741 if ( lo && lo->ldo_tls_connect_cb )
742 lo->ldo_tls_connect_cb( ld, ssl, ctx, lo->ldo_tls_connect_arg );
745 err = SSL_connect( ssl );
748 errno = WSAGetLastError();
752 if ( update_flags( sb, ssl, err )) {
756 if ((err = ERR_peek_error())) {
759 if ( ld->ld_error ) {
760 LDAP_FREE( ld->ld_error );
762 ld->ld_error = LDAP_STRDUP(ERR_error_string(err, buf));
764 if ( ld->ld_error ) __etoa(ld->ld_error);
768 Debug( LDAP_DEBUG_ANY,"TLS: can't connect.\n",0,0,0);
770 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
771 LBER_SBIOD_LEVEL_TRANSPORT );
773 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
774 LBER_SBIOD_LEVEL_TRANSPORT );
783 * Call this to do a TLS accept on a sockbuf.
784 * Everything else is the same as with tls_connect.
787 ldap_pvt_tls_accept( Sockbuf *sb, void *ctx_arg )
792 if ( HAS_TLS( sb ) ) {
793 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
796 ssl = alloc_handle( ctx_arg );
797 if ( ssl == NULL ) return -1;
800 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
801 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
803 ber_sockbuf_add_io( sb, &sb_tls_sbio,
804 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
807 err = SSL_accept( ssl );
810 errno = WSAGetLastError();
813 if ( update_flags( sb, ssl, err )) return 1;
815 Debug( LDAP_DEBUG_ANY,"TLS: can't accept.\n",0,0,0 );
818 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
819 LBER_SBIOD_LEVEL_TRANSPORT );
821 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
822 LBER_SBIOD_LEVEL_TRANSPORT );
831 ldap_pvt_tls_inplace ( Sockbuf *sb )
833 return HAS_TLS( sb ) ? 1 : 0;
837 ldap_tls_inplace( LDAP *ld )
841 if ( ld->ld_defconn && ld->ld_defconn->lconn_sb ) {
842 sb = ld->ld_defconn->lconn_sb;
844 } else if ( ld->ld_sb ) {
851 return ldap_pvt_tls_inplace( sb );
855 tls_get_cert( SSL *s )
857 /* If peer cert was bad, treat as if no cert was given */
858 if (SSL_get_verify_result(s)) {
859 /* If we can send an alert, do so */
860 if (SSL_version(s) != SSL2_VERSION) {
861 ssl3_send_alert(s,SSL3_AL_WARNING,SSL3_AD_BAD_CERTIFICATE);
865 return SSL_get_peer_certificate(s);
869 ldap_pvt_tls_get_peer_dn( void *s, struct berval *dn,
870 LDAPDN_rewrite_dummy *func, unsigned flags )
876 x = tls_get_cert((SSL *)s);
878 if (!x) return LDAP_INVALID_CREDENTIALS;
880 xn = X509_get_subject_name(x);
881 rc = ldap_X509dn2bv(xn, dn, (LDAPDN_rewrite_func *)func, flags);
887 ldap_pvt_tls_get_peer_hostname( void *s )
894 x = tls_get_cert((SSL *)s);
897 xn = X509_get_subject_name(x);
899 ret = X509_NAME_get_text_by_NID(xn, NID_commonName, buf, sizeof(buf));
905 p = LDAP_STRDUP(buf);
910 /* what kind of hostname were we given? */
916 ldap_pvt_tls_check_hostname( LDAP *ld, void *s, const char *name_in )
918 int i, ret = LDAP_LOCAL_ERROR;
924 struct in6_addr addr;
929 if( ldap_int_hostname &&
930 ( !name_in || !strcasecmp( name_in, "localhost" ) ) )
932 name = ldap_int_hostname;
937 x = tls_get_cert((SSL *)s);
939 Debug( LDAP_DEBUG_ANY,
940 "TLS: unable to get peer certificate.\n",
942 /* If this was a fatal condition, things would have
943 * aborted long before now.
949 if (name[0] == '[' && strchr(name, ']')) {
950 char *n2 = ldap_strdup(name+1);
951 *strchr(n2, ']') = 2;
952 if (inet_pton(AF_INET6, n2, &addr))
957 if ((ptr = strrchr(name, '.')) && isdigit((unsigned char)ptr[1])) {
958 if (inet_aton(name, (struct in_addr *)&addr)) ntype = IS_IP4;
961 i = X509_get_ext_by_NID(x, NID_subject_alt_name, -1);
964 STACK_OF(GENERAL_NAME) *alt;
966 ex = X509_get_ext(x, i);
967 alt = X509V3_EXT_d2i(ex);
969 int n, len1 = 0, len2 = 0;
973 if (ntype == IS_DNS) {
975 domain = strchr(name, '.');
977 len2 = len1 - (domain-name);
980 n = sk_GENERAL_NAME_num(alt);
981 for (i=0; i<n; i++) {
984 gn = sk_GENERAL_NAME_value(alt, i);
985 if (gn->type == GEN_DNS) {
986 if (ntype != IS_DNS) continue;
988 sn = (char *) ASN1_STRING_data(gn->d.ia5);
989 sl = ASN1_STRING_length(gn->d.ia5);
992 if (sl == 0) continue;
994 /* Is this an exact match? */
995 if ((len1 == sl) && !strncasecmp(name, sn, len1)) {
999 /* Is this a wildcard match? */
1000 if (domain && (sn[0] == '*') && (sn[1] == '.') &&
1001 (len2 == sl-1) && !strncasecmp(domain, &sn[1], len2))
1006 } else if (gn->type == GEN_IPADD) {
1007 if (ntype == IS_DNS) continue;
1009 sn = (char *) ASN1_STRING_data(gn->d.ia5);
1010 sl = ASN1_STRING_length(gn->d.ia5);
1012 #ifdef LDAP_PF_INET6
1013 if (ntype == IS_IP6 && sl != sizeof(struct in6_addr)) {
1017 if (ntype == IS_IP4 && sl != sizeof(struct in_addr)) {
1020 if (!memcmp(sn, &addr, sl)) {
1026 GENERAL_NAMES_free(alt);
1027 if (i < n) { /* Found a match */
1033 if (ret != LDAP_SUCCESS) {
1038 xn = X509_get_subject_name(x);
1039 if( X509_NAME_get_text_by_NID( xn, NID_commonName,
1040 buf, sizeof(buf)) == -1)
1042 Debug( LDAP_DEBUG_ANY,
1043 "TLS: unable to get common name from peer certificate.\n",
1045 ret = LDAP_CONNECT_ERROR;
1046 if ( ld->ld_error ) {
1047 LDAP_FREE( ld->ld_error );
1049 ld->ld_error = LDAP_STRDUP(
1050 _("TLS: unable to get CN from peer certificate"));
1052 } else if (strcasecmp(name, buf) == 0 ) {
1055 } else if (( buf[0] == '*' ) && ( buf[1] == '.' )) {
1056 char *domain = strchr(name, '.');
1062 dlen = sl - (domain-name);
1065 /* Is this a wildcard match? */
1066 if ((dlen == sl-1) && !strncasecmp(domain, &buf[1], dlen)) {
1072 if( ret == LDAP_LOCAL_ERROR ) {
1073 Debug( LDAP_DEBUG_ANY, "TLS: hostname (%s) does not match "
1074 "common name in certificate (%s).\n",
1076 ret = LDAP_CONNECT_ERROR;
1077 if ( ld->ld_error ) {
1078 LDAP_FREE( ld->ld_error );
1080 ld->ld_error = LDAP_STRDUP(
1081 _("TLS: hostname does not match CN in peer certificate"));
1089 ldap_pvt_tls_get_peer_issuer( void *s )
1091 #if 0 /* currently unused; see ldap_pvt_tls_get_peer_dn() if needed */
1096 x = SSL_get_peer_certificate((SSL *)s);
1098 if (!x) return NULL;
1100 xn = X509_get_issuer_name(x);
1101 p = LDAP_STRDUP(X509_NAME_oneline(xn, buf, sizeof(buf)));
1110 ldap_int_tls_config( LDAP *ld, int option, const char *arg )
1115 case LDAP_OPT_X_TLS_CACERTFILE:
1116 case LDAP_OPT_X_TLS_CACERTDIR:
1117 case LDAP_OPT_X_TLS_CERTFILE:
1118 case LDAP_OPT_X_TLS_KEYFILE:
1119 case LDAP_OPT_X_TLS_RANDOM_FILE:
1120 case LDAP_OPT_X_TLS_CIPHER_SUITE:
1121 return ldap_pvt_tls_set_option( ld, option, (void *) arg );
1123 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1124 case LDAP_OPT_X_TLS:
1126 if ( strcasecmp( arg, "never" ) == 0 ) {
1127 i = LDAP_OPT_X_TLS_NEVER ;
1129 } else if ( strcasecmp( arg, "demand" ) == 0 ) {
1130 i = LDAP_OPT_X_TLS_DEMAND ;
1132 } else if ( strcasecmp( arg, "allow" ) == 0 ) {
1133 i = LDAP_OPT_X_TLS_ALLOW ;
1135 } else if ( strcasecmp( arg, "try" ) == 0 ) {
1136 i = LDAP_OPT_X_TLS_TRY ;
1138 } else if ( ( strcasecmp( arg, "hard" ) == 0 ) ||
1139 ( strcasecmp( arg, "on" ) == 0 ) ||
1140 ( strcasecmp( arg, "yes" ) == 0) ||
1141 ( strcasecmp( arg, "true" ) == 0 ) )
1143 i = LDAP_OPT_X_TLS_HARD ;
1147 return ldap_pvt_tls_set_option( ld, option, &i );
1150 #ifdef HAVE_OPENSSL_CRL
1151 case LDAP_OPT_X_TLS_CRLCHECK:
1153 if ( strcasecmp( arg, "none" ) == 0 ) {
1154 i = LDAP_OPT_X_TLS_CRL_NONE ;
1155 } else if ( strcasecmp( arg, "peer" ) == 0 ) {
1156 i = LDAP_OPT_X_TLS_CRL_PEER ;
1157 } else if ( strcasecmp( arg, "all" ) == 0 ) {
1158 i = LDAP_OPT_X_TLS_CRL_ALL ;
1161 return ldap_pvt_tls_set_option( ld, option, &i );
1170 ldap_pvt_tls_get_option( LDAP *ld, int option, void *arg )
1172 struct ldapoptions *lo;
1175 assert( LDAP_VALID( ld ) );
1177 if( !LDAP_VALID( ld ) ) {
1178 return LDAP_OPT_ERROR;
1181 lo = &ld->ld_options;
1184 /* Get pointer to global option structure */
1185 lo = LDAP_INT_GLOBAL_OPT();
1187 return LDAP_NO_MEMORY;
1192 case LDAP_OPT_X_TLS:
1193 *(int *)arg = lo->ldo_tls_mode;
1195 case LDAP_OPT_X_TLS_CTX:
1197 *(void **)arg = (void *) tls_def_ctx;
1199 *(void **)arg = ld->ld_defconn->lconn_tls_ctx;
1202 case LDAP_OPT_X_TLS_CACERTFILE:
1203 *(char **)arg = tls_opt_cacertfile ?
1204 LDAP_STRDUP( tls_opt_cacertfile ) : NULL;
1206 case LDAP_OPT_X_TLS_CACERTDIR:
1207 *(char **)arg = tls_opt_cacertdir ?
1208 LDAP_STRDUP( tls_opt_cacertdir ) : NULL;
1210 case LDAP_OPT_X_TLS_CERTFILE:
1211 *(char **)arg = tls_opt_certfile ?
1212 LDAP_STRDUP( tls_opt_certfile ) : NULL;
1214 case LDAP_OPT_X_TLS_KEYFILE:
1215 *(char **)arg = tls_opt_keyfile ?
1216 LDAP_STRDUP( tls_opt_keyfile ) : NULL;
1218 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1219 *(int *)arg = tls_opt_require_cert;
1221 #ifdef HAVE_OPENSSL_CRL
1222 case LDAP_OPT_X_TLS_CRLCHECK:
1223 *(int *)arg = tls_opt_crlcheck;
1226 case LDAP_OPT_X_TLS_RANDOM_FILE:
1227 *(char **)arg = tls_opt_randfile ?
1228 LDAP_STRDUP( tls_opt_randfile ) : NULL;
1230 case LDAP_OPT_X_TLS_SSL_CTX: {
1233 LDAPConn *conn = ld->ld_defconn;
1234 if ( conn != NULL ) {
1235 Sockbuf *sb = conn->lconn_sb;
1236 retval = ldap_pvt_tls_sb_ctx( sb );
1239 *(void **)arg = retval;
1242 case LDAP_OPT_X_TLS_CONNECT_CB:
1243 *(LDAP_TLS_CONNECT_CB **)arg = lo->ldo_tls_connect_cb;
1245 case LDAP_OPT_X_TLS_CONNECT_ARG:
1246 *(void **)arg = lo->ldo_tls_connect_arg;
1255 ldap_pvt_tls_set_option( LDAP *ld, int option, void *arg )
1257 struct ldapoptions *lo;
1260 assert( LDAP_VALID( ld ) );
1262 if( !LDAP_VALID( ld ) ) {
1263 return LDAP_OPT_ERROR;
1266 lo = &ld->ld_options;
1269 /* Get pointer to global option structure */
1270 lo = LDAP_INT_GLOBAL_OPT();
1272 return LDAP_NO_MEMORY;
1277 case LDAP_OPT_X_TLS:
1278 switch( *(int *) arg ) {
1279 case LDAP_OPT_X_TLS_NEVER:
1280 case LDAP_OPT_X_TLS_DEMAND:
1281 case LDAP_OPT_X_TLS_ALLOW:
1282 case LDAP_OPT_X_TLS_TRY:
1283 case LDAP_OPT_X_TLS_HARD:
1285 lo->ldo_tls_mode = *(int *)arg;
1292 case LDAP_OPT_X_TLS_CTX:
1294 tls_def_ctx = (SSL_CTX *) arg;
1297 ld->ld_defconn->lconn_tls_ctx = arg;
1300 case LDAP_OPT_X_TLS_CONNECT_CB:
1301 lo->ldo_tls_connect_cb = (LDAP_TLS_CONNECT_CB *)arg;
1303 case LDAP_OPT_X_TLS_CONNECT_ARG:
1304 lo->ldo_tls_connect_arg = arg;
1313 case LDAP_OPT_X_TLS_CACERTFILE:
1314 if ( tls_opt_cacertfile ) LDAP_FREE( tls_opt_cacertfile );
1315 tls_opt_cacertfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1317 case LDAP_OPT_X_TLS_CACERTDIR:
1318 if ( tls_opt_cacertdir ) LDAP_FREE( tls_opt_cacertdir );
1319 tls_opt_cacertdir = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1321 case LDAP_OPT_X_TLS_CERTFILE:
1322 if ( tls_opt_certfile ) LDAP_FREE( tls_opt_certfile );
1323 tls_opt_certfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1325 case LDAP_OPT_X_TLS_KEYFILE:
1326 if ( tls_opt_keyfile ) LDAP_FREE( tls_opt_keyfile );
1327 tls_opt_keyfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1329 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1330 switch( *(int *) arg ) {
1331 case LDAP_OPT_X_TLS_NEVER:
1332 case LDAP_OPT_X_TLS_DEMAND:
1333 case LDAP_OPT_X_TLS_ALLOW:
1334 case LDAP_OPT_X_TLS_TRY:
1335 case LDAP_OPT_X_TLS_HARD:
1336 tls_opt_require_cert = * (int *) arg;
1340 #ifdef HAVE_OPENSSL_CRL
1341 case LDAP_OPT_X_TLS_CRLCHECK:
1342 switch( *(int *) arg ) {
1343 case LDAP_OPT_X_TLS_CRL_NONE:
1344 case LDAP_OPT_X_TLS_CRL_PEER:
1345 case LDAP_OPT_X_TLS_CRL_ALL:
1346 tls_opt_crlcheck = * (int *) arg;
1351 case LDAP_OPT_X_TLS_CIPHER_SUITE:
1352 if ( tls_opt_ciphersuite ) LDAP_FREE( tls_opt_ciphersuite );
1353 tls_opt_ciphersuite = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1355 case LDAP_OPT_X_TLS_RANDOM_FILE:
1356 if (tls_opt_randfile ) LDAP_FREE (tls_opt_randfile );
1357 tls_opt_randfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1366 ldap_int_tls_start ( LDAP *ld, LDAPConn *conn, LDAPURLDesc *srv )
1368 Sockbuf *sb = conn->lconn_sb;
1373 host = srv->lud_host;
1375 host = conn->lconn_server->lud_host;
1378 /* avoid NULL host */
1379 if( host == NULL ) {
1383 (void) ldap_pvt_tls_init();
1386 * Fortunately, the lib uses blocking io...
1388 if ( ldap_int_tls_connect( ld, conn ) < 0 ) {
1389 ld->ld_errno = LDAP_CONNECT_ERROR;
1390 return (ld->ld_errno);
1393 ssl = ldap_pvt_tls_sb_ctx( sb );
1394 assert( ssl != NULL );
1397 * compare host with name(s) in certificate
1399 if (tls_opt_require_cert != LDAP_OPT_X_TLS_NEVER) {
1400 ld->ld_errno = ldap_pvt_tls_check_hostname( ld, ssl, host );
1401 if (ld->ld_errno != LDAP_SUCCESS) {
1402 return ld->ld_errno;
1406 return LDAP_SUCCESS;
1409 /* Derived from openssl/apps/s_cb.c */
1411 tls_info_cb( const SSL *ssl, int where, int ret )
1415 char *state = (char *) SSL_state_string_long( (SSL *)ssl );
1417 w = where & ~SSL_ST_MASK;
1418 if ( w & SSL_ST_CONNECT ) {
1420 } else if ( w & SSL_ST_ACCEPT ) {
1428 state = LDAP_STRDUP( state );
1432 if ( where & SSL_CB_LOOP ) {
1433 Debug( LDAP_DEBUG_TRACE,
1434 "TLS trace: %s:%s\n",
1437 } else if ( where & SSL_CB_ALERT ) {
1438 char *atype = (char *) SSL_alert_type_string_long( ret );
1439 char *adesc = (char *) SSL_alert_desc_string_long( ret );
1440 op = ( where & SSL_CB_READ ) ? "read" : "write";
1443 atype = LDAP_STRDUP( atype );
1447 adesc = LDAP_STRDUP( adesc );
1451 Debug( LDAP_DEBUG_TRACE,
1452 "TLS trace: SSL3 alert %s:%s:%s\n",
1455 if ( atype ) LDAP_FREE( atype );
1456 if ( adesc ) LDAP_FREE( adesc );
1458 } else if ( where & SSL_CB_EXIT ) {
1460 Debug( LDAP_DEBUG_TRACE,
1461 "TLS trace: %s:failed in %s\n",
1463 } else if ( ret < 0 ) {
1464 Debug( LDAP_DEBUG_TRACE,
1465 "TLS trace: %s:error in %s\n",
1470 if ( state ) LDAP_FREE( state );
1475 tls_verify_cb( int ok, X509_STORE_CTX *ctx )
1484 char *certerr = NULL;
1486 cert = X509_STORE_CTX_get_current_cert( ctx );
1487 errnum = X509_STORE_CTX_get_error( ctx );
1488 errdepth = X509_STORE_CTX_get_error_depth( ctx );
1491 * X509_get_*_name return pointers to the internal copies of
1492 * those things requested. So do not free them.
1494 subject = X509_get_subject_name( cert );
1495 issuer = X509_get_issuer_name( cert );
1496 /* X509_NAME_oneline, if passed a NULL buf, allocate memomry */
1497 sname = X509_NAME_oneline( subject, NULL, 0 );
1498 iname = X509_NAME_oneline( issuer, NULL, 0 );
1499 if ( !ok ) certerr = (char *)X509_verify_cert_error_string( errnum );
1501 if ( sname ) __etoa( sname );
1502 if ( iname ) __etoa( iname );
1504 certerr = LDAP_STRDUP( certerr );
1508 Debug( LDAP_DEBUG_TRACE,
1509 "TLS certificate verification: depth: %d, err: %d, subject: %s,",
1511 sname ? sname : "-unknown-" );
1512 Debug( LDAP_DEBUG_TRACE, " issuer: %s\n", iname ? iname : "-unknown-", 0, 0 );
1514 Debug( LDAP_DEBUG_ANY,
1515 "TLS certificate verification: Error, %s\n",
1519 CRYPTO_free ( sname );
1521 CRYPTO_free ( iname );
1523 if ( certerr ) LDAP_FREE( certerr );
1529 tls_verify_ok( int ok, X509_STORE_CTX *ctx )
1531 (void) tls_verify_cb( ok, ctx );
1535 /* Inspired by ERR_print_errors in OpenSSL */
1537 tls_report_error( void )
1544 while ( ( l = ERR_get_error_line( &file, &line ) ) != 0 ) {
1545 ERR_error_string_n( l, buf, sizeof( buf ) );
1548 file = LDAP_STRDUP( file );
1549 __etoa( (char *)file );
1553 Debug( LDAP_DEBUG_ANY, "TLS: %s %s:%d\n",
1556 if ( file ) LDAP_FREE( (void *)file );
1562 tls_tmp_rsa_cb( SSL *ssl, int is_export, int key_length )
1566 /* FIXME: Pregenerate the key on startup */
1567 /* FIXME: Who frees the key? */
1568 tmp_rsa = RSA_generate_key( key_length, RSA_F4, NULL, NULL );
1571 Debug( LDAP_DEBUG_ANY,
1572 "TLS: Failed to generate temporary %d-bit %s RSA key\n",
1573 key_length, is_export ? "export" : "domestic", 0 );
1580 tls_seed_PRNG( const char *randfile )
1582 #ifndef URANDOM_DEVICE
1583 /* no /dev/urandom (or equiv) */
1585 char buffer[MAXPATHLEN];
1587 if (randfile == NULL) {
1588 /* The seed file is $RANDFILE if defined, otherwise $HOME/.rnd.
1589 * If $HOME is not set or buffer too small to hold the pathname,
1590 * an error occurs. - From RAND_file_name() man page.
1591 * The fact is that when $HOME is NULL, .rnd is used.
1593 randfile = RAND_file_name( buffer, sizeof( buffer ) );
1595 } else if (RAND_egd(randfile) > 0) {
1600 if (randfile == NULL) {
1601 Debug( LDAP_DEBUG_ANY,
1602 "TLS: Use configuration file or $RANDFILE to define seed PRNG\n",
1607 total = RAND_load_file(randfile, -1);
1609 if (RAND_status() == 0) {
1610 Debug( LDAP_DEBUG_ANY,
1611 "TLS: PRNG not been seeded with enough data\n",
1616 /* assume if there was enough bits to seed that it's okay
1617 * to write derived bits to the file
1619 RAND_write_file(randfile);
1628 tls_tmp_dh_cb( SSL *ssl, int is_export, int key_length )
1636 ldap_pvt_tls_sb_ctx( Sockbuf *sb )
1641 if (HAS_TLS( sb )) {
1642 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&p );
1651 ldap_pvt_tls_get_strength( void *s )
1656 c = SSL_get_current_cipher((SSL *)s);
1657 return SSL_CIPHER_get_bits(c, NULL);
1665 ldap_pvt_tls_get_my_dn( void *s, struct berval *dn, LDAPDN_rewrite_dummy *func, unsigned flags )
1672 x = SSL_get_certificate((SSL *)s);
1674 if (!x) return LDAP_INVALID_CREDENTIALS;
1676 xn = X509_get_subject_name(x);
1677 rc = ldap_X509dn2bv(xn, dn, (LDAPDN_rewrite_func *)func, flags );
1680 return LDAP_NOT_SUPPORTED;
1685 ldap_start_tls( LDAP *ld,
1686 LDAPControl **serverctrls,
1687 LDAPControl **clientctrls,
1690 return ldap_extended_operation( ld, LDAP_EXOP_START_TLS,
1691 NULL, serverctrls, clientctrls, msgidp );
1695 ldap_install_tls( LDAP *ld )
1698 return LDAP_NOT_SUPPORTED;
1700 if ( ldap_tls_inplace( ld ) ) {
1701 return LDAP_LOCAL_ERROR;
1704 return ldap_int_tls_start( ld, ld->ld_defconn, NULL );
1709 ldap_start_tls_s ( LDAP *ld,
1710 LDAPControl **serverctrls,
1711 LDAPControl **clientctrls )
1714 return LDAP_NOT_SUPPORTED;
1717 char *rspoid = NULL;
1718 struct berval *rspdata = NULL;
1720 /* XXYYZ: this initiates operation only on default connection! */
1722 if ( ldap_tls_inplace( ld ) ) {
1723 return LDAP_LOCAL_ERROR;
1726 rc = ldap_extended_operation_s( ld, LDAP_EXOP_START_TLS,
1727 NULL, serverctrls, clientctrls, &rspoid, &rspdata );
1729 if ( rspoid != NULL ) {
1733 if ( rspdata != NULL ) {
1734 ber_bvfree( rspdata );
1737 if ( rc == LDAP_SUCCESS ) {
1738 rc = ldap_int_tls_start( ld, ld->ld_defconn, NULL );