asiopolysock.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
//
 
// Asio polymorphic socket for handling TCP
// and unix domain sockets.
 
#ifndef OPENVPN_ASIO_ASIOPOLYSOCK_H
#define OPENVPN_ASIO_ASIOPOLYSOCK_H
 
#include <openvpn/io/io.hpp>
 
#include <openvpn/common/platform.hpp>
#include <openvpn/common/exception.hpp>
#include <openvpn/common/size.hpp>
#include <openvpn/common/rc.hpp>
#include <openvpn/common/function.hpp>
#include <openvpn/common/to_string.hpp>
#include <openvpn/common/sockopt.hpp>
#include <openvpn/addr/ip.hpp>
 
#if defined(OPENVPN_POLYSOCK_SUPPORTS_ALT_ROUTING)
#include <openvpn/asio/alt_routing.hpp>
#elif defined(OPENVPN_POLYSOCK_SUPPORTS_BIND)
#include <openvpn/asio/asioboundsock.hpp>
#endif
 
#ifdef ASIO_HAS_LOCAL_SOCKETS
#include <openvpn/common/peercred.hpp>
#endif
 
namespace openvpn::AsioPolySock {
// for shutdown()
enum ShutdownFlags
{
    SHUTDOWN_SEND = (1 << 0),
    SHUTDOWN_RECV = (1 << 1),
};
 
class Base : public RC<thread_unsafe_refcount>
{
  public:
    typedef RCPtr<Base> Ptr;
 
    virtual void async_send(const openvpn_io::const_buffer &buf,
                            Function<void(const openvpn_io::error_code &, const size_t)> &&callback) = 0;
 
    virtual void async_receive(const openvpn_io::mutable_buffer &buf,
                               Function<void(const openvpn_io::error_code &, const size_t)> &&callback) = 0;
 
    virtual std::string remote_endpoint_str() const = 0;
    virtual bool remote_ip_port(IP::Addr &addr, unsigned int &port) const = 0;
 
    virtual void non_blocking(const bool state) = 0;
 
    virtual void close() = 0;
 
    virtual void shutdown(const unsigned int flags)
    {
    }
 
    virtual void tcp_nodelay()
    {
    }
    virtual void set_cloexec()
    {
    }
 
    virtual openvpn_io::detail::socket_type native_handle()
    {
        return -1;
    }
 
#ifdef ASIO_HAS_LOCAL_SOCKETS
    virtual bool peercreds(SockOpt::Creds &cr)
    {
        return false;
    }
#endif
 
#if defined(OPENVPN_POLYSOCK_SUPPORTS_ALT_ROUTING)
    virtual bool alt_routing_enabled() const
    {
        return false;
    }
#endif
 
    virtual bool is_open() const = 0;
    virtual bool is_local() const = 0;
 
    size_t index() const
    {
        return index_;
    }
 
  protected:
    Base(const size_t index)
        : index_(index)
    {
    }
 
  private:
    size_t index_;
};
 
struct TCP : public Base
{
    typedef RCPtr<TCP> Ptr;
 
    TCP(openvpn_io::io_context &io_context,
        const size_t index)
        : Base(index),
          socket(io_context)
    {
    }
 
    void async_send(const openvpn_io::const_buffer &buf,
                    Function<void(const openvpn_io::error_code &, const size_t)> &&callback) override
    {
        socket.async_send(buf, std::move(callback));
    }
 
    void async_receive(const openvpn_io::mutable_buffer &buf,
                       Function<void(const openvpn_io::error_code &, const size_t)> &&callback) override
    {
        socket.async_receive(buf, std::move(callback));
    }
 
#if !defined(OPENVPN_POLYSOCK_SUPPORTS_ALT_ROUTING)
    std::string remote_endpoint_str() const override
    {
        try
        {
            return "TCP " + openvpn::to_string(socket.remote_endpoint());
        }
        catch (const std::exception &)
        {
            return "TCP";
        }
    }
#endif
 
    bool remote_ip_port(IP::Addr &addr, unsigned int &port) const override
    {
        try
        {
            addr = IP::Addr::from_asio(socket.remote_endpoint().address());
            port = socket.remote_endpoint().port();
            return true;
        }
        catch (const std::exception &)
        {
            return false;
        }
    }
 
    void non_blocking(const bool state) override
    {
        socket.non_blocking(state);
    }
 
    void tcp_nodelay() override
    {
        socket.set_option(openvpn_io::ip::tcp::no_delay(true));
    }
 
#if !defined(OPENVPN_PLATFORM_WIN)
    void set_cloexec() override
    {
        const int fd = socket.native_handle();
        if (fd >= 0)
            SockOpt::set_cloexec(fd);
    }
#endif
 
