fenton_shell 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 895dc5bdb745a8ffeab2ff9bd7c4cf26f0773edb
+  data.tar.gz: a698dfdb443b99f0ec17937ac7df2348bdb12805
+SHA512:
+  metadata.gz: c8df7410c4186b02596dd66d7352ecfd1bd74f65d177d7efd400095708d60bbf1060678f6352940f08a701e91830f051d90e18be8774e14c00ef574d1312ddf8
+  data.tar.gz: 2c69907bd99a22cfec5fd6b40cb5bd6dfddf98697f9f7c20b26a1f650ac7bcea10d12cc614dd3f9a660c4e787f39b6709cd94e9f6b8f864b639d365487a95e62

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,93 @@
+# Fenton Shell
+
+Interacts with Fenton Server to download a signed SSH key for authentication to a server running OpenSSH 5.9+ and configured to use SSH Certificate authentication for the Fenton Project
+
+[Fenton Project](https://fenton-project.github.io/) - SSH Key Management
+
+## Production Deployment
+
+Not recommended at this time
+
+```sh
+gem install fenton_shell -P MediumSecurity
+```
+
+### Shell Completion
+
+```sh
+complete -F get_fenton_targets fenton
+function get_fenton_targets()
+{
+  if [ -z $2 ] ; then
+    COMPREPLY=(`fenton help -c`)
+  else
+    COMPREPLY=(`fenton help -c $2`)
+  fi
+}
+```
+
+## Developer Setup
+
+#### Getting started
+
+```sh
+git clone git@github.com:fenton-project/fenton_shell.git
+cd fenton_shell
+bundle install
+bundle exec ./bin/fenton
+```
+
+#### Ruby version
+
+  See [gemspec](fenton_shell.gemspec)
+
+#### System dependencies
+
+  OpenSSH 5.9 or higher
+
+#### Configuration
+
+  Fenton creates configuration files here: `~/.fenton/`
+
+#### How to run the test suite
+
+    bundle exec rake test
+    bundle exec rake features
+
+#### Build documentation
+
+    bundle exec rake yard
+    bundle exec yard server
+
+## Contributing
+
+- Open an issue (please note if you'll be working on it or need assistance)
+- Fork the project and do your work in a topic branch.
+- Rebase your branch to make sure everything is up to date.
+- Commit your changes & tests, then send a pull request.
+
+## License
+
+#### Author
+
+  Nick Willever (<nickwillever@gmail.com>)
+
+#### Copyright
+
+  Copyright (c) 2013-2016 Nick Willever
+
+#### License
+
+Apache License, Version 2.0
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -0,0 +1,84 @@
+require 'bundler/gem_tasks'
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'yard'
+require 'cucumber'
+require 'cucumber/rake/task'
+require 'rubocop/rake_task'
+require 'digest/sha2'
+require 'bundler/audit/cli'
+require 'mixlib/shellout'
+
+RuboCop::RakeTask.new
+
+# http://www.rubydoc.info/gems/yard/file/docs/Tags.md
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb', '-', 'bin/**/*']
+  t.stats_options = ['--list-undoc']
+end
+
+spec = eval(File.read('fenton_shell.gemspec'))
+
+Gem::PackageTask.new(spec) do |pkg|
+end
+
+CUKE_RESULTS = 'coverage/results.html'.freeze
+CLEAN << CUKE_RESULTS
+
+desc 'Run features'
+Cucumber::Rake::Task.new(:features) do |t|
+  opts = "features --format html -o #{CUKE_RESULTS} --format progress -x"
+  opts += " --tags #{ENV['TAGS']}" if ENV['TAGS']
+  t.cucumber_opts = opts
+  t.fork = false
+end
+
+desc 'Run features tagged as work-in-progress (@wip)'
+Cucumber::Rake::Task.new('features:wip') do |t|
+  tag_opts = ' --tags ~@pending'
+  tag_opts += ' --tags @wip'
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} " \
+    "--format pretty -x -s#{tag_opts}"
+  t.fork = false
+end
+
+task cucumber: :features
+task 'cucumber:wip' => 'features:wip'
+task wip: 'features:wip'
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb']
+end
+
+name = Gem::PackageTask.new(spec).name
+
+desc "Write checksum for #{name}.gem file"
+task 'package:checksum' do
+  built_gem_path = "pkg/#{name}.gem"
+  checksum = Digest::SHA512.new.hexdigest(File.read(built_gem_path))
+  checksum_path = "checksum/#{name}.gem.sha512"
+  File.open(checksum_path, 'w') { |f| f.write(checksum) }
+end
+
+namespace :bundler do
+  desc 'Updates the ruby-advisory-db and runs audit'
+  task :audit do
+    %w(update check).each do |command|
+      Bundler::Audit::CLI.start [command]
+    end
+  end
+end
+
+desc 'RubyCritic'
+task 'rubycritic' do
+  command = Mixlib::ShellOut.new('rubycritic -f console -s 100')
+  command.live_stdout = $stdout
+  command.live_stderr = $stderr
+  command.run_command
+  exit command.exitstatus
+end
+
+task default: [:test, :features]

data/bin/fenton

@@ -0,0 +1,267 @@
+#!/usr/bin/env ruby
+
+require 'fenton_shell'
+require 'gli'
+
+include GLI::App
+include FentonShell
+
+program_desc 'manage and sign SSH Keys from Fenton Server'
+
+desc 'Show current version number'
+version FentonShell::VERSION
+
+desc 'Be verbose'
+switch 'verbose'
+
+sort_help :manually
+
+pre_config = begin
+               YAML.load_file("#{Dir.home}/.fenton/config")
+             rescue
+               {}
+             end
+private_key_default = begin
+                        pre_config[:public_key].gsub('.pub', '')
+                      rescue
+                        "#{Dir.home}/.ssh/id_rsa"
+                      end
+public_key_default = "#{private_key_default}.pub"
+
+default_fenton_directory = "#{Dir.home}/.fenton"
+
+flag [:z, :fenton_server_url],
+     desc: 'Fenton Server URL',
+     default_value: pre_config[:fenton_server_url] || 'http://localhost:9292'
+flag [:d, :directory], desc: 'Fenton Directory Path',
+                       default_value: default_fenton_directory
+
+desc 'Client Management'
+arg_name 'client'
+
+command :client do |c|
+  c.default_desc 'Manage Clients'
+
+  c.flag [:name], desc: 'Name'
+  c.flag [:email], desc: 'Email'
+  c.flag [:password], desc: 'Password'
+  c.flag [:public_key], desc: 'SSH Public Key',
+                        default_value: public_key_default
+
+  @config = ConfigFile.new
+  @client = Client.new
+
+  c.desc 'Create an account (<username> --name --email --password --public_key)'
+  arg_name 'signup'
+
+  c.command :signup do |c1|
+    c1.action do |global_options, options, args|
+      help_now!('username is required') if args.empty?
+      options[:username] = args.join(' ')
+
+      puts "Creating client with username: #{options[:username]}\n"
+      puts "Using public key: #{options['public_key']}\n\n"
+      options[:name] ||= ask('Name: ')
+      options[:email] ||= ask('Email: ')
+      options[:password] ||= ask('Create a password: ') { |i| i.echo = '*' }
+
+      help_now!('username is required') if options[:username].nil?
+      help_now!('name is required') if options[:name].nil?
+      help_now!('email is required') if options[:email].nil?
+      help_now!('password is required') if options[:password].nil?
+      help_now!('public_key is required') if options[:public_key].nil?
+
+      exit_now!("#{options[:public_key]} does not exist" \
+          ', please create one with ' \
+          '`fenton keys generate -h`') unless File.exist?(options[:public_key])
+
+      if @client.create_with_organization(global_options, options)
+        if File.exist?("#{global_options[:directory]}/config")
+          answer = ask('File exists ' \
+            "#{global_options[:directory]}/config, overwrite? (y/N) ")
+          exit_now!('Please choose a different path') unless answer =~ %r{^y$}i
+        end
+
+        @config.create(global_options, options)
+
+        puts
+        puts @client.message
+      else
+        exit_now!(@client.message)
+      end
+    end
+  end
+end
+
+desc 'Organization Management'
+arg_name 'organization'
+
+command :organization do |c|
+  c.default_desc 'Manage Organizations'
+
+  c.flag [:key], desc: 'Key'
+
+  @organization = Organization.new
+
+  c.desc 'Create an organization (<name> --key)'
+  arg_name 'create'
+
+  c.command :create do |c1|
+    c1.action do |global_options, options, args|
+      help_now!('name is required') if args.empty?
+      options[:name] = args.join(' ')
+
+      help_now!('key is required') if options[:key].nil?
+
+      puts "Creating organization with name: #{options[:name]}\n\n"
+
+      if @organization.create(global_options, options)
+        puts @organization.message
+      else
+        exit_now!(@organization.message)
+      end
+    end
+  end
+end
+
+desc 'Project Management'
+arg_name 'project'
+
+command :project do |c|
+  c.default_desc 'Manage Projects'
+
+  c.flag [:key], desc: 'Key (unique short acronym for the project)'
+  c.flag [:description], desc: 'Description'
+  c.flag [:passphrase], desc: 'Passphrase'
+  c.flag [:organization], desc: 'Organization Key (default: client username)'
+
+  @project = Project.new
+
+  c.desc 'Create a project (<name> --key --description ' \
+    '--passphrase --organization)'
+  arg_name 'create'
+
+  c.command :create do |c1|
+    c1.action do |global_options, options, args|
+      help_now!('name is required') if args.empty?
+      options[:name] = args.join(' ')
+
+      options[:organization] ||= ConfigFile.default_organization(global_options)
+
+      puts "Creating project #{options[:name]} " \
+        "under organization #{options[:organization]}\n\n"
+
+      options[:passphrase] ||= ask('Create a passphrase: ') { |i| i.echo = '*' }
+
+      help_now!('key is required') if options[:key].nil?
+      help_now!('description is required') if options[:description].nil?
+      help_now!('passphrase is required') if options[:passphrase].nil?
+      help_now!('organization key is required') if options[:organization].nil?
+
+      if @project.create(global_options, options)
+        puts @project.message
+      else
+        exit_now!(@project.message)
+      end
+    end
+  end
+end
+
+desc 'SSH Key Management'
+arg_name 'key'
+
+command :key do |c|
+  c.default_desc 'Manage your SSH Keys'
+
+  @key = Key.new
+
+  c.desc 'Generate a ssh key (--private_key --passphrase --type --bits)'
+  arg_name 'generate'
+
+  c.command :generate do |c1|
+    c1.flag [:type], desc: 'RSA or DSA', default_value: 'rsa'
+    c1.flag [:bits], desc: 'Size of key', type: Integer, default_value: 4096
+    c1.flag [:private_key], desc: 'Private key file path to use',
+                            default_value: private_key_default
+    c1.flag [:passphrase], desc: 'Passphrase that protects the private key'
+
+    c1.action do |_global_options, options, _args|
+      puts "Generating key at #{options[:private_key]}"
+
+      if File.exist?(options[:private_key])
+        answer = ask('File exists, overwrite? (y/N) ')
+        exit_now!('Please choose a different path') unless answer =~ %r{^y$}i
+      end
+
+      options[:passphrase] ||= ask('Enter passphrase: ') { |i| i.echo = '*' }
+
+      if @key.create(options)
+        puts @key.message
+      else
+        exit_now!(@key.message)
+      end
+    end
+  end
+
+  c.desc 'Sign your ssh public key (--project --client --public_key)'
+  arg_name 'sign'
+
+  c.command :sign do |c1|
+    @certificate = Certificate.new
+
+    c1.flag [:project], desc: 'Project key to sign with'
+
+    c1.action do |global_options, options|
+      options[:client] ||= ConfigFile.username(global_options)
+      options[:public_key] ||= ConfigFile.public_key(global_options)
+
+      help_now!('client username is required') if options[:client].nil?
+      help_now!('project key is required') if options[:project].nil?
+      help_now!('public key is required') if options[:public_key].nil?
+
+      puts "Signing public key (#{options[:public_key]}) " \
+      "for client: #{options[:client]}"
+
+      if @certificate.create(global_options, options)
+        puts @certificate.message
+      else
+        exit_now!(@certificate.message)
+      end
+    end
+  end
+end
+
+desc 'Machine Management'
+arg_name 'machine'
+
+command :machine do |c|
+  c.desc 'SSH to a machine <[user@]ip|host> (--private_key --command)'
+  arg_name 'ssh'
+
+  c.command :ssh do |c1|
+    c1.flag [:private_key], desc: 'Private key file path to use',
+                            default_value: private_key_default
+    c1.flag [:command], desc: 'Command to run for non-interactive sessions'
+
+    c1.action do |_global_options, options, args|
+      help_now!('machine is required') if args.empty?
+      options[:machine] = args.join(' ')
+
+      command = "-n '#{options[:command]}'" if options[:command]
+      ssh_command = "ssh -tt -q #{options[:machine]} " \
+      "-i #{options[:private_key]} #{command}"
+
+      if command
+        puts `#{ssh_command}`
+      else
+        exec(ssh_command)
+      end
+    end
+  end
+end
+
+on_error do |ex|
+  puts ex
+end
+
+exit run(ARGV)