aws_ssh 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 309d8060f416544bfc2f694b9e52e9a1d0959c88
+  data.tar.gz: f10639efda3bfb3d036886b865559320471dba4d
+SHA512:
+  metadata.gz: 08db6a7f98e7e501c61c84dddf558c3614f46866d0d1a634750a85811d8b3f57abaef5cef29a062f7be69cb4b1674b248e9836e68709578ab73b92feffbf756c
+  data.tar.gz: 44c0e9cb3d52f917c6d548c96650ec837352067ddc96cb244b3ee68d23d578f628285fa4a6bbae313ce3a49d6fc34627fc633da8bd542701c20ce4f5b96ff4c9

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,21 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aws-sdk (1.56.0)
+      aws-sdk-v1 (= 1.56.0)
+    aws-sdk-v1 (1.56.0)
+      json (~> 1.4)
+      nokogiri (>= 1.4.4)
+    colorize (0.7.3)
+    json (1.8.1)
+    mini_portile (0.6.0)
+    nokogiri (1.6.3.1)
+      mini_portile (= 0.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aws-sdk
+  colorize
+  json

data/README.md

@@ -0,0 +1,65 @@
+# AWS SSH Extension #
+
+If you have a lot of services running over a multitude of instances, or if you just don't want to have to remember IP addresses, this tool will work for you.
+
+## Requirements ##
+
+It does assume that you are using SSH key based authentication to access the servers and have a correctly configured environment. This means a current ~/.ssh/config that has relevant proxy settings etc along with AWS environment vars (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION)
+
+Ruby, version 2.0 onwards, is required along with the standard bundler gem.
+
+At the moment, this code is only tested with bash based shells.
+
+## AWS Configuration ##
+
+Before you install this code, please be aware you may need to add some information to your ec2 instances. This code makes use of the "tags" key / value data available for each instance.
+
+I think this will be easier to explain by example:
+
+<img src="http://i.imgur.com/kvgHbr1.png" width="100%">
+Above is an ec2 instance setup to run both website and blog services (website.blog) in production and staging (production.staging).
+
+<img src="http://i.imgur.com/2psCejI.png" width="100%">
+This ec2 instance is just the website running in production.
+
+What values you have for environment and service are free form, so if you prefer to use "prod" instead of "production", you can.
+
+You can also have as many services and environments as you like, they just have to be seperated by a full stop (.).
+
+## Install ##
+
+
+### Uninstall ###
+
+
+## Usage ##
+
+Once installed you will need to make an SSH call to a service like:
+
+ssh $environment_$service
+or
+ssh $service_$environment
+
+In the case or examples above, that would be:
+
+ssh production_website
+or
+ssh website_production
+
+To be even more useful, it will also add the instance name, so:
+
+ssh websites
+
+would work as well
+
+If you have tab completion available, even better.
+
+### SSH User ###
+
+By default "deploy" is used as the ssh user. You can override this in the command as you are running it:
+
+ssh my-user@website_production
+
+Or, to save remembering, you can add a "user" tag to your instance and that will be loaded in
+
+

data/aws_ssh.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "aws_ssh/version"
+require "aws_ssh/cmds"
+
+Gem::Specification.new do |spec|
+  spec.name = "aws_ssh"
+  spec.version = AWS_SSH::VERSION
+  spec.authors = ["Charles Marshall"]
+  spec.email = ["cm56marshall@gmail.com"]
+  spec.summary = %q{ Autogenerates an SSH config file built from and AWS environment }
+  spec.description = %q{ Autogenerates an SSH config file built from and AWS environment }
+  spec.homepage = "https://github.com/charlesmarshall/aws_ssh"
+  spec.license = "MIT"
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "colorize", "~> 0.7"
+  spec.add_dependency "bundler", "~> 1.5"
+  spec.add_dependency "json", "~> 1.8"
+  spec.add_dependency "aws-sdk", "~> 1.5"
+
+  spec.post_install_message = "Gem installed.\nTo configure for use, run: #{AWS_SSH::SETUP_CMD}\nBefore removing gem, run: #{AWS_SSH::TEARDOWN_CMD}\n\nThank you!"
+
+end

data/bin/aws_ssh_generate

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'aws_ssh'
+
+ssh = AWS_SSH::Run.new
+ssh.generate

data/bin/aws_ssh_setup

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'aws_ssh'
+require "colorize"
+# run the config setup
+runner = AWS_SSH::Setup.new
+puts ""
+puts "Configuring...".colorize(:green)
+result = runner.run
+if ! result.nil?
+  puts ""
+  puts "Configuration completed.".colorize(:green)
+  puts ""
+else
+  puts ""
+  puts "Configuration failed.".colorize(:red)
+  puts ""
+end

data/bin/aws_ssh_teardown

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'aws_ssh'
+require "colorize"
+# run the config setup
+runner = AWS_SSH::Teardown.new
+puts ""
+puts "Removing...".colorize(:green)
+result = runner.run
+if ! result.nil?
+  puts ""
+  puts "Removal completed, you can uninstall the gem.".colorize(:green)
+  puts ""
+else
+  puts ""
+  puts "Removal failed.".colorize(:red)
+  puts ""
+end

data/lib/aws_ssh/cmds.rb

@@ -0,0 +1,7 @@
+require "aws_ssh/files"
+module AWS_SSH
+  GENERATE_CMD="aws_ssh_generate"
+  SETUP_CMD="aws_ssh_setup"
+  TEARDOWN_CMD="aws_ssh_teardown"
+  MERGE_CMD='cat ~/.ssh/' + AWS_SSH::BASE_HOSTS_FILE + ' ~/.ssh/' + AWS_SSH::HOSTS_FILE + ' > ~/.ssh/config'
+end

data/lib/aws_ssh/ec2.rb

@@ -0,0 +1,114 @@
+require 'json'
+require 'aws-sdk'
+
+module AWS_SSH
+  class EC2
+    ### ssh config file values
+    attr_accessor :User
+    attr_accessor :StrictHostKeyChecking
+    attr_accessor :UserKnownHostsFile
+    attr_accessor :LogLevel
+    ### class values
+    # aws api object
+    attr_accessor :api
+    # suffix of the key to use
+    attr_accessor :ssh_key_suffix
+    # auto generated ssh config_file
+    attr_accessor :ssh_config_file
+    # value used as seperater in the tags
+    attr_accessor :seperator
+
+    def initialize
+      self.env_error_check
+      self.default_values
+    end
+
+    def env_error_check
+      if ENV['AWS_ACCESS_KEY_ID'].nil? || ENV['AWS_SECRET_ACCESS_KEY'].nil? || ENV['AWS_REGION'].nil?
+        raise MissingAWS_CONFIG, "Missing AWS config data from the ENV."
+      end
+    end
+
+    def default_values
+      @User = "deploy"
+      @StrictHostKeyChecking = "no"
+      @UserKnownHostsFile = "/dev/null"
+      @LogLevel = "quiet"
+
+      @seperator = "."
+      @ssh_key_suffix = "pem"
+      @api = AWS::EC2.new(access_key_id: ENV['AWS_ACCESS_KEY_ID'], secret_access_key: ENV['AWS_SECRET_ACCESS_KEY'], region: ENV['AWS_REGION'])
+    end
+
+
+    def instances
+      instances = []
+      # normal instances
+      @api.instances.each{|i| instances.push(i)}
+      # vpc based insatnces
+      @api.vpcs.each{|v| v.instances.each{|vi| instances.push(vi)} }
+      return instances
+    end
+
+
+    def instance_data(instance)
+      tags = instance.tags.to_h
+      return {
+        :name => if tags["Name"].nil? then nil else tags["Name"].to_s.strip end,
+        :user => if tags["user"].nil? then @User else tags["user"].to_s.strip end,
+        :envs => if tags["environment"].nil? then nil else tags["environment"].split(@seperator) end,
+        :services => if tags["service"].nil? then nil else tags["service"].split(@seperator) end,
+        :ip => instance.private_ip_address,
+        :key => instance.key_name,
+        :key_file => ENV['HOME']+"/.ssh/"+instance.key_name+"."+@ssh_key_suffix
+      }
+    end
+
+    def instance_names(info)
+      names = []
+      if ! info[:name].nil? then names.push(info[:name]) end
+      if ! info[:envs].nil? && ! info[:services].nil?
+        info[:envs].each do |e|
+          info[:services].each do |s|
+            names.push("#{e}_#{s}")
+            names.push("#{s}_#{e}")
+          end
+        end
+      end
+      return names
+    end
+
+    def hosts
+      hosts = {}
+      self.instances.select!{|i| i.status.to_s == "running"}.each do |i|
+        info = self.instance_data(i)
+        if File.exists?(info[:key_file])
+          self.instance_names(info).each{ |h| hosts[h] = info}
+        end
+      end
+      return hosts
+    end
+
+
+    def write
+      # loop over hash and generate string
+      config = "\n\n# Custom generated list from AWS on #{Time.now}\n\n"
+      dir = ENV['HOME']+"/.ssh/"
+      sshfile = dir+AWS_SSH::HOSTS_FILE
+      File.open(sshfile, "w"){ |file| file.write(config)}
+      self.hosts.each do |name, host|
+        config += "Host #{name}\n"
+        config += "  HostName #{host[:ip].to_s}\n"
+        config += "  User #{host[:user].to_s}\n"
+        config += "  IdentityFile ~/.ssh/#{host[:key].to_s}.#{@ssh_key_suffix}\n"
+        config += "  StrictHostKeyChecking #{@StrictHostKeyChecking}\n"
+        config += "  UserKnownHostsFile #{@UserKnownHostsFile}\n"
+        config += "  LogLevel #{@LogLevel}\n"
+        config += "\n\n"
+      end
+      # write to file
+      File.open(sshfile, "w"){ |file| file.write(config)}
+    end
+
+  end
+end

data/lib/aws_ssh/exceptions.rb

@@ -0,0 +1,4 @@
+module AWS_SSH
+  class MissingAWS_CONFIG < Exception
+  end
+end

data/lib/aws_ssh/files.rb

@@ -0,0 +1,5 @@
+module AWS_SSH
+  ALIAS_FILE=".aws_alias"
+  HOSTS_FILE="config.aws"
+  BASE_HOSTS_FILE="config.base"
+end

data/lib/aws_ssh/runner.rb

@@ -0,0 +1,21 @@
+require "aws_ssh/files"
+module AWS_SSH
+  class Run
+    def generate
+      config = AWS_SSH::HOSTS_FILE
+      # 4 hour cache
+      if (File.exists?(config) && File.mtime(config) < (Time.now - (60*60*4) )) || ! File.exists?(config)
+        self.force
+      end
+    end
+
+    def force
+      ec2 = EC2.new
+      ec2.write
+    end
+
+    def merge
+      `#{AWS_SSH::MERGE_CMD}`
+    end
+  end
+end

data/lib/aws_ssh/setup.rb

@@ -0,0 +1,103 @@
+require 'colorize'
+require "aws_ssh/files"
+require "aws_ssh/terminal_formats"
+require "aws_ssh/version"
+require 'fileutils'
+require "aws_ssh/runner"
+
+module AWS_SSH
+  class Setup
+    attr_accessor :profile
+
+    # all vars are required
+    def env
+      return ( ENV['AWS_ACCESS_KEY_ID'] && ENV['AWS_SECRET_ACCESS_KEY'] && ENV['AWS_REGION'] && ENV['SHELL'] && ENV['HOME'])
+    end
+
+    def shell
+      shell = ENV['SHELL']
+      last = shell.rindex("/")+1
+      len = shell.length-1
+      return shell[last..len]
+    end
+
+    def self.shells(home, shell)
+      ["#{home}/.#{shell}rc", "#{home}/.#{shell}_profile", "#{home}/.profile"]
+    end
+
+    def profile
+      home = ENV['HOME']
+      shell = self.shell
+      @profile = nil
+      # check for automated locations
+      if ! shell.nil?
+        possibles = AWS_SSH::Setup.shells(home, shell)
+        possibles.each {|p| if @profile.nil? && File.exists?(p) then @profile = p end }
+      end
+
+    end
+
+    # create the alias file
+    def alias
+      msg = "# This is an automatically generated file; do not edit.\n# Created at #{Time.now}\n# Created by aws_ssh #{AWS_SSH::VERSION}\n"
+      cmd = 'alias ssh="' + AWS_SSH::GENERATE_CMD + ' ; '+AWS_SSH::MERGE_CMD+ '; ssh"'
+      filename=ENV['HOME']+"/"+AWS_SSH::ALIAS_FILE
+      File.open(filename, 'w') { |file| file.write(msg+cmd) }
+      return File.exists?(filename)
+    end
+    # move any current ssh config file to a base file
+    def create_base
+      origin = "#{ENV['HOME']}/.ssh/config"
+      dest = "#{ENV['HOME']}/.ssh/#{AWS_SSH::BASE_HOSTS_FILE}"
+      if File.exists?(origin)
+        FileUtils.mv(origin, dest)
+      end
+    end
+
+    def add_to_profile
+      if ! @profile.nil?
+        contents = File.open(@profile, 'rb') {|file| file.read}
+        # remove any current references and add new one in
+        contents = contents.gsub(". ~/#{AWS_SSH::ALIAS_FILE}", "").chomp + "\n" + ". ~/#{AWS_SSH::ALIAS_FILE}"
+        File.open(@profile, 'w') { |file| file.write(contents) }
+      end
+    end
+
+    def run
+
+      if !self.env
+        printf(AWS_SSH::FORMAT_FATAL, "Environment failed", "\u2620")
+        return nil
+      else
+        printf(AWS_SSH::FORMAT_OK, "Environment vars", "\u2713")
+      end
+
+      self.profile
+      if @profile.nil?
+        printf(AWS_SSH::FORMAT_FATAL, "Shell profile failed", "\u2620")
+        return nil
+      else
+        printf(AWS_SSH::FORMAT_OK, "Shell profile found", "\u2713")
+      end
+
+      if self.alias
+        printf(AWS_SSH::FORMAT_OK, "Alias file created ", "\u2713")
+      else
+        printf(AWS_SSH::FORMAT_FATAL, "Alias file creation failed", "\u2620")
+        return nil
+      end
+
+      self.create_base
+      printf(AWS_SSH::FORMAT_OK, "Base SSH file created ", "\u2713")
+      self.add_to_profile
+      printf(AWS_SSH::FORMAT_OK, "Alias added to shell ", "\u2713")
+
+      run = AWS_SSH::Run.new
+      run.force
+      run.merge
+      printf(AWS_SSH::FORMAT_OK, "Completed first run", "\u2713")
+      return true
+    end
+
+  end
+end

data/lib/aws_ssh/teardown.rb

@@ -0,0 +1,84 @@
+require 'colorize'
+require "aws_ssh/files"
+require "aws_ssh/terminal_formats"
+require "aws_ssh/version"
+require 'fileutils'
+require "aws_ssh/runner"
+
+module AWS_SSH
+  class Teardown < Setup
+    attr_accessor :profile
+
+
+    def self.shells(home, shell)
+      ["#{home}/.#{shell}rc", "#{home}/.#{shell}_profile", "#{home}/.profile"]
+    end
+
+    def profile
+      home = ENV['HOME']
+      shell = self.shell
+      @profile = nil
+      # check for automated locations
+      if ! shell.nil?
+        possibles = AWS_SSH::Setup.shells(home, shell)
+        possibles.each {|p| if @profile.nil? && File.exists?(p) then @profile = p end }
+      end
+
+    end
+
+    # create the alias file
+    def alias
+      filename=ENV['HOME']+"/"+AWS_SSH::ALIAS_FILE
+      if File.exists?(filename)
+        FileUtils.rm(filename)
+      end
+      return !File.exists?(filename)
+    end
+    #
+    def swap_base
+      origin = "#{ENV['HOME']}/.ssh/config"
+      dest = "#{ENV['HOME']}/.ssh/#{AWS_SSH::BASE_HOSTS_FILE}"
+      if File.exists?(dest)
+        FileUtils.mv(dest, origin)
+      end
+      extra = "#{ENV['HOME']}/.ssh/#{AWS_SSH::HOSTS_FILE}"
+      if File.exists?(extra)
+        FileUtils.rm(extra)
+      end
+    end
+
+    def remove_from_profile
+      if ! @profile.nil?
+        contents = File.open(@profile, 'rb') {|file| file.read}
+        # remove any current references and add new one in
+        contents = contents.gsub(". ~/#{AWS_SSH::ALIAS_FILE}", "").chomp + "\n"
+        File.open(@profile, 'w') { |file| file.write(contents) }
+      end
+    end
+
+    def run
+      self.profile
+      if @profile.nil?
+        printf(AWS_SSH::FORMAT_FATAL, "Shell profile failed", "\u2620")
+        return nil
+      else
+        printf(AWS_SSH::FORMAT_OK, "Shell profile found", "\u2713")
+      end
+
+      if self.alias
+        printf(AWS_SSH::FORMAT_OK, "Alias file removed ", "\u2713")
+      else
+        printf(AWS_SSH::FORMAT_FATAL, "Alias removal failed", "\u2620")
+        return nil
+      end
+
+      self.swap_base
+      printf(AWS_SSH::FORMAT_OK, "Base SSH file reverted ", "\u2713")
+      self.remove_from_profile
+      printf(AWS_SSH::FORMAT_OK, "Alias removed from shell ", "\u2713")
+
+      return true
+    end
+
+  end
+end

data/lib/aws_ssh/terminal_formats.rb

@@ -0,0 +1,5 @@
+module AWS_SSH
+  FORMAT_OK="\e[0;32m%#-30s\t%5s\e[0m\n"
+  FORMAT_ERROR="\e[33;40m%#-30s\t%5s\e[0m\n"
+  FORMAT_FATAL="\e[0;31m%#-30s\t%5s\e[0m\n"
+end

data/lib/aws_ssh/version.rb

@@ -0,0 +1,3 @@
+module AWS_SSH
+  VERSION="0.1.0"
+end

data/lib/aws_ssh.rb

@@ -0,0 +1,14 @@
+require "aws_ssh/version"
+
+
+module AWS_SSH
+  require "aws_ssh/exceptions"
+  require "aws_ssh/files"
+  require "aws_ssh/cmds"
+  require "aws_ssh/terminal_formats"
+  require "aws_ssh/ec2"
+  require "aws_ssh/setup"
+  require "aws_ssh/teardown"
+  require "aws_ssh/runner"
+
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: aws_ssh
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Charles Marshall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: " Autogenerates an SSH config file built from and AWS environment "
+email:
+- cm56marshall@gmail.com
+executables:
+- aws_ssh_generate
+- aws_ssh_setup
+- aws_ssh_teardown
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- aws_ssh.gemspec
+- bin/aws_ssh_generate
+- bin/aws_ssh_setup
+- bin/aws_ssh_teardown
+- lib/aws_ssh.rb
+- lib/aws_ssh/cmds.rb
+- lib/aws_ssh/ec2.rb
+- lib/aws_ssh/exceptions.rb
+- lib/aws_ssh/files.rb
+- lib/aws_ssh/runner.rb
+- lib/aws_ssh/setup.rb
+- lib/aws_ssh/teardown.rb
+- lib/aws_ssh/terminal_formats.rb
+- lib/aws_ssh/version.rb
+homepage: https://github.com/charlesmarshall/aws_ssh
+licenses:
+- MIT
+metadata: {}
+post_install_message: |-
+  Gem installed.
+  To configure for use, run: aws_ssh_setup
+  Before removing gem, run: aws_ssh_teardown
+
+  Thank you!
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Autogenerates an SSH config file built from and AWS environment
+test_files: []