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 );
47 static Sockbuf_IO tls_io=
56 static int tls_verify_cb( int ok, X509_STORE_CTX *ctx );
58 static SSL_CTX *tls_def_ctx = NULL;
62 * provide mutexes for the SSLeay library.
64 static ldap_pvt_thread_mutex_t tls_mutexes[CRYPTO_NUM_LOCKS];
66 static void tls_locking_cb( int mode, int type, const char *file, int line )
68 if ( mode & CRYPTO_LOCK ) {
69 ldap_pvt_thread_mutex_lock( tls_mutexes+type );
71 ldap_pvt_thread_mutex_unlock( tls_mutexes+type );
76 * an extra mutex for the default ctx.
79 static ldap_pvt_thread_mutex_t tls_def_ctx_mutex;
81 static void tls_init_threads( void )
85 for( i=0; i< CRYPTO_NUM_LOCKS ; i++ ) {
86 ldap_pvt_thread_mutex_init( tls_mutexes+i );
88 CRYPTO_set_locking_callback( tls_locking_cb );
89 /* FIXME: the thread id should be added somehow... */
91 ldap_pvt_thread_mutex_init( &tls_def_ctx_mutex );
93 #endif /* LDAP_R_COMPILE */
96 * Initialize tls system. Should be called only once.
99 ldap_pvt_tls_init( void )
101 static int tls_initialized = 0;
103 if ( tls_initialized )
105 #ifdef LDAP_R_COMPILE
108 SSL_load_error_strings();
109 SSLeay_add_ssl_algorithms();
114 * initialize the default context
117 ldap_pvt_tls_init_def_ctx( void )
119 #ifdef LDAP_R_COMPILE
120 ldap_pvt_thread_mutex_lock( &tls_def_ctx_mutex );
122 if ( tls_def_ctx == NULL ) {
123 tls_def_ctx = SSL_CTX_new( TLSv1_method() );
124 if ( tls_def_ctx == NULL ) {
125 Debug( LDAP_DEBUG_ANY,
126 "TLS: could not allocate default ctx.\n",0,0,0);
129 if ( !SSL_CTX_load_verify_locations( tls_def_ctx,
131 tls_opt_cacertdir ) ||
132 !SSL_CTX_set_default_verify_paths( tls_def_ctx ) ) {
133 Debug( LDAP_DEBUG_ANY,
134 "TLS: could not load verify locations (file:`%s',dir:`%s').\n",
135 tls_opt_cacertfile,tls_opt_cacertdir,0);
138 if ( tls_opt_keyfile &&
139 !SSL_CTX_use_PrivateKey_file( tls_def_ctx,
141 SSL_FILETYPE_PEM ) ) {
142 Debug( LDAP_DEBUG_ANY,
143 "TLS: could not use key file `%s'.\n",
144 tls_opt_keyfile,0,0);
147 if ( tls_opt_certfile &&
148 !SSL_CTX_use_certificate_file( tls_def_ctx,
150 SSL_FILETYPE_PEM ) ) {
151 Debug( LDAP_DEBUG_ANY,
152 "TLS: could not use certificate `%s'.\n",
153 tls_opt_certfile,0,0);
156 SSL_CTX_set_verify( tls_def_ctx, (tls_opt_require_cert) ?
157 (SSL_VERIFY_PEER|SSL_VERIFY_FAIL_IF_NO_PEER_CERT) :
158 SSL_VERIFY_PEER, tls_verify_cb );
160 #ifdef LDAP_R_COMPILE
161 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
165 #ifdef LDAP_R_COMPILE
166 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
172 alloc_handle( Sockbuf *sb, void *ctx_arg )
179 ctx = (SSL_CTX *) ctx_arg;
181 if ( ldap_pvt_tls_init_def_ctx() < 0 )
186 ssl = SSL_new( ctx );
188 Debug( LDAP_DEBUG_ANY,"TLS: can't create ssl handle.\n",0,0,0);
192 SSL_set_fd( ssl, ber_pvt_sb_get_desc( sb ) );
197 update_flags( Sockbuf *sb, SSL * ssl )
199 sb->sb_trans_needs_read = SSL_want_read(ssl) ? 1 : 0;
200 sb->sb_trans_needs_write = SSL_want_write(ssl) ? 1 : 0;
204 * Call this to do a TLS connect on a sockbuf. ctx_arg can be
205 * a SSL_CTX * or NULL, in which case the default ctx is used.
209 * 0 - Success. Connection is ready for communication.
210 * <0 - Error. Can't create a TLS stream.
211 * >0 - Partial success.
212 * Do a select (using information from lber_pvt_sb_needs_{read,write}
217 ldap_pvt_tls_connect( Sockbuf *sb, void *ctx_arg )
222 if ( HAS_TLS( sb ) ) {
223 ssl = (SSL *) sb->sb_iodata;
225 ssl = alloc_handle( sb, ctx_arg );
228 ber_pvt_sb_clear_io( sb );
229 ber_pvt_sb_set_io( sb, &tls_io, (void *)ssl );
232 err = SSL_connect( ssl );
237 (errno==EWOULDBLOCK) ||
243 update_flags( sb, ssl );
246 Debug( LDAP_DEBUG_ANY,"TLS: can't connect.\n",0,0,0);
247 ber_pvt_sb_clear_io( sb );
248 ber_pvt_sb_set_io( sb, &ber_pvt_sb_io_tcp, NULL );
255 * Call this to do a TLS accept on a sockbuf.
256 * Everything else is the same as with tls_connect.
259 ldap_pvt_tls_accept( Sockbuf *sb, void *ctx_arg )
264 if ( HAS_TLS( sb ) ) {
265 ssl = (SSL *) sb->sb_iodata;
267 ssl = alloc_handle( sb, ctx_arg );
270 ber_pvt_sb_clear_io( sb );
271 ber_pvt_sb_set_io( sb, &tls_io, (void *)ssl );
274 err = SSL_accept( ssl );
279 (errno==EWOULDBLOCK) ||
285 update_flags( sb, ssl );
288 Debug( LDAP_DEBUG_ANY,"TLS: can't accept.\n",0,0,0 );
289 ber_pvt_sb_clear_io( sb );
290 ber_pvt_sb_set_io( sb, &ber_pvt_sb_io_tcp, NULL );
297 ldap_pvt_tls_get_peer( LDAP *ld )
302 ldap_pvt_tls_get_peer_issuer( LDAP *ld )
307 ldap_pvt_tls_config( struct ldapoptions *lo, int option, const char *arg )
312 case LDAP_OPT_X_TLS_CACERTFILE:
313 case LDAP_OPT_X_TLS_CACERTDIR:
314 case LDAP_OPT_X_TLS_CERTFILE:
315 case LDAP_OPT_X_TLS_KEYFILE:
316 return ldap_pvt_tls_set_option( NULL, option, (void *) arg );
317 case LDAP_OPT_X_TLS_REQUIRE_CERT:
318 i = ( ( strcasecmp( arg, "on" ) == 0 ) ||
319 ( strcasecmp( arg, "yes" ) == 0) ||
320 ( strcasecmp( arg, "true" ) == 0 ) );
321 return ldap_pvt_tls_set_option( NULL, option, (void *) &i );
323 if ( strcasecmp( arg, "never" ) == 0 )
324 return ldap_pvt_tls_set_option( lo, option,
325 LDAP_OPT_X_TLS_NEVER );
326 if ( strcasecmp( arg, "demand" ) == 0 )
327 return ldap_pvt_tls_set_option( lo, option,
328 LDAP_OPT_X_TLS_DEMAND );
329 if ( strcasecmp( arg, "allow" ) == 0 )
330 return ldap_pvt_tls_set_option( lo, option,
331 LDAP_OPT_X_TLS_ALLOW );
332 if ( strcasecmp( arg, "try" ) == 0 )
333 return ldap_pvt_tls_set_option( lo, option,
334 LDAP_OPT_X_TLS_TRY );
335 if ( strcasecmp( arg, "hard" ) == 0 )
336 return ldap_pvt_tls_set_option( lo, option,
337 LDAP_OPT_X_TLS_HARD );
345 ldap_pvt_tls_get_option( struct ldapoptions *lo, int option, void *arg )
349 *(int *)arg = lo->ldo_tls_mode;
351 case LDAP_OPT_X_TLS_CERT:
353 arg = (void *) tls_def_ctx;
355 arg = lo->ldo_tls_ctx;
357 case LDAP_OPT_X_TLS_CACERTFILE:
358 *(char **)arg = tls_opt_cacertfile ?
359 strdup( tls_opt_cacertfile ) : NULL;
361 case LDAP_OPT_X_TLS_CACERTDIR:
362 *(char **)arg = tls_opt_cacertdir ?
363 strdup( tls_opt_cacertdir ) : NULL;
365 case LDAP_OPT_X_TLS_CERTFILE:
366 *(char **)arg = tls_opt_certfile ?
367 strdup( tls_opt_certfile ) : NULL;
369 case LDAP_OPT_X_TLS_KEYFILE:
370 *(char **)arg = tls_opt_keyfile ?
371 strdup( tls_opt_keyfile ) : NULL;
373 case LDAP_OPT_X_TLS_REQUIRE_CERT:
374 *(int *)arg = tls_opt_require_cert;
383 ldap_pvt_tls_set_option( struct ldapoptions *lo, int option, void *arg )
387 switch( *(int *) arg ) {
388 case LDAP_OPT_X_TLS_NEVER:
389 case LDAP_OPT_X_TLS_DEMAND:
390 case LDAP_OPT_X_TLS_ALLOW:
391 case LDAP_OPT_X_TLS_TRY:
392 case LDAP_OPT_X_TLS_HARD:
393 lo->ldo_tls_mode = *(int *)arg;
399 case LDAP_OPT_X_TLS_CERT:
401 tls_def_ctx = (SSL_CTX *) arg;
403 lo->ldo_tls_ctx = arg;
409 case LDAP_OPT_X_TLS_CACERTFILE:
410 if ( tls_opt_cacertfile ) free( tls_opt_cacertfile );
411 tls_opt_cacertfile = arg ? strdup( (char *) arg ) : NULL;
413 case LDAP_OPT_X_TLS_CACERTDIR:
414 if ( tls_opt_cacertdir ) free( tls_opt_cacertdir );
415 tls_opt_cacertdir = arg ? strdup( (char *) arg ) : NULL;
417 case LDAP_OPT_X_TLS_CERTFILE:
418 if ( tls_opt_certfile ) free( tls_opt_certfile );
419 tls_opt_certfile = arg ? strdup( (char *) arg ) : NULL;
421 case LDAP_OPT_X_TLS_KEYFILE:
422 if ( tls_opt_keyfile ) free( tls_opt_keyfile );
423 tls_opt_keyfile = arg ? strdup( (char *) arg ) : NULL;
425 case LDAP_OPT_X_TLS_REQUIRE_CERT:
426 tls_opt_require_cert = * (int *) arg;
433 tls_setup( Sockbuf *sb, void *arg )
440 tls_remove( Sockbuf *sb )
442 SSL_free( (SSL *) sb->sb_iodata );
447 tls_write( Sockbuf *sb, void *buf, ber_len_t sz )
449 int ret = SSL_write( (SSL *)sb->sb_iodata, buf, sz );
451 update_flags(sb, (SSL *)sb->sb_iodata );
456 tls_read( Sockbuf *sb, void *buf, ber_len_t sz )
458 int ret = SSL_read( (SSL *)sb->sb_iodata, buf, sz );
460 update_flags(sb, (SSL *)sb->sb_iodata );
465 tls_close( Sockbuf *sb )
467 tcp_close( ber_pvt_sb_get_desc( sb ) );
472 tls_verify_cb( int ok, X509_STORE_CTX *ctx )