storedsafe 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed587808626883a211cda1842c737f3ca31354e99ab76b3fb173ee202a4b0090
-  data.tar.gz: c7ffc7a27d41c6a0cf3833ce3d4630745a6390f817a3b328ea7660b4429836a7
+  metadata.gz: 3284ce4b299b3a111699580ab7a144ece6586017688a190277f19db54750eab1
+  data.tar.gz: 7712584e6f771e1825166aca610b349bc0067a9f3ea8d1742f9802a5362d41e6
 SHA512:
-  metadata.gz: 835ba721f4fdfe1692fdeb5c8f42d50c4cdf60edeb5c30254c1d4f664b566bea5338081278dc9ab3587c8fb62aac648b097bbdec003e78c5a51b6f960ac2fe0d
-  data.tar.gz: b81917058e9c348d0c7f75cc35711354510b7cc8c9dafc606836a8a00926f8e427a8d397c3b5b63b365dfbdf9699db1f681a44e1d425849fb4d77d450e282710
+  metadata.gz: 7d0ab608ef2f79adef486a5f3ed67828fe4327e43cccc4734649c4c1384e4cc7b8c48cf96e799b4bd1ad36ba2f6ff85ddd5310b76620e3a2c5d685447a26da80
+  data.tar.gz: 130f06c1fb087a0d2a29e7e276a6f449ee45eef9a1f29813fc32ae1499de2920728bcfd6733cf122427bd488a8e6b7580841846e1d33d8056f9621f29001f1d8

data/README.md

@@ -1,3 +1,99 @@
 # Storedsafe API ruby wrapper
 
