#include <sipaccount_config.h>

Inheritance diagram for jami::SipAccountConfig:

Collaboration diagram for jami::SipAccountConfig:

Classes
struct	Credentials
	Map of credential for this account. More...

Public Member Functions
void	fromMap (const std::map< std::string, std::string > &) override

std::vector< std::map< std::string, std::string > >	getCredentials () const

void	serialize (YAML::Emitter &out) const override

void	setCredentials (const std::vector< std::map< std::string, std::string > > &creds)

	SipAccountConfig (const std::string &id={}, const std::filesystem::path &path={})

std::map< std::string, std::string >	toMap () const override

void	unserialize (const YAML::Node &node) override

Public Member Functions inherited from jami::SipAccountBaseConfig
void	serializeDiff (YAML::Emitter &out, const SipAccountBaseConfig &def) const

	SipAccountBaseConfig (const std::string &type, const std::string &id, const std::filesystem::path &path)

Public Member Functions inherited from jami::AccountConfig
	AccountConfig (const std::string &type_, const std::string &id_, const std::filesystem::path &path_={})

void	serializeDiff (YAML::Emitter &out, const AccountConfig &def) const

Public Member Functions inherited from jami::Serializable
virtual	~Serializable ()

Public Attributes
bool	allowIPAutoRewrite {true}

std::string	bindAddress {}
	Potential ip addresss on which this account is bound.

std::vector< Credentials >	credentials

std::string	interface {dhtnet::ip_utils::DEFAULT_INTERFACE}
	interface name on which this account is bound

uint16_t	localPort {sip_utils::DEFAULT_SIP_PORT}
	Local port to whih this account is bound.

bool	presenceEnabled {false}

uint16_t	publishedPort {sip_utils::DEFAULT_SIP_PORT}
	Published port, used only if defined by the user.

bool	publishSupported {false}

unsigned	registrationExpire {3600}
	Network settings.

bool	registrationRefreshEnabled {true}

std::string	serviceRoute
	Input Outbound Proxy Server Address.

bool	srtpFallback {false}
	Determine if the softphone should fallback on non secured media channel if SRTP negotiation fails.

KeyExchangeProtocol	srtpKeyExchange {KeyExchangeProtocol::SDES}
	Specifies the type of key exchange used for SRTP, if any.

bool	stunEnabled {false}
	Determine if STUN public address resolution is required to register this account.

std::string	stunServer {}
	The STUN server hostname (optional), used to provide the public IP address in case the softphone stay behind a NAT.

bool	subscribeSupported {false}

std::string	tlsCiphers

bool	tlsDisableSecureDlgCheck {true}

bool	tlsEnable {false}

uint16_t	tlsListenerPort {sip_utils::DEFAULT_SIP_TLS_PORT}
	The TLS listener port.

std::string	tlsMethod

int	tlsNegotiationTimeout {2}

bool	tlsRequireClientCertificate {true}

std::string	tlsServerName

bool	tlsVerifyClient {true}

bool	tlsVerifyServer {true}

Public Attributes inherited from jami::SipAccountBaseConfig
std::pair< uint16_t, uint16_t >	audioPortRange {16384, 32766}

std::string	dtmfType {OVERRTP_STR}

std::string	interface {"default"}
	interface name on which this account is bound

std::string	publishedIp

bool	publishedSameasLocal {true}
	Flag which determine if localIpAddress_ or publishedIpAddress_ is used in sip headers.

std::string	tlsCaListFile

std::string	tlsCertificateFile

std::string	tlsPassword

std::string	tlsPrivateKeyFile

bool	turnEnabled {false}
	Determine if TURN public address resolution is required to register this account.

std::string	turnServer
	The TURN server hostname (optional), used to provide the public IP address in case the softphone stay behind a NAT.

std::string	turnServerPwd

std::string	turnServerRealm

std::string	turnServerUserName

std::pair< uint16_t, uint16_t >	videoPortRange {49152, (65536) -2}
	Port range for video RTP ports.

Public Attributes inherited from jami::AccountConfig
int	activeCallLimit {-1}
	The number of concurrent calls for the account -1: Unlimited 0: Do not disturb 1: Single call +: Multi line.

std::vector< unsigned >	activeCodecs {}

std::string	alias {}
	A user-defined name for this account.

bool	allModeratorsEnabled {true}

