transbase.hpp

Go to the documentation of this file.

//    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- OpenVPN Inc.
//
//    SPDX-License-Identifier: MPL-2.0 OR AGPL-3.0-only WITH openvpn3-openssl-exception
//
 
// Abstract base classes for server transport objects that implement UDP, TCP,
// HTTP Proxy, etc.
 
#ifndef OPENVPN_TRANSPORT_SERVER_TRANSBASE_H
#define OPENVPN_TRANSPORT_SERVER_TRANSBASE_H
 
#include <string>
#include <vector>
 
#include <openvpn/io/io.hpp>
 
#include <openvpn/common/exception.hpp>
#include <openvpn/common/rc.hpp>
#include <openvpn/buffer/buffer.hpp>
#include <openvpn/addr/route.hpp>
#include <openvpn/crypto/cryptodc.hpp>
#include <openvpn/server/servhalt.hpp>
#include <openvpn/server/peerstats.hpp>
#include <openvpn/server/peeraddr.hpp>
#include <openvpn/ssl/datalimit.hpp>
#include <openvpn/ssl/psid.hpp>
 
// TunClientInstance fwd decl replaces
// #include <openvpn/tun/server/tunbase.hpp>
namespace openvpn {
class PsidCookie;
namespace TunClientInstance {
struct Recv;
struct Send;
} // namespace TunClientInstance
} // namespace openvpn
 
// used by ipma_notify()
struct ovpn_tun_head_ipma;
 
namespace openvpn {
 
// Base class for server transport object.
struct TransportServer : public RC<thread_unsafe_refcount>
{
    typedef RCPtr<TransportServer> Ptr;
 
    virtual void start() = 0;
    virtual void stop() = 0;
    virtual std::string local_endpoint_info() const = 0;
    virtual IP::Addr local_endpoint_addr() const = 0;
};
 
// Factory for server transport object.
struct TransportServerFactory : public RC<thread_unsafe_refcount>
{
    typedef RCPtr<TransportServerFactory> Ptr;
 
    virtual TransportServer::Ptr new_server_obj(openvpn_io::io_context &io_context) = 0;
};
 
namespace TransportClientInstance {
 
// Base class for the per-client-instance state of the TransportServer.
// Each client instance uses this class to send data to the transport layer.
struct Send : public virtual RC<thread_unsafe_refcount>
{
    typedef RCPtr<Send> Ptr;
 
    virtual bool defined() const = 0;
    virtual void stop() = 0;
 
    virtual bool transport_send_const(const Buffer &buf) = 0;
    virtual bool transport_send(BufferAllocated &buf) = 0;
 
    virtual const std::string &transport_info() const = 0;
 
    // bandwidth stats polling
    virtual bool stats_pending() const = 0;
    virtual PeerStats stats_poll() = 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>
{
    // clang-format off
    typedef RCPtr<Recv> Ptr;
 
    virtual bool defined() const = 0;
    virtual void stop() = 0;
 
    virtual void start(const Send::Ptr &parent,
                       const PeerAddr::Ptr &addr,
                       const int local_peer_id,
                       const ProtoSessionID cookie_psid = ProtoSessionID()) = 0;
 
    // Called with OpenVPN-encapsulated packets from transport layer.
    // Returns true if packet successfully validated.
    virtual bool transport_recv(BufferAllocated &buf) = 0;
 
    // Return true if keepalive parameter(s) are enabled.
    virtual bool is_keepalive_enabled() const = 0;
 
    // Disable keepalive for rest of session, but fetch
    // the keepalive parameters (in seconds).
    virtual void disable_keepalive(unsigned int &keepalive_ping,
                                   unsigned int &keepalive_timeout) = 0;
 
    // override the data channel factory
    virtual void override_dc_factory(const CryptoDCFactory::Ptr &dc_factory) = 0;
 
    // override the tun provider
    virtual TunClientInstance::Recv *override_tun(TunClientInstance::Send *tun) = 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;
 
    // IP-mapped ACL (IPMA) notification
    virtual void ipma_notify(const struct ovpn_tun_head_ipma &ipma) = 0;
 
    // Data limit notification -- trigger a renegotiation
    // when cdl_status == DataLimit::Red.
    virtual void data_limit_notify(const int key_id,
                                   const DataLimit::Mode cdl_mode,
                                   const DataLimit::State cdl_status) = 0;
 
    // push a halt or restart message to client
    virtual void push_halt_restart_msg(const HaltRestart::Type type,
                                       const std::string &reason,
                                       const std::string &client_reason) = 0;
    // clang-format on
};
 
// Base class for factory used to create Recv objects.
struct Factory : public RC<thread_unsafe_refcount>
{
    typedef RCPtr<Factory> Ptr;
 
    virtual Recv::Ptr new_client_instance() = 0;
    virtual bool validate_initial_packet(const BufferAllocated &net_buf) = 0;
};
 
} // namespace TransportClientInstance
} // namespace openvpn
 
#endif