cliconnect.hpp

//    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-2022 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/>.

// This file implements the top-level connection logic for an OpenVPN client
// connection.  It is concerned with starting, stopping, pausing, and resuming
// OpenVPN client connections.  It deals with retrying a connection and handles
// the connection timeout.  It also deals with connection exceptions and understands
// the difference between an exception that should halt any further reconnection
// attempts (such as AUTH_FAILED), and other exceptions such as network errors
// that would justify a retry.
//
// Some of the methods in the class (such as stop, pause, and reconnect) are often
// called by another thread that is controlling the connection, therefore
// thread-safe methods are provided where the thread-safe function posts a message
// to the actual connection thread.
//
// In an OpenVPN client connection, the following object stack would be used:
//
// 1. class ClientConnect --
//      The top level object in an OpenVPN client connection.
// 2. class ClientProto::Session --
//      The OpenVPN client protocol object.
// 3. class ProtoContext --
//      The core OpenVPN protocol implementation that is common to both
//      client and server.
// 4. ProtoStackBase<Packet> --
//      The lowest-level class that implements the basic functionality of
//      tunneling a protocol over a reliable or unreliable transport
//      layer, but isn't specific to OpenVPN per-se.

#ifndef OPENVPN_CLIENT_CLICONNECT_H
#define OPENVPN_CLIENT_CLICONNECT_H

#include <memory>
#include <utility>

#include <openvpn/common/bigmutex.hpp>
#include <openvpn/common/rc.hpp>
#include <openvpn/asio/asiowork.hpp>
#include <openvpn/error/excode.hpp>
#include <openvpn/time/asiotimer.hpp>
#include <openvpn/client/cliopt.hpp>
#include <openvpn/client/remotelist.hpp>
#include <openvpn/client/clilife.hpp>

