Liblinphone  5.3.0
Macros | Typedefs | Enumerations | Functions
Tunnel

Macros

#define LINPHONE_TUNNEL(obj)   BELLE_SIP_CAST(obj, LinphoneTunnel)
 Linphone tunnel aims is to bypass IP traffic blocking due to aggressive firewalls which typically only authorize TCP traffic with destination port 443. More...
 

Typedefs

typedef struct _LinphoneTunnel LinphoneTunnel
 Linphone tunnel object.
 
typedef struct _LinphoneTunnelConfig LinphoneTunnelConfig
 Tunnel settings.
 
typedef enum _LinphoneTunnelMode LinphoneTunnelMode
 Enum describing the tunnel modes.
 

Enumerations

enum  _LinphoneTunnelMode {
  LinphoneTunnelModeDisable = 0,
  LinphoneTunnelModeEnable = 1,
  LinphoneTunnelModeAuto = 2
}
 Enum describing the tunnel modes. More...
 

Functions

bool_t linphone_core_tunnel_available (void)
 True if tunnel support was compiled. More...
 
LinphoneTunnellinphone_core_get_tunnel (const LinphoneCore *core)
 get tunnel instance if available More...
 
LinphoneTunnelConfiglinphone_tunnel_config_new (void)
 Create a new tunnel configuration. More...
 
LinphoneTunnellinphone_tunnel_ref (LinphoneTunnel *tunnel)
 Take a reference on a LinphoneTunnel. More...
 
void linphone_tunnel_unref (LinphoneTunnel *tunnel)
 Release a reference on a LinphoneTunnel. More...
 
void linphone_tunnel_config_set_host (LinphoneTunnelConfig *tunnel_config, const char *host)
 Set the IP address or hostname of the tunnel server. More...
 
const char * linphone_tunnel_config_get_host (const LinphoneTunnelConfig *tunnel_config)
 Get the IP address or hostname of the tunnel server. More...
 
void linphone_tunnel_config_set_port (LinphoneTunnelConfig *tunnel_config, int port)
 Set tls port of server. More...
 
int linphone_tunnel_config_get_port (const LinphoneTunnelConfig *tunnel_config)
 Get the TLS port of the tunnel server. More...
 
void linphone_tunnel_config_set_host2 (LinphoneTunnelConfig *tunnel_config, const char *host)
 Set the IP address or hostname of the second tunnel server when using dual tunnel client. More...
 
const char * linphone_tunnel_config_get_host2 (const LinphoneTunnelConfig *tunnel_config)
 Get the IP address or hostname of the second tunnel server when using dual tunnel client. More...
 
void linphone_tunnel_config_set_port2 (LinphoneTunnelConfig *tunnel_config, int port)
 Set tls port of the second server when using dual tunnel client. More...
 
int linphone_tunnel_config_get_port2 (const LinphoneTunnelConfig *tunnel_config)
 Get the TLS port of the second tunnel server when using dual tunnel client. More...
 
void linphone_tunnel_config_set_remote_udp_mirror_port (LinphoneTunnelConfig *tunnel_config, int remote_udp_mirror_port)
 Set the remote port on the tunnel server side used to test UDP reachability. More...
 
int linphone_tunnel_config_get_remote_udp_mirror_port (const LinphoneTunnelConfig *tunnel_config)
 Get the remote port on the tunnel server side used to test UDP reachability. More...
 
void linphone_tunnel_config_set_delay (LinphoneTunnelConfig *tunnel_config, int delay)
 Set the UDP packet round trip delay in ms for a tunnel configuration. More...
 
int linphone_tunnel_config_get_delay (const LinphoneTunnelConfig *tunnel_config)
 Get the UDP packet round trip delay in ms for a tunnel configuration. More...
 
LinphoneTunnelConfiglinphone_tunnel_config_ref (LinphoneTunnelConfig *tunnel_config)
 Increment the refcount of LinphoneTunnelConfig object. More...
 
void linphone_tunnel_config_unref (LinphoneTunnelConfig *tunnel_config)
 Decrement the refcount of LinphoneTunnelConfig object. More...
 
