3 * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
8 * BindRequest ::= SEQUENCE {
10 * name DistinguishedName, -- who
11 * authentication CHOICE {
12 * simple [0] OCTET STRING -- passwd
13 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
14 * krbv42ldap [1] OCTET STRING
15 * krbv42dsa [2] OCTET STRING
17 * sasl [3] SaslCredentials -- LDAPv3
21 * BindResponse ::= SEQUENCE {
22 * COMPONENTS OF LDAPResult,
23 * serverSaslCreds OCTET STRING OPTIONAL -- LDAPv3
32 #include <ac/socket.h>
33 #include <ac/stdlib.h>
34 #include <ac/string.h>
41 * ldap_sasl_bind - bind to the ldap server (and X.500).
42 * The dn (usually NULL), mechanism, and credentials are provided.
43 * The message id of the request initiated is provided upon successful
44 * (LDAP_SUCCESS) return.
47 * ldap_sasl_bind( ld, NULL, "mechanism",
48 * cred, NULL, NULL, &msgid )
55 LDAP_CONST char *mechanism,
66 LDAP_LOG ( TRANSPORT, ENTRY, "ldap_sasl_bind\n", 0, 0, 0 );
68 Debug( LDAP_DEBUG_TRACE, "ldap_sasl_bind\n", 0, 0, 0 );
72 assert( LDAP_VALID( ld ) );
73 assert( msgidp != NULL );
75 /* check client controls */
76 rc = ldap_int_client_controls( ld, cctrls );
77 if( rc != LDAP_SUCCESS ) return rc;
79 if( mechanism == LDAP_SASL_SIMPLE ) {
80 if( dn == NULL && cred != NULL ) {
81 /* use default binddn */
82 dn = ld->ld_defbinddn;
85 } else if( ld->ld_version < LDAP_VERSION3 ) {
86 ld->ld_errno = LDAP_NOT_SUPPORTED;
94 /* create a message to send */
95 if ( (ber = ldap_alloc_ber_with_options( ld )) == NULL ) {
96 ld->ld_errno = LDAP_NO_MEMORY;
100 assert( LBER_VALID( ber ) );
102 LDAP_NEXT_MSGID( ld, id );
103 if( mechanism == LDAP_SASL_SIMPLE ) {
105 rc = ber_printf( ber, "{it{istON}" /*}*/,
107 ld->ld_version, dn, LDAP_AUTH_SIMPLE,
110 } else if ( cred == NULL || cred->bv_val == NULL ) {
111 /* SASL bind w/o creditials */
112 rc = ber_printf( ber, "{it{ist{sN}N}" /*}*/,
114 ld->ld_version, dn, LDAP_AUTH_SASL,
118 /* SASL bind w/ creditials */
119 rc = ber_printf( ber, "{it{ist{sON}N}" /*}*/,
121 ld->ld_version, dn, LDAP_AUTH_SASL,
126 ld->ld_errno = LDAP_ENCODING_ERROR;
131 /* Put Server Controls */
132 if( ldap_int_put_controls( ld, sctrls, ber ) != LDAP_SUCCESS ) {
137 if ( ber_printf( ber, /*{*/ "N}" ) == -1 ) {
138 ld->ld_errno = LDAP_ENCODING_ERROR;
144 /* send the message */
145 *msgidp = ldap_send_initial_request( ld, LDAP_REQ_BIND, dn, ber, id );
158 LDAP_CONST char *mechanism,
160 LDAPControl **sctrls,
161 LDAPControl **cctrls,
162 struct berval **servercredp )
166 struct berval *scredp = NULL;
169 LDAP_LOG ( TRANSPORT, ENTRY, "ldap_sasl_bind_s\n", 0, 0, 0 );
171 Debug( LDAP_DEBUG_TRACE, "ldap_sasl_bind_s\n", 0, 0, 0 );
174 /* do a quick !LDAPv3 check... ldap_sasl_bind will do the rest. */
175 if( servercredp != NULL ) {
176 if (ld->ld_version < LDAP_VERSION3) {
177 ld->ld_errno = LDAP_NOT_SUPPORTED;
183 rc = ldap_sasl_bind( ld, dn, mechanism, cred, sctrls, cctrls, &msgid );
185 if ( rc != LDAP_SUCCESS ) {
189 #ifdef LDAP_CONNECTIONLESS
190 if (LDAP_IS_UDP(ld)) {
195 if ( ldap_result( ld, msgid, 1, NULL, &result ) == -1 ) {
196 return( ld->ld_errno ); /* ldap_result sets ld_errno */
199 /* parse the results */
201 if( servercredp != NULL ) {
202 rc = ldap_parse_sasl_bind_result( ld, result, &scredp, 0 );
205 if ( rc != LDAP_SUCCESS && rc != LDAP_SASL_BIND_IN_PROGRESS ) {
206 ldap_msgfree( result );
210 rc = ldap_result2error( ld, result, 1 );
212 if ( rc == LDAP_SUCCESS || rc == LDAP_SASL_BIND_IN_PROGRESS ) {
213 if( servercredp != NULL ) {
214 *servercredp = scredp;
219 if ( scredp != NULL ) {
228 * Parse BindResponse:
230 * BindResponse ::= [APPLICATION 1] SEQUENCE {
231 * COMPONENTS OF LDAPResult,
232 * serverSaslCreds [7] OCTET STRING OPTIONAL }
234 * LDAPResult ::= SEQUENCE {
235 * resultCode ENUMERATED,
237 * errorMessage LDAPString,
238 * referral [3] Referral OPTIONAL }
242 ldap_parse_sasl_bind_result(
245 struct berval **servercredp,
249 struct berval* scred;
255 LDAP_LOG ( TRANSPORT, ENTRY, "ldap_parse_sasl_bind_result\n", 0, 0, 0 );
257 Debug( LDAP_DEBUG_TRACE, "ldap_parse_sasl_bind_result\n", 0, 0, 0 );
260 assert( ld != NULL );
261 assert( LDAP_VALID( ld ) );
262 assert( res != NULL );
264 if( servercredp != NULL ) {
265 if( ld->ld_version < LDAP_VERSION2 ) {
266 return LDAP_NOT_SUPPORTED;
271 if( res->lm_msgtype != LDAP_RES_BIND ) {
272 ld->ld_errno = LDAP_PARAM_ERROR;
278 if ( ld->ld_error ) {
279 LDAP_FREE( ld->ld_error );
282 if ( ld->ld_matched ) {
283 LDAP_FREE( ld->ld_matched );
284 ld->ld_matched = NULL;
289 ber = ber_dup( res->lm_ber );
292 ld->ld_errno = LDAP_NO_MEMORY;
296 if ( ld->ld_version < LDAP_VERSION2 ) {
297 tag = ber_scanf( ber, "{ia}",
298 &errcode, &ld->ld_error );
300 if( tag == LBER_ERROR ) {
302 ld->ld_errno = LDAP_DECODING_ERROR;
309 tag = ber_scanf( ber, "{iaa" /*}*/,
310 &errcode, &ld->ld_matched, &ld->ld_error );
312 if( tag == LBER_ERROR ) {
314 ld->ld_errno = LDAP_DECODING_ERROR;
318 tag = ber_peek_tag(ber, &len);
320 if( tag == LDAP_TAG_REFERRAL ) {
322 if( ber_scanf( ber, "x" ) == LBER_ERROR ) {
324 ld->ld_errno = LDAP_DECODING_ERROR;
328 tag = ber_peek_tag(ber, &len);
331 if( tag == LDAP_TAG_SASL_RES_CREDS ) {
332 if( ber_scanf( ber, "O", &scred ) == LBER_ERROR ) {
334 ld->ld_errno = LDAP_DECODING_ERROR;
342 if ( servercredp != NULL ) {
343 *servercredp = scred;
345 } else if ( scred != NULL ) {
349 ld->ld_errno = errcode;
355 return( ld->ld_errno );
359 ldap_pvt_sasl_getmechs ( LDAP *ld, char **pmechlist )
361 /* we need to query the server for supported mechs anyway */
362 LDAPMessage *res, *e;
363 char *attrs[] = { "supportedSASLMechanisms", NULL };
364 char **values, *mechlist;
368 LDAP_LOG ( TRANSPORT, ENTRY, "ldap_pvt_sasl_getmech\n", 0, 0, 0 );
370 Debug( LDAP_DEBUG_TRACE, "ldap_pvt_sasl_getmech\n", 0, 0, 0 );
373 rc = ldap_search_s( ld, "", LDAP_SCOPE_BASE,
374 NULL, attrs, 0, &res );
376 if ( rc != LDAP_SUCCESS ) {
380 e = ldap_first_entry( ld, res );
383 if ( ld->ld_errno == LDAP_SUCCESS ) {
384 ld->ld_errno = LDAP_NO_SUCH_OBJECT;
389 values = ldap_get_values( ld, e, "supportedSASLMechanisms" );
390 if ( values == NULL ) {
392 ld->ld_errno = LDAP_NO_SUCH_ATTRIBUTE;
396 mechlist = ldap_charray2str( values, " " );
397 if ( mechlist == NULL ) {
398 LDAP_VFREE( values );
400 ld->ld_errno = LDAP_NO_MEMORY;
404 LDAP_VFREE( values );
407 *pmechlist = mechlist;
413 * ldap_sasl_interactive_bind_s - interactive SASL authentication
415 * This routine uses interactive callbacks.
417 * LDAP_SUCCESS is returned upon success, the ldap error code
421 ldap_sasl_interactive_bind_s(
423 LDAP_CONST char *dn, /* usually NULL */
424 LDAP_CONST char *mechs,
425 LDAPControl **serverControls,
426 LDAPControl **clientControls,
428 LDAP_SASL_INTERACT_PROC *interact,
433 #if defined( LDAP_R_COMPILE ) && defined( HAVE_CYRUS_SASL )
434 ldap_pvt_thread_mutex_lock( &ldap_int_sasl_mutex );
436 #ifdef LDAP_CONNECTIONLESS
437 if( LDAP_IS_UDP(ld) ) {
438 /* Just force it to simple bind, silly to make the user
439 * ask all the time. No, we don't ever actually bind, but I'll
440 * let the final bind handler take care of saving the cdn.
442 rc = ldap_simple_bind(ld, dn, NULL);
443 return rc < 0 ? rc : 0;
446 if( mechs == NULL || *mechs == '\0' ) {
449 rc = ldap_pvt_sasl_getmechs( ld, &smechs );
451 if( rc != LDAP_SUCCESS ) {
456 LDAP_LOG ( TRANSPORT, DETAIL1,
457 "ldap_interactive_sasl_bind_s: server supports: %s\n",
460 Debug( LDAP_DEBUG_TRACE,
461 "ldap_interactive_sasl_bind_s: server supports: %s\n",
469 LDAP_LOG ( TRANSPORT, DETAIL1,
470 "ldap_interactive_sasl_bind_s: user selected: %s\n", mechs, 0, 0 );
472 Debug( LDAP_DEBUG_TRACE,
473 "ldap_interactive_sasl_bind_s: user selected: %s\n",
478 rc = ldap_int_sasl_bind( ld, dn, mechs,
479 serverControls, clientControls,
480 flags, interact, defaults );
483 #if defined( LDAP_R_COMPILE ) && defined( HAVE_CYRUS_SASL )
484 ldap_pvt_thread_mutex_unlock( &ldap_int_sasl_mutex );