secret_server 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3809021f55ff721ca61d09dda83b42ee40cdd9f3
+  data.tar.gz: a1661e11f67f917c2dba75df4b7a298859985cc3
+SHA512:
+  metadata.gz: 48eda31f9aa395ce3e6a908b2072f222ab06e20931380dc938c8c5717c6dc65098ae58911ea67f89241d5cf8664dd00bf4ba4376c712a87acbbc5566857ea72e
+  data.tar.gz: 27cec9fb35e6f8f0f6e681cedc1d13ae5f7e4b3fa1e65ed8693bcfaa7d18754d4e07a6932560ba2ff0271c6387297c81ec8392e512bb02987f28f4086df82007

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# tss configs
+cache.config
+credentials.config
+endpoint.config

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,3 @@
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in secret_server.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Tony Gambone
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,150 @@
+# secret-server-ruby
+
+A gem for using Thycotic Secret Server as a vault for storing secrets and consuming them in Ruby programs.
+
+Requires Secret Server 10.4 and higher, and an installation of the Secret Server SDK client tool.
+
+This gem is unofficial and not supported by Thycotic.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'secret_server'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install secret_server
+
+## Initial Setup
+
+Configure the connection to your Secret Server instance:
+
+```ruby
+SecretServer.configure do |config|
+  config.path = "#{ENV['HOME']}/sdkclient"
+  config.url = 'https://myserver/SecretServer/'
+  config.rule = 'MyOnboardingRule'
+  config.key = 'MyOnboardingKey'
+end
+```
+
+* `config.path` is the directory containing the SDK client
+* `config.url` is the URL to your Secret Server instance
+* `config.rule` is the name of an onboarding rule you have created (optional)
+* `config.key` is the onboarding key for that rule, if applicable (optional)
+
+Alternatively, you can also pull configuration from the current environment:
+
+```ruby
+SecretServer.env_configure
+```
+
+The gem will configure the connection using the variables `SDK_CLIENT_PATH`,
+`SECRET_SERVER_URL`, `SDK_CLIENT_RULE`, and `SDK_CLIENT_KEY`.
+
+Initialize the connection to Secret Server:
+
+```ruby
+SecretServer.init!
+```
+
+The initialization step requires write access to the current directory.
+
+Once the configuration and initialization are complete, they do not need to be
+run again. Encrypted configuration files created in the current directory will
+be used to establish the connection to Secret Server.
+
+## Usage
+
+Fetch a secret by ID:
+
+```ruby
+# retrieve the full representation of a secret
+secret = SecretServer.secret(1)
+
+# retrieve only the secret fields
+secret = SecretServer.secret(1, field: :all)
+
+# retrieve only a single secret field value by slug
+password = SecretServer.secret(1, field: 'password')
+```
+
+To acquire an API token to make REST calls as the application account user:
+
+```ruby
+token = SecretServer.token
+```
+
+To remove the connection to Secret Server and delete all configuration:
+
+```ruby
+SecretServer.remove!
+```
+
+## Cache Settings
+
+By default, no secret values are stored on the local machine. As such, every call to `SecretServer.secret` will result in a round-trip to the server.  If the server is unavailable, the call will fail.
+
+To change this behavior, set the cache strategy:
+
+```ruby
+# The default (never cache secrets)
+SecretServer.cache_strategy = SecretServer::SdkClient::StrategyNever
+
+# Set the cache age (the maximum time, in minutes, that a cached value will be usable).
+SecretServer.cache_age = 10
+
+# Check the server first; if unavailable, use the return the last retrieved
+# value, if present. Use this strategy for improved fault tolerance.
+SecretServer.cache_strategy = SecretServer::SdkClient::StrategyServerThenCache
+
+# Check the cache first; if no value is present, retrieve it from the server.
+# Use this strategy for improved performance.
+SecretServer.cache_strategy = SecretServer::SdkClient::StrategyCacheThenServer
+
+# Same as the above mode, but allow an expired cached value to be used if the
+# server is unavailable.
+SecretServer.cache_strategy = SecretServer::SdkClient::StrategyCacheThenServerAllowExpired
+
+# It is also possible to set the cache strategy and age at the same time:
+SecretServer.cache_strategy = [SecretServer::SdkClient::StrategyServerThenCache, 20]
+
+# Clear all cached values immediately
+SecretServer.cache_clear!
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tonygambone/secret-server-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## TODO
+
+* Automated SDK client installation
+* Check if `tss` is a supported version, if it ever supports versioning
+* Integration testing
+* Add links to SDK client documentation where needed
+* Release to GitHub official
+* Release to Rubygems
+
+## `tss` TODO
+
+* Report version
+* Clear up cache.config on remove
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'secret_server'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/secret_server.rb

@@ -0,0 +1,28 @@
+# Secret Server SDK client integration for Ruby
+module SecretServer
+  require_relative 'secret_server/sdk_client'
+  require_relative 'secret_server/version'
+
+  class << self
+    attr_reader :client
+
+    def module_init!
+      @client = SdkClient.new
+      self
+    end
+
+    def method_missing(m, *params, &block)
+      if @client.respond_to?(m)
+        @client.send(m, *params, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(m, p = false)
+      @client.respond_to?(m, p) || super
+    end
+  end
+end
+
+SecretServer.module_init!

data/lib/secret_server/commands.rb

@@ -0,0 +1,14 @@
+Dir[File.dirname(__FILE__) + '/commands/*.rb'].each do |file|
+  require file
+end
+
+module SecretServer
+  # Wrappers for each command provided by the SDK client tool.
+  module Commands
+    include SecretServer::Commands::Cache
+    include SecretServer::Commands::Init
+    include SecretServer::Commands::Remove
+    include SecretServer::Commands::Secret
+    include SecretServer::Commands::Token
+  end
+end

data/lib/secret_server/commands/cache.rb

@@ -0,0 +1,58 @@
+module SecretServer
+  module Commands
+    # Command to control caching of Secret values
+    module Cache
+      # rubocop:disable Naming/ConstantName
+      StrategyNever = 0
+      StrategyServerThenCache = 1
+      StrategyCacheThenServer = 2
+      StrategyCacheThenServerAllowExpired = 3
+      # rubocop:enable Naming/ConstantName
+
+      def cache_strategy
+        stdout, * = sdkclient_exec('cache', '-c')
+        result = /Strategy : (\w+)(?:, Max Age : (\d+) minutes)?/.match(stdout)
+        strategy = SecretServer::SdkClient.const_get("Strategy#{result[1]}")
+        [strategy, result[2].to_i]
+      end
+
+      def cache_strategy=(value)
+        strategy, age = value.is_a?(Array) ? value : [value, nil]
+        validate_cache_strategy_args(strategy, age)
+        args = ['cache', '-s', strategy.to_s]
+        args += ['-a', age.to_s] unless age.nil?
+        sdkclient_exec(*args)
+      end
+
+      def cache_age
+        cache_strategy[1]
+      end
+
+      def cache_age=(age)
+        unless age.is_a?(Integer) && age >= 0
+          raise ArgumentError, 'age must be a nonnegative integer'
+        end
+        sdkclient_exec('cache', '-a', age.to_s)
+      end
+
+      def cache_clear!
+        sdkclient_exec('cache', '-b')
+      end
+
+      private
+
+      def validate_cache_strategy_args(strategy, age)
+        unless strategy.is_a? Integer
+          raise ArgumentError, 'strategy must be an integer'
+        end
+        unless (0..3).cover? strategy
+          raise ArgumentError, 'strategy must be in the range 0 to 3 inclusive'
+        end
+        unless age.nil? || age.is_a?(Integer) && age >= 0
+          raise ArgumentError, 'age must be a nonnegative integer'
+        end
+        true
+      end
+    end
+  end
+end

data/lib/secret_server/commands/init.rb

@@ -0,0 +1,14 @@
+module SecretServer
+  module Commands
+    # Command to initialize a connection to Secret Server
+    module Init
+      def init!
+        raise 'Secret Server URL is not set' unless valid_url?
+        args = ['-e', '-u', url]
+        args += ['-r', rule] unless rule.nil?
+        args += ['-k', key] unless key.nil?
+        sdkclient_exec('init', *args)
+      end
+    end
+  end
+end

data/lib/secret_server/commands/remove.rb

@@ -0,0 +1,10 @@
+module SecretServer
+  module Commands
+    # Command to remove a connection with Secret Server
+    module Remove
+      def remove!
+        sdkclient_exec('remove', '-c')
+      end
+    end
+  end
+end

data/lib/secret_server/commands/secret.rb

@@ -0,0 +1,29 @@
+module SecretServer
+  module Commands
+    # Command to fetch Secret values
+    module Secret
+      def secret(id, opts = {})
+        unless id.is_a?(Integer) && id > 0
+          raise ArgumentError, 'id must be a positive integer'
+        end
+        args = ['-s', id.to_s]
+        if opts.key? :field
+          args += opts[:field] == :all ? ['-ad'] : ['-f', opts[:field].to_s]
+        end
+        secret_exec(*args)
+      end
+
+      private
+
+      def secret_exec(*args)
+        stdout, * = sdkclient_exec('secret', *args)
+        stdout.chomp!
+        begin
+          JSON.parse(stdout)
+        rescue JSON::ParserError
+          stdout
+        end
+      end
+    end
+  end
+end

data/lib/secret_server/commands/token.rb

@@ -0,0 +1,11 @@
+module SecretServer
+  module Commands
+    # Command to fetch an API token
+    module Token
+      def token
+        stdout, * = sdkclient_exec('token')
+        stdout
+      end
+    end
+  end
+end

data/lib/secret_server/configuration.rb

@@ -0,0 +1,36 @@
+module SecretServer
+  # Helpers for working with the Secret Server configuration
+  module Configuration
+    attr_accessor :path, :url, :rule, :key
+
+    def configure
+      yield self
+    end
+
+    def env_configure
+      configure do |config|
+        config.path = ENV['SDK_CLIENT_PATH'] || nil
+        config.url = ENV['SECRET_SERVER_URL'] || nil
+        config.rule = ENV['SDK_CLIENT_RULE'] || nil
+        config.key = ENV['SDK_CLIENT_KEY'] || nil
+      end
+    end
+
+    def valid_path?
+      File.exist? tss
+    end
+
+    def valid_url?
+      !url.nil?
+    end
+
+    def tss
+      return @tss if defined? @tss
+      @tss = begin
+        bin = File.join(path, 'tss.exe')
+        bin = File.join(path, 'tss') unless File.exist? bin
+        bin
+      end
+    end
+  end
+end

data/lib/secret_server/sdk_client.rb

@@ -0,0 +1,21 @@
+require 'json'
+require 'open3'
+require_relative 'configuration'
+require_relative 'commands'
+
+module SecretServer
+  # Ruby SDK client for Secret Server
+  class SdkClient
+    include SecretServer::Configuration
+    include SecretServer::Commands
+
+    private
+
+    def sdkclient_exec(*args)
+      raise 'SDK client path is invalid' unless valid_path?
+      stdout, stderr, status = Open3.capture3(tss, *args)
+      raise stdout unless status.exitstatus.zero?
+      [stdout, stderr, status]
+    end
+  end
+end

data/lib/secret_server/version.rb

@@ -0,0 +1,3 @@
+module SecretServer
+  VERSION = '0.1.0'.freeze
+end

data/secret_server.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'secret_server/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'secret_server'
+  spec.version       = SecretServer::VERSION
+  spec.authors       = ['Tony Gambone']
+  spec.email         = ['tony.gambone@thycotic.com']
+
+  spec.summary       = 'Retrieve secrets from Secret Server in Ruby programs.'
+  spec.homepage      = 'https://thycotic.com/'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`
+                       .split("\x0")
+                       .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.52.1'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: secret_server
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tony Gambone
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+description: 
+email:
+- tony.gambone@thycotic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/secret_server.rb
+- lib/secret_server/commands.rb
+- lib/secret_server/commands/cache.rb
+- lib/secret_server/commands/init.rb
+- lib/secret_server/commands/remove.rb
+- lib/secret_server/commands/secret.rb
+- lib/secret_server/commands/token.rb
+- lib/secret_server/configuration.rb
+- lib/secret_server/sdk_client.rb
+- lib/secret_server/version.rb
+- secret_server.gemspec
+homepage: https://thycotic.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.5.2.1
+signing_key: 
+specification_version: 4
+summary: Retrieve secrets from Secret Server in Ruby programs.
+test_files: []