capistrano-vault 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a3839176fa42c0219dc863806bb1a6def4e8c58
+  data.tar.gz: 0b0c8d83c8ebebb4c2a162e847baec3d6df2ddb8
+SHA512:
+  metadata.gz: 5af31f165e17aec8fd20111819cfb6b8dd654cd53b3b9e257121159413c514f3d3ff5568a44d9a986f9be869eda3f65cd682fa4b0af8dba426c687f442883d53
+  data.tar.gz: 5fe108abefe4621b47679c02a7f89beeed875d6f7157a80350805afb4fcdb00bc2956fe00d7a48091fb343a47ded0ce142d9071704694d0420263cbf6f44f12e

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in capistrano-vault.gemspec
+gemspec

data/README.md

@@ -0,0 +1,48 @@
+# Capistrano Vault
+
+Provide capistrano access your Hashicrop Vault server to signature certificate to ssh into server, or read access token saved in Vault.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-vault'
+```
+
+## Usage
+
+### SSH without config
+
+Enable SSH Plugin in Capfile
+
+```ruby
+# ...
+require "capistrano/vault"
+
+# This Hook will override your ssh options to use signed key and publickey mode to ssh.
+install_plugin Capistrano::Vault::SSH
+```
+
+Setup the options to sign
+
+```ruby
+set :vault_address, 'https://vault.example.com' # It not set, it will use EVN['VAULT_ADDR']
+set :vault_ssh_mount_path, 'ssh-client-signer'
+set :vault_ssh_role, 'deploy'
+```
+
+And before running capistrano command, make sure you are already `vault login`
+
+> Make sure your are added the trusted ca in your server.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/elct9620/capistrano-vault.

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 "capistrano/vault"
+
+# 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(__FILE__)

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/capistrano-vault.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "capistrano/vault/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-vault"
+  spec.version       = Capistrano::Vault::VERSION
+  spec.authors       = ["蒼時弦也"]
+  spec.email         = ["contact@frost.tw"]
+
+  spec.summary       = %q{Load secret and ssh certificate from Hashicorp Vault}
+  spec.description   = %q{Load secret and ssh certificate from Hashicorp Vault}
+  spec.homepage      = "https://github.com/elct9620/capistrano-vault"
+
+  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_runtime_dependency "capistrano"
+  spec.add_runtime_dependency "vault", "~> 0.1"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/capistrano/vault/ssh.rb

@@ -0,0 +1,70 @@
+module Capistrano
+  module Vault
+    class SSH < Capistrano::Plugin
+      KEY_NAME = "capistrano-vault-signed"
+
+      def set_defaults
+        set_if_empty :vault_address, ENV['VAULT_ADDR']
+        set_if_empty :vault_ssh_role, 'deploy'
+        set_if_empty :vault_ssh_mount_path, 'ssh-client-signer'
+      end
+
+      def register_hooks
+        stages.each do |stage|
+          after stage, 'configure_vault_ssh_options'
+          after stage, 'signature_ssh_public_key'
+        end
+      end
+
+      def define_tasks
+        task :configure_vault_ssh_options do
+          configure_vault_ssh_options
+        end
+
+        task :signature_ssh_public_key do
+          signature_ssh_public_key
+        end
+      end
+
+      private
+
+      def vault_ssh_options
+        {
+          auth_methods: %w[publickey],
+          keys: ["#{Dir.tmpdir}/#{KEY_NAME}"]
+        }
+      end
+
+      def configure_vault_ssh_options
+        env.backend.configure do |sshkit|
+          sshkit.backend.configure do |backend|
+            backend.ssh_options =
+              (backend.ssh_options || {})
+              .merge(vault_ssh_options)
+          end
+        end
+      end
+
+      def configure_vault
+        ::Vault.address = fetch(:vault_address)
+      end
+
+      def generate_rsa_key
+        key = OpenSSL::PKey::RSA.new 2048
+        File.write("#{Dir.tmpdir}/#{KEY_NAME}", key.to_pem)
+
+        [key, key.public_key]
+      end
+
+      def signature_ssh_public_key
+        configure_vault
+        _, pkey = generate_rsa_key
+        payload = { public_key: "ssh-rsa " + [pkey.to_blob].pack('m0') }
+        mount_path = fetch(:vault_ssh_mount_path)
+        role = fetch(:vault_ssh_role)
+        res = ::Vault.post("/v1/#{mount_path}/sign/#{role}", JSON.fast_generate(payload))
+        File.write("#{Dir.tmpdir}/#{KEY_NAME}.pub", res.dig(:data, :signed_key).strip)
+      end
+    end
+  end
+end

data/lib/capistrano/vault/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Vault
+    VERSION = "0.1.0"
+  end
+end

data/lib/capistrano/vault.rb

@@ -0,0 +1,16 @@
+require 'tmpdir'
+require 'vault'
+require 'openssl'
+
+require "capistrano/vault/version"
+require 'capistrano/all'
+require "capistrano/plugin"
+require "capistrano/vault/ssh"
+
+module Capistrano
+  module Vault
+    # Your code goes here...
+  end
+end
+
+load File.expand_path('../tasks/vault.cap', __FILE__)

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-vault
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- 蒼時弦也
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vault
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Load secret and ssh certificate from Hashicorp Vault
+email:
+- contact@frost.tw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capistrano-vault.gemspec
+- lib/capistrano/vault.rb
+- lib/capistrano/vault/ssh.rb
+- lib/capistrano/vault/version.rb
+homepage: https://github.com/elct9620/capistrano-vault
+licenses: []
+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: Load secret and ssh certificate from Hashicorp Vault
+test_files: []