Configure the FDO client

To customize the behavior of the FIDO Device Onboard (FDO) client to suit your environment, manage how it interacts with the manufacturing and onboarding servers.

Before you begin

  • You installed the go-fdo-client package on the target device.
  • You have access to a command line with sufficient permissions to run the client.
  • Optional: You have a predefined configuration file in the YAML or TOML format.

About this task

Configuring the behavior of the FDO client ensures that the device can securely authenticate and receive its intended credentials and software packages during the onboarding process.

Procedure

  1. Identify the required configuration parameters. To view a comprehensive list of all available flags and options for a specific subcommand, pass the --help flag: 
    $ go-fdo-client <command> --help
  2. Create or edit a configuration file. You can use either the YAML (.yaml, .yml) or TOML (.toml) format. Ensure that any file paths defined within the configuration are either absolute or relative to your current working directory.
  3. Run the client by using a configuration file. Use the --config flag to point the client to your specific settings: 
    $ go-fdo-client <command> --config /etc/fdo/config.yaml
    Note

    The file format is automatically detected by the extension provided in the --config path.
  4. Optional: Override settings by using CLI flags. The client resolves configuration values based on a specific hierarchy. If a value is defined in multiple places, the client applies them in the following order of precedence (from highest to lowest):
    • Positional arguments: Such as the server URL for device-init.
    • CLI flags: --key or --kex.
    • Configuration file values: Settings defined in your YAML or TOML file.
    • Default values: Built-in application defaults.