keylime 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a81357c7a678f11061991964b11c12e7bdfdd144
+  data.tar.gz: 72d703f5749bba76f214e23b1670a7d4dc960043
+SHA512:
+  metadata.gz: d2142d8176bd0e05218118caa4e3ecf2b4101ecacfb50250f23c93ce69df9264fb1ae138fc76b64df9f3c64bbd914b6e51fb54cb602aafe8c6cff5a9d0062df2
+  data.tar.gz: f3645e6405ec6c4854db623d5bdc26eb685da4275f769e917a4ac5ea79e406d5be1d4281a4dd0f30a654a5ac526e0494138f9727f334f9d18e575678a2f848b4

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*.gem
+coverage/
+.coveralls.yml
+.bundle
+Gemfile.lock

data/.prospectus

@@ -0,0 +1,11 @@
+item do
+  expected do
+    static
+    set 'green'
+  end
+
+  actual do
+    gemnasium
+    slug 'akerl/keylime'
+  end
+end

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Encoding:
+    Enabled: false

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Les Aker
+
+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,69 @@
+keylime
+=========
+
+[![Gem Version](https://img.shields.io/gem/v/keylime.svg)](https://rubygems.org/gems/keylime)
+[![Dependency Status](https://img.shields.io/gemnasium/akerl/keylime.svg)](https://gemnasium.com/akerl/keylime)
+[![Build Status](https://img.shields.io/circleci/project/akerl/keylime.svg)](https://circleci.com/gh/akerl/keylime)
+[![Coverage Status](https://img.shields.io/codecov/c/github/akerl/keylime.svg)](https://codecov.io/github/akerl/keylime)
+[![Code Quality](https://img.shields.io/codacy/b84e51f348094a33b2982bfb73adc645.svg)](https://www.codacy.com/app/akerl/keylime)
+[![MIT Licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://tldrlegal.com/license/mit-license)
+
+Simple wrapper for using Mac Keychain
+
+## Usage
+
+Create a Keylime object, which represents a single credential (which may or may not be stored in Keychain yet):
+
+```
+require 'keylime'
+my_credential = Keylime.new(server: 'https://example.org', account: 'akerl')
+```
+
+You can specify any of the following attributes by providing them:
+
+* account: the username field
+* server: the site the credential is for (if it's an "internet password", which just means a credential that was created with a server set)
+* label: the name of the credential, generally describing what it's used for
+* service: the "Where" field in keychain access, used to describe what the credential is used for
+* There are other attributes, which you can look up with `security find-generic-password -h` and `security find-internet-password -h`, but these are the most commonly useful
+
+Once you've created the credential object, you can get its value in one of two ways:
+
+```
+require 'keylime'
+my_credential = Keylime.new(server: 'https://example.org', account: 'akerl')
+
+# This will get the value, and return nil if it doesn't exist:
+value = my_credential.get
+
+# This will get the value, and prompt the user to input the value if it doesn't exist:
+value = my_credential.get!('Please enter example.org password')
+```
+
+If you know the password via some other means, you can directly set it with .set():
+
+```
+require 'keylime'
+my_credential = Keylime.new(server: 'https://example.org', account: 'akerl')
+
+secret = 'foobar'
+my_credential.set(secret)
+```
+
+You can also delete a secret using .delete():
+
+```
+require 'keylime'
+my_credential = Keylime.new(server: 'https://example.org', account: 'akerl')
+
+my_credential.delete!
+```
+
+## Installation
+
+    gem install keylime
+
+## License
+
+keylime is released under the MIT License. See the bundled LICENSE file for details.
+

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+desc 'Run tests'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run Rubocop on the gem'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+  task.fail_on_error = true
+end
+
+task default: [:spec, :rubocop, :build, :install]

data/circle.yml

@@ -0,0 +1,12 @@
+dependencies:
+  override:
+    - 'rvm-exec 1.9.3-p551 bundle install'
+    - 'rvm-exec 2.0.0-p645 bundle install'
+    - 'rvm-exec 2.1.6 bundle install'
+    - 'rvm-exec 2.2.2 bundle install'
+test:
+  override:
+    - 'rvm-exec 1.9.3-p551 bundle exec rake'
+    - 'rvm-exec 2.0.0-p645 bundle exec rake'
+    - 'rvm-exec 2.1.6 bundle exec rake'
+    - 'rvm-exec 2.2.2 bundle exec rake'

data/keylime.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name        = 'keylime'
+  s.version     = '0.0.3'
+  s.date        = Time.now.strftime('%Y-%m-%d')
+
+  s.summary     = 'Simple wrapper for using Mac Keychain'
+  s.description = "Simple wrapper for using Mac Keychain"
+  s.authors     = ['Les Aker']
+  s.email       = 'me@lesaker.org'
+  s.homepage    = 'https://github.com/akerl/keylime'
+  s.license     = 'MIT'
+
+  s.files       = `git ls-files`.split
+  s.test_files  = `git ls-files spec/*`.split
+
+  s.add_dependency 'ruby-keychain', '~> 0.3.0'
+  s.add_dependency 'userinput', '~> 1.0.0'
+
+  s.add_development_dependency 'rubocop', '~> 0.39.0'
+  s.add_development_dependency 'rake', '~> 11.1.0'
+  s.add_development_dependency 'codecov', '~> 0.1.1'
+  s.add_development_dependency 'rspec', '~> 3.4.0'
+  s.add_development_dependency 'fuubar', '~> 2.0.0'
+end

data/lib/keylime.rb

@@ -0,0 +1,11 @@
+##
+# Keylime, a simple tool for interacting with OSX's keychain
+module Keylime
+  class << self
+    def new(*args)
+      self::Credential.new(*args)
+    end
+  end
+end
+
+require 'keylime/credential'

data/lib/keylime/credential.rb

@@ -0,0 +1,59 @@
+require 'keychain'
+require 'userinput'
+
+module Keylime
+  ##
+  # Easy wrapper around getting and setting secrets
+  class Credential
+    def initialize(params = {})
+      @options = params
+      @enabled = RUBY_PLATFORM =~ /darwin/ || ENV['CI']
+    end
+
+    def get
+      return unless @enabled
+      keychain_segment.where(@options).first
+    end
+
+    def get!(message)
+      get || prompt(message)
+    end
+
+    def set(value)
+      delete!
+      keychain_segment.create(@options.merge(password: value))
+    end
+
+    def delete!
+      get && keychain_segment.where(@options).first.delete
+      nil
+    end
+
+    private
+
+    def prompt(message)
+      set UserInput.new(
+        message: message,
+        secret: true,
+        attempts: 3,
+        validation: /.+/
+      ).ask
+    end
+
+    def keychain
+      @keychain ||= if @options[:keychain]
+                      Keychain.open(@options[:keychain])
+                    else
+                      Keychain
+                    end
+    end
+
+    def key_type
+      @options[:server] ? :internet_passwords : :generic_passwords
+    end
+
+    def keychain_segment
+      @keychain_segment ||= keychain.send(key_type)
+    end
+  end
+end

data/spec/keylime/credential_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+require 'securerandom'
+
+describe Keylime::Credential do
+  let(:subject) { Keylime.new(service: 'testing') }
+  let(:secret) { SecureRandom.hex }
+
+  it 'accepts a keychain path' do
+    credential = Keylime.new(keychain: 'other/file', service: 'testing')
+    credential.set secret
+    expect(credential.get.keychain).to eql 'other/file'
+  end
+  it 'can get internet passwords' do
+    credential = Keylime.new(server: 'https://example.org', account: 'testing')
+    credential.set secret
+    expect(credential.get.password).to eql secret
+  end
+  it 'can get generic passwords' do
+    subject.set secret
+    expect(subject.get.password).to eql secret
+  end
+
+  describe '#get' do
+    it 'returns a credential if it exists' do
+      subject.set secret
+      expect(subject.get.password).to eql secret
+    end
+    it 'returns nil if the credential does not exist' do
+      expect(subject.get).to be_nil
+    end
+  end
+
+  describe '#get!' do
+    it 'returns a credential if it exists' do
+      subject.set secret
+      expect(subject.get.password).to eql secret
+    end
+    it 'prompts the user if the credential does not exist' do
+      allow(STDIN).to receive(:gets) { "#{secret}\n" }
+      expect(STDOUT).to receive(:print).with('Question? ')
+      expect(subject.get!('Question').password).to eql secret
+    end
+  end
+
+  describe '#set' do
+    it 'sets the value of the credential' do
+      subject.set secret
+      expect(subject.get.password).to eql secret
+    end
+    it 'overwrites any existing credential' do
+      subject.set 'oldvalue'
+      expect(subject.get.password).to eql 'oldvalue'
+      subject.set secret
+      expect(subject.get.password).to eql secret
+    end
+  end
+
+  describe '#delete!' do
+    it 'removes the credential' do
+      subject.set secret
+      expect(subject.get.password).to eql secret
+      subject.delete!
+      expect(subject.get).to be_nil
+    end
+    it 'succeeds if credential does not exist' do
+      subject.delete!
+      expect(subject.get).to be_nil
+    end
+  end
+end

data/spec/keylime_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Keylime do
+  describe '#new' do
+    it 'creates Credential objects' do
+      expect(Keylime.new).to be_an_instance_of Keylime::Credential
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+if ENV['CI'] == 'true'
+  require 'simplecov'
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+  SimpleCov.start do
+    add_filter '/spec/'
+  end
+end
+
+require 'rspec'
+$LOAD_PATH.unshift File.expand_path('../stub', __FILE__)
+require 'keylime'

data/spec/stub/keychain.rb

@@ -0,0 +1,78 @@
+require 'ostruct'
+
+module Keychain
+  class << self
+    def generic_passwords
+      KeychainFile.new.generic_passwords
+    end
+
+    def internet_passwords
+      KeychainFile.new.internet_passwords
+    end
+
+    def open(path)
+      KeychainFile.new(path)
+    end
+
+    def nuke_list
+      @nuke_list ||= []
+    end
+
+    def empty_nuke_list!
+      @nuke_list = []
+    end
+  end
+
+  class KeychainFile
+    def initialize(path = nil)
+      @keychain = path
+    end
+
+    def generic_passwords
+      Passwords.new(@keychain)
+    end
+
+    def internet_passwords
+      InternetPasswords.new(@keychain)
+    end
+  end
+
+  class Passwords
+    def initialize(keychain = nil)
+      @keychain = keychain
+    end
+
+    def where(params)
+      cache.find_all do |x|
+        hash = x.marshal_dump
+        params.all? { |k, v| hash[k] == v }
+      end
+    end
+
+    def create(params)
+      struct = OpenStruct.new(params)
+      struct.keychain = @keychain
+      cache << struct
+      struct
+    end
+
+    private
+
+    def cache
+      @cache ||= []
+      @cache.reject! { |x| Keychain.nuke_list.include? x.hash }
+      Keychain.empty_nuke_list!
+      @cache
+    end
+  end
+
+  class InternetPasswords < Passwords
+  end
+end
+
+class OpenStruct
+  def delete
+    Keychain.nuke_list << hash
+    super
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: keylime
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Les Aker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-keychain
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: userinput
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.0
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Simple wrapper for using Mac Keychain
+email: me@lesaker.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".prospectus"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- circle.yml
+- keylime.gemspec
+- lib/keylime.rb
+- lib/keylime/credential.rb
+- spec/keylime/credential_spec.rb
+- spec/keylime_spec.rb
+- spec/spec_helper.rb
+- spec/stub/keychain.rb
+homepage: https://github.com/akerl/keylime
+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.1
+signing_key: 
+specification_version: 4
+summary: Simple wrapper for using Mac Keychain
+test_files:
+- spec/keylime/credential_spec.rb
+- spec/keylime_spec.rb
+- spec/spec_helper.rb
+- spec/stub/keychain.rb