-This is a ruby wrapper for the Storedsafe REST-like API.
+This is a ruby wrapper for the Storedsafe REST-like API (See full [docs here](https://tracker.storedsafe.com/projects/storedsafe20/wiki/Version_10_release_documentation)).
+
+**This early version may contain errors and is subject to change and should be used with caution**
+
+## Install
+
+Install from rubygems `gem install storedsafe`
+
+Add to Gemfile `gem 'storedsafe', '~> 0.0.1'`
+
+## Usage
+To pass a manual configuration, you simply pass a block to *Storedsafe.configure*.
+```
+api = Storedsafe.configure do |config|
+  config.server = 'storedsafe.example.com'
+  config.api_token = 'abc123'
+  config.token = 'secret'
+  config.username = 'bob'
+end
+```
+
+If you only want to use the built-in defaults you can skip the block.
+```
+api = Storedsafe.configure
+```
+
+See [Configuration](#configuration) for more info about default values and external configuration sources.
+
+All methods of the `Storedsafe::API` object returns the data parsed by whichever parser is listed in your config's *parser* field. By default the `Storedsafe::Parser::RawParser` is used, which simply turns the returned JSON data into a Ruby hash.
+
+### Authentication
+If you already have a token from another source, you can enter it in the config and skip this section.
+
+Three forms of authentication are currently availble. Either by the default *TOTP* (`Storedsafe::API::LogintType::TOTP`), *yubikey* (`Storedsafe::API::LoginType::YUBIKEY`) or *smartcard* (`Storedsafe::API::LoginType::SMARTCARD`).
+
+NOTE: Make sure all other relevant fields are set on the Storedsafe::API object (username, api\_key)
+
+Example authenticating using TOTP (sets the *token* field of the Storedsafe::API object).
+```
+api.authenticate('abc123', '123456')
+```
+
+Example authenticating using YubiKey.
+```
+api.authenticate('abc123', 'abcdef123456', Storedsafe::API::LoginType::YUBIKEY)
+```
+
+### Vaults
+* list\_vaults
+* list\_objects(vault\_id)
+* create\_vault(groupname, policy, description)
+* edit\_vault(vault\_id, { groupname, policy, description })
+* delete\_vault(vault\_id)
+
+### Templates
+* list\_templates
+* retrieve\_template(template\_id)
+
+### Objects
+* object(object\_id, decrypt=false)
+* create\_object(template\_id, group\_id, parent\_id, object\_name, template\_args)
+* edit\_object(object\_id, template\_id, group\_id, parent\_id, object\_name, template\_args)
+* delete\_object(object\_id)
+* find\_object(needle)
+
+## Configuration
+Configuration can be done in a few different ways. Other than the manual configuration, external configuration sources can be applied through the *config\_sources* array. This array contains Ruby Hashes with the fields that should be applied to the `Storedsafe::Config::Configurable` instance. By default fetch configurations through the `Storedsafe::Config::RcReader` and `Storedsafe::Config::EnvReader`.
+
+The order of priority between these different configuration sources are:
+1. Manual Configuration
+2. Built-in defaults
+3. Elements in the config\_sources array in order of appearance
+
+The **RcReader** will extract a configuration hash from a file (default is ~/.storedsafe-client.rc) which is generated by the [Storedsafe Tokenhandler](https://github.com/storedsafe/tokenhandler).
+
+The **EnvReader** will extract a configuration hash from environment variables. By default these variables are `STOREDSAFE_SERVER`, `STOREDSAFE_TOKEN`, `STOREDSAFE_CABUNDLE` and `STOREDSAFE_SKIP_VERIFY`.
+
+To disable all external configuration sources such as the rc-file and environment vairables, set the *config\_sources* option to an empty array.
+```
+api = Storedsafe.configure do |config|
+  config.config_sources = []
+  ...
+end
+```
+
+If you want to add your own configurations, simply add them to the config\_sources array.
+```
+def fetch_password(options, obj_id)
+  api = Storedsafe.configure do |config|
+    config.config_sources = [
+      options,
+      Storedsafe::Config::RcReader.parse_file('/path/to/.storedsafe-client.rc'),
+    ]
+  end
+  api.object(obj_id, true)
+end
+```

data/lib/storedsafe/config.rb

@@ -16,8 +16,8 @@ module Storedsafe
     # Default configuration values
     DEFAULTS = {
       config_sources: [
-        RcReader.new(File.join(Dir.home, '.storedsafe-client.rc')),
-        EnvReader.new
+        RcReader.parse_file,
+        EnvReader.parse_env
       ],
       api_version: '1.0',
       parser: Parser::RawParser
@@ -30,8 +30,8 @@ module Storedsafe
     def self.apply(configurable)
       apply_config(configurable, DEFAULTS)
 
-      configurable.config_sources.each do |source|
-        apply_config(configurable, source.read)
+      configurable.config_sources.each do |config|
+        apply_config(configurable, config)
       end
     end
 

data/lib/storedsafe/config/env_reader.rb

@@ -4,30 +4,25 @@ module Storedsafe
   module Config
     ##
     # Reads configuration items from environment variables.
-    class EnvReader
-      attr_reader :config
-
-      ##
-      # Read configuration from environment variables.
-      # @param [Hash] fields Mapping from configuration field to environment
-      #   variable name.
-      def initialize(fields = {
-        server: 'STOREDSAFE_SERVER',
-        token: 'STOREDSAFE_TOKEN',
-        ca_bundle: 'STOREDSAFE_CABUNDLE',
-        skip_verify: 'STOREDSAFE_SKIP_VERIFY'
-      })
-        @fields = fields
-        @config = {}
-      end
-
-      ##
-      # Read values from file into the @config hash.
-      def read
-        @fields.each do |key, val|
-          @config[key] = ENV[val]
+    module EnvReader
+      class << self
+        ##
+        # Parses the passed environment variable names into a hash of config
+        #   values.
+        # @param [Hash] fields Mapping from configuration field to environment
+        #   variable name.
+        def parse_env(fields = {
+          server: 'STOREDSAFE_SERVER',
+          token: 'STOREDSAFE_TOKEN',
+          ca_bundle: 'STOREDSAFE_CABUNDLE',
+          skip_verify: 'STOREDSAFE_SKIP_VERIFY'
+        })
+          config = {}
+          fields.each do |key, val|
+            config[key] = ENV[val]
+          end
+          config
         end
-        @config
       end
     end
   end

data/lib/storedsafe/config/rc_reader.rb

@@ -4,43 +4,39 @@ module Storedsafe
   module Config
     ##
     # Reads configuration items from rc file.
-    class RcReader
-      attr_reader :config
-
-      ##
-      # Read configuration from Storedsafe RC file.
-      # @param [String] path Path to RC file.
-      def initialize(path)
-        @path = path
-        @config = {}
-      end
-
-      ##
-      # Read values from file into the @config hash.
-      def read
-        if File.exists?(@path)
-          File.open(@path, 'r').each do |line|
-            key, val = line.split(':', 2)
-            key = key.strip
-            val = val.strip
-            parse_line(key, val)
+    module RcReader
+      class << self
+        ##
+        # Parses values from RC file into a hash.
+        def parse_file(path = File.join(
+          Dir.home,
+          '.storedsafe-client.rc'
+        ))
+          config = {}
+          if File.exist?(path)
+            File.open(path, 'r').each do |line|
+              key, val = line.split(':', 2)
+              key = key.strip
+              val = val.strip
+              parse_line(config, key, val)
+            end
           end
+          config
         end
-        @config
-      end
 
-      private
+        private
 
-      def parse_line(key, val)
-        case key
-        when 'token'
-          @config[:token] = val
-        when 'username'
-          @config[:username] = val
-        when 'apikey'
-          @config[:api_key] = val
-        when 'mysite'
-          @config[:server] = val
+        def parse_line(config, key, val)
+          case key
+          when 'token'
+            config[:token] = val
+          when 'username'
+            config[:username] = val
+          when 'apikey'
+            config[:api_key] = val
+          when 'mysite'
+            config[:server] = val
+          end
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: storedsafe
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Oscar Mattsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-07 00:00:00.000000000 Z
+date: 2019-06-13 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: oscar_mattsson@live.se