406 lines
13 KiB
C++
406 lines
13 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 "EAPSerial.h"
|
|
#include "TLS.h"
|
|
#include "PAP.h"
|
|
|
|
#include <WinStd/Crypt.h>
|
|
|
|
|
|
namespace eap
|
|
{
|
|
class config_ttls;
|
|
class credentials_ttls;
|
|
class session_ttls;
|
|
class peer_ttls;
|
|
}
|
|
|
|
namespace eapserial
|
|
{
|
|
inline void pack(_Inout_ unsigned char *&cursor, _In_ const eap::config_ttls &val);
|
|
inline size_t get_pk_size(const eap::config_ttls &val);
|
|
inline void unpack(_Inout_ const unsigned char *&cursor, _Out_ eap::config_ttls &val);
|
|
}
|
|
|
|
#pragma once
|
|
|
|
|
|
namespace eap
|
|
{
|
|
///
|
|
/// TTLS configuration
|
|
///
|
|
class config_ttls : public config_tls
|
|
{
|
|
public:
|
|
///
|
|
/// Constructs configuration
|
|
///
|
|
/// \param[in] mod Reference of the EAP module to use for global services
|
|
///
|
|
config_ttls(_In_ module &mod);
|
|
|
|
///
|
|
/// Copies configuration
|
|
///
|
|
/// \param[in] other Configuration to copy from
|
|
///
|
|
config_ttls(const _In_ config_ttls &other);
|
|
|
|
///
|
|
/// Moves configuration
|
|
///
|
|
/// \param[in] other Configuration to move from
|
|
///
|
|
config_ttls(_Inout_ config_ttls &&other);
|
|
|
|
///
|
|
/// Destructs configuration
|
|
///
|
|
virtual ~config_ttls();
|
|
|
|
///
|
|
/// Copies configuration
|
|
///
|
|
/// \param[in] other Configuration to copy from
|
|
///
|
|
/// \returns Reference to this object
|
|
///
|
|
config_ttls& operator=(const _In_ config_ttls &other);
|
|
|
|
///
|
|
/// Moves configuration
|
|
///
|
|
/// \param[in] other Configuration to move from
|
|
///
|
|
/// \returns Reference to this object
|
|
///
|
|
config_ttls& operator=(_Inout_ config_ttls &&other);
|
|
|
|
///
|
|
/// Clones configuration
|
|
///
|
|
/// \returns Pointer to cloned configuration
|
|
///
|
|
virtual config* clone() const { return new config_ttls(*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;
|
|
|
|
///
|
|
/// 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 `eap::type_ttls`
|
|
///
|
|
virtual eap::type_t get_method_id() { return eap::type_ttls; }
|
|
|
|
public:
|
|
config_method *m_inner; ///< Inner authentication configuration
|
|
};
|
|
|
|
|
|
///
|
|
/// TTLS credentials
|
|
///
|
|
class credentials_ttls : public credentials_tls
|
|
{
|
|
public:
|
|
///
|
|
/// Constructs credentials
|
|
///
|
|
/// \param[in] mod Reference of the EAP module to use for global services
|
|
///
|
|
credentials_ttls(_In_ module &mod);
|
|
|
|
///
|
|
/// Copies credentials
|
|
///
|
|
/// \param[in] other Credentials to copy from
|
|
///
|
|
credentials_ttls(_In_ const credentials_ttls &other);
|
|
|
|
///
|
|
/// Moves credentials
|
|
///
|
|
/// \param[in] other Credentials to move from
|
|
///
|
|
credentials_ttls(_Inout_ credentials_ttls &&other);
|
|
|
|
///
|
|
/// Copies credentials
|
|
///
|
|
/// \param[in] other Credentials to copy from
|
|
///
|
|
/// \returns Reference to this object
|
|
///
|
|
credentials_ttls& operator=(_In_ const credentials_ttls &other);
|
|
|
|
///
|
|
/// Moves credentials
|
|
///
|
|
/// \param[in] other Credentials to move from
|
|
///
|
|
/// \returns Reference to this object
|
|
///
|
|
credentials_ttls& operator=(_Inout_ credentials_ttls &&other);
|
|
|
|
///
|
|
/// Clones credentials
|
|
///
|
|
/// \returns Pointer to cloned credentials
|
|
///
|
|
virtual config* clone() const { return new credentials_ttls(*this); }
|
|
|
|
///
|
|
/// Resets credentials
|
|
///
|
|
virtual void clear();
|
|
|
|
///
|
|
/// Test credentials if blank
|
|
///
|
|
virtual bool empty() const;
|
|
|
|
/// \name XML credentials management
|
|
/// @{
|
|
|
|
///
|
|
/// Load credentials from XML document
|
|
///
|
|
/// \param[in] pConfigRoot Root element for loading credentials
|
|
/// \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);
|
|
|
|
/// @}
|
|
|
|
/// \name Storage
|
|
/// @{
|
|
|
|
///
|
|
/// Save credentials to Windows Credential Manager
|
|
///
|
|
/// \param[in] pszTargetName The name in Windows Credential Manager to store credentials as
|
|
/// \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 store(_In_ LPCTSTR pszTargetName, _Out_ EAP_ERROR **ppEapError) const;
|
|
|
|
///
|
|
/// Retrieve credentials from Windows Credential Manager
|
|
///
|
|
/// \param[in] pszTargetName The name in Windows Credential Manager to retrieve credentials from
|
|
/// \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 retrieve(_In_ LPCTSTR pszTargetName, _Out_ EAP_ERROR **ppEapError);
|
|
|
|
/// @}
|
|
|
|
public:
|
|
credentials *m_inner; ///< Inner credentials
|
|
};
|
|
|
|
|
|
///
|
|
/// TTLS session
|
|
///
|
|
class session_ttls : public session
|
|
{
|
|
public:
|
|
///
|
|
/// Constructor
|
|
///
|
|
session_ttls();
|
|
};
|
|
|
|
|
|
///
|
|
/// TTLS peer
|
|
///
|
|
class peer_ttls : public peer<eap::config_ttls, eap::credentials_ttls, int, int>
|
|
{
|
|
public:
|
|
///
|
|
/// Constructor
|
|
///
|
|
peer_ttls();
|
|
|
|
///
|
|
/// Initializes an EAP peer method for EAPHost.
|
|
///
|
|
/// \sa [EapPeerGetInfo function](https://msdn.microsoft.com/en-us/library/windows/desktop/aa363613.aspx)
|
|
///
|
|
virtual DWORD initialize(_Out_ EAP_ERROR **ppEapError);
|
|
|
|
///
|
|
/// Shuts down the EAP method and prepares to unload its corresponding DLL.
|
|
///
|
|
/// \sa [EapPeerShutdown function](https://msdn.microsoft.com/en-us/library/windows/desktop/aa363627.aspx)
|
|
///
|
|
virtual DWORD shutdown(_Out_ EAP_ERROR **ppEapError);
|
|
|
|
///
|
|
/// Returns the user data and user identity after being called by EAPHost.
|
|
///
|
|
/// \sa [EapPeerGetIdentity function](https://msdn.microsoft.com/en-us/library/windows/desktop/aa363607.aspx)
|
|
///
|
|
virtual DWORD get_identity(
|
|
_In_ DWORD dwFlags,
|
|
_In_ DWORD dwConnectionDataSize,
|
|
_In_count_(dwConnectionDataSize) const BYTE *pConnectionData,
|
|
_In_ DWORD dwUserDataSize,
|
|
_In_count_(dwUserDataSize) const BYTE *pUserData,
|
|
_In_ HANDLE hTokenImpersonateUser,
|
|
_Out_ BOOL *pfInvokeUI,
|
|
_Out_ DWORD *pdwUserDataOutSize,
|
|
_Out_ BYTE **ppUserDataOut,
|
|
_Out_ WCHAR **ppwszIdentity,
|
|
_Out_ EAP_ERROR **ppEapError);
|
|
|
|
///
|
|
/// Defines the implementation of an EAP method-specific function that retrieves the properties of an EAP method given the connection and user data.
|
|
///
|
|
/// \sa [EapPeerGetMethodProperties function](https://msdn.microsoft.com/en-us/library/windows/desktop/hh706636.aspx)
|
|
///
|
|
virtual DWORD get_method_properties(
|
|
_In_ DWORD dwVersion,
|
|
_In_ DWORD dwFlags,
|
|
_In_ HANDLE hUserImpersonationToken,
|
|
_In_ DWORD dwEapConnDataSize,
|
|
_In_count_(dwEapConnDataSize) const BYTE *pEapConnData,
|
|
_In_ DWORD dwUserDataSize,
|
|
_In_count_(dwUserDataSize) const BYTE *pUserData,
|
|
_Out_ EAP_METHOD_PROPERTY_ARRAY *pMethodPropertyArray,
|
|
_Out_ EAP_ERROR **ppEapError) const;
|
|
};
|
|
}
|
|
|
|
|
|
namespace eapserial
|
|
{
|
|
///
|
|
/// Packs a TTLS based method configuration
|
|
///
|
|
/// \param[inout] cursor Memory cursor
|
|
/// \param[in] val Configuration to pack
|
|
///
|
|
inline void pack(_Inout_ unsigned char *&cursor, _In_ const eap::config_ttls &val)
|
|
{
|
|
pack(cursor, (const eap::config_tls&)val);
|
|
if (val.m_inner) {
|
|
if (dynamic_cast<eap::config_pap*>(val.m_inner)) {
|
|
pack(cursor, (unsigned char)eap::type_pap);
|
|
pack(cursor, (const eap::config_pap&)*val.m_inner);
|
|
} else {
|
|
assert(0); // Unsupported inner authentication method type.
|
|
pack(cursor, (unsigned char)0);
|
|
}
|
|
} else
|
|
pack(cursor, (unsigned char)0);
|
|
}
|
|
|
|
|
|
///
|
|
/// Returns packed size of a TTLS based 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_ttls &val)
|
|
{
|
|
size_t size_inner = sizeof(unsigned char);
|
|
if (val.m_inner) {
|
|
if (dynamic_cast<eap::config_pap*>(val.m_inner))
|
|
size_inner += get_pk_size((const eap::config_pap&)*val.m_inner);
|
|
else
|
|
assert(0); // Unsupported inner authentication method type.
|
|
}
|
|
|
|
return
|
|
get_pk_size((const eap::config_tls&)val) +
|
|
size_inner;
|
|
}
|
|
|
|
|
|
///
|
|
/// Unpacks a TTLS based 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_ttls &val)
|
|
{
|
|
unpack(cursor, (eap::config_tls&)val);
|
|
|
|
assert(!val.m_inner);
|
|
unsigned char eap_type;
|
|
unpack(cursor, eap_type);
|
|
switch (eap_type) {
|
|
case eap::type_pap:
|
|
val.m_inner = new eap::config_pap(val.m_module);
|
|
unpack(cursor, (eap::config_pap&)*val.m_inner);
|
|
break;
|
|
case 0 : break;
|
|
default : assert(0); // Unsupported inner authentication method type.
|
|
}
|
|
}
|
|
}
|