TlsSocket2.hpp

 
//
//  Copyright PHOENIX CONTACT Electronics GmbH
//
#pragma once
#include "Arp/System/Core/Arp.h"
#include "Arp/System/Core/PimplPtr.hxx"
#include "Arp/System/Commons/Net/Socket.hpp"
#include "Arp/System/Commons/Net/TlsOptions.hpp"
#include "Arp/System/Commons/Security/Certificate.hpp"
#include "Arp/System/Commons/Net/TlsVerificationError.hpp"
#include "Arp/System/Commons/Net/TlsAlertType.hpp"
#include "Arp/System/Commons/Net/TlsAlertLevel.hpp"
 
 
namespace Arp { namespace System { namespace Commons { namespace Net
{
 
 
 
 
class TlsContext;
using TlsContextPtr = std::shared_ptr<TlsContext>;
 
class ARP_CXX_SYMBOL_EXPORT TlsSocket2: private Loggable<TlsSocket2>
{
public: // Impl forward declaration
    class Impl;
 
public: // usings
    using Ptr = std::shared_ptr<TlsSocket2>;
    using Certificate = Arp::System::Commons::Security::Certificate;
 
    using VerifyHandler = delegate<void(bool&, TlsVerificationError&, int, const Certificate*)>;
    using AlertHandler = delegate<void(TlsAlertType, TlsAlertLevel)>;
 
 
public: // construction/destruction/assignment
    explicit TlsSocket2(SocketType type, SocketDomain domain, SocketBlockingMode blockingMode);
    TlsSocket2(SocketType type, SocketDomain domain, SocketBlockingMode blockingMode, TlsOptions options);
    TlsSocket2(const TlsSocket2& arg) = delete;
    TlsSocket2(TlsSocket2&& arg)noexcept;
    TlsSocket2(Socket::Ptr pSocket, TlsContextPtr pContext, bool isInitialized);
    TlsSocket2& operator=(const TlsSocket2& arg) = delete;
    TlsSocket2& operator=(TlsSocket2&& arg)noexcept;
    ~TlsSocket2(void);
 
private: // Impl usings
    using Pimpl = PimplPtr<Impl>;
 
private:
 
 
public: // operators
 
public: // static operations
 
public: // setter/getter operations
    SocketType      GetSocketType(void);
 
    SocketDomain    GetSocketDomain(void);
 
    bool            IsBlocking(void);
 
    bool            IsConnected(void);
 
    bool            IsTlsConnected(void);
 
    IpAddress       GetRemoteIpAddress(void);
 
    int             GetRemotePort(void);
 
public: // operations
    Ptr             Accept(IpAddress& ip4address, int& port, SocketError& error);
 
    SocketError     Bind(const IpAddress& ip4Address, int port);
 
    SocketError     Bind2(const IpAddress& ip4Address, int& port);
 
    SocketError     Listen(size_t backlog);
 
    SocketError     Connect(const IpAddress& ip4Address, int port);
 
    SocketError     Shutdown(void);
 
    SocketError     Shutdown(ShutdownMode mode);
 
    SocketError     Close(void);
 
    int             Send(const void* pBuffer, size_t length, SocketError& error);
 
    int             Receive(void* pBuffer, size_t length, SocketError& error);
 
    bool            Select(SelectMode mode, Microseconds timeout, SocketError& error);
 
    int             Poll(PollMode mode, Milliseconds timeout, SocketError& error);
 
    SocketError     SetSocketOption(SocketOptionName optionName, const void* optionValue, size_t optionLength);
 
    SocketError     GetSocketOption(SocketOptionName optionName, void* optionValue, size_t* optionLength);
 
    SocketError     SetOptionReuseAddress(bool enabled);
 
    SocketError     GetOptionReuseAddress(bool& enabled);
 
    SocketError     SetOptionKeepAlive(bool enabled);
 
    SocketError     GetOptionKeepAlive(bool& enabled);
 
    SocketError     SetOptionBroadcast(bool enabled);
 
    SocketError     GetOptionBroadcast(bool& enabled);
 
    SocketError     SetOptionNoDelay(bool enabled);
 
    SocketError     GetOptionNoDelay(bool& enabled);
 
    SocketError     SetOptionLinger(bool enable, size_t timeout);
 
    SocketError     GetOptionLinger(bool& enable, size_t& timeout);
 
    SocketError     SetOptionUserTimeout(size_t timeout_ms);
 
    SocketError     GetOptionUserTimeout(size_t& timeout_ms);
 
    SocketError     SetOptionKeepAliveIdleTime(int seconds);
 
    SocketError     GetOptionKeepAliveIdleTime(int& seconds);
 
    SocketError     SetOptionKeepAliveProbeInterval(int seconds);
 
    SocketError     GetOptionKeepAliveProbeInterval(int& seconds);
 
    SocketError     SetOptionKeepAliveProbeCount(int probeCount);
 
    SocketError     GetOptionKeepAliveProbeCount(int& probeCount);
 
    SocketError     SetOptionBlocking(bool enable);
 
    SocketError InitClient(const String& trustStoreName, const String& identityStoreName, const String& hostName);
 
    SocketError InitServer(const String& identityStoreName, const String& trustStoreName = "");
 
    void SetCipherList(const String& cipherList);
 
    SocketError RenegotiateSession();
 
 
    SocketError UpdateSessionKeys(bool requestUpdate = true);
 
    SocketError GetPeerCertificate(Certificate& certificate);
 
 
    SteadyTimePoint GetLastRenegotionTime(void);
 
 
    SteadyTimePoint GetLastKeyUpdateTime(void);
 
 
    void AddVerifyHandler(const VerifyHandler& handler);
 
    void RemoveVerifyHandler(const VerifyHandler& handler);
 
 
    void AddAlertReceivedHandler(const AlertHandler& handler);
 
    void RemoveAlertReceivedHandler(const AlertHandler& handler);
 
    void AddAlertSendHandler(const AlertHandler& handler);
 
    void RemoveAlertSendHandler(const AlertHandler& handler);
 
    static String GetTlsVerificationErrorString(const TlsVerificationError& error);
 
public: // internal operations
    Impl&       GetImpl(void);
    const Impl& GetImpl(void)const;
 
 
 
private: // Impl fields
    Pimpl   pimpl;
};
 
}}}} // end of namespace Arp::System::Commons::Net