eapmethodpeerapis.h header

This header is used by Extensible Authentication Protocol Host. For more information, see:

• Extensible Authentication Protocol Host

eapmethodpeerapis.h contains the following programming interfaces:

Functions

EapPeerBeginSession Starts an EAP authentication session on the peer EAPHost using the EAP method.
EapPeerConfigBlob2Xml Converts the configuration BLOB to XML. (EapPeerConfigBlob2Xml)
EapPeerConfigXml2Blob Converts XML into the configuration BLOB. (EapPeerConfigXml2Blob)
EapPeerCredentialsXml2Blob Converts XML into the configuration BLOB. (EapPeerCredentialsXml2Blob)
EapPeerEndSession Ends an EAP authentication session for the EAP method.
EapPeerFreeErrorMemory Releases error-specific memory allocated by the EAP peer method.
EapPeerFreeMemory Releases all memory associated with an opaque user interface context data buffer. (EapPeerFreeMemory)
EapPeerGetConfigBlobAndUserBlob Allows EAP method developers to provide the various connection properties and user properties supported by the method. EAPHost invokes this function to create the connection property and user property of the EAP method.
EapPeerGetIdentity Returns the user data and user identity after being called by EAPHost.
EapPeerGetInfo Obtains a set of function pointers for an implementation of the EAP peer method EapPeerGetInfo currently loaded on the EAPHost service.
EapPeerGetMethodProperties EAP method-specific function that retrieves the properties of an EAP method given the connection and user data.
EapPeerGetResponseAttributes Obtains an array of EAP response attributes from the EAP method.
EapPeerGetResponsePacket Obtains a response packet from the EAP method.
EapPeerGetResult Obtains the result of an authentication session from the EAP method.
EapPeerGetUIContext Obtains the user interface context from the EAP method.
EapPeerInitialize Initializes an EAP peer method for EAPHost.
EapPeerInvokeConfigUI Raises the EAP method's specific connection configuration user interface dialog on the client.
EapPeerInvokeIdentityUI Raises a custom interactive user interface dialog to obtain user identity information for the EAP method on the client.
EapPeerInvokeInteractiveUI Raises a custom interactive user interface dialog for the EAP method on the client.
EapPeerProcessRequestPacket Processes a packet received by EAPHost from a supplicant.
EapPeerQueryCredentialInputFields Defines the implementation of an EAP method-specific function that obtains the EAP Single-Sign-On (SSO) credential input fields for an EAP method.
EapPeerQueryInteractiveUIInputFields Defines the implementation of an EAP method API that provides the input fields for interactive UI components to be raised on the supplicant.
EapPeerQueryUIBlobFromInteractiveUIInputFields Converts user information into a user BLOB that can be consumed by EAPHost run-time functions. (EapPeerQueryUIBlobFromInteractiveUIInputFields)
EapPeerQueryUserBlobFromCredentialInputFields 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.
EapPeerSetCredentials Supplies new or updated authentication credentials to the EAP method.
EapPeerSetResponseAttributes Provides an updated array of EAP response attributes to the EAP method.
EapPeerSetUIContext Provides a user interface context to the EAP method. This function is called after the UI has been raised through the EapPeerGetUIContext function.
EapPeerShutdown Shuts down the EAP method and prepares to unload its corresponding DLL.

Structures

EAP_PEER_METHOD_ROUTINES Contains a set of function pointers to the EAPHost Peer Method APIs.
EapPeerMethodResult Contains result data generated by an EAP method during authentication.