secret_config 0.6.4 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a86408c0a69f9e1c3e67a06d004c659abe13f7b482a3ff11e8de6b99c650d05
-  data.tar.gz: cd16668968bf171809b47b2c3b749de2ef63a7fb91245cdf68bac253aeb5639b
+  metadata.gz: f21043b5cb86e83686e3e3cdb920c39bdd21c6c8e8dcfbd2d1cc34f81aef8e8c
+  data.tar.gz: d932bca14ac864d3558e825ae226f227da60af5abe53f81dc601b05c2c51bfde
 SHA512:
-  metadata.gz: b71279e1a7855b8e081239f3eea1bf05c3c6edc5e4226e8e31e347667480156c493f87443d09bc060a2829a7cd87ab1acdcba9e0cad9811c634355b4944ecea7
-  data.tar.gz: ce127ef03fa642011deb394e3f3cd3de94e8d4ace3de712dbc218dd080ed4ea03ce2ff06c8ee35d32e2b06765e08c93a92cf2066ca072e4d16380e52d2d58504
+  metadata.gz: d72ec54655bab806b3c1c7243fc033e529924f0024cae1c2f604904b3ea620e833e36744a1dfbbe8bb1b2d0c6d5fc0b644bb7477f7978c186fcbdca795596fb9
+  data.tar.gz: cf24dc349803e4bd328fe471b0bcec0cd1f94b5b94b0261db990f4acab975494497b31044807f1fe87ba9d2ff5bb408db1674cedafad6676200c3de0904bc158

data/README.md

@@ -5,6 +5,21 @@ Centralized Configuration and Secrets Management for Ruby and Rails applications
 
 Securely store configuration information centrally, supporting multiple tenants of the same application.
 
+## v0.9 Upgrade Notes
+
+Note that the command line program name has changed from `secret_config` to `secret-config`. 
+Be careful that the arguments have also changed. The arguments are now consistent across operations.
+The command line examples below have also been updated to reflect the changes. 
+ 
+Please run `secret-config --help` to see the new arguments and updated operations.  
+
+## Overview
+
+Securely store centralized configuration information such as:
+* Settings
+* Passwords
+* Encryption keys and certificates
+
 ## Features
 
 Supports storing configuration information in:
@@ -13,7 +28,21 @@ Supports storing configuration information in:
 * Environment Variables
     * Environment Variables take precedence and can be used to override any setting.
 * AWS System Manager Parameter Store
-    * Encrypt and securely store secrets such as passwords centrally. 
+    * Encrypt and securely store secrets such as passwords centrally.
+
+Since all values are stored as strings in the central directory or config file, the following type conversions 
+are supported:
+* integer
+* float
+* string
+* boolean
+* symbol
+* json
+
+Supported conversions:
+* base64
+
+Arrays are also supported when the value contains a known separator by which to break down the values.
 
 ## Benefits
 
@@ -23,7 +52,7 @@ Benefits of moving sensitive configuration information into AWS System Manager P
     * Environment variables force all config into a single level.
   * Reduces the number of environment variables.
     * In a large application the number of secrets can grow dramatically.
-  * Removes the need to encrypt sensitive data config files.
+  * Replaces sensitive data stored in local yaml or configuration files.
     * Including securing and managing encryption keys.
   * When encryption keys change, such as during a key rotation, config files don't have to be changed.
   * Removes security concerns with placing passwords in the clear into environment variables.
@@ -34,10 +63,10 @@ Benefits of moving sensitive configuration information into AWS System Manager P
   * Configure multiple distinct application instances to support multiple tenants.
     * For example, use separate databases with unique credentials for each tenant.
   * Separation of responsibilities is achieved since operations can manage production configuration.
-    * Developers do not need to be involved with production configuration such as host names and passwords.      
-  * All values are encrypted by default when stored in the AWS Parameter Store. 
+    * Developers do not need to be involved with production configuration such as host names and passwords.
+  * All values are encrypted by default when stored in the AWS Parameter Store.
     * Prevents accidentally not encrypting sensitive data.
