EapPeerQueryUserBlobFromCredentialInputFields function (eapmethodpeerapis.h)

Article
02/22/2024

The EapPeerQueryUserBlobFromCredentialInputFields function defines the implementation of an EAP method function that obtains the user BLOB data provided in an interactive Single-Sign-On (SSO) UI raised on the supplicant.

Syntax

DWORD EapPeerQueryUserBlobFromCredentialInputFields(
  [in]      HANDLE                             hUserImpersonationToken,
  [in]      EAP_METHOD_TYPE                    eapMethodType,
  [in]      DWORD                              dwFlags,
  [in]      DWORD                              dwEapConnDataSize,
  [in]      BYTE                               *pbEapConnData,
  [in]      const EAP_CONFIG_INPUT_FIELD_ARRAY *pEapConfigInputFieldArray,
  [in, out] DWORD                              *pdwUserBlobSize,
  [in, out] BYTE                               **ppbUserBlob,
  [out]     EAP_ERROR                          **ppEapError
);

Parameters

[in] hUserImpersonationToken

An impersonation token for the user whose credentials are to be requested and obtained.

[in] eapMethodType

An EAP_METHOD_TYPE structure that contains vendor and author information about the EAP method used for authenticating the connection.

[in] dwFlags

A combination of EAP flags that describe the EAP authentication session behavior.

[in] dwEapConnDataSize

The size of the EAP SSO configuration data pointed to by pbEapConnData, in bytes.

[in] pbEapConnData

A pointer to an opaque byte buffer that contains the EAP SSO configuration data BLOB.

[in] pEapConfigInputFieldArray

A pointer to an EAP_CONFIG_INPUT_FIELD_ARRAY structure that contains the input fields to display to the supplicant user. The pwszData fields in the individual EAP_CONFIG_INPUT_FIELD_DATA elements are initialized to NULL.

[in, out] pdwUserBlobSize

A pointer to a buffer that contains the size, in bytes, of the opaque user configuration data BLOB in ppUserBlob.

[in, out] ppbUserBlob

A pointer that contains the opaque user data BLOB.

[out] ppEapError

A pointer to the address of an EAP_ERROR structure that contains any errors raised during the execution of this function call. After consuming the error data, this memory must be freed by passing a pointer to the error data to EapPeerFreeErrorMemory.

Return value

None

Remarks

EapPeerQueryUserBlobFromCredentialInputFields supports Single-Sign-On (SSO). This peer method function, like EapPeerQueryCredentialInputFields, is used only in an SSO scenario.

After EapPeerQueryUserBlobFromCredentialInputFields, EAPHost calls EapPeerBeginSession. The supplicant uses the EAP_FLAG_PRE_LOGON flag in EapHostPeerBeginSession to indicate that EAPHost should provide SSO.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	eapmethodpeerapis.h

Share via