kbsecret 1.2.0 → 1.3.0.pre.1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kbsecret
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0.pre.1
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-14 00:00:00.000000000 Z
+date: 2018-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -225,22 +225,24 @@ files:
 - bin/kbsecret
 - lib/kbsecret.rb
 - lib/kbsecret/cli.rb
-- lib/kbsecret/cli/kbsecret-conf
-- lib/kbsecret/cli/kbsecret-cp
-- lib/kbsecret/cli/kbsecret-dump-fields
-- lib/kbsecret/cli/kbsecret-env
-- lib/kbsecret/cli/kbsecret-generator
-- lib/kbsecret/cli/kbsecret-generators
-- lib/kbsecret/cli/kbsecret-list
-- lib/kbsecret/cli/kbsecret-login
-- lib/kbsecret/cli/kbsecret-new
-- lib/kbsecret/cli/kbsecret-pass
-- lib/kbsecret/cli/kbsecret-raw-edit
-- lib/kbsecret/cli/kbsecret-rm
-- lib/kbsecret/cli/kbsecret-session
-- lib/kbsecret/cli/kbsecret-sessions
-- lib/kbsecret/cli/kbsecret-stash-file
-- lib/kbsecret/cli/kbsecret-todo
+- lib/kbsecret/cli/command.rb
+- lib/kbsecret/cli/command/abstract.rb
+- lib/kbsecret/cli/command/conf.rb
+- lib/kbsecret/cli/command/cp.rb
+- lib/kbsecret/cli/command/dump_fields.rb
+- lib/kbsecret/cli/command/env.rb
+- lib/kbsecret/cli/command/generator.rb
+- lib/kbsecret/cli/command/generators.rb
+- lib/kbsecret/cli/command/list.rb
+- lib/kbsecret/cli/command/login.rb
+- lib/kbsecret/cli/command/new.rb
+- lib/kbsecret/cli/command/pass.rb
+- lib/kbsecret/cli/command/raw_edit.rb
+- lib/kbsecret/cli/command/rm.rb
+- lib/kbsecret/cli/command/session.rb
+- lib/kbsecret/cli/command/sessions.rb
+- lib/kbsecret/cli/command/stash_file.rb
+- lib/kbsecret/cli/command/todo.rb
 - lib/kbsecret/config.rb
 - lib/kbsecret/exceptions.rb
 - lib/kbsecret/generator.rb
@@ -268,9 +270,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.3

data/lib/kbsecret/cli/kbsecret-conf

@@ -1,31 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "kbsecret"
-
-include KBSecret
-
-cmd = CLI.create do |c|
-  c.slop do |o|
-    o.banner = <<~HELP
-      Usage: kbsecret conf [options]
-    HELP
-
-    o.bool "-c", "--commands", "open the commands config (commands.ini)"
-    o.bool "-d", "--directory", "print the path to the config directory"
-    o.bool "-r", "--record-directory", "print the path to the custom record directory"
-  end
-end
-
-KBSecret::CLI.die "You need to set $EDITOR!" unless ENV["EDITOR"]
-
-if cmd.opts.commands?
-  exec "#{ENV["EDITOR"]} #{Config::COMMAND_CONFIG_FILE}"
-elsif cmd.opts.directory?
-  puts Config::CONFIG_DIR
-elsif cmd.opts.record_directory?
-  puts Config::CUSTOM_TYPES_DIR
-else
-  exec "#{ENV["EDITOR"]} #{Config::CONFIG_FILE}"
-end
-

data/lib/kbsecret/cli/kbsecret-cp

