-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Generate zipgateway.cfg from options passed in
When having Grizzly start zipgateway (useful for Nerves systems) we now generate the `zipgateway.cfg` file before running the binary. This is useful for device specific information like product id to be passed into the configuration. Also, this will allow for optioning out of the default scripts provided. If running in a Nerves system you can write your own scripts and put them in the `rootfs_overly` directory and provide that path to the script in the configuration. The base configuration generated when there are no options provided is the basic configuration that works in the Nerves environment.
- Loading branch information
1 parent
e0a05b7
commit e49bb00
Showing
4 changed files
with
253 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| defmodule Grizzly.ZipgatewayCfg do | ||
| @moduledoc false | ||
|
|
||
| @type t :: %__MODULE__{ | ||
| unsolicited_destination_ip6: String.t(), | ||
| unsolicited_destination_port: :inet.port_number(), | ||
| ca_cert: Path.t(), | ||
| cert: Path.t(), | ||
| priv_key: Path.t(), | ||
| eeprom_file: Path.t(), | ||
| tun_script: Path.t(), | ||
| pvs_storage_file: Path.t(), | ||
| provisioning_config_file: Path.t(), | ||
| pan_ip6: String.t(), | ||
| lan_ip6: String.t(), | ||
| lan_gw6: String.t(), | ||
| psk: String.t(), | ||
| manufacturer_id: non_neg_integer() | nil, | ||
| hardware_version: non_neg_integer() | nil, | ||
| product_id: non_neg_integer() | nil, | ||
| product_type: non_neg_integer() | nil, | ||
| serial_log: String.t() | nil | ||
| } | ||
|
|
||
| defstruct unsolicited_destination_ip6: "fd00:aaaa::2", | ||
| unsolicited_destination_port: 41230, | ||
| ca_cert: "./Portal.ca_x509.pem", | ||
| cert: "./ZIPR.x509_1024.pem", | ||
| priv_key: "./ZIPR.key_1024.pem", | ||
| eeprom_file: "/root/zipeeprom.dat", | ||
| tun_script: "./zipgateway.tun", | ||
| pvs_storage_file: "/root/provisioning_list_store.dat", | ||
| provisioning_config_file: "/etc/zipgateway_provisioning_list.cfg", | ||
| pan_ip6: "fd00:bbbb::1", | ||
| lan_ip6: "fd00:aaaa::1", | ||
| lan_gw6: "::1", | ||
| psk: "123456789012345678901234567890AA", | ||
| serial_log: nil, | ||
| product_id: nil, | ||
| product_type: nil, | ||
| hardware_version: nil, | ||
| manufacturer_id: nil | ||
|
|
||
| @doc """ | ||
| Make a new `ZipgatewayCfg.t()` from the supplied options | ||
| """ | ||
| @spec new(keyword) :: t() | ||
| def new(opts \\ []) do | ||
| opts = | ||
| Keyword.take(opts, [ | ||
| :manufacturer_id, | ||
| :hardware_version, | ||
| :product_id, | ||
| :product_type, | ||
| :serial_log, | ||
| :tun_script | ||
| ]) | ||
|
|
||
| struct(__MODULE__, opts) | ||
| end | ||
|
|
||
| @doc """ | ||
| Write the contents of the `ZipgatewayCfg.t()` to the file system | ||
| """ | ||
| @spec write(t()) :: {:ok, Path.t()} | {:error, File.posix()} | ||
| def write(cfg) do | ||
| contents = __MODULE__.to_string(cfg) | ||
| cfg_path = Path.join(System.tmp_dir(), "zipgateway.cfg") | ||
|
|
||
| case File.write(cfg_path, contents) do | ||
| :ok -> | ||
| {:ok, cfg_path} | ||
|
|
||
| {:error, _} = error -> | ||
| error | ||
| end | ||
| end | ||
|
|
||
| @doc """ | ||
| Turn the `ZipgatewayCfg.t()` into a string | ||
| """ | ||
| @spec to_string(t()) :: String.t() | ||
| def to_string(cfg) do | ||
| """ | ||
| ZipUnsolicitedDestinationIp6=#{cfg.unsolicited_destination_ip6} | ||
| ZipUnsolicitedDestinationPort=#{cfg.unsolicited_destination_port} | ||
| ZipCaCert=#{cfg.ca_cert} | ||
| ZipCert=#{cfg.cert} | ||
| ZipPrivKey=#{cfg.priv_key} | ||
| Eepromfile=#{cfg.eeprom_file} | ||
| TunScript=#{cfg.tun_script} | ||
| PVSStorageFile=#{cfg.pvs_storage_file} | ||
| ProvisioningConfigFile=#{cfg.provisioning_config_file} | ||
| ZipPanIp6=#{cfg.pan_ip6} | ||
| ZipLanIp6=#{cfg.lan_ip6} | ||
| ZipLanGw6=#{cfg.lan_gw6} | ||
| ZipPSK=#{cfg.psk} | ||
| """ | ||
| |> maybe_put_config_item(cfg, :serial_log, "SerialLog") | ||
| |> maybe_put_config_item(cfg, :product_id, "ZipProductID") | ||
| |> maybe_put_config_item(cfg, :manufacturer_id, "ZipManufacturerID") | ||
| |> maybe_put_config_item(cfg, :hardware_version, "ZipHardwareVersion") | ||
| |> maybe_put_config_item(cfg, :product_type, "ZipProductType") | ||
| end | ||
|
|
||
| defp maybe_put_config_item(config_string, cfg, field, cfg_name) do | ||
| cfg_item = Map.get(cfg, field) | ||
|
|
||
| if cfg_item != nil do | ||
| config_string <> "#{cfg_name} = #{cfg_item}\n" | ||
| else | ||
| config_string | ||
| end | ||
| end | ||
| end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| defmodule Grizzly.ZipgatewayCfgTest do | ||
| use ExUnit.Case, async: true | ||
|
|
||
| test "default config to string" do | ||
| output = """ | ||
| ZipUnsolicitedDestinationIp6=fd00:aaaa::2 | ||
| ZipUnsolicitedDestinationPort=41230 | ||
| ZipCaCert=./Portal.ca_x509.pem | ||
| ZipCert=./ZIPR.x509_1024.pem | ||
| ZipPrivKey=./ZIPR.key_1024.pem | ||
| Eepromfile=/root/zipeeprom.dat | ||
| TunScript=./zipgateway.tun | ||
| PVSStorageFile=/root/provisioning_list_store.dat | ||
| ProvisioningConfigFile=/etc/zipgateway_provisioning_list.cfg | ||
| ZipPanIp6=fd00:bbbb::1 | ||
| ZipLanIp6=fd00:aaaa::1 | ||
| ZipLanGw6=::1 | ||
| ZipPSK=123456789012345678901234567890AA | ||
| """ | ||
|
|
||
| cfg = Grizzly.ZipgatewayCfg.new() | ||
|
|
||
| assert output == Grizzly.ZipgatewayCfg.to_string(cfg) | ||
| end | ||
|
|
||
| test "when options are added as string" do | ||
| output = """ | ||
| ZipUnsolicitedDestinationIp6=fd00:aaaa::2 | ||
| ZipUnsolicitedDestinationPort=41230 | ||
| ZipCaCert=./Portal.ca_x509.pem | ||
| ZipCert=./ZIPR.x509_1024.pem | ||
| ZipPrivKey=./ZIPR.key_1024.pem | ||
| Eepromfile=/root/zipeeprom.dat | ||
| TunScript=./zipgateway.tun | ||
| PVSStorageFile=/root/provisioning_list_store.dat | ||
| ProvisioningConfigFile=/etc/zipgateway_provisioning_list.cfg | ||
| ZipPanIp6=fd00:bbbb::1 | ||
| ZipLanIp6=fd00:aaaa::1 | ||
| ZipLanGw6=::1 | ||
| ZipPSK=123456789012345678901234567890AA | ||
| ZipProductID = 1 | ||
| """ | ||
|
|
||
| cfg = Grizzly.ZipgatewayCfg.new(product_id: 1) | ||
|
|
||
| assert output == Grizzly.ZipgatewayCfg.to_string(cfg) | ||
| end | ||
|
|
||
| test "write the cfg file to the system" do | ||
| cfg = Grizzly.ZipgatewayCfg.new() | ||
|
|
||
| expected_contents = """ | ||
| ZipUnsolicitedDestinationIp6=fd00:aaaa::2 | ||
| ZipUnsolicitedDestinationPort=41230 | ||
| ZipCaCert=./Portal.ca_x509.pem | ||
| ZipCert=./ZIPR.x509_1024.pem | ||
| ZipPrivKey=./ZIPR.key_1024.pem | ||
| Eepromfile=/root/zipeeprom.dat | ||
| TunScript=./zipgateway.tun | ||
| PVSStorageFile=/root/provisioning_list_store.dat | ||
| ProvisioningConfigFile=/etc/zipgateway_provisioning_list.cfg | ||
| ZipPanIp6=fd00:bbbb::1 | ||
| ZipLanIp6=fd00:aaaa::1 | ||
| ZipLanGw6=::1 | ||
| ZipPSK=123456789012345678901234567890AA | ||
| """ | ||
|
|
||
| assert {:ok, cfg_file_path} = Grizzly.ZipgatewayCfg.write(cfg) | ||
|
|
||
| assert expected_contents == File.read!(cfg_file_path) | ||
|
|
||
| :ok = File.rm!(cfg_file_path) | ||
| end | ||
| end |