EAP_AUTHENTICATOR_METHOD_ROUTINES構造体 (eapmethodauthenticatorapis.h)

EAPHost Authenticator メソッド API への関数ポインターのセットが含まれています。

構文

typedef struct _EAP_AUTHENTICATOR_METHOD_ROUTINES {
  DWORD           dwSizeInBytes;
  EAP_METHOD_TYPE *pEapType;
  DWORD(EAP_METHOD_TYPE *pEapType,EAP_ERROR **ppEapError)          * )(EapMethodAuthenticatorInitialize;
  DWORD(ORD dwFlags,LPCWSTR pwszIdentity, const EapAttributes * const pAttributeArray,DWORD dwSizeofConnectionData, const BYTE * const pConnectionData,DWORD dwMaxSendPacketSize,EAP_SESSION_HANDLE *pSessionHandle,EAP_ERROR **ppEapError)          * )(DWEapMethodAuthenticatorBeginSession;
  DWORD(AP_SESSION_HANDLE sessionHandle,DWORD dwFlags, const WCHAR *pwszIdentity, const EapAttributes * const pAttributeArray,EAP_ERROR **ppEapError)          * )(EEapMethodAuthenticatorUpdateInnerMethodParams;
  DWORD(AP_SESSION_HANDLE sessionHandle,DWORD cbReceivePacket, const EapPacket * const pReceivePacket,EAP_METHOD_AUTHENTICATOR_RESPONSE_ACTION *pEapOutput,EAP_ERROR **ppEapError)          * )(EEapMethodAuthenticatorReceivePacket;
  DWORD(P_SESSION_HANDLE sessionHandle,BYTE bPacketId,DWORD *pcbSendPacket,EapPacket *pSendPacket,EAP_AUTHENTICATOR_SEND_TIMEOUT *pTimeout,EAP_ERROR **ppEapError)          * )(EAEapMethodAuthenticatorSendPacket;
  DWORD(EAP_SESSION_HANDLE sessionHandle,EapAttributes *pAttribs,EAP_ERROR **ppEapError)          * )(EapMethodAuthenticatorGetAttributes;
  DWORD(AP_SESSION_HANDLE sessionHandle, const EapAttributes * const pAttribs,EAP_METHOD_AUTHENTICATOR_RESPONSE_ACTION *pEapOutput,EAP_ERROR **ppEapError)          * )(EEapMethodAuthenticatorSetAttributes;
  DWORD(EAP_SESSION_HANDLE sessionHandle,EAP_METHOD_AUTHENTICATOR_RESULT *pResult,EAP_ERROR **ppEapError)          * )(EapMethodAuthenticatorGetResult;
  DWORD((EAP_SESSION_HANDLE sessionHandle,EAP_ERROR **ppEapError)          * )EapMethodAuthenticatorEndSession;
  DWORD(EAP_METHOD_TYPE *pEapType,EAP_ERROR **ppEapError)          * )(EapMethodAuthenticatorShutdown;
} EAP_AUTHENTICATOR_METHOD_ROUTINES, *PEAP_AUTHENTICATOR_METHOD_ROUTINES;

メンバー

dwSizeInBytes

実装者が定義した構造体のバージョン。

メモ このフィールドの値は、Microsoft によって定義されていません。

 

pEapType

この構造体のメンバーが指す API の実装者に関するベンダー情報を含むEAP_METHOD_TYPE構造体へのポインター。

EapMethodAuthenticatorInitialize

EapMethodAuthenticatorInitialize への関数ポインター。

pEapType

EAP_METHOD_TYPE このセッションに使用する EAP 認証の種類を指定する列挙値です。

ppEapError

この関数呼び出しの実行中に EAPHost によって発生したエラーを含む EAP_ERROR 構造体のアドレスへのポインター。 エラー データを使用した後、エラー データへのポインターを EapPeerFreeErrorMemory に渡すことで、このメモリを解放する必要があります。

EapMethodAuthenticatorBeginSession

EapMethodAuthenticatorBeginSession への関数ポインター。

dwFlags

EAP 認証セッションの動作を記述する EAP フラグ の組み合わせ。

pwszIdentity

認証するユーザーの ID を含む 0 で終わる Unicode 文字列。

pAttributeArray

認証するエンティティの EAP 属性を指定する EapAttributes 配列構造体へのポインター。

dwSizeOfConnectionData

pConnectionData で提供される接続データ バッファーのサイズをバイト単位で指定します。

pConnectionData

