README.md

Identity::Hostdata (identity-hostdata)

A gem to help read configuration from login.gov infrastructure, according to the login.gov infrastructure contract.

Installation

Add this line to your application's Gemfile:

gem 'identity-hostdata', github: '18F/identity-hostdata'

Usage

Use this gem to access config data on a per-host basis. The config data is read according to the login.gov infrastructure contract.

require 'identity/hostdata'

Identity::Hostdata.domain
# => "login.gov"

Set configs from YML files in S3 or Secrets Manager

Identity::Hostdata.load_config!(
  app_root: Rails.root,
  rails_env: Rails.env
) do |builder|
  # YML
  builder.add(:some_option, type: :string)
  builder.add(:other_option, type: :json)

  # Secrets Manager
  builder.add(:prop_name, secrets_manager_name: 'secrets-manager-name', type: :string)
  builder.add(
    :other_prop,
    secrets_manager_name: "secrets-manager-dynamic-#{Identity::Hostdata.env || 'local'}",
    type: :string,
  )

  # custom parsing of values
  builder.add(:other_prop_name, type: :string) do |raw|
    JSON.parse(raw)['nested-key']
  end
end

Identity::Hostdata.config.some_option
# => "value"

Download configs from S3:

root = File.expand_path('../../', __FILE__)

Identity::Hostdata.in_datacenter do |hostdata|
  # Download the config and write to disk
  hostdata.app_secrets_s3.download_file(
    s3_path: '/%{env}/v1/idp/database.yml',
    local_path: File.join(root, 'config/database_s3.yml')
  )
  # Read the config into the `cert` var
  cert = hostdata.secrets_s3.read_file('/%{env}/oidc.cert')
end

Development

Run tests:

make test

Contributing

See CONTRIBUTING for additional information.

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.