1. Manuals
  2. Tumbleweed
  3. connman-doc
  4. connman-vpn-provider.config(5)

Scroll to navigation

connection_name.config(5) File Formats Manual connection_name.config(5)

NAME

connection_name.config - ConnMan vpn connection provisioning file

SYNOPSIS

/var/lib/connman-vpn/connection-name.config

DESCRIPTION

ConnMan's vpn connections are configured with so called "provisioning files" which reside under /var/lib/connman-vpn/. The files can be named anything, as long as they contain only printable ascii characters, for example letters, numbers and underscores. The file must end with .config. Each VPN connection requires a provisioning file, but multiple connections can be specified in the same file.

FILE FORMAT

The configuration file consists of sections (groups) of key-value pairs. Lines beginning with a '#' and blank lines are considered comments. Sections are started by a header line containing the section enclosed in '[' and ']', and ended implicitly by the start of the next section or the end of the file. Each key-value pair must be contained in a section.

Description of sections and available keys follows:

[global]

This section is optional, and can be used to describe the actual file. The two allowed fields for this section are:

Name of the network.
Description of the network.

[provider_*]

Each provisioned connection must start with a [provider_*] tag, with * replaced by an unique name within the file. The following fields are mandatory:

Specifies the VPN type.
VPN server IP address.
Domain name for the VPN service.
Networks behind the VPN. If all traffic should go through the VPN, this field can be left out. The gateway can be left out. For IPv6 addresses, only the prefix length is accepted as the netmask.

OpenConnect

The following keys can be used for openconnect(8) networks:

SHA1 fingerprint of the VPN server's certificate.
File containing additional CA certificates in addition to the system trusted certificate authorities.
Client certificate, if needed by web authentication.
Request mtu from the server as the MTU of the tunnel.
The resulting cookie of the authentication process. As the cookie lifetime can be very limited, it does not usually make sense to add it into the configuration file.
The final VPN server to use after completing the web authentication. Only usable for extremely simple VPN configurations and should normally be set only via the VPN Agent API.

If OpenConnect.Cookie, OpenConnect.VPNHost or OpenConnect.ServerCert are missing, the VPN Agent will be contacted to supply the information.

OpenVPN

The following keys are mandatory for openvpn(8) networks:

Certificate authority file.
Local peer's signed certificate.
Local peer's signed certificate.
Local peer's private key.
openvpn(8) networks:
MTU of the tunnel.
Peer certificate type, either client or server.
Use protocol.
TCP/UDP port number.
Authenticate on the server using username/password.
Get certificate password from file.
Don't cache AskPass or AuthUserPass value.
Accept connections only from a host with X509 name or common name equal to name.
Use file for HMAC authentication.
Use direction for HMAC authentication direction.
Use cipher as the cipher.
Use HMAC authentication.
Use fast LZO compression.
Require that remote certificate is signed based on RFC3280 TLS rules.
OpenVPN config file for extra options not supported by the OpenVPN plugin.
Whether the VPN should use a tun (OSI layer 3) or tap (OSI layer 2) device. Defaults to tun if omitted.

VPNC

The following key is mandatory for vpnc(8) networks:

Group username.
vpnc(8) networks:
Group password.
Username.
Password.
IKE authentication mode.
IKE DH group name.
Diffie-Hellman group for perfect forward secrecy.
Domain name for authentication.
Vendor of the IPSec gateway.
Local ISAKMP port number to use.
Cisco UDP Encapsulation Port.
Application version to report.
NAT-Traversal Method to use.
DPD idle timeout.
Enable single DES encryption.
Enable usage of no encryption for data traffic.
Whether the VPN should use a tun (OSI layer 3) or tap (OSI layer 2) device. Defaults to tun if omitted.

L2TP

The following keys are optional for l2tp (xl2tp.conf(5), pppd(8)) networks:

L2TP username.
L2TP password.
Max bandwidth to use.
Max transmit bandwidth to use.
Max receive bandwidth to use.
Use length bit.
Use challenge authentication.
Add route to the routing tables.
Use seq numbers.
Window size.
Use only one control channel.
Redial if disconnected.
Redial timeout.
Maximum amount of redial tries.
Require PAP.
Require CHAP.
Require authentication.
Use access control.
Authentication file location.
Listen address.
Listen address.
UDP port used.
Echo failure count.
Dead peer check count.
Dead peer check interval.
Debug level.
Refuse EAP authentication.
Refuse PAP authentication.
Refuse CHAP authentication.
Refuse MSCHAP authentication.
Refuse MSCHAPv2 authentication.
Disable BSD compression.
Disable protocol compression.
Disable Access/Control compression.
Disable deflate compression.
Require the use of MPPE.
Require the use of MPPE 40 bit.
Require the use of MPPE 128 bit.
Allow MPPE to use stateful mode.
No Van Jacobson compression.

PPTP

The following keys are optional for pptp(8) (see also pppd(8)) networks:

Username.
Password.
Echo failure count.
Dead peer check count.
Dead peer check interval.
Debug level.
Refuse EAP authentication.
Refuse PAP authentication.
Refuse CHAP authentication.
Refuse MSCHAP authentication.
Refuse MSCHAPv2 authentication.
Disable BSD compression.
Disable protocol compression.
Disable Access/Control compression.
Disable deflate compression.
Require the use of MPPE.
Require the use of MPPE 40 bit.
Require the use of MPPE 128 bit.
Allow MPPE to use stateful mode.
No Van Jacobson compression.

EXAMPLE

This is a configuration file for a VPN providing L2TP, OpenVPN and OpenConnect services. It could, for example, be in the file /var/lib/connman-vpn/example.config.

[global]
Name = Example
Description = Example VPN configuration
[provider_l2tp]
Type = L2TP
Name = Connection to corporate network
Host = 1.2.3.4
Domain = corporate.com
Networks = 10.10.30.0/24
L2TP.User = username
[provider_openconnect]
Type = OpenConnect
Name = Connection to corporate network using Cisco VPN
Host = 7.6.5.4
Domain = corporate.com
Networks = 10.10.20.0/255.255.255.0/10.20.1.5,192.168.99.1/24,2001:db8::1/64
OpenConnect.ServerCert = 263AFAB4CB2E6621D12E90182008AEF44AEFA031
OpenConnect.CACert = /etc/certs/certificate.p12
[provider_openvpn]
Type = OpenVPN
Name = Connection to corporate network using OpenVPN
Host = 3.2.5.6
Domain = my.home.network
OpenVPN.CACert = /etc/certs/cacert.pem
OpenVPN.Cert = /etc/certs/cert.pem
OpenVPN.Key = /etc/certs/cert.key

SEE ALSO

connmanctl(1), connman(8), connman-vpn(8)

2015-10-15