|
Liblinphone
5.5.0
|
|
|
Liblinphone
5.5.0
|
|
This document lists the supported sections and keys of the ini-style linphonerc configuration file.
This configuration can be served through https in order to remotely configure a linphone-sdk based application, see Linphone.Core.ProvisioningUri().
The Flexisip Account Manager has built-in support for remote provisioning Linphone or linphone-sdk based client applications.
The sip section represents a general configuration for SIP.
| Key | Value type | Possible values | Default value | API | |
|---|---|---|---|---|---|
| 100rel_support_level | integer | Linphone.SupportLevel | NoSupport | Linphone.Core.Tag100RelSupportLevel() | |
| auto_send_ringing | integer | 0 or 1 | 1 | Linphone.Core.AutoSendRingingEnabled() | |
| automatic_http_proxy_detection | integer | 0 or 1 | 0 | Linphone.Core.AutomaticHttpProxyDetectionEnabled() | |
| capability_negotiations_reinvite | integer | 0 or 1 | 1 | Linphone.Core.CapabilityNegotiationReinviteEnabled() | |
| cfg_lines_merge | integer | 0 or 1 | 1 | Linphone.Core.CfgLinesMergingEnabled() | |
| client_cert_chain | string | A path | "" | Linphone.Core.TlsCertPath() | |
| client_cert_key | string | A key | "" | Linphone.Core.TlsKeyPath() | |
| contact | string | SIP URI (e.g. sip:user@host) | "" | Linphone.Core.PrimaryContact() | |
| delayed_timeout | integer | seconds | 4 | Linphone.Core.DelayedTimeout() | |
| dscp | integer | DSCP | 0 | Linphone.Core.SipDscp() | |
| enable_go_clear | integer | 0 or 1 | 0 | Linphone.Core.ZrtpGoClearEnabled() | |
| guess_hostname | integer | 0 or 1 | 1 | Linphone.Core.GuessHostname() | |
| http_proxy_host | string | a hostname | "" | Linphone.Core.HttpProxyHost() | |
| http_proxy_port | integer | 0 - 65535 | 3128 | Linphone.Core.HttpProxyPort() | |
| ice_enabled | integer | 0 or 1 | 1 | Linphone.NatPolicy.IceEnabled() | |
| in_call_timeout | integer | 0–86400 (s) | 0 | Linphone.Core.InCallTimeout() | |
| inc_timeout | integer | 0–300 (s) | Android and IOS: 45. Else: 30 | Linphone.Core.IncTimeout() | |
| keepalive_period | integer | 0–60000 (ms) | 30000 | Linphone.Core.KeepAliveEnabled() | |
| linphone_specs | string | "groupchat/1.1" | "" | Linphone.Core.LinphoneSpecsList() | |
| media_encryption_mandatory | integer | 0 or 1 | 0 | Linphone.Core.IsMediaEncryptionMandatory() | |
| media_encryption | string | none, srtp, zrtp | none | Linphone.Core.MediaEncryption() | |
| push_incoming_call_timeout | integer | seconds | 15 | Linphone.Core.PushIncomingCallTimeout() | |
| refresh_window | range | Range of seconds | 90-90 | Linphone.Core.SetRefreshWindow() | |
| register_only_when_network_is_up | integer | 0 or 1 | 1 | Linphone.Core.RegisterOnlyWhenNetworkIsUp() | |
| root_ca | string | a path | "" | Linphone.Core.RootCa() | |
| sdp_200_ack | integer | 0 or 1 | 0 | Linphone.Core.Sdp200AckEnabled() | |
| session_expires_enabled | integer | 0 or 1 | 0 | Linphone.Core.SessionExpiresEnabled() | |
| session_expires_min_value | integer | Positive number | 0 | Linphone.Core.SessionExpiresMinValue() | |
| session_expires_refresher_value | integer | Linphone.SessionExpiresRefresher | Unspecified | Linphone.Core.SessionExpiresRefresherValue() | |
| session_expires_value | integer | 0 or not lower than session_expires_min_value | 0 | Linphone.Core.SessionExpiresValue() | |
| sip_update | integer | 0 or 1 | 1 | Linphone.Core.EnableSipUpdate() | |
| srtp_crypto_suites | string | List | "AEAD_AES_128_GCM, AES_CM_128_HMAC_SHA1_80, AEAD_AES_256_GCM, AES_256_CM_HMAC_SHA1_80" | Linphone.Core.SrtpCryptoSuites() | |
| stun_enabled | integer | 0 or 1 | 0 | Linphone.NatPolicy.StunEnabled() | |
| stun_server | string | hostname or IP | "" | Linphone.NatPolicy.StunServer() | |
| support_capability_negotiations | integer | 0 or 1 | 0 | Linphone.Core.CapabilityNegociationEnabled() | |
| supported | string | Tags | "replaces, outbound, gruu, path" | Linphone.Core.SupportedTag() | |
| tcap_line_merge | integer | 0 or 1 | 0 | Linphone.Core.TcapLinesMergingEnabled() | |
| transport_timeout | integer | Milliseconds | 15000 | Linphone.Core.SipTransportTimeout() | |
| use_info | integer | 0 or 1 | 0 | Linphone.Core.UseInfoForDtmf() | |
| use_ipv6 | integer | 0 or 1 | 0 | Linphone.Core.Ipv6Enabled() | |
| use_rfc2833 | integer | 0 or 1 | 1 | Linphone.Core.UseRfc2833ForDtmf() | |
| user_agent | string | A user-agent | PACKAGE_NAME/LIBLINPHONE_VERSION | Linphone.Core.UserAgent() | |
| verify_server_certs | integer | 0 or 1 | 1 | Linphone.Core.VerifyServerCertificates() | |
| verify_server_cn | integer | 0 or 1 | 1 | Linphone.Core.VerifyServerCn() | |
| zero_rtp_port_for_stream_inactive | integer | 0 or 1 | 0 | Linphone.Core.ZeroRtpPortForStreamInactiveEnabled() |
The proxy_N sections represents SIP accounts.
Their name inherits from the legacy object name Linphone.ProxyConfig in liblinphone, that is now superseeded by by the Linphone.Account and Linphone.AccountParams object, but the linphonerc section name was left unchanged to preserve configuration file compatibility.
| Key | Value type | Possible values | Default value | Description |
|---|---|---|---|---|
| reg_identity | string | SIP address | "" | The SIP address of the user, as to be sent in the From header of the REGISTER request |
| reg_proxy | string | SIP address | "" | The address of the SIP server |
| reg_route | string | SIP address | "" | An optional SIP address to include as a route |
| reg_sendregister | boolean | 0 or 1 | 1 | Whether to send a REGISTER request |
| reg_expires | integer | any strictly positive integer | 3600 | The expiry of the REGISTER, in seconds |
| realm | string | any string | "" | The authentication realm of the SIP service, used to match with authentication information |
Their role is not to present a permanent list of contacts to the user, but rather return, per a search request, a list of contacts that match the request.
The search request is transmitted through the protocol (LDAP or CardDav), and executed on the server. The server's response is analysed and search results are represented as a list of Linphone.Friend objects.
LDAP connection configuration has it is own password key, and it is not relying at all on the Linphone.AuthInfo objects, unlike all other liblinphone initiated connections.
Table remote contact directory parameters lists all remote contact directory parameters one may find under section [remote_contact_directory_N] of a Linphone RC file.
| Key | Value type | Possible values | Default value | Description |
|---|---|---|---|---|
| enabled | integer | 0 or 1 | 1 | Whether the remote contact directory is enabled |
| type | string | carddav or ldap | "" | The type (protocol) used by the remote contact directory |
| uri | string | a URI | "" | The server URI, typically ldap://example.org or https://carddav.example.org |
| min_characters | integer | any positive integer or 0 | 3 | The minimum number of characters needed to submit the request |
| results_limit | integer | any positive integer or 0 | 0 | Limit on the number of returned results. 0 means returns all results |
| timeout | integer | any positive integer or 0 | 5 | Request timeout in seconds |
| delay | integer | any positive integer or 0 | 500 | Delay in milliseconds before submitting the request |
| carddav_fields_for_user_input | string | "" | List of comma separated VCard fields to match with the user input | |
| carddav_fields_for_domain | string | "" | List of comma separated VCard fields to match for SIP domain | |
| carddav_use_exact_match_policy | integer | 0 or 1 | 0 | Whether the match must be exact or approximate (ignoring accents, case, ...) |
| ldap_bind_dn | string | "" | LDAP bind distinguished name | |
| ldap_auth_method | integer | 0: anonymous | 1 | LDAP authentication method |
| 1: simple | ||||
| ldap_base_object | string | "" | LDAP base object | |
| ldap_name_attribute | string | "sn" | LDAP attribute(s) to browse for contact names | |
| ldap_sip_attribute | string | "mobile,telephonenumber,homephone,sn" | LDAP attribute(s) to use to create SIP URIs associated with this remote contact directory | |
| ldap_sip_domain | string | "" | A SIP domain to filter results | |
| ldap_filter | string | "(sn=%s)" | A LDAP search filter |
The auth_info sections provide authentication information to use for SIP as well as http services (typically remote provisioning, cardDav requests). They need to be supplied in the form of a Linphone.AuthInfo object, whose configuration storage representation is of [auth_info_N] sections, numbered continuously from 0.
Table authentication information parameters lists all remote contact directory parameters one may find under section [auth_info_N] of a Linphone RC file.
| Key | Value type | Possible values | Default value | Description |
|---|---|---|---|---|
| username | string | anything | "" | The username to use for authenticating |
| domain | string | anything | "" | A SIP domain to which the use of thie Linphone.AuthInfo is scoped to |
| passwd | string | anything | "" | The clear-text password |
| realm | string | anything | "" | The realm advertised by the server, it may be left empty if unknown |
| ha1 | string | anything | "" | A digest HA1 of the password |
| algorithm | string | MD5 | MD5 | The digest algorithm |
| SHA-256 | ||||
| authorization_server | string | any HTTP/HTTPS URI | "" | An OAUTH/OpenID connect authorization server URI to use to autheticate |
| token_endpoint | string | any HTTP/HTTPS URI | "" | URI of endpoint to refresh tokens |
| client_id | string | anything | "" | OAUTH client ID |
| client_secret | string | anything | "" | OAUTH client secret |
1.8.11