void linphone_tunnel_config_set_user_data (LinphoneTunnelConfig *tunnel_config, void *user_data)
 Store a user data in the tunnel config object. More...
 
void * linphone_tunnel_config_get_user_data (LinphoneTunnelConfig *tunnel_config)
 Retrieve user data from the tunnel config. More...
 
void linphone_tunnel_add_server (LinphoneTunnel *tunnel, LinphoneTunnelConfig *tunnel_config)
 Add a tunnel server configuration. More...
 
void linphone_tunnel_remove_server (LinphoneTunnel *tunnel, LinphoneTunnelConfig *tunnel_config)
 Remove a tunnel server configuration. More...
 
const bctbx_list_t * linphone_tunnel_get_servers (const LinphoneTunnel *tunnel)
 Get added servers. More...
 
void linphone_tunnel_clean_servers (LinphoneTunnel *tunnel)
 Remove all tunnel server addresses previously entered with linphone_tunnel_add_server() More...
 
void linphone_tunnel_set_mode (LinphoneTunnel *tunnel, LinphoneTunnelMode mode)
 Set the tunnel mode. More...
 
LinphoneTunnelMode linphone_tunnel_get_mode (const LinphoneTunnel *tunnel)
 Get the tunnel mode. More...
 
void linphone_tunnel_enable_dual_mode (LinphoneTunnel *tunnel, bool_t dual_mode_enabled)
 Sets whether or not to use the dual tunnel client mode. More...
 
bool_t linphone_tunnel_dual_mode_enabled (const LinphoneTunnel *tunnel)
 Get the dual tunnel client mode. More...
 
bool_t linphone_tunnel_get_activated (const LinphoneTunnel *tunnel)
 Returns whether the tunnel is activated. More...
 
bool_t linphone_tunnel_connected (const LinphoneTunnel *tunnel)
 Check whether the tunnel is connected. More...
 
void linphone_tunnel_reconnect (LinphoneTunnel *tunnel)
 Force reconnection to the tunnel server. More...
 
void linphone_tunnel_enable_sip (LinphoneTunnel *tunnel, bool_t enable)
 Set whether SIP packets must be directly sent to a UA or pass through the tunnel. More...
 
bool_t linphone_tunnel_sip_enabled (const LinphoneTunnel *tunnel)
 Check whether tunnel is set to transport SIP packets. More...
 
void linphone_tunnel_set_http_proxy (LinphoneTunnel *tunnel, const char *host, int port, const char *username, const char *passwd)
 Set an optional http proxy to go through when connecting to tunnel server. More...
 
void linphone_tunnel_get_http_proxy (LinphoneTunnel *tunnel, const char **host, int *port, const char **username, const char **passwd)
 Retrieve optional http proxy configuration previously set with linphone_tunnel_set_http_proxy(). More...
 
void linphone_tunnel_set_http_proxy_auth_info (LinphoneTunnel *tunnel, const char *username, const char *passwd)
 Set authentication info for the http proxy. More...
 
void linphone_tunnel_set_username (LinphoneTunnel *tunnel, const char *username)
 Set the username. More...
 
const char * linphone_tunnel_get_username (LinphoneTunnel *tunnel)
 Get the username. More...
 
void linphone_tunnel_set_domain (LinphoneTunnel *tunnel, const char *domain)
 Set the domain. More...
 
const char * linphone_tunnel_get_domain (LinphoneTunnel *tunnel)
 Get the domain. More...
 
void linphone_tunnel_simulate_udp_loss (LinphoneTunnel *tunnel, bool_t enabled)
 

Detailed Description

Macro Definition Documentation

◆ LINPHONE_TUNNEL

#define LINPHONE_TUNNEL (   obj)    BELLE_SIP_CAST(obj, LinphoneTunnel)

Linphone tunnel aims is to bypass IP traffic blocking due to aggressive firewalls which typically only authorize TCP traffic with destination port 443.


