Session.h/cpp >> Method.h/cpp

lib/EAPBase/include/Method.h

@@ -0,0 +1,129 @@
+/*
+    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/>.
+*/
+
+namespace eap
+{
+    ///
+    /// EAP method base class
+    ///
+    class method;
+}
+
+#pragma once
+
+#include "Config.h"
+#include "Credentials.h"
+#include "Module.h"
+
+#include <WinStd/EAP.h>
+
+#include <Windows.h>
+#include <eaptypes.h> // Must include after <Windows.h>
+extern "C" {
+#include <eapmethodpeerapis.h>
+}
+#include <sal.h>
+
+
+namespace eap
+{
+    class method
+    {
+    public:
+        ///
+        /// Constructs an EAP method
+        ///
+        /// \param[in] mod  EAP module to use for global services
+        /// \param[in] cfg  Method configuration
+        ///
+        method(_In_ module &module, _In_ config_method &cfg, _In_ credentials &cred);
+
+        ///
+        /// Copies an EAP method
+        ///
+        /// \param[in] other  EAP method to copy from
+        ///
+        method(_In_ const method &other);
+
+        ///
+        /// Moves an EAP method
+        ///
+        /// \param[in] other  EAP method to move from
+        ///
+        method(_Inout_ method &&other);
+
+        ///
+        /// Copies an EAP method
+        ///
+        /// \param[in] other  EAP method to copy from
+        ///
+        /// \returns Reference to this object
+        ///
+        method& operator=(_In_ const method &other);
+
+        ///
+        /// Moves an EAP method
+        ///
+        /// \param[in] other  EAP method to move from
+        ///
+        /// \returns Reference to this object
+        ///
+        method& operator=(_Inout_ method &&other);
+
+        /// \name Packet processing
+        /// @{
+
+        ///
+        /// Processes a packet received by EAPHost from a supplicant.
+        ///
+        /// \returns
+        /// - \c true if succeeded
+        /// - \c false otherwise. See \p ppEapError for details.
+        ///
+        /// \sa [EapPeerProcessRequestPacket function](https://msdn.microsoft.com/en-us/library/windows/desktop/aa363621.aspx)
+        ///
+        virtual bool process_request_packet(
+            _In_bytecount_(dwReceivedPacketSize) const EapPacket           *pReceivedPacket,
+            _In_                                       DWORD               dwReceivedPacketSize,
+            _Out_                                      EapPeerMethodOutput *pEapOutput,
+            _Out_                                      EAP_ERROR           **ppEapError) = 0;
+
+        ///
+        /// Obtains a response packet from the EAP method.
+        ///
+        /// \sa [EapPeerGetResponsePacket function](https://msdn.microsoft.com/en-us/library/windows/desktop/aa363610.aspx)
+        ///
+        /// \returns
+        /// - \c true if succeeded
+        /// - \c false otherwise. See \p ppEapError for details.
+        ///
+        virtual bool get_response_packet(
+            _Inout_bytecap_(*dwSendPacketSize) EapPacket *pSendPacket,
+            _Inout_                            DWORD     *pdwSendPacketSize,
+            _Out_                              EAP_ERROR **ppEapError) = 0;
+
+        /// @}
+
+    public:
+        module &m_module;       ///< EAP module
+        config_method &m_cfg;   ///< Method configuration
+        credentials &m_cred;    ///< User credentials
+    };
+}