Share via

EapPeerGetIdentity (Compact 7)

  • Article

3/12/2014

Returns the user data and user identity after it is called by EAPHost.

Syntax

DWORD WINAPI EapPeerGetIdentity(
  __in     DWORD dwflags,
  __in     DWORD dwSizeofConnectionData,
  __in     const BYTE* pConnectionData,
  __in     DWORD dwSizeOfUserData,
  __in     const BYTE* pUserData,
  __in     HANDLE hTokenImpersonateUser,
  __out    BOOL* pfInvokeUI,
  __inout  DWORD* pdwSizeOfUserDataOut,
  __out    BYTE** ppUserDataOut,
  __out    LPWSTR* ppwszIdentity,
  __out    EAP_ERROR** ppEapError
);

Parameters

  • dwflags
    A combination of EAP Method Flags that describe the EAP authentication session behavior.
  • dwSizeofConnectionData
    Specifies the size, in bytes, of the connection data buffer provided in pConnectionData.
  • pConnectionData
    A pointer to a byte buffer that contains the opaque configuration data BLOB.
  • dwSizeOfUserData
    Specifies the size, in bytes, of the user data buffer provided in pUserData.
  • pUserData
    A pointer to the user data that is specific to this authentication that is used to pre-populate the user data. When this API is called for the first time, or when a new authentication session starts, this parameter is NULL. Otherwise, set this parameter to the pUserData member of the structure pointed to by the ppResult parameter received by EapPeerGetResult.
  • hTokenImpersonateUser
    Specifies a handle to the impersonation token of the user being authenticated. This handle will be NULL when doing computer authentication. By using this handle an EAP method can impersonate the user to obtain user specific information such as user name, domain name and credentials.
  • pfInvokeUI
    Returns true if the user identity and user data blob are not returned successfully, and the method seeks to collect the information from the user through the user interface dialog.
  • pdwSizeOfUserDataOut
    Specifies the size, in bytes, of the ppUserDataOut buffer.
  • ppUserDataOut
    A pointer to a pointer to the returned user data. The data is passed to EapPeerBeginSession as input pUserData.
  • ppwszIdentity
    A pointer to the returned user identity. The pointer will be included in the identity response packet and returned to the server.
  • ppEapError
    A pointer to the pointer to an EAP_ERROR structure that contains any errors raised during the execution of this function call. After using the error data, this memory must be freed by calling EapPeerFreeErrorMemory.

Remarks

This call is performed by a peer-based EAPHost by using a function pointer to this API. This API must be implemented on the EAP method loaded by EAPHost, and must strictly comply with the syntax and parameter types that are specified in the documentation.

See Also

Reference

EAPHost Peer Method Run-Time Functions
EapPeerInvokeIdentityUI