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 should follow the *.config
   7 pattern.
   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 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 both EAP-TLS and
  50 EAP-PEAP services.
  51 The respective SSIDs are tls_ssid and peap_ssid and the file name is
  52 example.config.
  53
  54 example@example:[~]$ cat /var/lib/connman/example.config
  55 [global]
  56 Name = Example
  57 Description = Example network configuration
  58
  59 [service_tls]
  60 Type = wifi
  61 SSID = 746c735f73736964
  62 EAP = tls
  63 CACertFile = /home/user/.certs/ca.pem
  64 ClientCertFile = /home/user/devlp/.certs/client.pem
  65 PrivateKeyFile = /home/user/.certs/client.fsid.pem
  66 PrivateKeyPassphraseType = fsid
  67 Identity = user
  68
  69 [service_peap]
  70 Type = wifi
  71 SSID = peap_ssid
  72 EAP = peap
  73 CACert = /home/user/.cert/ca.pem
  74 Phase2 = MSCHAPV2
  75 Identity = user