3 * Copyright 1998-2000 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
33 #include <ac/socket.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,
64 Debug( LDAP_DEBUG_TRACE, "ldap_sasl_bind\n", 0, 0, 0 );
67 assert( LDAP_VALID( ld ) );
68 assert( msgidp != NULL );
70 /* check client controls */
71 rc = ldap_int_client_controls( ld, cctrls );
72 if( rc != LDAP_SUCCESS ) return rc;
74 if( msgidp == NULL ) {
75 ld->ld_errno = LDAP_PARAM_ERROR;
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 if( mechanism == LDAP_SASL_SIMPLE ) {
104 rc = ber_printf( ber, "{it{istON}" /*}*/,
105 ++ld->ld_msgid, LDAP_REQ_BIND,
106 ld->ld_version, dn, LDAP_AUTH_SIMPLE,
109 } else if ( cred == NULL || !cred->bv_len ) {
110 /* SASL bind w/o creditials */
111 rc = ber_printf( ber, "{it{ist{sN}N}" /*}*/,
112 ++ld->ld_msgid, LDAP_REQ_BIND,
113 ld->ld_version, dn, LDAP_AUTH_SASL,
117 /* SASL bind w/ creditials */
118 rc = ber_printf( ber, "{it{ist{sON}N}" /*}*/,
119 ++ld->ld_msgid, LDAP_REQ_BIND,
120 ld->ld_version, dn, LDAP_AUTH_SASL,
125 ld->ld_errno = LDAP_ENCODING_ERROR;
130 /* Put Server Controls */
131 if( ldap_int_put_controls( ld, sctrls, ber ) != LDAP_SUCCESS ) {
136 if ( ber_printf( ber, /*{*/ "N}" ) == -1 ) {
137 ld->ld_errno = LDAP_ENCODING_ERROR;
143 if ( ld->ld_cache != NULL ) {
144 ldap_flush_cache( ld );
146 #endif /* !LDAP_NOCACHE */
148 /* send the message */
149 *msgidp = ldap_send_initial_request( ld, LDAP_REQ_BIND, dn, ber );
162 LDAP_CONST char *mechanism,
164 LDAPControl **sctrls,
165 LDAPControl **cctrls,
166 struct berval **servercredp )
170 struct berval *scredp = NULL;
172 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 if ( ldap_result( ld, msgid, 1, NULL, &result ) == -1 ) {
190 return( ld->ld_errno ); /* ldap_result sets ld_errno */
193 /* parse the results */
195 if( servercredp != NULL ) {
196 rc = ldap_parse_sasl_bind_result( ld, result, &scredp, 0 );
199 if ( rc != LDAP_SUCCESS && rc != LDAP_SASL_BIND_IN_PROGRESS ) {
200 ldap_msgfree( result );
204 rc = ldap_result2error( ld, result, 1 );
206 if ( rc == LDAP_SUCCESS || rc == LDAP_SASL_BIND_IN_PROGRESS ) {
207 if( servercredp != NULL ) {
208 *servercredp = scredp;
213 if ( scredp != NULL ) {
222 * Parse BindResponse:
224 * BindResponse ::= [APPLICATION 1] SEQUENCE {
225 * COMPONENTS OF LDAPResult,
226 * serverSaslCreds [7] OCTET STRING OPTIONAL }
228 * LDAPResult ::= SEQUENCE {
229 * resultCode ENUMERATED,
231 * errorMessage LDAPString,
232 * referral [3] Referral OPTIONAL }
236 ldap_parse_sasl_bind_result(
239 struct berval **servercredp,
243 struct berval* scred;
248 Debug( LDAP_DEBUG_TRACE, "ldap_parse_sasl_bind_result\n", 0, 0, 0 );
250 assert( ld != NULL );
251 assert( LDAP_VALID( ld ) );
252 assert( res != NULL );
254 if ( ld == NULL || res == NULL ) {
255 return LDAP_PARAM_ERROR;
258 if( servercredp != NULL ) {
259 if( ld->ld_version < LDAP_VERSION2 ) {
260 return LDAP_NOT_SUPPORTED;
265 if( res->lm_msgtype != LDAP_RES_BIND ) {
266 ld->ld_errno = LDAP_PARAM_ERROR;
272 if ( ld->ld_error ) {
273 LDAP_FREE( ld->ld_error );
276 if ( ld->ld_matched ) {
277 LDAP_FREE( ld->ld_matched );
278 ld->ld_matched = NULL;
283 ber = ber_dup( res->lm_ber );
286 ld->ld_errno = LDAP_NO_MEMORY;
290 if ( ld->ld_version < LDAP_VERSION2 ) {
291 tag = ber_scanf( ber, "{ia}",
292 &errcode, &ld->ld_error );
294 if( tag == LBER_ERROR ) {
296 ld->ld_errno = LDAP_DECODING_ERROR;
303 tag = ber_scanf( ber, "{iaa" /*}*/,
304 &errcode, &ld->ld_matched, &ld->ld_error );
306 if( tag == LBER_ERROR ) {
308 ld->ld_errno = LDAP_DECODING_ERROR;
312 tag = ber_peek_tag(ber, &len);
314 if( tag == LDAP_TAG_REFERRAL ) {
316 if( ber_scanf( ber, "x" ) == LBER_ERROR ) {
318 ld->ld_errno = LDAP_DECODING_ERROR;
322 tag = ber_peek_tag(ber, &len);
325 if( tag == LDAP_TAG_SASL_RES_CREDS ) {
326 if( ber_scanf( ber, "O", &scred ) == LBER_ERROR ) {
328 ld->ld_errno = LDAP_DECODING_ERROR;
336 if ( servercredp != NULL ) {
337 *servercredp = scred;
339 } else if ( scred != NULL ) {
343 ld->ld_errno = errcode;
349 return( ld->ld_errno );
353 ldap_pvt_sasl_getmechs ( LDAP *ld, char **pmechlist )
355 /* we need to query the server for supported mechs anyway */
356 LDAPMessage *res, *e;
357 char *attrs[] = { "supportedSASLMechanisms", NULL };
358 char **values, *mechlist;
361 Debug( LDAP_DEBUG_TRACE, "ldap_pvt_sasl_getmech\n", 0, 0, 0 );
363 rc = ldap_search_s( ld, "", LDAP_SCOPE_BASE,
364 NULL, attrs, 0, &res );
366 if ( rc != LDAP_SUCCESS ) {
370 e = ldap_first_entry( ld, res );
373 if ( ld->ld_errno == LDAP_SUCCESS ) {
374 ld->ld_errno = LDAP_NO_SUCH_OBJECT;
379 values = ldap_get_values( ld, e, "supportedSASLMechanisms" );
380 if ( values == NULL ) {
382 ld->ld_errno = LDAP_NO_SUCH_ATTRIBUTE;
386 mechlist = ldap_charray2str( values, " " );
387 if ( mechlist == NULL ) {
388 LDAP_VFREE( values );
390 ld->ld_errno = LDAP_NO_MEMORY;
394 LDAP_VFREE( values );
397 *pmechlist = mechlist;
403 * ldap_sasl_interactive_bind_s - interactive SASL authentication
405 * This routine uses interactive callbacks.
407 * LDAP_SUCCESS is returned upon success, the ldap error code
411 ldap_sasl_interactive_bind_s(
413 LDAP_CONST char *dn, /* usually NULL */
414 LDAP_CONST char *mechs,
415 LDAPControl **serverControls,
416 LDAPControl **clientControls,
418 LDAP_SASL_INTERACT_PROC *interact,
423 #if defined( LDAP_R_COMPILE ) && defined( HAVE_CYRUS_SASL )
424 ldap_pvt_thread_mutex_lock( &ldap_int_sasl_mutex );
427 if( mechs == NULL || *mechs == '\0' ) {
430 rc = ldap_pvt_sasl_getmechs( ld, &smechs );
432 if( rc != LDAP_SUCCESS ) {
436 Debug( LDAP_DEBUG_TRACE,
437 "ldap_interactive_sasl_bind_s: server supports: %s\n",
443 Debug( LDAP_DEBUG_TRACE,
444 "ldap_interactive_sasl_bind_s: user selected: %s\n",
448 rc = ldap_int_sasl_bind( ld, dn, mechs,
449 serverControls, clientControls,
450 flags, interact, defaults );
453 #if defined( LDAP_R_COMPILE ) && defined( HAVE_CYRUS_SASL )
454 ldap_pvt_thread_mutex_unlock( &ldap_int_sasl_mutex );