siptransport.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2004-2025 Savoir-faire Linux Inc.
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
#pragma once
 
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
 
#include "connectivity/sip_utils.h"
 
#include "noncopyable.h"
#include "logger.h"
 
#include <pjsip.h>
#include <pjnath/stun_config.h>
 
#include <functional>
#include <mutex>
#include <condition_variable>
#include <map>
#include <string>
#include <vector>
#include <list>
#include <memory>
 
// OpenDHT
namespace dht {
namespace crypto {
struct Certificate;
}
} // namespace dht
 
namespace dhtnet {
class ChannelSocket;
} // namespace dhtnet
 
namespace jami {
class SIPAccountBase;
using onShutdownCb = std::function<void(void)>;
 
struct TlsListener
{
    TlsListener() {}
    TlsListener(pjsip_tpfactory* f)
        : listener(f)
    {}
    virtual ~TlsListener()
    {
        JAMI_DBG("Destroying listener");
        listener->destroy(listener);
    }
    pjsip_tpfactory* get() { return listener; }
 
private:
    NON_COPYABLE(TlsListener);
    pjsip_tpfactory* listener {nullptr};
};
 
struct TlsInfos
{
    pj_ssl_cipher cipher {PJ_TLS_UNKNOWN_CIPHER};
    pj_ssl_sock_proto proto {PJ_SSL_SOCK_PROTO_DEFAULT};
    pj_ssl_cert_verify_flag_t verifyStatus {};
    std::shared_ptr<dht::crypto::Certificate> peerCert {};
};
 
using SipTransportStateCallback
    = std::function<void(pjsip_transport_state, const pjsip_transport_state_info*)>;
 
class SipTransport
{
public:
    SipTransport(pjsip_transport*);
    SipTransport(pjsip_transport*, const std::shared_ptr<TlsListener>&);
    // If the SipTransport is a channeled transport, we are already connected to the peer,
    // so, we can directly set tlsInfos_.peerCert and avoid any copy
    SipTransport(pjsip_transport* t,
                 const std::shared_ptr<dht::crypto::Certificate>& peerCertficate);
 
    ~SipTransport();
 
    static const char* stateToStr(pjsip_transport_state state);
 
    void stateCallback(pjsip_transport_state state, const pjsip_transport_state_info* info);
 
    pjsip_transport* get() { return transport_.get(); }
 
    void addStateListener(uintptr_t lid, SipTransportStateCallback cb);
    bool removeStateListener(uintptr_t lid);
 
    bool isSecure() const { return PJSIP_TRANSPORT_IS_SECURE(transport_); }
 
    const TlsInfos& getTlsInfos() const { return tlsInfos_; }
 
    static bool isAlive(pjsip_transport_state state);
 
    bool isConnected() const noexcept { return connected_; }
 
    inline void setDeviceId(const std::string& deviceId) { deviceId_ = deviceId; }
    inline std::string_view deviceId() const { return deviceId_; }
    inline void setAccount(const std::shared_ptr<SIPAccountBase>& account) { account_ = account; }
    inline const std::weak_ptr<SIPAccountBase>& getAccount() const { return account_; }
 
    uint16_t getTlsMtu();
 
private:
    NON_COPYABLE(SipTransport);
 
    static void deleteTransport(pjsip_transport* t);
 
    std::unique_ptr<pjsip_transport, decltype(deleteTransport)&> transport_;
    std::shared_ptr<TlsListener> tlsListener_;
    std::mutex stateListenersMutex_;
    std::map<uintptr_t, SipTransportStateCallback> stateListeners_;
    std::weak_ptr<SIPAccountBase> account_ {};
 
    bool connected_ {false};
    std::string deviceId_ {};
    TlsInfos tlsInfos_;
};
 
class IceTransport;
namespace tls {
struct TlsParams;
};
 
class SipTransportBroker
{
public:
    SipTransportBroker(pjsip_endpoint* endpt);
    ~SipTransportBroker();
 
    std::shared_ptr<SipTransport> getUdpTransport(const dhtnet::IpAddr&);
 
    std::shared_ptr<TlsListener> getTlsListener(const dhtnet::IpAddr&, const pjsip_tls_setting*);
 
    std::shared_ptr<SipTransport> getTlsTransport(const std::shared_ptr<TlsListener>&,
                                                  const dhtnet::IpAddr& remote,
                                                  const std::string& remote_name = {});
 
    std::shared_ptr<SipTransport> addTransport(pjsip_transport*);
 
    std::shared_ptr<SipTransport> getChanneledTransport(
        const std::shared_ptr<SIPAccountBase>& account,
        const std::shared_ptr<dhtnet::ChannelSocket>& socket,
        onShutdownCb&& cb);
 
    void shutdown();
 
    void transportStateChanged(pjsip_transport*,
                               pjsip_transport_state,
                               const pjsip_transport_state_info*);
 
private:
    NON_COPYABLE(SipTransportBroker);
 
    std::shared_ptr<SipTransport> createUdpTransport(const dhtnet::IpAddr&);
 
    std::map<pjsip_transport*, std::weak_ptr<SipTransport>> transports_ {};
    std::mutex transportMapMutex_ {};
 
    std::map<dhtnet::IpAddr, pjsip_transport*> udpTransports_;
 
    pjsip_endpoint* endpt_;
    std::atomic_bool isDestroying_ {false};
};
 
} // namespace jami