EAP_PEER_METHOD_ROUTINES structure (eapmethodpeerapis.h)

  • Article

Contient un ensemble de pointeurs de fonction vers les API de méthode d’homologue EAPHost.

Syntaxe

typedef struct _EAP_PEER_METHOD_ROUTINES {
  DWORD    dwVersion;
  EAP_TYPE *pEapType;
  DWORD((EAP_ERROR **ppEapError)   * )EapPeerInitialize;
  DWORD(lags,DWORD dwSizeofConnectionData, const BYTE *pConnectionData,DWORD dwSizeofUserData, const BYTE *pUserData,HANDLE hTokenImpersonateUser,BOOL *pfInvokeUI,DWORD *pdwSizeOfUserDataOut,BYTE **ppUserDataOut,WCHAR **ppwszIdentity,EAP_ERROR **ppEapError)   * )(DWORD fEapPeerGetIdentity;
  DWORD(RD dwFlags, const EapAttributes * const pAttributeArray,HANDLE hTokenImpersonateUser,DWORD dwSizeofConnectionData,BYTE *pConnectionData,DWORD dwSizeofUserData,BYTE *pUserData,DWORD dwMaxSendPacketSize,EAP_SESSION_HANDLE *pSessionHandle,EAP_ERROR **ppEapError)   * )(DWOEapPeerBeginSession;
  DWORD(AP_SESSION_HANDLE sessionHandle,WCHAR *pwszIdentity,WCHAR *pwszPassword,EAP_ERROR **ppEapError)   * )(EEapPeerSetCredentials;
  DWORD(AP_SESSION_HANDLE sessionHandle,DWORD cbReceivePacket,EapPacket *pReceivePacket,EapPeerMethodOutput *pEapOutput,EAP_ERROR **ppEapError)   * )(EEapPeerProcessRequestPacket;
  DWORD(AP_SESSION_HANDLE sessionHandle,DWORD *pcbSendPacket,EapPacket *pSendPacket,EAP_ERROR **ppEapError)   * )(EEapPeerGetResponsePacket;
  DWORD(EAP_SESSION_HANDLE sessionHandle,EapPeerMethodResultReason reason,EapPeerMethodResult *ppResult,EAP_ERROR **ppEapError)   * )(EapPeerGetResult;
  DWORD(P_SESSION_HANDLE sessionHandle,DWORD *dwSizeOfUIContextData,BYTE **pUIContextData,EAP_ERROR **ppEapError)   * )(EAEapPeerGetUIContext;
  DWORD(AP_SESSION_HANDLE sessionHandle,DWORD dwSizeOfUIContextData, const BYTE *pUIContextData,EapPeerMethodOutput *pEapOutput,EAP_ERROR **ppEapError)   * )(EEapPeerSetUIContext;
  DWORD(EAP_SESSION_HANDLE sessionHandle,EapAttributes *pAttribs,EAP_ERROR **ppEapError)   * )(EapPeerGetResponseAttributes;
  DWORD(AP_SESSION_HANDLE sessionHandle,EapAttributes *pAttribs,EapPeerMethodOutput *pEapOutput,EAP_ERROR **ppEapError)   * )(EEapPeerSetResponseAttributes;
  DWORD((EAP_SESSION_HANDLE sessionHandle,EAP_ERROR **ppEapError)   * )EapPeerEndSession;
  DWORD((EAP_ERROR **ppEapError)   * )EapPeerShutdown;
} EAP_PEER_METHOD_ROUTINES;

Membres

dwVersion

Version de structure définie par l’implémenteur.

Note Les valeurs de ce champ ne sont pas définies par Microsoft.
 

pEapType

Pointeur vers une structure de EAP_TYPE qui contient les informations de fournisseur sur l’implémenteur des API vers lesquelles les membres de cette structure pointent.

EapPeerInitialize

Pointeur de fonction pour EapPeerInitialize.

pEapError

Pointeur vers la structure EAP_ERROR qui contient les erreurs générées pendant l’exécution de cet appel de fonction. Après avoir consommé les données d’erreur, cette mémoire doit être libérée en passant un pointeur vers EapPeerFreeErrorMemory.

EapPeerGetIdentity

Pointeur de fonction pour EapPeerGetIdentity.

dwflags

Combinaison d’indicateurs EAP qui décrivent le comportement de la session d’authentification EAP.

dwSizeofConnectionData

