/* Copyright 2015-2016 Amebis Copyright 2016 GÉANT This file is part of GÉANTLink. GÉANTLink is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. GÉANTLink is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GÉANTLink. If not, see . */ #include namespace eap { /// /// Base class for configuration storage /// class config; /// /// Base class for method configuration storage /// class config_method; /// /// Provider configuration /// template class config_provider; /// /// Providers configuration /// template class config_providers; /// /// Password based method configuration /// typedef config_method config_pass; } namespace eapserial { /// /// Packs a method configuration /// /// \param[inout] cursor Memory cursor /// \param[in] val Configuration to pack /// inline void pack(_Inout_ unsigned char *&cursor, _In_ const eap::config_method &val); /// /// Returns packed size of a method configuration /// /// \param[in] val Configuration to pack /// /// \returns Size of data when packed (in bytes) /// inline size_t get_pk_size(const eap::config_method &val); /// /// Unpacks a method configuration /// /// \param[inout] cursor Memory cursor /// \param[out] val Configuration to unpack to /// inline void unpack(_Inout_ const unsigned char *&cursor, _Out_ eap::config_method &val); /// /// Packs a provider configuration /// /// \param[inout] cursor Memory cursor /// \param[in] val Configuration to pack /// template inline void pack(_Inout_ unsigned char *&cursor, _In_ const eap::config_provider<_Tmeth> &val); /// /// Returns packed size of a provider configuration /// /// \param[in] val Configuration to pack /// /// \returns Size of data when packed (in bytes) /// template inline size_t get_pk_size(const eap::config_provider<_Tmeth> &val); /// /// Unpacks a provider configuration /// /// \param[inout] cursor Memory cursor /// \param[out] val Configuration to unpack to /// template inline void unpack(_Inout_ const unsigned char *&cursor, _Out_ eap::config_provider<_Tmeth> &val); /// /// Packs a providers configuration /// /// \param[inout] cursor Memory cursor /// \param[in] val Configuration to pack /// template inline void pack(_Inout_ unsigned char *&cursor, _In_ const eap::config_providers<_Tprov> &val); /// /// Returns packed size of a providers configuration /// /// \param[in] val Configuration to pack /// /// \returns Size of data when packed (in bytes) /// template inline size_t get_pk_size(const eap::config_providers<_Tprov> &val); /// /// Unpacks a providers configuration /// /// \param[inout] cursor Memory cursor /// \param[out] val Configuration to unpack to /// template inline void unpack(_Inout_ const unsigned char *&cursor, _Out_ eap::config_providers<_Tprov> &val); } #pragma once #include "Module.h" #include "EAPSerial.h" #include "EAPXML.h" #include #include #include #include // Must include after #include #include #include namespace eap { class config { public: /// /// Constructs configuration /// /// \param[in] mod Reference of the EAP module to use for global services /// config(_In_ module &mod); /// /// Copies configuration /// /// \param[in] other Configuration to copy from /// config(_In_ const config &other); /// /// Moves configuration /// /// \param[in] other Configuration to move from /// config(_Inout_ config &&other); /// /// Destructs configuration /// virtual ~config(); /// /// Copies configuration /// /// \param[in] other Configuration to copy from /// /// \returns Reference to this object /// config& operator=(_In_ const config &other); /// /// Moves configuration /// /// \param[in] other Configuration to move from /// /// \returns Reference to this object /// config& operator=(_Inout_ config &&other); /// /// Clones this configuration /// /// \returns Pointer to cloned configuration /// virtual config* clone() const = 0; /// \name XML configuration management /// @{ /// /// Save configuration to XML document /// /// \param[in] pDoc XML document /// \param[in] pConfigRoot Suggested root element for saving configuration /// \param[out] ppEapError Pointer to error descriptor in case of failure. Free using `module::free_error_memory()`. /// /// \returns /// - \c ERROR_SUCCESS if succeeded /// - error code otherwise /// virtual DWORD save(_In_ IXMLDOMDocument *pDoc, _In_ IXMLDOMNode *pConfigRoot, _Out_ EAP_ERROR **ppEapError) const = 0; /// /// Load configuration from XML document /// /// \param[in] pConfigRoot Root element for loading configuration /// \param[out] ppEapError Pointer to error descriptor in case of failure. Free using `module::free_error_memory()`. /// /// \returns /// - \c ERROR_SUCCESS if succeeded /// - error code otherwise /// virtual DWORD load(_In_ IXMLDOMNode *pConfigRoot, _Out_ EAP_ERROR **ppEapError) = 0; /// @} public: module &m_module; ///< Reference of the EAP module }; class config_method : public config { public: /// /// Constructs configuration /// /// \param[in] mod Reference of the EAP module to use for global services /// config_method(_In_ module &mod); /// /// Copies configuration /// /// \param[in] other Configuration to copy from /// config_method(_In_ const config_method &other); /// /// Moves configuration /// /// \param[in] other Configuration to move from /// config_method(_Inout_ config_method &&other); /// /// Copies configuration /// /// \param[in] other Configuration to copy from /// /// \returns Reference to this object /// config_method& operator=(_In_ const config_method &other); /// /// Moves configuration /// /// \param[in] other Configuration to move from /// /// \returns Reference to this object /// config_method& operator=(_Inout_ config_method &&other); /// \name XML configuration management /// @{ /// /// Save configuration to XML document /// /// \param[in] pDoc XML document /// \param[in] pConfigRoot Suggested root element for saving configuration /// \param[out] ppEapError Pointer to error descriptor in case of failure. Free using `module::free_error_memory()`. /// /// \returns /// - \c ERROR_SUCCESS if succeeded /// - error code otherwise /// virtual DWORD save(_In_ IXMLDOMDocument *pDoc, _In_ IXMLDOMNode *pConfigRoot, _Out_ EAP_ERROR **ppEapError) const; /// /// Load configuration from XML document /// /// \param[in] pConfigRoot Root element for loading configuration /// \param[out] ppEapError Pointer to error descriptor in case of failure. Free using `module::free_error_memory()`. /// /// \returns /// - \c ERROR_SUCCESS if succeeded /// - error code otherwise /// virtual DWORD load(_In_ IXMLDOMNode *pConfigRoot, _Out_ EAP_ERROR **ppEapError); /// @} /// /// Returns EAP method type of this configuration /// /// \returns One of `eap::type_t` constants. /// virtual type_t get_method_id() const = 0; public: bool m_allow_save; ///< Are credentials allowed to be saved to Windows Credential Manager? std::wstring m_anonymous_identity; ///< Anonymous identity }; template class config_provider : public config { public: /// /// Constructs configuration /// /// \param[in] mod Reference of the EAP module to use for global services /// config_provider(_In_ module &mod) : config(mod) { } /// /// Copies configuration /// /// \param[in] other Configuration to copy from /// config_provider(_In_ const config_provider &other) : m_id(other.m_id), m_lbl_alt_credential(other.m_lbl_alt_credential), m_lbl_alt_identity(other.m_lbl_alt_identity), m_lbl_alt_password(other.m_lbl_alt_password), m_methods(other.m_methods), config(other) { } /// /// Moves configuration /// /// \param[in] other Configuration to move from /// config_provider(_Inout_ config_provider &&other) : m_id(std::move(other.m_id)), m_lbl_alt_credential(std::move(other.m_lbl_alt_credential)), m_lbl_alt_identity(std::move(other.m_lbl_alt_identity)), m_lbl_alt_password(std::move(other.m_lbl_alt_password)), m_methods(std::move(other.m_methods)), config(std::move(other)) { } /// /// Copies configuration /// /// \param[in] other Configuration to copy from /// /// \returns Reference to this object /// config_provider& operator=(_In_ const config_provider &other) { if (this != &other) { (config&)*this = other; m_id = other.m_id; m_lbl_alt_credential = other.m_lbl_alt_credential; m_lbl_alt_identity = other.m_lbl_alt_identity; m_lbl_alt_password = other.m_lbl_alt_password; m_methods = other.m_methods; } return *this; } /// /// Moves configuration /// /// \param[in] other Configuration to move from /// /// \returns Reference to this object /// config_provider& operator=(_Inout_ config_provider &&other) { if (this != &other) { (config&&)*this = std::move(other); m_id = std::move(other.m_id); m_lbl_alt_credential = std::move(other.m_lbl_alt_credential); m_lbl_alt_identity = std::move(other.m_lbl_alt_identity); m_lbl_alt_password = std::move(other.m_lbl_alt_password); m_methods = std::move(other.m_methods); } return *this; } /// /// Clones configuration /// /// \returns Pointer to cloned configuration /// virtual config* clone() const { return new config_provider<_Tmeth>(*this); } /// \name XML configuration management /// @{ /// /// Save configuration to XML document /// /// \param[in] pDoc XML document /// \param[in] pConfigRoot Suggested root element for saving configuration /// \param[out] ppEapError Pointer to error descriptor in case of failure. Free using `module::free_error_memory()`. /// /// \returns /// - \c ERROR_SUCCESS if succeeded /// - error code otherwise /// virtual DWORD save(_In_ IXMLDOMDocument *pDoc, _In_ IXMLDOMNode *pConfigRoot, _Out_ EAP_ERROR **ppEapError) const { const winstd::bstr bstrNamespace(L"urn:ietf:params:xml:ns:yang:ietf-eap-metadata"); DWORD dwResult; HRESULT hr; // if (!m_id.empty()) if ((dwResult = eapxml::put_element_value(pDoc, pConfigRoot, winstd::bstr(L"ID"), bstrNamespace, winstd::bstr(m_id))) != ERROR_SUCCESS) { *ppEapError = m_module.make_error(dwResult, 0, NULL, NULL, NULL, _T(__FUNCTION__) _T(" Error creating element."), NULL); return dwResult; } // winstd::com_obj pXmlElProviderInfo; if ((dwResult = eapxml::create_element(pDoc, pConfigRoot, winstd::bstr(L"eap-metadata:ProviderInfo"), winstd::bstr(L"ProviderInfo"), bstrNamespace, &pXmlElProviderInfo)) != ERROR_SUCCESS) { *ppEapError = m_module.make_error(dwResult, 0, NULL, NULL, NULL, _T(__FUNCTION__) _T(" Error creating element."), NULL); return dwResult; } // / if (!m_lbl_alt_credential.empty()) if ((dwResult = eapxml::put_element_value(pDoc, pXmlElProviderInfo, winstd::bstr(L"CredentialPrompt"), bstrNamespace, winstd::bstr(m_lbl_alt_credential))) != ERROR_SUCCESS) { *ppEapError = m_module.make_error(dwResult, 0, NULL, NULL, NULL, _T(__FUNCTION__) _T(" Error creating element."), NULL); return dwResult; } // / if (!m_lbl_alt_identity.empty()) if ((dwResult = eapxml::put_element_value(pDoc, pXmlElProviderInfo, winstd::bstr(L"UserNameLabel"), bstrNamespace, winstd::bstr(m_lbl_alt_identity))) != ERROR_SUCCESS) { *ppEapError = m_module.make_error(dwResult, 0, NULL, NULL, NULL, _T(__FUNCTION__) _T(" Error creating element."), NULL); return dwResult; } // / if (!m_lbl_alt_password.empty()) if ((dwResult = eapxml::put_element_value(pDoc, pXmlElProviderInfo, winstd::bstr(L"PasswordLabel"), bstrNamespace, winstd::bstr(m_lbl_alt_password))) != ERROR_SUCCESS) { *ppEapError = m_module.make_error(dwResult, 0, NULL, NULL, NULL, _T(__FUNCTION__) _T(" Error creating element."), NULL); return dwResult; } // winstd::com_obj pXmlElAuthenticationMethods; if ((dwResult = eapxml::create_element(pDoc, pConfigRoot, winstd::bstr(L"eap-metadata:AuthenticationMethods"), winstd::bstr(L"AuthenticationMethods"), bstrNamespace, &pXmlElAuthenticationMethods)) != ERROR_SUCCESS) { *ppEapError = m_module.make_error(dwResult, 0, NULL, NULL, NULL, _T(__FUNCTION__) _T(" Error creating element."), NULL); return dwResult; } for (std::list<_Tmeth>::const_iterator method = m_methods.cbegin(), method_end = m_methods.cend(); method != method_end; ++method) { // winstd::com_obj pXmlElAuthenticationMethod; if ((dwResult = eapxml::create_element(pDoc, winstd::bstr(L"AuthenticationMethod"), bstrNamespace, &pXmlElAuthenticationMethod))) { *ppEapError = m_module.make_error(dwResult, 0, NULL, NULL, NULL, _T(__FUNCTION__) _T(" Error creating element."), NULL); return dwResult; } // /... if ((dwResult = method->save(pDoc, pXmlElAuthenticationMethod, ppEapError)) != ERROR_SUCCESS) return dwResult; if (FAILED(hr = pXmlElAuthenticationMethods->appendChild(pXmlElAuthenticationMethod, NULL))) { *ppEapError = m_module.make_error(dwResult = HRESULT_CODE(hr), 0, NULL, NULL, NULL, _T(__FUNCTION__) _T(" Error appending element."), NULL); return dwResult; } } return dwResult; } /// /// Load configuration from XML document /// /// \param[in] pConfigRoot Root element for loading configuration /// \param[out] ppEapError Pointer to error descriptor in case of failure. Free using `module::free_error_memory()`. /// /// \returns /// - \c ERROR_SUCCESS if succeeded /// - error code otherwise /// virtual DWORD load(_In_ IXMLDOMNode *pConfigRoot, _Out_ EAP_ERROR **ppEapError) { assert(pConfigRoot); assert(ppEapError); DWORD dwResult; std::wstring lang; LoadString(m_module.m_instance, 2, lang); // m_id.clear(); eapxml::get_element_value(pConfigRoot, winstd::bstr(L"eap-metadata:ID"), m_id); // m_lbl_alt_credential.clear(); m_lbl_alt_identity.clear(); m_lbl_alt_password.clear(); winstd::com_obj pXmlElProviderInfo; if (eapxml::select_element(pConfigRoot, winstd::bstr(L"eap-metadata:ProviderInfo"), &pXmlElProviderInfo) == ERROR_SUCCESS) { // eapxml::get_element_localized(pXmlElProviderInfo, winstd::bstr(L"eap-metadata:CredentialPrompt"), lang.c_str(), m_lbl_alt_credential); // eapxml::get_element_localized(pXmlElProviderInfo, winstd::bstr(L"eap-metadata:UserNameLabel"), lang.c_str(), m_lbl_alt_identity); // eapxml::get_element_localized(pXmlElProviderInfo, winstd::bstr(L"eap-metadata:PasswordLabel"), lang.c_str(), m_lbl_alt_password); } // Iterate authentication methods (). m_methods.clear(); winstd::com_obj pXmlListMethods; if ((dwResult = eapxml::select_nodes(pConfigRoot, winstd::bstr(L"eap-metadata:AuthenticationMethods/eap-metadata:AuthenticationMethod"), &pXmlListMethods)) != ERROR_SUCCESS) { *ppEapError = m_module.make_error(dwResult = ERROR_NOT_FOUND, 0, NULL, NULL, NULL, _T(__FUNCTION__) _T(" Error selecting / elements."), NULL); return dwResult; } long lCount = 0; pXmlListMethods->get_length(&lCount); for (long i = 0; i < lCount; i++) { winstd::com_obj pXmlElMethod; pXmlListMethods->get_item(i, &pXmlElMethod); _Tmeth cfg(m_module); // Check EAP method type (). DWORD dwMethodID; if (eapxml::get_element_value(pXmlElMethod, winstd::bstr(L"eap-metadata:EAPMethod"), &dwMethodID) == ERROR_SUCCESS) { if ((type_t)dwMethodID != cfg.get_method_id()) { // Wrong type. continue; } } // Load configuration. dwResult = cfg.load(pXmlElMethod, ppEapError); if (dwResult != ERROR_SUCCESS) return dwResult; // Add configuration to the list. m_methods.push_back(std::move(cfg)); } return ERROR_SUCCESS; } /// @} public: std::wstring m_id; ///< Profile ID winstd::tstring m_lbl_alt_credential; ///< Alternative label for credential prompt winstd::tstring m_lbl_alt_identity; ///< Alternative label for identity prompt winstd::tstring m_lbl_alt_password; ///< Alternative label for password prompt std::list<_Tmeth> m_methods; ///< List of method configurations }; template class config_providers : public config { public: /// /// Constructs configuration /// /// \param[in] mod Reference of the EAP module to use for global services /// config_providers(_In_ module &mod) : config(mod) { } /// /// Copies configuration /// /// \param[in] other Configuration to copy from /// config_providers(_In_ const config_providers &other) : m_providers(other.m_providers), config(other) { } /// /// Moves configuration /// /// \param[in] other Configuration to move from /// config_providers(_Inout_ config_providers &&other) : m_providers(std::move(other.m_providers)), config(std::move(other)) { } /// /// Copies configuration /// /// \param[in] other Configuration to copy from /// /// \returns Reference to this object /// config_providers& operator=(_In_ const config_providers &other) { if (this != &other) { (config&)*this = other; m_providers = other.m_providers; } return *this; } /// /// Moves configuration /// /// \param[in] other Configuration to move from /// /// \returns Reference to this object /// config_providers& operator=(_Inout_ config_providers &&other) { if (this != &other) { (config&&)*this = std::move(other); m_providers = std::move(other.m_providers); } return *this; } /// /// Clones configuration /// /// \returns Pointer to cloned configuration /// virtual config* clone() const { return new config_providers<_Tprov>(*this); } /// \name XML configuration management /// @{ /// /// Save configuration to XML document /// /// \param[in] pDoc XML document /// \param[in] pConfigRoot Suggested root element for saving configuration /// \param[out] ppEapError Pointer to error descriptor in case of failure. Free using `module::free_error_memory()`. /// /// \returns /// - \c ERROR_SUCCESS if succeeded /// - error code otherwise /// virtual DWORD save(_In_ IXMLDOMDocument *pDoc, _In_ IXMLDOMNode *pConfigRoot, _Out_ EAP_ERROR **ppEapError) const { const winstd::bstr bstrNamespace(L"urn:ietf:params:xml:ns:yang:ietf-eap-metadata"); DWORD dwResult; HRESULT hr; // Select node. winstd::com_obj pXmlElIdentityProviderList; if ((dwResult = eapxml::select_node(pConfigRoot, winstd::bstr(L"eap-metadata:EAPIdentityProviderList"), &pXmlElIdentityProviderList)) != ERROR_SUCCESS) { *ppEapError = m_module.make_error(dwResult = ERROR_NOT_FOUND, 0, NULL, NULL, NULL, _T(__FUNCTION__) _T(" Error selecting element."), NULL); return dwResult; } for (std::list<_Tprov>::const_iterator provider = m_providers.cbegin(), provider_end = m_providers.cend(); provider != provider_end; ++provider) { // winstd::com_obj pXmlElIdentityProvider; if ((dwResult = eapxml::create_element(pDoc, winstd::bstr(L"EAPIdentityProvider"), bstrNamespace, &pXmlElIdentityProvider))) { *ppEapError = m_module.make_error(dwResult, 0, NULL, NULL, NULL, _T(__FUNCTION__) _T(" Error creating element."), NULL); return dwResult; } // /... if ((dwResult = provider->save(pDoc, pXmlElIdentityProvider, ppEapError)) != ERROR_SUCCESS) return dwResult; if (FAILED(hr = pXmlElIdentityProviderList->appendChild(pXmlElIdentityProvider, NULL))) { *ppEapError = m_module.make_error(dwResult = HRESULT_CODE(hr), 0, NULL, NULL, NULL, _T(__FUNCTION__) _T(" Error appending element."), NULL); return dwResult; } } return dwResult; } /// /// Load configuration from XML document /// /// \param[in] pConfigRoot Root element for loading configuration /// \param[out] ppEapError Pointer to error descriptor in case of failure. Free using `module::free_error_memory()`. /// /// \returns /// - \c ERROR_SUCCESS if succeeded /// - error code otherwise /// virtual DWORD load(_In_ IXMLDOMNode *pConfigRoot, _Out_ EAP_ERROR **ppEapError) { assert(pConfigRoot); assert(ppEapError); DWORD dwResult; // Iterate authentication providers (). winstd::com_obj pXmlListProviders; if ((dwResult = eapxml::select_nodes(pConfigRoot, winstd::bstr(L"eap-metadata:EAPIdentityProviderList/eap-metadata:EAPIdentityProvider"), &pXmlListProviders)) != ERROR_SUCCESS) { *ppEapError = m_module.make_error(dwResult = ERROR_NOT_FOUND, 0, NULL, NULL, NULL, _T(__FUNCTION__) _T(" Error selecting elements."), NULL); return dwResult; } long lCount = 0; pXmlListProviders->get_length(&lCount); for (long i = 0; i < lCount; i++) { winstd::com_obj pXmlElProvider; pXmlListProviders->get_item(i, &pXmlElProvider); _Tprov prov(m_module); // Load provider. dwResult = prov.load(pXmlElProvider, ppEapError); if (dwResult != ERROR_SUCCESS) return dwResult; // Add provider to the list. m_providers.push_back(std::move(prov)); } return dwResult; } /// @} public: std::list<_Tprov> m_providers; ///< List of provider configurations }; } namespace eapserial { inline void pack(_Inout_ unsigned char *&cursor, _In_ const eap::config_method &val) { pack(cursor, val.m_allow_save ); pack(cursor, val.m_anonymous_identity); } inline size_t get_pk_size(const eap::config_method &val) { return get_pk_size(val.m_allow_save ) + get_pk_size(val.m_anonymous_identity); } inline void unpack(_Inout_ const unsigned char *&cursor, _Out_ eap::config_method &val) { unpack(cursor, val.m_allow_save ); unpack(cursor, val.m_anonymous_identity); } template inline void pack(_Inout_ unsigned char *&cursor, _In_ const eap::config_provider<_Tmeth> &val) { pack(cursor, val.m_id ); pack(cursor, val.m_lbl_alt_credential); pack(cursor, val.m_lbl_alt_identity ); pack(cursor, val.m_lbl_alt_password ); pack(cursor, val.m_methods ); } template inline size_t get_pk_size(const eap::config_provider<_Tmeth> &val) { return get_pk_size(val.m_id ) + get_pk_size(val.m_lbl_alt_credential) + get_pk_size(val.m_lbl_alt_identity ) + get_pk_size(val.m_lbl_alt_password ) + get_pk_size(val.m_methods ); } template inline void unpack(_Inout_ const unsigned char *&cursor, _Out_ eap::config_provider<_Tmeth> &val) { unpack(cursor, val.m_id ); unpack(cursor, val.m_lbl_alt_credential); unpack(cursor, val.m_lbl_alt_identity ); unpack(cursor, val.m_lbl_alt_password ); std::list<_Tmeth>::size_type count = *(const std::list<_Tmeth>::size_type*&)cursor; cursor += sizeof(std::list<_Tmeth>::size_type); val.m_methods.clear(); for (std::list<_Tmeth>::size_type i = 0; i < count; i++) { _Tmeth el(val.m_module); unpack(cursor, el); val.m_methods.push_back(std::move(el)); } } template inline void pack(_Inout_ unsigned char *&cursor, _In_ const eap::config_providers<_Tprov> &val) { pack(cursor, val.m_providers); } template inline size_t get_pk_size(const eap::config_providers<_Tprov> &val) { return get_pk_size(val.m_providers); } template inline void unpack(_Inout_ const unsigned char *&cursor, _Out_ eap::config_providers<_Tprov> &val) { std::list<_Tprov>::size_type count = *(const std::list<_Tprov>::size_type*&)cursor; cursor += sizeof(std::list<_Tprov>::size_type); val.m_providers.clear(); for (std::list<_Tprov>::size_type i = 0; i < count; i++) { _Tprov el(val.m_module); unpack(cursor, el); val.m_providers.push_back(std::move(el)); } } }