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) parameters.
  43 - Passphrase: RSN/WPA/WPA2 Passphrase
  44
  45
  46 Example
  47 =======
  48
  49 This is a configuration file for a network providing EAP-TLS, EAP-TTLS and
  50 EAP-PEAP services.
  51 The respective SSIDs are tls_ssid, ttls_ssid and peap_ssid and the file name
  52 is example.config.
  53 Please note that the SSID entry is for hexadecimal encoded SSID (e.g. "SSID =
  54 746c735f73736964"). If your SSID does not contain any exotic character then
  55 you should use the Name entry instead (e.g. "Name = tls_ssid").
  56
  57
  58 example@example:[~]$ cat /var/lib/connman/example.config
  59 [global]
  60 Name = Example
  61 Description = Example network configuration
  62
  63 [service_tls]
  64 Type = wifi
  65 SSID = 746c735f73736964
  66 EAP = tls
  67 CACertFile = /home/user/.certs/ca.pem
  68 ClientCertFile = /home/user/devlp/.certs/client.pem
  69 PrivateKeyFile = /home/user/.certs/client.fsid.pem
  70 PrivateKeyPassphraseType = fsid
  71 Identity = user
  72
  73 [service_ttls]
  74 Type = wifi
  75 Name = ttls_ssid
  76 EAP = ttls
  77 CACertFile = /home/user/.cert/ca.pem
  78 Phase2 = MSCHAPV2
  79 Identity = user
  80
  81 [service_peap]
  82 Type = wifi
  83 Name = peap_ssid
  84 EAP = peap
  85 CACertFile = /home/user/.cert/ca.pem
  86 Phase2 = MSCHAPV2
  87 Identity = user