不透明な構成データ BLOB を含むバイト バッファーへのポインター。

dwMaxSendPacketSize

セッション中に送信される EAP パケットの最大サイズをバイト単位で指定します。

pSessionHandle

サーバー EAPHost 上の新しい EAP 認証セッションの一意の ID を含む EAP_SESSION_HANDLE 構造体へのポインターを受け取ります。

ppEapError

この関数呼び出しの実行中に EAPHost によって発生したエラーを含む EAP_ERROR 構造体のアドレスへのポインター。 エラー データを使用した後、エラー データへのポインターを EapPeerFreeErrorMemory に渡すことで、このメモリを解放する必要があります。

EapMethodAuthenticatorUpdateInnerMethodParams

EapMethodAuthenticatorUpdateInnerMethodParams への関数ポインター。

sessionHandle

EAP_SESSION_HANDLE サーバー EAPHost 上の EAP 認証セッションの特定のハンドルを含む値です。 このハンドルは、EapMethodAuthenticatorBeginSession の以前の呼び出しによって取得されます

dwFlags

EAP 認証セッションの動作を記述する EAP フラグ の組み合わせ。

pwszIdentity

認証するユーザーの更新された ID を含む、0 で終わる Unicode 文字列。

pAttributeArray

認証するエンティティの更新された EAP 属性を指定する EapAttributes 配列構造体へのポインター。

ppEapError

この関数呼び出しの実行中に発生したエラーを含む EAP_ERROR 構造体のアドレスへのポインター。 エラー データを使用した後、エラー データへのポインターを EapMethodAuthenticatorFreeErrorMemory に渡すことで、このメモリを解放する必要があります。

EapMethodAuthenticatorReceivePacket

EapMethodAuthenticatorReceivePacket への関数ポインター。

sessionHandle

EAP_SESSION_HANDLE サーバー EAPHost 上の EAP 認証セッションの特定のハンドルを含む値です。 このハンドルは、EapMethodAuthenticatorBeginSession の以前の呼び出しによって取得されます

cbReceivePacket

pReceivePacket のサイズ (バイト単位)。

pReceivePacket

サーバー EAPHost によってサプリカントから受信された EAP 認証セッション パケットを含む EapPacket 構造体へのポインター。

pEapOutput

サプリカントが EAP 認証セッションで次に実行する必要があるアクションを示す、 EAP_METHOD_AUTHENTICATOR_RESPONSE_ACTION 列挙値へのポインターを受け取ります。

ppEapError

この関数呼び出しの実行中に EAPHost によって発生したエラーを含む EAP_ERROR 構造体のアドレスへのポインター。 エラー データを使用した後、エラー データへのポインターを EapMethodAuthenticatorFreeErrorMemory に渡すことで、このメモリを解放する必要があります。

EapMethodAuthenticatorSendPacket

EapMethodAuthenticatorSendPacket への関数ポインター。

sessionHandle

EAP_SESSION_HANDLE サーバー EAPHost 上の EAP 認証セッションの特定のハンドルを含む値です。 このハンドルは、EapMethodAuthenticatorBeginSession の以前の呼び出しによって取得されます

bPacketId

送信するパケットの数値 ID 値を指定します。

pcbSendPacket

送信するパケットの最大サイズをバイト単位で指定します。 戻り値の場合、このパラメーターは pEapPacket で返されるパケットのサイズ (バイト単位) を受け取ります。

pSendPacket

サプリカントに送信するパケットを含む EapPacket 構造体へのポインターを受け取ります。

pTimeout

パケットのタイムアウトを指定する EAP_AUTHENTICATOR_SEND_TIMEOUT 値へのポインターを受け取ります。

ppEapError

この関数呼び出しの実行中に発生したエラーを含む EAP_ERROR 構造体のアドレスへのポインター。 エラー データを使用した後、エラー データへのポインターを EapMethodAuthenticatorFreeErrorMemory に渡すことで、このメモリを解放する必要があります。

EapMethodAuthenticatorGetAttributes

EapMethodAuthenticatorGetAttributes への関数ポインター。

sessionHandle

EAP_SESSION_HANDLE サーバー EAPHost 上の EAP 認証セッションの特定のハンドルを含む値です。 このハンドルは、EapMethodAuthenticatorBeginSession の以前の呼び出しによって取得されます

pAttribs

サプリカントの EAP 認証応答属性の配列を含む EapAttributes 構造体へのポインターを受け取ります。

ppEapError