Its principle is tunneling all SIP and/or RTP traffic through a single secure https connection up to a detunnelizer server.
This set of methods enhance LinphoneCore functionalities in order to provide an easy to use API to

  • provision tunnel servers IP addresses and ports. This functionality is an option not implemented under GPL. Availability can be check at runtime using function linphone_core_tunnel_available()
  • start/stop the tunneling service
  • perform auto-detection whether tunneling is required, based on a test of sending/receiving a flow of UDP packets.

It takes in charge automatically the SIP registration procedure when connecting or disconnecting to a tunnel server. No other action on LinphoneCore is required to enable full operation in tunnel mode.


Provision is done using object LinphoneTunnelConfig created by function linphone_tunnel_config_new(). Functions linphone_tunnel_config_set_host() and linphone_tunnel_config_set_port() allow to point to tunnel server IP/port. Once set, use function linphone_tunnel_add_server() to provision a tunnel server.
Finally tunnel mode configuration is achieved by function linphone_tunnel_set_mode().
Tunnel connection status can be checked using function linphone_tunnel_connected().

Bellow pseudo code that can be use to configure, enable, check state and disable tunnel functionality:

LinphoneTunnel *tunnel = linphone_core_get_tunnel(linphone_core);
LinphoneTunnelConfig *config=linphone_tunnel_config_new(); //instantiate tunnel configuration
linphone_tunnel_config_set_host(config, "tunnel.linphone.org"); //set tunnel server host address
linphone_tunnel_config_set_port(config, 443); //set tunnel server port
linphone_tunnel_add_server(tunnel, config); //provision tunnel config
linphone_tunnel_set_mode(tunnel, LinphoneTunnelModeEnable); //activate the tunnel unconditional
while (!linphone_tunnel_connected(tunnel)) { //wait for tunnel to be ready
linphone_core_iterate(linphone_core); //schedule core main loop
ms_sleep(100); //wait 100ms
}
LinphoneCall *call = linphone_core_invite(linphone_core,"sip:foo@example.org"); //place an outgoing call
linphone_call_ref(call); //acquire a reference on the call to avoid deletion after completion
//...
linphone_core_terminate_call(linphone_core,call);
while (linphone_call_get_state(call) != LinphoneCallReleased) { //wait for call to be in release state
linphone_core_iterate(linphone_core); //schedule core main loop
ms_sleep(100); //wait 100ms
}
linphone_call_unref(call); //release reference on the call

Enumeration Type Documentation

◆ _LinphoneTunnelMode

Enum describing the tunnel modes.

Enumerator
LinphoneTunnelModeDisable 

The tunnel is disabled.

LinphoneTunnelModeEnable 

The tunnel is enabled.

LinphoneTunnelModeAuto 

The tunnel is enabled automatically if it is required.

Function Documentation

◆ linphone_core_get_tunnel()

LinphoneTunnel* linphone_core_get_tunnel ( const LinphoneCore core)

get tunnel instance if available

Parameters
corecore object
Returns
LinphoneTunnel or NULL if not available.

◆ linphone_core_tunnel_available()

bool_t linphone_core_tunnel_available ( void  )

True if tunnel support was compiled.

Returns
TRUE if library was built with tunnel, FALSE otherwise

◆ linphone_tunnel_add_server()

void linphone_tunnel_add_server ( LinphoneTunnel tunnel,
LinphoneTunnelConfig tunnel_config 
)

Add a tunnel server configuration.

Parameters
tunnelLinphoneTunnel object
tunnel_configLinphoneTunnelConfig object

◆ linphone_tunnel_clean_servers()

void linphone_tunnel_clean_servers ( LinphoneTunnel tunnel)

Remove all tunnel server addresses previously entered with linphone_tunnel_add_server()

Parameters
tunnelLinphoneTunnel object

◆ linphone_tunnel_config_get_delay()

int linphone_tunnel_config_get_delay ( const LinphoneTunnelConfig tunnel_config)

Get the UDP packet round trip delay in ms for a tunnel configuration.

Parameters
tunnel_configLinphoneTunnelConfig object
Returns
The UDP packet round trip delay in ms.

◆ linphone_tunnel_config_get_host()

const char* linphone_tunnel_config_get_host ( const LinphoneTunnelConfig tunnel_config)

