ldap_sasl_bind_s function

The ldap_sasl_bind_s function is a synchronous function that authenticates a client to the LDAP server using SASL.

Syntax

C++
Copy 

ULONG ldap_sasl_bind_s(
  _In_        LDAP          *ExternalHandle,
  _In_  const PCHAR         DistName,
  _In_  const PCHAR         AuthMechanism,
  _In_  const BERVAL        *cred,
  _In_        PLDAPControlA *ServerCtrls,
  _In_        PLDAPControlA *ClientCtrls,
  _Out_       PBERVAL       *ServerData
);

Parameters

ExternalHandle [in]

The session handle.

DistName [in]

The distinguished name of the entry used to bind.

AuthMechanism [in]

Indicates the authentication method to use.

cred [in]

The credentials to use for authentication. Arbitrary credentials can be passed using this parameter. The format and content of the credentials depend on the value of the AuthMechanism argument passed. For more information, see Remarks.

ServerCtrls [in]

A list of LDAP server controls.

ClientCtrls [in]

A list of LDAP client controls.

ServerData [out]

Authentication data returned by the server in response to the bind request.

Return value

If the function succeeds, the return value is LDAP_SUCCESS.

If the function fails, it returns an error code. For more information, see Return Values.

Remarks

The ldap_sasl_bind_s function binds to an LDAP server using the Simple Authentication and Security Layer (SASL) protocol. The bind operation identifies a client to the directory server by providing a distinguished name and some type of authentication credentials. The authentication method being used determines the particular type of credential, and is specified by the AuthMechanism argument. This is passed as a string in the form of "GSSAPI", "GSS-SPNEGO", "DIGEST-MD5", and so on. This function can be used to pass arbitrary credentials to the server, so the application must be ready to interpret the response sent back from the server.

Note  The Microsoft LDAP client uses a default timeout value of 120 seconds (2 minutes) for each bind-response roundtrip. This timeout value can be changed using the LDAP_OPT_TIMELIMIT session option. Other operations do not have a timeout unless specified using ldap_set_option.
 

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Header
Winldap.h

Library
Wldap32.lib

DLL
Wldap32.dll

Unicode and ANSI names

ldap_sasl_bind_sW (Unicode) and ldap_sasl_bind_sA (ANSI)

See also

Functions
Return Values
ldap_sasl_bind
ldap_bind_s
ldap_bind
ldap_simple_bind_s
ldap_simple_bind
SEC_WINNT_AUTH_IDENTITY

 

 

Show: