1 /* tls.c - Handle tls/ssl. */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2015 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 )
46 #define LDAP_USE_NON_BLOCKING_TLS
48 /* RFC2459 minimum required set of supported attribute types
51 typedef struct oid_name {
56 static oid_name oids[] = {
57 { BER_BVC("2.5.4.3"), BER_BVC("cn") },
58 { BER_BVC("2.5.4.4"), BER_BVC("sn") },
59 { BER_BVC("2.5.4.6"), BER_BVC("c") },
60 { BER_BVC("2.5.4.7"), BER_BVC("l") },
61 { BER_BVC("2.5.4.8"), BER_BVC("st") },
62 { BER_BVC("2.5.4.10"), BER_BVC("o") },
63 { BER_BVC("2.5.4.11"), BER_BVC("ou") },
64 { BER_BVC("2.5.4.12"), BER_BVC("title") },
65 { BER_BVC("2.5.4.41"), BER_BVC("name") },
66 { BER_BVC("2.5.4.42"), BER_BVC("givenName") },
67 { BER_BVC("2.5.4.43"), BER_BVC("initials") },
68 { BER_BVC("2.5.4.44"), BER_BVC("generationQualifier") },
69 { BER_BVC("2.5.4.46"), BER_BVC("dnQualifier") },
70 { BER_BVC("1.2.840.113549.1.9.1"), BER_BVC("email") },
71 { BER_BVC("0.9.2342.19200300.100.1.25"), BER_BVC("dc") },
72 { BER_BVNULL, BER_BVNULL }
78 ldap_pvt_tls_ctx_free ( void *c )
81 tls_imp->ti_ctx_free( c );
85 tls_ctx_ref( tls_ctx *ctx )
89 tls_imp->ti_ctx_ref( ctx );
94 * an extra mutex for the default ctx.
96 static ldap_pvt_thread_mutex_t tls_def_ctx_mutex;
100 ldap_int_tls_destroy( struct ldapoptions *lo )
102 if ( lo->ldo_tls_ctx ) {
103 ldap_pvt_tls_ctx_free( lo->ldo_tls_ctx );
104 lo->ldo_tls_ctx = NULL;
107 if ( lo->ldo_tls_certfile ) {
108 LDAP_FREE( lo->ldo_tls_certfile );
109 lo->ldo_tls_certfile = NULL;
111 if ( lo->ldo_tls_keyfile ) {
112 LDAP_FREE( lo->ldo_tls_keyfile );
113 lo->ldo_tls_keyfile = NULL;
115 if ( lo->ldo_tls_dhfile ) {
116 LDAP_FREE( lo->ldo_tls_dhfile );
117 lo->ldo_tls_dhfile = NULL;
119 if ( lo->ldo_tls_ecname ) {
120 LDAP_FREE( lo->ldo_tls_ecname );
121 lo->ldo_tls_ecname = NULL;
123 if ( lo->ldo_tls_cacertfile ) {
124 LDAP_FREE( lo->ldo_tls_cacertfile );
125 lo->ldo_tls_cacertfile = NULL;
127 if ( lo->ldo_tls_cacertdir ) {
128 LDAP_FREE( lo->ldo_tls_cacertdir );
129 lo->ldo_tls_cacertdir = NULL;
131 if ( lo->ldo_tls_ciphersuite ) {
132 LDAP_FREE( lo->ldo_tls_ciphersuite );
133 lo->ldo_tls_ciphersuite = NULL;
135 if ( lo->ldo_tls_crlfile ) {
136 LDAP_FREE( lo->ldo_tls_crlfile );
137 lo->ldo_tls_crlfile = NULL;
142 * Tear down the TLS subsystem. Should only be called once.
145 ldap_pvt_tls_destroy( void )
147 struct ldapoptions *lo = LDAP_INT_GLOBAL_OPT();
149 ldap_int_tls_destroy( lo );
151 tls_imp->ti_tls_destroy();
155 * Initialize a particular TLS implementation.
156 * Called once per implementation.
159 tls_init(tls_impl *impl )
161 static int tls_initialized = 0;
163 if ( !tls_initialized++ ) {
164 #ifdef LDAP_R_COMPILE
165 ldap_pvt_thread_mutex_init( &tls_def_ctx_mutex );
169 if ( impl->ti_inited++ ) return 0;
171 #ifdef LDAP_R_COMPILE
174 return impl->ti_tls_init();
178 * Initialize TLS subsystem. Called once per implementation.
181 ldap_pvt_tls_init( void )
183 return tls_init( tls_imp );
187 * initialize a new TLS context
190 ldap_int_tls_init_ctx( struct ldapoptions *lo, int is_server )
193 tls_impl *ti = tls_imp;
194 struct ldaptls lts = lo->ldo_tls_info;
196 if ( lo->ldo_tls_ctx )
201 if ( is_server && !lts.lt_certfile && !lts.lt_keyfile &&
202 !lts.lt_cacertfile && !lts.lt_cacertdir ) {
203 /* minimum configuration not provided */
204 return LDAP_NOT_SUPPORTED;
208 /* This ASCII/EBCDIC handling is a real pain! */
209 if ( lts.lt_ciphersuite ) {
210 lts.lt_ciphersuite = LDAP_STRDUP( lts.lt_ciphersuite );
211 __atoe( lts.lt_ciphersuite );
213 if ( lts.lt_cacertfile ) {
214 lts.lt_cacertfile = LDAP_STRDUP( lts.lt_cacertfile );
215 __atoe( lts.lt_cacertfile );
217 if ( lts.lt_certfile ) {
218 lts.lt_certfile = LDAP_STRDUP( lts.lt_certfile );
219 __atoe( lts.lt_certfile );
221 if ( lts.lt_keyfile ) {
222 lts.lt_keyfile = LDAP_STRDUP( lts.lt_keyfile );
223 __atoe( lts.lt_keyfile );
225 if ( lts.lt_crlfile ) {
226 lts.lt_crlfile = LDAP_STRDUP( lts.lt_crlfile );
227 __atoe( lts.lt_crlfile );
229 if ( lts.lt_cacertdir ) {
230 lts.lt_cacertdir = LDAP_STRDUP( lts.lt_cacertdir );
231 __atoe( lts.lt_cacertdir );
233 if ( lts.lt_dhfile ) {
234 lts.lt_dhfile = LDAP_STRDUP( lts.lt_dhfile );
235 __atoe( lts.lt_dhfile );
237 if ( lts.lt_ecname ) {
238 lts.lt_ecname = LDAP_STRDUP( lts.lt_ecname );
239 __atoe( lts.lt_ecname );
242 lo->ldo_tls_ctx = ti->ti_ctx_new( lo );
243 if ( lo->ldo_tls_ctx == NULL ) {
244 Debug( LDAP_DEBUG_ANY,
245 "TLS: could not allocate default ctx.\n",
251 rc = ti->ti_ctx_init( lo, <s, is_server );
254 if ( rc < 0 && lo->ldo_tls_ctx != NULL ) {
255 ldap_pvt_tls_ctx_free( lo->ldo_tls_ctx );
256 lo->ldo_tls_ctx = NULL;
259 LDAP_FREE( lts.lt_ciphersuite );
260 LDAP_FREE( lts.lt_cacertfile );
261 LDAP_FREE( lts.lt_certfile );
262 LDAP_FREE( lts.lt_keyfile );
263 LDAP_FREE( lts.lt_crlfile );
264 LDAP_FREE( lts.lt_cacertdir );
265 LDAP_FREE( lts.lt_dhfile );
266 LDAP_FREE( lts.lt_ecname );
272 * initialize the default context
275 ldap_pvt_tls_init_def_ctx( int is_server )
277 struct ldapoptions *lo = LDAP_INT_GLOBAL_OPT();
279 LDAP_MUTEX_LOCK( &tls_def_ctx_mutex );
280 rc = ldap_int_tls_init_ctx( lo, is_server );
281 LDAP_MUTEX_UNLOCK( &tls_def_ctx_mutex );
286 alloc_handle( void *ctx_arg, int is_server )
294 struct ldapoptions *lo = LDAP_INT_GLOBAL_OPT();
295 if ( ldap_pvt_tls_init_def_ctx( is_server ) < 0 ) return NULL;
296 ctx = lo->ldo_tls_ctx;
299 ssl = tls_imp->ti_session_new( ctx, is_server );
301 Debug( LDAP_DEBUG_ANY,"TLS: can't create ssl handle.\n",0,0,0);
308 update_flags( Sockbuf *sb, tls_session * ssl, int rc )
310 sb->sb_trans_needs_read = 0;
311 sb->sb_trans_needs_write = 0;
313 return tls_imp->ti_session_upflags( sb, ssl, rc );
317 * Call this to do a TLS connect on a sockbuf. ctx_arg can be
318 * a SSL_CTX * or NULL, in which case the default ctx is used.
322 * 0 - Success. Connection is ready for communication.
323 * <0 - Error. Can't create a TLS stream.
324 * >0 - Partial success.
325 * Do a select (using information from lber_pvt_sb_needs_{read,write}
330 ldap_int_tls_connect( LDAP *ld, LDAPConn *conn )
332 Sockbuf *sb = conn->lconn_sb;
334 tls_session *ssl = NULL;
336 if ( HAS_TLS( sb )) {
337 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
339 struct ldapoptions *lo;
342 ctx = ld->ld_options.ldo_tls_ctx;
344 ssl = alloc_handle( ctx, 0 );
346 if ( ssl == NULL ) return -1;
349 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
350 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
352 ber_sockbuf_add_io( sb, tls_imp->ti_sbio,
353 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
355 lo = LDAP_INT_GLOBAL_OPT();
357 ctx = lo->ldo_tls_ctx;
358 ld->ld_options.ldo_tls_ctx = ctx;
361 if ( ld->ld_options.ldo_tls_connect_cb )
362 ld->ld_options.ldo_tls_connect_cb( ld, ssl, ctx,
363 ld->ld_options.ldo_tls_connect_arg );
364 if ( lo && lo->ldo_tls_connect_cb && lo->ldo_tls_connect_cb !=
365 ld->ld_options.ldo_tls_connect_cb )
366 lo->ldo_tls_connect_cb( ld, ssl, ctx, lo->ldo_tls_connect_arg );
369 err = tls_imp->ti_session_connect( ld, ssl );
372 errno = WSAGetLastError();
378 if ( update_flags( sb, ssl, err )) {
382 msg = tls_imp->ti_session_errmsg( ssl, err, buf, sizeof(buf) );
384 if ( ld->ld_error ) {
385 LDAP_FREE( ld->ld_error );
387 ld->ld_error = LDAP_STRDUP( msg );
389 if ( ld->ld_error ) __etoa(ld->ld_error);
393 Debug( LDAP_DEBUG_ANY,"TLS: can't connect: %s.\n",
394 ld->ld_error ? ld->ld_error : "" ,0,0);
396 ber_sockbuf_remove_io( sb, tls_imp->ti_sbio,
397 LBER_SBIOD_LEVEL_TRANSPORT );
399 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
400 LBER_SBIOD_LEVEL_TRANSPORT );
409 * Call this to do a TLS accept on a sockbuf.
410 * Everything else is the same as with tls_connect.
413 ldap_pvt_tls_accept( Sockbuf *sb, void *ctx_arg )
416 tls_session *ssl = NULL;
418 if ( HAS_TLS( sb )) {
419 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
421 ssl = alloc_handle( ctx_arg, 1 );
422 if ( ssl == NULL ) return -1;
425 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
426 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
428 ber_sockbuf_add_io( sb, tls_imp->ti_sbio,
429 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
432 err = tls_imp->ti_session_accept( ssl );
435 errno = WSAGetLastError();
440 if ( update_flags( sb, ssl, err )) return 1;
442 if ( DebugTest( LDAP_DEBUG_ANY ) ) {
444 msg = tls_imp->ti_session_errmsg( ssl, err, buf, sizeof(buf) );
445 Debug( LDAP_DEBUG_ANY,"TLS: can't accept: %s.\n",
446 msg ? msg : "(unknown)", 0, 0 );
449 ber_sockbuf_remove_io( sb, tls_imp->ti_sbio,
450 LBER_SBIOD_LEVEL_TRANSPORT );
452 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
453 LBER_SBIOD_LEVEL_TRANSPORT );
461 ldap_pvt_tls_inplace ( Sockbuf *sb )
463 return HAS_TLS( sb ) ? 1 : 0;
467 ldap_tls_inplace( LDAP *ld )
471 if ( ld->ld_defconn && ld->ld_defconn->lconn_sb ) {
472 sb = ld->ld_defconn->lconn_sb;
474 } else if ( ld->ld_sb ) {
481 return ldap_pvt_tls_inplace( sb );
485 ldap_pvt_tls_get_peer_dn( void *s, struct berval *dn,
486 LDAPDN_rewrite_dummy *func, unsigned flags )
488 tls_session *session = s;
492 rc = tls_imp->ti_session_peer_dn( session, &bvdn );
495 rc = ldap_X509dn2bv( &bvdn, dn,
496 (LDAPDN_rewrite_func *)func, flags);
501 ldap_pvt_tls_check_hostname( LDAP *ld, void *s, const char *name_in )
503 tls_session *session = s;
505 return tls_imp->ti_session_chkhost( ld, session, name_in );
509 ldap_pvt_tls_config( LDAP *ld, int option, const char *arg )
514 case LDAP_OPT_X_TLS_CACERTFILE:
515 case LDAP_OPT_X_TLS_CACERTDIR:
516 case LDAP_OPT_X_TLS_CERTFILE:
517 case LDAP_OPT_X_TLS_KEYFILE:
518 case LDAP_OPT_X_TLS_RANDOM_FILE:
519 case LDAP_OPT_X_TLS_CIPHER_SUITE:
520 case LDAP_OPT_X_TLS_DHFILE:
521 case LDAP_OPT_X_TLS_CRLFILE: /* GnuTLS only */
522 return ldap_pvt_tls_set_option( ld, option, (void *) arg );
524 case LDAP_OPT_X_TLS_REQUIRE_CERT:
527 if ( strcasecmp( arg, "never" ) == 0 ) {
528 i = LDAP_OPT_X_TLS_NEVER ;
530 } else if ( strcasecmp( arg, "demand" ) == 0 ) {
531 i = LDAP_OPT_X_TLS_DEMAND ;
533 } else if ( strcasecmp( arg, "allow" ) == 0 ) {
534 i = LDAP_OPT_X_TLS_ALLOW ;
536 } else if ( strcasecmp( arg, "try" ) == 0 ) {
537 i = LDAP_OPT_X_TLS_TRY ;
539 } else if ( ( strcasecmp( arg, "hard" ) == 0 ) ||
540 ( strcasecmp( arg, "on" ) == 0 ) ||
541 ( strcasecmp( arg, "yes" ) == 0) ||
542 ( strcasecmp( arg, "true" ) == 0 ) )
544 i = LDAP_OPT_X_TLS_HARD ;
548 return ldap_pvt_tls_set_option( ld, option, &i );
551 case LDAP_OPT_X_TLS_PROTOCOL_MIN: {
554 l = strtol( arg, &next, 10 );
555 if ( l < 0 || l > 0xff || next == arg ||
556 ( *next != '\0' && *next != '.' ) )
561 l = strtol( arg, &next, 10 );
562 if ( l < 0 || l > 0xff || next == arg || *next != '\0' )
566 return ldap_pvt_tls_set_option( ld, option, &i );
568 #ifdef HAVE_OPENSSL_CRL
569 case LDAP_OPT_X_TLS_CRLCHECK: /* OpenSSL only */
571 if ( strcasecmp( arg, "none" ) == 0 ) {
572 i = LDAP_OPT_X_TLS_CRL_NONE ;
573 } else if ( strcasecmp( arg, "peer" ) == 0 ) {
574 i = LDAP_OPT_X_TLS_CRL_PEER ;
575 } else if ( strcasecmp( arg, "all" ) == 0 ) {
576 i = LDAP_OPT_X_TLS_CRL_ALL ;
579 return ldap_pvt_tls_set_option( ld, option, &i );
588 ldap_pvt_tls_get_option( LDAP *ld, int option, void *arg )
590 struct ldapoptions *lo;
592 if( option == LDAP_OPT_X_TLS_PACKAGE ) {
593 *(char **)arg = LDAP_STRDUP( tls_imp->ti_name );
598 assert( LDAP_VALID( ld ) );
600 if( !LDAP_VALID( ld ) ) {
601 return LDAP_OPT_ERROR;
604 lo = &ld->ld_options;
607 /* Get pointer to global option structure */
608 lo = LDAP_INT_GLOBAL_OPT();
610 return LDAP_NO_MEMORY;
616 *(int *)arg = lo->ldo_tls_mode;
618 case LDAP_OPT_X_TLS_CTX:
619 *(void **)arg = lo->ldo_tls_ctx;
620 if ( lo->ldo_tls_ctx ) {
621 tls_ctx_ref( lo->ldo_tls_ctx );
624 case LDAP_OPT_X_TLS_CACERTFILE:
625 *(char **)arg = lo->ldo_tls_cacertfile ?
626 LDAP_STRDUP( lo->ldo_tls_cacertfile ) : NULL;
628 case LDAP_OPT_X_TLS_CACERTDIR:
629 *(char **)arg = lo->ldo_tls_cacertdir ?
630 LDAP_STRDUP( lo->ldo_tls_cacertdir ) : NULL;
632 case LDAP_OPT_X_TLS_CERTFILE:
633 *(char **)arg = lo->ldo_tls_certfile ?
634 LDAP_STRDUP( lo->ldo_tls_certfile ) : NULL;
636 case LDAP_OPT_X_TLS_KEYFILE:
637 *(char **)arg = lo->ldo_tls_keyfile ?
638 LDAP_STRDUP( lo->ldo_tls_keyfile ) : NULL;
640 case LDAP_OPT_X_TLS_DHFILE:
641 *(char **)arg = lo->ldo_tls_dhfile ?
642 LDAP_STRDUP( lo->ldo_tls_dhfile ) : NULL;
644 case LDAP_OPT_X_TLS_ECNAME:
645 *(char **)arg = lo->ldo_tls_ecname ?
646 LDAP_STRDUP( lo->ldo_tls_ecname ) : NULL;
648 case LDAP_OPT_X_TLS_CRLFILE: /* GnuTLS only */
649 *(char **)arg = lo->ldo_tls_crlfile ?
650 LDAP_STRDUP( lo->ldo_tls_crlfile ) : NULL;
652 case LDAP_OPT_X_TLS_REQUIRE_CERT:
653 *(int *)arg = lo->ldo_tls_require_cert;
655 #ifdef HAVE_OPENSSL_CRL
656 case LDAP_OPT_X_TLS_CRLCHECK: /* OpenSSL only */
657 *(int *)arg = lo->ldo_tls_crlcheck;
660 case LDAP_OPT_X_TLS_CIPHER_SUITE:
661 *(char **)arg = lo->ldo_tls_ciphersuite ?
662 LDAP_STRDUP( lo->ldo_tls_ciphersuite ) : NULL;
664 case LDAP_OPT_X_TLS_PROTOCOL_MIN:
665 *(int *)arg = lo->ldo_tls_protocol_min;
667 case LDAP_OPT_X_TLS_RANDOM_FILE:
668 *(char **)arg = lo->ldo_tls_randfile ?
669 LDAP_STRDUP( lo->ldo_tls_randfile ) : NULL;
671 case LDAP_OPT_X_TLS_SSL_CTX: {
674 LDAPConn *conn = ld->ld_defconn;
675 if ( conn != NULL ) {
676 Sockbuf *sb = conn->lconn_sb;
677 retval = ldap_pvt_tls_sb_ctx( sb );
680 *(void **)arg = retval;
683 case LDAP_OPT_X_TLS_CONNECT_CB:
684 *(LDAP_TLS_CONNECT_CB **)arg = lo->ldo_tls_connect_cb;
686 case LDAP_OPT_X_TLS_CONNECT_ARG:
687 *(void **)arg = lo->ldo_tls_connect_arg;
689 case LDAP_OPT_X_TLS_VERSION: {
691 const char *retval = NULL;
693 LDAPConn *conn = ld->ld_defconn;
694 if ( conn != NULL ) {
695 Sockbuf *sb = conn->lconn_sb;
696 sess = ldap_pvt_tls_sb_ctx( sb );
698 retval = ldap_pvt_tls_get_version( sess );
701 *(char **)arg = retval ? LDAP_STRDUP( retval ) : NULL;
704 case LDAP_OPT_X_TLS_CIPHER: {
706 const char *retval = NULL;
708 LDAPConn *conn = ld->ld_defconn;
709 if ( conn != NULL ) {
710 Sockbuf *sb = conn->lconn_sb;
711 sess = ldap_pvt_tls_sb_ctx( sb );
713 retval = ldap_pvt_tls_get_cipher( sess );
716 *(char **)arg = retval ? LDAP_STRDUP( retval ) : NULL;
719 case LDAP_OPT_X_TLS_PEERCERT: {
721 struct berval *bv = arg;
725 LDAPConn *conn = ld->ld_defconn;
726 if ( conn != NULL ) {
727 Sockbuf *sb = conn->lconn_sb;
728 sess = ldap_pvt_tls_sb_ctx( sb );
730 return ldap_pvt_tls_get_peercert( sess, bv );
743 ldap_pvt_tls_set_option( LDAP *ld, int option, void *arg )
745 struct ldapoptions *lo;
748 assert( LDAP_VALID( ld ) );
750 if( !LDAP_VALID( ld ) ) {
751 return LDAP_OPT_ERROR;
754 lo = &ld->ld_options;
757 /* Get pointer to global option structure */
758 lo = LDAP_INT_GLOBAL_OPT();
760 return LDAP_NO_MEMORY;
766 if ( !arg ) return -1;
768 switch( *(int *) arg ) {
769 case LDAP_OPT_X_TLS_NEVER:
770 case LDAP_OPT_X_TLS_DEMAND:
771 case LDAP_OPT_X_TLS_ALLOW:
772 case LDAP_OPT_X_TLS_TRY:
773 case LDAP_OPT_X_TLS_HARD:
775 lo->ldo_tls_mode = *(int *)arg;
782 case LDAP_OPT_X_TLS_CTX:
783 if ( lo->ldo_tls_ctx )
784 ldap_pvt_tls_ctx_free( lo->ldo_tls_ctx );
785 lo->ldo_tls_ctx = arg;
786 tls_ctx_ref( lo->ldo_tls_ctx );
788 case LDAP_OPT_X_TLS_CONNECT_CB:
789 lo->ldo_tls_connect_cb = (LDAP_TLS_CONNECT_CB *)arg;
791 case LDAP_OPT_X_TLS_CONNECT_ARG:
792 lo->ldo_tls_connect_arg = arg;
794 case LDAP_OPT_X_TLS_CACERTFILE:
795 if ( lo->ldo_tls_cacertfile ) LDAP_FREE( lo->ldo_tls_cacertfile );
796 lo->ldo_tls_cacertfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
798 case LDAP_OPT_X_TLS_CACERTDIR:
799 if ( lo->ldo_tls_cacertdir ) LDAP_FREE( lo->ldo_tls_cacertdir );
800 lo->ldo_tls_cacertdir = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
802 case LDAP_OPT_X_TLS_CERTFILE:
803 if ( lo->ldo_tls_certfile ) LDAP_FREE( lo->ldo_tls_certfile );
804 lo->ldo_tls_certfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
806 case LDAP_OPT_X_TLS_KEYFILE:
807 if ( lo->ldo_tls_keyfile ) LDAP_FREE( lo->ldo_tls_keyfile );
808 lo->ldo_tls_keyfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
810 case LDAP_OPT_X_TLS_DHFILE:
811 if ( lo->ldo_tls_dhfile ) LDAP_FREE( lo->ldo_tls_dhfile );
812 lo->ldo_tls_dhfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
814 case LDAP_OPT_X_TLS_ECNAME:
815 if ( lo->ldo_tls_ecname ) LDAP_FREE( lo->ldo_tls_ecname );
816 lo->ldo_tls_ecname = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
818 case LDAP_OPT_X_TLS_CRLFILE: /* GnuTLS only */
819 if ( lo->ldo_tls_crlfile ) LDAP_FREE( lo->ldo_tls_crlfile );
820 lo->ldo_tls_crlfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
822 case LDAP_OPT_X_TLS_REQUIRE_CERT:
823 if ( !arg ) return -1;
824 switch( *(int *) arg ) {
825 case LDAP_OPT_X_TLS_NEVER:
826 case LDAP_OPT_X_TLS_DEMAND:
827 case LDAP_OPT_X_TLS_ALLOW:
828 case LDAP_OPT_X_TLS_TRY:
829 case LDAP_OPT_X_TLS_HARD:
830 lo->ldo_tls_require_cert = * (int *) arg;
834 #ifdef HAVE_OPENSSL_CRL
835 case LDAP_OPT_X_TLS_CRLCHECK: /* OpenSSL only */
836 if ( !arg ) return -1;
837 switch( *(int *) arg ) {
838 case LDAP_OPT_X_TLS_CRL_NONE:
839 case LDAP_OPT_X_TLS_CRL_PEER:
840 case LDAP_OPT_X_TLS_CRL_ALL:
841 lo->ldo_tls_crlcheck = * (int *) arg;
846 case LDAP_OPT_X_TLS_CIPHER_SUITE:
847 if ( lo->ldo_tls_ciphersuite ) LDAP_FREE( lo->ldo_tls_ciphersuite );
848 lo->ldo_tls_ciphersuite = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
851 case LDAP_OPT_X_TLS_PROTOCOL_MIN:
852 if ( !arg ) return -1;
853 lo->ldo_tls_protocol_min = *(int *)arg;
855 case LDAP_OPT_X_TLS_RANDOM_FILE:
858 if ( lo->ldo_tls_randfile ) LDAP_FREE (lo->ldo_tls_randfile );
859 lo->ldo_tls_randfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
861 case LDAP_OPT_X_TLS_NEWCTX:
862 if ( !arg ) return -1;
863 if ( lo->ldo_tls_ctx )
864 ldap_pvt_tls_ctx_free( lo->ldo_tls_ctx );
865 lo->ldo_tls_ctx = NULL;
866 return ldap_int_tls_init_ctx( lo, *(int *)arg );
874 ldap_int_tls_start ( LDAP *ld, LDAPConn *conn, LDAPURLDesc *srv )
880 #ifdef LDAP_USE_NON_BLOCKING_TLS
881 struct timeval start_time_tv, tv, tv0;
882 ber_socket_t sd = AC_SOCKET_ERROR;
883 #endif /* LDAP_USE_NON_BLOCKING_TLS */
886 return LDAP_PARAM_ERROR;
890 host = srv->lud_host;
892 host = conn->lconn_server->lud_host;
895 /* avoid NULL host */
900 (void) tls_init( tls_imp );
902 #ifdef LDAP_USE_NON_BLOCKING_TLS
904 * Use non-blocking io during SSL Handshake when a timeout is configured
906 if ( ld->ld_options.ldo_tm_net.tv_sec >= 0 ) {
907 ber_sockbuf_ctrl( ld->ld_sb, LBER_SB_OPT_SET_NONBLOCK, sb );
908 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_FD, &sd );
909 tv = ld->ld_options.ldo_tm_net;
911 #ifdef HAVE_GETTIMEOFDAY
912 gettimeofday( &start_time_tv, NULL );
913 #else /* ! HAVE_GETTIMEOFDAY */
914 time( &start_time_tv.tv_sec );
915 start_time_tv.tv_usec = 0;
916 #endif /* ! HAVE_GETTIMEOFDAY */
919 #endif /* LDAP_USE_NON_BLOCKING_TLS */
921 ld->ld_errno = LDAP_SUCCESS;
922 ret = ldap_int_tls_connect( ld, conn );
924 #ifdef LDAP_USE_NON_BLOCKING_TLS
925 while ( ret > 0 ) { /* this should only happen for non-blocking io */
928 if ( sb->sb_trans_needs_read ) {
930 } else if ( sb->sb_trans_needs_write ) {
933 Debug( LDAP_DEBUG_TRACE, "ldap_int_tls_start: ldap_int_tls_connect needs %s\n",
934 wr ? "write": "read", 0, 0);
936 ret = ldap_int_poll( ld, sd, &tv, wr);
938 ld->ld_errno = LDAP_TIMEOUT;
941 /* ldap_int_poll called ldap_pvt_ndelay_off */
942 ber_sockbuf_ctrl( ld->ld_sb, LBER_SB_OPT_SET_NONBLOCK, sb );
943 ret = ldap_int_tls_connect( ld, conn );
944 if ( ret > 0 ) { /* need to call tls_connect once more */
945 struct timeval curr_time_tv, delta_tv;
947 /* This is mostly copied from result.c:wait4msg(), should
948 * probably be moved into a separate function */
949 #ifdef HAVE_GETTIMEOFDAY
950 gettimeofday( &curr_time_tv, NULL );
951 #else /* ! HAVE_GETTIMEOFDAY */
952 time( &curr_time_tv.tv_sec );
953 curr_time_tv.tv_usec = 0;
954 #endif /* ! HAVE_GETTIMEOFDAY */
956 /* delta = curr - start */
957 delta_tv.tv_sec = curr_time_tv.tv_sec - start_time_tv.tv_sec;
958 delta_tv.tv_usec = curr_time_tv.tv_usec - start_time_tv.tv_usec;
959 if ( delta_tv.tv_usec < 0 ) {
961 delta_tv.tv_usec += 1000000;
965 if ( ( tv0.tv_sec < delta_tv.tv_sec ) ||
966 ( ( tv0.tv_sec == delta_tv.tv_sec ) &&
967 ( tv0.tv_usec < delta_tv.tv_usec ) ) )
970 ld->ld_errno = LDAP_TIMEOUT;
973 /* timeout -= delta_time */
974 tv0.tv_sec -= delta_tv.tv_sec;
975 tv0.tv_usec -= delta_tv.tv_usec;
976 if ( tv0.tv_usec < 0 ) {
978 tv0.tv_usec += 1000000;
980 start_time_tv.tv_sec = curr_time_tv.tv_sec;
981 start_time_tv.tv_usec = curr_time_tv.tv_usec;
984 Debug( LDAP_DEBUG_TRACE, "ldap_int_tls_start: ld %p %ld s %ld us to go\n",
985 (void *)ld, (long) tv.tv_sec, (long) tv.tv_usec );
989 if ( ld->ld_options.ldo_tm_net.tv_sec >= 0 ) {
990 ber_sockbuf_ctrl( ld->ld_sb, LBER_SB_OPT_SET_NONBLOCK, NULL );
992 #endif /* LDAP_USE_NON_BLOCKING_TLS */
995 if ( ld->ld_errno == LDAP_SUCCESS )
996 ld->ld_errno = LDAP_CONNECT_ERROR;
997 return (ld->ld_errno);
1000 ssl = ldap_pvt_tls_sb_ctx( sb );
1001 assert( ssl != NULL );
1004 * compare host with name(s) in certificate
1006 if (ld->ld_options.ldo_tls_require_cert != LDAP_OPT_X_TLS_NEVER &&
1007 ld->ld_options.ldo_tls_require_cert != LDAP_OPT_X_TLS_ALLOW) {
1008 ld->ld_errno = ldap_pvt_tls_check_hostname( ld, ssl, host );
1009 if (ld->ld_errno != LDAP_SUCCESS) {
1010 return ld->ld_errno;
1014 return LDAP_SUCCESS;
1018 ldap_pvt_tls_sb_ctx( Sockbuf *sb )
1022 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&p );
1027 ldap_pvt_tls_get_strength( void *s )
1029 tls_session *session = s;
1031 return tls_imp->ti_session_strength( session );
1035 ldap_pvt_tls_get_my_dn( void *s, struct berval *dn, LDAPDN_rewrite_dummy *func, unsigned flags )
1037 tls_session *session = s;
1038 struct berval der_dn;
1041 rc = tls_imp->ti_session_my_dn( session, &der_dn );
1042 if ( rc == LDAP_SUCCESS )
1043 rc = ldap_X509dn2bv(&der_dn, dn, (LDAPDN_rewrite_func *)func, flags );
1048 ldap_pvt_tls_get_unique( void *s, struct berval *buf, int is_server )
1050 tls_session *session = s;
1051 return tls_imp->ti_session_unique( session, buf, is_server );
1055 ldap_pvt_tls_get_version( void *s )
1057 tls_session *session = s;
1058 return tls_imp->ti_session_version( session );
1062 ldap_pvt_tls_get_cipher( void *s )
1064 tls_session *session = s;
1065 return tls_imp->ti_session_cipher( session );
1069 ldap_pvt_tls_get_peercert( void *s, struct berval *der )
1071 tls_session *session = s;
1072 return tls_imp->ti_session_peercert( session, der );
1074 #endif /* HAVE_TLS */
1077 ldap_start_tls( LDAP *ld,
1078 LDAPControl **serverctrls,
1079 LDAPControl **clientctrls,
1082 return ldap_extended_operation( ld, LDAP_EXOP_START_TLS,
1083 NULL, serverctrls, clientctrls, msgidp );
1087 ldap_install_tls( LDAP *ld )
1090 return LDAP_NOT_SUPPORTED;
1092 if ( ldap_tls_inplace( ld ) ) {
1093 return LDAP_LOCAL_ERROR;
1096 return ldap_int_tls_start( ld, ld->ld_defconn, NULL );
1101 ldap_start_tls_s ( LDAP *ld,
1102 LDAPControl **serverctrls,
1103 LDAPControl **clientctrls )
1106 return LDAP_NOT_SUPPORTED;
1109 char *rspoid = NULL;
1110 struct berval *rspdata = NULL;
1112 /* XXYYZ: this initiates operation only on default connection! */
1114 if ( ldap_tls_inplace( ld ) ) {
1115 return LDAP_LOCAL_ERROR;
1118 rc = ldap_extended_operation_s( ld, LDAP_EXOP_START_TLS,
1119 NULL, serverctrls, clientctrls, &rspoid, &rspdata );
1121 if ( rspoid != NULL ) {
1125 if ( rspdata != NULL ) {
1126 ber_bvfree( rspdata );
1129 if ( rc == LDAP_SUCCESS ) {
1130 rc = ldap_int_tls_start( ld, ld->ld_defconn, NULL );
1137 /* These tags probably all belong in lber.h, but they're
1138 * not normally encountered when processing LDAP, so maybe
1139 * they belong somewhere else instead.
1142 #define LBER_TAG_OID ((ber_tag_t) 0x06UL)
1144 /* Tags for string types used in a DirectoryString.
1146 * Note that IA5string is not one of the defined choices for
1147 * DirectoryString in X.520, but it gets used for email AVAs.
1149 #define LBER_TAG_UTF8 ((ber_tag_t) 0x0cUL)
1150 #define LBER_TAG_PRINTABLE ((ber_tag_t) 0x13UL)
1151 #define LBER_TAG_TELETEX ((ber_tag_t) 0x14UL)
1152 #define LBER_TAG_IA5 ((ber_tag_t) 0x16UL)
1153 #define LBER_TAG_UNIVERSAL ((ber_tag_t) 0x1cUL)
1154 #define LBER_TAG_BMP ((ber_tag_t) 0x1eUL)
1157 find_oid( struct berval *oid )
1161 for ( i=0; !BER_BVISNULL( &oids[i].oid ); i++ ) {
1162 if ( oids[i].oid.bv_len != oid->bv_len ) continue;
1163 if ( !strcmp( oids[i].oid.bv_val, oid->bv_val ))
1169 /* Converts BER Bitstring value to LDAP BitString value (RFC4517)
1174 * berValue and ldapValue should not be NULL
1177 #define BITS_PER_BYTE 8
1178 #define SQUOTE_LENGTH 1
1179 #define B_CHAR_LENGTH 1
1180 #define STR_OVERHEAD (2*SQUOTE_LENGTH + B_CHAR_LENGTH)
1183 der_to_ldap_BitString (struct berval *berValue,
1184 struct berval *ldapValue)
1186 ber_len_t bitPadding=0;
1187 ber_len_t bits, maxBits;
1190 ber_len_t bitLength;
1192 unsigned char* valPtr;
1194 ldapValue->bv_len=0;
1195 ldapValue->bv_val=NULL;
1197 /* Gets padding and points to binary data */
1198 valLen=berValue->bv_len;
1199 valPtr=(unsigned char*)berValue->bv_val;
1201 bitPadding=(ber_len_t)(valPtr[0]);
1205 /* If Block is non DER encoding fixes to DER encoding */
1206 if (bitPadding >= BITS_PER_BYTE) {
1207 if (valLen*BITS_PER_BYTE > bitPadding ) {
1208 valLen-=(bitPadding/BITS_PER_BYTE);
1209 bitPadding%=BITS_PER_BYTE;
1215 /* Just in case bad encoding */
1216 if (valLen*BITS_PER_BYTE < bitPadding ) {
1221 /* Gets buffer to hold RFC4517 Bit String format */
1222 bitLength=valLen*BITS_PER_BYTE-bitPadding;
1223 tmpStr=LDAP_MALLOC(bitLength + STR_OVERHEAD + 1);
1226 return LDAP_NO_MEMORY;
1228 ldapValue->bv_val=tmpStr;
1229 ldapValue->bv_len=bitLength + STR_OVERHEAD;
1231 /* Formatting in '*binary-digit'B format */
1232 maxBits=BITS_PER_BYTE;
1237 maxBits-=bitPadding;
1238 for (bits=0; bits<maxBits; bits++) {
1253 return LDAP_SUCCESS;
1256 /* Convert a structured DN from an X.509 certificate into an LDAPV3 DN.
1257 * x509_name must be raw DER. If func is non-NULL, the
1258 * constructed DN will use numeric OIDs to identify attributeTypes,
1259 * and the func() will be invoked to rewrite the DN with the given
1262 * Otherwise the DN will use shortNames from a hardcoded table.
1265 ldap_X509dn2bv( void *x509_name, struct berval *bv, LDAPDN_rewrite_func *func,
1270 LDAPAVA *newAVA, *baseAVA;
1271 BerElementBuffer berbuf;
1272 BerElement *ber = (BerElement *)&berbuf;
1273 char oids[8192], *oidptr = oids, *oidbuf = NULL;
1275 char *dn_end, *rdn_end;
1276 int i, navas, nrdns, rc = LDAP_SUCCESS;
1277 size_t dnsize, oidrem = sizeof(oids), oidsize = 0;
1283 struct berval Oid, Val, oid2, *in = x509_name;
1285 assert( bv != NULL );
1293 /* A DN is a SEQUENCE of RDNs. An RDN is a SET of AVAs.
1294 * An AVA is a SEQUENCE of attr and value.
1295 * Count the number of AVAs and RDNs
1297 ber_init2( ber, in, LBER_USE_DER );
1298 tag = ber_peek_tag( ber, &len );
1299 if ( tag != LBER_SEQUENCE )
1300 return LDAP_DECODING_ERROR;
1302 for ( tag = ber_first_element( ber, &len, &dn_end );
1304 tag = ber_next_element( ber, &len, dn_end )) {
1306 for ( tag = ber_first_element( ber, &len, &rdn_end );
1307 tag == LBER_SEQUENCE;
1308 tag = ber_next_element( ber, &len, rdn_end )) {
1309 tag = ber_skip_tag( ber, &len );
1310 ber_skip_data( ber, len );
1315 /* Allocate the DN/RDN/AVA stuff as a single block */
1316 dnsize = sizeof(LDAPRDN) * (nrdns+1);
1317 dnsize += sizeof(LDAPAVA *) * (navas+nrdns);
1318 dnsize += sizeof(LDAPAVA) * navas;
1319 if (dnsize > sizeof(ptrs)) {
1320 newDN = (LDAPDN)LDAP_MALLOC( dnsize );
1321 if ( newDN == NULL )
1322 return LDAP_NO_MEMORY;
1324 newDN = (LDAPDN)(char *)ptrs;
1327 newDN[nrdns] = NULL;
1328 newRDN = (LDAPRDN)(newDN + nrdns+1);
1329 newAVA = (LDAPAVA *)(newRDN + navas + nrdns);
1332 /* Rewind and start extracting */
1335 tag = ber_first_element( ber, &len, &dn_end );
1336 for ( i = nrdns - 1; i >= 0; i-- ) {
1339 for ( tag = ber_first_element( ber, &len, &rdn_end );
1340 tag == LBER_SEQUENCE;
1341 tag = ber_next_element( ber, &len, rdn_end )) {
1344 tag = ber_skip_tag( ber, &len );
1345 tag = ber_get_stringbv( ber, &Oid, LBER_BV_NOTERM );
1346 if ( tag != LBER_TAG_OID ) {
1347 rc = LDAP_DECODING_ERROR;
1351 oid2.bv_val = oidptr;
1352 oid2.bv_len = oidrem;
1353 if ( ber_decode_oid( &Oid, &oid2 ) < 0 ) {
1354 rc = LDAP_DECODING_ERROR;
1357 oidname = find_oid( &oid2 );
1359 newAVA->la_attr = oid2;
1360 oidptr += oid2.bv_len + 1;
1361 oidrem -= oid2.bv_len + 1;
1363 /* Running out of OID buffer space? */
1365 if ( oidsize == 0 ) {
1366 oidsize = sizeof(oids) * 2;
1368 oidbuf = LDAP_MALLOC( oidsize );
1369 if ( oidbuf == NULL ) goto nomem;
1373 oidbuf = LDAP_REALLOC( oidbuf, oidsize*2 );
1374 if ( oidbuf == NULL ) goto nomem;
1375 /* Buffer moved! Fix AVA pointers */
1376 if ( old != oidbuf ) {
1378 long dif = oidbuf - old;
1380 for (a=baseAVA; a<=newAVA; a++){
1381 if (a->la_attr.bv_val >= old &&
1382 a->la_attr.bv_val <= (old + oidsize))
1383 a->la_attr.bv_val += dif;
1386 oidptr = oidbuf + oidsize - oidrem;
1393 newAVA->la_attr = oidname->oid;
1395 newAVA->la_attr = oidname->name;
1398 newAVA->la_private = NULL;
1399 newAVA->la_flags = LDAP_AVA_STRING;
1400 tag = ber_get_stringbv( ber, &Val, LBER_BV_NOTERM );
1402 case LBER_TAG_UNIVERSAL:
1403 /* This uses 32-bit ISO 10646-1 */
1404 csize = 4; goto to_utf8;
1406 /* This uses 16-bit ISO 10646-1 */
1407 csize = 2; goto to_utf8;
1408 case LBER_TAG_TELETEX:
1409 /* This uses 8-bit, assume ISO 8859-1 */
1411 to_utf8: rc = ldap_ucs_to_utf8s( &Val, csize, &newAVA->la_value );
1412 newAVA->la_flags |= LDAP_AVA_NONPRINTABLE;
1414 newAVA->la_flags |= LDAP_AVA_FREE_VALUE;
1415 if (rc != LDAP_SUCCESS) goto nomem;
1418 newAVA->la_flags |= LDAP_AVA_NONPRINTABLE;
1419 /* This is already in UTF-8 encoding */
1421 case LBER_TAG_PRINTABLE:
1422 /* These are always 7-bit strings */
1423 newAVA->la_value = Val;
1425 case LBER_BITSTRING:
1426 /* X.690 bitString value converted to RFC4517 Bit String */
1427 rc = der_to_ldap_BitString( &Val, &newAVA->la_value );
1430 /* Not a string type at all */
1431 newAVA->la_flags = 0;
1432 newAVA->la_value = Val;
1438 tag = ber_next_element( ber, &len, dn_end );
1442 rc = func( newDN, flags, NULL );
1443 if ( rc != LDAP_SUCCESS )
1447 rc = ldap_dn2bv_x( newDN, bv, LDAP_DN_FORMAT_LDAPV3, NULL );
1450 for (;baseAVA < newAVA; baseAVA++) {
1451 if (baseAVA->la_flags & LDAP_AVA_FREE_ATTR)
1452 LDAP_FREE( baseAVA->la_attr.bv_val );
1453 if (baseAVA->la_flags & LDAP_AVA_FREE_VALUE)
1454 LDAP_FREE( baseAVA->la_value.bv_val );
1458 LDAP_FREE( oidbuf );
1459 if ( newDN != (LDAPDN)(char *) ptrs )