Compartilhar via

estrutura EAP_PEER_METHOD_ROUTINES (eapmethodpeerapis.h)

  • Artigo

Contém um conjunto de ponteiros de função para as APIs de método par EAPHost.

Sintaxe

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;

Membros

dwVersion

A versão da estrutura definida pelo implementador.

Nota Os valores para esse campo não são definidos pela Microsoft.
 

pEapType

Um ponteiro para uma estrutura EAP_TYPE que contém as informações do fornecedor sobre o implementador das APIs apontadas pelos membros dessa estrutura.

EapPeerInitialize

Um ponteiro de função para EapPeerInitialize.

pEapError

Um ponteiro para a estrutura EAP_ERROR que contém quaisquer erros gerados durante a execução dessa chamada de função. Depois de consumir os dados de erro, essa memória deve ser liberada passando um ponteiro para EapPeerFreeErrorMemory.

EapPeerGetIdentity

Um ponteiro de função para EapPeerGetIdentity.

Dwflags

Uma combinação de sinalizadores EAP que descrevem o comportamento da sessão de autenticação EAP.

dwSizeofConnectionData

Especifica o tamanho, em bytes, do buffer de dados de conexão fornecido em pConnectionData

pConnectionData

Um ponteiro para um buffer de bytes que contém o BLOB de dados de configuração opaco.

dwSizeOfUserData

Especifica o tamanho, em bytes, do buffer de dados do usuário fornecido em pUserData.

Puserdata

Um ponteiro para os dados do usuário específicos para essa autenticação usada para preencher previamente os dados do usuário. Quando essa API é chamada pela primeira vez ou quando uma nova sessão de autenticação é iniciada, esse parâmetro é NULL. Caso contrário, defina esse parâmetro como o membro pUserData da estrutura apontada pelo parâmetro ppResult recebido por EapPeerGetResult.

hTokenImpersonateUser

Especifica um identificador para o token de representação do usuário que está sendo autenticado. Esse identificador será NULL ao fazer a autenticação do computador. Usando esse identificador, um método EAP pode representar o usuário com a finalidade de obter informações específicas do usuário, como nome de usuário, nome de domínio e credenciais.

pfInvokeUI

Retornará TRUE se a identidade do usuário e o blob de dados do usuário não forem retornados com êxito e o método buscar coletar as informações do usuário por meio da caixa de diálogo de interface do usuário.

pdwSizeOfUserDataOut

Especifica o tamanho, em bytes, do buffer ppUserDataOut .

ppUserDataOut

Um ponteiro para um ponteiro para os dados de usuário retornados. Os dados são passados para EapPeerBeginSession como pUserData de entrada.

ppwszIdentity

Um ponteiro para a identidade do usuário retornada. O ponteiro será incluído no pacote de resposta de identidade e retornado ao servidor.

ppEapError

Um ponteiro para o ponteiro para uma estrutura EAP_ERROR que contém quaisquer erros gerados durante a execução dessa chamada de função. Depois de consumir os dados de erro, essa memória deve ser liberada chamando EapPeerFreeErrorMemory.

EapPeerBeginSession

Um ponteiro de função para EapPeerBeginSession.

dwFlags

Uma combinação de sinalizadores EAP que descrevem o novo comportamento da sessão de autenticação EAP.

pAttributeArray

Ponteiro para uma estrutura de matriz EAP_ATTRIBUTES que especifica os atributos EAP da entidade a ser autenticada.

hTokenImpersonateUser

Especifica um identificador para o token de representação do usuário a ser usado nesta sessão.

dwSizeOfConnectionData

Especifica o tamanho, em bytes, do buffer de dados de conexão fornecido em pConnectionData.

pConnectionData

Ponteiro para um buffer de bytes que contém o BLOB de dados de configuração opaco.

dwSizeOfUserData

Especifica o tamanho em bytes do buffer de dados do usuário fornecido em pUserData.

Puserdata

Ponteiro para um buffer de bytes que contém o BLOB de dados opacos do usuário.

dwMaxSendPacketSize

Especifica o tamanho máximo em bytes de um pacote EAP enviado durante a sessão. Se o método precisar enviar um pacote maior que o tamanho máximo, o método deverá acomodar a fragmentação e remontar.

pSessionHandle

Ponteiro para uma estrutura EAP_SESSION_HANDLE que contém a ID exclusiva para a nova sessão de autenticação EAP no EAPHost

ppEapError

