struttura EAP_PEER_METHOD_ROUTINES (eapmethodpeerapis.h)
Contiene un set di puntatori a funzione alle API del metodo peer EAPHost.
Sintassi
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;
Members
dwVersion
Versione della struttura definita dall'implementer.
pEapType
Puntatore a una struttura EAP_TYPE che contiene le informazioni del fornitore sull'implementatore delle API a cui puntano i membri di questa struttura.
EapPeerInitialize
Puntatore a funzione per EapPeerInitialize.
pEapError
Puntatore alla struttura EAP_ERROR che contiene eventuali errori generati durante l'esecuzione di questa chiamata di funzione. Dopo aver utilizzato i dati di errore, questa memoria deve essere liberata passando un puntatore a EapPeerFreeErrorMemory.
EapPeerGetIdentity
Puntatore a funzione per EapPeerGetIdentity.
Dwflags
Combinazione di flag EAP che descrivono il comportamento della sessione di autenticazione EAP.
dwSizeofConnectionData
Specifica le dimensioni, in byte, del buffer dei dati di connessione fornito in pConnectionData
pConnectionData
Puntatore a un buffer di byte che contiene il BLOB di dati di configurazione opaco.
dwSizeOfUserData
Specifica le dimensioni, in byte, del buffer dei dati utente fornito in pUserData.
pUserData
Puntatore ai dati utente specifici di questa autenticazione usata per precompilare i dati utente. Quando questa API viene chiamata per la prima volta o quando viene avviata una nuova sessione di autenticazione, questo parametro è NULL. In caso contrario, impostare questo parametro sul membro pUserData della struttura a cui punta il parametro ppResult ricevuto da EapPeerGetResult.
hTokenImpersonateUser
Specifica un handle per il token di rappresentazione dell'utente autenticato. Questo handle sarà NULL quando si esegue l'autenticazione del computer. Usando questo handle un metodo EAP può rappresentare l'utente allo scopo di ottenere informazioni specifiche dell'utente, ad esempio nome utente, nome di dominio e credenziali.
pfInvokeUI
Restituisce TRUE se l'identità utente e il BLOB di dati utente non vengono restituiti correttamente e il metodo cerca di raccogliere le informazioni dall'utente tramite la finestra di dialogo dell'interfaccia utente.
pdwSizeOfUserDataOut
Specifica le dimensioni, in byte, del buffer ppUserDataOut .
ppUserDataOut
Puntatore a un puntatore ai dati utente restituiti. I dati vengono passati a EapPeerBeginSession come input pUserData.
ppwszIdentity
Puntatore all'identità utente restituita. Il puntatore verrà incluso nel pacchetto di risposta identity e restituito al server.
ppEapError
Puntatore al puntatore a una struttura EAP_ERROR che contiene eventuali errori generati durante l'esecuzione di questa chiamata di funzione. Dopo aver utilizzato i dati di errore, questa memoria deve essere liberata chiamando EapPeerFreeErrorMemory.
EapPeerBeginSession
Puntatore a funzione per EapPeerBeginSession.
dwFlags
Combinazione di flag EAP che descrivono il nuovo comportamento della sessione di autenticazione EAP.
pAttributeArray
Puntatore a una struttura di matrice EAP_ATTRIBUTES che specifica gli attributi EAP dell'entità da autenticare.
hTokenImpersonateUser
Specifica un handle per il token di rappresentazione dell'utente da usare in questa sessione.
dwSizeOfConnectionData
Specifica le dimensioni, in byte, del buffer dei dati di connessione fornito in pConnectionData.
pConnectionData
Puntatore a un buffer di byte contenente il BLOB dei dati di configurazione opaco.
dwSizeOfUserData
Specifica le dimensioni in byte del buffer dei dati utente fornito in pUserData.
pUserData
Puntatore a un buffer di byte che contiene il BLOB di dati utente opaco.
dwMaxSendPacketSize
Specifica le dimensioni massime in byte di un pacchetto EAP inviato durante la sessione. Se il metodo deve inviare un pacchetto superiore alla dimensione massima, il metodo deve contenere la frammentazione e il riassemblaggio.
pSessionHandle
Puntatore a una struttura di EAP_SESSION_HANDLE che contiene l'ID univoco per la nuova sessione di autenticazione EAP in EAPHost
ppEapError
Puntatore all'indirizzo di una struttura di EAP_ERROR che contiene eventuali errori generati da EAPHost durante l'esecuzione di questa chiamata di funzione. Dopo aver utilizzato i dati di errore, questa memoria deve essere liberata chiamando EapPeerFreeErrorMemory.
EapPeerSetCredentials
Puntatore a funzione per EapPeerSetCredentials.
sessionHandle
Puntatore a una struttura EAP_SESSION_HANDLE che contiene l'handle univoco per questa sessione di autenticazione EAP nel server EAPHost. Questo handle viene restituito nel parametro pSessionHandle in una chiamata precedente a EapPeerBeginSession.
pwszIdentity
Puntatore che specifica l'identità utente per cui impostare le credenziali. Questa stringa di identità utente viene ottenuta chiamando la funzione EapPeerGetIdentity .
pwszPassword
Puntatore che contiene la password di testo non crittografato per l'identità utente.
ppEapError
Puntatore all'indirizzo di una struttura EAP_ERROR che contiene eventuali errori generati durante l'esecuzione di questa chiamata di funzione. Dopo aver utilizzato i dati di errore, questa memoria deve essere liberata chiamando EapPeerFreeErrorMemory.
EapPeerProcessRequestPacket
Puntatore a funzione per EapPeerProcessRequestPacket.
sessionHandle
EAP_SESSION_HANDLE valore che contiene l'handle specifico per la sessione di autenticazione EAP in EAPHost. Questo handle viene ottenuto da una chiamata precedente a EapPeerBeginSession.
cbReceivePacket
Dimensioni in byte del pacchetto di richiesta specificato in pReceivePacket.
pReceivePacket
Puntatore a una struttura EapPacket che contiene il pacchetto di richiesta da elaborare.
pEapOutput
Puntatore a una struttura EapPeerMethodOutput che contiene l'output dell'operazione del processo di pacchetto.
ppEapError
Puntatore all'indirizzo di una struttura EAP_ERROR che contiene eventuali errori generati durante l'esecuzione di questa chiamata di funzione. Dopo aver utilizzato i dati di errore, questa memoria deve essere liberata chiamando EapPeerFreeErrorMemory.
EapPeerGetResponsePacket
Puntatore a funzione per EapPeerGetResponsePacket.
sessionHandle
EAP_SESSION_HANDLE valore che contiene l'handle specifico per la sessione di autenticazione EAP in EAPHost. Questo handle viene ottenuto da una chiamata precedente a EapPeerBeginSession.
pcbSendPacket
Puntatore a un valore contenente le dimensioni in byte del buffer allocato per il pacchetto di risposta. In caso di restituzione, questo parametro riceve un puntatore alla dimensione effettiva in byte di pSendPacket.
pSendPacket
Puntatore a una struttura EapPacket contenente il pacchetto di risposta.
ppEapError
Puntatore all'indirizzo di una struttura EAP_ERROR che contiene eventuali errori generati durante l'esecuzione di questa chiamata di funzione. Dopo aver utilizzato i dati di errore, questa memoria deve essere liberata chiamandoEapPeerFreeErrorMemory.
EapPeerGetResult
Puntatore alla funzione per EapPeerGetResult.
sessionHandle
EAP_SESSION_HANDLE valore che contiene l'handle specifico per la sessione di autenticazione EAP in EAPHost. Questo handle viene ottenuto da una chiamata precedente a EapPeerBeginSession.
reason
Valore di enumerazione che specifica il codice motivo per il risultato dell'autenticazione restituito in ppResult.
ppResult
Puntatore a una struttura EapHostPeerMethodResult contenente i risultati dell'autenticazione.
ppEapError
Puntatore all'indirizzo di una struttura EAP_ERROR che contiene eventuali errori generati durante l'esecuzione di questa chiamata di funzione. Dopo aver utilizzato i dati di errore, questa memoria deve essere liberata passando un puntatore a EapPeerFreeErrorMemory.
EapPeerGetUIContext
Puntatore di funzione per EapPeerGetUIContext.
sessionHandle
EAP_SESSION_HANDLE valore che contiene l'handle specifico per la sessione di autenticazione EAP in EAPHost. Questo handle viene ottenuto da una chiamata precedente a EapPeerBeginSession.
pdwSizeOfUIContextData
Puntatore a un valore che specifica le dimensioni del buffer di byte del contesto dell'interfaccia utente restituito in ppUIContextData.
ppUIContextData
Puntatore a un indirizzo contenente un buffer di byte con i dati del contesto dell'interfaccia utente supplicanti da EAPHost.
ppEapError
Puntatore all'indirizzo di una struttura EAP_ERROR che contiene eventuali errori generati durante l'esecuzione di questa chiamata di funzione. Dopo aver utilizzato i dati di errore, questa memoria deve essere liberata passando un puntatore ai dati degli errori a EapPeerFreeErrorMemory.
EapPeerSetUIContext
Puntatore alla funzione per EapPeerSetUIContext.
sessionHandle
EAP_SESSION_HANDLE valore che contiene l'handle specifico per la sessione di autenticazione EAP in EAPHost. Questo handle viene ottenuto da una chiamata precedente a EapPeerBeginSession.
dwSizeOfUIContextData
Puntatore a un valore che specifica le dimensioni del buffer di byte del contesto dell'interfaccia utente fornite in pUIContextData.
pUIContextData
Puntatore a un indirizzo contenente un buffer di byte con i nuovi dati del contesto dell'interfaccia utente supplicanti da impostare su EAPHost.
pEapOutput
Puntatore a una struttura EapPeerMethodOutput contenente l'output dell'operazione del processo di pacchetto.
ppEapError
Puntatore all'indirizzo di una struttura EAP_ERROR che contiene eventuali errori generati durante l'esecuzione di questa chiamata di funzione. Dopo aver utilizzato i dati di errore, questa memoria deve essere liberata passando un puntatore a EapPeerFreeErrorMemory.
EapPeerGetResponseAttributes
Puntatore alla funzione per EapPeerGetResponseAttributes.
sessionHandle
EAP_SESSION_HANDLE valore che contiene l'handle specifico per la sessione di autenticazione EAP in EAPHost. Questo handle viene ottenuto da una chiamata precedente a EapPeerBeginSession.
pAttribs
Riceve un puntatore a una struttura EAP_ATTRIBUTES contenente una matrice di attributi di risposta di autenticazione EAP per il supplicante.
ppEapError
Puntatore all'indirizzo di una struttura EAP_ERROR che contiene eventuali errori generati durante l'esecuzione di questa chiamata di funzione. Dopo aver utilizzato i dati di errore, questa memoria deve essere liberata chiamandoEapPeerFreeErrorMemory.
EapPeerSetResponseAttributes
Puntatore alla funzione per EapPeerSetResponseAttributes.
sessionHandle
EAP_SESSION_HANDLE valore che contiene l'handle specifico per la sessione di autenticazione EAP in EAPHost. Questo handle viene ottenuto da una chiamata precedente a EapPeerBeginSession.
pAttribs
Puntatore a una struttura EAP_ATTRIBUTES che contiene una matrice di nuovi attributi di risposta di autenticazione EAP da impostare per il supplicante in EAPHost.
pEapOutput
Puntatore a una struttura EapPeerMethodOutput che specifica l'azione suggerita che deve essere eseguita come risposta agli attributi aggiornati.
ppEapError
Puntatore all'indirizzo di una struttura EAP_ERROR che contiene eventuali errori generati durante l'esecuzione di questa chiamata di funzione. Dopo aver utilizzato i dati di errore, questa memoria deve essere liberata chiamando EapPeerFreeErrorMemory.
EapPeerEndSession
Puntatore di funzione per EapPeerEndSession.
sessionHandle
EAP_SESSION_HANDLE valore che contiene l'handle specifico per la sessione di autenticazione EAP da chiudere su EAPHost. Questo handle viene ottenuto da una chiamata precedente a EapPeerBeginSession.
ppEapError
Puntatore all'indirizzo di una struttura EAP_ERROR che contiene eventuali errori generati durante l'esecuzione di questa chiamata di funzione. Dopo aver utilizzato i dati di errore, questa memoria deve essere liberata chiamando EapPeerFreeErrorMemory.
EapPeerShutdown
Puntatore alla funzione per EapPeerShutdown.
ppEapError
Puntatore all'indirizzo di una struttura EAP_ERROR che contiene eventuali errori generati durante l'esecuzione di questa chiamata di funzione. Dopo aver utilizzato i dati di errore, questa memoria deve essere liberata passando un puntatore a EapPeerFreeErrorMemory.
Commenti
Ogni DLL del metodo EAP deve implementare le API seguenti:
- EapPeerInitialize
- EapPeerBeginSession
- EapPeerGetIdentity
- EapPeerSetCredentials
- EapPeerProcessRequestPacket
- EapPeerGetResponsePacket
- EapPeerGetResult
- EapPeerGetUIContext
- EapPeerSetUIContext
- EapPeerGetResponseAttributes
- EapPeerSetResponseAttributes
- EapPeerEndSession
- EapPeerShutdown
Le altre funzioni nel set di API metodo peer EAP vengono chiamate da un EAPHost basato su peer senza una chiamata supplicante corrispondente e vengono usate per la convalida della connessione o le operazioni di generazione dell'interfaccia utente.
Requisiti
Requisito | Valore |
---|---|
Client minimo supportato | Windows Vista [solo app desktop] |
Server minimo supportato | Windows Server 2008 [solo app desktop] |
Intestazione | eapmethodpeerapis.h |