3 * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
6 * tls.c - Handle tls/ssl using SSLeay or OpenSSL.
15 #include <ac/stdlib.h>
17 #include <ac/socket.h>
18 #include <ac/string.h>
20 #include <ac/unistd.h>
25 #include <ldap_pvt_thread.h>
28 #ifdef HAVE_OPENSSL_SSL_H
29 #include <openssl/ssl.h>
30 #include <openssl/x509v3.h>
31 #include <openssl/err.h>
32 #elif defined( HAVE_SSL_H )
36 static int tls_opt_trace = 1;
37 static char *tls_opt_certfile = NULL;
38 static char *tls_opt_keyfile = NULL;
39 static char *tls_opt_cacertfile = NULL;
40 static char *tls_opt_cacertdir = NULL;
41 static int tls_opt_require_cert = 0;
42 static char *tls_opt_ciphersuite = NULL;
44 #define HAS_TLS( sb ) ((sb)->sb_io==&tls_io)
46 static int tls_setup( Sockbuf *sb, void *arg );
47 static int tls_remove( Sockbuf *sb );
48 static ber_slen_t tls_read( Sockbuf *sb, void *buf, ber_len_t len );
49 static ber_slen_t tls_write( Sockbuf *sb, void *buf, ber_len_t len );
50 static int tls_close( Sockbuf *sb );
51 static void tls_report_error( void );
53 static Sockbuf_IO tls_io=
62 static void tls_info_cb( SSL *ssl, int where, int ret );
63 static int tls_verify_cb( int ok, X509_STORE_CTX *ctx );
64 static RSA * tls_tmp_rsa_cb( SSL *ssl, int is_export, int key_length );
65 static STACK_OF(X509_NAME) * get_ca_list( char * bundle, char * dir );
67 #if 0 /* Currently this is not used by anyone */
68 static DH * tls_tmp_dh_cb( SSL *ssl, int is_export, int key_length );
71 static SSL_CTX *tls_def_ctx = NULL;
75 * provide mutexes for the SSLeay library.
77 static ldap_pvt_thread_mutex_t tls_mutexes[CRYPTO_NUM_LOCKS];
79 static void tls_locking_cb( int mode, int type, const char *file, int line )
81 if ( mode & CRYPTO_LOCK ) {
82 ldap_pvt_thread_mutex_lock( tls_mutexes+type );
84 ldap_pvt_thread_mutex_unlock( tls_mutexes+type );
89 * an extra mutex for the default ctx.
92 static ldap_pvt_thread_mutex_t tls_def_ctx_mutex;
94 static void tls_init_threads( void )
98 for( i=0; i< CRYPTO_NUM_LOCKS ; i++ ) {
99 ldap_pvt_thread_mutex_init( tls_mutexes+i );
101 CRYPTO_set_locking_callback( tls_locking_cb );
102 /* FIXME: the thread id should be added somehow... */
104 ldap_pvt_thread_mutex_init( &tls_def_ctx_mutex );
106 #endif /* LDAP_R_COMPILE */
109 * Initialize tls system. Should be called only once.
112 ldap_pvt_tls_init( void )
114 static int tls_initialized = 0;
116 if ( tls_initialized )
119 #ifdef LDAP_R_COMPILE
122 SSL_load_error_strings();
123 SSLeay_add_ssl_algorithms();
124 /* FIXME: mod_ssl does this */
125 X509V3_add_standard_extensions();
130 * initialize the default context
133 ldap_pvt_tls_init_def_ctx( void )
135 STACK_OF(X509_NAME) *calist;
137 #ifdef LDAP_R_COMPILE
138 ldap_pvt_thread_mutex_lock( &tls_def_ctx_mutex );
140 if ( tls_def_ctx == NULL ) {
141 tls_def_ctx = SSL_CTX_new( SSLv23_method() );
142 if ( tls_def_ctx == NULL ) {
143 Debug( LDAP_DEBUG_ANY,
144 "TLS: could not allocate default ctx.\n",0,0,0);
147 if ( tls_opt_ciphersuite &&
148 !SSL_CTX_set_cipher_list( tls_def_ctx,
149 tls_opt_ciphersuite ) ) {
150 Debug( LDAP_DEBUG_ANY,
151 "TLS: could not set cipher list %s.\n",
152 tls_opt_ciphersuite, 0, 0 );
156 if (tls_opt_cacertfile != NULL || tls_opt_cacertdir != NULL) {
157 if ( !SSL_CTX_load_verify_locations( tls_def_ctx,
160 || !SSL_CTX_set_default_verify_paths( tls_def_ctx ) )
162 Debug( LDAP_DEBUG_ANY,
163 "TLS: could not load verify locations (file:`%s',dir:`%s').\n",
164 tls_opt_cacertfile,tls_opt_cacertdir,0);
168 calist = get_ca_list( tls_opt_cacertfile, tls_opt_cacertdir );
170 Debug( LDAP_DEBUG_ANY,
171 "TLS: could not load client CA list (file:`%s',dir:`%s').\n",
172 tls_opt_cacertfile,tls_opt_cacertdir,0);
176 SSL_CTX_set_client_CA_list( tls_def_ctx, calist );
178 if ( tls_opt_keyfile &&
179 !SSL_CTX_use_PrivateKey_file( tls_def_ctx,
181 SSL_FILETYPE_PEM ) ) {
182 Debug( LDAP_DEBUG_ANY,
183 "TLS: could not use key file `%s'.\n",
184 tls_opt_keyfile,0,0);
188 if ( tls_opt_certfile &&
189 !SSL_CTX_use_certificate_file( tls_def_ctx,
191 SSL_FILETYPE_PEM ) ) {
192 Debug( LDAP_DEBUG_ANY,
193 "TLS: could not use certificate `%s'.\n",
194 tls_opt_certfile,0,0);
198 if ( ( tls_opt_certfile || tls_opt_keyfile ) &&
199 !SSL_CTX_check_private_key( tls_def_ctx ) ) {
200 Debug( LDAP_DEBUG_ANY,
201 "TLS: private key mismatch.\n",
206 if ( tls_opt_trace ) {
207 SSL_CTX_set_info_callback( tls_def_ctx, tls_info_cb );
209 SSL_CTX_set_verify( tls_def_ctx, (tls_opt_require_cert) ?
210 (SSL_VERIFY_PEER|SSL_VERIFY_FAIL_IF_NO_PEER_CERT) :
211 SSL_VERIFY_PEER, tls_verify_cb );
212 SSL_CTX_set_tmp_rsa_callback( tls_def_ctx, tls_tmp_rsa_cb );
213 /* SSL_CTX_set_tmp_dh_callback( tls_def_ctx, tls_tmp_dh_cb ); */
215 #ifdef LDAP_R_COMPILE
216 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
220 if ( tls_def_ctx != NULL ) {
221 SSL_CTX_free( tls_def_ctx );
224 #ifdef LDAP_R_COMPILE
225 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
230 static STACK_OF(X509_NAME) *
231 get_ca_list( char * bundle, char * dir )
233 STACK_OF(X509_NAME) *ca_list = NULL;
236 ca_list = SSL_load_client_CA_file( bundle );
239 * FIXME: We have now to go over all files in dir, load them
240 * and add every certificate there to ca_list.
246 alloc_handle( Sockbuf *sb, void *ctx_arg )
253 ctx = (SSL_CTX *) ctx_arg;
255 if ( ldap_pvt_tls_init_def_ctx() < 0 )
260 ssl = SSL_new( ctx );
262 Debug( LDAP_DEBUG_ANY,"TLS: can't create ssl handle.\n",0,0,0);
266 if ( tls_opt_trace ) {
267 SSL_set_info_callback( ssl, tls_info_cb );
270 SSL_set_fd( ssl, ber_pvt_sb_get_desc( sb ) );
275 update_flags( Sockbuf *sb, SSL * ssl, int rc )
277 int err = SSL_get_error(ssl, rc);
279 sb->sb_trans_needs_read = 0;
280 sb->sb_trans_needs_write = 0;
281 if (err == SSL_ERROR_WANT_READ)
283 sb->sb_trans_needs_read = 1;
285 } else if (err == SSL_ERROR_WANT_WRITE)
287 sb->sb_trans_needs_write = 1;
289 } else if (err == SSL_ERROR_WANT_CONNECT)
297 * Call this to do a TLS connect on a sockbuf. ctx_arg can be
298 * a SSL_CTX * or NULL, in which case the default ctx is used.
302 * 0 - Success. Connection is ready for communication.
303 * <0 - Error. Can't create a TLS stream.
304 * >0 - Partial success.
305 * Do a select (using information from lber_pvt_sb_needs_{read,write}
310 ldap_pvt_tls_connect( LDAP *ld, Sockbuf *sb, void *ctx_arg )
315 if ( HAS_TLS( sb ) ) {
316 ssl = (SSL *) sb->sb_iodata;
318 ssl = alloc_handle( sb, ctx_arg );
321 ber_pvt_sb_clear_io( sb );
322 ber_pvt_sb_set_io( sb, &tls_io, (void *)ssl );
325 err = SSL_connect( ssl );
328 errno = WSAGetLastError();
331 if ( update_flags( sb, ssl, err ))
333 if ((err = ERR_peek_error())) {
335 ld->ld_error = ldap_strdup(ERR_error_string(err, buf));
337 Debug( LDAP_DEBUG_ANY,"TLS: can't connect.\n",0,0,0);
338 ber_pvt_sb_clear_io( sb );
339 ber_pvt_sb_set_io( sb, &ber_pvt_sb_io_tcp, NULL );
346 * Call this to do a TLS accept on a sockbuf.
347 * Everything else is the same as with tls_connect.
350 ldap_pvt_tls_accept( Sockbuf *sb, void *ctx_arg )
355 if ( HAS_TLS( sb ) ) {
356 ssl = (SSL *) sb->sb_iodata;
358 ssl = alloc_handle( sb, ctx_arg );
361 ber_pvt_sb_clear_io( sb );
362 ber_pvt_sb_set_io( sb, &tls_io, (void *)ssl );
365 err = SSL_accept( ssl );
368 errno = WSAGetLastError();
371 if ( update_flags( sb, ssl, err ))
373 Debug( LDAP_DEBUG_ANY,"TLS: can't accept.\n",0,0,0 );
375 ber_pvt_sb_clear_io( sb );
376 ber_pvt_sb_set_io( sb, &ber_pvt_sb_io_tcp, NULL );
383 ldap_pvt_tls_inplace ( Sockbuf *sb )
391 ldap_pvt_tls_sb_handle( Sockbuf *sb )
394 return sb->sb_iodata;
400 ldap_pvt_tls_get_handle( LDAP *ld )
402 return ldap_pvt_tls_sb_handle(&ld->ld_sb);
406 ldap_pvt_tls_get_peer( LDAP *ld )
412 ldap_pvt_tls_get_peer_issuer( LDAP *ld )
418 ldap_pvt_tls_config( struct ldapoptions *lo, int option, const char *arg )
423 case LDAP_OPT_X_TLS_CACERTFILE:
424 case LDAP_OPT_X_TLS_CACERTDIR:
425 case LDAP_OPT_X_TLS_CERTFILE:
426 case LDAP_OPT_X_TLS_KEYFILE:
427 return ldap_pvt_tls_set_option( NULL, option, (void *) arg );
428 case LDAP_OPT_X_TLS_REQUIRE_CERT:
429 i = ( ( strcasecmp( arg, "on" ) == 0 ) ||
430 ( strcasecmp( arg, "yes" ) == 0) ||
431 ( strcasecmp( arg, "true" ) == 0 ) );
432 return ldap_pvt_tls_set_option( NULL, option, (void *) &i );
435 if ( strcasecmp( arg, "never" ) == 0 )
436 i = LDAP_OPT_X_TLS_NEVER ;
437 if ( strcasecmp( arg, "demand" ) == 0 )
438 i = LDAP_OPT_X_TLS_DEMAND ;
439 if ( strcasecmp( arg, "allow" ) == 0 )
440 i = LDAP_OPT_X_TLS_ALLOW ;
441 if ( strcasecmp( arg, "try" ) == 0 )
442 i = LDAP_OPT_X_TLS_TRY ;
443 if ( strcasecmp( arg, "hard" ) == 0 )
444 i = LDAP_OPT_X_TLS_HARD ;
446 return ldap_pvt_tls_set_option( lo, option, &i );
454 ldap_pvt_tls_get_option( struct ldapoptions *lo, int option, void *arg )
458 *(int *)arg = lo->ldo_tls_mode;
460 case LDAP_OPT_X_TLS_CERT:
462 *(void **)arg = (void *) tls_def_ctx;
464 *(void **)arg = lo->ldo_tls_ctx;
466 case LDAP_OPT_X_TLS_CACERTFILE:
467 *(char **)arg = tls_opt_cacertfile ?
468 LDAP_STRDUP( tls_opt_cacertfile ) : NULL;
470 case LDAP_OPT_X_TLS_CACERTDIR:
471 *(char **)arg = tls_opt_cacertdir ?
472 LDAP_STRDUP( tls_opt_cacertdir ) : NULL;
474 case LDAP_OPT_X_TLS_CERTFILE:
475 *(char **)arg = tls_opt_certfile ?
476 LDAP_STRDUP( tls_opt_certfile ) : NULL;
478 case LDAP_OPT_X_TLS_KEYFILE:
479 *(char **)arg = tls_opt_keyfile ?
480 LDAP_STRDUP( tls_opt_keyfile ) : NULL;
482 case LDAP_OPT_X_TLS_REQUIRE_CERT:
483 *(int *)arg = tls_opt_require_cert;
492 ldap_pvt_tls_set_option( struct ldapoptions *lo, int option, void *arg )
496 switch( *(int *) arg ) {
497 case LDAP_OPT_X_TLS_NEVER:
498 case LDAP_OPT_X_TLS_DEMAND:
499 case LDAP_OPT_X_TLS_ALLOW:
500 case LDAP_OPT_X_TLS_TRY:
501 case LDAP_OPT_X_TLS_HARD:
503 lo->ldo_tls_mode = *(int *)arg;
510 case LDAP_OPT_X_TLS_CERT:
512 tls_def_ctx = (SSL_CTX *) arg;
515 lo->ldo_tls_ctx = arg;
525 case LDAP_OPT_X_TLS_CACERTFILE:
526 if ( tls_opt_cacertfile ) free( tls_opt_cacertfile );
527 tls_opt_cacertfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
529 case LDAP_OPT_X_TLS_CACERTDIR:
530 if ( tls_opt_cacertdir ) free( tls_opt_cacertdir );
531 tls_opt_cacertdir = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
533 case LDAP_OPT_X_TLS_CERTFILE:
534 if ( tls_opt_certfile ) free( tls_opt_certfile );
535 tls_opt_certfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
537 case LDAP_OPT_X_TLS_KEYFILE:
538 if ( tls_opt_keyfile ) free( tls_opt_keyfile );
539 tls_opt_keyfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
541 case LDAP_OPT_X_TLS_REQUIRE_CERT:
542 tls_opt_require_cert = * (int *) arg;
544 case LDAP_OPT_X_TLS_CIPHER_SUITE:
545 if ( tls_opt_ciphersuite ) free( tls_opt_ciphersuite );
546 tls_opt_ciphersuite = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
555 ldap_pvt_tls_start ( LDAP *ld, Sockbuf *sb, void *ctx_arg )
558 * Fortunately, the lib uses blocking io...
560 if ( ldap_pvt_tls_connect( ld, sb, ctx_arg ) < 0 ) {
561 return LDAP_CONNECT_ERROR;
564 /* FIXME: hostname of server must be compared with name in
573 tls_setup( Sockbuf *sb, void *arg )
580 tls_remove( Sockbuf *sb )
582 SSL_free( (SSL *) sb->sb_iodata );
587 tls_write( Sockbuf *sb, void *buf, ber_len_t sz )
589 int ret = SSL_write( (SSL *)sb->sb_iodata, buf, sz );
592 errno = WSAGetLastError();
594 update_flags(sb, (SSL *)sb->sb_iodata, ret );
596 if (sb->sb_trans_needs_write)
603 tls_read( Sockbuf *sb, void *buf, ber_len_t sz )
605 int ret = SSL_read( (SSL *)sb->sb_iodata, buf, sz );
608 errno = WSAGetLastError();
610 update_flags(sb, (SSL *)sb->sb_iodata, ret );
612 if (sb->sb_trans_needs_read)
619 tls_close( Sockbuf *sb )
621 tcp_close( ber_pvt_sb_get_desc( sb ) );
625 /* Derived from openssl/apps/s_cb.c */
627 tls_info_cb( SSL *ssl, int where, int ret )
632 w = where & ~SSL_ST_MASK;
633 if ( w & SSL_ST_CONNECT ) {
635 } else if ( w & SSL_ST_ACCEPT ) {
641 if ( where & SSL_CB_LOOP ) {
642 Debug( LDAP_DEBUG_TRACE,
643 "TLS trace: %s:%s\n",
644 op, SSL_state_string_long( ssl ), 0 );
645 } else if ( where & SSL_CB_ALERT ) {
646 op = ( where & SSL_CB_READ ) ? "read" : "write";
647 Debug( LDAP_DEBUG_TRACE,
648 "TLS trace: SSL3 alert %s:%s:%s\n",
650 SSL_alert_type_string_long( ret ),
651 SSL_alert_desc_string_long( ret) );
652 } else if ( where & SSL_CB_EXIT ) {
654 Debug( LDAP_DEBUG_TRACE,
655 "TLS trace: %s:failed in %s\n",
656 op, SSL_state_string_long( ssl ), 0 );
657 } else if ( ret < 0 ) {
658 Debug( LDAP_DEBUG_TRACE,
659 "TLS trace: %s:error in %s\n",
660 op, SSL_state_string_long( ssl ), 0 );
666 tls_verify_cb( int ok, X509_STORE_CTX *ctx )
676 cert = X509_STORE_CTX_get_current_cert( ctx );
677 errnum = X509_STORE_CTX_get_error( ctx );
678 errdepth = X509_STORE_CTX_get_error_depth( ctx );
681 * X509_get_*_name return pointers to the internal copies of
682 * those things requested. So do not free them.
684 subject = X509_get_subject_name( cert );
685 issuer = X509_get_issuer_name( cert );
686 /* X509_NAME_oneline, if passed a NULL buf, allocate memomry */
687 sname = X509_NAME_oneline( subject, NULL, 0 );
688 iname = X509_NAME_oneline( issuer, NULL, 0 );
689 Debug( LDAP_DEBUG_TRACE,
690 "TLS certificate verification: depth: %d, subject: %s, issuer: %s\n",
692 sname ? sname : "-unknown-",
693 iname ? iname : "-unknown-" );
695 CRYPTO_free ( sname );
697 CRYPTO_free ( iname );
702 /* Inspired by ERR_print_errors in OpenSSL */
704 tls_report_error( void )
711 while ( ( l = ERR_get_error_line( &file, &line ) ) != 0 ) {
712 Debug( LDAP_DEBUG_ANY, "TLS: %s %s:%d\n",
713 ERR_error_string( l, buf ), file, line );
718 tls_tmp_rsa_cb( SSL *ssl, int is_export, int key_length )
722 /* FIXME: Pregenerate the key on startup */
723 /* FIXME: Who frees the key? */
724 tmp_rsa = RSA_generate_key( key_length, RSA_F4, NULL, NULL );
727 Debug( LDAP_DEBUG_ANY, "TLS: Failed to generate temporary %d-bit %s RSA key\n",
728 key_length, is_export ? "export" : "domestic", 0 );
736 tls_tmp_dh_cb( SSL *ssl, int is_export, int key_length )