doc/connman-service.config.5.in

   1 .\" connman-service.config(5) manual page
   2 .\"
   3 .\" Copyright (C) 2015 Intel Corporation
   4 .\"
   5 .TH "service-name.config" "5" "2015-10-15" ""
   6 .SH NAME
   7 service-name.config \- ConnMan service provisioning file
   8 .SH SYNOPSIS
   9 .B @storagedir@/\fIservice-name\fB.config
  10 .SH DESCRIPTION
  11 .P
  12 \fIConnMan\fP's services are configured with so called
  13 "\fBprovisioning files\fP" which reside under \fI@storagedir@/\fP.
  14 The files can be named anything, as long as they end in \fB.config\fP.
  15 The provisioning files can be used to configure for example secured
  16 wireless access points which need complex authentication, for example
  17 eduroam, or for static IPs and so on. Each provisioning file can be
  18 used for multiple services at once.
  19 .SH "FILE FORMAT"
  20 .P
  21 The configuration file consists of sections (groups) of key-value pairs.
  22 Lines beginning with a '#' and blank lines are considered comments.
  23 Sections are started by a header line containing the section enclosed
  24 in '[' and ']', and ended implicitly by the start of the next section
  25 or the end of the file. Each key-value pair must be contained in a section.
  26 .P
  27 Description of sections and available keys follows:
  28 .SS [global]
  29 This section is optional, and can be used to describe the actual file. The
  30 two allowed fields for this section are:
  31 .TP
  32 .BI Name= name
  33 Name of the network.
  34 .TP
  35 .BI Description= description
  36 Description of the network.
  37 .SS [service_*]
  38 Each provisioned service must start with a [service_*] tag, with * replaced
  39 by an unique name within the file.
  40 The allowed fields are:
  41 .TP
  42 .B Type=ethernet \fR|\fB wifi
  43 Mandatory. Other types than ethernet or wifi are not supported.
  44 .TP
  45 .BI IPv4=off \ \fR|\  dhcp\ \fR|\  network / netmask / gateway
  46 IPv4 settings for the service. If set to \fBoff\fP, IPv4 won't be used.
  47 If set to \fBdhcp\fP, dhcp will be used to obtain the network settings.
  48 \fInetmask\fP can be specified as length of the mask rather than the
  49 mask itself. The gateway can be omitted when using a static IP.
  50 .TP
  51 .BI IPv6=off \ \fR|\  auto\ \fR|\  network / prefixlength / gateway
  52 IPv6 settings for the service. If set to \fBoff\fP, IPv6 won't be used.
  53 If set to \fBauto\fP, settings will be obtained from the network.
  54 .TP
  55 .B IPv6.Privacy=disabled \fR|\fB enabled \fR|\fB preferred
  56 IPv6 privacy settings as per RFC3041.
  57 .TP
  58 .BI MAC= address
  59 MAC address of the interface to be used. If not specified, the first
  60 found interface is used. Must be in format ab:cd:ef:01:23:45.
  61 .TP
  62 .BI Nameservers= servers
  63 Comma separated list of nameservers.
  64 .TP
  65 .BI SearchDomains= domains
  66 Comma separated list of DNS search domains.
  67 .TP
  68 .BI Timeservers= servers
  69 Comma separated list of timeservers.
  70 .TP
  71 .BI Domain= domain
  72 Domain name to be used.
  73 .TP
  74 The following keys can only be used for wireless networks:
  75 .TP
  76 .BI Name= name
  77 A string representation of an network SSID. If the SSID field is
  78 present, the Name field is ignored. If the SSID field is not present,
  79 this field is mandatory.
  80 .TP
  81 .BI SSID= ssid
  82 SSID: A hexadecimal representation of an 802.11 SSID. Use this format to
  83 encode special characters including starting or ending spaces.
  84 .TP
  85 .BI Passphrase= passphrase
  86 RSN/WPA/WPA2 Passphrase.
  87 .TP
  88 .BI Security= type
  89 The security type of the network. Possible values are \fBpsk\fP
  90 (WPA/WPA2 PSK), \fBieee8021x\fP (WPA EAP), \fBnone\fP and \fBwep\fP.
  91 When not set, the default value is \fBieee8021x\fP if an EAP type is
  92 configured, \fBpsk\fP if a passphrase is present and \fBnone\fP otherwise.
  93 .TP
  94 .B Hidden=true \fR|\fB false
  95 If set to \fBtrue\fP, then this AP is hidden. If missing or set to
  96 \fBfalse\fP, then AP is not hidden.
  97 .TP
  98 The following keys are used for WPA EAP (when \fBSecurity=ieee8021x\fP):
  99 .TP
 100 .B EAP=tls \fR|\fB ttls \fR|\fB peap
 101 EAP type to use. Only \fBtls\fP, \fBttls\fP and \fBpeap\fP are supported.
 102 .TP
 103 .BI CACertFile= file
 104 Path to the CA certificate file. Only PEM and DER formats are supported.
 105 .TP
 106 .BI PrivateKeyFile= file
 107 Path to the private key file. Only PEM, DER and PFX formats are supported.
 108 .TP
 109 .BI PrivateKeyPassphrase= passphrase
 110 Passphrase of the private key.
 111 .TP
 112 .B PrivateKeyPassphraseType=fsid
 113 If specified, use the private key's fsid as the passphrase, and ignore the
 114 PrivateKeyPassphrase field.
 115 .TP
 116 .BI Identity= identity
 117 Identity string for EAP.
 118 .TP
 119 .BI AnonymousIdentity= identity
 120 Anonymous identity string for EAP.
 121 .TP
 122 .BI SubjectMatch= substring
 123 Substring to be matched against the subject of the
 124 authentication server certificate for EAP.
 125 .TP
 126 .BI AltSubjectMatch= substring
 127 Semicolon separated string of entries to be matched against the alternative
 128 subject name of the authentication server certificate for EAP.
 129 .TP
 130 .BI DomainSuffixMatch= domain
 131 Constraint for server domain name. If set, this FQDN is used as a suffix match
 132 requirement for the authentication server certificate for EAP.
 133 .TP
 134 .BI DomainMatch= domain
 135 This FQDN is used as a full match requirement for the
 136 authentication server certificate for EAP.
 137 .TP
 138 .BI Phase2= type
 139 Inner authentication type with for \fBEAP=tls\fP or \fBEAP=ttls\fP. Prefix
 140 the value with \fBEAP-\fP to indicate usage of EAP-based authentication
 141 method (should only be used with \fBEAP=ttls\fP).
 142 .SH "EXAMPLE"
 143 .SS Eduroam
 144 This is a configuration file for eduroam networks. This file could for
 145 example be @storagedir@/eduroam.config. Your university's exact
 146 settings might be different.
 147 .PP
 148 .nf
 149 [service_eduroam]
 150 Type = wifi
 151 Name = eduroam
 152 EAP = peap
 153 Phase2 = MSCHAPV2
 154 CACertFile = /etc/ssl/certs/UNIV_CA.crt
 155 .fi
 156 .SS Complex networking
 157 This is a configuration file for a network providing EAP-TLS, EAP-TTLS and
 158 EAP-PEAP services. The respective SSIDs are tls_ssid, ttls_ssid and peap_ssid
 159 and the file name could be @storagedir@/complex.config.
 160 .PP
 161 Please note that the SSID entry is for hexadecimal encoded SSID (e.g. "SSID =
 162 746c735f73736964"). If your SSID does not contain any exotic character then
 163 you should use the Name entry instead (e.g. "Name = tls_ssid").
 164 .PP
 165 .nf
 166 [global]
 167 Name = Example
 168 Description = Example network configuration
 169
 170 [service_tls]
 171 Type = wifi
 172 SSID = 746c735f73736964
 173 EAP = tls
 174 CACertFile = /home/user/.certs/ca.pem
 175 ClientCertFile = /home/user/devlp/.certs/client.pem
 176 PrivateKeyFile = /home/user/.certs/client.fsid.pem
 177 PrivateKeyPassphraseType = fsid
 178 Identity = user
 179
 180 [service_ttls]
 181 Type = wifi
 182 Name = ttls_ssid
 183 EAP = ttls
 184 CACertFile = /home/user/.cert/ca.pem
 185 Phase2 = MSCHAPV2
 186 Identity = user
 187
 188 [service_peap]
 189 Type = wifi
 190 Name = peap_ssid
 191 EAP = peap
 192 CACertFile = /home/user/.cert/ca.pem
 193 Phase2 = MSCHAPV2
 194 Identity = user
 195
 196 [service_home_ethernet]
 197 Type = ethernet
 198 IPv4 = 192.168.1.42/255.255.255.0/192.168.1.1
 199 IPv6 = 2001:db8::42/64/2001:db8::1
 200 MAC = 01:02:03:04:05:06
 201 Nameservers = 10.2.3.4,192.168.1.99
 202 SearchDomains = my.home,isp.net
 203 Timeservers = 10.172.2.1,ntp.my.isp.net
 204 Domain = my.home
 205
 206 [service_home_wifi]
 207 Type = wifi
 208 Name = my_home_wifi
 209 Passphrase = password
 210 IPv4 = 192.168.2.2/255.255.255.0/192.168.2.1
 211 MAC = 06:05:04:03:02:01
 212 .fi
 213 .SH "SEE ALSO"
 214 .BR connman (8)