rails_kms_credentials 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75b923804031caddd3be015d207c02cdb9758d2dc98ebe527ee5ecd163823478
-  data.tar.gz: 98fef79cee6c7910b8e665de1c99ce886159b4c903095321e751f0e1339e801d
+  metadata.gz: 44bc978f5ac247ec65a51df713cc84366e80c7ae27dcfe2e5c13f29eef1761f3
+  data.tar.gz: b91a33f301098c11373a5d9fa8516f53ac93c3799fc9ec94348d6bb9c6c49881
 SHA512:
-  metadata.gz: 14f001897a77ad3664c9125a493992ec2586ee467e2b15c39beaa4ece0685ea29e2ed7281dc8258a17768884431f2dac8e38c0c630ea3ef7b92d1be28cebcbcf
-  data.tar.gz: 257fddec2f37904ef64e578a1bb93e57c8573cf3dee5749fcac565801a79edd2d417669a6b979de3b76ed72618c6aa5da049212d37d3b08829b32126384766ac
+  metadata.gz: 50fd05f387be1c04f35098e771f37ec22f78ca52ea2cd06ac74221a4196ee43a34c4426df9064245edf584ed75a3f666bef3c1f67731e247e352ecd815f4f4b2
+  data.tar.gz: b5a23437fd1ddfa0f13783a6fb2ccee860f7f4b0a89cfcb37073c1ac34af1ff267a4706fe1f45ed69e17b484dcfcabf2814813f6a47993211f731dc0d72b11be

data/README.md

@@ -1 +1,65 @@
 # rails-kms-credentials
+
+This gem expands the capabilities of `Rails.application.credentials` to support fetching the credentials from a Key Management System.
+
+## Configuration
+This gem will read `config/kms_credentials.yml` using `Rails.application.config_for`.
+
+Key | Description
+---|---
+`store` | [Stores](#stores) The Key Managedment System to use.
+
+## Stores
+
+Key Management System | Config Value
+---|---
+[Azure Key Vault](#azure-key-vault) | `azure_key_vault`
+
+### Azure Key Vault
+Credentials will be loaded from a Key Vault's Secrets.
+
+All hyphens (`-`) in a secret name will be replaced with underscores (`_`) when put into credentials (ex. `foo-bar` -> `foo_bar`).
+
+Credentials can be nested by separating the parent key from the child key with `--` (ex. secret `foo--bar--baz` with a value of `test` will become `{foo: {bar: {baz: "test"}}}`.
+
+Since Secrets cannot be empty in Azure Key Vault, if you need a key to show up in credentials, but need its value to be empty, then set the Secret's value to `--EMPTY--`.
+
+#### Config
+Key | Description
+---|---
+`vault` | The name of the Key Vault
+`client` | Client specific configuration. See [Client Types](#client-types).
+`client.type` | The [Client Type](#client-types) to use.
+`client.secret_prefix` | The prefix that all secrets for this application will have. See [Secret Prefix](#secret-prefix).
+
+#### Secret Prefix
+The prefix along with `----` will be added to the beginning of the secret name (ex. `prefix: abc123` -> `abc123----some-secret`)
+
+#### Client Types
+
+How to connect/authenticate to Azure Ket Vault.
+
+Client | `client.type`
+---|---
+[Managed Identity](#managed-identity) | `managed_identity`
+[Client Credentials](#client-credentials) | `client_credentials`
+
+
+##### Managed Identity
+This is the client to use when running on an [Azure VM](https://learn.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/how-to-use-vm-token).
+
+**Config:**
+Key | Description
+---|---
+`client.type` | `managed_identity`
+
+
+##### Client Credentials
+This is the client to use when connecting from outside of Azure. [See here](https://learn.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow).
+
+**Config**
+Key | Description
+---|---
+`client.tenant_id` | The directory tenant the application plans to operate against, in GUID or domain-name format.
+`client.client_id` | The application ID that's assigned to your app. You can find this information in the portal where you registered your app.
+`client.client_secret` | The client secret that you generated for your app in the app registration portal.

data/lib/rails_kms_credentials/railtie.rb

@@ -4,9 +4,5 @@ module RailsKmsCredentials
   class Railtie < Rails::Railtie
     railtie_name :rails_kms_credentials
 
-    rake_tasks do
-      load 'tasks/credentials.rake'
-    end
-
   end
 end

data/lib/rails_kms_credentials/version.rb

@@ -4,8 +4,8 @@ module RailsKmsCredentials
 
   module Version
     MAJOR = 0
-    MINOR = 0
-    PATCH = 3
+    MINOR = 1
+    PATCH = 0
 
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_kms_credentials
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Taylor Yelverton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-02 00:00:00.000000000 Z
+date: 2022-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -72,7 +72,6 @@ files:
 - lib/rails_kms_credentials/store/azure_key_vault/client/managed_identity.rb
 - lib/rails_kms_credentials/store/base.rb
 - lib/rails_kms_credentials/version.rb
-- lib/tasks/credentials.rake
 - rails_kms_credentials.gemspec
 homepage: https://github.com/ComplyMD/rails_kms_credentials
 licenses:

data/lib/tasks/credentials.rake

@@ -1,8 +0,0 @@
-namespace :kms_creds do
-  task :show, [:environment] do |_, args|
-  end
-
-  task :edit, [:environment] do |_, args|
-    ENV['EDITOR'] += ' --wait' if ENV['EDITOR'].present? && (ENV['EDITOR'] == 'code' || ENV['EDITOR'].ends_with?('/code')) # Stupid fix for vscode exiting too quickly
-  end
-end