Spécifie la taille, en octets, de la mémoire tampon de données de connexion fournie dans pConnectionData

pConnectionData

Pointeur vers une mémoire tampon d’octets qui contient les données blob de configuration opaques.

dwSizeOfUserData

Spécifie la taille, en octets, de la mémoire tampon de données utilisateur fournie dans pUserData.

pUserData

Pointeur vers les données utilisateur spécifiques à cette authentification utilisées pour préremplir les données utilisateur. Lorsque cette API est appelée pour la première fois ou lorsqu’une nouvelle session d’authentification démarre, ce paramètre a la valeur NULL. Sinon, définissez ce paramètre sur le membre pUserData de la structure pointée vers par le paramètre ppResult reçu par EapPeerGetResult.

hTokenImpersonateUser

Spécifie un handle pour le jeton d’emprunt d’identité de l’utilisateur en cours d’authentification. Ce handle est NULL lors de l’authentification de l’ordinateur. En utilisant ce handle, une méthode EAP peut emprunter l’identité de l’utilisateur dans le but d’obtenir des informations spécifiques à l’utilisateur, telles que le nom d’utilisateur, le nom de domaine et les informations d’identification.

pfInvokeUI

Retourne TRUE si l’identité de l’utilisateur et l’objet blob de données utilisateur ne sont pas retournés correctement, et si la méthode cherche à collecter les informations de l’utilisateur via la boîte de dialogue de l’interface utilisateur.

pdwSizeOfUserDataOut

Spécifie la taille, en octets, de la mémoire tampon ppUserDataOut .

ppUserDataOut

Pointeur vers un pointeur vers les données utilisateur retournées. Les données sont passées à EapPeerBeginSession en tant qu’entrée pUserData.

ppwszIdentity

Pointeur vers l’identité d’utilisateur retournée. Le pointeur est inclus dans le paquet de réponse d’identité et retourné au serveur.

ppEapError

Pointeur vers un EAP_ERROR structure qui contient les erreurs générées pendant l’exécution de cet appel de fonction. Après avoir consommé les données d’erreur, cette mémoire doit être libérée en appelant EapPeerFreeErrorMemory.

EapPeerBeginSession

Pointeur de fonction pour EapPeerBeginSession.

dwFlags

Combinaison d’indicateurs EAP qui décrivent le nouveau comportement de session d’authentification EAP.

pAttributeArray

Pointeur vers une structure de tableau EAP_ATTRIBUTES qui spécifie les attributs EAP de l’entité à authentifier.

hTokenImpersonateUser

Spécifie un handle pour le jeton d’emprunt d’identité utilisateur à utiliser dans cette session.

dwSizeOfConnectionData

Spécifie la taille, en octets, de la mémoire tampon de données de connexion fournie dans pConnectionData.

pConnectionData

Pointeur vers une mémoire tampon d’octets qui contient les données blob de configuration opaques.

dwSizeOfUserData

Spécifie la taille en octets de la mémoire tampon de données utilisateur fournie dans pUserData.

pUserData

Pointeur vers une mémoire tampon d’octets qui contient l’objet BLOB de données utilisateur opaques.

dwMaxSendPacketSize

Spécifie la taille maximale en octets d’un paquet EAP envoyé pendant la session. Si la méthode doit envoyer un paquet supérieur à la taille maximale, la méthode doit prendre en charge la fragmentation et le réassemblage.

pSessionHandle

Pointeur vers une structure EAP_SESSION_HANDLE qui contient l’ID unique de la nouvelle session d’authentification EAP sur EAPHost

ppEapError

Pointeur vers l’adresse d’une structure de EAP_ERROR qui contient les erreurs générées par EAPHost pendant l’exécution de cet appel de fonction. Après avoir consommé les données d’erreur, cette mémoire doit être libérée en appelant EapPeerFreeErrorMemory.

EapPeerSetCredentials

Pointeur de fonction pour EapPeerSetCredentials.

sessionHandle

Pointeur vers une structure de EAP_SESSION_HANDLE qui contient le handle unique pour cette session d’authentification EAP sur le serveur EAPHost. Ce handle est retourné dans le paramètre pSessionHandle dans un appel précédent à EapPeerBeginSession.

pwszIdentity

Pointeur qui spécifie l’identité de l’utilisateur pour laquelle définir les informations d’identification. Cette chaîne d’identité utilisateur est obtenue en appelant la fonction EapPeerGetIdentity .