Ponteiro para o endereço de uma estrutura EAP_ERROR que contém quaisquer erros gerados pelo EAPHost durante a execução dessa chamada de função. Depois de consumir os dados de erro, essa memória deve ser liberada chamando EapPeerFreeErrorMemory.

EapPeerSetCredentials

Um ponteiro de função para EapPeerSetCredentials.

sessionHandle

Um ponteiro para uma estrutura de EAP_SESSION_HANDLE que contém o identificador exclusivo para essa sessão de autenticação EAP no servidor EAPHost. Esse identificador é retornado no parâmetro pSessionHandle em uma chamada anterior para EapPeerBeginSession.

pwszIdentity

Ponteiro que especifica a identidade do usuário para a qual definir as credenciais. Essa cadeia de caracteres de identidade do usuário é obtida chamando a função EapPeerGetIdentity .

pwszPassword

Um ponteiro que contém a senha de texto não criptografado para a identidade do usuário.

ppEapError

Ponteiro para o endereço de uma estrutura EAP_ERROR que contém quaisquer erros gerados durante a execução dessa chamada de função. Depois de consumir os dados de erro, essa memória deve ser liberada chamando EapPeerFreeErrorMemory.

EapPeerProcessRequestPacket

Um ponteiro de função para EapPeerProcessRequestPacket.

sessionHandle

EAP_SESSION_HANDLE valor que contém o identificador específico para a sessão de autenticação EAP no EAPHost. Esse identificador é obtido por uma chamada anterior para EapPeerBeginSession.

cbReceivePacket

O tamanho em bytes do pacote de solicitação especificado em pReceivePacket.

pReceivePacket

Ponteiro para uma estrutura EapPacket que contém o pacote de solicitação a ser processado.

pEapOutput

Ponteiro para uma estrutura EapPeerMethodOutput que contém a saída da operação de processo de pacote.

ppEapError

Ponteiro para o endereço de uma estrutura EAP_ERROR que contém quaisquer erros gerados durante a execução dessa chamada de função. Depois de consumir os dados de erro, essa memória deve ser liberada chamando EapPeerFreeErrorMemory.

EapPeerGetResponsePacket

Um ponteiro de função para EapPeerGetResponsePacket.

sessionHandle

EAP_SESSION_HANDLE valor que contém o identificador específico para a sessão de autenticação EAP no EAPHost. Esse identificador é obtido por uma chamada anterior para EapPeerBeginSession.

pcbSendPacket

Ponteiro para um valor que contém o tamanho em bytes do buffer alocado para o pacote de resposta. No retorno, esse parâmetro recebe um ponteiro para o tamanho real em bytes de pSendPacket.

pSendPacket

Ponteiro para uma estrutura EapPacket que contém o pacote de resposta.

ppEapError

Ponteiro para o endereço de uma estrutura EAP_ERROR que contém erros gerados durante a execução dessa chamada de função. Depois de consumir os dados de erro, essa memória deve ser liberada chamandoEapPeerFreeErrorMemory.

EapPeerGetResult

Um ponteiro de função para EapPeerGetResult.

sessionHandle

EAP_SESSION_HANDLE valor que contém o identificador específico para a sessão de autenticação EAP no EAPHost. Esse identificador é obtido por uma chamada anterior para EapPeerBeginSession.

reason

Valor de enumeração que especifica o código de motivo para o resultado da autenticação retornado em ppResult.

ppResult

Ponteiro para uma estrutura EapHostPeerMethodResult que contém os resultados da autenticação.

ppEapError

Ponteiro para o endereço de uma estrutura EAP_ERROR que contém erros gerados durante a execução dessa chamada de função. Depois de consumir os dados de erro, essa memória deve ser liberada passando um ponteiro para EapPeerFreeErrorMemory.

EapPeerGetUIContext

Um ponteiro de função para EapPeerGetUIContext.

sessionHandle

EAP_SESSION_HANDLE valor que contém o identificador específico para a sessão de autenticação EAP no EAPHost. Esse identificador é obtido por uma chamada anterior para EapPeerBeginSession.

pdwSizeOfUIContextData

Ponteiro para um valor que especifica o tamanho do buffer de bytes de dados de contexto da interface do usuário retornado em ppUIContextData.

ppUIContextData

Ponteiro para um endereço que contém um buffer de bytes com os dados de contexto de interface do usuário suplicantes do EAPHost.

ppEapError

Ponteiro para o endereço de uma estrutura EAP_ERROR que contém erros gerados durante a execução dessa chamada de função. Depois de consumir os dados de erro, essa memória deve ser liberada passando um ponteiro para os dados de erro para EapPeerFreeErrorMemory.

EapPeerSetUIContext