@@ -1,44 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "kbsecret"
-include KBSecret
-
-cmd = CLI.create do |c|
-  c.slop do |o|
-    o.banner = <<~HELP
-      Usage:
-        kbsecret cp [options] <source> <destination> <record [record ...]>
-    HELP
-
-    o.bool "-f", "--force", "force copying (ignore overwrites)"
-    o.bool "-m", "--move", "delete the record after copying"
-  end
-
-  c.dreck do
-    string :src_sess
-    string :dst_sess
-    list :string, :labels
-  end
-end
-
-cmd.guard do
-  src_sess = Session[cmd.args[:src_sess]]
-  dst_sess = Session[cmd.args[:dst_sess]]
-
-  selected_records = src_sess.records.select { |r| cmd.args[:labels].include?(r.label) }
-  cmd.die "No such record(s)." if selected_records.empty?
-
-  overlaps = dst_sess.record_labels & selected_records.map(&:label)
-
-  # the code below actually handles the overwriting if necessary, but we fail early here for
-  # friendliness and to avoid half-copying the selected records
-  unless overlaps.empty? || cmd.opts.force?
-    cmd.die "Refusing to overwrite existing record(s) without --force."
-  end
-
-  selected_records.each do |record|
-    dst_sess.import_record(record, overwrite: cmd.opts.force?)
-    src_sess.delete_record(label) if cmd.opts.move?
-  end
-end

data/lib/kbsecret/cli/kbsecret-dump-fields

@@ -1,39 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "kbsecret"
-
-include KBSecret
-
-cmd = CLI.create do |c|
-  c.slop do |o|
-    o.banner = <<~HELP
-      Usage:
-        kbsecret dump-fields [options] <record>
-    HELP
-
-    o.string "-s", "--session", "the session to search in", default: :default
-    o.bool "-x", "--terse", "output in field<sep>value format"
-    o.string "-i", "--ifs", "separate terse pairs with this string", default: CLI.ifs
-  end
-
-  c.dreck do
-    string :label
-  end
-
-  c.ensure_session!
-end
-
-label   = cmd.args[:label]
-record  = cmd.session[label]
-
-cmd.die "No such record." unless record
-
-field_values = record.data_fields.map { |f| record.send f }
-field_pairs  = record.data_fields.zip(field_values)
-
-if cmd.opts.terse?
-  puts field_pairs.map { |f, v| "#{f}#{cmd.opts[:ifs]}#{v}" }.join "\n"
-else
-  puts field_pairs.map { |f, v| "#{f}: #{v}" }.join "\n"
-end

data/lib/kbsecret/cli/kbsecret-env

@@ -1,53 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "kbsecret"
-
-include KBSecret
-
-cmd = CLI.create do |c|
-  c.slop do |o|
-    o.banner = <<~HELP
-      Usage:
-        kbsecret env [options] <record [record ...]>
-    HELP
-
-    o.string "-s", "--session", "the session to search in", default: :default
-    o.bool "-a", "--all", "retrieve all environment records, not just listed ones"
-    o.bool "-v", "--value-only", "print only the environment value, not the key"
-    o.bool "-n", "--no-export", "print only VAR=val keypairs without `export`"
-    o.bool "-u", "--unescape-plus", "escape any pluses in the variable and/or value"
-  end
-
-  unless c.opts.all?
-    c.dreck do
-      list :string, :labels
-    end
-  end
-
-  c.ensure_session!
-end
-
-records = cmd.session.records :environment
-
-selected_records = if cmd.opts.all?
-                     records
-                   else
-                     records.select do |record|
-                       cmd.args[:labels].include? record.label
-                     end
-                   end
-
-cmd.die "No such record(s)." if selected_records.empty?
-
-env_output = if cmd.opts.no_export?
-               selected_records.map(&:to_assignment).join(" ")
-             elsif cmd.opts.value_only?
-               selected_records.map(&:value).join("\n")
-             else
-               selected_records.map(&:to_export).join("\n")
-             end
-
-env_output.gsub!("\\+", "+") if cmd.opts.unescape_plus?
-
-puts env_output

data/lib/kbsecret/cli/kbsecret-generator

