lanyard 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 897a19ae78ccd593d98d33b76b2b1741deedde52
+  data.tar.gz: 779a462f5f74907f9f228833824a76fabed5b752
+SHA512:
+  metadata.gz: ed34172d8470da26754d7c3ce45506992b748313f11534141f281ccd0cdf9e4100a4907bb7f4652184d3625baff7d81ee78795d23b1f05fac9740890f2598d6b
+  data.tar.gz: f2ae2c5cbaf5d99b8ea05df761f69d8c97b01e0126cae210f43f1b7a4d8f12c5a7f3a76004f6f3c1532d98d36571915885feb9dd1077140237690900eb655d17

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.2
+before_install: gem install bundler -v 1.10.4

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Manfred Endres
+
+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,52 @@
+# Lanyard
+
+[![Gem Version](https://badge.fury.io/rb/lanyard.svg)](http://badge.fury.io/rb/lanyard)
+[![Build Status](https://travis-ci.org/wooga/lanyard.svg?branch=master)](https://travis-ci.org/wooga/lanyard)
+[![Code Climate](https://codeclimate.com/github/wooga/lanyard/badges/gpa.svg)](https://codeclimate.com/github/wooga/lanyard)
+[![Test Coverage](https://codeclimate.com/github/wooga/lanyard/badges/coverage.svg)](https://codeclimate.com/github/wooga/lanyard/coverage)
+
+Lanyar is a little gem that helps to work with OSX keychains
+It includes a simple wrapper for `security` and is able to add/remove custom keychains to the keychain lookip list with one command.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lanyard'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lanyard
+
+## Usage
+
+### Commandline tool
+```
+Usage:
+  lanyard use-keychain [(-t=Time | --lock-timeout=Time)] (<keychain> <password>)...
+  lanyard unuse-keychain <keychain>...
+  lanyard (-h | --help)
+```
+
+### Rake
+```
+lanyard = Rake::Lanyard.new
+
+# this will add the tasks :unlock and :reset
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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 "lanyard"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/lanyard

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require 'docopt'
+require 'lanyard/lanyard_cmd'
+
+command_name = File.basename(__FILE__)
+
+doc = <<DOCOPT
+#{command_name} - helper script to work with OSX keychain
+
+Usage:
+  #{command_name} use-keychain [(-t=Time | --lock-timeout=Time)] (<keychain> <password>)...
+  #{command_name} unuse-keychain <keychain>...
+  #{command_name} (-h | --help)
+
+Options:
+-t=Time, --lock-timeout=Time    lock timeout [default: 7200].
+-h, --help                      show this help message and exit
+
+Commands:
+use-keychain    Add the provided keychains to the lookup list and unlock them with password
+unuse-keychain  Lock keychains and remove them from lookup list
+
+DOCOPT
+
+options = nil
+begin
+  options = Docopt::docopt(doc)
+rescue Docopt::Exit => e
+  puts e.message
+  exit
+end
+
+Lanyard.execute options

data/lanyard.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lanyard/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lanyard"
+  spec.version       = Lanyard::VERSION
+  spec.authors       = ["Manfred Endres"]
+  spec.email         = ["manfred.endres@tslarusso.de"]
+
+  spec.summary       = %q{Handy little tool to work with the OSX toolchain.}
+  spec.homepage      = "http://google.de"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = '~> 2.0'
+  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_runtime_dependency "docopt", "~> 0.5"
+
+  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/lanyard.rb

@@ -0,0 +1,69 @@
+require "lanyard/version"
+require "lanyard/security"
+
+module Lanyard
+  class Lanyard
+    attr_reader :security
+
+    def initialize security=nil
+      @security = security
+      unless @security
+        @security = Security.new
+      end
+    end
+
+    public
+    def use_keychain keychain, password, **options
+      keychain = [keychain] unless keychain.respond_to?('each')
+      password = [password] unless password.respond_to?('each')
+      abort "count of keychains and password need to be equal" if keychain.count != password.count
+
+      security.keychains += keychain
+
+      keychain.zip(password) do |product|
+        keychain = product[0]
+        password = product[1]
+
+        if options.fetch(:unlock, true)
+          security.unlock_keychain(keychain, password)
+          security.set_keychain_settings( keychain:keychain,
+          lock_sleep:true,
+          lock_after_timeout:true,
+          lock_timeout: options.fetch(:lock_timeout, 7200))
+          security.print_keychain_info keychain
+        end
+      end
+    end
+
+    def unuse_keychain keychain, **options
+      keychain = [keychain] unless keychain.respond_to?('each')
+
+      lock_keychain keychain, **options
+      security.keychains -= keychain
+    end
+
+    def lock_keychain keychain, **options
+      keychain = [keychain] unless keychain.respond_to?('each')
+
+      keychain.each {|k|
+        security.lock_keychain k
+      }
+    end
+  end
+
+  def self.use_keychain keychain, password, **options
+    lanyard = Lanyard.new
+    lanyard.use_keychain keychain, password, **options
+  end
+
+  def self.lock_keychain keychain, **options
+    lanyard = Lanyard.new
+    lanyard.lock_keychain keychain, **options
+  end
+
+  def self.unuse_keychain keychain, **options
+    lanyard = Lanyard.new
+    lanyard.unuse_keychain keychain, **options
+  end
+
+end

data/lib/lanyard/lanyard_cmd.rb

@@ -0,0 +1,19 @@
+require 'lanyard'
+
+module Lanyard
+  def self.convert_options options
+    Hash[options.select{|key, value|
+      key.to_s.start_with? '--'
+    }.collect{|key, value|
+      [key.to_s.gsub("--","").gsub("-","_").to_sym, value]
+    }]
+  end
+
+  def self.execute options
+    if options['use-keychain']
+      use_keychain options['<keychain>'], options['<password>'], convert_options(options)
+    elsif options['unuse-keychain']
+      unuse_keychain options['<keychain>'], convert_options(options)
+    end
+  end
+end

data/lib/lanyard/security.rb

@@ -0,0 +1,81 @@
+require 'set'
+require 'open3'
+
+module Lanyard
+  class Security
+
+    OPTIONS = {
+      account:  "-a",
+      creator:  "-c",
+      type:     "-C",
+      kind:     "-D",
+      value:    "-G",
+      comment:  "-j",
+      label:    "-l",
+      service:  "-s"
+    }
+
+    attr_accessor :keychains
+
+    def keychains
+      keychains = []
+      Open3::popen3("security list-keychain -d user") do | stdin, stdout, stderr, wait_thr |
+        stdout.each_line { |line|
+          keychains << line.gsub(/["\s+]/, "")
+        }
+      end
+
+      keychains
+    end
+
+    def keychains= keychains
+      abort "can`t append keychain[s]." unless system "security", "list-keychain", "-d", "user", "-s", *keychains.uniq
+    end
+
+    def unlock_keychain keychain, password
+      abort "can't unlock keychain #{keychain}" unless system "security", "unlock-keychain", "-p", password, keychain
+    end
+
+    def lock_keychain keychain
+      abort "can't lock keychain #{keychain}" unless system "security", "lock-keychain", keychain
+    end
+
+    def set_keychain_settings keychain:nil, verbose:true, lock_sleep:false, lock_after_timeout:false, lock_timeout:7200
+      args = ["security"]
+      args << "-v" if verbose
+      args << "set-keychain-settings"
+      args << "-l" if lock_sleep
+      args << "-ut #{lock_timeout}" if lock_after_timeout
+      args << keychain if keychain
+
+      abort "can't set keychain settings #{keychain}" unless system(*args)
+    end
+
+    def print_keychain_info keychain
+      system "security", "show-keychain-info", keychain
+    end
+
+    def find_generic_password *keychain, **filter_options
+      filter = build_filter_options(**filter_options)
+
+      password = nil
+      Open3::popen3("security", "find-generic-password", *filter + keychain) do | stdin, stdout, stderr, wait_thr |
+        stdout.each_line { |line|
+          if line.start_with? "password: "
+            password = line.sub(/password: "(.*)"/, '\1')
+          end
+        }
+      end
+      password
+    end
+
+    private
+
+    def build_filter_options **filter_options
+      filter_options.sort_by { |k, v| k }.reduce(["-g"]){|memo, obj|
+        memo = memo << Security::OPTIONS[obj[0]] << obj[1] if Security::OPTIONS.has_key? obj[0]
+        memo
+      }
+    end
+  end
+end

data/lib/lanyard/version.rb

@@ -0,0 +1,3 @@
+module Lanyard
+  VERSION = "0.2.0"
+end

data/lib/rake/lanyard_task.rb

@@ -0,0 +1,79 @@
+require 'rake'
+require 'rake/tasklib'
+require 'rake/clean'
+require 'lanyard'
+
+module Rake
+  class LanyardTask < Rake::TaskLib
+
+    attr_accessor :keychain_path
+    def keychain_path
+      @keychain_path ? @keychain_path : "build.keychain"
+    end
+
+    attr_accessor :original_keychain_path
+    def copy_keychain_from file
+      @original_keychain_path = file
+    end
+
+    attr_accessor :keychain_password
+    def keychain_password
+      @keychain_password ? @keychain_password : ""
+    end
+
+    attr_accessor :namespace_name
+    def namespace_name
+      @namespace_name ? @namespace_name.to_sym : nil
+    end
+
+    def initialize keychain_path = nil, keychain_password = nil
+      @keychain_path = keychain_path
+      @keychain_password = keychain_password
+
+      yield self if block_given?
+
+      unless namespace_name.nil?
+        namespace namespace_name do
+          define
+        end
+      else
+        define
+      end
+      self
+    end
+
+    private
+
+    def define_unlock
+      desc "unlock the build keychain"
+      task :unlock => [self.keychain_path] do
+        Lanyard::use_keychain self.keychain_path, self.keychain_password
+        task('keychain:reset').reenable
+      end
+    end
+
+    def define_reset
+      desc "reset and lock the build keychain"
+      task :reset => [self.keychain_path] do
+        Lanyard::unuse_keychain self.keychain_path
+        task('keychain:unlock').reenable
+      end
+    end
+
+    def define_copy_task
+      unless self.original_keychain_path.nil?
+        CLEAN.include(self.keychain_path)
+        desc "copies keychain from #{File.basename self.original_keychain_path}"
+        file self.keychain_path do |t|
+          cp self.original_keychain_path, t.name
+        end
+      end
+    end
+
+    def define
+      define_unlock
+      define_reset
+      define_copy_task
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: lanyard
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Manfred Endres
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: docopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- manfred.endres@tslarusso.de
+executables:
+- lanyard
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/lanyard
+- lanyard.gemspec
+- lib/lanyard.rb
+- lib/lanyard/lanyard_cmd.rb
+- lib/lanyard/security.rb
+- lib/lanyard/version.rb
+- lib/rake/lanyard_task.rb
+homepage: http://google.de
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Handy little tool to work with the OSX toolchain.
+test_files: []