tunwrap.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
//
 
#ifndef OPENVPN_TUN_PERSIST_TUNWRAP_H
#define OPENVPN_TUN_PERSIST_TUNWRAP_H
 
#include <openvpn/common/size.hpp>
#include <openvpn/common/destruct.hpp>
 
namespace openvpn {
 
// defines how the new tun/fd handle replaces old one and close() behaviour
enum class TunWrapObjRetain
{
    // close the old handle, then replace it with a new handle and
    // perform cleanup on close
    NO_RETAIN,
 
    // replace the old handle with a new one without closing the old one and
    // don't perform cleanup on close - used in iOS
    RETAIN,
 
    // same as NO_RETAIN, but don't replace the old handle if it is already defined.
    // used by dco-win where we need to perform cleanup on close _and_ cannot do replace -
    // old and new handles are the same (we got handle before establishing connection,
    // since dco-win also implements transport) and replacing means closing the old handle -
    // which would mean that we loose peer state in the driver
    NO_RETAIN_NO_REPLACE
};
 
// TunWrapTemplate is used client-side to store the underlying tun
// interface fd/handle.  SCOPED_OBJ is generally a ScopedFD (unix) or a
// ScopedHANDLE (Windows).  It can also be a ScopedAsioStream.
template <typename SCOPED_OBJ>
class TunWrapTemplate : public RC<thread_unsafe_refcount>
{
  public:
    typedef RCPtr<TunWrapTemplate> Ptr;
 
    TunWrapTemplate(const TunWrapObjRetain retain_obj)
        : retain_obj_(retain_obj)
    {
    }
 
    virtual ~TunWrapTemplate()
    {
        close();
    }
 
    bool obj_defined() const
    {
        return obj_.defined();
    }
 
    // Current persisted tun fd/handle
    typename SCOPED_OBJ::base_type obj() const
    {
        return obj_();
    }
 
    bool destructor_defined() const
    {
        return bool(destruct_);
    }
 
    // destruct object performs cleanup prior to TAP device
    // HANDLE close, such as removing added routes.
    void add_destructor(const DestructorBase::Ptr &destruct)
    {
        close_destructor();
        destruct_ = destruct;
    }
 
    void close_destructor()
    {
        try
        {
            if (destruct_)
            {
                std::ostringstream os;
                destruct_->destroy(os);
                OPENVPN_LOG_STRING(os.str());
                destruct_.reset();
            }
        }
        catch (const std::exception &e)
        {
            OPENVPN_LOG("TunWrap destructor exception: " << e.what());
        }
    }
 
    void close()
    {
        if (retain_obj_ == TunWrapObjRetain::RETAIN)
            obj_.release();
        else
        {
            close_destructor();
            obj_.close();
        }
    }
 
    // replace the old handle with a new one, the replacement behavior
    // is determined by retain_obj_ enum.
    void save_replace_sock(const typename SCOPED_OBJ::base_type obj)
    {
        if (retain_obj_ == TunWrapObjRetain::RETAIN)
            obj_.replace(obj);
        else if (!obj_defined() || (retain_obj_ == TunWrapObjRetain::NO_RETAIN))
            obj_.reset(obj);
    }
 
  private:
    const TunWrapObjRetain retain_obj_;
    DestructorBase::Ptr destruct_;
    SCOPED_OBJ obj_;
};
 
} // namespace openvpn
#endif