Export (0) Print
Expand All

DsBindWithSpnEx function

The DsBindWithSpnEx function binds to a domain controller using the specified credentials and a specific service principal name (SPN) for mutual authentication. This function is similar to the DsBindWithSpn function except this function allows more binding options with the BindFlags parameter.

This function is provided where complete control is required over mutual authentication. Do not use this function if you expect DsBind to find a server for you, because SPNs are computer-specific, and it is unlikely that the SPN you provide will match the server that DsBind finds for you. Providing a NULLServicePrincipalName argument results in behavior that is identical to DsBindWithCred.

Syntax


DWORD DsBindWithSpnEx(
  _In_opt_  LPCTSTR DomainControllerName,
  _In_opt_  LPCTSTR DnsDomainName,
  _In_opt_  RPC_AUTH_IDENTITY_HANDLE AuthIdentity,
  _In_opt_  LPCTSTR ServicePrincipalName,
  _In_opt_  DWORD BindFlags,
  _Out_     HANDLE *phDS
);

Parameters

DomainControllerName [in, optional]

Pointer to a null-terminated string that contains the fully qualified DNS name of the domain to bind. For more information, see the DomainControllerName description in the DsBind topic.

DnsDomainName [in, optional]

Pointer to a null-terminated string that contains the fully qualified DNS name of the domain to bind. For more information, see the DnsDomainName description in the DsBind topic.

AuthIdentity [in, optional]

Contains an RPC_AUTH_IDENTITY_HANDLE value that represents the credentials to be used for the bind. The DsMakePasswordCredentials function is used to obtain this value. If this parameter is NULL, the credentials of the calling thread are used.

DsUnBind must be called before freeing this handle with the DsFreePasswordCredentials function.

ServicePrincipalName [in, optional]

Pointer to a null-terminated string that specifies the Service Principal Name to assign to the client. Passing NULL in ServicePrincipalName is equivalent to a call to the DsBindWithCred function.

BindFlags [in, optional]

Contains a set of flags that define the behavior of this function. This parameter can contain zero or a combination of the values listed in the following table.

ValueMeaning
NTDSAPI_BIND_ALLOW_DELEGATION
1

Causes the bind to use the delegate impersonation level. This allows operations that require delegation, such as DsAddSidHistory, to succeed. Specifying this flag also causes DsBindWithSpnEx to operate like DsBindWithSpn.

If this flag is not specified, the bind will use the impersonate impersonation level. For more information, see Impersonation Levels.

Most operations do not require the delegate impersonation level, so this flag should only be specified if absolutely required. Binding to a rogue server with the delegate impersonation level will allow the rogue server to connect to a non-rogue server with your credentials and perform unintended operations.

NTDSAPI_BIND_FIND_BINDING
2

Reserved.

NTDSAPI_BIND_FORCE_KERBEROS
4

Active Directory Lightweight Directory Services:  If this flag is specified, DsBindWithSpnEx forces Kerberos authentication to be used. If Kerberos authentication cannot be established, DsBindWithSpnEx will not attempt to authenticate with any other method.

 

phDS [out]

Address of a HANDLE value that receives the binding handle. To close this handle, pass it to the DsUnBind function.

Return value

Returns ERROR_SUCCESS if successful or a Windows or RPC error code otherwise. The following table lists common error codes.

Return codeDescription
ERROR_INVALID_DOMAINNAME

The format of the specified DnsDomainName is not valid.

ERROR_INVALID_PARAMETER

phDS is invalid.

ERROR_NO_SUCH_DOMAIN

No domain controller is available for the specified domain or the domain does not exist.

ERROR_NOT_ENOUGH_MEMORY

A memory allocation failure occurred.

 

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Ntdsapi.h

Library

Ntdsapi.lib

DLL

Ntdsapi.dll

Unicode and ANSI names

DsBindWithSpnExW (Unicode) and DsBindWithSpnExA (ANSI)

See also

DsBindWithSpn
DsBind
DsBindWithCred
DsUnBind
Impersonation Levels
Domain Controller and Replication Management Functions

 

 

Show:
© 2014 Microsoft