@@ -1,42 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "kbsecret"
-
-include KBSecret
-
-cmd = CLI.create do |c|
-  c.slop cmds: %w[new rm] do |o|
-    o.banner = <<~HELP
-      Usage:
-        kbsecret generator [options] <new|rm> <generator>
-    HELP
-
-    o.string "-F", "--format", "the format of the secrets generated", default: "hex"
-    o.integer "-l", "--length", "the length, in bytes, of the secrets generated",
-              default: 16
-    o.bool "-f", "--force", "force generator creation (ignore overwrite)"
-  end
-
-  c.dreck do
-    string :command
-    string :generator
-  end
-
-  c.ensure_generator! :argument if c.args[:command] == "rm"
-end
-
-case cmd.args[:command]
-when "new"
-  if Config.generator?(cmd.args[:generator]) && !cmd.opts.force?
-    cmd.die "Refusing to overwrite an existing generator without --force."
-  end
-
-  Config.configure_generator(cmd.args[:generator],
-                             format: cmd.opts[:format],
-                             length: cmd.opts[:length])
-when "rm"
-  Config.deconfigure_generator(cmd.args[:generator])
-else
-  cmd.die "Unknown subcommand: '#{cmd.args[:command]}'."
-end

data/lib/kbsecret/cli/kbsecret-generators

@@ -1,28 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "kbsecret"
-
-include KBSecret
-
-cmd = CLI.create do |c|
-  c.slop do |o|
-    o.banner = <<~HELP
-      Usage:
-        kbsecret generators [options]
-    HELP
-
-    o.bool "-a", "--show-all", "show each generator in depth (i.e. metadata)"
-  end
-end
-
-Config[:generators].each do |label, config|
-  puts label
-
-  next unless cmd.opts.show_all?
-
-  puts <<~DETAIL
-    \tFormat: #{config[:format]}
-    \tLength: #{config[:length]}
-  DETAIL
-end

data/lib/kbsecret/cli/kbsecret-list

@@ -1,36 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "kbsecret"
-
-include KBSecret
-
-cmd = CLI.create do |c|
-  c.slop do |o|
-    o.banner = <<~HELP
-      Usage:
-        kbsecret list [options]
-    HELP
-
-    o.string "-s", "--session", "the session to list from", default: :default
-    o.string "-t", "--type", "the type of secrets to list", default: nil
-    o.bool "-a", "--show-all", "show everything in each secret (i.e. metadata)"
-  end
-
-  c.ensure_type! if c.opts[:type]
-  c.ensure_session!
-end
-
-records = cmd.session.records cmd.opts[:type]
-
-records.each do |record|
-  puts record.label
-
-  next unless cmd.opts.show_all?
-
-  puts <<~DETAIL
-    \tType: #{record.type}
-    \tLast changed: #{Time.at(record.timestamp)}
-    \tRaw data: #{record.data}
-  DETAIL
-end

data/lib/kbsecret/cli/kbsecret-login

@@ -1,53 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "kbsecret"
-
-include KBSecret
-
-cmd = CLI.create do |c|
-  c.slop do |o|
-    o.banner = <<~HELP
-      Usage:
-        kbsecret login [options] <record [record ...]>
-    HELP
-
-    o.string "-s", "--session", "the session to search in", default: :default
-    o.bool "-a", "--all", "retrieve all login records, not just listed ones"
-    o.bool "-x", "--terse", "output in label<sep>username<sep>password format"
-    o.string "-i", "--ifs", "separate terse fields with this string", default: CLI.ifs
-  end
-
-  unless c.opts.all?
-    c.dreck do
-      list :string, :labels
-    end
-  end
-
-  c.ensure_session!
-end
-
-records = cmd.session.records :login
-
-selected_records = if cmd.opts.all?
-                     records
-                   else
-                     records.select do |record|
-                       cmd.args[:labels].include? record.label
-                     end
-                   end
-
-cmd.die "No such record(s)." if selected_records.empty?
-
-selected_records.each do |record|
-  if cmd.opts.terse?
-    fields = %i[label username password].map { |m| record.send(m) }
-    puts fields.join(cmd.opts[:ifs])
-  else
-    puts <<~DETAIL
-      Label: #{record.label}
-      \tUsername: #{record.username}
-      \tPassword: #{record.password}
-    DETAIL
-  end
-end

data/lib/kbsecret/cli/kbsecret-new