bool	autoAnswerEnabled {false}
	If true, automatically answer calls to this account.

std::string	customUserAgent {}
	User-agent used for registration.

std::set< std::string >	defaultModerators {}

bool	denySecondCallEnabled {false}
	If true, automatically deny new calls when already in one call to this account.

std::string	deviceKey {}
	Device push notification token.

std::string	displayName {}
	Display name when calling.

bool	enabled {true}
	True if the account is enabled.

std::string	hostname {}
	SIP hostname (SIP account) or DHT bootstrap nodes (Jami account)

const std::string	id
	Account id.

bool	isRendezVous {false}
	If true mix calls into a conference.

bool	localModeratorsEnabled {true}

std::string	mailbox {}
	Account mail box.

std::string	notificationTopic {}
	Push notification topic.

const std::filesystem::path	path
	Path where the configuration file is stored.

std::string	platform {}
	Device push notification platform.

bool	ringtoneEnabled {true}
	Play ringtone when receiving a call.

std::string	ringtonePath {DEFAULT_RINGTONE_PATH}
	Ringtone file used for this account.

bool	sendComposing {true}
	If true, send composing status (and emit to the client)

bool	sendReadReceipt {true}
	If true, send displayed status (and emit to the client)

const std::string	type
	Account type.

std::string	uiCustomization {}
	information about the customization of ui

bool	upnpEnabled {true}
	UPnP IGD controller and the mutex to access it.

std::string	username {}

bool	videoEnabled {true}
	Allows user to temporarily disable video calling.

Detailed Description

Definition at line 23 of file sipaccount_config.h.

Constructor & Destructor Documentation

◆ SipAccountConfig()

jami::SipAccountConfig::SipAccountConfig	(	const std::string &	id = `{}`,
		const std::filesystem::path &	path = `{}`
	)

inline

Definition at line 24 of file sipaccount_config.h.

Member Function Documentation

◆ fromMap()

void jami::SipAccountConfig::fromMap ( const std::map< std::string, std::string > & details )

overridevirtual

Reimplemented from jami::SipAccountBaseConfig.

Definition at line 242 of file sipaccount_config.cpp.

Here is the call graph for this function:

◆ getCredentials()

std::vector< std::map< std::string, std::string > > jami::SipAccountConfig::getCredentials ( ) const

Definition at line 340 of file sipaccount_config.cpp.

References credentials, and jami::emitSignal().

Referenced by jami::SIPAccount::getCredentials(), and serialize().

Here is the call graph for this function:

◆ serialize()

void jami::SipAccountConfig::serialize ( YAML::Emitter & out ) const

overridevirtual

Implements jami::AccountConfig.

Definition at line 79 of file sipaccount_config.cpp.

References jami::Conf::ALLOW_IP_AUTO_REWRITE, allowIPAutoRewrite, jami::Conf::BIND_ADDRESS_KEY, bindAddress, jami::Conf::CALIST_KEY, jami::Conf::CERTIFICATE_KEY, jami::Conf::CIPHERS_KEY, jami::Conf::CONFIG_ACCOUNT_REGISTRATION_EXPIRE, jami::Conf::CRED_KEY, jami::DEFAULT_CONFIG, jami::Conf::DISABLE_SECURE_DLG_CHECK, jami::emitSignal(), getCredentials(), jami::sip_utils::getKeyExchangeName(), jami::AccountConfig::id, jami::Conf::ID_KEY, jami::Conf::KEEP_ALIVE_ENABLED, jami::Conf::KEY_EXCHANGE_KEY, localPort, jami::Conf::METHOD_KEY, jami::Conf::PORT_KEY, jami::Conf::PRIVATE_KEY_KEY, jami::Conf::PUBLISH_PORT_KEY, publishedPort, registrationExpire, registrationRefreshEnabled, jami::Conf::REQUIRE_CERTIF_KEY, jami::Conf::RTP_FALLBACK_KEY, jami::SipAccountBaseConfig::serializeDiff(), jami::Conf::SERVER_KEY, jami::Conf::SERVICE_ROUTE_KEY, serviceRoute, jami::Conf::SRTP_KEY, srtpFallback, srtpKeyExchange, jami::Conf::STUN_ENABLED_KEY, jami::Conf::STUN_SERVER_KEY, stunEnabled, stunServer, jami::Conf::TIMEOUT_KEY, jami::Conf::TLS_ENABLE_KEY, jami::Conf::TLS_KEY, jami::Conf::TLS_PASSWORD_KEY, jami::Conf::TLS_PORT_KEY, jami::SipAccountBaseConfig::tlsCaListFile, jami::SipAccountBaseConfig::tlsCertificateFile, tlsCiphers, tlsDisableSecureDlgCheck, tlsEnable, tlsListenerPort, tlsMethod, tlsNegotiationTimeout, jami::SipAccountBaseConfig::tlsPassword, jami::SipAccountBaseConfig::tlsPrivateKeyFile, tlsRequireClientCertificate, tlsServerName, tlsVerifyClient, tlsVerifyServer, jami::AccountConfig::username, jami::Conf::USERNAME_KEY, jami::Conf::VERIFY_CLIENT_KEY, and jami::Conf::VERIFY_SERVER_KEY.

