| eaphostpeerconfigapis.h (6.0.6002.18005-Windows 6.0) | | eaphostpeerconfigapis.h (6.1.7600.16385-Windows 7.0) |
|---|
| | |
| skipping to change at line 24 | | skipping to change at line 24 |
|---|
| | |
| #include "objbase.h" //Required by msxml2.h | | #include "objbase.h" //Required by msxml2.h |
| #include "msxml6.h" | | #include "msxml6.h" |
| | |
| #include "EapTypes.h" | | #include "EapTypes.h" |
| | |
| #ifdef __cplusplus | | #ifdef __cplusplus |
| extern "C" { | | extern "C" { |
| #endif | | #endif |
| | |
|
| | // This API is used to enumerate all the EAP Methods installed and available for |
| | use; this |
| | // includes legacy EAP Methods too. Returns non zero return code up on error. |
| DWORD WINAPI EapHostPeerGetMethods( | | DWORD WINAPI EapHostPeerGetMethods( |
|
| EAP_METHOD_INFO_ARRAY* pEapMethodInfoArray, | | // API fills the structure to have installed EAP Methods. Caller |
| EAP_ERROR** ppEapError | | should free the inner pointers |
| | // using EapHostPeerFreeMemory starting at the inner most pointe |
| | r. |
| | OUT EAP_METHOD_INFO_ARRAY* pEapMethodInfoArray, |
| | // In case of error, API fills ppEapError if possible. Caller sh |
| | ould free ppEapError using EapHostPeerFreeErrorMemory |
| | OUT EAP_ERROR** ppEapError |
| ); | | ); |
| | |
|
| | // This API is used to retrieve the method properties for a specific configurati |
| | on |
| | // It returns non zero return code upon error. |
| | DWORD WINAPI EapHostPeerGetMethodProperties( |
| | // The version number of the API. |
| | IN DWORD dwVersion, |
| | // A combination of EAP flags that describe the EAP authenticati |
| | on session behavior. |
| | IN DWORD dwFlags, |
| | // An EAP_METHOD_TYPE structure that identifies the EAP method t |
| | he supplicant is to use. |
| | IN EAP_METHOD_TYPE eapMethodType, |
| | // A handle to the user impersonation token to use in this sessi |
| | on. |
| | IN HANDLE hUserImpersonationToken, |
| | // The size, in bytes, of the connection data buffer provided in |
| | pbEapConnData. |
| | IN DWORD dwEapConnDataSize, |
| | // Connection data used for the EAP method. |
| | IN __in_ecount(dwEapConnDataSize) const BYTE* pbEapConnData, |
| | // The size in bytes of the user data buffer provided in pbUserD |
| | ata. |
| | IN DWORD dwUserDataSize, |
| | // A pointer to a byte buffer that contains the opaque user data |
| | BLOB. |
| | IN __in_ecount(dwUserDataSize) const BYTE* pbUserData, |
| | // A pointer to the method properties array. Caller should free |
| | the inner pointers using EapHostPeerFreeMemory starting |
| | // at the inner most pointer. The caller should free empvString |
| | value only when the type is empvtString. |
| | OUT EAP_METHOD_PROPERTY_ARRAY* pMethodPropertyArray, |
| | // A pointer to a pointer to an EAP_ERROR structure that contain |
| | s any errors raised by EAPHost |
| | // during the execution of this function call. |
| | OUT EAP_ERROR** ppEapError |
| | ); |
| | |
| | // This API is used to invoke configure UI of the specified EAP Method. |
| | // API Returns non zero return code up on error. |
| DWORD WINAPI EapHostPeerInvokeConfigUI( | | DWORD WINAPI EapHostPeerInvokeConfigUI( |
|
| HWND hwndParent, | | // window handle of the parent window under which configuration |
| DWORD dwFlags, | | dialog will show up |
| EAP_METHOD_TYPE eapMethodType, | | IN HWND hwndParent, |
| DWORD dwSizeOfConfigIn, | | // Flags to control the behavior of the EAP Method. |
| __in_ecount_opt(dwSizeOfConfigIn) const BYTE* pConfigIn, | | IN DWORD dwFlags, |
| DWORD* pdwSizeOfConfigOut, | | // Identifies the EAP Method to configure |
| BYTE** ppConfigOut, | | IN EAP_METHOD_TYPE eapMethodType, |
| EAP_ERROR** pEapError | | // Size of input configuration; this could be 0 when there is no |
| | configuration |
| | IN DWORD dwSizeOfConfigIn, |
| | // input configuration, this couldb NULL when there is no config |
| | uration |
| | IN __in_ecount_opt(dwSizeOfConfigIn) const BYTE* pConfigIn, |
| | // pointer to DWORD that receives configuration after user updat |
| | ed using UI |
| | OUT DWORD* pdwSizeOfConfigOut, |
| | // buffer that receives updated configuration after user updated |
| | using UI. |
| | // Caller should free the memory using EapHostPeerFreeMemory. |
| | OUT BYTE** ppConfigOut, |
| | // In case of error, API fills ppEapError if possible. Caller sh |
| | ould free ppEapError using EapHostPeerFreeErrorMemory |
| | OUT EAP_ERROR** ppEapError |
| ); | | ); |
| | |
|
| | // This API is used to obtain the fields to be shown in Single Sign On scenario |
| | for |
| | // showing UI in long screen. The structures returned have details on how to sho |
| | w the fields. |
| | // API Returns non zero return code up on error. |
| DWORD WINAPI EapHostPeerQueryCredentialInputFields( | | DWORD WINAPI EapHostPeerQueryCredentialInputFields( |
|
| HANDLE hUserImpersonationToken, | | // handle to the impersonation token that is used while signle s |
| EAP_METHOD_TYPE eapMethodType, | | ign on. |
| DWORD dwFlags, | | IN HANDLE hUserImpersonationToken, |
| DWORD dwEapConnDataSize, | | // identifies the EAP Method supplicant wants to use |
| PBYTE pbEapConnData, | | IN EAP_METHOD_TYPE eapMethodType, |
| EAP_CONFIG_INPUT_FIELD_ARRAY *pEapConfigFieldsArray, | | // control the behavior of the EAP Methods |
| EAP_ERROR** pEapError | | IN DWORD dwFlags, |
| | // size of input configuration data |
| | IN DWORD dwEapConnDataSize, |
| | // configuration data that is used for the EAP method |
| | IN __in_ecount(dwEapConnDataSize) const BYTE* pbEapConnData, |
| | // structure that gets filled with fields and how they should be |
| | shown to the user. |
| | // Caller should free the inner pointers using EapHostPeerFreeMe |
| | mory starting |
| | // at the inner most pointer. |
| | OUT EAP_CONFIG_INPUT_FIELD_ARRAY *pEapConfigInputFieldArray, |
| | // In case of error, API fills ppEapError if possible. Caller sh |
| | ould free ppEapError using EapHostPeerFreeErrorMemory |
| | OUT EAP_ERROR** ppEapError |
| ); | | ); |
| | |
|
| | // Supplicant up on receiving user inputs from Single Sign On UI, calls this API |
| | to obtain |
| | // credential blob that could used start authentication |
| | // API Returns non zero return code up on error. |
| DWORD WINAPI EapHostPeerQueryUserBlobFromCredentialInputFields( | | DWORD WINAPI EapHostPeerQueryUserBlobFromCredentialInputFields( |
|
| HANDLE hUserImpersonationToken, | | // handle to the impersonation token that is used while signle s |
| EAP_METHOD_TYPE eapMethodType, | | ign on. |
| DWORD dwFlags, | | IN HANDLE hUserImpersonationToken, |
| DWORD dwEapConnDataSize, | | // identifies the EAP Method supplicant wants to use |
| PBYTE pbEapConnData, | | IN EAP_METHOD_TYPE eapMethodType, |
| EAP_CONFIG_INPUT_FIELD_ARRAY *pEapConfigInputFieldArray, | | // control the behavior of the EAP Methods |
| DWORD *pdwUserBlobSize, | | IN DWORD dwFlags, |
| PBYTE *ppbUserBlob, | | // size of input configuration data |
| EAP_ERROR** pEapError | | IN DWORD dwEapConnDataSize, |
| | // configuration data that is used for the EAP method |
| | IN __in_ecount(dwEapConnDataSize) const BYTE* pbEapConnData, |
| | // structure containing the data entered by the user in Single S |
| | ign On UI |
| | IN const EAP_CONFIG_INPUT_FIELD_ARRAY *pEapConfigInputFieldArray |
| | , |
| | // pointer to DWORD that receives the size of credential blob, i |
| | f supplicant passes in |
| | // non-zero size and non-NULL data below, EAPHost will just atte |
| | mpt to Update |
| | // the blob with passed in values (if method supports) instead o |
| | f creating a new one. |
| | IN OUT DWORD *pdwUserBlobSize, |
| | // Pointer that receives the credential blob that can be used in |
| | authentication. |
| | // For incoming data caller should always allocate this memory u |
| | sing LocalAlloc() |
| | // Caller should free the memory using EapHostPeerFreeMemory. |
| | IN OUT __deref_out_ecount(*pdwUserBlobSize) BYTE **ppbUserBlob, |
| | // In case of error, API fills ppEapError if possible. Caller sh |
| | ould free ppEapError using EapHostPeerFreeErrorMemory |
| | OUT EAP_ERROR** ppEapError |
| ); | | ); |
| | |
|
| | // Tunnel Methods call this function to invoke Identity UI of the inner Methods. |
| | // This function returns the identity as well as the credentials to use to start |
| | the authentication. |
| | DWORD WINAPI EapHostPeerInvokeIdentityUI ( |
| | // API's version number for ease of interoperability. It must be |
| | 0. |
| | IN DWORD dwVersion, |
| | // identifies the EAP Method supplicant wants to use |
| | IN EAP_METHOD_TYPE eapMethodType, |
| | // EAP_FLAG_xxx defined in eaptypes.w |
| | IN DWORD dwFlags, |
| | // window handle of the parent window under which configuration |
| | dialog will show up |
| | IN HWND hwndParent, |
| | // size of the buffer (pConnectionData) in bytes |
| | IN DWORD dwSizeofConnectionData, |
| | // configuration data that is used for the EAP method |
| | IN __in_ecount(dwSizeofConnectionData) const BYTE* pConnectionDa |
| | ta, |
| | // size of the ubuffer pUserData |
| | IN DWORD dwSizeofUserData, |
| | // user credential information pertinent to this auth |
| | IN __in_ecount_opt(dwSizeofUserData) const BYTE* pUserData, |
| | // size of the buffer pUserDataOut. |
| | IN OUT DWORD* pdwSizeOfUserDataOut, |
| | // user data information returned by method. |
| | // Caller should release this using EapHostPeerFreeMemory |
| | OUT __deref_out_ecount(*pdwSizeOfUserDataOut)BYTE** ppUserDataOu |
| | t, |
| | // identity returned by method. Caller should release this using |
| | EapHostPeerFreeMemory |
| | OUT __deref_out LPWSTR* ppwszIdentity, |
| | // In case of error, API fills ppEapError if possible. Caller sh |
| | ould free ppEapError |
| | // using EapHostPeerFreeErrorMemory |
| | OUT EAP_ERROR** ppEapError, |
| | // Reserved for future usage. It must be NULL. |
| | IN OUT LPVOID *ppvReserved |
| | ); |
| | |
| | // While doing authentication with EapHost, when supplicant receives action code |
| | of EapHostPeerResponseInvokeUi |
| | // supplicant should call EapHostPeerGetUIContext to get UI context data. After |
| | that. it then should call this |
| | // API from a process where UI can be brought up. |
| | // API Returns non zero return code up on error. |
| DWORD WINAPI EapHostPeerInvokeInteractiveUI( | | DWORD WINAPI EapHostPeerInvokeInteractiveUI( |
|
| HWND hwndParent, | | // window handle of the parent window under which dialog will sh |
| DWORD dwSizeofUIContextData, | | ow up |
| __in_ecount_opt(dwSizeofUIContextData) const BYTE* pUIContextDat | | IN HWND hwndParent, |
| a, | | // size of UIcontext data received from EapHostPeerGetUIContext |
| DWORD* pdwSizeOfDataFromInteractiveUI, | | call |
| __deref_out_ecount(*pdwSizeOfDataFromInteractiveUI) BYTE** ppDat | | IN DWORD dwSizeofUIContextData, |
| aFromInteractiveUI, | | // UIcontext data received from EapHostPeerGetUIContext call |
| EAP_ERROR** pEapError | | IN __in_ecount_opt(dwSizeofUIContextData) const BYTE* pUIContext |
| | Data, |
| | // pointer to DWORD that receives data from interactive UI that |
| | is used for authentication |
| | // to continue |
| | OUT DWORD* pdwSizeOfDataFromInteractiveUI, |
| | // pointer that receives buffer filled with interactive UI that |
| | is used for authentication |
| | // to continue. Caller should free the memory using EapHostPeerF |
| | reeMemory. |
| | OUT __deref_out_ecount(*pdwSizeOfDataFromInteractiveUI) BYTE** p |
| | pDataFromInteractiveUI, |
| | // In case of error, API fills ppEapError if possible. Caller sh |
| | ould free ppEapError using EapHostPeerFreeErrorMemory |
| | OUT EAP_ERROR** ppEapError |
| | ); |
| | |
| | // This API will enable supplicants to collect necessary information from EAPHos |
| | t to raise interactive UI and collect user information |
| | // supplicant should call EapHostPeerQueryInteractiveUIInputFields() API first a |
| | fter it receives |
| | // EapHostPeerResponseInvokeUi actionCode from EAPHost. If the return value from |
| | this API |
| | // is EAP_E_EAPHOST_METHOD_OPERATION_NOT_SUPPORTED, then supplicant should fall |
| | back to |
| | // traditional model of invoking method interactive UI, i.e. by calling EapHostP |
| | eerInvokeInteractiveUI() |
| | // API Returns non zero return code up on error. |
| | DWORD WINAPI EapHostPeerQueryInteractiveUIInputFields ( |
| | // API's version number for ease of interoperability. It must be |
| | 0. |
| | IN DWORD dwVersion, |
| | // control the behavior of the EAP Methods |
| | IN DWORD dwFlags, |
| | // size of UIcontext data EAPHost runtime |
| | IN DWORD dwSizeofUIContextData, |
| | // UIContext data received from EAPHost runtime |
| | IN __in_ecount(dwSizeofUIContextData) const BYTE* pUIContextData |
| | , |
| | // structure that gets filled with fields and how they should be |
| | shown to the user. |
| | // Caller should free the inner pointers using EapHostPeerFreeMe |
| | mory starting at the inner most pointer. |
| | OUT EAP_INTERACTIVE_UI_DATA *pEapInteractiveUIData, |
| | // In case of error, API fills ppEapError if possible. Caller s |
| | hould free ppEapError using EapHostPeerFreeErrorMemory |
| | OUT EAP_ERROR** ppEapError, |
| | // Reserved for future usage. It must be NULL. |
| | IN OUT LPVOID *ppvReserved |
| ); | | ); |
| | |
|
| | // This API will enable supplicants to convert user information into a user-blob |
| | which can be consumed by EAPHost runtime APIs |
| | // API Returns non zero return code up on error. |
| | DWORD WINAPI EapHostPeerQueryUIBlobFromInteractiveUIInputFields( |
| | // API's version number for ease of interoperability. It must be |
| | 0. |
| | IN DWORD dwVersion, |
| | // control the behavior of the EAP Methods |
| | IN DWORD dwFlags, |
| | // size of UIcontext data EAPHost runtime |
| | IN DWORD dwSizeofUIContextData, |
| | // UIContext data received from EAPHost runtime |
| | IN __in_ecount(dwSizeofUIContextData) const BYTE* pUIContextData |
| | , |
| | // structure that carries data provided by user |
| | IN const EAP_INTERACTIVE_UI_DATA *pEapInteractiveUIData, |
| | // pointer to DWORD that receives size of credential blob, if su |
| | pplicant passes in |
| | // non-zero size and non-NULL data below, EAPHost will just atte |
| | mpt to Update |
| | // the blob with passed in values (if method supports) instead o |
| | f creating a new one. |
| | IN OUT DWORD * pdwSizeOfDataFromInteractiveUI, |
| | // Pointer that receives the credential blob that can be used in |
| | authentication. |
| | // Caller should free the memory using EapHostPeerFreeMemory. |
| | IN OUT __deref_out_ecount(*pdwSizeOfDataFromInteractiveUI) BYTE |
| | ** ppDataFromInteractiveUI, |
| | // In case of error, API fills ppEapError if possible. Caller s |
| | hould free ppEapError using EapHostPeerFreeErrorMemory |
| | OUT EAP_ERROR** ppEapError, |
| | // Reserved for future usage. It must be NULL. |
| | IN OUT LPVOID *ppvReserved |
| | ); |
| | |
| | // Supplicant can utilize XML based EAP configuration storing, managing, editing |
| | . When it wants to call EapHostPeerConfigureUI |
| | // or when it has to start authentication, it calls this API to convert XML conf |
| | iguration into blob. |
| | // API Returns non zero return code up on error. |
| DWORD WINAPI EapHostPeerConfigXml2Blob( | | DWORD WINAPI EapHostPeerConfigXml2Blob( |
|
| | // controls the behavior of the EAP Method |
| IN DWORD dwFlags, | | IN DWORD dwFlags, |
|
| | // a node containing EAP XML configuration inside it |
| IN IXMLDOMNode* pConfigDoc, | | IN IXMLDOMNode* pConfigDoc, |
|
| | // pointer to DWORD that receives the configuration blob size |
| OUT DWORD* pdwSizeOfConfigOut, | | OUT DWORD* pdwSizeOfConfigOut, |
|
| | // pointer that receives configuration blob. Caller should free
the memory using EapHostPeerFreeMemory. |
| OUT __deref_out_ecount(*pdwSizeOfConfigOut) BYTE** ppConfigOut, | | OUT __deref_out_ecount(*pdwSizeOfConfigOut) BYTE** ppConfigOut, |
|
| | // pointer that receives the EAP Method specified in the XML con
figuration |
| OUT EAP_METHOD_TYPE* pEapMethodType, | | OUT EAP_METHOD_TYPE* pEapMethodType, |
|
| | // In case of error, API fills ppEapError if possible. Caller sh
ould free ppEapError using EapHostPeerFreeErrorMemory |
| OUT EAP_ERROR** ppEapError | | OUT EAP_ERROR** ppEapError |
| ); | | ); |
| | |
|
| | // Supplicant can utilize XML based EAP credentials storing, managing, editing. |
| | When it wants to start |
| | // authentication, it calls this API to convert XML based credentials into blob. |
| | // API Returns non zero return code up on error. |
| DWORD WINAPI EapHostPeerCredentialsXml2Blob( | | DWORD WINAPI EapHostPeerCredentialsXml2Blob( |
|
| | // controls the behavior of the EAP Method |
| IN DWORD dwFlags, | | IN DWORD dwFlags, |
|
| | // XML node that contains credentials |
| IN IXMLDOMNode* pCredentialsDoc, | | IN IXMLDOMNode* pCredentialsDoc, |
|
| | // size of configuration blob that the credentials are configure
d for |
| IN DWORD dwSizeOfConfigIn, | | IN DWORD dwSizeOfConfigIn, |
|
| | // configuration blob that the credentials are configured for |
| IN __in_ecount(dwSizeOfConfigIn) BYTE* pConfigIn, | | IN __in_ecount(dwSizeOfConfigIn) BYTE* pConfigIn, |
|
| | // pointer to DWORD that receives size of the credentials blob. |
| OUT DWORD* pdwSizeOfCredentialsOut, | | OUT DWORD* pdwSizeOfCredentialsOut, |
|
| | // pointer that receives credential blob buffer. Caller should |
| | free the memory using |
| | // EapHostPeerFreeMemory. |
| OUT __deref_out_ecount(*pdwSizeOfCredentialsOut) BYTE** ppCreden
tialsOut, | | OUT __deref_out_ecount(*pdwSizeOfCredentialsOut) BYTE** ppCreden
tialsOut, |
|
| | // pointer that receives the EAP Method specified in the XML con
figuration |
| OUT EAP_METHOD_TYPE* pEapMethodType, | | OUT EAP_METHOD_TYPE* pEapMethodType, |
|
| | // In case of error, API fills ppEapError if possible. Caller sh
ould free ppEapError using EapHostPeerFreeErrorMemory |
| OUT EAP_ERROR** ppEapError | | OUT EAP_ERROR** ppEapError |
| ); | | ); |
| | |
|
| | // Supplicant can utilize XML based EAP credentials storing, managing, editing. |
| | When it wants to start |
| | // convert configuration blob to XML, it can call this API. |
| | // API Returns non zero return code up on error. |
| DWORD WINAPI EapHostPeerConfigBlob2Xml( | | DWORD WINAPI EapHostPeerConfigBlob2Xml( |
|
| | // controls the behavior of the EAP Method |
| IN DWORD dwFlags, | | IN DWORD dwFlags, |
|
| | // identifies the EAP Method |
| IN EAP_METHOD_TYPE eapMethodType, | | IN EAP_METHOD_TYPE eapMethodType, |
|
| | // Size of configuration blob that supplicant wants to convert |
| IN DWORD dwSizeOfConfigIn, | | IN DWORD dwSizeOfConfigIn, |
|
| | // Configuration blob that supplicant wants to convert |
| IN __in_ecount(dwSizeOfConfigDataIn) BYTE* pConfigIn, | | IN __in_ecount(dwSizeOfConfigDataIn) BYTE* pConfigIn, |
|
| // TODO: Move to IXMLDOMDocument | | // XML document that contains XML form of the blob. If the EAP M |
| | ethod does not support |
| | // EapPeerConfigBlob2Xml function, the XML contains ConfigBlob n |
| | ode with blob in string form |
| OUT IXMLDOMDocument2** ppConfigDoc, | | OUT IXMLDOMDocument2** ppConfigDoc, |
|
| | // In case of error, API fills ppEapError if possible. Caller sh
ould free ppEapError using EapHostPeerFreeErrorMemory |
| OUT EAP_ERROR** ppEapError | | OUT EAP_ERROR** ppEapError |
| ); | | ); |
| | |
|
| | // Supplicant calls this API to free memory returned by Config APIs. Supplicant |
| | should not use this API |
| | // for freeing EAP_ERROR structure. |
| VOID WINAPI EapHostPeerFreeMemory(BYTE* pData); | | VOID WINAPI EapHostPeerFreeMemory(BYTE* pData); |
| | |
|
| | // Supplicant calls this API to free EAP_ERROR memory, which will get filled whe
n an API fails. |
| VOID WINAPI EapHostPeerFreeErrorMemory(EAP_ERROR* pEapError); | | VOID WINAPI EapHostPeerFreeErrorMemory(EAP_ERROR* pEapError); |
| | |
| #ifdef __cplusplus | | #ifdef __cplusplus |
| } | | } |
| #endif | | #endif |
| | |
| #endif // EAPHOSTPEERCONFIGAPIS_H | | #endif // EAPHOSTPEERCONFIGAPIS_H |
| | |
| End of changes. 35 change blocks. |
|---|
| 35 lines changed or deleted | | 312 lines changed or added |
|---|
|