Get the IP address or hostname of the tunnel server.

Parameters
tunnel_configLinphoneTunnelConfig object
Returns
The tunnel server IP address or hostname.

◆ linphone_tunnel_config_get_host2()

const char* linphone_tunnel_config_get_host2 ( const LinphoneTunnelConfig tunnel_config)

Get the IP address or hostname of the second tunnel server when using dual tunnel client.

Parameters
tunnel_configLinphoneTunnelConfig object
Returns
The tunnel server IP address or hostname.

◆ linphone_tunnel_config_get_port()

int linphone_tunnel_config_get_port ( const LinphoneTunnelConfig tunnel_config)

Get the TLS port of the tunnel server.

Parameters
tunnel_configLinphoneTunnelConfig object
Returns
The TLS port of the tunnel server

◆ linphone_tunnel_config_get_port2()

int linphone_tunnel_config_get_port2 ( const LinphoneTunnelConfig tunnel_config)

Get the TLS port of the second tunnel server when using dual tunnel client.

Parameters
tunnel_configLinphoneTunnelConfig object
Returns
The TLS port of the tunnel server

◆ linphone_tunnel_config_get_remote_udp_mirror_port()

int linphone_tunnel_config_get_remote_udp_mirror_port ( const LinphoneTunnelConfig tunnel_config)

Get the remote port on the tunnel server side used to test UDP reachability.

This is used when the mode is set auto, to detect whether the tunnel has to be enabled or not.

Parameters
tunnel_configLinphoneTunnelConfig object
Returns
The remote port on the tunnel server side used to test UDP reachability

◆ linphone_tunnel_config_get_user_data()

void* linphone_tunnel_config_get_user_data ( LinphoneTunnelConfig tunnel_config)

Retrieve user data from the tunnel config.

Parameters
tunnel_configthe tunnel config
Returns
the user data.

◆ linphone_tunnel_config_new()

LinphoneTunnelConfig* linphone_tunnel_config_new ( void  )

Create a new tunnel configuration.

Returns
a LinphoneTunnelConfig object

◆ linphone_tunnel_config_ref()

LinphoneTunnelConfig* linphone_tunnel_config_ref ( LinphoneTunnelConfig tunnel_config)

Increment the refcount of LinphoneTunnelConfig object.

Parameters
tunnel_configthe LinphoneTunnelConfig object.
Returns
the same LinphoneTunnelConfig object.

◆ linphone_tunnel_config_set_delay()

void linphone_tunnel_config_set_delay ( LinphoneTunnelConfig tunnel_config,
int  delay 
)

Set the UDP packet round trip delay in ms for a tunnel configuration.

Parameters
tunnel_configLinphoneTunnelConfig object
delayThe UDP packet round trip delay in ms considered as acceptable (recommended value is 1000 ms).

◆ linphone_tunnel_config_set_host()

void linphone_tunnel_config_set_host ( LinphoneTunnelConfig tunnel_config,
const char *  host 
)

Set the IP address or hostname of the tunnel server.

Parameters
tunnel_configLinphoneTunnelConfig object
hostThe tunnel server IP address or hostname.

◆ linphone_tunnel_config_set_host2()

void linphone_tunnel_config_set_host2 ( LinphoneTunnelConfig tunnel_config,
const char *  host 
)

Set the IP address or hostname of the second tunnel server when using dual tunnel client.

Parameters
tunnel_configLinphoneTunnelConfig object
hostThe tunnel server IP address or hostname.

◆ linphone_tunnel_config_set_port()

void linphone_tunnel_config_set_port ( LinphoneTunnelConfig tunnel_config,
int  port 
)

Set tls port of server.

Parameters
tunnel_configLinphoneTunnelConfig object
portThe tunnel server TLS port, recommended value is 443

◆ linphone_tunnel_config_set_port2()

void linphone_tunnel_config_set_port2 ( LinphoneTunnelConfig tunnel_config,
int  port 
)

Set tls port of the second server when using dual tunnel client.

Parameters
tunnel_configLinphoneTunnelConfig object
portThe tunnel server TLS port, recommended value is 443