pwszPassword

Pointeur qui contient le mot de passe en texte clair de l’identité de l’utilisateur.

ppEapError

Pointeur vers l’adresse d’une structure EAP_ERROR qui contient les erreurs générées pendant l’exécution de cet appel de fonction. Après avoir consommé les données d’erreur, cette mémoire doit être libérée en appelant EapPeerFreeErrorMemory.

EapPeerProcessRequestPacket

Pointeur de fonction pour EapPeerProcessRequestPacket.

sessionHandle

EAP_SESSION_HANDLE valeur qui contient le handle spécifique pour la session d’authentification EAP sur EAPHost. Ce handle est obtenu par un appel précédent à EapPeerBeginSession.

cbReceivePacket

Taille en octets du paquet de requête spécifié dans pReceivePacket.

pReceivePacket

Pointeur vers une structure EapPacket qui contient le paquet de requête à traiter.

pEapOutput

Pointeur vers une structure EapPeerMethodOutput qui contient la sortie de l’opération de traitement de paquets.

ppEapError

Pointeur vers l’adresse d’une structure EAP_ERROR qui contient les erreurs générées pendant l’exécution de cet appel de fonction. Après avoir consommé les données d’erreur, cette mémoire doit être libérée en appelant EapPeerFreeErrorMemory.

EapPeerGetResponsePacket

Pointeur de fonction pour EapPeerGetResponsePacket.

sessionHandle

EAP_SESSION_HANDLE valeur qui contient le handle spécifique pour la session d’authentification EAP sur EAPHost. Ce handle est obtenu par un appel précédent à EapPeerBeginSession.

pcbSendPacket

Pointeur vers une valeur qui contient la taille en octets de la mémoire tampon allouée pour le paquet de réponse. Au retour, ce paramètre reçoit un pointeur vers la taille réelle en octets de pSendPacket.

pSendPacket

Pointeur vers une structure EapPacket qui contient le paquet de réponse.

ppEapError

Pointeur vers l’adresse d’une structure de EAP_ERROR qui contient les erreurs générées pendant l’exécution de cet appel de fonction. Après avoir consommé les données d’erreur, cette mémoire doit être libérée en appelantEapPeerFreeErrorMemory.

EapPeerGetResult

Pointeur de fonction pour EapPeerGetResult.

sessionHandle

EAP_SESSION_HANDLE valeur qui contient le handle spécifique de la session d’authentification EAP sur EAPHost. Ce handle est obtenu par un appel précédent à EapPeerBeginSession.

reason

Valeur d’énumération qui spécifie le code de raison du résultat d’authentification retourné dans ppResult.

ppResult

Pointeur vers une structure EapHostPeerMethodResult qui contient les résultats de l’authentification.

ppEapError

Pointeur vers l’adresse d’une structure de EAP_ERROR qui contient les erreurs générées pendant l’exécution de cet appel de fonction. Après avoir consommé les données d’erreur, cette mémoire doit être libérée en passant un pointeur vers EapPeerFreeErrorMemory.

EapPeerGetUIContext

Pointeur de fonction pour EapPeerGetUIContext.

sessionHandle

EAP_SESSION_HANDLE valeur qui contient le handle spécifique de la session d’authentification EAP sur EAPHost. Ce handle est obtenu par un appel précédent à EapPeerBeginSession.

pdwSizeOfUIContextData

Pointeur vers une valeur qui spécifie la taille de la mémoire tampon d’octets de données de contexte de l’interface utilisateur retournée dans ppUIContextData.

ppUIContextData

Pointeur vers une adresse qui contient une mémoire tampon d’octets avec les données de contexte d’interface utilisateur de la requête d’EAPHost.

ppEapError

Pointeur vers l’adresse d’une structure de EAP_ERROR qui contient les erreurs générées pendant l’exécution de cet appel de fonction. Après avoir consommé les données d’erreur, cette mémoire doit être libérée en passant un pointeur vers les données d’erreur vers EapPeerFreeErrorMemory.

EapPeerSetUIContext

Pointeur de fonction pour EapPeerSetUIContext.

sessionHandle

EAP_SESSION_HANDLE valeur qui contient le handle spécifique de la session d’authentification EAP sur EAPHost. Ce handle est obtenu par un appel précédent à EapPeerBeginSession.

dwSizeOfUIContextData