Um ponteiro de função para EapPeerSetUIContext.

sessionHandle

EAP_SESSION_HANDLE valor que contém o identificador específico para a sessão de autenticação EAP no EAPHost. Esse identificador é obtido por uma chamada anterior para EapPeerBeginSession.

dwSizeOfUIContextData

Ponteiro para um valor que especifica o tamanho do buffer de bytes de dados de contexto da interface do usuário fornecido em pUIContextData.

pUIContextData

Ponteiro para um endereço que contém um buffer de bytes com os novos dados de contexto de interface do usuário suplicantes a serem definidos no EAPHost.

pEapOutput

Um ponteiro para uma estrutura EapPeerMethodOutput que contém a saída da operação do processo de pacote.

ppEapError

Ponteiro para o endereço de uma estrutura EAP_ERROR que contém erros gerados durante a execução dessa chamada de função. Depois de consumir os dados de erro, essa memória deve ser liberada passando um ponteiro para EapPeerFreeErrorMemory.

EapPeerGetResponseAttributes

Um ponteiro de função para EapPeerGetResponseAttributes.

sessionHandle

EAP_SESSION_HANDLE valor que contém o identificador específico para a sessão de autenticação EAP no EAPHost. Esse identificador é obtido por uma chamada anterior para EapPeerBeginSession.

pAttribs

Recebe um ponteiro para uma estrutura EAP_ATTRIBUTES que contém uma matriz de atributos de resposta de autenticação EAP para o supplicante.

ppEapError

Ponteiro para o endereço de uma estrutura EAP_ERROR que contém erros gerados durante a execução dessa chamada de função. Depois de consumir os dados de erro, essa memória deve ser liberada chamandoEapPeerFreeErrorMemory.

EapPeerSetResponseAttributes

Um ponteiro de função para EapPeerSetResponseAttributes.

sessionHandle

EAP_SESSION_HANDLE valor que contém o identificador específico para a sessão de autenticação EAP no EAPHost. Esse identificador é obtido por uma chamada anterior para EapPeerBeginSession.

pAttribs

Ponteiro para uma estrutura EAP_ATTRIBUTES que contém uma matriz de novos atributos de resposta de autenticação EAP a serem definidos para o suplicante no EAPHost.

pEapOutput

Um ponteiro para uma estrutura EapPeerMethodOutput que especifica a ação sugerida que o supplicante deve tomar como resposta aos atributos atualizados.

ppEapError

Ponteiro para o endereço de uma estrutura EAP_ERROR que contém erros gerados durante a execução dessa chamada de função. Depois de consumir os dados de erro, essa memória deve ser liberada chamando EapPeerFreeErrorMemory.

EapPeerEndSession

Um ponteiro de função para EapPeerEndSession.

sessionHandle

EAP_SESSION_HANDLE valor que contém o identificador específico para a sessão de autenticação EAP ser fechada no EAPHost. Esse identificador é obtido por uma chamada anterior para EapPeerBeginSession.

ppEapError

Ponteiro para o endereço de uma estrutura EAP_ERROR que contém erros gerados durante a execução dessa chamada de função. Depois de consumir os dados de erro, essa memória deve ser liberada chamando EapPeerFreeErrorMemory.

EapPeerShutdown

Um ponteiro de função para EapPeerShutdown.

ppEapError

Ponteiro para o endereço de uma estrutura EAP_ERROR que contém erros gerados durante a execução dessa chamada de função. Depois de consumir os dados de erro, essa memória deve ser liberada passando um ponteiro para EapPeerFreeErrorMemory.

Comentários

Cada DLL do método EAP deve implementar as seguintes APIs:

Essas APIs correspondem a chamadas feitas por um suplicante e servem como um proxy entre as chamadas à API do supplicante e as APIs públicas expostas na DLL do método EAP. Portanto, quando um suplicante faz uma chamada para um EAPHost baseado em pares para estabelecer uma sessão de autenticação ou executar uma operação durante essa sessão, o EAPHost chama a função implementada correspondente na DLL do método EAP com os dados de parâmetro fornecidos. As funções do método EAP são gerenciadas por ponteiros para seus respectivos pontos de entrada.

As outras funções no conjunto de API de Método par EAP são chamadas por um EAPHost baseado em pares sem uma chamada suplicante correspondente e são usadas para operações de validação de conexão ou de criação de interface do usuário.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2008 [somente aplicativos da área de trabalho]
Cabeçalho eapmethodpeerapis.h

Confira também

Estruturas de método par EAPHost

EapPeerGetInfo