2 * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
3 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
5 * tls.c - Handle tls/ssl using SSLeay or OpenSSL.
16 #include <ac/socket.h>
17 #include <ac/string.h>
19 #include <ac/unistd.h>
24 #include <ldap_pvt_thread.h>
27 #ifdef HAVE_OPENSSL_SSL_H
28 #include <openssl/ssl.h>
29 #elif defined( HAVE_SSL_H )
33 static char *tls_opt_certfile = NULL;
34 static char *tls_opt_keyfile = NULL;
35 static char *tls_opt_cacertfile = NULL;
36 static char *tls_opt_cacertdir = NULL;
37 static int tls_opt_require_cert = 0;
39 #define HAS_TLS( sb ) ((sb)->sb_io==&tls_io)
41 static int tls_setup( Sockbuf *sb, void *arg );
42 static int tls_remove( Sockbuf *sb );
43 static ber_slen_t tls_read( Sockbuf *sb, void *buf, ber_len_t len );
44 static ber_slen_t tls_write( Sockbuf *sb, void *buf, ber_len_t len );
45 static int tls_close( Sockbuf *sb );
46 static int tls_report_error( void );
48 static Sockbuf_IO tls_io=
57 static int tls_verify_cb( int ok, X509_STORE_CTX *ctx );
59 static SSL_CTX *tls_def_ctx = NULL;
63 * provide mutexes for the SSLeay library.
65 static ldap_pvt_thread_mutex_t tls_mutexes[CRYPTO_NUM_LOCKS];
67 static void tls_locking_cb( int mode, int type, const char *file, int line )
69 if ( mode & CRYPTO_LOCK ) {
70 ldap_pvt_thread_mutex_lock( tls_mutexes+type );
72 ldap_pvt_thread_mutex_unlock( tls_mutexes+type );
77 * an extra mutex for the default ctx.
80 static ldap_pvt_thread_mutex_t tls_def_ctx_mutex;
82 static void tls_init_threads( void )
86 for( i=0; i< CRYPTO_NUM_LOCKS ; i++ ) {
87 ldap_pvt_thread_mutex_init( tls_mutexes+i );
89 CRYPTO_set_locking_callback( tls_locking_cb );
90 /* FIXME: the thread id should be added somehow... */
92 ldap_pvt_thread_mutex_init( &tls_def_ctx_mutex );
94 #endif /* LDAP_R_COMPILE */
97 * Initialize tls system. Should be called only once.
100 ldap_pvt_tls_init( void )
102 static int tls_initialized = 0;
104 if ( tls_initialized )
106 #ifdef LDAP_R_COMPILE
109 SSL_load_error_strings();
110 SSLeay_add_ssl_algorithms();
115 * initialize the default context
118 ldap_pvt_tls_init_def_ctx( void )
120 #ifdef LDAP_R_COMPILE
121 ldap_pvt_thread_mutex_lock( &tls_def_ctx_mutex );
123 if ( tls_def_ctx == NULL ) {
124 tls_def_ctx = SSL_CTX_new( SSLv23_method() );
125 if ( tls_def_ctx == NULL ) {
126 Debug( LDAP_DEBUG_ANY,
127 "TLS: could not allocate default ctx.\n",0,0,0);
130 if ( !SSL_CTX_set_cipher_list( tls_def_ctx,
131 "RC4+RSA:HIGH:MEDIUM:LOW:EXP:+SSLv2:+EXP" ) ) {
132 Debug( LDAP_DEBUG_ANY,
133 "TLS: could not set cipher list.\n", 0, 0 );
137 if ( !SSL_CTX_load_verify_locations( tls_def_ctx,
139 tls_opt_cacertdir ) ||
140 !SSL_CTX_set_default_verify_paths( tls_def_ctx ) ) {
141 Debug( LDAP_DEBUG_ANY,
142 "TLS: could not load verify locations (file:`%s',dir:`%s').\n",
143 tls_opt_cacertfile,tls_opt_cacertdir,0);
146 if ( tls_opt_keyfile &&
147 !SSL_CTX_use_PrivateKey_file( tls_def_ctx,
149 SSL_FILETYPE_PEM ) ) {
150 Debug( LDAP_DEBUG_ANY,
151 "TLS: could not use key file `%s'.\n",
152 tls_opt_keyfile,0,0);
155 if ( tls_opt_certfile &&
156 !SSL_CTX_use_certificate_file( tls_def_ctx,
158 SSL_FILETYPE_PEM ) ) {
159 Debug( LDAP_DEBUG_ANY,
160 "TLS: could not use certificate `%s'.\n",
161 tls_opt_certfile,0,0);
164 SSL_CTX_set_verify( tls_def_ctx, (tls_opt_require_cert) ?
165 (SSL_VERIFY_PEER|SSL_VERIFY_FAIL_IF_NO_PEER_CERT) :
166 SSL_VERIFY_PEER, tls_verify_cb );
168 #ifdef LDAP_R_COMPILE
169 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
173 #ifdef LDAP_R_COMPILE
174 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
180 alloc_handle( Sockbuf *sb, void *ctx_arg )
187 ctx = (SSL_CTX *) ctx_arg;
189 if ( ldap_pvt_tls_init_def_ctx() < 0 )
194 ssl = SSL_new( ctx );
196 Debug( LDAP_DEBUG_ANY,"TLS: can't create ssl handle.\n",0,0,0);
200 SSL_set_fd( ssl, ber_pvt_sb_get_desc( sb ) );
205 update_flags( Sockbuf *sb, SSL * ssl )
207 sb->sb_trans_needs_read = SSL_want_read(ssl) ? 1 : 0;
208 sb->sb_trans_needs_write = SSL_want_write(ssl) ? 1 : 0;
212 * Call this to do a TLS connect on a sockbuf. ctx_arg can be
213 * a SSL_CTX * or NULL, in which case the default ctx is used.
217 * 0 - Success. Connection is ready for communication.
218 * <0 - Error. Can't create a TLS stream.
219 * >0 - Partial success.
220 * Do a select (using information from lber_pvt_sb_needs_{read,write}
225 ldap_pvt_tls_connect( Sockbuf *sb, void *ctx_arg )
230 if ( HAS_TLS( sb ) ) {
231 ssl = (SSL *) sb->sb_iodata;
233 ssl = alloc_handle( sb, ctx_arg );
236 ber_pvt_sb_clear_io( sb );
237 ber_pvt_sb_set_io( sb, &tls_io, (void *)ssl );
240 err = SSL_connect( ssl );
245 (errno==EWOULDBLOCK) ||
251 update_flags( sb, ssl );
254 Debug( LDAP_DEBUG_ANY,"TLS: can't connect.\n",0,0,0);
255 ber_pvt_sb_clear_io( sb );
256 ber_pvt_sb_set_io( sb, &ber_pvt_sb_io_tcp, NULL );
263 * Call this to do a TLS accept on a sockbuf.
264 * Everything else is the same as with tls_connect.
267 ldap_pvt_tls_accept( Sockbuf *sb, void *ctx_arg )
272 if ( HAS_TLS( sb ) ) {
273 ssl = (SSL *) sb->sb_iodata;
275 ssl = alloc_handle( sb, ctx_arg );
278 ber_pvt_sb_clear_io( sb );
279 ber_pvt_sb_set_io( sb, &tls_io, (void *)ssl );
282 err = SSL_accept( ssl );
287 (errno==EWOULDBLOCK) ||
293 update_flags( sb, ssl );
296 Debug( LDAP_DEBUG_ANY,"TLS: can't accept.\n",0,0,0 );
298 ber_pvt_sb_clear_io( sb );
299 ber_pvt_sb_set_io( sb, &ber_pvt_sb_io_tcp, NULL );
306 ldap_pvt_tls_get_peer( LDAP *ld )
311 ldap_pvt_tls_get_peer_issuer( LDAP *ld )
316 ldap_pvt_tls_config( struct ldapoptions *lo, int option, const char *arg )
321 case LDAP_OPT_X_TLS_CACERTFILE:
322 case LDAP_OPT_X_TLS_CACERTDIR:
323 case LDAP_OPT_X_TLS_CERTFILE:
324 case LDAP_OPT_X_TLS_KEYFILE:
325 return ldap_pvt_tls_set_option( NULL, option, (void *) arg );
326 case LDAP_OPT_X_TLS_REQUIRE_CERT:
327 i = ( ( strcasecmp( arg, "on" ) == 0 ) ||
328 ( strcasecmp( arg, "yes" ) == 0) ||
329 ( strcasecmp( arg, "true" ) == 0 ) );
330 return ldap_pvt_tls_set_option( NULL, option, (void *) &i );
332 if ( strcasecmp( arg, "never" ) == 0 )
333 return ldap_pvt_tls_set_option( lo, option,
334 LDAP_OPT_X_TLS_NEVER );
335 if ( strcasecmp( arg, "demand" ) == 0 )
336 return ldap_pvt_tls_set_option( lo, option,
337 LDAP_OPT_X_TLS_DEMAND );
338 if ( strcasecmp( arg, "allow" ) == 0 )
339 return ldap_pvt_tls_set_option( lo, option,
340 LDAP_OPT_X_TLS_ALLOW );
341 if ( strcasecmp( arg, "try" ) == 0 )
342 return ldap_pvt_tls_set_option( lo, option,
343 LDAP_OPT_X_TLS_TRY );
344 if ( strcasecmp( arg, "hard" ) == 0 )
345 return ldap_pvt_tls_set_option( lo, option,
346 LDAP_OPT_X_TLS_HARD );
354 ldap_pvt_tls_get_option( struct ldapoptions *lo, int option, void *arg )
358 *(int *)arg = lo->ldo_tls_mode;
360 case LDAP_OPT_X_TLS_CERT:
362 arg = (void *) tls_def_ctx;
364 arg = lo->ldo_tls_ctx;
366 case LDAP_OPT_X_TLS_CACERTFILE:
367 *(char **)arg = tls_opt_cacertfile ?
368 strdup( tls_opt_cacertfile ) : NULL;
370 case LDAP_OPT_X_TLS_CACERTDIR:
371 *(char **)arg = tls_opt_cacertdir ?
372 strdup( tls_opt_cacertdir ) : NULL;
374 case LDAP_OPT_X_TLS_CERTFILE:
375 *(char **)arg = tls_opt_certfile ?
376 strdup( tls_opt_certfile ) : NULL;
378 case LDAP_OPT_X_TLS_KEYFILE:
379 *(char **)arg = tls_opt_keyfile ?
380 strdup( tls_opt_keyfile ) : NULL;
382 case LDAP_OPT_X_TLS_REQUIRE_CERT:
383 *(int *)arg = tls_opt_require_cert;
392 ldap_pvt_tls_set_option( struct ldapoptions *lo, int option, void *arg )
396 switch( *(int *) arg ) {
397 case LDAP_OPT_X_TLS_NEVER:
398 case LDAP_OPT_X_TLS_DEMAND:
399 case LDAP_OPT_X_TLS_ALLOW:
400 case LDAP_OPT_X_TLS_TRY:
401 case LDAP_OPT_X_TLS_HARD:
402 lo->ldo_tls_mode = *(int *)arg;
408 case LDAP_OPT_X_TLS_CERT:
410 tls_def_ctx = (SSL_CTX *) arg;
412 lo->ldo_tls_ctx = arg;
418 case LDAP_OPT_X_TLS_CACERTFILE:
419 if ( tls_opt_cacertfile ) free( tls_opt_cacertfile );
420 tls_opt_cacertfile = arg ? strdup( (char *) arg ) : NULL;
422 case LDAP_OPT_X_TLS_CACERTDIR:
423 if ( tls_opt_cacertdir ) free( tls_opt_cacertdir );
424 tls_opt_cacertdir = arg ? strdup( (char *) arg ) : NULL;
426 case LDAP_OPT_X_TLS_CERTFILE:
427 if ( tls_opt_certfile ) free( tls_opt_certfile );
428 tls_opt_certfile = arg ? strdup( (char *) arg ) : NULL;
430 case LDAP_OPT_X_TLS_KEYFILE:
431 if ( tls_opt_keyfile ) free( tls_opt_keyfile );
432 tls_opt_keyfile = arg ? strdup( (char *) arg ) : NULL;
434 case LDAP_OPT_X_TLS_REQUIRE_CERT:
435 tls_opt_require_cert = * (int *) arg;
443 tls_setup( Sockbuf *sb, void *arg )
450 tls_remove( Sockbuf *sb )
452 SSL_free( (SSL *) sb->sb_iodata );
457 tls_write( Sockbuf *sb, void *buf, ber_len_t sz )
459 int ret = SSL_write( (SSL *)sb->sb_iodata, buf, sz );
461 update_flags(sb, (SSL *)sb->sb_iodata );
466 tls_read( Sockbuf *sb, void *buf, ber_len_t sz )
468 int ret = SSL_read( (SSL *)sb->sb_iodata, buf, sz );
470 update_flags(sb, (SSL *)sb->sb_iodata );
475 tls_close( Sockbuf *sb )
477 tcp_close( ber_pvt_sb_get_desc( sb ) );
482 tls_verify_cb( int ok, X509_STORE_CTX *ctx )
487 /* Inspired by ERR_print_errors in OpenSSL */
489 tls_report_error( void )
496 while ( ( l = ERR_get_error_line( &file, &line ) ) != 0 ) {
497 Debug( LDAP_DEBUG_ANY, "TLS: %s %s:%d\n",
498 ERR_error_string( l, buf ), file, line );