Here is the call graph for this function:

◆ setCredentials()

void jami::SipAccountConfig::setCredentials ( const std::vector< std::map< std::string, std::string > > & creds )

Definition at line 351 of file sipaccount_config.cpp.

References credentials, and jami::emitSignal().

Referenced by fromMap(), libjami::setCredentials(), and unserialize().

Here is the call graph for this function:

◆ toMap()

std::map< std::string, std::string > jami::SipAccountConfig::toMap ( ) const

overridevirtual

Reimplemented from jami::SipAccountBaseConfig.

Definition at line 190 of file sipaccount_config.cpp.

Referenced by libjami::getAccountTemplate().

Here is the call graph for this function:

◆ unserialize()

void jami::SipAccountConfig::unserialize ( const YAML::Node & node )

overridevirtual

Reimplemented from jami::SipAccountBaseConfig.

Definition at line 135 of file sipaccount_config.cpp.

References jami::Conf::ALLOW_IP_AUTO_REWRITE, allowIPAutoRewrite, jami::Conf::BIND_ADDRESS_KEY, bindAddress, jami::Conf::CALIST_KEY, jami::Conf::CERTIFICATE_KEY, jami::Conf::CIPHERS_KEY, jami::Conf::CONFIG_ACCOUNT_PASSWORD, jami::Conf::CONFIG_ACCOUNT_REALM, jami::Conf::CONFIG_ACCOUNT_REGISTRATION_EXPIRE, jami::Conf::CONFIG_ACCOUNT_USERNAME, jami::Conf::CRED_KEY, jami::Conf::DISABLE_SECURE_DLG_CHECK, jami::emitSignal(), jami::sip_utils::getKeyExchangeProtocol(), jami::Conf::KEEP_ALIVE_ENABLED, jami::Conf::KEY_EXCHANGE_KEY, localPort, jami::Conf::METHOD_KEY, jami::MIN_REGISTRATION_TIME, jami::Conf::PORT_KEY, jami::Conf::PRESENCE_MODULE_ENABLED_KEY, jami::Conf::PRESENCE_PUBLISH_SUPPORTED_KEY, jami::Conf::PRESENCE_SUBSCRIBE_SUPPORTED_KEY, presenceEnabled, jami::Conf::PRIVATE_KEY_KEY, jami::Conf::PUBLISH_PORT_KEY, publishedPort, publishSupported, registrationExpire, registrationRefreshEnabled, jami::Conf::REQUIRE_CERTIF_KEY, jami::Conf::RTP_FALLBACK_KEY, jami::Conf::SERVER_KEY, jami::Conf::SERVICE_ROUTE_KEY, serviceRoute, setCredentials(), jami::Conf::SRTP_KEY, srtpFallback, srtpKeyExchange, jami::Conf::STUN_ENABLED_KEY, jami::Conf::STUN_SERVER_KEY, stunEnabled, stunServer, subscribeSupported, jami::Conf::TIMEOUT_KEY, jami::Conf::TLS_ENABLE_KEY, jami::Conf::TLS_KEY, jami::Conf::TLS_PASSWORD_KEY, jami::Conf::TLS_PORT_KEY, jami::SipAccountBaseConfig::tlsCaListFile, jami::SipAccountBaseConfig::tlsCertificateFile, tlsCiphers, tlsDisableSecureDlgCheck, tlsEnable, tlsListenerPort, tlsMethod, tlsNegotiationTimeout, jami::SipAccountBaseConfig::tlsPassword, jami::SipAccountBaseConfig::tlsPrivateKeyFile, tlsRequireClientCertificate, tlsServerName, tlsVerifyClient, tlsVerifyServer, jami::SipAccountBaseConfig::unserialize(), jami::AccountConfig::username, jami::Conf::USERNAME_KEY, jami::Conf::VERIFY_CLIENT_KEY, and jami::Conf::VERIFY_SERVER_KEY.

