737 lines
22 KiB
C++
737 lines
22 KiB
C++
/*
|
|
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 <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#include "EAP.h"
|
|
|
|
#include <sal.h>
|
|
|
|
namespace eap
|
|
{
|
|
///
|
|
/// Base class for configuration storage
|
|
///
|
|
class config;
|
|
|
|
///
|
|
/// Base class for method configuration storage
|
|
///
|
|
class config_method;
|
|
|
|
///
|
|
/// Base class for method with credentials
|
|
///
|
|
template <class _Tcred> class config_method_with_cred;
|
|
|
|
///
|
|
/// Base class for single provider configuration storage
|
|
///
|
|
class config_provider;
|
|
|
|
///
|
|
/// Base class for the list of providers configuration storage
|
|
///
|
|
class config_providers;
|
|
}
|
|
|
|
///
|
|
/// Packs a configuration
|
|
///
|
|
/// \param[inout] cursor Memory cursor
|
|
/// \param[in] val Configuration to pack
|
|
///
|
|
inline void operator<<(_Inout_ eap::cursor_out &cursor, _In_ const eap::config &val);
|
|
|
|
///
|
|
/// Returns packed size of a configuration
|
|
///
|
|
/// \param[in] val Configuration to pack
|
|
///
|
|
/// \returns Size of data when packed (in bytes)
|
|
///
|
|
inline size_t pksizeof(const eap::config &val);
|
|
|
|
///
|
|
/// Unpacks a configuration
|
|
///
|
|
/// \param[inout] cursor Memory cursor
|
|
/// \param[out] val Configuration to unpack to
|
|
///
|
|
inline void operator>>(_Inout_ eap::cursor_in &cursor, _Out_ eap::config &val);
|
|
|
|
#pragma once
|
|
|
|
#include "Module.h"
|
|
#include "EAPXML.h"
|
|
|
|
#include "../../../include/Version.h"
|
|
|
|
#include <WinStd/COM.h>
|
|
#include <WinStd/Common.h>
|
|
|
|
#include <Windows.h>
|
|
#include <eaptypes.h> // Must include after <Windows.h>
|
|
#include <tchar.h>
|
|
|
|
#include <list>
|
|
#include <string>
|
|
#include <memory>
|
|
|
|
|
|
namespace eap
|
|
{
|
|
class config
|
|
{
|
|
public:
|
|
///
|
|
/// Constructs configuration
|
|
///
|
|
/// \param[in] mod 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);
|
|
|
|
///
|
|
/// 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 true if succeeded
|
|
/// - \c false otherwise. See \p ppEapError for details.
|
|
///
|
|
virtual bool 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 true if succeeded
|
|
/// - \c false otherwise. See \p ppEapError for details.
|
|
///
|
|
virtual bool load(_In_ IXMLDOMNode *pConfigRoot, _Out_ EAP_ERROR **ppEapError);
|
|
|
|
/// @}
|
|
|
|
/// \name BLOB management
|
|
/// @{
|
|
|
|
///
|
|
/// Packs a configuration
|
|
///
|
|
/// \param[inout] cursor Memory cursor
|
|
///
|
|
virtual void operator<<(_Inout_ cursor_out &cursor) const;
|
|
|
|
///
|
|
/// Returns packed size of a configuration
|
|
///
|
|
/// \returns Size of data when packed (in bytes)
|
|
///
|
|
virtual size_t get_pk_size() const;
|
|
|
|
///
|
|
/// Unpacks a configuration
|
|
///
|
|
/// \param[inout] cursor Memory cursor
|
|
///
|
|
virtual void operator>>(_Inout_ cursor_in &cursor);
|
|
|
|
/// @}
|
|
|
|
public:
|
|
module *m_module; ///< EAP module
|
|
};
|
|
|
|
|
|
class config_method : public config
|
|
{
|
|
public:
|
|
///
|
|
/// Constructs configuration
|
|
///
|
|
/// \param[in] mod 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);
|
|
|
|
///
|
|
/// Returns EAP method type of this configuration
|
|
///
|
|
/// \returns One of `winstd::eap_type_t` constants.
|
|
///
|
|
virtual winstd::eap_type_t get_method_id() const = 0;
|
|
};
|
|
|
|
|
|
class credentials;
|
|
|
|
|
|
template <class _Tcred>
|
|
class config_method_with_cred : public config_method
|
|
{
|
|
public:
|
|
///
|
|
/// Constructs configuration
|
|
///
|
|
/// \param[in] mod EAP module to use for global services
|
|
///
|
|
config_method_with_cred(_In_ module *mod) :
|
|
m_allow_save(true),
|
|
m_use_preshared(false),
|
|
m_preshared(new _Tcred(mod)),
|
|
config_method(mod)
|
|
{
|
|
}
|
|
|
|
|
|
///
|
|
/// Copies configuration
|
|
///
|
|
/// \param[in] other Configuration to copy from
|
|
///
|
|
config_method_with_cred(_In_ const config_method_with_cred<_Tcred> &other) :
|
|
m_allow_save(other.m_allow_save),
|
|
m_use_preshared(other.m_use_preshared),
|
|
m_preshared((_Tcred*)other.m_preshared->clone()),
|
|
config_method(other)
|
|
{
|
|
}
|
|
|
|
|
|
///
|
|
/// Moves configuration
|
|
///
|
|
/// \param[in] other Configuration to move from
|
|
///
|
|
config_method_with_cred(_Inout_ config_method_with_cred<_Tcred> &&other) :
|
|
m_allow_save(std::move(other.m_allow_save)),
|
|
m_use_preshared(std::move(other.m_use_preshared)),
|
|
m_preshared(std::move(other.m_preshared)),
|
|
config_method(std::move(other))
|
|
{
|
|
}
|
|
|
|
|
|
///
|
|
/// Copies configuration
|
|
///
|
|
/// \param[in] other Configuration to copy from
|
|
///
|
|
/// \returns Reference to this object
|
|
///
|
|
config_method_with_cred& operator=(_In_ const config_method_with_cred<_Tcred> &other)
|
|
{
|
|
if (this != &other) {
|
|
(config_method&)*this = other;
|
|
m_allow_save = other.m_allow_save;
|
|
m_use_preshared = other.m_use_preshared;
|
|
m_preshared.reset((_Tcred*)other.m_preshared->clone());
|
|
}
|
|
|
|
return *this;
|
|
}
|
|
|
|
|
|
///
|
|
/// Moves configuration
|
|
///
|
|
/// \param[in] other Configuration to move from
|
|
///
|
|
/// \returns Reference to this object
|
|
///
|
|
config_method_with_cred& operator=(_Inout_ config_method_with_cred<_Tcred> &&other)
|
|
{
|
|
if (this != &other) {
|
|
(config_method&)*this = std::move(other );
|
|
m_allow_save = std::move(other.m_allow_save );
|
|
m_use_preshared = std::move(other.m_use_preshared);
|
|
m_preshared = std::move(other.m_preshared );
|
|
}
|
|
|
|
return *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 true if succeeded
|
|
/// - \c false otherwise. See \p ppEapError for details.
|
|
///
|
|
virtual bool save(_In_ IXMLDOMDocument *pDoc, _In_ IXMLDOMNode *pConfigRoot, _Out_ EAP_ERROR **ppEapError) const
|
|
{
|
|
assert(pDoc);
|
|
assert(pConfigRoot);
|
|
assert(ppEapError);
|
|
|
|
const winstd::bstr bstrNamespace(L"urn:ietf:params:xml:ns:yang:ietf-eap-metadata");
|
|
DWORD dwResult;
|
|
|
|
// <ClientSideCredential>
|
|
winstd::com_obj<IXMLDOMElement> pXmlElClientSideCredential;
|
|
if ((dwResult = eapxml::create_element(pDoc, pConfigRoot, winstd::bstr(L"eap-metadata:ClientSideCredential"), winstd::bstr(L"ClientSideCredential"), bstrNamespace, &pXmlElClientSideCredential)) != ERROR_SUCCESS) {
|
|
*ppEapError = m_module->make_error(dwResult, _T(__FUNCTION__) _T(" Error creating <ClientSideCredential> element."));
|
|
return false;
|
|
}
|
|
|
|
// <ClientSideCredential>/<allow-save>
|
|
if ((dwResult = eapxml::put_element_value(pDoc, pXmlElClientSideCredential, winstd::bstr(L"allow-save"), bstrNamespace, m_allow_save)) != ERROR_SUCCESS) {
|
|
*ppEapError = m_module->make_error(dwResult, _T(__FUNCTION__) _T(" Error creating <allow-save> element."));
|
|
return false;
|
|
}
|
|
|
|
if (m_use_preshared && !m_preshared->save(pDoc, pXmlElClientSideCredential, ppEapError))
|
|
return false;
|
|
|
|
return true;
|
|
}
|
|
|
|
///
|
|
/// 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 true if succeeded
|
|
/// - \c false otherwise. See \p ppEapError for details.
|
|
///
|
|
virtual bool load(_In_ IXMLDOMNode *pConfigRoot, _Out_ EAP_ERROR **ppEapError)
|
|
{
|
|
assert(pConfigRoot);
|
|
assert(ppEapError);
|
|
|
|
m_allow_save = true;
|
|
m_use_preshared = false;
|
|
m_preshared->clear();
|
|
|
|
// <ClientSideCredential>
|
|
winstd::com_obj<IXMLDOMElement> pXmlElClientSideCredential;
|
|
if (eapxml::select_element(pConfigRoot, winstd::bstr(L"eap-metadata:ClientSideCredential"), &pXmlElClientSideCredential) == ERROR_SUCCESS) {
|
|
std::wstring xpath(eapxml::get_xpath(pXmlElClientSideCredential));
|
|
|
|
// <allow-save>
|
|
eapxml::get_element_value(pXmlElClientSideCredential, winstd::bstr(L"eap-metadata:allow-save"), &m_allow_save);
|
|
m_module->log_config((xpath + L"/allow-save").c_str(), m_allow_save);
|
|
|
|
_Tcred preshared(m_module);
|
|
if (preshared.load(pXmlElClientSideCredential, ppEapError)) {
|
|
m_use_preshared = true;
|
|
*m_preshared = std::move(preshared);
|
|
} else {
|
|
// This is not really an error - merely an indication pre-shared credentials are unavailable.
|
|
if (*ppEapError) {
|
|
m_module->free_error_memory(*ppEapError);
|
|
*ppEapError = NULL;
|
|
}
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/// @}
|
|
|
|
/// \name BLOB management
|
|
/// @{
|
|
|
|
///
|
|
/// Packs a configuration
|
|
///
|
|
/// \param[inout] cursor Memory cursor
|
|
///
|
|
virtual void operator<<(_Inout_ cursor_out &cursor) const
|
|
{
|
|
config_method::operator<<(cursor);
|
|
cursor << m_allow_save;
|
|
cursor << m_use_preshared;
|
|
cursor << *m_preshared;
|
|
}
|
|
|
|
|
|
///
|
|
/// Returns packed size of a configuration
|
|
///
|
|
/// \returns Size of data when packed (in bytes)
|
|
///
|
|
virtual size_t get_pk_size() const
|
|
{
|
|
return
|
|
config_method::get_pk_size() +
|
|
pksizeof(m_allow_save ) +
|
|
pksizeof(m_use_preshared) +
|
|
pksizeof(*m_preshared );
|
|
}
|
|
|
|
|
|
///
|
|
/// Unpacks a configuration
|
|
///
|
|
/// \param[inout] cursor Memory cursor
|
|
///
|
|
virtual void operator>>(_Inout_ cursor_in &cursor)
|
|
{
|
|
config_method::operator>>(cursor);
|
|
cursor >> m_allow_save;
|
|
cursor >> m_use_preshared;
|
|
cursor >> *m_preshared;
|
|
}
|
|
|
|
/// @}
|
|
|
|
public:
|
|
bool m_allow_save; ///< Are credentials allowed to be saved to Windows Credential Manager?
|
|
bool m_use_preshared; ///< Use pre-shared credentials
|
|
std::unique_ptr<_Tcred> m_preshared; ///< Pre-shared credentials
|
|
};
|
|
|
|
|
|
class config_provider : public config
|
|
{
|
|
public:
|
|
///
|
|
/// Constructs configuration
|
|
///
|
|
/// \param[in] mod EAP module to use for global services
|
|
///
|
|
config_provider(_In_ module *mod);
|
|
|
|
///
|
|
/// Copies configuration
|
|
///
|
|
/// \param[in] other Configuration to copy from
|
|
///
|
|
config_provider(_In_ const config_provider &other);
|
|
|
|
///
|
|
/// Moves configuration
|
|
///
|
|
/// \param[in] other Configuration to move from
|
|
///
|
|
config_provider(_Inout_ config_provider &&other);
|
|
|
|
///
|
|
/// Copies configuration
|
|
///
|
|
/// \param[in] other Configuration to copy from
|
|
///
|
|
/// \returns Reference to this object
|
|
///
|
|
config_provider& operator=(_In_ const config_provider &other);
|
|
|
|
///
|
|
/// Moves configuration
|
|
///
|
|
/// \param[in] other Configuration to move from
|
|
///
|
|
/// \returns Reference to this object
|
|
///
|
|
config_provider& operator=(_Inout_ config_provider &&other);
|
|
|
|
///
|
|
/// Clones configuration
|
|
///
|
|
/// \returns Pointer to cloned configuration
|
|
///
|
|
virtual config* clone() const;
|
|
|
|
/// \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 true if succeeded
|
|
/// - \c false otherwise. See \p ppEapError for details.
|
|
///
|
|
virtual bool 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 true if succeeded
|
|
/// - \c false otherwise. See \p ppEapError for details.
|
|
///
|
|
virtual bool load(_In_ IXMLDOMNode *pConfigRoot, _Out_ EAP_ERROR **ppEapError);
|
|
|
|
/// @}
|
|
|
|
/// \name BLOB management
|
|
/// @{
|
|
|
|
///
|
|
/// Packs a configuration
|
|
///
|
|
/// \param[inout] cursor Memory cursor
|
|
///
|
|
virtual void operator<<(_Inout_ cursor_out &cursor) const;
|
|
|
|
///
|
|
/// Returns packed size of a configuration
|
|
///
|
|
/// \returns Size of data when packed (in bytes)
|
|
///
|
|
virtual size_t get_pk_size() const;
|
|
|
|
///
|
|
/// Unpacks a configuration
|
|
///
|
|
/// \param[inout] cursor Memory cursor
|
|
///
|
|
virtual void operator>>(_Inout_ cursor_in &cursor);
|
|
|
|
/// @}
|
|
|
|
public:
|
|
bool m_read_only; ///< Is profile read-only
|
|
std::wstring m_id; ///< Profile ID
|
|
winstd::tstring m_name; ///< Provider name
|
|
winstd::tstring m_help_email; ///< Helpdesk e-mail
|
|
winstd::tstring m_help_web; ///< Helpdesk website URL
|
|
winstd::tstring m_help_phone; ///< Helpdesk phone
|
|
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<std::unique_ptr<config_method> > m_methods; ///< List of method configurations
|
|
};
|
|
|
|
|
|
class config_providers : public config
|
|
{
|
|
public:
|
|
///
|
|
/// Constructs configuration
|
|
///
|
|
/// \param[in] mod EAP module to use for global services
|
|
///
|
|
config_providers(_In_ module *mod);
|
|
|
|
///
|
|
/// Copies configuration
|
|
///
|
|
/// \param[in] other Configuration to copy from
|
|
///
|
|
config_providers(_In_ const config_providers &other);
|
|
|
|
///
|
|
/// Moves configuration
|
|
///
|
|
/// \param[in] other Configuration to move from
|
|
///
|
|
config_providers(_Inout_ config_providers &&other);
|
|
|
|
///
|
|
/// Copies configuration
|
|
///
|
|
/// \param[in] other Configuration to copy from
|
|
///
|
|
/// \returns Reference to this object
|
|
///
|
|
config_providers& operator=(_In_ const config_providers &other);
|
|
|
|
///
|
|
/// Moves configuration
|
|
///
|
|
/// \param[in] other Configuration to move from
|
|
///
|
|
/// \returns Reference to this object
|
|
///
|
|
config_providers& operator=(_Inout_ config_providers &&other);
|
|
|
|
///
|
|
/// Clones configuration
|
|
///
|
|
/// \returns Pointer to cloned configuration
|
|
///
|
|
virtual config* clone() const;
|
|
|
|
/// \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 true if succeeded
|
|
/// - \c false otherwise. See \p ppEapError for details.
|
|
///
|
|
virtual bool 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 true if succeeded
|
|
/// - \c false otherwise. See \p ppEapError for details.
|
|
///
|
|
virtual bool load(_In_ IXMLDOMNode *pConfigRoot, _Out_ EAP_ERROR **ppEapError);
|
|
|
|
/// @}
|
|
|
|
/// \name BLOB management
|
|
/// @{
|
|
|
|
///
|
|
/// Packs a configuration
|
|
///
|
|
/// \param[inout] cursor Memory cursor
|
|
///
|
|
virtual void operator<<(_Inout_ cursor_out &cursor) const;
|
|
|
|
///
|
|
/// Returns packed size of a configuration
|
|
///
|
|
/// \returns Size of data when packed (in bytes)
|
|
///
|
|
virtual size_t get_pk_size() const;
|
|
|
|
///
|
|
/// Unpacks a configuration
|
|
///
|
|
/// \param[inout] cursor Memory cursor
|
|
///
|
|
virtual void operator>>(_Inout_ cursor_in &cursor);
|
|
|
|
/// @}
|
|
|
|
public:
|
|
std::list<eap::config_provider> m_providers; ///< List of provider configurations
|
|
};
|
|
}
|
|
|
|
|
|
inline void operator<<(_Inout_ eap::cursor_out &cursor, _In_ const eap::config &val)
|
|
{
|
|
val.operator<<(cursor);
|
|
}
|
|
|
|
|
|
inline size_t pksizeof(const eap::config &val)
|
|
{
|
|
return val.get_pk_size();
|
|
}
|
|
|
|
|
|
inline void operator>>(_Inout_ eap::cursor_in &cursor, _Out_ eap::config &val)
|
|
{
|
|
val.operator>>(cursor);
|
|
}
|