Merge commit '86cc97e55fe346502462284d2e636a2b3708163e' as 'Sources/OpenVPN3'

2026-04-24 00:00:05 +08:00 · 2020-02-24 14:43:11 +03:00
parent 133b3756e6 86cc97e55f
commit 32f1555929
655 changed files with 146468 additions and 0 deletions
@@ -0,0 +1,150 @@
+//    OpenVPN -- An application to securely tunnel IP networks
+//               over a single port, with support for SSL/TLS-based
+//               session authentication and key exchange,
+//               packet encryption, packet authentication, and
+//               packet compression.
+//
+//    Copyright (C) 2012-2017 OpenVPN Inc.
+//
+//    This program is free software: you can redistribute it and/or modify
+//    it under the terms of the GNU Affero General Public License Version 3
+//    as published by the Free Software Foundation.
+//
+//    This program 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 Affero General Public License for more details.
+//
+//    You should have received a copy of the GNU Affero General Public License
+//    along with this program in the COPYING file.
+//    If not, see <http://www.gnu.org/licenses/>.
+
+// Server-side client manager
+
+#ifndef OPENVPN_SERVER_MANAGE_H
+#define OPENVPN_SERVER_MANAGE_H
+
+#include <string>
+#include <vector>
+
+#include <openvpn/common/size.hpp>
+#include <openvpn/common/exception.hpp>
+#include <openvpn/common/rc.hpp>
+#include <openvpn/tun/server/tunbase.hpp>
+#include <openvpn/addr/route.hpp>
+#include <openvpn/auth/authcreds.hpp>
+#include <openvpn/ssl/proto.hpp>
+#include <openvpn/server/servhalt.hpp>
+#include <openvpn/server/peerstats.hpp>
+#include <openvpn/server/peeraddr.hpp>
+#include <openvpn/auth/authcert.hpp>
+#include <openvpn/auth/authstatusconst.hpp>
+
+namespace openvpn {
+  namespace ManClientInstance {
+
+    // Base class for the per-client-instance state of the ManServer.
+    // Each client instance uses this class to send data to the man layer.
+    struct Send : public virtual RC<thread_unsafe_refcount>
+    {
+      typedef RCPtr<Send> Ptr;
+
+      virtual void pre_stop() = 0;
+      virtual void stop() = 0;
+
+      virtual void auth_request(const AuthCreds::Ptr& auth_creds,
+				const AuthCert::Ptr& auth_cert,
+				const PeerAddr::Ptr& peer_addr) = 0;
+      virtual void push_request(ProtoContext::Config::Ptr pconf) = 0;
+
+      // INFO notification
+      virtual void info_request(const std::string& imsg) = 0;
+
+      // bandwidth stats notification
+      virtual void stats_notify(const PeerStats& ps, const bool final) = 0;
+
+      // client float notification
+      virtual void float_notify(const PeerAddr::Ptr& addr) = 0;
+
+      // ID
+      virtual std::string instance_name() const = 0;
+      virtual std::uint64_t instance_id() const = 0;
+
+      // return a JSON string describing connected user
+      virtual std::string describe_user(const bool show_userprop) = 0;
+
+      // disconnect
+      virtual void disconnect_user(const HaltRestart::Type type,
+				   const AuthStatus::Type auth_status,
+				   const std::string& reason,
+				   const bool tell_client) = 0;
+
+      // send control channel message
+      virtual void post_info_user(BufferPtr&& info) = 0;
+
+      // set ACL index for user
+      virtual void set_acl_index(const int acl_index,
+				 const std::string* username,
+				 const bool challenge) = 0;
+
+      // notify of local user properties update
+      virtual void userprop_local_update() = 0;
+    };
+
+    // Base class for the client instance receiver.  Note that all
+    // client instance receivers (transport, routing, management,
+    // etc.) must inherit virtually from RC because the client instance
+    // object will inherit from multiple receivers.
+    struct Recv : public virtual RC<thread_unsafe_refcount>
+    {
+      typedef RCPtr<Recv> Ptr;
+
+      virtual void stop() = 0;
+
+      virtual void auth_failed(const std::string& reason,
+			       const bool tell_client) = 0;
+
+      virtual void push_reply(std::vector<BufferPtr>&& push_msgs) = 0;
+
+      // push a halt or restart message to client
+      virtual void push_halt_restart_msg(const HaltRestart::Type type,
+					 const std::string& reason,
+					 const bool tell_client) = 0;
+
+
+      // send control channel message
+      virtual void post_cc_msg(BufferPtr&& msg) = 0;
+
+      // schedule a low-level connection disconnect in seconds
+      virtual void schedule_disconnect(const unsigned int seconds) = 0;
+
+      // schedule an auth pending disconnect in seconds
+      virtual void schedule_auth_pending_timeout(const unsigned int seconds) = 0;
+
+      // set up relay to target
+      virtual void relay(const IP::Addr& target, const int port) = 0;
+
+      // get client bandwidth stats
+      virtual PeerStats stats_poll() = 0;
+
+      // return true if management layer should preserve session ID
+      virtual bool should_preserve_session_id() = 0;
+
+      // get native reference to client instance
+      virtual TunClientInstance::NativeHandle tun_native_handle() = 0;
+    };
+
+    struct Factory : public RC<thread_unsafe_refcount>
+    {
+      typedef RCPtr<Factory> Ptr;
+
+      virtual void start() = 0;
+      virtual void stop() = 0;
+
+      virtual Send::Ptr new_obj(Recv* instance) = 0;
+    };
+
+  }
+}
+
+#endif