1 /* tls.c - Handle tls/ssl. */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2018 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>.
16 /* ACKNOWLEDGEMENTS: restructured by Howard Chu.
20 #include "ldap_config.h"
24 #include <ac/stdlib.h>
26 #include <ac/socket.h>
27 #include <ac/string.h>
30 #include <ac/unistd.h>
32 #include <ac/dirent.h>
40 static tls_impl *tls_imp = &ldap_int_tls_impl;
41 #define HAS_TLS( sb ) ber_sockbuf_ctrl( sb, LBER_SB_OPT_HAS_IO, \
42 (void *)tls_imp->ti_sbio )
47 #define LDAP_USE_NON_BLOCKING_TLS
48 #endif /* LDAP_DEVEL */
50 /* RFC2459 minimum required set of supported attribute types
53 typedef struct oid_name {
58 static oid_name oids[] = {
59 { BER_BVC("2.5.4.3"), BER_BVC("cn") },
60 { BER_BVC("2.5.4.4"), BER_BVC("sn") },
61 { BER_BVC("2.5.4.6"), BER_BVC("c") },
62 { BER_BVC("2.5.4.7"), BER_BVC("l") },
63 { BER_BVC("2.5.4.8"), BER_BVC("st") },
64 { BER_BVC("2.5.4.10"), BER_BVC("o") },
65 { BER_BVC("2.5.4.11"), BER_BVC("ou") },
66 { BER_BVC("2.5.4.12"), BER_BVC("title") },
67 { BER_BVC("2.5.4.41"), BER_BVC("name") },
68 { BER_BVC("2.5.4.42"), BER_BVC("givenName") },
69 { BER_BVC("2.5.4.43"), BER_BVC("initials") },
70 { BER_BVC("2.5.4.44"), BER_BVC("generationQualifier") },
71 { BER_BVC("2.5.4.46"), BER_BVC("dnQualifier") },
72 { BER_BVC("1.2.840.113549.1.9.1"), BER_BVC("email") },
73 { BER_BVC("0.9.2342.19200300.100.1.25"), BER_BVC("dc") },
74 { BER_BVNULL, BER_BVNULL }
80 ldap_pvt_tls_ctx_free ( void *c )
83 tls_imp->ti_ctx_free( c );
87 tls_ctx_ref( tls_ctx *ctx )
91 tls_imp->ti_ctx_ref( ctx );
96 * an extra mutex for the default ctx.
98 static ldap_pvt_thread_mutex_t tls_def_ctx_mutex;
102 ldap_int_tls_destroy( struct ldapoptions *lo )
104 if ( lo->ldo_tls_ctx ) {
105 ldap_pvt_tls_ctx_free( lo->ldo_tls_ctx );
106 lo->ldo_tls_ctx = NULL;
109 if ( lo->ldo_tls_certfile ) {
110 LDAP_FREE( lo->ldo_tls_certfile );
111 lo->ldo_tls_certfile = NULL;
113 if ( lo->ldo_tls_keyfile ) {
114 LDAP_FREE( lo->ldo_tls_keyfile );
115 lo->ldo_tls_keyfile = NULL;
117 if ( lo->ldo_tls_dhfile ) {
118 LDAP_FREE( lo->ldo_tls_dhfile );
119 lo->ldo_tls_dhfile = NULL;
121 if ( lo->ldo_tls_cacertfile ) {
122 LDAP_FREE( lo->ldo_tls_cacertfile );
123 lo->ldo_tls_cacertfile = NULL;
125 if ( lo->ldo_tls_cacertdir ) {
126 LDAP_FREE( lo->ldo_tls_cacertdir );
127 lo->ldo_tls_cacertdir = NULL;
129 if ( lo->ldo_tls_ciphersuite ) {
130 LDAP_FREE( lo->ldo_tls_ciphersuite );
131 lo->ldo_tls_ciphersuite = NULL;
133 if ( lo->ldo_tls_crlfile ) {
134 LDAP_FREE( lo->ldo_tls_crlfile );
135 lo->ldo_tls_crlfile = NULL;
140 * Tear down the TLS subsystem. Should only be called once.
143 ldap_pvt_tls_destroy( void )
145 struct ldapoptions *lo = LDAP_INT_GLOBAL_OPT();
147 ldap_int_tls_destroy( lo );
149 tls_imp->ti_tls_destroy();
153 * Initialize a particular TLS implementation.
154 * Called once per implementation.
157 tls_init(tls_impl *impl )
159 static int tls_initialized = 0;
161 if ( !tls_initialized++ ) {
162 #ifdef LDAP_R_COMPILE
163 ldap_pvt_thread_mutex_init( &tls_def_ctx_mutex );
167 if ( impl->ti_inited++ ) return 0;
169 #ifdef LDAP_R_COMPILE
172 return impl->ti_tls_init();
176 * Initialize TLS subsystem. Called once per implementation.
179 ldap_pvt_tls_init( void )
181 return tls_init( tls_imp );
185 * initialize a new TLS context
188 ldap_int_tls_init_ctx( struct ldapoptions *lo, int is_server )
191 tls_impl *ti = tls_imp;
192 struct ldaptls lts = lo->ldo_tls_info;
194 if ( lo->ldo_tls_ctx )
199 if ( is_server && !lts.lt_certfile && !lts.lt_keyfile &&
200 !lts.lt_cacertfile && !lts.lt_cacertdir ) {
201 /* minimum configuration not provided */
202 return LDAP_NOT_SUPPORTED;
206 /* This ASCII/EBCDIC handling is a real pain! */
207 if ( lts.lt_ciphersuite ) {
208 lts.lt_ciphersuite = LDAP_STRDUP( lts.lt_ciphersuite );
209 __atoe( lts.lt_ciphersuite );
211 if ( lts.lt_cacertfile ) {
212 lts.lt_cacertfile = LDAP_STRDUP( lts.lt_cacertfile );
213 __atoe( lts.lt_cacertfile );
215 if ( lts.lt_certfile ) {
216 lts.lt_certfile = LDAP_STRDUP( lts.lt_certfile );
217 __atoe( lts.lt_certfile );
219 if ( lts.lt_keyfile ) {
220 lts.lt_keyfile = LDAP_STRDUP( lts.lt_keyfile );
221 __atoe( lts.lt_keyfile );
223 if ( lts.lt_crlfile ) {
224 lts.lt_crlfile = LDAP_STRDUP( lts.lt_crlfile );
225 __atoe( lts.lt_crlfile );
227 if ( lts.lt_cacertdir ) {
228 lts.lt_cacertdir = LDAP_STRDUP( lts.lt_cacertdir );
229 __atoe( lts.lt_cacertdir );
231 if ( lts.lt_dhfile ) {
232 lts.lt_dhfile = LDAP_STRDUP( lts.lt_dhfile );
233 __atoe( lts.lt_dhfile );
236 lo->ldo_tls_ctx = ti->ti_ctx_new( lo );
237 if ( lo->ldo_tls_ctx == NULL ) {
238 Debug( LDAP_DEBUG_ANY,
239 "TLS: could not allocate default ctx.\n",
245 rc = ti->ti_ctx_init( lo, <s, is_server );
248 if ( rc < 0 && lo->ldo_tls_ctx != NULL ) {
249 ldap_pvt_tls_ctx_free( lo->ldo_tls_ctx );
250 lo->ldo_tls_ctx = NULL;
253 LDAP_FREE( lts.lt_ciphersuite );
254 LDAP_FREE( lts.lt_cacertfile );
255 LDAP_FREE( lts.lt_certfile );
256 LDAP_FREE( lts.lt_keyfile );
257 LDAP_FREE( lts.lt_crlfile );
258 LDAP_FREE( lts.lt_cacertdir );
259 LDAP_FREE( lts.lt_dhfile );
265 * initialize the default context
268 ldap_pvt_tls_init_def_ctx( int is_server )
270 struct ldapoptions *lo = LDAP_INT_GLOBAL_OPT();
272 LDAP_MUTEX_LOCK( &tls_def_ctx_mutex );
273 rc = ldap_int_tls_init_ctx( lo, is_server );
274 LDAP_MUTEX_UNLOCK( &tls_def_ctx_mutex );
279 alloc_handle( void *ctx_arg, int is_server )
287 struct ldapoptions *lo = LDAP_INT_GLOBAL_OPT();
288 if ( ldap_pvt_tls_init_def_ctx( is_server ) < 0 ) return NULL;
289 ctx = lo->ldo_tls_ctx;
292 ssl = tls_imp->ti_session_new( ctx, is_server );
294 Debug( LDAP_DEBUG_ANY,"TLS: can't create ssl handle.\n",0,0,0);
301 update_flags( Sockbuf *sb, tls_session * ssl, int rc )
303 sb->sb_trans_needs_read = 0;
304 sb->sb_trans_needs_write = 0;
306 return tls_imp->ti_session_upflags( sb, ssl, rc );
310 * Call this to do a TLS connect on a sockbuf. ctx_arg can be
311 * a SSL_CTX * or NULL, in which case the default ctx is used.
315 * 0 - Success. Connection is ready for communication.
316 * <0 - Error. Can't create a TLS stream.
317 * >0 - Partial success.
318 * Do a select (using information from lber_pvt_sb_needs_{read,write}
323 ldap_int_tls_connect( LDAP *ld, LDAPConn *conn, const char *host )
325 Sockbuf *sb = conn->lconn_sb;
327 tls_session *ssl = NULL;
329 if ( HAS_TLS( sb )) {
330 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
332 struct ldapoptions *lo;
335 ctx = ld->ld_options.ldo_tls_ctx;
337 ssl = alloc_handle( ctx, 0 );
339 if ( ssl == NULL ) return -1;
342 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
343 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
345 ber_sockbuf_add_io( sb, tls_imp->ti_sbio,
346 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
348 lo = LDAP_INT_GLOBAL_OPT();
350 ctx = lo->ldo_tls_ctx;
351 ld->ld_options.ldo_tls_ctx = ctx;
354 if ( ld->ld_options.ldo_tls_connect_cb )
355 ld->ld_options.ldo_tls_connect_cb( ld, ssl, ctx,
356 ld->ld_options.ldo_tls_connect_arg );
357 if ( lo && lo->ldo_tls_connect_cb && lo->ldo_tls_connect_cb !=
358 ld->ld_options.ldo_tls_connect_cb )
359 lo->ldo_tls_connect_cb( ld, ssl, ctx, lo->ldo_tls_connect_arg );
362 err = tls_imp->ti_session_connect( ld, ssl );
365 errno = WSAGetLastError();
369 err = ldap_pvt_tls_check_hostname( ld, ssl, host );
375 if ( update_flags( sb, ssl, err )) {
379 msg = tls_imp->ti_session_errmsg( ssl, err, buf, sizeof(buf) );
381 if ( ld->ld_error ) {
382 LDAP_FREE( ld->ld_error );
384 ld->ld_error = LDAP_STRDUP( msg );
386 if ( ld->ld_error ) __etoa(ld->ld_error);
390 Debug( LDAP_DEBUG_ANY,"TLS: can't connect: %s.\n",
391 ld->ld_error ? ld->ld_error : "" ,0,0);
393 ber_sockbuf_remove_io( sb, tls_imp->ti_sbio,
394 LBER_SBIOD_LEVEL_TRANSPORT );
396 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
397 LBER_SBIOD_LEVEL_TRANSPORT );
406 * Call this to do a TLS accept on a sockbuf.
407 * Everything else is the same as with tls_connect.
410 ldap_pvt_tls_accept( Sockbuf *sb, void *ctx_arg )
413 tls_session *ssl = NULL;
415 if ( HAS_TLS( sb )) {
416 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
418 ssl = alloc_handle( ctx_arg, 1 );
419 if ( ssl == NULL ) return -1;
422 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
423 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
425 ber_sockbuf_add_io( sb, tls_imp->ti_sbio,
426 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
429 err = tls_imp->ti_session_accept( ssl );
432 errno = WSAGetLastError();
437 if ( update_flags( sb, ssl, err )) return 1;
439 if ( DebugTest( LDAP_DEBUG_ANY ) ) {
441 msg = tls_imp->ti_session_errmsg( ssl, err, buf, sizeof(buf) );
442 Debug( LDAP_DEBUG_ANY,"TLS: can't accept: %s.\n",
443 msg ? msg : "(unknown)", 0, 0 );
446 ber_sockbuf_remove_io( sb, tls_imp->ti_sbio,
447 LBER_SBIOD_LEVEL_TRANSPORT );
449 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
450 LBER_SBIOD_LEVEL_TRANSPORT );
458 ldap_pvt_tls_inplace ( Sockbuf *sb )
460 return HAS_TLS( sb ) ? 1 : 0;
464 ldap_tls_inplace( LDAP *ld )
468 if ( ld->ld_defconn && ld->ld_defconn->lconn_sb ) {
469 sb = ld->ld_defconn->lconn_sb;
471 } else if ( ld->ld_sb ) {
478 return ldap_pvt_tls_inplace( sb );
482 ldap_pvt_tls_get_peer_dn( void *s, struct berval *dn,
483 LDAPDN_rewrite_dummy *func, unsigned flags )
485 tls_session *session = s;
489 rc = tls_imp->ti_session_peer_dn( session, &bvdn );
492 rc = ldap_X509dn2bv( &bvdn, dn,
493 (LDAPDN_rewrite_func *)func, flags);
498 ldap_pvt_tls_check_hostname( LDAP *ld, void *s, const char *name_in )
500 tls_session *session = s;
502 if (ld->ld_options.ldo_tls_require_cert != LDAP_OPT_X_TLS_NEVER &&
503 ld->ld_options.ldo_tls_require_cert != LDAP_OPT_X_TLS_ALLOW) {
504 ld->ld_errno = tls_imp->ti_session_chkhost( ld, session, name_in );
505 if (ld->ld_errno != LDAP_SUCCESS) {
514 ldap_int_tls_config( LDAP *ld, int option, const char *arg )
519 case LDAP_OPT_X_TLS_CACERTFILE:
520 case LDAP_OPT_X_TLS_CACERTDIR:
521 case LDAP_OPT_X_TLS_CERTFILE:
522 case LDAP_OPT_X_TLS_KEYFILE:
523 case LDAP_OPT_X_TLS_RANDOM_FILE:
524 case LDAP_OPT_X_TLS_CIPHER_SUITE:
525 case LDAP_OPT_X_TLS_DHFILE:
526 case LDAP_OPT_X_TLS_CRLFILE: /* GnuTLS only */
527 return ldap_pvt_tls_set_option( ld, option, (void *) arg );
529 case LDAP_OPT_X_TLS_REQUIRE_CERT:
532 if ( strcasecmp( arg, "never" ) == 0 ) {
533 i = LDAP_OPT_X_TLS_NEVER ;
535 } else if ( strcasecmp( arg, "demand" ) == 0 ) {
536 i = LDAP_OPT_X_TLS_DEMAND ;
538 } else if ( strcasecmp( arg, "allow" ) == 0 ) {
539 i = LDAP_OPT_X_TLS_ALLOW ;
541 } else if ( strcasecmp( arg, "try" ) == 0 ) {
542 i = LDAP_OPT_X_TLS_TRY ;
544 } else if ( ( strcasecmp( arg, "hard" ) == 0 ) ||
545 ( strcasecmp( arg, "on" ) == 0 ) ||
546 ( strcasecmp( arg, "yes" ) == 0) ||
547 ( strcasecmp( arg, "true" ) == 0 ) )
549 i = LDAP_OPT_X_TLS_HARD ;
553 return ldap_pvt_tls_set_option( ld, option, &i );
556 case LDAP_OPT_X_TLS_PROTOCOL_MIN: {
559 l = strtol( arg, &next, 10 );
560 if ( l < 0 || l > 0xff || next == arg ||
561 ( *next != '\0' && *next != '.' ) )
566 l = strtol( arg, &next, 10 );
567 if ( l < 0 || l > 0xff || next == arg || *next != '\0' )
571 return ldap_pvt_tls_set_option( ld, option, &i );
573 #ifdef HAVE_OPENSSL_CRL
574 case LDAP_OPT_X_TLS_CRLCHECK: /* OpenSSL only */
576 if ( strcasecmp( arg, "none" ) == 0 ) {
577 i = LDAP_OPT_X_TLS_CRL_NONE ;
578 } else if ( strcasecmp( arg, "peer" ) == 0 ) {
579 i = LDAP_OPT_X_TLS_CRL_PEER ;
580 } else if ( strcasecmp( arg, "all" ) == 0 ) {
581 i = LDAP_OPT_X_TLS_CRL_ALL ;
584 return ldap_pvt_tls_set_option( ld, option, &i );
593 ldap_pvt_tls_get_option( LDAP *ld, int option, void *arg )
595 struct ldapoptions *lo;
597 if( option == LDAP_OPT_X_TLS_PACKAGE ) {
598 *(char **)arg = LDAP_STRDUP( tls_imp->ti_name );
603 assert( LDAP_VALID( ld ) );
605 if( !LDAP_VALID( ld ) ) {
606 return LDAP_OPT_ERROR;
609 lo = &ld->ld_options;
612 /* Get pointer to global option structure */
613 lo = LDAP_INT_GLOBAL_OPT();
615 return LDAP_NO_MEMORY;
621 *(int *)arg = lo->ldo_tls_mode;
623 case LDAP_OPT_X_TLS_CTX:
624 *(void **)arg = lo->ldo_tls_ctx;
625 if ( lo->ldo_tls_ctx ) {
626 tls_ctx_ref( lo->ldo_tls_ctx );
629 case LDAP_OPT_X_TLS_CACERTFILE:
630 *(char **)arg = lo->ldo_tls_cacertfile ?
631 LDAP_STRDUP( lo->ldo_tls_cacertfile ) : NULL;
633 case LDAP_OPT_X_TLS_CACERTDIR:
634 *(char **)arg = lo->ldo_tls_cacertdir ?
635 LDAP_STRDUP( lo->ldo_tls_cacertdir ) : NULL;
637 case LDAP_OPT_X_TLS_CERTFILE:
638 *(char **)arg = lo->ldo_tls_certfile ?
639 LDAP_STRDUP( lo->ldo_tls_certfile ) : NULL;
641 case LDAP_OPT_X_TLS_KEYFILE:
642 *(char **)arg = lo->ldo_tls_keyfile ?
643 LDAP_STRDUP( lo->ldo_tls_keyfile ) : NULL;
645 case LDAP_OPT_X_TLS_DHFILE:
646 *(char **)arg = lo->ldo_tls_dhfile ?
647 LDAP_STRDUP( lo->ldo_tls_dhfile ) : NULL;
649 case LDAP_OPT_X_TLS_CRLFILE: /* GnuTLS only */
650 *(char **)arg = lo->ldo_tls_crlfile ?
651 LDAP_STRDUP( lo->ldo_tls_crlfile ) : NULL;
653 case LDAP_OPT_X_TLS_REQUIRE_CERT:
654 *(int *)arg = lo->ldo_tls_require_cert;
656 #ifdef HAVE_OPENSSL_CRL
657 case LDAP_OPT_X_TLS_CRLCHECK: /* OpenSSL only */
658 *(int *)arg = lo->ldo_tls_crlcheck;
661 case LDAP_OPT_X_TLS_CIPHER_SUITE:
662 *(char **)arg = lo->ldo_tls_ciphersuite ?
663 LDAP_STRDUP( lo->ldo_tls_ciphersuite ) : NULL;
665 case LDAP_OPT_X_TLS_PROTOCOL_MIN:
666 *(int *)arg = lo->ldo_tls_protocol_min;
668 case LDAP_OPT_X_TLS_RANDOM_FILE:
669 *(char **)arg = lo->ldo_tls_randfile ?
670 LDAP_STRDUP( lo->ldo_tls_randfile ) : NULL;
672 case LDAP_OPT_X_TLS_SSL_CTX: {
675 LDAPConn *conn = ld->ld_defconn;
676 if ( conn != NULL ) {
677 Sockbuf *sb = conn->lconn_sb;
678 retval = ldap_pvt_tls_sb_ctx( sb );
681 *(void **)arg = retval;
684 case LDAP_OPT_X_TLS_CONNECT_CB:
685 *(LDAP_TLS_CONNECT_CB **)arg = lo->ldo_tls_connect_cb;
687 case LDAP_OPT_X_TLS_CONNECT_ARG:
688 *(void **)arg = lo->ldo_tls_connect_arg;
697 ldap_pvt_tls_set_option( LDAP *ld, int option, void *arg )
699 struct ldapoptions *lo;
702 assert( LDAP_VALID( ld ) );
704 if( !LDAP_VALID( ld ) ) {
705 return LDAP_OPT_ERROR;
708 lo = &ld->ld_options;
711 /* Get pointer to global option structure */
712 lo = LDAP_INT_GLOBAL_OPT();
714 return LDAP_NO_MEMORY;
720 if ( !arg ) return -1;
722 switch( *(int *) arg ) {
723 case LDAP_OPT_X_TLS_NEVER:
724 case LDAP_OPT_X_TLS_DEMAND:
725 case LDAP_OPT_X_TLS_ALLOW:
726 case LDAP_OPT_X_TLS_TRY:
727 case LDAP_OPT_X_TLS_HARD:
729 lo->ldo_tls_mode = *(int *)arg;
736 case LDAP_OPT_X_TLS_CTX:
737 if ( lo->ldo_tls_ctx )
738 ldap_pvt_tls_ctx_free( lo->ldo_tls_ctx );
739 lo->ldo_tls_ctx = arg;
740 tls_ctx_ref( lo->ldo_tls_ctx );
742 case LDAP_OPT_X_TLS_CONNECT_CB:
743 lo->ldo_tls_connect_cb = (LDAP_TLS_CONNECT_CB *)arg;
745 case LDAP_OPT_X_TLS_CONNECT_ARG:
746 lo->ldo_tls_connect_arg = arg;
748 case LDAP_OPT_X_TLS_CACERTFILE:
749 if ( lo->ldo_tls_cacertfile ) LDAP_FREE( lo->ldo_tls_cacertfile );
750 lo->ldo_tls_cacertfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
752 case LDAP_OPT_X_TLS_CACERTDIR:
753 if ( lo->ldo_tls_cacertdir ) LDAP_FREE( lo->ldo_tls_cacertdir );
754 lo->ldo_tls_cacertdir = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
756 case LDAP_OPT_X_TLS_CERTFILE:
757 if ( lo->ldo_tls_certfile ) LDAP_FREE( lo->ldo_tls_certfile );
758 lo->ldo_tls_certfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
760 case LDAP_OPT_X_TLS_KEYFILE:
761 if ( lo->ldo_tls_keyfile ) LDAP_FREE( lo->ldo_tls_keyfile );
762 lo->ldo_tls_keyfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
764 case LDAP_OPT_X_TLS_DHFILE:
765 if ( lo->ldo_tls_dhfile ) LDAP_FREE( lo->ldo_tls_dhfile );
766 lo->ldo_tls_dhfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
768 case LDAP_OPT_X_TLS_CRLFILE: /* GnuTLS only */
769 if ( lo->ldo_tls_crlfile ) LDAP_FREE( lo->ldo_tls_crlfile );
770 lo->ldo_tls_crlfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
772 case LDAP_OPT_X_TLS_REQUIRE_CERT:
773 if ( !arg ) return -1;
774 switch( *(int *) arg ) {
775 case LDAP_OPT_X_TLS_NEVER:
776 case LDAP_OPT_X_TLS_DEMAND:
777 case LDAP_OPT_X_TLS_ALLOW:
778 case LDAP_OPT_X_TLS_TRY:
779 case LDAP_OPT_X_TLS_HARD:
780 lo->ldo_tls_require_cert = * (int *) arg;
784 #ifdef HAVE_OPENSSL_CRL
785 case LDAP_OPT_X_TLS_CRLCHECK: /* OpenSSL only */
786 if ( !arg ) return -1;
787 switch( *(int *) arg ) {
788 case LDAP_OPT_X_TLS_CRL_NONE:
789 case LDAP_OPT_X_TLS_CRL_PEER:
790 case LDAP_OPT_X_TLS_CRL_ALL:
791 lo->ldo_tls_crlcheck = * (int *) arg;
796 case LDAP_OPT_X_TLS_CIPHER_SUITE:
797 if ( lo->ldo_tls_ciphersuite ) LDAP_FREE( lo->ldo_tls_ciphersuite );
798 lo->ldo_tls_ciphersuite = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
801 case LDAP_OPT_X_TLS_PROTOCOL_MIN:
802 if ( !arg ) return -1;
803 lo->ldo_tls_protocol_min = *(int *)arg;
805 case LDAP_OPT_X_TLS_RANDOM_FILE:
808 if ( lo->ldo_tls_randfile ) LDAP_FREE (lo->ldo_tls_randfile );
809 lo->ldo_tls_randfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
811 case LDAP_OPT_X_TLS_NEWCTX:
812 if ( !arg ) return -1;
813 if ( lo->ldo_tls_ctx )
814 ldap_pvt_tls_ctx_free( lo->ldo_tls_ctx );
815 lo->ldo_tls_ctx = NULL;
816 return ldap_int_tls_init_ctx( lo, *(int *)arg );
824 ldap_int_tls_start ( LDAP *ld, LDAPConn *conn, LDAPURLDesc *srv )
830 #ifdef LDAP_USE_NON_BLOCKING_TLS
831 struct timeval start_time_tv, tv, tv0;
832 ber_socket_t sd = AC_SOCKET_ERROR;
833 #endif /* LDAP_USE_NON_BLOCKING_TLS */
836 return LDAP_PARAM_ERROR;
840 host = srv->lud_host;
842 host = conn->lconn_server->lud_host;
845 /* avoid NULL host */
850 (void) tls_init( tls_imp );
852 #ifdef LDAP_USE_NON_BLOCKING_TLS
854 * Use non-blocking io during SSL Handshake when a timeout is configured
856 if ( ld->ld_options.ldo_tm_net.tv_sec >= 0 ) {
857 ber_sockbuf_ctrl( sb, LBER_SB_OPT_SET_NONBLOCK, (void*)1 );
858 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_FD, &sd );
859 tv = ld->ld_options.ldo_tm_net;
861 #ifdef HAVE_GETTIMEOFDAY
862 gettimeofday( &start_time_tv, NULL );
863 #else /* ! HAVE_GETTIMEOFDAY */
864 time( &start_time_tv.tv_sec );
865 start_time_tv.tv_usec = 0;
866 #endif /* ! HAVE_GETTIMEOFDAY */
869 #endif /* LDAP_USE_NON_BLOCKING_TLS */
871 ld->ld_errno = LDAP_SUCCESS;
872 ret = ldap_int_tls_connect( ld, conn, host );
874 #ifdef LDAP_USE_NON_BLOCKING_TLS
875 while ( ret > 0 ) { /* this should only happen for non-blocking io */
878 if ( sb->sb_trans_needs_read ) {
880 } else if ( sb->sb_trans_needs_write ) {
883 Debug( LDAP_DEBUG_TRACE, "ldap_int_tls_start: ldap_int_tls_connect needs %s\n",
884 wr ? "write": "read", 0, 0);
886 ret = ldap_int_poll( ld, sd, &tv, wr);
888 ld->ld_errno = LDAP_TIMEOUT;
891 /* ldap_int_poll called ldap_pvt_ndelay_off */
892 ber_sockbuf_ctrl( sb, LBER_SB_OPT_SET_NONBLOCK, (void*)1 );
893 ret = ldap_int_tls_connect( ld, conn, host );
894 if ( ret > 0 ) { /* need to call tls_connect once more */
895 struct timeval curr_time_tv, delta_tv;
897 /* This is mostly copied from result.c:wait4msg(), should
898 * probably be moved into a separate function */
899 #ifdef HAVE_GETTIMEOFDAY
900 gettimeofday( &curr_time_tv, NULL );
901 #else /* ! HAVE_GETTIMEOFDAY */
902 time( &curr_time_tv.tv_sec );
903 curr_time_tv.tv_usec = 0;
904 #endif /* ! HAVE_GETTIMEOFDAY */
906 /* delta = curr - start */
907 delta_tv.tv_sec = curr_time_tv.tv_sec - start_time_tv.tv_sec;
908 delta_tv.tv_usec = curr_time_tv.tv_usec - start_time_tv.tv_usec;
909 if ( delta_tv.tv_usec < 0 ) {
911 delta_tv.tv_usec += 1000000;
915 if ( ( tv0.tv_sec < delta_tv.tv_sec ) ||
916 ( ( tv0.tv_sec == delta_tv.tv_sec ) &&
917 ( tv0.tv_usec < delta_tv.tv_usec ) ) )
920 ld->ld_errno = LDAP_TIMEOUT;
923 /* timeout -= delta_time */
924 tv0.tv_sec -= delta_tv.tv_sec;
925 tv0.tv_usec -= delta_tv.tv_usec;
926 if ( tv0.tv_usec < 0 ) {
928 tv0.tv_usec += 1000000;
930 start_time_tv.tv_sec = curr_time_tv.tv_sec;
931 start_time_tv.tv_usec = curr_time_tv.tv_usec;
934 Debug( LDAP_DEBUG_TRACE, "ldap_int_tls_start: ld %p %ld s %ld us to go\n",
935 (void *)ld, (long) tv.tv_sec, (long) tv.tv_usec );
939 if ( ld->ld_options.ldo_tm_net.tv_sec >= 0 ) {
940 ber_sockbuf_ctrl( sb, LBER_SB_OPT_SET_NONBLOCK, NULL );
942 #endif /* LDAP_USE_NON_BLOCKING_TLS */
945 if ( ld->ld_errno == LDAP_SUCCESS )
946 ld->ld_errno = LDAP_CONNECT_ERROR;
947 return (ld->ld_errno);
954 ldap_pvt_tls_sb_ctx( Sockbuf *sb )
958 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&p );
963 ldap_pvt_tls_get_strength( void *s )
965 tls_session *session = s;
967 return tls_imp->ti_session_strength( session );
971 ldap_pvt_tls_get_my_dn( void *s, struct berval *dn, LDAPDN_rewrite_dummy *func, unsigned flags )
973 tls_session *session = s;
974 struct berval der_dn;
977 rc = tls_imp->ti_session_my_dn( session, &der_dn );
978 if ( rc == LDAP_SUCCESS )
979 rc = ldap_X509dn2bv(&der_dn, dn, (LDAPDN_rewrite_func *)func, flags );
982 #endif /* HAVE_TLS */
985 ldap_start_tls( LDAP *ld,
986 LDAPControl **serverctrls,
987 LDAPControl **clientctrls,
990 return ldap_extended_operation( ld, LDAP_EXOP_START_TLS,
991 NULL, serverctrls, clientctrls, msgidp );
995 ldap_install_tls( LDAP *ld )
998 return LDAP_NOT_SUPPORTED;
1000 if ( ldap_tls_inplace( ld ) ) {
1001 return LDAP_LOCAL_ERROR;
1004 return ldap_int_tls_start( ld, ld->ld_defconn, NULL );
1009 ldap_start_tls_s ( LDAP *ld,
1010 LDAPControl **serverctrls,
1011 LDAPControl **clientctrls )
1014 return LDAP_NOT_SUPPORTED;
1017 char *rspoid = NULL;
1018 struct berval *rspdata = NULL;
1020 /* XXYYZ: this initiates operation only on default connection! */
1022 if ( ldap_tls_inplace( ld ) ) {
1023 return LDAP_LOCAL_ERROR;
1026 rc = ldap_extended_operation_s( ld, LDAP_EXOP_START_TLS,
1027 NULL, serverctrls, clientctrls, &rspoid, &rspdata );
1029 if ( rspoid != NULL ) {
1033 if ( rspdata != NULL ) {
1034 ber_bvfree( rspdata );
1037 if ( rc == LDAP_SUCCESS ) {
1038 rc = ldap_int_tls_start( ld, ld->ld_defconn, NULL );
1045 /* These tags probably all belong in lber.h, but they're
1046 * not normally encountered when processing LDAP, so maybe
1047 * they belong somewhere else instead.
1050 #define LBER_TAG_OID ((ber_tag_t) 0x06UL)
1052 /* Tags for string types used in a DirectoryString.
1054 * Note that IA5string is not one of the defined choices for
1055 * DirectoryString in X.520, but it gets used for email AVAs.
1057 #define LBER_TAG_UTF8 ((ber_tag_t) 0x0cUL)
1058 #define LBER_TAG_PRINTABLE ((ber_tag_t) 0x13UL)
1059 #define LBER_TAG_TELETEX ((ber_tag_t) 0x14UL)
1060 #define LBER_TAG_IA5 ((ber_tag_t) 0x16UL)
1061 #define LBER_TAG_UNIVERSAL ((ber_tag_t) 0x1cUL)
1062 #define LBER_TAG_BMP ((ber_tag_t) 0x1eUL)
1065 find_oid( struct berval *oid )
1069 for ( i=0; !BER_BVISNULL( &oids[i].oid ); i++ ) {
1070 if ( oids[i].oid.bv_len != oid->bv_len ) continue;
1071 if ( !strcmp( oids[i].oid.bv_val, oid->bv_val ))
1077 /* Converts BER Bitstring value to LDAP BitString value (RFC4517)
1082 * berValue and ldapValue should not be NULL
1085 #define BITS_PER_BYTE 8
1086 #define SQUOTE_LENGTH 1
1087 #define B_CHAR_LENGTH 1
1088 #define STR_OVERHEAD (2*SQUOTE_LENGTH + B_CHAR_LENGTH)
1091 der_to_ldap_BitString (struct berval *berValue,
1092 struct berval *ldapValue)
1094 ber_len_t bitPadding=0;
1095 ber_len_t bits, maxBits;
1098 ber_len_t bitLength;
1100 unsigned char* valPtr;
1102 ldapValue->bv_len=0;
1103 ldapValue->bv_val=NULL;
1105 /* Gets padding and points to binary data */
1106 valLen=berValue->bv_len;
1107 valPtr=(unsigned char*)berValue->bv_val;
1109 bitPadding=(ber_len_t)(valPtr[0]);
1113 /* If Block is non DER encoding fixes to DER encoding */
1114 if (bitPadding >= BITS_PER_BYTE) {
1115 if (valLen*BITS_PER_BYTE > bitPadding ) {
1116 valLen-=(bitPadding/BITS_PER_BYTE);
1117 bitPadding%=BITS_PER_BYTE;
1123 /* Just in case bad encoding */
1124 if (valLen*BITS_PER_BYTE < bitPadding ) {
1129 /* Gets buffer to hold RFC4517 Bit String format */
1130 bitLength=valLen*BITS_PER_BYTE-bitPadding;
1131 tmpStr=LDAP_MALLOC(bitLength + STR_OVERHEAD + 1);
1134 return LDAP_NO_MEMORY;
1136 ldapValue->bv_val=tmpStr;
1137 ldapValue->bv_len=bitLength + STR_OVERHEAD;
1139 /* Formatting in '*binary-digit'B format */
1140 maxBits=BITS_PER_BYTE;
1145 maxBits-=bitPadding;
1146 for (bits=0; bits<maxBits; bits++) {
1161 return LDAP_SUCCESS;
1164 /* Convert a structured DN from an X.509 certificate into an LDAPV3 DN.
1165 * x509_name must be raw DER. If func is non-NULL, the
1166 * constructed DN will use numeric OIDs to identify attributeTypes,
1167 * and the func() will be invoked to rewrite the DN with the given
1170 * Otherwise the DN will use shortNames from a hardcoded table.
1173 ldap_X509dn2bv( void *x509_name, struct berval *bv, LDAPDN_rewrite_func *func,
1178 LDAPAVA *newAVA, *baseAVA;
1179 BerElementBuffer berbuf;
1180 BerElement *ber = (BerElement *)&berbuf;
1181 char oids[8192], *oidptr = oids, *oidbuf = NULL;
1183 char *dn_end, *rdn_end;
1184 int i, navas, nrdns, rc = LDAP_SUCCESS;
1185 size_t dnsize, oidrem = sizeof(oids), oidsize = 0;
1191 struct berval Oid, Val, oid2, *in = x509_name;
1193 assert( bv != NULL );
1201 /* A DN is a SEQUENCE of RDNs. An RDN is a SET of AVAs.
1202 * An AVA is a SEQUENCE of attr and value.
1203 * Count the number of AVAs and RDNs
1205 ber_init2( ber, in, LBER_USE_DER );
1206 tag = ber_peek_tag( ber, &len );
1207 if ( tag != LBER_SEQUENCE )
1208 return LDAP_DECODING_ERROR;
1210 for ( tag = ber_first_element( ber, &len, &dn_end );
1212 tag = ber_next_element( ber, &len, dn_end )) {
1214 for ( tag = ber_first_element( ber, &len, &rdn_end );
1215 tag == LBER_SEQUENCE;
1216 tag = ber_next_element( ber, &len, rdn_end )) {
1217 tag = ber_skip_tag( ber, &len );
1218 ber_skip_data( ber, len );
1223 /* Allocate the DN/RDN/AVA stuff as a single block */
1224 dnsize = sizeof(LDAPRDN) * (nrdns+1);
1225 dnsize += sizeof(LDAPAVA *) * (navas+nrdns);
1226 dnsize += sizeof(LDAPAVA) * navas;
1227 if (dnsize > sizeof(ptrs)) {
1228 newDN = (LDAPDN)LDAP_MALLOC( dnsize );
1229 if ( newDN == NULL )
1230 return LDAP_NO_MEMORY;
1232 newDN = (LDAPDN)(char *)ptrs;
1235 newDN[nrdns] = NULL;
1236 newRDN = (LDAPRDN)(newDN + nrdns+1);
1237 newAVA = (LDAPAVA *)(newRDN + navas + nrdns);
1240 /* Rewind and start extracting */
1243 tag = ber_first_element( ber, &len, &dn_end );
1244 for ( i = nrdns - 1; i >= 0; i-- ) {
1247 for ( tag = ber_first_element( ber, &len, &rdn_end );
1248 tag == LBER_SEQUENCE;
1249 tag = ber_next_element( ber, &len, rdn_end )) {
1252 tag = ber_skip_tag( ber, &len );
1253 tag = ber_get_stringbv( ber, &Oid, LBER_BV_NOTERM );
1254 if ( tag != LBER_TAG_OID ) {
1255 rc = LDAP_DECODING_ERROR;
1259 oid2.bv_val = oidptr;
1260 oid2.bv_len = oidrem;
1261 if ( ber_decode_oid( &Oid, &oid2 ) < 0 ) {
1262 rc = LDAP_DECODING_ERROR;
1265 oidname = find_oid( &oid2 );
1267 newAVA->la_attr = oid2;
1268 oidptr += oid2.bv_len + 1;
1269 oidrem -= oid2.bv_len + 1;
1271 /* Running out of OID buffer space? */
1273 if ( oidsize == 0 ) {
1274 oidsize = sizeof(oids) * 2;
1276 oidbuf = LDAP_MALLOC( oidsize );
1277 if ( oidbuf == NULL ) goto nomem;
1281 oidbuf = LDAP_REALLOC( oidbuf, oidsize*2 );
1282 if ( oidbuf == NULL ) goto nomem;
1283 /* Buffer moved! Fix AVA pointers */
1284 if ( old != oidbuf ) {
1286 long dif = oidbuf - old;
1288 for (a=baseAVA; a<=newAVA; a++){
1289 if (a->la_attr.bv_val >= old &&
1290 a->la_attr.bv_val <= (old + oidsize))
1291 a->la_attr.bv_val += dif;
1294 oidptr = oidbuf + oidsize - oidrem;
1301 newAVA->la_attr = oidname->oid;
1303 newAVA->la_attr = oidname->name;
1306 newAVA->la_private = NULL;
1307 newAVA->la_flags = LDAP_AVA_STRING;
1308 tag = ber_get_stringbv( ber, &Val, LBER_BV_NOTERM );
1310 case LBER_TAG_UNIVERSAL:
1311 /* This uses 32-bit ISO 10646-1 */
1312 csize = 4; goto to_utf8;
1314 /* This uses 16-bit ISO 10646-1 */
1315 csize = 2; goto to_utf8;
1316 case LBER_TAG_TELETEX:
1317 /* This uses 8-bit, assume ISO 8859-1 */
1319 to_utf8: rc = ldap_ucs_to_utf8s( &Val, csize, &newAVA->la_value );
1320 newAVA->la_flags |= LDAP_AVA_NONPRINTABLE;
1322 newAVA->la_flags |= LDAP_AVA_FREE_VALUE;
1323 if (rc != LDAP_SUCCESS) goto nomem;
1326 newAVA->la_flags |= LDAP_AVA_NONPRINTABLE;
1327 /* This is already in UTF-8 encoding */
1329 case LBER_TAG_PRINTABLE:
1330 /* These are always 7-bit strings */
1331 newAVA->la_value = Val;
1333 case LBER_BITSTRING:
1334 /* X.690 bitString value converted to RFC4517 Bit String */
1335 rc = der_to_ldap_BitString( &Val, &newAVA->la_value );
1338 /* Not a string type at all */
1339 newAVA->la_flags = 0;
1340 newAVA->la_value = Val;
1346 tag = ber_next_element( ber, &len, dn_end );
1350 rc = func( newDN, flags, NULL );
1351 if ( rc != LDAP_SUCCESS )
1355 rc = ldap_dn2bv_x( newDN, bv, LDAP_DN_FORMAT_LDAPV3, NULL );
1358 for (;baseAVA < newAVA; baseAVA++) {
1359 if (baseAVA->la_flags & LDAP_AVA_FREE_ATTR)
1360 LDAP_FREE( baseAVA->la_attr.bv_val );
1361 if (baseAVA->la_flags & LDAP_AVA_FREE_VALUE)
1362 LDAP_FREE( baseAVA->la_value.bv_val );
1366 LDAP_FREE( oidbuf );
1367 if ( newDN != (LDAPDN)(char *) ptrs )