sanctum 0.8.5.rc2 → 0.8.5.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dc55aef33e0ba6113e5577b80799818e64a8953d0643d6b029335b84a5edc23
-  data.tar.gz: 52638d7d39ccb21cb830288081d9ca23017e3582e991603ec8f084175f0f3034
+  metadata.gz: b9644d3be1fdfcdd2e01ea42a1a0abd2e695bd3b2e9fe156083b10f64fb61540
+  data.tar.gz: 6b467122d7066368cf662a37c00f7d9bad88e7c4e1d9aabbb7dc12d54fed70cc
 SHA512:
-  metadata.gz: 475976714b4229cd2e9a4dce401ed6aada1decbb2da6e73f55e7de3ba95e8ea17ef0aa0e4b84be9225713d8cacfe2260236b75cc75e21d396bcb6d63403463f5
-  data.tar.gz: 16b9465d78eeceb1580c8203eb8c21096d6a398d3b2c6c023f8c4e68bbfbe698c21be2cc9f52daf81175d35706f2a95b89a07214ccba1f4dde38ed7ef4303e8e
+  metadata.gz: 4b8f3ecbae4f6085c442ff12aa87560d884016a1bae709e7110a6a766d53b133986b148ccb69772acf2d3eb2ddba77c26a0305e41992f5e319ad4a485fe666ee
+  data.tar.gz: 9f081fb88da05525f0666a05994a2299136e1f52c37d2979607849dd4db752cb71e15802ac3cdbfeffc515c6f57aba73a1d91c7c32fa8e703f4d667bca0abbd0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sanctum (0.8.5.rc2)
+    sanctum (0.8.5.rc3)
       gli (~> 2.18)
       hashdiff (~> 0.3)
       vault (~> 0.12)

data/README.md