◆ linphone_tunnel_config_set_remote_udp_mirror_port()

void linphone_tunnel_config_set_remote_udp_mirror_port ( LinphoneTunnelConfig tunnel_config,
int  remote_udp_mirror_port 
)

Set the remote port on the tunnel server side used to test UDP reachability.

This is used when the mode is set auto, to detect whether the tunnel has to be enabled or not.

Parameters
tunnel_configLinphoneTunnelConfig object
remote_udp_mirror_portThe remote port on the tunnel server side used to test UDP reachability, set to -1 to disable the feature

◆ linphone_tunnel_config_set_user_data()

void linphone_tunnel_config_set_user_data ( LinphoneTunnelConfig tunnel_config,
void *  user_data 
)

Store a user data in the tunnel config object.

Parameters
tunnel_configthe tunnel config
user_datathe user data.

◆ linphone_tunnel_config_unref()

void linphone_tunnel_config_unref ( LinphoneTunnelConfig tunnel_config)

Decrement the refcount of LinphoneTunnelConfig object.

Parameters
tunnel_configthe LinphoneTunnelConfig object.

◆ linphone_tunnel_connected()

bool_t linphone_tunnel_connected ( const LinphoneTunnel tunnel)

Check whether the tunnel is connected.

Parameters
tunnelLinphoneTunnel object
Returns
A boolean value telling if the tunnel is connected

◆ linphone_tunnel_dual_mode_enabled()

bool_t linphone_tunnel_dual_mode_enabled ( const LinphoneTunnel tunnel)

Get the dual tunnel client mode.

Parameters
tunnelLinphoneTunnel object
Returns
TRUE if dual tunnel client mode is enabled, FALSE otherwise

◆ linphone_tunnel_enable_dual_mode()

void linphone_tunnel_enable_dual_mode ( LinphoneTunnel tunnel,
bool_t  dual_mode_enabled 
)

Sets whether or not to use the dual tunnel client mode.

By default this feature is disabled. After enabling it, add a server with 2 hosts and 2 ports for the feature to work.

Parameters
tunnelLinphoneTunnel object
dual_mode_enabledTRUE to enable it, FALSE to disable it

◆ linphone_tunnel_enable_sip()

void linphone_tunnel_enable_sip ( LinphoneTunnel tunnel,
bool_t  enable 
)

Set whether SIP packets must be directly sent to a UA or pass through the tunnel.

Parameters
tunnelLinphoneTunnel object
enableIf true, SIP packets shall pass through the tunnel

◆ linphone_tunnel_get_activated()

bool_t linphone_tunnel_get_activated ( const LinphoneTunnel tunnel)

Returns whether the tunnel is activated.

If mode is set to auto, this gives indication whether the automatic detection determined that tunnel was necessary or not.

Parameters
tunnelthe LinphoneTunnel
Returns
TRUE if tunnel is in use, FALSE otherwise.

◆ linphone_tunnel_get_domain()

const char* linphone_tunnel_get_domain ( LinphoneTunnel tunnel)

Get the domain.

Parameters
tunnelLinphoneTunnel object
Returns
The domain.

◆ linphone_tunnel_get_http_proxy()

void linphone_tunnel_get_http_proxy ( LinphoneTunnel tunnel,
const char **  host,
int *  port,
const char **  username,
const char **  passwd 
)

Retrieve optional http proxy configuration previously set with linphone_tunnel_set_http_proxy().

Parameters
tunnelLinphoneTunnel object
hosthttp proxy host
porthttp proxy port
usernameOptional http proxy username if the proxy request authentication. Currently only basic authentication is supported. Use NULL if not needed.
passwdOptional http proxy password. Use NULL if not needed.

◆ linphone_tunnel_get_mode()

LinphoneTunnelMode linphone_tunnel_get_mode ( const LinphoneTunnel tunnel)

Get the tunnel mode.

Parameters
tunnelLinphoneTunnel object
Returns
The current LinphoneTunnelMode

◆ linphone_tunnel_get_servers()

const bctbx_list_t* linphone_tunnel_get_servers ( const LinphoneTunnel tunnel)

Get added servers.

