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;
164 char *file = LDAP_STRDUP( tls_opt_randfile );
165 if ( file ) __atoe( file );
166 (void) tls_seed_PRNG( file );
170 (void) tls_seed_PRNG( tls_opt_randfile );
173 #ifdef LDAP_R_COMPILE
177 SSL_load_error_strings();
178 SSLeay_add_ssl_algorithms();
180 /* FIXME: mod_ssl does this */
181 X509V3_add_standard_extensions();
186 * initialize the default context
189 ldap_pvt_tls_init_def_ctx( void )
191 STACK_OF(X509_NAME) *calist;
193 char *ciphersuite = tls_opt_ciphersuite;
194 char *cacertfile = tls_opt_cacertfile;
195 char *cacertdir = tls_opt_cacertdir;
196 char *certfile = tls_opt_certfile;
197 char *keyfile = tls_opt_keyfile;
200 /* This ASCII/EBCDIC handling is a real pain! */
202 ciphersuite = LDAP_STRDUP( ciphersuite );
203 __atoe( ciphersuite );
206 cacertfile = LDAP_STRDUP( cacertfile );
207 __atoe( cacertfile );
210 cacertdir = LDAP_STRDUP( cacertdir );
214 certfile = LDAP_STRDUP( certfile );
218 keyfile = LDAP_STRDUP( keyfile );
223 #ifdef LDAP_R_COMPILE
224 ldap_pvt_thread_mutex_lock( &tls_def_ctx_mutex );
226 if ( tls_def_ctx == NULL ) {
228 tls_def_ctx = SSL_CTX_new( SSLv23_method() );
229 if ( tls_def_ctx == NULL ) {
230 Debug( LDAP_DEBUG_ANY,
231 "TLS: could not allocate default ctx (%lu).\n",
232 ERR_peek_error(),0,0);
237 SSL_CTX_set_session_id_context( tls_def_ctx,
238 (const unsigned char *) "OpenLDAP", sizeof("OpenLDAP")-1 );
240 if ( tls_opt_ciphersuite &&
241 !SSL_CTX_set_cipher_list( tls_def_ctx, ciphersuite ) )
243 Debug( LDAP_DEBUG_ANY,
244 "TLS: could not set cipher list %s.\n",
245 tls_opt_ciphersuite, 0, 0 );
251 if (tls_opt_cacertfile != NULL || tls_opt_cacertdir != NULL) {
252 if ( !SSL_CTX_load_verify_locations( tls_def_ctx,
253 cacertfile, cacertdir ) ||
254 !SSL_CTX_set_default_verify_paths( tls_def_ctx ) )
256 Debug( LDAP_DEBUG_ANY, "TLS: "
257 "could not load verify locations (file:`%s',dir:`%s').\n",
258 tls_opt_cacertfile ? tls_opt_cacertfile : "",
259 tls_opt_cacertdir ? tls_opt_cacertdir : "",
266 calist = get_ca_list( cacertfile, cacertdir );
268 Debug( LDAP_DEBUG_ANY, "TLS: "
269 "could not load client CA list (file:`%s',dir:`%s').\n",
270 tls_opt_cacertfile ? tls_opt_cacertfile : "",
271 tls_opt_cacertdir ? tls_opt_cacertdir : "",
278 SSL_CTX_set_client_CA_list( tls_def_ctx, calist );
281 if ( tls_opt_keyfile &&
282 !SSL_CTX_use_PrivateKey_file( tls_def_ctx,
283 keyfile, SSL_FILETYPE_PEM ) )
285 Debug( LDAP_DEBUG_ANY,
286 "TLS: could not use key file `%s'.\n",
287 tls_opt_keyfile,0,0);
293 if ( tls_opt_certfile &&
294 !SSL_CTX_use_certificate_file( tls_def_ctx,
295 certfile, SSL_FILETYPE_PEM ) )
297 Debug( LDAP_DEBUG_ANY,
298 "TLS: could not use certificate `%s'.\n",
299 tls_opt_certfile,0,0);
305 if ( ( tls_opt_certfile || tls_opt_keyfile ) &&
306 !SSL_CTX_check_private_key( tls_def_ctx ) )
308 Debug( LDAP_DEBUG_ANY,
309 "TLS: private key mismatch.\n",
316 if ( tls_opt_trace ) {
317 SSL_CTX_set_info_callback( tls_def_ctx, tls_info_cb );
321 if ( tls_opt_require_cert ) {
323 if ( tls_opt_require_cert == LDAP_OPT_X_TLS_DEMAND ||
324 tls_opt_require_cert == LDAP_OPT_X_TLS_HARD ) {
325 i |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
329 SSL_CTX_set_verify( tls_def_ctx, i,
330 tls_opt_require_cert == LDAP_OPT_X_TLS_ALLOW ?
331 tls_verify_ok : tls_verify_cb );
332 SSL_CTX_set_tmp_rsa_callback( tls_def_ctx, tls_tmp_rsa_cb );
333 /* SSL_CTX_set_tmp_dh_callback( tls_def_ctx, tls_tmp_dh_cb ); */
336 if ( rc == -1 && tls_def_ctx != NULL ) {
337 SSL_CTX_free( tls_def_ctx );
341 LDAP_FREE( ciphersuite );
342 LDAP_FREE( cacertfile );
343 LDAP_FREE( cacertdir );
344 LDAP_FREE( certfile );
345 LDAP_FREE( keyfile );
347 #ifdef LDAP_R_COMPILE
348 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
353 static STACK_OF(X509_NAME) *
354 get_ca_list( char * bundle, char * dir )
356 STACK_OF(X509_NAME) *ca_list = NULL;
359 ca_list = SSL_load_client_CA_file( bundle );
361 #if defined(HAVE_DIRENT_H) || defined(dirent)
366 ca_list = sk_X509_NAME_new_null();
369 if ( !SSL_add_dir_cert_subjects_to_stack( ca_list, dir ) &&
371 sk_X509_NAME_free( ca_list );
380 alloc_handle( void *ctx_arg )
386 ctx = (SSL_CTX *) ctx_arg;
388 if ( ldap_pvt_tls_init_def_ctx() < 0 ) return NULL;
392 ssl = SSL_new( ctx );
394 Debug( LDAP_DEBUG_ANY,"TLS: can't create ssl handle.\n",0,0,0);
401 update_flags( Sockbuf *sb, SSL * ssl, int rc )
403 int err = SSL_get_error(ssl, rc);
405 sb->sb_trans_needs_read = 0;
406 sb->sb_trans_needs_write = 0;
408 if (err == SSL_ERROR_WANT_READ) {
409 sb->sb_trans_needs_read = 1;
412 } else if (err == SSL_ERROR_WANT_WRITE) {
413 sb->sb_trans_needs_write = 1;
416 } else if (err == SSL_ERROR_WANT_CONNECT) {
423 * TLS support for LBER Sockbufs
428 Sockbuf_IO_Desc *sbiod;
431 static BIO_METHOD sb_tls_bio_method;
434 sb_tls_setup( Sockbuf_IO_Desc *sbiod, void *arg )
439 assert( sbiod != NULL );
441 p = LBER_MALLOC( sizeof( *p ) );
448 bio = BIO_new( &sb_tls_bio_method );
449 bio->ptr = (void *)p;
450 SSL_set_bio( p->ssl, bio, bio );
451 sbiod->sbiod_pvt = p;
456 sb_tls_remove( Sockbuf_IO_Desc *sbiod )
460 assert( sbiod != NULL );
461 assert( sbiod->sbiod_pvt != NULL );
463 p = (struct tls_data *)sbiod->sbiod_pvt;
465 LBER_FREE( sbiod->sbiod_pvt );
466 sbiod->sbiod_pvt = NULL;
471 sb_tls_close( Sockbuf_IO_Desc *sbiod )
475 assert( sbiod != NULL );
476 assert( sbiod->sbiod_pvt != NULL );
478 p = (struct tls_data *)sbiod->sbiod_pvt;
479 SSL_shutdown( p->ssl );
484 sb_tls_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
488 assert( sbiod != NULL );
489 assert( sbiod->sbiod_pvt != NULL );
491 p = (struct tls_data *)sbiod->sbiod_pvt;
493 if ( opt == LBER_SB_OPT_GET_SSL ) {
494 *((SSL **)arg) = p->ssl;
497 } else if ( opt == LBER_SB_OPT_DATA_READY ) {
498 if( SSL_pending( p->ssl ) > 0 ) {
503 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
507 sb_tls_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
513 assert( sbiod != NULL );
514 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
516 p = (struct tls_data *)sbiod->sbiod_pvt;
518 ret = SSL_read( p->ssl, (char *)buf, len );
520 errno = WSAGetLastError();
522 err = SSL_get_error( p->ssl, ret );
523 if (err == SSL_ERROR_WANT_READ ) {
524 sbiod->sbiod_sb->sb_trans_needs_read = 1;
528 sbiod->sbiod_sb->sb_trans_needs_read = 0;
533 sb_tls_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
539 assert( sbiod != NULL );
540 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
542 p = (struct tls_data *)sbiod->sbiod_pvt;
544 ret = SSL_write( p->ssl, (char *)buf, len );
546 errno = WSAGetLastError();
548 err = SSL_get_error( p->ssl, ret );
549 if (err == SSL_ERROR_WANT_WRITE ) {
550 sbiod->sbiod_sb->sb_trans_needs_write = 1;
554 sbiod->sbiod_sb->sb_trans_needs_write = 0;
559 static Sockbuf_IO sb_tls_sbio =
561 sb_tls_setup, /* sbi_setup */
562 sb_tls_remove, /* sbi_remove */
563 sb_tls_ctrl, /* sbi_ctrl */
564 sb_tls_read, /* sbi_read */
565 sb_tls_write, /* sbi_write */
566 sb_tls_close /* sbi_close */
570 sb_tls_bio_create( BIO *b ) {
579 sb_tls_bio_destroy( BIO *b )
581 if ( b == NULL ) return 0;
583 b->ptr = NULL; /* sb_tls_remove() will free it */
590 sb_tls_bio_read( BIO *b, char *buf, int len )
595 if ( buf == NULL || len <= 0 ) return 0;
597 p = (struct tls_data *)b->ptr;
599 if ( p == NULL || p->sbiod == NULL ) {
603 ret = LBER_SBIOD_READ_NEXT( p->sbiod, buf, len );
605 BIO_clear_retry_flags( b );
608 if ( err == EAGAIN || err == EWOULDBLOCK ) {
609 BIO_set_retry_read( b );
617 sb_tls_bio_write( BIO *b, const char *buf, int len )
622 if ( buf == NULL || len <= 0 ) return 0;
624 p = (struct tls_data *)b->ptr;
626 if ( p == NULL || p->sbiod == NULL ) {
630 ret = LBER_SBIOD_WRITE_NEXT( p->sbiod, (char *)buf, len );
632 BIO_clear_retry_flags( b );
635 if ( err == EAGAIN || err == EWOULDBLOCK ) {
636 BIO_set_retry_write( b );
644 sb_tls_bio_ctrl( BIO *b, int cmd, long num, void *ptr )
646 if ( cmd == BIO_CTRL_FLUSH ) {
647 /* The OpenSSL library needs this */
654 sb_tls_bio_gets( BIO *b, char *buf, int len )
660 sb_tls_bio_puts( BIO *b, const char *str )
662 return sb_tls_bio_write( b, str, strlen( str ) );
665 static BIO_METHOD sb_tls_bio_method =
667 ( 100 | 0x400 ), /* it's a source/sink BIO */
679 * Call this to do a TLS connect on a sockbuf. ctx_arg can be
680 * a SSL_CTX * or NULL, in which case the default ctx is used.
684 * 0 - Success. Connection is ready for communication.
685 * <0 - Error. Can't create a TLS stream.
686 * >0 - Partial success.
687 * Do a select (using information from lber_pvt_sb_needs_{read,write}
692 ldap_int_tls_connect( LDAP *ld, LDAPConn *conn )
694 Sockbuf *sb = conn->lconn_sb;
698 if ( HAS_TLS( sb ) ) {
699 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
702 void *ctx = ld->ld_defconn
703 ? ld->ld_defconn->lconn_tls_ctx : NULL;
705 ssl = alloc_handle( ctx );
707 if ( ssl == NULL ) return -1;
710 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
711 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
713 ber_sockbuf_add_io( sb, &sb_tls_sbio,
714 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
717 conn->lconn_tls_ctx = tls_def_ctx;
721 err = SSL_connect( ssl );
724 errno = WSAGetLastError();
728 if ( update_flags( sb, ssl, err )) {
732 if ((err = ERR_peek_error())) {
734 ld->ld_error = LDAP_STRDUP(ERR_error_string(err, buf));
736 if ( ld->ld_error ) __etoa(ld->ld_error);
740 Debug( LDAP_DEBUG_ANY,"TLS: can't connect.\n",0,0,0);
742 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
743 LBER_SBIOD_LEVEL_TRANSPORT );
745 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
746 LBER_SBIOD_LEVEL_TRANSPORT );
755 * Call this to do a TLS accept on a sockbuf.
756 * Everything else is the same as with tls_connect.
759 ldap_pvt_tls_accept( Sockbuf *sb, void *ctx_arg )
764 if ( HAS_TLS( sb ) ) {
765 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
768 ssl = alloc_handle( ctx_arg );
769 if ( ssl == NULL ) return -1;
772 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
773 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
775 ber_sockbuf_add_io( sb, &sb_tls_sbio,
776 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
779 err = SSL_accept( ssl );
782 errno = WSAGetLastError();
785 if ( update_flags( sb, ssl, err )) return 1;
787 Debug( LDAP_DEBUG_ANY,"TLS: can't accept.\n",0,0,0 );
790 ber_sockbuf_remove_io( sb, &sb_tls_sbio,
791 LBER_SBIOD_LEVEL_TRANSPORT );
793 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
794 LBER_SBIOD_LEVEL_TRANSPORT );
803 ldap_pvt_tls_inplace ( Sockbuf *sb )
805 return HAS_TLS( sb ) ? 1 : 0;
809 tls_get_cert( SSL *s )
811 /* If peer cert was bad, treat as if no cert was given */
812 if (SSL_get_verify_result(s)) {
813 /* If we can send an alert, do so */
814 if (SSL_version(s) != SSL2_VERSION) {
815 ssl3_send_alert(s,SSL3_AL_WARNING,SSL3_AD_BAD_CERTIFICATE);
819 return SSL_get_peer_certificate(s);
823 ldap_pvt_tls_get_peer_dn( void *s, struct berval *dn,
824 LDAPDN_rewrite_dummy *func, unsigned flags )
830 x = tls_get_cert((SSL *)s);
832 if (!x) return LDAP_INVALID_CREDENTIALS;
834 xn = X509_get_subject_name(x);
835 rc = ldap_X509dn2bv(xn, dn, (LDAPDN_rewrite_func *)func, flags);
841 ldap_pvt_tls_get_peer_hostname( void *s )
848 x = tls_get_cert((SSL *)s);
851 xn = X509_get_subject_name(x);
853 ret = X509_NAME_get_text_by_NID(xn, NID_commonName, buf, sizeof(buf));
859 p = LDAP_STRDUP(buf);
864 /* what kind of hostname were we given? */
870 ldap_pvt_tls_check_hostname( LDAP *ld, void *s, const char *name_in )
872 int i, ret = LDAP_LOCAL_ERROR;
878 struct in6_addr addr;
883 if( ldap_int_hostname &&
884 ( !name_in || !strcasecmp( name_in, "localhost" ) ) )
886 name = ldap_int_hostname;
891 x = tls_get_cert((SSL *)s);
893 Debug( LDAP_DEBUG_ANY,
894 "TLS: unable to get peer certificate.\n",
896 /* If this was a fatal condition, things would have
897 * aborted long before now.
903 if (name[0] == '[' && strchr(name, ']')) {
904 char *n2 = ldap_strdup(name+1);
905 *strchr(n2, ']') = 2;
906 if (inet_pton(AF_INET6, n2, &addr))
911 if ((ptr = strrchr(name, '.')) && isdigit((unsigned char)ptr[1])) {
912 if (inet_aton(name, (struct in_addr *)&addr)) ntype = IS_IP4;
915 i = X509_get_ext_by_NID(x, NID_subject_alt_name, -1);
918 STACK_OF(GENERAL_NAME) *alt;
920 ex = X509_get_ext(x, i);
921 alt = X509V3_EXT_d2i(ex);
923 int n, len1 = 0, len2 = 0;
927 if (ntype == IS_DNS) {
929 domain = strchr(name, '.');
931 len2 = len1 - (domain-name);
934 n = sk_GENERAL_NAME_num(alt);
935 for (i=0; i<n; i++) {
938 gn = sk_GENERAL_NAME_value(alt, i);
939 if (gn->type == GEN_DNS) {
940 if (ntype != IS_DNS) continue;
942 sn = (char *) ASN1_STRING_data(gn->d.ia5);
943 sl = ASN1_STRING_length(gn->d.ia5);
946 if (sl == 0) continue;
948 /* Is this an exact match? */
949 if ((len1 == sl) && !strncasecmp(name, sn, len1)) {
953 /* Is this a wildcard match? */
954 if (domain && (sn[0] == '*') && (sn[1] == '.') &&
955 (len2 == sl-1) && !strncasecmp(domain, &sn[1], len2))
960 } else if (gn->type == GEN_IPADD) {
961 if (ntype == IS_DNS) continue;
963 sn = (char *) ASN1_STRING_data(gn->d.ia5);
964 sl = ASN1_STRING_length(gn->d.ia5);
967 if (ntype == IS_IP6 && sl != sizeof(struct in6_addr)) {
971 if (ntype == IS_IP4 && sl != sizeof(struct in_addr)) {
974 if (!memcmp(sn, &addr, sl)) {
980 GENERAL_NAMES_free(alt);
981 if (i < n) { /* Found a match */
987 if (ret != LDAP_SUCCESS) {
992 xn = X509_get_subject_name(x);
993 if( X509_NAME_get_text_by_NID( xn, NID_commonName,
994 buf, sizeof(buf)) == -1)
996 Debug( LDAP_DEBUG_ANY,
997 "TLS: unable to get common name from peer certificate.\n",
999 ret = LDAP_CONNECT_ERROR;
1000 ld->ld_error = LDAP_STRDUP(
1001 _("TLS: unable to get CN from peer certificate"));
1003 } else if (strcasecmp(name, buf) == 0 ) {
1006 } else if (( buf[0] == '*' ) && ( buf[1] == '.' )) {
1007 char *domain = strchr(name, '.');
1013 dlen = sl - (domain-name);
1016 /* Is this a wildcard match? */
1017 if ((dlen == sl-1) && !strncasecmp(domain, &buf[1], dlen)) {
1023 if( ret == LDAP_LOCAL_ERROR ) {
1024 Debug( LDAP_DEBUG_ANY, "TLS: hostname (%s) does not match "
1025 "common name in certificate (%s).\n",
1027 ret = LDAP_CONNECT_ERROR;
1028 ld->ld_error = LDAP_STRDUP(
1029 _("TLS: hostname does not match CN in peer certificate"));
1037 ldap_pvt_tls_get_peer_issuer( void *s )
1039 #if 0 /* currently unused; see ldap_pvt_tls_get_peer_dn() if needed */
1044 x = SSL_get_peer_certificate((SSL *)s);
1046 if (!x) return NULL;
1048 xn = X509_get_issuer_name(x);
1049 p = LDAP_STRDUP(X509_NAME_oneline(xn, buf, sizeof(buf)));
1058 ldap_int_tls_config( LDAP *ld, int option, const char *arg )
1063 case LDAP_OPT_X_TLS_CACERTFILE:
1064 case LDAP_OPT_X_TLS_CACERTDIR:
1065 case LDAP_OPT_X_TLS_CERTFILE:
1066 case LDAP_OPT_X_TLS_KEYFILE:
1067 case LDAP_OPT_X_TLS_RANDOM_FILE:
1068 return ldap_pvt_tls_set_option( ld, option, (void *) arg );
1070 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1071 case LDAP_OPT_X_TLS:
1073 if ( strcasecmp( arg, "never" ) == 0 ) {
1074 i = LDAP_OPT_X_TLS_NEVER ;
1076 } else if ( strcasecmp( arg, "demand" ) == 0 ) {
1077 i = LDAP_OPT_X_TLS_DEMAND ;
1079 } else if ( strcasecmp( arg, "allow" ) == 0 ) {
1080 i = LDAP_OPT_X_TLS_ALLOW ;
1082 } else if ( strcasecmp( arg, "try" ) == 0 ) {
1083 i = LDAP_OPT_X_TLS_TRY ;
1085 } else if ( ( strcasecmp( arg, "hard" ) == 0 ) ||
1086 ( strcasecmp( arg, "on" ) == 0 ) ||
1087 ( strcasecmp( arg, "yes" ) == 0) ||
1088 ( strcasecmp( arg, "true" ) == 0 ) )
1090 i = LDAP_OPT_X_TLS_HARD ;
1094 return ldap_pvt_tls_set_option( ld, option, &i );
1103 ldap_pvt_tls_get_option( LDAP *ld, int option, void *arg )
1105 struct ldapoptions *lo;
1108 assert( LDAP_VALID( ld ) );
1110 if( !LDAP_VALID( ld ) ) {
1111 return LDAP_OPT_ERROR;
1114 lo = &ld->ld_options;
1117 /* Get pointer to global option structure */
1118 lo = LDAP_INT_GLOBAL_OPT();
1120 return LDAP_NO_MEMORY;
1125 case LDAP_OPT_X_TLS:
1126 *(int *)arg = lo->ldo_tls_mode;
1128 case LDAP_OPT_X_TLS_CTX:
1130 *(void **)arg = (void *) tls_def_ctx;
1132 *(void **)arg = ld->ld_defconn->lconn_tls_ctx;
1135 case LDAP_OPT_X_TLS_CACERTFILE:
1136 *(char **)arg = tls_opt_cacertfile ?
1137 LDAP_STRDUP( tls_opt_cacertfile ) : NULL;
1139 case LDAP_OPT_X_TLS_CACERTDIR:
1140 *(char **)arg = tls_opt_cacertdir ?
1141 LDAP_STRDUP( tls_opt_cacertdir ) : NULL;
1143 case LDAP_OPT_X_TLS_CERTFILE:
1144 *(char **)arg = tls_opt_certfile ?
1145 LDAP_STRDUP( tls_opt_certfile ) : NULL;
1147 case LDAP_OPT_X_TLS_KEYFILE:
1148 *(char **)arg = tls_opt_keyfile ?
1149 LDAP_STRDUP( tls_opt_keyfile ) : NULL;
1151 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1152 *(int *)arg = tls_opt_require_cert;
1154 case LDAP_OPT_X_TLS_RANDOM_FILE:
1155 *(char **)arg = tls_opt_randfile ?
1156 LDAP_STRDUP( tls_opt_randfile ) : NULL;
1158 case LDAP_OPT_X_TLS_SSL_CTX: {
1161 LDAPConn *conn = ld->ld_defconn;
1162 if ( conn != NULL ) {
1163 Sockbuf *sb = conn->lconn_sb;
1164 retval = ldap_pvt_tls_sb_ctx( sb );
1167 *(void **)arg = retval;
1177 ldap_pvt_tls_set_option( LDAP *ld, int option, void *arg )
1179 struct ldapoptions *lo;
1182 assert( LDAP_VALID( ld ) );
1184 if( !LDAP_VALID( ld ) ) {
1185 return LDAP_OPT_ERROR;
1188 lo = &ld->ld_options;
1191 /* Get pointer to global option structure */
1192 lo = LDAP_INT_GLOBAL_OPT();
1194 return LDAP_NO_MEMORY;
1199 case LDAP_OPT_X_TLS:
1200 switch( *(int *) arg ) {
1201 case LDAP_OPT_X_TLS_NEVER:
1202 case LDAP_OPT_X_TLS_DEMAND:
1203 case LDAP_OPT_X_TLS_ALLOW:
1204 case LDAP_OPT_X_TLS_TRY:
1205 case LDAP_OPT_X_TLS_HARD:
1207 lo->ldo_tls_mode = *(int *)arg;
1214 case LDAP_OPT_X_TLS_CTX:
1216 tls_def_ctx = (SSL_CTX *) arg;
1219 ld->ld_defconn->lconn_tls_ctx = arg;
1229 case LDAP_OPT_X_TLS_CACERTFILE:
1230 if ( tls_opt_cacertfile ) LDAP_FREE( tls_opt_cacertfile );
1231 tls_opt_cacertfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1233 case LDAP_OPT_X_TLS_CACERTDIR:
1234 if ( tls_opt_cacertdir ) LDAP_FREE( tls_opt_cacertdir );
1235 tls_opt_cacertdir = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1237 case LDAP_OPT_X_TLS_CERTFILE:
1238 if ( tls_opt_certfile ) LDAP_FREE( tls_opt_certfile );
1239 tls_opt_certfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1241 case LDAP_OPT_X_TLS_KEYFILE:
1242 if ( tls_opt_keyfile ) LDAP_FREE( tls_opt_keyfile );
1243 tls_opt_keyfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1245 case LDAP_OPT_X_TLS_REQUIRE_CERT:
1246 switch( *(int *) arg ) {
1247 case LDAP_OPT_X_TLS_NEVER:
1248 case LDAP_OPT_X_TLS_DEMAND:
1249 case LDAP_OPT_X_TLS_ALLOW:
1250 case LDAP_OPT_X_TLS_TRY:
1251 case LDAP_OPT_X_TLS_HARD:
1252 tls_opt_require_cert = * (int *) arg;
1256 case LDAP_OPT_X_TLS_CIPHER_SUITE:
1257 if ( tls_opt_ciphersuite ) LDAP_FREE( tls_opt_ciphersuite );
1258 tls_opt_ciphersuite = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1260 case LDAP_OPT_X_TLS_RANDOM_FILE:
1261 if (tls_opt_randfile ) LDAP_FREE (tls_opt_randfile );
1262 tls_opt_randfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
1271 ldap_int_tls_start ( LDAP *ld, LDAPConn *conn, LDAPURLDesc *srv )
1273 Sockbuf *sb = conn->lconn_sb;
1278 host = srv->lud_host;
1280 host = conn->lconn_server->lud_host;
1283 /* avoid NULL host */
1284 if( host == NULL ) {
1288 (void) ldap_pvt_tls_init();
1291 * Fortunately, the lib uses blocking io...
1293 if ( ldap_int_tls_connect( ld, conn ) < 0 ) {
1294 ld->ld_errno = LDAP_CONNECT_ERROR;
1295 return (ld->ld_errno);
1298 ssl = ldap_pvt_tls_sb_ctx( sb );
1299 assert( ssl != NULL );
1302 * compare host with name(s) in certificate
1304 if (tls_opt_require_cert != LDAP_OPT_X_TLS_NEVER) {
1305 ld->ld_errno = ldap_pvt_tls_check_hostname( ld, ssl, host );
1306 if (ld->ld_errno != LDAP_SUCCESS) {
1307 return ld->ld_errno;
1311 return LDAP_SUCCESS;
1314 /* Derived from openssl/apps/s_cb.c */
1316 tls_info_cb( const SSL *ssl, int where, int ret )
1320 char *state = (char *) SSL_state_string_long( (SSL *)ssl );
1322 w = where & ~SSL_ST_MASK;
1323 if ( w & SSL_ST_CONNECT ) {
1325 } else if ( w & SSL_ST_ACCEPT ) {
1333 state = LDAP_STRDUP( state );
1337 if ( where & SSL_CB_LOOP ) {
1338 Debug( LDAP_DEBUG_TRACE,
1339 "TLS trace: %s:%s\n",
1342 } else if ( where & SSL_CB_ALERT ) {
1343 char *atype = (char *) SSL_alert_type_string_long( ret );
1344 char *adesc = (char *) SSL_alert_desc_string_long( ret );
1345 op = ( where & SSL_CB_READ ) ? "read" : "write";
1348 atype = LDAP_STRDUP( atype );
1352 adesc = LDAP_STRDUP( adesc );
1356 Debug( LDAP_DEBUG_TRACE,
1357 "TLS trace: SSL3 alert %s:%s:%s\n",
1360 if ( atype ) LDAP_FREE( atype );
1361 if ( adesc ) LDAP_FREE( adesc );
1363 } else if ( where & SSL_CB_EXIT ) {
1365 Debug( LDAP_DEBUG_TRACE,
1366 "TLS trace: %s:failed in %s\n",
1368 } else if ( ret < 0 ) {
1369 Debug( LDAP_DEBUG_TRACE,
1370 "TLS trace: %s:error in %s\n",
1375 if ( state ) LDAP_FREE( state );
1380 tls_verify_cb( int ok, X509_STORE_CTX *ctx )
1389 char *certerr = NULL;
1391 cert = X509_STORE_CTX_get_current_cert( ctx );
1392 errnum = X509_STORE_CTX_get_error( ctx );
1393 errdepth = X509_STORE_CTX_get_error_depth( ctx );
1396 * X509_get_*_name return pointers to the internal copies of
1397 * those things requested. So do not free them.
1399 subject = X509_get_subject_name( cert );
1400 issuer = X509_get_issuer_name( cert );
1401 /* X509_NAME_oneline, if passed a NULL buf, allocate memomry */
1402 sname = X509_NAME_oneline( subject, NULL, 0 );
1403 iname = X509_NAME_oneline( issuer, NULL, 0 );
1404 if ( !ok ) certerr = (char *)X509_verify_cert_error_string( errnum );
1406 if ( sname ) __etoa( sname );
1407 if ( iname ) __etoa( iname );
1409 certerr = LDAP_STRDUP( certerr );
1413 Debug( LDAP_DEBUG_TRACE,
1414 "TLS certificate verification: depth: %d, err: %d, subject: %s,",
1416 sname ? sname : "-unknown-" );
1417 Debug( LDAP_DEBUG_TRACE, " issuer: %s\n", iname ? iname : "-unknown-", 0, 0 );
1419 Debug( LDAP_DEBUG_ANY,
1420 "TLS certificate verification: Error, %s\n",
1424 CRYPTO_free ( sname );
1426 CRYPTO_free ( iname );
1428 if ( certerr ) LDAP_FREE( certerr );
1434 tls_verify_ok( int ok, X509_STORE_CTX *ctx )
1436 (void) tls_verify_cb( ok, ctx );
1440 /* Inspired by ERR_print_errors in OpenSSL */
1442 tls_report_error( void )
1449 while ( ( l = ERR_get_error_line( &file, &line ) ) != 0 ) {
1450 ERR_error_string_n( l, buf, sizeof( buf ) );
1453 file = LDAP_STRDUP( file );
1454 __etoa( (char *)file );
1458 Debug( LDAP_DEBUG_ANY, "TLS: %s %s:%d\n",
1461 if ( file ) LDAP_FREE( (void *)file );
1467 tls_tmp_rsa_cb( SSL *ssl, int is_export, int key_length )
1471 /* FIXME: Pregenerate the key on startup */
1472 /* FIXME: Who frees the key? */
1473 tmp_rsa = RSA_generate_key( key_length, RSA_F4, NULL, NULL );
1476 Debug( LDAP_DEBUG_ANY,
1477 "TLS: Failed to generate temporary %d-bit %s RSA key\n",
1478 key_length, is_export ? "export" : "domestic", 0 );
1485 tls_seed_PRNG( const char *randfile )
1487 #ifndef URANDOM_DEVICE
1488 /* no /dev/urandom (or equiv) */
1490 char buffer[MAXPATHLEN];
1492 if (randfile == NULL) {
1493 /* The seed file is $RANDFILE if defined, otherwise $HOME/.rnd.
1494 * If $HOME is not set or buffer too small to hold the pathname,
1495 * an error occurs. - From RAND_file_name() man page.
1496 * The fact is that when $HOME is NULL, .rnd is used.
1498 randfile = RAND_file_name( buffer, sizeof( buffer ) );
1500 } else if (RAND_egd(randfile) > 0) {
1505 if (randfile == NULL) {
1506 Debug( LDAP_DEBUG_ANY,
1507 "TLS: Use configuration file or $RANDFILE to define seed PRNG\n",
1512 total = RAND_load_file(randfile, -1);
1514 if (RAND_status() == 0) {
1515 Debug( LDAP_DEBUG_ANY,
1516 "TLS: PRNG not been seeded with enough data\n",
1521 /* assume if there was enough bits to seed that it's okay
1522 * to write derived bits to the file
1524 RAND_write_file(randfile);
1533 tls_tmp_dh_cb( SSL *ssl, int is_export, int key_length )
1541 ldap_pvt_tls_sb_ctx( Sockbuf *sb )
1546 if (HAS_TLS( sb )) {
1547 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&p );
1556 ldap_pvt_tls_get_strength( void *s )
1561 c = SSL_get_current_cipher((SSL *)s);
1562 return SSL_CIPHER_get_bits(c, NULL);
1570 ldap_pvt_tls_get_my_dn( void *s, struct berval *dn, LDAPDN_rewrite_dummy *func, unsigned flags )
1577 x = SSL_get_certificate((SSL *)s);
1579 if (!x) return LDAP_INVALID_CREDENTIALS;
1581 xn = X509_get_subject_name(x);
1582 rc = ldap_X509dn2bv(xn, dn, (LDAPDN_rewrite_func *)func, flags );
1585 return LDAP_NOT_SUPPORTED;
1590 ldap_start_tls_s ( LDAP *ld,
1591 LDAPControl **serverctrls,
1592 LDAPControl **clientctrls )
1597 char *rspoid = NULL;
1598 struct berval *rspdata = NULL;
1600 /* XXYYZ: this initiates operation only on default connection! */
1602 if ( ld->ld_sb != NULL && ldap_pvt_tls_inplace( ld->ld_sb ) != 0 ) {
1603 return LDAP_LOCAL_ERROR;
1606 rc = ldap_extended_operation_s( ld, LDAP_EXOP_START_TLS,
1607 NULL, serverctrls, clientctrls, &rspoid, &rspdata );
1609 if ( rspoid != NULL ) {
1613 if ( rspdata != NULL ) {
1614 ber_bvfree( rspdata );
1617 if ( rc == LDAP_SUCCESS ) {
1618 rc = ldap_int_tls_start( ld, ld->ld_defconn, NULL );
1622 rc = LDAP_NOT_SUPPORTED;