namespace openvpn {

// ClientConnect implements an "always-try-to-reconnect" approach, with remote
// list rotation.  Only gives up on auth failure or other fatal errors that
// cannot be remedied by retrying.
class ClientConnect : ClientProto::NotifyCallback,
                      RemoteList::BulkResolve::NotifyCallback,
                      ClientLifeCycle::NotifyCallback,
                      public RC<thread_unsafe_refcount>
{
  public:
    typedef RCPtr<ClientConnect> Ptr;
    typedef ClientOptions::Client Client;

    OPENVPN_SIMPLE_EXCEPTION(client_connect_unhandled_exception);

    ClientConnect(openvpn_io::io_context &io_context_arg,
                  const ClientOptions::Ptr &client_options_arg)
        : generation(0),
          halt(false),
          paused(false),
          client_finalized(false),
          dont_restart_(false),
          lifecycle_started(false),
          conn_timeout(client_options_arg->conn_timeout()),
          io_context(io_context_arg),
          client_options(client_options_arg),
          server_poll_timer(io_context_arg),
          restart_wait_timer(io_context_arg),
          conn_timer(io_context_arg),
          conn_timer_pending(false)
    {
    }

    void start()
    {
        if (!client && !halt)
        {
            if (!test_network())
                throw ErrorCode(Error::NETWORK_UNAVAILABLE, true, "Network Unavailable");

            RemoteList::Ptr remote_list = client_options->remote_list_precache();
            RemoteList::BulkResolve::Ptr bulkres(new RemoteList::BulkResolve(io_context,
                                                                             remote_list,
                                                                             client_options->stats_ptr()));
            if (bulkres->work_available())
            {
                ClientEvent::Base::Ptr ev = new ClientEvent::Resolve();
                client_options->events().add_event(std::move(ev));
                bulk_resolve = bulkres;
                bulk_resolve->start(this); // asynchronous -- will call back to bulk_resolve_done
            }
            else
                new_client();
        }
    }

    void send_explicit_exit_notify()
    {
        if (!halt && client)
            client->send_explicit_exit_notify();
    }

    void graceful_stop()
    {
        send_explicit_exit_notify();
        // sleep(5); // simulate slow stop (comment out for production)
        stop();
    }

    void stop()
    {
        if (!halt)
        {
            halt = true;
            if (bulk_resolve)
                bulk_resolve->cancel();
            if (client)
            {
                client->tun_set_disconnect();
                client->stop(false);
            }
            cancel_timers();
            asio_work.reset();

            client_options->finalize(true);

            if (lifecycle_started)
            {
                ClientLifeCycle *lc = client_options->lifecycle();
                if (lc)
                    lc->stop();
            }

            ClientEvent::Base::Ptr ev = new ClientEvent::Disconnected();
            client_options->events().add_event(std::move(ev));
#ifdef OPENVPN_IO_REQUIRES_STOP
            io_context.stop();
#endif
        }
    }

    void stop_on_signal(const openvpn_io::error_code &error, int signal_number)
    {
        stop();
    }

    // like stop() but may be safely called by another thread
    void thread_safe_stop()
    {
        if (!halt)
            openvpn_io::post(io_context, [self = Ptr(this)]()
                             {
		     OPENVPN_ASYNC_HANDLER;
		     self->graceful_stop(); });
    }

    void pause(const std::string &reason)
    {
        if (!halt && !paused)
        {
            paused = true;
            if (client)
            {
                client->send_explicit_exit_notify();
                client->stop(false);
                interim_finalize();
            }
            cancel_timers();
            asio_work.reset(new AsioWork(io_context));
            ClientEvent::Base::Ptr ev = new ClientEvent::Pause(reason);
            client_options->events().add_event(std::move(ev));
            client_options->stats().error(Error::N_PAUSE);
        }
    }

    void resume()
    {
        if (!halt && paused)
        {
            paused = false;
            ClientEvent::Base::Ptr ev = new ClientEvent::Resume();
            client_options->events().add_event(std::move(ev));
            client_options->remote_reset_cache_item();
            new_client();
        }
    }

    void reconnect(int seconds)
    {
        if (!halt)
        {
            if (seconds < 0)
                seconds = 0;
            OPENVPN_LOG("Client terminated, reconnecting in " << seconds << "...");
            server_poll_timer.cancel();
            restart_wait_timer.expires_after(Time::Duration::seconds(seconds));
            restart_wait_timer.async_wait([self = Ptr(this), gen = generation](const openvpn_io::error_code &error)
                                          {
                                          OPENVPN_ASYNC_HANDLER;
                                          self->restart_wait_callback(gen, error); });
        }
    }

    void thread_safe_pause(const std::string &reason)
    {
        if (!halt)
            openvpn_io::post(io_context, [self = Ptr(this), reason]()
                             {
		     OPENVPN_ASYNC_HANDLER;
		     self->pause(reason); });
    }

    void thread_safe_resume()
    {
        if (!halt)
            openvpn_io::post(io_context, [self = Ptr(this)]()
                             {
		     OPENVPN_ASYNC_HANDLER;
		     self->resume(); });
    }

    void thread_safe_reconnect(int seconds)
    {
        if (!halt)
            openvpn_io::post(io_context, [self = Ptr(this), seconds]()
                             {
		     OPENVPN_ASYNC_HANDLER;
		     self->reconnect(seconds); });
    }

    void dont_restart()
    {
        dont_restart_ = true;
    }

    void post_cc_msg(const std::string &msg)
    {
        if (!halt && client)
            client->post_cc_msg(msg);
    }

    void thread_safe_post_cc_msg(std::string msg)
    {
        if (!halt)
            openvpn_io::post(io_context, [self = Ptr(this), msg = std::move(msg)]()
                             {
		     OPENVPN_ASYNC_HANDLER;
		     self->post_cc_msg(msg); });
    }

    void send_app_control_channel_msg(std::string protocol, std::string msg)
    {
        if (!halt && client)
            client->post_app_control_message(std::move(protocol), std::move(msg));
    }

    void thread_safe_send_app_control_channel_msg(std::string protocol, std::string msg)
    {
        if (!halt)
        {
            openvpn_io::post(io_context, [self = Ptr(this), protocol = std::move(protocol), msg = std::move(msg)]()
                             {
                OPENVPN_ASYNC_HANDLER;
                self->send_app_control_channel_msg(protocol, msg); });
        }
    }

    ~ClientConnect()
    {
        stop();
    }

  private:
    void interim_finalize()
    {
        if (!client_finalized)
        {
            client_options->finalize(false);
            client_finalized = true;
        }
    }

    virtual void bulk_resolve_done() override
    {
        if (!halt && generation == 0)
            new_client();
    }

    void cancel_timers()
    {
        restart_wait_timer.cancel();
        server_poll_timer.cancel();
        conn_timer.cancel();
        conn_timer_pending = false;
    }

    void restart_wait_callback(unsigned int gen, const openvpn_io::error_code &e)
    {
        if (!e && gen == generation && !halt)
        {
            if (paused)
                resume();
            else
            {
                if (client)
                    client->send_explicit_exit_notify();
                new_client();
            }
        }
    }

    void server_poll_callback(unsigned int gen, const openvpn_io::error_code &e)
    {
        if (!e && gen == generation && !halt && !client->first_packet_received())
        {
            OPENVPN_LOG("Server poll timeout, trying next remote entry...");
            new_client();
        }
    }

    void conn_timer_callback(unsigned int gen, const openvpn_io::error_code &e)
    {
        if (!e && !halt)
        {
            client_options->stats().error(Error::CONNECTION_TIMEOUT);
            if (!paused && client_options->pause_on_connection_timeout())
            {
                // go into pause state instead of disconnect
                pause("");
            }
            else
            {
                ClientEvent::Base::Ptr ev = new ClientEvent::ConnectionTimeout();
                client_options->events().add_event(std::move(ev));
                stop();
            }
        }
    }

    void conn_timer_start(int timeout)
    {
        if (!conn_timer_pending && timeout > 0)
        {
            conn_timer.expires_after(Time::Duration::seconds(timeout));
            conn_timer.async_wait([self = Ptr(this), gen = generation](const openvpn_io::error_code &error)
                                  {
                                  OPENVPN_ASYNC_HANDLER;
                                  self->conn_timer_callback(gen, error); });
            conn_timer_pending = true;
        }
    }

    bool test_network() const
    {
        ClientLifeCycle *lc = client_options->lifecycle();
        if (lc)
        {
            if (!lc->network_available())
                return false;
        }
        return true;
    }

    virtual void client_proto_connected() override
    {
        conn_timer.cancel();
        conn_timer_pending = false;

        // Monitor connection lifecycle notifications, such as sleep,
        // wakeup, network-unavailable, and network-available.
        // Not all platforms define a lifecycle object.  Some platforms
        // such as Android and iOS manage lifecycle notifications
        // in the UI, and they call pause(), resume(), reconnect(), etc.
        // as needed using the main ovpncli API.
        if (!lifecycle_started)
        {
            ClientLifeCycle *lc = client_options->lifecycle(); // lifecycle is defined by platform, and may be NULL
            if (lc)
            {
                lc->start(this);
                lifecycle_started = true;
            }
        }
    }

    void client_proto_renegotiated() override
    {
        // Try to re-lookup potentially outdated RemoteList::Items
        if (bulk_resolve)
            bulk_resolve->start(this);
    }

    void queue_restart(const unsigned int delay_ms = default_delay_)
    {
        OPENVPN_LOG("Client terminated, restarting in " << delay_ms << " ms...");
        server_poll_timer.cancel();
        interim_finalize();
        restart_wait_timer.expires_after(Time::Duration::milliseconds(delay_ms));
        restart_wait_timer.async_wait([self = Ptr(this), gen = generation](const openvpn_io::error_code &error)
                                      {
                                      OPENVPN_ASYNC_HANDLER;
                                      self->restart_wait_callback(gen, error); });
    }

    virtual void client_proto_auth_pending_timeout(int timeout) override
    {
        if (conn_timer_pending)
        {
            auto timer_left = std::chrono::duration_cast<std::chrono::seconds>(conn_timer.expiry() - AsioTimer::clock_type::now()).count();
            if (timer_left < timeout)
            {
                OPENVPN_LOG("Extending connection timeout from " << timer_left << " to " << timeout << " for pending authentification");
                conn_timer.cancel();
                conn_timer_pending = false;
                conn_timer_start(timeout);
            }
        }
    }

    virtual void client_proto_terminate() override
    {
        if (!halt)
        {
            if (dont_restart_)
            {
                stop();
            }
            else
            {
                switch (client->fatal())
                {
                case Error::UNDEF: // means that there wasn't a fatal error
                    {
                        auto client_delay = client->reconnect_delay();
                        queue_restart(client_delay ? client_delay : default_delay_);
                    }
                    break;

                    // Errors below will cause the client to NOT retry the connection,
                    // or otherwise give the error special handling.

                case Error::AUTH_FAILED:
                    {
                        const std::string &reason = client->fatal_reason();
                        if (ChallengeResponse::is_dynamic(reason)) // dynamic challenge/response?
                        {
                            ClientEvent::Base::Ptr ev = new ClientEvent::DynamicChallenge(reason);
                            client_options->events().add_event(std::move(ev));
                            stop();
                        }
                        else
                        {
                            ClientEvent::Base::Ptr ev = new ClientEvent::AuthFailed(reason);
                            client_options->events().add_event(std::move(ev));
                            client_options->stats().error(Error::AUTH_FAILED);
                            if (client_options->retry_on_auth_failed())
                                queue_restart(5000);
                            else
                                stop();
                        }
                    }
                    break;
                case Error::TUN_SETUP_FAILED:
                    {
                        ClientEvent::Base::Ptr ev = new ClientEvent::TunSetupFailed(client->fatal_reason());
                        client_options->events().add_event(std::move(ev));
                        client_options->stats().error(Error::TUN_SETUP_FAILED);
                        stop();
                    }
                    break;
                case Error::TUN_REGISTER_RINGS_ERROR:
                    {
                        ClientEvent::Base::Ptr ev = new ClientEvent::TunSetupFailed(client->fatal_reason());
                        client_options->events().add_event(std::move(ev));
                        client_options->stats().error(Error::TUN_REGISTER_RINGS_ERROR);
                        stop();
                    }
                    break;
                case Error::TUN_IFACE_CREATE:
                    {
                        ClientEvent::Base::Ptr ev = new ClientEvent::TunIfaceCreate(client->fatal_reason());
                        client_options->events().add_event(std::move(ev));
                        client_options->stats().error(Error::TUN_IFACE_CREATE);
                        stop();
                    }
                    break;
                case Error::TUN_IFACE_DISABLED:
                    {
                        ClientEvent::Base::Ptr ev = new ClientEvent::TunIfaceDisabled(client->fatal_reason());
                        client_options->events().add_event(std::move(ev));
                        client_options->stats().error(Error::TUN_IFACE_DISABLED);
                        queue_restart(5000);
                    }
                    break;
                case Error::PROXY_ERROR:
                    {
                        ClientEvent::Base::Ptr ev = new ClientEvent::ProxyError(client->fatal_reason());
                        client_options->events().add_event(std::move(ev));
                        client_options->stats().error(Error::PROXY_ERROR);
                        stop();
                    }
                    break;
                case Error::PROXY_NEED_CREDS:
                    {
                        ClientEvent::Base::Ptr ev = new ClientEvent::ProxyNeedCreds(client->fatal_reason());
                        client_options->events().add_event(std::move(ev));
                        client_options->stats().error(Error::PROXY_NEED_CREDS);
                        stop();
                    }
                    break;
                case Error::CERT_VERIFY_FAIL:
                    {
                        ClientEvent::Base::Ptr ev = new ClientEvent::CertVerifyFail(client->fatal_reason());
                        client_options->events().add_event(std::move(ev));
                        client_options->stats().error(Error::CERT_VERIFY_FAIL);
                        stop();
                    }
                    break;
                case Error::TLS_VERSION_MIN:
                    {
                        ClientEvent::Base::Ptr ev = new ClientEvent::TLSVersionMinFail();
                        client_options->events().add_event(std::move(ev));
                        client_options->stats().error(Error::TLS_VERSION_MIN);
                        stop();
                    }
                    break;
                case Error::CLIENT_HALT:
                    {
                        ClientEvent::Base::Ptr ev = new ClientEvent::ClientHalt(client->fatal_reason());
                        client_options->events().add_event(std::move(ev));
                        client_options->stats().error(Error::CLIENT_HALT);
                        stop();
                    }
                    break;
                case Error::CLIENT_RESTART:
                    {
                        ClientEvent::Base::Ptr ev = new ClientEvent::ClientRestart(client->fatal_reason());
                        client_options->events().add_event(std::move(ev));
                        client_options->stats().error(Error::CLIENT_RESTART);
                        queue_restart();
                    }
                    break;
                case Error::INACTIVE_TIMEOUT:
                    {
                        ClientEvent::Base::Ptr ev = new ClientEvent::InactiveTimeout();
                        client_options->events().add_event(std::move(ev));
                        client_options->stats().error(Error::INACTIVE_TIMEOUT);

                        // explicit exit notify is sent earlier by
                        // ClientProto::Session::inactive_callback()
                        stop();
                    }
                    break;
                case Error::TRANSPORT_ERROR:
                    {
                        ClientEvent::Base::Ptr ev = new ClientEvent::TransportError(client->fatal_reason());
                        client_options->events().add_event(std::move(ev));
                        client_options->stats().error(Error::TRANSPORT_ERROR);
                        queue_restart(5000); // use a larger timeout to allow preemption from higher levels
                    }
                    break;
                case Error::TUN_ERROR:
                    {
                        ClientEvent::Base::Ptr ev = new ClientEvent::TunError(client->fatal_reason());
                        client_options->events().add_event(std::move(ev));
                        client_options->stats().error(Error::TUN_ERROR);
                        queue_restart(5000);
                    }
                    break;
                case Error::TUN_HALT:
                    {
                        ClientEvent::Base::Ptr ev = new ClientEvent::TunHalt(client->fatal_reason());
                        client_options->events().add_event(std::move(ev));
                        client_options->stats().error(Error::TUN_HALT);
                        stop();
                    }
                    break;
                case Error::RELAY:
                    {
                        ClientEvent::Base::Ptr ev = new ClientEvent::Relay();
                        client_options->events().add_event(std::move(ev));
                        client_options->stats().error(Error::RELAY);
                        transport_factory_relay = client->transport_factory_relay();
                        queue_restart(0);
                    }
                    break;
                case Error::RELAY_ERROR:
                    {
                        ClientEvent::Base::Ptr ev = new ClientEvent::RelayError(client->fatal_reason());
                        client_options->events().add_event(std::move(ev));
                        client_options->stats().error(Error::RELAY_ERROR);
                        stop();
                    }
                    break;
                case Error::COMPRESS_ERROR:
                    {
                        ClientEvent::Base::Ptr ev = new ClientEvent::CompressError(client->fatal_reason());
                        client_options->events().add_event(std::move(ev));
                        client_options->stats().error(Error::COMPRESS_ERROR);
                        stop();
                    }
                    break;
                case Error::NTLM_MISSING_CRYPTO:
                    {
                        ClientEvent::Base::Ptr ev = new ClientEvent::NtlmMissingCryptoError(client->fatal_reason());
                        client_options->events().add_event(std::move(ev));
                        client_options->stats().error(Error::NTLM_MISSING_CRYPTO);
                        stop();
                    }
                    break;
                default:
                    throw client_connect_unhandled_exception();
                }
            }
        }
    }

    void new_client()
    {
        // Make sure generation is > 0 in case of overflow
        if (++generation == 0)
            ++generation;

        if (client_options->asio_work_always_on())
            asio_work.reset(new AsioWork(io_context));
        else
            asio_work.reset();

        RemoteList::Advance advance_type = RemoteList::Advance::Addr;
        if (client)
        {
            advance_type = client->advance_type();
            client->stop(false);
            interim_finalize();
        }
        if (generation > 1 && !transport_factory_relay)
        {
            ClientEvent::Base::Ptr ev = new ClientEvent::Reconnecting();
            client_options->events().add_event(std::move(ev));
            client_options->stats().error(Error::N_RECONNECT);
            if (!(client && client->reached_connected_state()))
                client_options->next(advance_type);
            else
                client_options->remote_reset_cache_item();
        }

        // client_config in cliopt.hpp
        Client::Config::Ptr cli_config = client_options->client_config(!transport_factory_relay);
        client.reset(new Client(io_context, *cli_config, this)); // build ClientProto::Session from cliproto.hpp
        client_finalized = false;

        // relay?
        if (transport_factory_relay)
        {
            client->transport_factory_override(std::move(transport_factory_relay));
            transport_factory_relay.reset();
        }

        restart_wait_timer.cancel();
        if (client_options->server_poll_timeout_enabled())
        {
            server_poll_timer.expires_after(client_options->server_poll_timeout());
            server_poll_timer.async_wait([self = Ptr(this), gen = generation](const openvpn_io::error_code &error)
                                         {
                                         OPENVPN_ASYNC_HANDLER;
                                         self->server_poll_callback(gen, error); });
        }
        conn_timer_start(conn_timeout);
        client->start();
    }

    // ClientLifeCycle::NotifyCallback callbacks

    virtual void cln_stop() override
    {
        thread_safe_stop();
    }

    virtual void cln_pause(const std::string &reason) override
    {
        thread_safe_pause(reason);
    }

    virtual void cln_resume() override
    {
        thread_safe_resume();
    }

    virtual void cln_reconnect(int seconds) override
    {
        thread_safe_reconnect(seconds);
    }

    unsigned int generation;
    bool halt;
    bool paused;
    bool client_finalized;
    bool dont_restart_;
    bool lifecycle_started;
    int conn_timeout;
    openvpn_io::io_context &io_context;
    ClientOptions::Ptr client_options;
    Client::Ptr client;
    TransportClientFactory::Ptr transport_factory_relay;
    AsioTimer server_poll_timer;
    AsioTimer restart_wait_timer;
    AsioTimer conn_timer;
    bool conn_timer_pending;
    std::unique_ptr<AsioWork> asio_work;
    RemoteList::BulkResolve::Ptr bulk_resolve;

    static constexpr unsigned int default_delay_ = 2000; // ms
};

} // namespace openvpn

#endif