Parameters
tunnelLinphoneTunnel object
Returns
The list of servers.

◆ linphone_tunnel_get_username()

const char* linphone_tunnel_get_username ( LinphoneTunnel tunnel)

Get the username.

Parameters
tunnelLinphoneTunnel object
Returns
The username.

◆ linphone_tunnel_reconnect()

void linphone_tunnel_reconnect ( LinphoneTunnel tunnel)

Force reconnection to the tunnel server.

This method is useful when the device switches from wifi to Edge/3G or vice versa. In most cases the tunnel client socket won't be notified promptly that its connection is now zombie, so it is recommended to call this method that will cause the lost connection to be closed and new connection to be issued.

Parameters
tunnelLinphoneTunnel object

◆ linphone_tunnel_ref()

LinphoneTunnel* linphone_tunnel_ref ( LinphoneTunnel tunnel)

Take a reference on a LinphoneTunnel.

Parameters
tunnelThe LinphoneTunnel whose the ref counter will be increased.
Returns
Pointer on the freshly refed LinphoneTunnel.

◆ linphone_tunnel_remove_server()

void linphone_tunnel_remove_server ( LinphoneTunnel tunnel,
LinphoneTunnelConfig tunnel_config 
)

Remove a tunnel server configuration.

Parameters
tunnelLinphoneTunnel object
tunnel_configLinphoneTunnelConfig object

◆ linphone_tunnel_set_domain()

void linphone_tunnel_set_domain ( LinphoneTunnel tunnel,
const char *  domain 
)

Set the domain.

Required for tunnel TLS client authentification. Certificate Altname or CName should be sip:<tunnel_username><tunnel_domain>

Parameters
tunnelLinphoneTunnel object
domainThe domain.

◆ linphone_tunnel_set_http_proxy()

void linphone_tunnel_set_http_proxy ( LinphoneTunnel tunnel,
const char *  host,
int  port,
const char *  username,
const char *  passwd 
)

Set an optional http proxy to go through when connecting to tunnel server.

Parameters
tunnelLinphoneTunnel object
hosthttp proxy host
porthttp proxy port
usernameOptional http proxy username if the proxy request authentication. Currently only basic authentication is supported. Use NULL if not needed.
passwdOptional http proxy password. Use NULL if not needed.

◆ linphone_tunnel_set_http_proxy_auth_info()

void linphone_tunnel_set_http_proxy_auth_info ( LinphoneTunnel tunnel,
const char *  username,
const char *  passwd 
)

Set authentication info for the http proxy.

Parameters
tunnelLinphoneTunnel object
usernameUser name
passwdPassword

◆ linphone_tunnel_set_mode()

void linphone_tunnel_set_mode ( LinphoneTunnel tunnel,
LinphoneTunnelMode  mode 
)

Set the tunnel mode.

The tunnel mode can be 'enable', 'disable' or 'auto' If the mode is set to 'auto', the tunnel manager will try to established an RTP session with the tunnel server on the UdpMirrorPort. If the connection fail, the tunnel is automatically activated whereas the tunnel is automatically disabled if the connection succeed.

Parameters
tunnelLinphoneTunnel object
modeThe desired LinphoneTunnelMode

◆ linphone_tunnel_set_username()

void linphone_tunnel_set_username ( LinphoneTunnel tunnel,
const char *  username 
)

Set the username.

Required for tunnel TLS client authentification. Certificate Altname or CName should be sip:<tunnel_username><tunnel_domain>

Parameters
tunnelLinphoneTunnel object
usernameThe username.

◆ linphone_tunnel_sip_enabled()

bool_t linphone_tunnel_sip_enabled ( const LinphoneTunnel tunnel)

Check whether tunnel is set to transport SIP packets.

Parameters
tunnelLinphoneTunnel object
Returns
A boolean value telling whether SIP packets shall pass through the tunnel

◆ linphone_tunnel_unref()

void linphone_tunnel_unref ( LinphoneTunnel tunnel)

Release a reference on a LinphoneTunnel.

Parameters
tunnelThe LinphoneTunnel whose the ref counter will be decreased.