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>
31 static char *tls_opt_certfile = NULL;
32 static char *tls_opt_keyfile = NULL;
33 static char *tls_opt_cacertfile = NULL;
34 static char *tls_opt_cacertdir = NULL;
35 static int tls_opt_require_cert = 0;
37 #define HAS_TLS( sb ) ((sb)->sb_io==&tls_io)
39 static int tls_setup( Sockbuf *sb, void *arg );
40 static int tls_remove( Sockbuf *sb );
41 static ber_slen_t tls_read( Sockbuf *sb, void *buf, ber_len_t len );
42 static ber_slen_t tls_write( Sockbuf *sb, void *buf, ber_len_t len );
43 static int tls_close( Sockbuf *sb );
45 static Sockbuf_IO tls_io=
54 static int tls_verify_cb( int ok, X509_STORE_CTX *ctx );
56 static SSL_CTX *tls_def_ctx = NULL;
60 * provide mutexes for the SSLeay library.
62 static ldap_pvt_thread_mutex_t tls_mutexes[CRYPTO_NUM_LOCKS];
64 static void tls_locking_cb( int mode, int type, const char *file, int line )
66 if ( mode & CRYPTO_LOCK ) {
67 ldap_pvt_thread_mutex_lock( tls_mutexes+type );
69 ldap_pvt_thread_mutex_unlock( tls_mutexes+type );
74 * an extra mutex for the default ctx.
77 static ldap_pvt_thread_mutex_t tls_def_ctx_mutex;
79 static void tls_init_threads( void )
83 for( i=0; i< CRYPTO_NUM_LOCKS ; i++ ) {
84 ldap_pvt_thread_mutex_init( tls_mutexes+i );
86 CRYPTO_set_locking_callback( tls_locking_cb );
87 /* FIXME: the thread id should be added somehow... */
89 ldap_pvt_thread_mutex_init( &tls_def_ctx_mutex );
91 #endif /* LDAP_R_COMPILE */
94 * Initialize tls system. Should be called only once.
97 ldap_pvt_tls_init( void )
99 static int tls_initialized = 0;
101 if ( tls_initialized )
103 #ifdef LDAP_R_COMPILE
106 SSL_load_error_strings();
107 SSLeay_add_ssl_algorithms();
112 * initialize the default context
115 ldap_pvt_tls_init_def_ctx( void )
117 #ifdef LDAP_R_COMPILE
118 ldap_pvt_thread_mutex_lock( &tls_def_ctx_mutex );
120 if ( tls_def_ctx == NULL ) {
121 tls_def_ctx = SSL_CTX_new( TLSv1_method() );
122 if ( tls_def_ctx == NULL ) {
123 Debug( LDAP_DEBUG_ANY,
124 "TLS: could not allocate default ctx.\n",0,0,0);
127 if ( !SSL_CTX_load_verify_locations( tls_def_ctx,
129 tls_opt_cacertdir ) ||
130 !SSL_CTX_set_default_verify_paths( tls_def_ctx ) ) {
131 Debug( LDAP_DEBUG_ANY,
132 "TLS: could not load verify locations (file:`%s',dir:`%s').\n",
133 tls_opt_cacertfile,tls_opt_cacertdir,0);
136 if ( tls_opt_keyfile &&
137 !SSL_CTX_use_PrivateKey_file( tls_def_ctx,
139 SSL_FILETYPE_PEM ) ) {
140 Debug( LDAP_DEBUG_ANY,
141 "TLS: could not use key file `%s'.\n",
142 tls_opt_keyfile,0,0);
145 if ( tls_opt_certfile &&
146 !SSL_CTX_use_certificate_file( tls_def_ctx,
148 SSL_FILETYPE_PEM ) ) {
149 Debug( LDAP_DEBUG_ANY,
150 "TLS: could not use certificate `%s'.\n",
151 tls_opt_certfile,0,0);
154 SSL_CTX_set_verify( tls_def_ctx, (tls_opt_require_cert) ?
155 (SSL_VERIFY_PEER|SSL_VERIFY_FAIL_IF_NO_PEER_CERT) :
156 SSL_VERIFY_PEER, tls_verify_cb );
158 #ifdef LDAP_R_COMPILE
159 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
163 #ifdef LDAP_R_COMPILE
164 ldap_pvt_thread_mutex_unlock( &tls_def_ctx_mutex );
170 alloc_handle( Sockbuf *sb, void *ctx_arg )
177 ctx = (SSL_CTX *) ctx_arg;
179 if ( ldap_pvt_tls_init_def_ctx() < 0 )
184 ssl = SSL_new( ctx );
186 Debug( LDAP_DEBUG_ANY,"TLS: can't create ssl handle.\n",0,0,0);
190 SSL_set_fd( ssl, ber_pvt_sb_get_desc( sb ) );
195 update_flags( Sockbuf *sb, SSL * ssl )
197 sb->sb_trans_needs_read = SSL_want_read(ssl) ? 1 : 0;
198 sb->sb_trans_needs_write = SSL_want_write(ssl) ? 1 : 0;
202 * Call this to do a TLS connect on a sockbuf. ctx_arg can be
203 * a SSL_CTX * or NULL, in which case the default ctx is used.
207 * 0 - Success. Connection is ready for communication.
208 * <0 - Error. Can't create a TLS stream.
209 * >0 - Partial success.
210 * Do a select (using information from lber_pvt_sb_needs_{read,write}
215 ldap_pvt_tls_connect( Sockbuf *sb, void *ctx_arg )
220 if ( HAS_TLS( sb ) ) {
221 ssl = (SSL *) sb->sb_iodata;
223 ssl = alloc_handle( sb, ctx_arg );
226 ber_pvt_sb_clear_io( sb );
227 ber_pvt_sb_set_io( sb, &tls_io, (void *)ssl );
230 err = SSL_connect( ssl );
235 (errno==EWOULDBLOCK) ||
241 update_flags( sb, ssl );
244 Debug( LDAP_DEBUG_ANY,"TLS: can't connect.\n",0,0,0);
245 ber_pvt_sb_clear_io( sb );
246 ber_pvt_sb_set_io( sb, &ber_pvt_sb_io_tcp, NULL );
253 * Call this to do a TLS accept on a sockbuf.
254 * Everything else is the same as with tls_connect.
257 ldap_pvt_tls_accept( Sockbuf *sb, void *ctx_arg )
262 if ( HAS_TLS( sb ) ) {
263 ssl = (SSL *) sb->sb_iodata;
265 ssl = alloc_handle( sb, ctx_arg );
268 ber_pvt_sb_clear_io( sb );
269 ber_pvt_sb_set_io( sb, &tls_io, (void *)ssl );
272 err = SSL_accept( ssl );
277 (errno==EWOULDBLOCK) ||
283 update_flags( sb, ssl );
286 Debug( LDAP_DEBUG_ANY,"TLS: can't accept.\n",0,0,0 );
287 ber_pvt_sb_clear_io( sb );
288 ber_pvt_sb_set_io( sb, &ber_pvt_sb_io_tcp, NULL );
295 ldap_pvt_tls_get_peer( LDAP *ld )
300 ldap_pvt_tls_get_peer_issuer( LDAP *ld )
305 ldap_pvt_tls_config( struct ldapoptions *lo, int option, const char *arg )
310 case LDAP_OPT_X_TLS_CACERTFILE:
311 case LDAP_OPT_X_TLS_CACERTDIR:
312 case LDAP_OPT_X_TLS_CERTFILE:
313 case LDAP_OPT_X_TLS_KEYFILE:
314 return ldap_pvt_tls_set_option( NULL, option, (void *) arg );
315 case LDAP_OPT_X_TLS_REQUIRE_CERT:
316 i = ( ( strcasecmp( arg, "on" ) == 0 ) ||
317 ( strcasecmp( arg, "yes" ) == 0) ||
318 ( strcasecmp( arg, "true" ) == 0 ) );
319 return ldap_pvt_tls_set_option( NULL, option, (void *) &i );
321 if ( strcasecmp( arg, "never" ) == 0 )
322 return ldap_pvt_tls_set_option( lo, option,
323 LDAP_OPT_X_TLS_NEVER );
324 if ( strcasecmp( arg, "demand" ) == 0 )
325 return ldap_pvt_tls_set_option( lo, option,
326 LDAP_OPT_X_TLS_DEMAND );
327 if ( strcasecmp( arg, "allow" ) == 0 )
328 return ldap_pvt_tls_set_option( lo, option,
329 LDAP_OPT_X_TLS_ALLOW );
330 if ( strcasecmp( arg, "try" ) == 0 )
331 return ldap_pvt_tls_set_option( lo, option,
332 LDAP_OPT_X_TLS_TRY );
333 if ( strcasecmp( arg, "hard" ) == 0 )
334 return ldap_pvt_tls_set_option( lo, option,
335 LDAP_OPT_X_TLS_HARD );
343 ldap_pvt_tls_get_option( struct ldapoptions *lo, int option, void *arg )
347 *(int *)arg = lo->ldo_tls_mode;
349 case LDAP_OPT_X_TLS_CERT:
351 arg = (void *) tls_def_ctx;
353 arg = lo->ldo_tls_ctx;
355 case LDAP_OPT_X_TLS_CACERTFILE:
356 *(char **)arg = tls_opt_cacertfile ?
357 strdup( tls_opt_cacertfile ) : NULL;
359 case LDAP_OPT_X_TLS_CACERTDIR:
360 *(char **)arg = tls_opt_cacertdir ?
361 strdup( tls_opt_cacertdir ) : NULL;
363 case LDAP_OPT_X_TLS_CERTFILE:
364 *(char **)arg = tls_opt_certfile ?
365 strdup( tls_opt_certfile ) : NULL;
367 case LDAP_OPT_X_TLS_KEYFILE:
368 *(char **)arg = tls_opt_keyfile ?
369 strdup( tls_opt_keyfile ) : NULL;
371 case LDAP_OPT_X_TLS_REQUIRE_CERT:
372 *(int *)arg = tls_opt_require_cert;
381 ldap_pvt_tls_set_option( struct ldapoptions *lo, int option, void *arg )
385 switch( *(int *) arg ) {
386 case LDAP_OPT_X_TLS_NEVER:
387 case LDAP_OPT_X_TLS_DEMAND:
388 case LDAP_OPT_X_TLS_ALLOW:
389 case LDAP_OPT_X_TLS_TRY:
390 case LDAP_OPT_X_TLS_HARD:
391 lo->ldo_tls_mode = *(int *)arg;
397 case LDAP_OPT_X_TLS_CERT:
399 tls_def_ctx = (SSL_CTX *) arg;
401 lo->ldo_tls_ctx = arg;
407 case LDAP_OPT_X_TLS_CACERTFILE:
408 if ( tls_opt_cacertfile ) free( tls_opt_cacertfile );
409 tls_opt_cacertfile = arg ? strdup( (char *) arg ) : NULL;
411 case LDAP_OPT_X_TLS_CACERTDIR:
412 if ( tls_opt_cacertdir ) free( tls_opt_cacertdir );
413 tls_opt_cacertdir = arg ? strdup( (char *) arg ) : NULL;
415 case LDAP_OPT_X_TLS_CERTFILE:
416 if ( tls_opt_certfile ) free( tls_opt_certfile );
417 tls_opt_certfile = arg ? strdup( (char *) arg ) : NULL;
419 case LDAP_OPT_X_TLS_KEYFILE:
420 if ( tls_opt_keyfile ) free( tls_opt_keyfile );
421 tls_opt_keyfile = arg ? strdup( (char *) arg ) : NULL;
423 case LDAP_OPT_X_TLS_REQUIRE_CERT:
424 tls_opt_require_cert = * (int *) arg;
431 tls_setup( Sockbuf *sb, void *arg )
438 tls_remove( Sockbuf *sb )
440 SSL_free( (SSL *) sb->sb_iodata );
445 tls_write( Sockbuf *sb, void *buf, ber_len_t sz )
447 int ret = SSL_write( (SSL *)sb->sb_iodata, buf, sz );
449 update_flags(sb, (SSL *)sb->sb_iodata );
454 tls_read( Sockbuf *sb, void *buf, ber_len_t sz )
456 int ret = SSL_read( (SSL *)sb->sb_iodata, buf, sz );
458 update_flags(sb, (SSL *)sb->sb_iodata );
463 tls_close( Sockbuf *sb )
465 tcp_close( ber_pvt_sb_get_desc( sb ) );
470 tls_verify_cb( int ok, X509_STORE_CTX *ctx )