    void shutdown(const unsigned int flags) override
    {
        if (flags & SHUTDOWN_SEND)
            socket.shutdown(openvpn_io::ip::tcp::socket::shutdown_send);
        else if (flags & SHUTDOWN_RECV)
            socket.shutdown(openvpn_io::ip::tcp::socket::shutdown_receive);
    }
 
    void close() override
    {
        socket.close();
    }
 
    bool is_open() const override
    {
        return socket.is_open();
    }
 
    bool is_local() const override
    {
        return false;
    }
 
    openvpn_io::detail::socket_type native_handle() override
    {
        return socket.native_handle();
    }
 
#if defined(OPENVPN_POLYSOCK_SUPPORTS_ALT_ROUTING)
    std::string remote_endpoint_str() const override
    {
        const char *proto = (socket.alt_routing_enabled() ? "TCP ALT " : "TCP ");
        return proto + socket.to_string();
    }
 
    bool alt_routing_enabled() const override
    {
        return socket.alt_routing_enabled();
    }
 
    AltRouting::Socket socket;
#elif defined(OPENVPN_POLYSOCK_SUPPORTS_BIND)
    AsioBoundSocket::Socket socket;
#else
    openvpn_io::ip::tcp::socket socket;
#endif
};
 
#ifdef ASIO_HAS_LOCAL_SOCKETS
struct Unix : public Base
{
    typedef RCPtr<Unix> Ptr;
 
    Unix(openvpn_io::io_context &io_context,
         const size_t index)
        : Base(index),
          socket(io_context)
    {
    }
 
    void async_send(const openvpn_io::const_buffer &buf,
                    Function<void(const openvpn_io::error_code &, const size_t)> &&callback) override
    {
        socket.async_send(buf, std::move(callback));
    }
 
    void async_receive(const openvpn_io::mutable_buffer &buf,
                       Function<void(const openvpn_io::error_code &, const size_t)> &&callback) override
    {
        socket.async_receive(buf, std::move(callback));
    }
 
    std::string remote_endpoint_str() const override
    {
        return "LOCAL";
    }
 
    bool remote_ip_port(IP::Addr &, unsigned int &) const override
    {
        return false;
    }
 
    void non_blocking(const bool state) override
    {
        socket.non_blocking(state);
    }
 
    bool peercreds(SockOpt::Creds &cr) override
    {
        return SockOpt::peercreds(socket.native_handle(), cr);
    }
 
    void set_cloexec() override
    {
        const int fd = socket.native_handle();
        if (fd >= 0)
            SockOpt::set_cloexec(fd);
    }
 
#if !defined(OPENVPN_PLATFORM_MAC)
    // shutdown() throws "socket is not connected" exception
    // on macos if another side has called close() - this behavior
    // breaks communication with agent, and hence disabled
    void shutdown(const unsigned int flags) override
    {
        if (flags & SHUTDOWN_SEND)
            socket.shutdown(openvpn_io::ip::tcp::socket::shutdown_send);
        else if (flags & SHUTDOWN_RECV)
            socket.shutdown(openvpn_io::ip::tcp::socket::shutdown_receive);
    }
#endif
 
    void close() override
    {
        socket.close();
    }
 
    bool is_open() const override
    {
        return socket.is_open();
    }
 
    bool is_local() const override
    {
        return true;
    }
 
    openvpn_io::detail::socket_type native_handle() override
    {
        return socket.native_handle();
    }
 
    openvpn_io::local::stream_protocol::socket socket;
};
#endif
 
#if defined(OPENVPN_PLATFORM_WIN)
struct NamedPipe : public Base
{
    typedef RCPtr<NamedPipe> Ptr;
 
    NamedPipe(openvpn_io::windows::stream_handle &&handle_arg,
              const size_t index)
        : Base(index),
          handle(std::move(handle_arg))
    {
    }
 
    void async_send(const openvpn_io::const_buffer &buf,
                    Function<void(const openvpn_io::error_code &, const size_t)> &&callback) override
    {
        handle.async_write_some(buf, std::move(callback));
    }
 
    void async_receive(const openvpn_io::mutable_buffer &buf,
                       Function<void(const openvpn_io::error_code &, const size_t)> &&callback) override
    {
        handle.async_read_some(buf, std::move(callback));
    }
 
    std::string remote_endpoint_str() const override
    {
        return "NAMED_PIPE";
    }
 
    bool remote_ip_port(IP::Addr &, unsigned int &) const override
    {
        return false;
    }
 
    void non_blocking(const bool state) override
    {
    }
 
    void close() override
    {
        handle.close();
    }
 
    bool is_open() const override
    {
        return handle.is_open();
    }
 
    bool is_local() const override
    {
        return true;
    }
 
    openvpn_io::windows::stream_handle handle;
};
#endif
} // namespace openvpn::AsioPolySock
 
#endif