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