@@ -1,68 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "kbsecret"
-require "abbrev"
-require "tty-prompt"
-
-include KBSecret
-
-cmd = CLI.create do |c|
-  c.slop do |o|
-    o.banner = <<~HELP
-      Usage:
-        kbsecret new [options] <type> <label>
-    HELP
-
-    o.string "-s", "--session", "the session to contain the record", default: :default
-    o.bool "-f", "--force", "force creation (ignore overwrites, etc.)"
-    o.bool "-e", "--echo", "echo input to tty (only affects interactive input)"
-    o.bool "-G", "--generate", "generate secret fields (interactive only)"
-    o.string "-g", "--generator", "the generator to use for secret fields",
-             default: :default
-    o.bool "-x", "--terse", "read fields from input in a terse format"
-    o.string "-i", "--ifs", "separate terse fields with this string", default: CLI.ifs
-  end
-
-  c.dreck do
-    string :type
-    string :label
-  end
-
-  c.ensure_generator!
-  c.ensure_type! :argument
-  c.ensure_session!
-end
-
-type          = cmd.args[:type]
-label         = cmd.args[:label]
-resolved_type = CLI::TYPE_ALIASES[type]
-
-# the code below actually handles the overwriting if necessary, but we fail early here
-# for friendliness and to avoid prompting the user for input unnecessarily
-if cmd.session.record?(label) && !cmd.opts.force?
-  cmd.die "Refusing to overwrite an existing record without --force."
-end
-
-if cmd.opts.generate?
-  generator = cmd.guard { Generator.new cmd.opts[:generator] }
-end
-
-fields = if cmd.opts.terse?
-           STDIN.read.chomp.split cmd.opts[:ifs]
-         else
-           prompt = TTY::Prompt.new
-           klass = Record.class_for(resolved_type)
-           klass.external_fields.map do |field|
-             if cmd.opts.generate? && klass.sensitive?(field)
-               generator.secret
-             else
-               prompt.ask "#{field.capitalize}?",
-                          echo: !klass.sensitive?(field) || cmd.opts.echo?
-             end
-           end
-         end
-
-cmd.guard do
-  cmd.session.add_record resolved_type, label, *fields, overwrite: cmd.opts.force?
-end

data/lib/kbsecret/cli/kbsecret-pass

@@ -1,37 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "kbsecret"
-require "clipboard"
-
-include KBSecret
-
-cmd = CLI.create do |c|
-  c.slop do |o|
-    o.banner = <<~HELP
-      Usage:
-        kbsecret pass [options] <record>
-    HELP
-
-    o.string "-s", "--session", "the session to search in", default: :default
-    o.bool "-c", "--clipboard", "dump the password in the clipboard"
-  end
-
-  c.dreck do
-    string :label
-  end
-
-  c.ensure_session!
-end
-
-label   = cmd.args[:label]
-record  = cmd.session[label]
-
-cmd.die "No such record." unless record
-cmd.die "'#{record}' is not a login record." unless record.type == :login
-
-if cmd.opts.clipboard?
-  Clipboard.copy record.password
-else
-  puts record.password
-end

data/lib/kbsecret/cli/kbsecret-raw-edit

@@ -1,31 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "kbsecret"
-
-include KBSecret
-
-cmd = CLI.create do |c|
-  c.slop do |o|
-    o.banner = <<~HELP
-      Usage:
-        kbsecret raw-edit [options] <record>
-    HELP
-
-    o.string "-s", "--session", "the session to search in", default: :default
-  end
-
-  c.dreck do
-    string :label
-  end
-
-  c.ensure_session!
-end
-
-label   = cmd.args[:label]
-record  = cmd.session[label]
-
-cmd.die "No such record." unless record
-
-Process.spawn("#{ENV["EDITOR"]} #{record.path}")
-record.sync! # just to bump the timestamp

data/lib/kbsecret/cli/kbsecret-rm

