pw_provider 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d00025b3c176a7a3dfc7acca473b000ec4b94ba0
+  data.tar.gz: 546ccf1815042ca0add47dafdcd0ebd1986ad378
+SHA512:
+  metadata.gz: fbf1cf90efc40b2af3dcce05040b20dd1460a0c819dac07ffbef187b36cc7bb794c44ff32f0402427e2b5465e16375a7e332d64ab26afaa4de7de2ae8e1f194e
+  data.tar.gz: a60bf721874fc6d24a8a578fcfcc25d201f2dabb828e74800a3fa68647cef9bca75d5fe130a74d4e9b4ceb52fb562f32b9eb1aec315246e2626296cb1c96806a

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--warnings
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem "rspec"
+gem "inifile"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Zsolt Kecskemeti
+
+MIT License
+
+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,54 @@
+# pw_provider
+
+A very simple password utility to pull passwords from different sources, currently supporting:
+- environment variables (for backwards compatibility)
+- Mac OSX KeyChain (more secure)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+  gem 'pw_provider'
+
+And then execute:
+
+  $ bundle
+
+Or install it yourself as:
+
+  $ gem install pw_provider
+
+## Usage
+
+Configure the method you want to use:
+
+  $ cat ~/.pw_provider
+  [config]
+  pass_source=KeyChain
+
+or 
+
+  [config]
+  pass_source=Environment
+
+It defaults to Environment when no config file is present.
+
+In your code where you need a password:
+
+  PwProvider.get('account_name')
+
+Example:
+
+  OpenSSL::PKey::RSA.new(cert_private_key, PwProvider.get('my_cert_pass_identifier'))
+
+
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/pw_provider/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+#require 'rubygems'
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/addpwd.rb

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'pw_provider/keychain'
+KeyChain.add_pw(ARGV[0], ARGV[1])

data/lib/pw_provider/conf.rb

@@ -0,0 +1,22 @@
+require 'inifile'
+
+# reads .pw_provider from user home dir to decide
+# where to read our passwords from:
+# - keychain
+# - environment variables
+module Conf
+
+  def Conf.abs_path(dotfile)
+    dotfile =~ /^\// ? dotfile : File.join(Dir.home, dotfile)
+  end
+
+  def Conf.inifile(dotfile)
+    @inifile ||= IniFile.load(abs_path(dotfile))
+  end
+
+  # default to 'Environment'
+  def Conf.pass_source(dotfile: '.pw_provider')
+    inifile(dotfile) ? inifile(dotfile)['config']['pass_source'] : 'Environment'
+  end
+end
+ 

data/lib/pw_provider/environment.rb

@@ -0,0 +1,5 @@
+class Environment
+  def self.get_pw(var)
+    ENV[var]
+  end
+end

data/lib/pw_provider/key_chain.rb

@@ -0,0 +1,24 @@
+# TODO use one of the available keychain gems for this
+
+class KeyChain
+  def self.get_pw(account)
+    cmd = quiet_cmd("security find-generic-password -g -a " + account)
+    response = `#{cmd}` 
+    response[/^password: "(.*)"$/, 1]
+  end
+
+  def self.add_pw(account, password)
+    cmd = quiet_cmd("security add-generic-password -a " + account + " -s " + account + " -w " + password)
+    `#{cmd}`
+  end
+
+  def self.del_pw(account)
+    cmd = quiet_cmd("security delete-generic-password -a " + account)
+    `#{cmd}`
+  end
+
+  def self.quiet_cmd(cmd)
+    cmd + ' 2>&1 >/dev/null'
+  end
+
+end

data/lib/pw_provider/version.rb

@@ -0,0 +1,3 @@
+module PwProvider
+  VERSION = "0.0.1"
+end

data/lib/pw_provider.rb

@@ -0,0 +1,13 @@
+require 'pw_provider/version'
+require 'pw_provider/key_chain'
+require 'pw_provider/conf'
+require 'pw_provider/environment'
+
+module PwProvider
+
+  def PwProvider.get(key)
+    eval(Conf.pass_source).get_pw(key)
+  end
+  
+end
+  

data/pw_provider.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pw_provider/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pw_provider"
+  spec.version       = PwProvider::VERSION
+  spec.authors       = ["Zsolt Kecskemeti"]
+  spec.email         = ["zsooo@zsooo.org"]
+  spec.summary       = %q{Password provider}
+  spec.description   = %q{Originally created for tests that require SSL certs with passphrases}
+  spec.homepage      = "http://rubygems.org/gems/pw_provider"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  
+end

data/spec/pw_provider/conf_spec.rb

