Document configuration file format
[platform/upstream/connman.git] / doc / config-format.txt
1 Connman configuration file format
2 *********************************
3
4 Connman uses configuration files to provision existing services. Connman will
5 be looking for its configuration files at STORAGEDIR which by default points
6 to /var/lib/connman/.
7 Those configuration files are text files with a simple format and we typically
8 have one file per provisioned network.
9
10
11 Global entry [global]
12 =====================
13
14 These files can have an optional global entry describing the actual file.
15 The 2 allowed fields for that entry are:
16 - Name: Name of the network.
17 - Description: Description of the network.
18
19
20 Service entry [service_*]
21 =========================
22
23 Each provisioned service must start with the [service_*] tag. Replace * with
24 your service identifier.
25 The service identifier can be anything and will be used internally by connman
26 to store the different services into an hash table.
27
28 Allowed fields:
29 - Type: Service type. We currently only support wifi.
30 - SSID: An hexadecimal or a string representation of a 802.11 SSID.
31 - EAP: EAP type. We currently only support tls or peap.
32 - CACertFile: File path to CA certificate file (PEM/DER).
33 - ClientCertFile: File path to client certificate file (PEM/DER).
34 - PrivateKeyFile: File path to client private key file (PEM/DER/PFX).
35 - PrivateKeyPassphrase: Password/passphrase for private key file.
36 - PrivateKeyPassphraseType: We only support the fsid passphrase type for now.
37 This is for private keys generated by using their own filesystem UUID as the
38 passphrase. The PrivateKeyPassphrase field is ignored when this field is set
39 to fsid.
40 - Identity: Identity string for EAP.
41 - Phase2: Phase2 (inner authentication with TLS tunnel) parameters.
42
43
44 Example
45 =======
46
47 This is a configuration file for a network providing both EAP-TLS and
48 EAP-PEAP services.
49 The respective SSIDs are tls_ssid and peap_ssid.
50
51 [global]
52 Name = Example
53 Description = Example network configuration
54
55 [service_tls]
56 Type = wifi
57 SSID = 746c735f73736964
58 EAP = tls
59 CACertFile = /home/user/.certs/ca.pem
60 ClientCertFile = /home/user/devlp/.certs/client.pem
61 PrivateKeyFile = /home/user/.certs/client.fsid.pem
62 PrivateKeyPassphraseType = fsid
63 Identity = user
64
65 [service_peap]
66 Type = wifi
67 SSID = peap_ssid
68 EAP = peap
69 CACert = /home/user/.cert/ca.pem
70 Phase2 = MSCHAPV2
71 Identity = user