@@ -1,44 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "kbsecret"
-require "tty-prompt"
-
-include KBSecret
-
-$VERBOSE = nil # tty-prompt blasts us with irrelevant warnings on 2.4
-
-cmd = CLI.create do |c|
-  c.slop do |o|
-    o.banner = <<~HELP
-      Usage:
-        kbsecret rm [options] <record [record ...]>
-    HELP
-
-    o.string "-s", "--session", "the session containing the record", default: :default
-    o.bool "-i", "--interactive", "ask for confirmation before deleting"
-  end
-
-  c.dreck do
-    list :string, :labels
-  end
-
-  c.ensure_session!
-end
-
-records = cmd.session.records
-
-selected_records = records.select do |record|
-  cmd.args[:labels].include? record.label
-end
-
-cmd.die "No such record(s)." if selected_records.empty?
-
-tty = TTY::Prompt.new
-
-confirm = if cmd.opts.interactive?
-            tty.yes?("Delete '#{selected_records.join(", ")}' from the #{cmd.session.label} session?")
-          else true
-          end
-
-selected_records.each { |r| cmd.session.delete_record(r.label) } if confirm

data/lib/kbsecret/cli/kbsecret-session

@@ -1,105 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "kbsecret"
-
-include KBSecret
-
-def new_session(label, cmd)
-  if Config.session?(label) && !cmd.opts.force?
-    cmd.die "Refusing to overwrite an existing session without --force."
-  end
-
-  if cmd.opts[:team]
-    teams = Keybase::Local::Team.list_self_memberships.teams
-
-    unless teams.map(&:fq_name).include?(cmd.opts[:team])
-      if cmd.opts.create_team?
-        cmd.guard do
-          Keybase::Local::Team.create_team cmd.opts[:team]
-          Keybase::Local::Team.add_members cmd.opts[:team], users: [{
-            username: Keybase::Local.current_user,
-            role: "admin",
-          }]
-        end
-      else
-        cmd.die "No such team (either nonexistent or non-member)."
-      end
-    end
-
-    Config.configure_session(label, team: cmd.opts[:team], root: label)
-  else
-    cmd.die "Missing `-r', `--root' option." unless cmd.opts[:root]
-
-    cmd.opts[:users].each do |user|
-      cmd.die "Nonexistent Keybase user: '#{user}'." unless Keybase::API.user? user
-    end
-
-    unless cmd.opts[:users].include? Keybase::Local.current_user
-      cmd.warn "You didn't include yourself in the user list, but I'll add you."
-      cmd.opts[:users] << Keybase::Local.current_user
-    end
-
-    Config.configure_session(label, users: cmd.opts[:users], root: cmd.opts[:root])
-
-    unless cmd.opts.no_notify? && cmd.opts[:users] != [Keybase::Local.current_user]
-      users = cmd.opts[:users].join(",")
-
-      Keybase::Local::Chat.send_message cmd.opts[:users], <<~MESSAGE
-        You've been added to a KBSecret session!
-
-        To access this session, please run the following:
-
-        ```
-          $ kbsecret session new -r '#{cmd.opts[:root]}' -u #{users} <label>
-        ```
-
-        If you don't have KBSecret installed, you can install it from `gem`:
-
-        ```
-          $ gem install kbsecret
-        ```
-      MESSAGE
-    end
-  end
-end
-
-def rm_session(label, cmd)
-  cmd.session.unlink! if cmd.opts.delete?
-  Config.deconfigure_session label
-end
-
-cmd = CLI.create do |c|
-  c.slop cmds: %w[new rm] do |o|
-    o.banner = <<~HELP
-      Usage:
-        kbsecret session [options] <new|rm> <label>
-    HELP
-
-    o.string "-t", "--team", "the team to create the session under"
-    o.array "-u", "--users", "the Keybase users", default: [Keybase::Local.current_user]
-    o.string "-r", "--root", "the secret root directory"
-    o.bool "-c", "--create-team", "create the Keybase team if it does not exist"
-    o.bool "-f", "--force", "force creation (ignore overwrites, etc.)"
-    o.bool "-n", "--no-notify", "do not send a notification to session members"
-    o.bool "-d", "--delete", "unlink the session in addition to deconfiguration"
-  end
-
-  c.dreck do
-    string :command
-    string :session
-  end
-
-  c.ensure_session! :argument if c.args[:command] == "rm"
-end
-
-session_label = cmd.args[:session]
-
-case cmd.args[:command]
-when "new"
-  new_session session_label, cmd
-when "rm"
-  rm_session session_label, cmd
-else
-  cmd.die "Unknown subcommand: '#{cmd.args[:command]}'."
-end