Here is the call graph for this function:

Member Data Documentation

◆ allowIPAutoRewrite

bool jami::SipAccountConfig::allowIPAutoRewrite {true}

Definition at line 70 of file sipaccount_config.h.

Referenced by fromMap(), serialize(), toMap(), and unserialize().

◆ bindAddress

std::string jami::SipAccountConfig::bindAddress {}

Potential ip addresss on which this account is bound.

Definition at line 38 of file sipaccount_config.h.

Referenced by fromMap(), serialize(), toMap(), and unserialize().

◆ credentials

std::vector<Credentials> jami::SipAccountConfig::credentials

Definition at line 125 of file sipaccount_config.h.

Referenced by fromMap(), jami::SIPAccount::getCredentialCount(), getCredentials(), jami::SIPAccount::hasCredentials(), setCredentials(), and toMap().

◆ interface

std::string jami::SipAccountConfig::interface {dhtnet::ip_utils::DEFAULT_INTERFACE}

interface name on which this account is bound

Definition at line 48 of file sipaccount_config.h.

Referenced by fromMap(), and toMap().

◆ localPort

uint16_t jami::SipAccountConfig::localPort {sip_utils::DEFAULT_SIP_PORT}

Local port to whih this account is bound.

Definition at line 33 of file sipaccount_config.h.

Referenced by fromMap(), jami::SIPAccount::getLocalPort(), jami::SIPAccount::getRPort(), serialize(), jami::SIPAccount::setLocalPort(), toMap(), and unserialize().

◆ presenceEnabled

bool jami::SipAccountConfig::presenceEnabled {false}

Definition at line 103 of file sipaccount_config.h.

Referenced by fromMap(), toMap(), and unserialize().

◆ publishedPort

uint16_t jami::SipAccountConfig::publishedPort {sip_utils::DEFAULT_SIP_PORT}

Published port, used only if defined by the user.

Definition at line 43 of file sipaccount_config.h.

Referenced by fromMap(), serialize(), toMap(), and unserialize().

◆ publishSupported

bool jami::SipAccountConfig::publishSupported {false}

Definition at line 104 of file sipaccount_config.h.

Referenced by unserialize().

◆ registrationExpire

unsigned jami::SipAccountConfig::registrationExpire {3600}

Network settings.

Definition at line 65 of file sipaccount_config.h.

Referenced by fromMap(), jami::SIPAccount::getRegistrationExpire(), serialize(), toMap(), and unserialize().

◆ registrationRefreshEnabled

bool jami::SipAccountConfig::registrationRefreshEnabled {true}

Definition at line 66 of file sipaccount_config.h.

Referenced by fromMap(), jami::SIPAccount::isRegistrationRefreshEnabled(), serialize(), toMap(), and unserialize().

◆ serviceRoute

std::string jami::SipAccountConfig::serviceRoute

Input Outbound Proxy Server Address.

Definition at line 75 of file sipaccount_config.h.

Referenced by fromMap(), jami::SIPAccount::getServiceRoute(), jami::SIPAccount::hasServiceRoute(), serialize(), toMap(), and unserialize().

◆ srtpFallback

bool jami::SipAccountConfig::srtpFallback {false}

Determine if the softphone should fallback on non secured media channel if SRTP negotiation fails.

Make sure other SIP endpoints share the same behavior since it could result in encrypted data to be played through the audio device.

Definition at line 96 of file sipaccount_config.h.

Referenced by fromMap(), jami::SIPAccount::getSrtpFallback(), serialize(), toMap(), and unserialize().

◆ srtpKeyExchange

KeyExchangeProtocol jami::SipAccountConfig::srtpKeyExchange {KeyExchangeProtocol::SDES}

Specifies the type of key exchange used for SRTP, if any.

This only determine if the media channel is secured.

Definition at line 101 of file sipaccount_config.h.

