lastpass-cli 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a4dc2da94a48fdd5613b4fda4fffb0307f39eeb
+  data.tar.gz: db2b116fc2ae63db6320eef6a4ec9cfc2cfd99c8
+SHA512:
+  metadata.gz: e546282f422ee7a70c2a066beb479a296f1de96ad22aa8d8ae37f16ab1acbc8836b319bea7f43545741789cdb1ff991bb4da20e004df12b72539c9cec87bb302
+  data.tar.gz: b458d529ff4edd7a6d139ab1560d0d9764c5a354d95e6d6a3ef6b956a2a97cca8700f115000e25f25014f792e4187bfad5071050d3c8c89a3d9e3f053e609781

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.5
+before_install: gem install bundler -v 1.13.7

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Quantifi
+
+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,93 @@
+# LastPassCLI-Ruby
+
+LastPassCLI-Ruby uses the [LastPass Command Line Interface](https://github.com/lastpass/lastpass-cli) to add passwords, notes, and other secure items to the LastPass password management service, and to read those same items.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lastpass-cli'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lastpass-cli
+
+Add your LastPass credentials to environment variables named `LASTPASS_EMAIL` and `LASTPASS_PASSWORD`. For development and test environments, consider using something like [dotenv](https://github.com/bkeepers/dotenv).
+
+For use with Ruby on Rails, create the initializer with the following command:
+
+```
+rails generate lastpass_cli
+```
+
+If you're not using Rails, configure the gem like this:
+
+```rb
+LastpassCLI.configure do |config|
+  config.username = ENV['LASTPASS_EMAIL']
+  config.password = ENV['LASTPASS_PASSWORD']
+end
+```
+
+Since LastPassCLI-Ruby is a wrapper for [lastpass-cli](https://github.com/lastpass/lastpass-cli), you'll need to install that too.
+
+For Linux, FreeBSD, or Cygwin, see the [installation instructions in the README](https://github.com/lastpass/lastpass-cli#installing-on-linux).
+
+For macOS or OS X, you can install `lastpass-cli` with [Homebrew](http://brew.sh/) (`brew install lastpass-cli --with-pinentry`) or [MacPorts](https://www.macports.org/) (`sudo port install lastpass-cli`).
+
+## Usage
+
+### Reading items from LastPass
+
+Look up items by Unique ID or name (with optional folder).
+
+```rb
+LastpassCLI.show("SOME_UNIQUE_ID")  # by Unique ID
+LastpassCLI.show("github")          # by name
+LastpassCLI.show("social/linkedin") # by name with folder
+LastpassCLI.show("ssn")             # works with non-password items as well
+```
+
+### Adding items to LastPass
+
+```rb
+LastpassCLI.add_password(
+    "social/twitter",
+    username: "someone",
+    password: "$0m3thing-$3cr3t!",
+    url: "https://twitter.com",
+    notes: "Use it wisely."
+)
+```
+
+You can also check out the [usage instructions for `lastpass-cli` itself](https://lastpass.github.io/lastpass-cli/lpass.1.html).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+For convenience, you may want to add your LastPass credentials to `bin/console`, but remember not to commit them to the repository! For example, just above `Pry.start` in `bin/console`:
+
+```rb
+LastpassCLI.configure do |config|
+  config.username = "myLastpassUsername"
+  config.password = "My LastPass passw0rd!"
+end
+```
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/QuantifiAi/lastpass-cli.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lastpass-cli"
+require "pry"
+
+# 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.
+# initializer
+
+Pry.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/generators/lastpass_cli/lastpass_cli_generator.rb

@@ -0,0 +1,7 @@
+class LastpassCliGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.file 'lastpass_cli.rb', 'config/initializers/lastpass_cli.rb'
+    end
+  end
+end

data/generators/lastpass_cli/templates/lastpass_cli.rb

@@ -0,0 +1,14 @@
+# LastPass CLI Global Configuration
+#
+# Use this to set up shared configuration options for your entire application.
+#
+# To learn more, check out the README:
+#
+# https://github.com/QuantifiAi/lastpass-cli-ruby/blob/master/README.md
+
+LastpassCLI.configure do |config|
+  # Credentials of the LastPass account to sync with
+  # Stored in an environment variable, by default
+  config.username = ENV['LASTPASS_EMAIL']
+  config.password = ENV['LASTPASS_PASSWORD']
+end

data/lastpass-cli.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lastpass-cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lastpass-cli"
+  spec.version       = LastpassCLI::VERSION
+  spec.authors       = ["David Jones", "Dave Strus"]
+  spec.email         = ["unixmonkey1@gmail.com", "dave@getfretless.com"]
+
+  spec.summary       = %q{A Ruby wrapper for the LastPass CLI}
+  spec.description   = %q{A Ruby wrapper for the LastPass CLI}
+  spec.homepage      = "https://github.com/QuantifiAi/lastpass-cli-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry", "~> 0.11"
+end

data/lib/generators/lastpass_cli_generator.rb

@@ -0,0 +1,11 @@
+if defined?(Rails) && Rails::VERSION::MAJOR != 2
+  
+    # Rails3 generator invoked with 'rails generate lastpass_cli'
+    class LastpassCliGenerator < Rails::Generators::Base
+      source_root(File.expand_path(File.dirname(__FILE__) + '/../../generators/lastpass_cli/templates'))
+      def copy_initializer
+        copy_file 'lastpass_cli.rb', 'config/initializers/lastpass_cli.rb'
+      end
+    end
+  
+  end

data/lib/lastpass-cli.rb

@@ -0,0 +1,66 @@
+require "lastpass-cli/version"
+require "lastpass-cli/configuration"
+require "lastpass-cli/agent"
+require "lastpass-cli/command"
+require "lastpass-cli/item"
+
+module LastpassCLI
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset_configuration!
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.items
+    items = []
+    out = Command.run(Command.new.ls)
+    if !out.nil? && out != ""
+      out.each_line do |line|
+        match_data = line.match(/(?<modified_at>\d{4}-\d{2}-\d{2} \d{2}:\d{2}) (?<folder>.+)\/(?<name>.+) \[id: (?<id>.*)\] \[username:\s?(?<username>.+)\]/)
+        attributes = Hash[match_data.names.zip(match_data.captures)]
+        items << Item.new(attributes)
+      end
+    end
+    items
+  end
+
+  def self.show(name)
+    items = []
+    out = Command.run(Command.new.show(name: name))
+    if !out.nil? && out != "" && !out.start_with?("Error: ")
+      out.each_line do |line|
+        id_match = line.match(/^((?<folder>.*)\/)?(?<name>.*) \[id: (?<id>.*)\]/)
+        if id_match
+          items << Item.new(id: id_match[:id], folder: id_match[:folder], name: id_match[:name])
+        else
+          match_data = line.match(/^(?<key>.*): (?<value>.*)$/)
+          items.last.set(match_data[:key].downcase, match_data[:value])
+        end
+      end
+    end
+    items
+  end
+
+  def self.add_password(name, username:, password:, notes: nil, url: nil)
+    stdin_data = "Username:#{username}\nPassword:#{password}\n"
+    stdin_data << "URL:#{url}\n" if url
+    stdin_data << "Notes:\n#{notes}\n" if notes
+    Command.run(Command.new.add(name: name), stdin_data: stdin_data)
+    show(name)
+  end
+
+  def self.add_note(name, note_type: nil, notes: nil, data: {})
+    stdin_data = ""
+    data.each do |field, value|
+      stdin_data << "#{field.capitalize}:#{value}\n"
+    end
+    stdin_data << "Notes:\n#{notes}\n"
+    Command.run(Command.new.add(name: name, note_type: note_type), stdin_data: stdin_data)
+  end
+end

data/lib/lastpass-cli/agent.rb

@@ -0,0 +1,40 @@
+module LastpassCLI
+  class Agent
+    attr_reader :logged_in, :config
+
+    def initialize
+      @config = LastpassCLI.configuration
+    end
+
+    def login
+      return true if logged_in?
+      command = [config.executable]
+      command += Command.new.login(username: config.username)
+      out, _, _ = Open3.capture2e(
+        { 'LPASS_DISABLE_PINENTRY' => '1' },
+        *command,
+        stdin_data: "#{config.password}\n"
+      )
+      !!out.match('Success: Logged in')
+    end
+
+    def logout
+      return true if logged_out?
+      command = [config.executable]
+      command += Command.new.logout
+      out, _, _ = Open3.capture2e(*command)
+      !!out.match('Log out: complete')
+    end
+
+    def logged_in?
+      command = [config.executable]
+      command += Command.new.status
+      out, _, _ = Open3.capture2e(*command)
+      !!out.match('Logged in as')
+    end
+
+    def logged_out?
+      !logged_in?
+    end
+  end
+end

data/lib/lastpass-cli/command.rb

@@ -0,0 +1,58 @@
+require 'open3'
+
+module LastpassCLI
+  class Command
+    def self.run(args, stdin_data: nil)
+      raise unless Agent.new.login
+      command = [LastpassCLI.configuration.executable]
+      command += args
+      out, _, _ = Open3.capture2e(*command, stdin_data: stdin_data)
+      out
+    rescue StandardError => e
+      raise "Failed to execute:\n#{command}\nError: #{e}"
+    end
+
+    def login(username:, trust: false, plaintext_key: false, force: false)
+      args = ['login', username]
+      args << '--plaintext-key' if plaintext_key
+      args << '--force' if force
+      args
+    end
+
+    def logout(force: true)
+      args = ['logout']
+      args << '--force' if force
+      args
+    end
+
+    def ls(sync: 'now')
+      raise unless %w[auto now no].include?(sync)
+      args = ['ls', '--long']
+      args << "--sync=#{sync}"
+      args
+    end
+
+    def status(quiet: false)
+      args = ['status']
+      args << '--quiet' if quiet
+      args
+    end
+
+    def show(name:, sync: 'now', expand_multi: true)
+      raise unless %w[auto now no].include?(sync)
+      args = ['show', '--all']
+      args << "--sync=#{sync}"
+      args << '--expand-multi' if expand_multi
+      args << name
+      args
+    end
+
+    def add(name:, sync: 'now', note_type: nil)
+      raise unless %w[auto now no].include?(sync)
+      args = ['add', '--non-interactive']
+      args << "--sync=#{sync}"
+      args << "--note-type=#{note_type}" if note_type
+      args << name
+    end
+  end
+end

data/lib/lastpass-cli/configuration.rb

@@ -0,0 +1,9 @@
+module LastpassCLI
+  class Configuration
+    attr_accessor :username, :password, :executable
+
+    def initialize
+      @executable = 'lpass'
+    end
+  end
+end

data/lib/lastpass-cli/item.rb

@@ -0,0 +1,27 @@
+module LastpassCLI
+  class Item
+    def self.attributes
+      %w[id name folder username modified_at password notes number url]
+    end
+
+    attr_accessor *attributes
+
+    def initialize(attrs)
+      attrs.each do |k, v|
+        set(k.to_s, v)
+      end
+    end
+
+    def set(attribute, value)
+      if self.class.attributes.include?(attribute)
+        send("#{attribute}=", value)
+      end
+    end
+
+    def to_h
+      self.class.attributes.each_with_object({}) do |attr, hsh|
+        hsh[attr] = send(attr)
+      end
+    end
+  end
+end

data/lib/lastpass-cli/version.rb

@@ -0,0 +1,3 @@
+module LastpassCLI
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: lastpass-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- David Jones
+- Dave Strus
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: A Ruby wrapper for the LastPass CLI
+email:
+- unixmonkey1@gmail.com
+- dave@getfretless.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- generators/lastpass_cli/lastpass_cli_generator.rb
+- generators/lastpass_cli/templates/lastpass_cli.rb
+- lastpass-cli.gemspec
+- lib/generators/lastpass_cli_generator.rb
+- lib/lastpass-cli.rb
+- lib/lastpass-cli/agent.rb
+- lib/lastpass-cli/command.rb
+- lib/lastpass-cli/configuration.rb
+- lib/lastpass-cli/item.rb
+- lib/lastpass-cli/version.rb
+homepage: https://github.com/QuantifiAi/lastpass-cli-ruby
+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.6.14
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the LastPass CLI
+test_files: []