EapHostPeerQueryUserBlobFromCredentialInputFields (Compact 2013)
3/26/2014
This function obtains a credential BLOB that can be used to start authentication from user input received from the Single-Sign-On (SSO) UI.
Syntax
DWORD WINAPI EapHostPeerQueryUserBlobFromCredentialInputFields(
__in HANDLE hUserImpersonationToken,
__in EAP_METHOD_TYPE eapMethodType,
__in DWORD dwFlags,
__in DWORD dwEapConnDataSize,
__in PBYTE pbEapConnData,
__in EAP_CONFIG_INPUT_FIELD_ARRAY* pEapConfigInputFieldArray,
__inout DWORD* pdwUserBlobSize,
__inout PBYTE* ppbUserBlob,
__out EAP_ERROR** pEapError
);
Parameters
- hUserImpersonationToken
A handle to the user impersonation token to use in this session.
- eapMethodType
An EAP_METHOD_TYPE structure that specifies the type of EAP authentication to use for this session.
- dwFlags
A combination of EAP Method Flags that describe the EAP authentication session behavior.
- dwEapConnDataSize
The size, in bytes, of the connection data buffer provided in pConnectionData.
- pbEapConnData
Connection data that is used for the EAP method.
- pEapConfigInputFieldArray
A pointer to an EAP_CONFIG_INPUT_FIELD_ARRAY structure the contains the UI input field data. The caller should free the inner pointers using the function EapHostPeerFreeMemory, starting at the innermost pointer.
- pdwUserBlobSize
A pointer to a DWORD that specifies the size, in bytes, of the buffer pointed to by ppbUserBlob. If this value is not set to zero, and then a pointer to a buffer of the size specified in this parameter must be supplied to ppbUserBlob.
- ppbUserBlob
A pointer to the credential BLOB that can be used in authentication. Memory must be freed by calling EapHostPeerFreeEapError. If a non-null value is supplied for this parameter (meaning that an existing data BLOB is passed to it), the supplied data BLOB will be updated and returned in this parameter. If a non-NULL BLOB value is supplied, the LocalAlloc function should be used.
- pEapError
A pointer to a pointer to an EAP_ERROR structure that contains any errors raised by EAPHost during the execution of this function call. After using the error data, this memory must be freed by calling EapHostPeerFreeErrorMemory.
Remarks
EapHostPeerQueryUserBlobFromCredentialInputFields supports SSO. This supplicant function, just as EapHostPeerQueryCredentialInputFields, is used only in an SSO scenario.
After EapHostPeerQueryUserBlobFromCredentialInputFields, EAPHost calls EapHostPeerBeginSession. The supplicant uses the EAP_FLAG_PRE_LOGON flag in EapHostPeerBeginSession to indicate that EAPHost should provide SSO.