@@ -0,0 +1,56 @@
+require 'pw_provider/conf'
+require 'tempfile'
+require 'securerandom'
+
+RSpec.describe Conf do
+
+  before(:each) do
+    Object.send(:remove_const, 'Conf')
+    load 'pw_provider/conf.rb'
+  end
+
+  describe "#pass_source" do
+    it "returns the pass source from temp file" do
+      # given
+      dotfile = Tempfile.new('testconfig')
+      dotfile.puts '[config]'
+      dotfile.puts 'pass_source=t123'
+      dotfile.flush
+
+      # when then
+      expect(Conf.pass_source(dotfile: dotfile.path)).to eq('t123')
+
+      # teardown
+      dotfile.close
+      dotfile.unlink
+    end
+  end
+
+  describe "#pass_source" do
+    it "returns 'Environment' when file doesn't exist" do
+      # given
+      non_existent_file = '/file_not_here' + SecureRandom.uuid  
+      # when then
+      expect(Conf.pass_source(dotfile: non_existent_file)).to eq('Environment')
+    end
+  end
+
+  describe "#abs_path" do
+    it "abs_path with absolute path" do
+      # given
+      dotfile = '/tmp/test1'
+      # when then
+      expect(Conf.abs_path(dotfile)).to eq(dotfile)
+    end
+  end
+
+  describe "#abs_path" do
+    it "abs_path with user dir" do
+      # given
+      dotfile = 'test2'
+      # when then
+      expect(Conf.abs_path(dotfile)).to eq(File.join(Dir.home, dotfile))
+    end
+  end
+
+end

data/spec/pw_provider/key_chain_spec.rb

@@ -0,0 +1,59 @@
+require 'pw_provider/key_chain'
+
+RSpec.describe KeyChain do
+
+  describe "#add_pw" do
+    it "creates a new password" do
+      # given
+      account = 'pw_provider-test'
+      pass = 'testpass'
+
+      # when
+      KeyChain.add_pw(account, pass)
+
+      # then
+      expect(KeyChain.get_pw(account)).to eq(pass)
+
+      # teardown
+      KeyChain.del_pw(account)
+    end
+  end
+
+
+
+  describe "#get_pw" do
+    it "gets the pass from the keychain" do
+      # given
+      account = 'pw_provider-test'
+      pass = 'testpass'
+      KeyChain.add_pw(account, pass)
+
+      # when
+      result = KeyChain.get_pw(account)
+
+      # then
+      expect(result).to eq(pass)
+
+      # teardown
+      KeyChain.del_pw(account)
+    end
+  end
+
+
+  describe "#del_pw" do
+    it "deletes the pass from the keychain" do
+      # given
+      account = 'pw_provider-test'
+      pass = 'testpass'
+      KeyChain.add_pw(account, pass)
+
+      # when
+      KeyChain.del_pw(account)
+
+      # then
+      empty = KeyChain.get_pw(account)
+      expect(empty).to eq(nil)
+    end
+  end
+  
+end

data/spec/pw_provider_spec.rb

@@ -0,0 +1,31 @@
+require 'pw_provider'
+require 'pw_provider/conf'
+
+RSpec.describe PwProvider do
+
+  describe "#get" do
+    it "returns the pass from keychain" do
+      # given
+      account = 'testacc'
+      pass = 'testpass'
+      allow(PwProvider).to receive(:pass_source).and_return('KeyChain')
+      allow(KeyChain).to receive(:get_pw).with(account).and_return(pass)
+
+      # when then
+      expect(PwProvider.get(account)).to eq(pass)
+    end
+  end
+  
+  describe "#get" do
+    it "returns the pass from the env" do
+      # given
+      account = 'testacc'
+      pass = 'testpass'
+      allow(Conf).to receive(:pass_source).and_return('Environment')
+      allow(Environment).to receive(:get_pw).with(account).and_return(pass)
+
+      # when then
+      expect(PwProvider.get(account)).to eq(pass)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'pw_provider'
+

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: pw_provider
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Zsolt Kecskemeti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Originally created for tests that require SSL certs with passphrases
+email:
+- zsooo@zsooo.org
+executables:
+- addpwd.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/addpwd.rb
+- lib/pw_provider.rb
+- lib/pw_provider/conf.rb
+- lib/pw_provider/environment.rb
+- lib/pw_provider/key_chain.rb
+- lib/pw_provider/version.rb
+- pw_provider.gemspec
+- spec/pw_provider/conf_spec.rb
+- spec/pw_provider/key_chain_spec.rb
+- spec/pw_provider_spec.rb
+- spec/spec_helper.rb
+homepage: http://rubygems.org/gems/pw_provider
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Password provider
+test_files:
+- spec/pw_provider/conf_spec.rb
+- spec/pw_provider/key_chain_spec.rb
+- spec/pw_provider_spec.rb
+- spec/spec_helper.rb