-  
+
 ## Introduction
 
 When Secret Config starts up it reads all configuration entries into memory for all keys under the configured path.
@@ -49,7 +78,7 @@ via a process signal, or by calling it through an event, or via a messaging syst
 It is suggested that any programmatic lookup to values stored in Secret Config are called every time a value is
 being used, rather than creating a local copy of the value. This ensures that a refresh of the registry will take effect
 immediately for any code reading from Secret Config.
-  
+
 ## API
 
 When Secret Config starts up it reads all configuration entries immediately for all keys under the configured path.
@@ -65,7 +94,7 @@ Fetch the value for the supplied key, returning nil if not found:
 # Key is present:
 SecretConfig["logger/level"]
 # => "info"
-  
+
 # Key is missing:
 SecretConfig["logger/blah"]
 # => nil
@@ -77,7 +106,7 @@ Fetch the value for the supplied key, raising `SecretConfig::MissingMandatoryKey
 # Key is present:
 SecretConfig.fetch("logger/level")
 # => "info"
-  
+
 # Key is missing:
 SecretConfig.fetch("logger/blah")
 # => SecretConfig::MissingMandatoryKey (Missing configuration value for /development/logger/blah)
@@ -90,7 +119,7 @@ SecretConfig.fetch("logger/level", default: "info")
 # => "info"
 ~~~
 
-Since AWS SSM Parameter store and environment variables only support string values, 
+Since AWS SSM Parameter store and environment variables only support string values,
 it is neccessary to convert the string back to the type required by the program.
 
 The following types are supported:
@@ -111,6 +140,20 @@ SecretConfig.fetch("symmetric_encryption/version", type: :integer)
 # => 0
 ~~~
 
+Sometimes it is useful to store arrays of values as a single key.  
+
+~~~ruby
+# Example: A list of host names could be stored as: "primary.example.net,secondary.example.net,backup.example.net"
+# To extract it as an array of strings: 
+SecretConfig.fetch("address_services/hostnames", separator: ",")
+# => ["primary.example.net", "secondary.example.net", "backup.example.net"]
+
+# Example: A list of ports could be stored as: "12345,5343,26815"
+# To extract it as an array of Integers: 
+SecretConfig.fetch("address_services/ports", type: :integer, separator: ",")
+# => [12345, 5343, 26815]
+~~~
+
 When storing binary data, it should be encoded with strict base64 encoding. To automatically convert it back to binary
 specify the encoding as `:base64`
 
@@ -118,7 +161,7 @@ specify the encoding as `:base64`
 # Return a value that was stored in Base64 encoding format:
 SecretConfig.fetch("symmetric_encryption/iv")
 # => "FW+/wLubAYM+ZU0bWQj59Q=="
-  
+
 # Base64 decode a value that was stored in Base64 encoding format:
 SecretConfig.fetch("symmetric_encryption/iv", encoding: :base64)
 # => "\x15o\xBF\xC0\xBB\x9B\x01\x83>eM\eY\b\xF9\xF5"
@@ -162,7 +205,7 @@ SecretConfig.refresh!
 ~~~
 
 Example, refresh the registry any time a SIGUSR2 is raised, add the following code on startup:
-      
+
 ~~~ruby
 Signal.trap('USR2') do
   SecretConfig.refresh!
@@ -179,7 +222,7 @@ Where `1234` above is the process PID.
 ## Development and Test use
 
 In the development environment create the file `config/application.yml` within which to store local development credentials.
-Depending on your team setup you may want to use the same file for all developers so can check it into you change control system. 
+Depending on your team setup you may want to use the same file for all developers so can check it into you change control system.
 
 For example: `config/application.yml`
 
@@ -222,7 +265,7 @@ Note: Do not put any production credentials into this file.
 
 ### Environment Variables
 
-Any of the above values can be overridden with an environment variable.
+Any of the above values can be overridden with an environment variable, unless explicitly configured `SecretConfig.check_env_var = false`.
 
 To overwrite any of these settings with an environment variable:
 
@@ -319,7 +362,7 @@ Then the application that uses the above library / gem just needs to add the rel
 
 ~~~yaml
 http_client:
-  url:          https://test.example.com  
+  url:          https://test.example.com
   pool_size:    20
   read_timeout: 300
 ~~~
@@ -328,7 +371,7 @@ This avoids a custom config file just for the above library.
 
 Additionally the values can be overridden with environment variables at any time:
 
-    export HTTP_CLIENT_URL=https://production.example.com  
+    export HTTP_CLIENT_URL=https://production.example.com
 
 ## Configuration
 
@@ -339,15 +382,15 @@ Add the following line to Gemfile
 Out of the box Secret Config will look in the local file system for the file `config/application.yml`
 as covered above. By default it will use env var `RAILS_ENV` to define the path to look under for settings.
 
-The default settings are great for getting started in development and test, but should not be used in production. 
+The default settings are great for getting started in development and test, but should not be used in production.
 
 To ensure Secret Config is configured and available for use within any of the config files, add
-the following lines to the very top of `application.rb` under the line `class Application < Rails::Application`: 
+the following lines to the very top of `application.rb` under the line `class Application < Rails::Application`:
 
 ~~~ruby
 module MyApp
   class Application < Rails::Application
-  
+
     # Add the following lines to configure Secret Config:
     if Rails.env.development? || Rails.env.test?
       # Use 'config/application.yml'
@@ -355,8 +398,8 @@ module MyApp
     else
       # Read configuration from AWS SSM Parameter Store
       config.secret_config.use :ssm, path: "/#{Rails.env}/my_app"
-    end    
-    
+    end
+
     # ....
   end
 end
@@ -370,7 +413,7 @@ By placing the secret config configuration as the very first configuration item,
 configuration item to access the centralized configuration in AWS System Manager Parameter Store.
 
 The environment variable `SECRET_CONFIG_PROVIDER` can be used to override the provider when needed.
-For example: 
+For example:
     `export SECRET_CONFIG_PROVIDER=ssm`
 Or,
     `export SECRET_CONFIG_PROVIDER=file`
@@ -380,31 +423,31 @@ multiple paths. For example:
 
     /production1/my_application
     /production2/my_application
-    
+
     /production/instance1/my_application
     /production/instance2/my_application
-    
+
 The `path` is completely flexible, but must be unique for every AWS account under which the application will run.
 The same `path` can be used in different AWS accounts though. It is also not replicated across regions.
 
-When writing settings to the parameter store, it is recommended to use a custom KMS key to encrypt the values.
-To supply the key to encrypt the values with, add the `key_id` parameter: 
+When writing settings to the parameter store, it is recommended to use a custom KMS key to encrypt the values, if you don't specify a key ID, the system uses the default key associated with your AWS account `alias/aws/ssm`.
+To supply the key to encrypt the values with, add the `key_id` parameter:
 
 ~~~ruby
 module MyApp
   class Application < Rails::Application
-  
+
     # Add the following lines to configure Secret Config:
     if Rails.env.development? || Rails.env.test?
       # Use 'config/application.yml'
       config.secret_config.use :file
     else
       # Read configuration from AWS SSM Parameter Store
-      config.secret_config.use :ssm, 
+      config.secret_config.use :ssm,
         path: "/#{Rails.env}/my_app",
         key_id: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
-    end    
-    
+    end
+
     # ....
   end
 end
@@ -412,8 +455,33 @@ end
 
 Note: The relevant KMS key must be created first prior to using it here.
 
-The `key_id` is only used when writing settings to the AWS Parameter store and can be left off when that instance
-will only read from the parameter store.
+`ssm` provider supports various configuration parameters that can be provided as keyword arguments for `config.secret_config.use :ssm, path, **args`
+
+Args hash:
+* **:key_id** (String) - The `key_id` is only used when writing settings to the AWS Parameter store and can be left off when that instance will only read from the parameter store. Can be configred with environment variable `SECRET_CONFIG_KEY_ID`.
+* **:retry_count** (Integer, default=10) - Max number of retries in case of execution failure.
+* **:retry_max_ms** (Integer, default=3_000) - Interval in ms between retries, `sleep` is used to facilitate throttling.
+* any options suported by [Aws::SSM::Client](https://docs.aws.amazon.com/sdkforruby/api/Aws/SSM/Client.html#initialize-instance_method) e.g. **:credentials**:
+~~~ruby
+  config.secret_config.use :ssm,
+    path: "/#{Rails.env}/my_app",
+    key_id: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+    credentials: Aws::AssumeRoleCredentials.new(
+      role_arn:          "arn:aws:iam::111111122222222:role/assume_role_name",
+      role_session_name: "session-name-to-identify-#{SecureRandom.uuid}"
+    ))
+~~~
+
+### Secret Config Environment variables
+
+Priority describes when environment variable is used as a default value, preceds configuration value or overrides.
+
+ Name                      | Desctiption                                                     | Priority
+ ------------------------- | --------------------------------------------------------------- | --------
+ `SECRET_CONFIG_PATH`      | path from which the configuration data will be read             | precede
+ `SECRET_CONFIG_PROVIDER`  | override the provider configured for `config.secret_config.use` | override
+ `SECRET_CONFIG_KEY_ID`    | encryption `key_id`                                             | default
+ `SECRET_CONFIG_ACCOUNT_ID`| used in `rspec` to configure AWS Account Id for role assuming   | required
 
 ### Shared configuration for development and test
 
@@ -423,7 +491,7 @@ configuration file `application.yml` can be shared. Update the lines above to:
 ~~~ruby
 module MyApp
   class Application < Rails::Application
-  
+
     # Add the following lines:
     if Rails.env.development? || Rails.env.test?
       # Use 'config/application.yml'
@@ -431,8 +499,8 @@ module MyApp
     else
       # Read configuration from AWS SSM Parameter Store
       config.secret_config.use :ssm, path: "/#{Rails.env}/my_app"
-    end    
-    
+    end
+
     # ....
   end
 end
@@ -471,25 +539,74 @@ to view and modify parameters:
 - `ssm:GetParameters`
 - `ssm:GetParameter`
 
+## String Interpolation
+
+Values supplied for config settings can be replaced inline with date, time, hostname, pid and random values.
+
+For example to include the `hostname` in the log file name setting:
+
+~~~yaml
+development:
+  logger:
+    level:     info
+    file_name: /var/log/my_application_%{hostname}.log
+~~~
+
+Available interpolations:
+
+* %{date}
+    * Current date in the format of "%Y%m%d" (CCYYMMDD)
+* %{date:format}
+    * Current date in the supplied format. See strftime
+* %{time}
+    * Current date and time down to ms in the format of "%Y%m%d%Y%H%M%S%L" (CCYYMMDDHHMMSSmmm)
+* %{time:format}
+    * Current date and time in the supplied format. See strftime
+* %{env:name}
+    * Extract value from the named environment variable.
+* %{hostname}
+    * Full name of this host.
+* %{hostname:short}
+    * Short name of this host. Everything up to the first period.
+* %{pid}
+    * Process Id for this process.
+* %{random}
+    * URL safe Random 32 byte value.
+* %{random:size}
+    * URL safe Random value of `size` bytes.
+
+#### Notes:
+
+* To prevent interpolation use %%{...}
+* %% is not touched, only %{...} is searched for.
+* Since these interpolations are only evaluated at load time and
+  every time the registry is refreshed there is no runtime overhead when keys are fetched.
+
 ## Command Line Interface
 
 Secret Config has a command line interface for exporting, importing and copying between paths in the registry.
 
 ~~~
-secret_config [options]
-    -e, --export [FILE_NAME]         Export configuration to a file or stdout if no file_name supplied.
-    -i, --import [FILE_NAME]         Import configuration from a file or stdin if no file_name supplied.
-    -C, --copy SOURCE_PATH           Import configuration from a file or stdin if no file_name supplied.
-    -D, --diff [FILE_NAME]           Compare configuration from a file or stdin if no file_name supplied.
+secret-config [options]
+    -e, --export SOURCE_PATH         Export configuration. Use --file to specify the file name, otherwise stdout is used.
+    -i, --import TARGET_PATH         Import configuration. Use --file to specify the file name, --path for the SOURCE_PATH, otherwise stdin is used.
+        --file FILE_NAME             Import/Export/Diff to/from this file.
+    -p, --path PATH                  Import/Export/Diff to/from this path.
+        --diff TARGET_PATH           Compare configuration to this path. Use --file to specify the source file name, --path for the SOURCE_PATH, otherwise stdin is used.
+    -s, --set KEY=VALUE              Set one key to value. Example: --set mysql/database=localhost
+    -f, --fetch KEY                  Fetch the value for one setting. Example: --fetch mysql/database.
+    -d, --delete KEY                 Delete one specific key.
+    -r, --delete-tree PATH           Recursively delete all keys under the specified path.
     -c, --console                    Start interactive console.
-    -p, --path PATH                  Path to import from / export to.
-    -P, --provider PROVIDER          Provider to use. [ssm | file]. Default: ssm
-    -U, --no-filter                  Do not filter passwords and keys.
-    -d, --prune                      During import delete all existing keys for which there is no key in the import file.
-    -k, --key_id KEY_ID              AWS KMS Key id or Key Alias to use when importing configuration values. Default: AWS Default key.
-    -r, --region REGION              AWS Region to use. Default: AWS_REGION env var.
-    -R, --random_size INTEGER        Size to use when generating random values. Whenever $random is encountered during an import. Default: 32
-    -v, --version                    Display Symmetric Encryption version.
+        --provider PROVIDER          Provider to use. [ssm | file]. Default: ssm
+        --no-filter                  For --export only. Do not filter passwords and keys.
+        --interpolate                For --export only. Evaluate string interpolation and __import__.
+        --prune                      For --import only. During import delete all existing keys for which there is no key in the import file. Only works with --import.
+        --force                      For --import only. Overwrite all values, not just the changed ones. Useful for changing the KMS key.
+        --key_id KEY_ID              For --import only. Encrypt config settings with this AWS KMS key id. Default: AWS Default key.
+        --key_alias KEY_ALIAS        For --import only. Encrypt config settings with this AWS KMS alias.
+        --random_size INTEGER        For --import only. Size to use when generating random values when $(random) is encountered in the source. Default: 32
+    -v, --version                    Display Secret Config version.
     -h, --help                       Prints this help.
 ~~~
 
@@ -521,18 +638,22 @@ secrets:
 
 Import a yaml file, into a path in AWS SSM Parameter Store:
 
-    secret_config --import production.yml --path /production/my_application
+    secret-config --import /production/my_application --file production.yml
 
 Import a yaml file, into a path in AWS SSM Parameter Store, using a custom KMS key to encrypt the values:
 
-    secret_config --import production.yml --path /production/my_application --key_id "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+    secret-config --import /production/my_application --file production.yml --key_id "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+
+Import a yaml file, into a path in AWS SSM Parameter Store, using a custom KMS key alias to encrypt the values:
+
+    secret-config --import /production/my_application --file production.yml --key_alias my_key_alias
 
 #### Diff
 
 Before importing a new config file into the AWS SSM Parameter store, a diff can be performed to determine
 what the differences are that will be applied when the import is run with the `--prune` option.
 
-    secret_config --diff production.yml --path /production/my_application
+    secret-config --diff /production/my_application --file production.yml 
 
 Key:
 
@@ -542,20 +663,20 @@ Key:
 
 #### Export SSM parameters
 
-In AWS SSM Parameter store it can be difficult to 
+In AWS SSM Parameter store it can be difficult to
 Export the values from a specific path into a yaml or json file so that they are easier to read.
 
 Export from a path in AWS SSM Parameter Store to a yaml file, where passwords are filtered:
 
-    secret_config --export production.yml --path /production/my_application
+    secret-config --export /production/my_application --file production.yml 
 
 Export from a path in AWS SSM Parameter Store to a yaml file, _without_ filtering out passwords:
 
-    secret_config --export production.yml --path /production/my_application --no-filter
+    secret-config --export /production/my_application --file production.yml --no-filter
 
 Export from a path in AWS SSM Parameter Store to a json file, where passwords are filtered:
 
-    secret_config --export production.json --path /production/my_application
+    secret-config --export /production/my_application --file production.json 
 
 #### Copy values between paths in AWS SSM parameter store
 
@@ -563,18 +684,18 @@ It can be useful to keep a "master" copy of the values for an environment or sta
 in AWS Parameter Store. Then for each stack or environment that is spun up, copy the "master" / "common" values
 into the new path. Once copied the values specific to that path can be updated accordingly.
 
-Copy configuration from one path in AWS SSM Parameter Store to another path in AWS SSM Parameter Store:
+Import configuration from an existing path in AWS SSM Parameter Store into another:
 
-    secret_config --copy /production/my_application --path /tenant73/my_application
+    secret-config --import /tenant73/my_application --path /production/my_application 
 
 #### Generating random passwords
 
 In the multi-tenant example above, we may want to generate a secure random password for each tenant.
-In the source file or registry, set the value to `$random`, this will ensure that during the `import` or `copy`
-that the destination will receive a secure random value. 
+In the source file or registry, set the value to `$random`, this will ensure that during the `import`
+that the destination will receive a secure random value.
 
-By default the length of the randomized value is 32 bytes, use `--random_size` to adjust the length of 
-the randomized string. 
+By default the length of the randomized value is 32 bytes, use `--random_size` to adjust the length of
+the randomized string.
 
 ## Docker
 
@@ -585,7 +706,7 @@ any changes. The only difference being the path that container uses to read its
 Another important benefit is that the docker image does not contain any production or test credentials since
 these are all stored in AWS SSM Parameter Store.
 
-When a Ruby / Rails application is using Secret Config for its configuration settings, it only requires the 
+When a Ruby / Rails application is using Secret Config for its configuration settings, it only requires the
 following environment variables when starting up the container in for example AWS ECS or AWS Fargate:
 
 ~~~shell
@@ -635,14 +756,14 @@ end
 Specifically for docker containers it is necessary to turn off file logging and turn on logging to standard out
 so that AWS Cloud Watch can pick up the log data.
 
-To start with `logger/destination` of `stdout` will work with regular non-colorized output. When feeding the 
+To start with `logger/destination` of `stdout` will work with regular non-colorized output. When feeding the
 log output into something that can process JSON, set `logger/formatter` to `json`.
 
 The benefit with the above approach is that a developer can pull the exact same container image that is running
 in production and configure it to run locally on their laptop. For example, set `logger/destination` to `file`.
 
 The above code can be modified as necessary to add any Semantic Logger appender to write directly to external
-centralized logging systems, instead of writing to standard out or local files. 
+centralized logging systems, instead of writing to standard out or local files.
 
 ### Email Server and Assets
 
@@ -687,7 +808,7 @@ end
 Using this approach the file `config/symmetric-encryption.yml` can be removed once the keys have been moved to
 the registry.
 
-To extract existing keys from the config file so that they can be imported into the registry, 
+To extract existing keys from the config file so that they can be imported into the registry,
 run the code below inside a console in each of the respective environments.
 
 ~~~ruby