cerberus_client 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d3a7b43ef0b561d32d794fa925fc34e9cbf2b59
-  data.tar.gz: da20976a2b27f1cf8b9e94feb5705732ff325d72
+  metadata.gz: ccb02d6f202ae5383140498f5bb9654e3efb0ea0
+  data.tar.gz: f639c3ad2c68c3af46ba48d28cd0668f0c213820
 SHA512:
-  metadata.gz: 52ef49d0ab8984779e0c01c939257a944a5ae3372a31c1d0f5233793e7633f125acb6a9c0785b9b62e0d1e8227500701a2c84b8a32158e9f964645620b98cb19
-  data.tar.gz: 4d1bb520ad2711d484043df639ed6d2e6d9d0401801c12f2c8ba3a9731f887959e24168508284c179eab603de3e325e37d16caaf593bd0e13583e9f21a4d759d
+  metadata.gz: 3c68b365555fe8e84d9eaea409f9694605580698a4bdefd79add1759c588eab6ffdc42c89b2885ce03aa23a4c66b68f2180c2e833384c28664f38c0425aedd41
+  data.tar.gz: 1f549a900c19e7c23f813520d672d4f3b961ebfe82721fbf29137bdb63d27932bff81b146ca5cf6862efea2b0b2420d8abaaf992a7ba30f65e757339822256ef

data/README.md

@@ -21,17 +21,17 @@ Add this to your application's Gemfile:
 
 ```ruby
 source 'https://rubygems.org'
-gem 'cerberus_client' 
+gem 'cerberus_client'
 ```
 
 And then install it:
 ```bash
 $ bundle
 ```
-    
+
 Or do it yourself:
-```bash 
-$ gem install cerberus_client 
+```bash
+$ gem install cerberus_client
 ```
 
 ## Usage
@@ -54,13 +54,42 @@ environment variable, CERBERUS_ADDR, must be set:
 ```bash
 export CERBERUS_ADDR=https://cerberus.example.com
 ```
+OR
+```bash
+export CERBERUS_ADDR=https://localhost:9001
+```
 
-The example above also use the DefaultCredentialsProviderChain which is used to resolve the token needed to interact 
+The example above also use the DefaultCredentialsProviderChain which is used to resolve the token needed to interact
 with Vault. This chain will first look to see if an environemnt variable has been set with a vault token, e.g.
 ```bash
 export CERBERUS_TOKEN=9cfced14-91ae-e3ad-5b9d-1cae6c82362d
 ```
 
+Increment the version and add `.rc.1` to the end in the `lib/cerberus_client/version.rb` file.
+
+Then build and install the gem locally:
+
+```bash
+% gem build cerberus_client.gemspec
+Successfully built RubyGem
+Name: cerberus_client
+Version: 0.0.0.rc.1
+File: cerberus_client-0.0.0.rc.1
+
+% gem install ./cerberus_client-0.0.0.rc.1.gem
+Successfully installed cerberus_client-0.0.0.rc.1
+1 gem installed
+```
+
+Then open Interactive Ruby:
+```bash
+% irb
+
+2.2.2 :001 > require 'cerberus_client'
+2.2.2 :001 > vaultClient = CerberusClient::getDefaultVaultClient()
+2.2.2 :001 > vaultClient.read("app/example/test")
+```
+
 ### Running in AWS
 
 If the environment variables used in local development are not found, the client will try to use the AWS metadata
@@ -70,7 +99,3 @@ are available in the [Cerberus quick start guide](http://engineering.nike.com/ce
 Optionally, UrlResolver and/or CredentialsProviderChain can be provided to customize how those values are used in
 your system. See lib/cerberus_client for alternative factory methods and the functions your custom objects should
 support.
-
-
-
-

data/lib/cerberus/aws_role_credentials_provider.rb

@@ -228,11 +228,12 @@ module Cerberus
     def doAuthWithCerberus(accountId, roleName, region)
       postJsonData = JSON.generate({:account_id => accountId, :role_name => roleName, :region => region})
       authUrl = URI(@vaultBaseUrl + ROLE_AUTH_REL_URI)
-      authResponse = CerberusClient::Http.new.doHttp(authUrl, 'POST', true, postJsonData)
+      useSSL = ! ("#{@vaultBaseUrl}".include? "localhost")
+      authResponse = CerberusClient::Http.new.doHttp(authUrl, 'POST', useSSL, postJsonData)
       # if we got this far, we should have a valid response with encrypted data
       # send back the encrypted data
       JSON.parse(authResponse.body)['auth_data']
     end
 
   end
-end
+end

data/lib/cerberus/vault_client.rb

@@ -42,7 +42,6 @@ module Cerberus
     # Read operation for a specified path.
     ##
     def read(path)
-
       begin
         response = doVaultHttpGet(SECRET_PATH_PREFIX + path)
         CerberusClient::Log.instance.debug("VaultClient::read(path) HTTP response: #{response.code}, #{response.message}")
@@ -157,10 +156,11 @@ module Cerberus
     def doVaultHttpGet(relativeUri)
 
       url = URI(@vaultBaseUrl + relativeUri)
+      useSSL = ! ("#{@vaultBaseUrl}".include? "localhost")
 
       begin
         response = CerberusClient::Http.new.doHttp(url,
-                                                 'GET', true, nil,
+                                                 'GET', useSSL, nil,
                                                  {VAULT_TOKEN_HEADER_KEY =>
                                                       CerberusClient.getCredentialsFromProvider(@credentialsProvider)})
 
@@ -204,4 +204,4 @@ module Cerberus
     end
 
   end
-end
+end

data/lib/cerberus_client/http.rb

@@ -4,6 +4,7 @@ module CerberusClient
   require_relative('../cerberus/exception/http_error')
   require('net/http')
   require_relative('log')
+  require_relative('version')
 
   ##
   #
@@ -38,6 +39,7 @@ module CerberusClient
         if(jsonData != nil); request.body = "#{jsonData}"; request['Content-Type'] = "application/json"; end
 
         if(headersMap != nil); headersMap.each{ |headerKey, headerValue| request[headerKey] = headerValue } end
+        request['X-Cerberus-Client'] = "CerberusRubyClient/#{CerberusClient::VERSION}"
 
         http.use_ssl = useSSL
         response = http.request(request)
@@ -64,4 +66,4 @@ module CerberusClient
     end
 
   end
-end
+end

data/lib/cerberus_client/version.rb

@@ -1,3 +1,3 @@
 module CerberusClient
-  VERSION = "1.3.1"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: cerberus_client
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Joe Teibel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-05 00:00:00.000000000 Z
+date: 2017-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.13'
 description: This is a Ruby based client library for communicating with Vault via
@@ -63,9 +63,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -100,17 +100,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: '["A Ruby Client for Cerberus, a secure property store for cloud applications"]'