Referenced by fromMap(), jami::SIPAccount::isSrtpEnabled(), serialize(), toMap(), and unserialize().

◆ stunEnabled

bool jami::SipAccountConfig::stunEnabled {false}

Determine if STUN public address resolution is required to register this account.

In this case a STUN server hostname must be specified.

Definition at line 54 of file sipaccount_config.h.

Referenced by fromMap(), jami::SIPAccount::isStunEnabled(), serialize(), toMap(), and unserialize().

◆ stunServer

std::string jami::SipAccountConfig::stunServer {}

The STUN server hostname (optional), used to provide the public IP address in case the softphone stay behind a NAT.

Definition at line 60 of file sipaccount_config.h.

Referenced by fromMap(), jami::SIPAccount::getStunServer(), serialize(), toMap(), and unserialize().

◆ subscribeSupported

bool jami::SipAccountConfig::subscribeSupported {false}

Definition at line 105 of file sipaccount_config.h.

Referenced by unserialize().

◆ tlsCiphers

std::string jami::SipAccountConfig::tlsCiphers

Definition at line 83 of file sipaccount_config.h.

Referenced by fromMap(), serialize(), toMap(), and unserialize().

◆ tlsDisableSecureDlgCheck

bool jami::SipAccountConfig::tlsDisableSecureDlgCheck {true}

Definition at line 88 of file sipaccount_config.h.

Referenced by fromMap(), serialize(), toMap(), and unserialize().

◆ tlsEnable

bool jami::SipAccountConfig::tlsEnable {false}

Definition at line 81 of file sipaccount_config.h.

Referenced by fromMap(), jami::SIPAccount::isTlsEnabled(), serialize(), toMap(), and unserialize().

◆ tlsListenerPort

uint16_t jami::SipAccountConfig::tlsListenerPort {sip_utils::DEFAULT_SIP_TLS_PORT}

The TLS listener port.

Definition at line 80 of file sipaccount_config.h.

Referenced by fromMap(), jami::SIPAccount::getTlsListenerPort(), serialize(), toMap(), and unserialize().

◆ tlsMethod

std::string jami::SipAccountConfig::tlsMethod

Definition at line 82 of file sipaccount_config.h.

Referenced by fromMap(), serialize(), toMap(), and unserialize().

◆ tlsNegotiationTimeout

int jami::SipAccountConfig::tlsNegotiationTimeout {2}

Definition at line 89 of file sipaccount_config.h.

Referenced by fromMap(), serialize(), toMap(), and unserialize().

◆ tlsRequireClientCertificate

bool jami::SipAccountConfig::tlsRequireClientCertificate {true}

Definition at line 87 of file sipaccount_config.h.

Referenced by fromMap(), serialize(), toMap(), and unserialize().

◆ tlsServerName

std::string jami::SipAccountConfig::tlsServerName

Definition at line 84 of file sipaccount_config.h.

Referenced by fromMap(), serialize(), toMap(), and unserialize().

◆ tlsVerifyClient

bool jami::SipAccountConfig::tlsVerifyClient {true}

Definition at line 86 of file sipaccount_config.h.

Referenced by fromMap(), serialize(), toMap(), and unserialize().

◆ tlsVerifyServer

bool jami::SipAccountConfig::tlsVerifyServer {true}

Definition at line 85 of file sipaccount_config.h.

Referenced by fromMap(), serialize(), toMap(), and unserialize().

The documentation for this struct was generated from the following files:

Classes

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SipAccountConfig()

Member Function Documentation

◆ fromMap()

◆ getCredentials()

◆ serialize()

◆ setCredentials()

◆ toMap()

◆ unserialize()

Member Data Documentation

◆ allowIPAutoRewrite

◆ bindAddress

◆ credentials

◆ interface

◆ localPort

◆ presenceEnabled

◆ publishedPort

◆ publishSupported

◆ registrationExpire

◆ registrationRefreshEnabled

◆ serviceRoute

◆ srtpFallback

◆ srtpKeyExchange

◆ stunEnabled

◆ stunServer

◆ subscribeSupported

◆ tlsCiphers

◆ tlsDisableSecureDlgCheck

◆ tlsEnable

◆ tlsListenerPort

◆ tlsMethod

◆ tlsNegotiationTimeout

◆ tlsRequireClientCertificate

◆ tlsServerName

◆ tlsVerifyClient

◆ tlsVerifyServer