この関数呼び出しの実行中に発生したエラーを含む EAP_ERROR 構造体のアドレスへのポインター。 エラー データを使用した後、エラー データへのポインターを EapMethodAuthenticatorFreeErrorMemory に渡すことで、このメモリを解放する必要があります。

EapMethodAuthenticatorSetAttributes

EapMethodAuthenticatorSetAttributes への関数ポインター。

sessionHandle

EAP_SESSION_HANDLE サーバー EAPHost 上の EAP 認証セッションの特定のハンドルを含む値です。 このハンドルは、EapMethodAuthenticatorBeginSession の以前の呼び出しによって取得されます

pAttribs

EAPHost 上のサプリカントに設定する新しい EAP 認証応答属性の配列を含む EapAttributes 構造体へのポインター。

pEapOutput

更新された属性への応答としてサプリカントが実行する必要がある推奨アクションを指定する、 EAP_METHOD_AUTHENTICATOR_RESPONSE_ACTION 列挙値へのポインターを受け取ります。

ppEapError

この関数呼び出しの実行中に発生したエラーを含む EAP_ERROR 構造体のアドレスへのポインター。 エラー データを使用した後、エラー データへのポインターを EapMethodAuthenticatorFreeErrorMemory に渡すことで、このメモリを解放する必要があります。

EapMethodAuthenticatorGetResult

EapMethodAuthenticatorGetResult への関数ポインター。

sessionHandle

EAP_SESSION_HANDLE サーバー EAPHost 上の EAP 認証セッションの特定のハンドルを含む値です。 このハンドルは、EapMethodAuthenticatorBeginSession の以前の呼び出しによって取得されます

pResult

認証結果を含む EAP_METHOD_AUTHENTICATOR_RESULT 構造体へのポインターを受け取ります。

ppEapError

この関数呼び出しの実行中に EAPHost によって発生したエラーを含む EAP_ERROR 構造体のアドレスへのポインター。 エラー データを使用した後、エラー データへのポインターを EapMethodAuthenticatorFreeErrorMemory に渡すことで、このメモリを解放する必要があります。

EapMethodAuthenticatorEndSession

EapMethodAuthenticatorEndSession への関数ポインター。

sessionHandle

EAP_SESSION_HANDLE サーバー EAPHost で閉じる EAP 認証セッションの特定のハンドルを含む値です。 このハンドルは、 EapMethodAuthenticatorBeginSession の以前の呼び出しによって取得されます。

ppEapError

この関数呼び出しの実行中に EAPHost によって発生したエラーを含む EAP_ERROR 構造体のアドレスへのポインター。 エラー データを使用した後、エラー データへのポインターを EapMethodAuthenticatorFreeErrorMemory に渡すことで、このメモリを解放する必要があります。

EapMethodAuthenticatorShutdown

EapMethodAuthenticatorShutdown への関数ポインター。

pEapType

セッションで使用される EAP 認証の種類を指定する EAP_METHOD_TYPE 列挙値。

ppEapError

この関数呼び出しの実行中に発生したエラーを含む EAP_ERROR 構造体のアドレスへのポインター。 エラー データを使用した後、エラー データへのポインターを EapMethodAuthenticatorFreeErrorMemory に渡すことで、このメモリを解放する必要があります。

解説

すべての EAP 認証メソッド DLL には、次の API のパブリック実装が必要です。

• EapMethodAuthenticatorInitialize
• EapMethodAuthenticatorBeginSession
• EapMethodAuthenticatorUpdateInnerMethodParams
• EapMethodAuthenticatorReceivePacket
• EapMethodAuthenticatorSendPacket
• EapMethodAuthenticatorGetAttributes
• EapMethodAuthenticatorSetAttributes
• EapMethodAuthenticatorGetResult
• EapMethodAuthenticatorEndSession
• EapMethodAuthenticatorShutdown

これらの API は、認証子 (サーバー) EAPHost がピア (クライアント) EAP メソッドから特定の対応するリモート プロシージャ 呼び出しを受信すると、EAP 認証メソッドで呼び出されます。 EAP ピア メソッドと EAP 認証メソッドの間には、完全な 1 対 1 の対応は存在しないことに注意してください。特定の EAP 認証メソッド API 呼び出しは、EAP 認証メソッド API 呼び出しの実装の要件に基づいて行う必要があります。

要件

サポートされている最小のクライアント	Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows Server 2008 [デスクトップ アプリのみ]
Header	eapmethodauthenticatorapis.h

関連項目

EAPHost Authenticator メソッドの構造

EapMethodAuthenticatorGetInfo