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/. Configuration file names must not include other
   7 characters than letters or numbers and must have a .config suffix.
   8 Those configuration files are text files with a simple format and we typically
   9 have one file per provisioned network.
  10
  11
  12 Global entry [global]
  13 =====================
  14
  15 These files can have an optional global entry describing the actual file.
  16 The 2 allowed fields for that entry are:
  17 - Name: Name of the network.
  18 - Description: Description of the network.
  19
  20
  21 Service entry [service_*]
  22 =========================
  23
  24 Each provisioned service must start with the [service_*] tag. Replace * with
  25 your service identifier.
  26 The service identifier can be anything and will be used internally by connman
  27 to store the different services into an hash table.
  28
  29 Allowed fields:
  30 - Type: Service type. We currently only support wifi.
  31 - SSID: An hexadecimal or a string representation of a 802.11 SSID.
  32 - EAP: EAP type. We currently only support tls, ttls or peap.
  33 - CACertFile: File path to CA certificate file (PEM/DER).
  34 - ClientCertFile: File path to client certificate file (PEM/DER).
  35 - PrivateKeyFile: File path to client private key file (PEM/DER/PFX).
  36 - PrivateKeyPassphrase: Password/passphrase for private key file.
  37 - PrivateKeyPassphraseType: We only support the fsid passphrase type for now.
  38 This is for private keys generated by using their own filesystem UUID as the
  39 passphrase. The PrivateKeyPassphrase field is ignored when this field is set
  40 to fsid.
  41 - Identity: Identity string for EAP.
  42 - Phase2: Phase2 (inner authentication with TLS tunnel) authentication method.
  43 Prefix the value with "EAP-" to indicate the usage of an EAP-based inner
  44 authentication method (should only be used with EAP = TTLS).
  45 - Passphrase: RSN/WPA/WPA2 Passphrase
  46
  47
  48 Example
  49 =======
  50
  51 This is a configuration file for a network providing EAP-TLS, EAP-TTLS and
  52 EAP-PEAP services.
  53 The respective SSIDs are tls_ssid, ttls_ssid and peap_ssid and the file name
  54 is example.config.
  55 Please note that the SSID entry is for hexadecimal encoded SSID (e.g. "SSID =
  56 746c735f73736964"). If your SSID does not contain any exotic character then
  57 you should use the Name entry instead (e.g. "Name = tls_ssid").
  58
  59
  60 example@example:[~]$ cat /var/lib/connman/example.config
  61 [global]
  62 Name = Example
  63 Description = Example network configuration
  64
  65 [service_tls]
  66 Type = wifi
  67 SSID = 746c735f73736964
  68 EAP = tls
  69 CACertFile = /home/user/.certs/ca.pem
  70 ClientCertFile = /home/user/devlp/.certs/client.pem
  71 PrivateKeyFile = /home/user/.certs/client.fsid.pem
  72 PrivateKeyPassphraseType = fsid
  73 Identity = user
  74
  75 [service_ttls]
  76 Type = wifi
  77 Name = ttls_ssid
  78 EAP = ttls
  79 CACertFile = /home/user/.cert/ca.pem
  80 Phase2 = MSCHAPV2
  81 Identity = user
  82
  83 [service_peap]
  84 Type = wifi
  85 Name = peap_ssid
  86 EAP = peap
  87 CACertFile = /home/user/.cert/ca.pem
  88 Phase2 = MSCHAPV2
  89 Identity = user