Pointeur vers une valeur qui spécifie la taille de la mémoire tampon d’octets de données de contexte de l’interface utilisateur fournie dans pUIContextData.

pUIContextData

Pointeur vers une adresse qui contient une mémoire tampon d’octets avec les nouvelles données de contexte d’interface utilisateur à définir sur EAPHost.

pEapOutput

Pointeur vers une structure EapPeerMethodOutput qui contient la sortie de l’opération de processus de paquets.

ppEapError

Pointeur vers l’adresse d’une structure de EAP_ERROR qui contient les erreurs générées pendant l’exécution de cet appel de fonction. Après avoir consommé les données d’erreur, cette mémoire doit être libérée en passant un pointeur vers EapPeerFreeErrorMemory.

EapPeerGetResponseAttributes

Pointeur de fonction pour EapPeerGetResponseAttributes.

sessionHandle

EAP_SESSION_HANDLE valeur qui contient le handle spécifique de la session d’authentification EAP sur EAPHost. Ce handle est obtenu par un appel précédent à EapPeerBeginSession.

pAttribs

Reçoit un pointeur vers une structure EAP_ATTRIBUTES qui contient un tableau d’attributs de réponse d’authentification EAP pour le demandeur.

ppEapError

Pointeur vers l’adresse d’une structure de EAP_ERROR qui contient les erreurs générées pendant l’exécution de cet appel de fonction. Après avoir consommé les données d’erreur, cette mémoire doit être libérée en appelantEapPeerFreeErrorMemory.

EapPeerSetResponseAttributes

Pointeur de fonction pour EapPeerSetResponseAttributes.

sessionHandle

EAP_SESSION_HANDLE valeur qui contient le handle spécifique de la session d’authentification EAP sur EAPHost. Ce handle est obtenu par un appel précédent à EapPeerBeginSession.

pAttribs

Pointeur vers une structure EAP_ATTRIBUTES qui contient un tableau de nouveaux attributs de réponse d’authentification EAP à définir pour le demandeur sur EAPHost.

pEapOutput

Pointeur vers une structure EapPeerMethodOutput qui spécifie l’action suggérée que le demandeur doit prendre en réponse aux attributs mis à jour.

ppEapError

Pointeur vers l’adresse d’une structure de EAP_ERROR qui contient les erreurs générées pendant l’exécution de cet appel de fonction. Après avoir consommé les données d’erreur, cette mémoire doit être libérée en appelant EapPeerFreeErrorMemory.

EapPeerEndSession

Pointeur de fonction pour EapPeerEndSession.

sessionHandle

EAP_SESSION_HANDLE valeur qui contient le handle spécifique pour la session d’authentification EAP à fermer sur EAPHost. Ce handle est obtenu par un appel précédent à EapPeerBeginSession.

ppEapError

Pointeur vers l’adresse d’une structure de EAP_ERROR qui contient les erreurs générées pendant l’exécution de cet appel de fonction. Après avoir consommé les données d’erreur, cette mémoire doit être libérée en appelant EapPeerFreeErrorMemory.

EapPeerShutdown

Pointeur de fonction pour EapPeerShutdown.

ppEapError

Pointeur vers l’adresse d’une structure de EAP_ERROR qui contient les erreurs générées pendant l’exécution de cet appel de fonction. Après avoir consommé les données d’erreur, cette mémoire doit être libérée en passant un pointeur vers EapPeerFreeErrorMemory.

Remarques

Chaque DLL de méthode EAP doit implémenter les API suivantes :

Ces API correspondent aux appels effectués par un demandeur et servent de proxy entre les appels d’API du demandeur et les API publiques exposées sur la DLL de la méthode EAP. Par conséquent, lorsqu’un demandeur appelle un EAPHost basé sur un homologue pour établir une session d’authentification ou effectuer une opération pendant cette session, EAPHost appelle la fonction implémentée correspondante sur la DLL de méthode EAP avec les données de paramètre fournies. Les fonctions de méthode EAP sont gérées par des pointeurs vers leurs points d’entrée respectifs.

Les autres fonctions de l’ensemble d’API de méthode d’homologue EAP sont appelées par un EAPHost basé sur des homologues sans appel de demande correspondant, et sont utilisées pour les opérations de validation de connexion ou de levée de l’interface utilisateur.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2008 [applications de bureau uniquement]
En-tête eapmethodpeerapis.h

Voir aussi

Structures de méthode homologue EAPHost

EapPeerGetInfo