@@ -4,7 +4,11 @@ Local files are encrypted using vaults [transit](https://www.vaultproject.io/api
 This makes maintaining multiple vault secrets for multiple applications simple and secure.
 
 ## Usage Example
-Lets say you have a vault instance with a `generic`, or `kv` enabled backend.
+
+### Generic/KV API v1
+**NOTE: If you just starting to use sanctum, and or vault, you should be using API v2 For more info see, [Vault kv v2](https://www.vaultproject.io/docs/secrets/kv/kv-v2.html), or [Vault kv v1](https://www.vaultproject.io/docs/secrets/kv/kv-v1.html)**
+
+Lets say you have a vault instance with a `generic`, or `kv v1` enabled backend.
 if you were to run, `vault read secrets/cool-app/dev/env` you would see something similar to
 
 ```
@@ -23,6 +27,37 @@ using the sanctum gem, you could run `sanctum pull`. Depending on the path you s
 `env` would contain a `transit` encrypted base64 encoded blob, which you could then edit with `sanctum edit <path-specified>/cool-app/dev/env`. You could then push any changes with
 `sanctum push`.
 
+### KV API v2
+**NOTE: V2 API adds `/data` and `/metadata` endpoints as such sanctum will automatically add `/data` to your local path in order to reflect the endpoints see [Vault kv v2](https://www.vaultproject.io/docs/secrets/kv/kv-v2.html)**
+
+Lets say you have a vault instance with `kv v2`  enabled backend.
+if you were to run, `vault kv secrets/cool-app/dev/env` you may see something similar to
+
+```
+====== Metadata ======
+Key              Value
+---              -----
+created_time     2019-02-17T00:58:51.194452314Z
+deletion_time    n/a
+destroyed        false
+version          1
+
+======= Data =======
+Key            Value
+---            -----
+db_password    heydudeihaveacoolapp
+token          myrandomtoken
+
+```
+
+using the sanctum gem, you could run `sanctum pull`. Depending on the path you specified in the `sanctum.yaml` config file; Your local file system would look similar to
+```
+<path-specified>/data/cool-app/dev/env
+```
+
+`env` would contain a `transit` encrypted base64 encoded blob, which you could then edit with `sanctum edit <path-specified>/data/cool-app/dev/env`. You could then push any changes with
+`sanctum push`.
+
 ## Installation
 
 From source:
@@ -42,7 +77,7 @@ sanctum config - Generate an example config file.
 sanctum create - Create an encrypted local file.
 sanctum edit   - Edit an encrypted local file.
 sanctum view   - View an encrypted local file.
-sanctum update - Update secrets backend to v2 api.
+sanctum update - Update secrets backend to v2 API.
 ```
 
 
@@ -81,8 +116,8 @@ The configuration file is a Hash represented in YAML format with three possible
   * At lease one application/target definition is required.
 
 ## Roadmap
-* <strike>Add vault v2 api support</strike>
-* <strike>Add upgrade option for v2 api</strike>
+* <strike>Add vault v2 API support</strike>
+* <strike>Add upgrade option for v2 API</strike>
 * If transit key doesn't exist try to create it(automatically)
 * If secrets mount doesn't exist try to create it(automatically)
 * <strike>Better/more Tests</strike>

data/lib/sanctum/command/base.rb

@@ -17,8 +17,14 @@ module Sanctum
         @args = args
 
         @transit_key = options.fetch(:vault).fetch(:transit_key)
-        # TODO: Fix, to much is happening to targets in this initializer!
-        @targets = update_prefix_or_path(set_secrets_version(options.fetch(:sync)))
+        # TODO: Fix, way to much is happening to targets in this initializer!
+        @targets = update_prefix_or_path(
+          set_secrets_version(
+            remove_trailing_slash(
+              options.fetch(:sync)
+            )
+          )
+        )
         @config_file = options.fetch(:config_file)
       end
 
@@ -46,19 +52,23 @@ module Sanctum
         mounts_hash = mounts_info
 
         targets.each do |h|
-          next if h.key?(:secrets_version)
+          if h.key?(:secrets_version)
+            # Ensure value is a string
+            h[:secrets_version] = h[:secrets_version].to_s
+            next
+          end
 
           # If mount options is nil default to api version 1 otherwise use version value
           # generic mounts will not have a version specified
           if mounts_hash.dig(:data, :secret, "#{h[:prefix]}/".to_sym, :options).nil?
             h[:secrets_version] = "1"
           else
-            h[:secrets_version] = mounts_hash.dig(:data, :secret, "#{h[:prefix]}/".to_sym, :options, :version)
+            h[:secrets_version] = mounts_hash.dig(:data, :secret, "#{h[:prefix]}/".to_sym, :options, :version).to_s
           end
         end
       end
 
-      # Internal, add /data to prefix or path if secrets_version == "2"
+      # Internal, update prefix or path, add `/data` if secrets_version == "2"
       # Parameter is an array of hashes: [{}, {}]
       # Returns array of hashes: [{:name=>"vault-test", :prefix=>"vault-test/data", :path=>"vault/vault-test/data", :secrets_version=>"2"},{}]
       def update_prefix_or_path(targets)
@@ -70,6 +80,13 @@ module Sanctum
         end
       end
 
+      def remove_trailing_slash(targets)
+        targets.each do |h|
+          h[:prefix] = h[:prefix].chomp("/")
+          h[:path] = h[:path].chomp("/")
+        end
+      end
+
       def unable_to_determine_version
         warn red(
           "Unable to automatically gather info about mounts. This maybe due to vault connectivity or permissions"\

data/lib/sanctum/version.rb

@@ -1,3 +1,3 @@
 module Sanctum
-  VERSION = "0.8.5.rc2"
+  VERSION = "0.8.5.rc3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sanctum
 version: !ruby/object:Gem::Version
-  version: 0.8.5.rc2
+  version: 0.8.5.rc3
 platform: ruby
 authors:
 - Corban Raun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-16 00:00:00.000000000 Z
+date: 2019-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vault