psid_cookie.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) 2022- OpenVPN Inc.
//
//    SPDX-License-Identifier: MPL-2.0 OR AGPL-3.0-only WITH openvpn3-openssl-exception
//
 
 
#pragma once
 
 
#include <openvpn/buffer/buffer.hpp> // includes rc.hpp
#include <openvpn/ssl/psid.hpp>
 
namespace openvpn {
 
class PsidCookieAddrInfoBase
{
  public:
    virtual const unsigned char *get_abstract_cli_addrport(size_t &slab_size) const = 0;
 
    virtual const void *get_impl_info() const = 0;
 
    virtual ~PsidCookieAddrInfoBase() = default;
};
 
class PsidCookieTransportBase : public RC<thread_unsafe_refcount>
{
  public:
    typedef RCPtr<PsidCookieTransportBase> Ptr;
 
    virtual bool psid_cookie_send_const(Buffer &send_buf, const PsidCookieAddrInfoBase &pcaib) = 0;
 
    virtual ~PsidCookieTransportBase() = default;
};
 
class PsidCookie : public RC<thread_unsafe_refcount>
{
  public:
    typedef RCPtr<PsidCookie> Ptr;
 
    enum class Intercept
    {
        DECLINE_HANDLING,
        EARLY_DROP,
        DROP_1ST,
        HANDLE_1ST,
        DROP_2ND,
        HANDLE_2ND,
    };
 
    virtual Intercept intercept(ConstBuffer &pkt_buf, const PsidCookieAddrInfoBase &pcaib) = 0;
 
    virtual ProtoSessionID get_cookie_psid() = 0;
 
    // The PsidCookie server implementation owns the transport detail for sending the psid cookie packet that the class implementing this interface creates.    The intercept() method will call the derived class' psid_cookie_send_const() function above.
 
    virtual void provide_psid_cookie_transport(PsidCookieTransportBase::Ptr pctb) = 0;
 
    virtual ~PsidCookie() = default;
};
 
} // namespace openvpn