ec2_hosts 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f3d3a81641bffc23b95c18e6979f3847387c9f65
+  data.tar.gz: 4798f749b1729aae57c0fc72bba3a0a67a4ffa27
+SHA512:
+  metadata.gz: 0628070a21cf3c3cb8d4cf0429b77e68077d822cfa97978201b650d9a92abd316cc8f33056b398e4e86a980ed774ccf9b5de08ce3c72b9dba597c46c945062ea
+  data.tar.gz: c8a91a6e75de1ab71968ec13c62933471ec902cb1c6d2723681e0d66d118fe7b420c66f69ea9b2728c97f02e82159b237379c1194832a95bb6551967e3526448

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,40 @@
+# ec2_hosts
+
+Update your hosts file based on ec2 compute instances.
+
+This is handy when used in conjunction with something like [sshuttle](https://github.com/sshuttle/sshuttle),
+allowing you to have a "poor man's vpn".
+
+## Installation
+
+```shell
+$ gem install ec2_hosts
+```
+
+## Requirements
+
+## Usage
+
+## Example
+
+Update your hosts file using ec2_hosts:
+
+```shell
+$ sudo ec2_hosts -p my-cool-project --public bastion
+
+```
+Start sshuttle session:
+
+```shell
+$ sshuttle --remote=bastion01 --daemon --pidfile=/tmp/sshuttle.pid 192.168.1.0/24
+```
+
+Now your hosts file will contain entries for all compute instances in the project,
+and you can ssh directly to them from your local machine.
+
+Hosts matching the pattern passed in with the `--public` flag will have their public
+IP address added to your host file instead of the their private internal IP address.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/atongen/ec2_hosts](https://github.com/atongen/ec2_hosts).

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/ec2_hosts

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+require 'ec2_hosts'
+Ec2Hosts::Runner.new(ARGV.dup).run!

data/ec2_hosts.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ec2_hosts/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ec2_hosts"
+  spec.version       = Ec2Hosts::VERSION
+  spec.authors       = ["Andrew Tongen"]
+  spec.email         = ["atongen@gmail.com"]
+
+  spec.summary       = %q{Update your hosts file based on aws ec2 compute instances}
+  spec.description   = %q{Update your hosts file based on aws ec2 compute instances}
+  spec.homepage      = "https://github.com/atongen/ec2_hosts"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "aws-sdk-v1", "~> 1.60"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/ec2_hosts/hosts.rb

@@ -0,0 +1,132 @@
+module Ec2Hosts
+  class Hosts
+
+    attr_reader :ec2,
+                :options
+
+    def initialize(options = {})
+      # Creds must be present in environment
+      @ec2 = AWS::EC2.new
+      @options = options
+      if @options[:tags]
+        @processed_tags = process_tags(@options[:tags])
+      elsif @options[:template]
+        @processed_template = process_template(@options[:template])
+      end
+    end
+
+    def vpc
+      return @vpc if instance_variable_defined?(:@vpc)
+
+      vpcs = ec2.vpcs.filter("tag:Name", options[:vpc]).map {|v|v}
+
+      if vpcs.length > 1
+        raise ArgumentError.new("Multiple VPCs with name '#{options[:vpc]}' found.")
+      elsif vpcs.length == 0
+        raise ArgumentError.new("VPC '#{options[:vpc]}' not found.")
+      end
+
+      @vpc = vpcs.first
+    end
+
+    def instances
+      return @instances if instance_variable_defined?(:@instances)
+
+      if options[:only_running]
+        @instances = vpc.instances.filter("instance-state-name", "running")
+      else
+        @instances = vpc.instances
+      end
+    end
+
+    def to_a
+      raw = instances.inject({}) do |memo, inst|
+        hostname = ""
+        if @processed_tags
+          hostname = parse_tags_hostname(@processed_tags, inst.tags.map.to_a.to_h)
+        elsif @processed_template
+          hostname = parse_template_hostname(@processed_template, inst.tags.map.to_a.to_h)
+        else
+          hostname = inst.tags["Name"]
+        end
+
+        hostname = "" unless hostname_valid?(hostname)
+
+        if hostname == "" && !options[:ignore_missing]
+          hostname = inst.private_dns_name.split('.').first
+        end
+
+        if hostname != ""
+          memo[hostname] = inst
+        end
+
+        memo
+      end.sort.to_h
+
+      list = []
+
+      raw.each do |hostname, inst|
+        begin
+          if !options[:public].nil? && hostname.downcase.include?(options[:public])
+            if !options[:exclude_public]
+              # get public ip address
+              if ip = inst.public_ip_address
+                list << "#{ip} #{hostname}"
+                raise HostError.new
+              end
+            end
+          else
+            # get private ip address
+            if ip = inst.private_ip_address
+              list << "#{ip} #{hostname}"
+              raise HostError.new
+            end
+          end
+        rescue HostError; end
+      end
+
+      list
+    end
+
+  private
+
+    def process_template(template)
+      template.split(/({\w+})/).select { |s| s != "" }.map do |snip|
+        if m = snip.match(/\A{(\w+)}\Z/)
+          ->(tags) { tags[m[1]] }
+        else
+          snip
+        end
+      end
+    end
+
+    def parse_template_hostname(template, instance_tags)
+      result = template.map do |snip|
+        if snip.is_a?(Proc)
+          snip.call(instance_tags)
+        else
+          snip
+        end
+      end
+      if result.any? { |r| r.nil? }
+        ""
+      else
+        result.join.gsub('_', '-')
+      end
+    end
+
+    def process_tags(tags)
+      tags.split(",").select { |s| s != "" }
+    end
+
+    def parse_tags_hostname(tags, instance_tags)
+      tags.map do |tag|
+        instance_tags[tag]
+      end.compact.join("-").gsub('_', '-')
+    end
+
+    def hostname_valid?(hostname)
+      !!hostname.to_s.match(/\A[A-Za-z]+[0-9A-Za-z-]*\Z/)
+    end
+  end
+end

data/lib/ec2_hosts/options.rb

@@ -0,0 +1,84 @@
+require 'optparse'
+
+module Ec2Hosts
+  class Options
+
+    attr_reader :options
+
+    def initialize(args)
+      @options = {
+        vpc: nil,
+        tags: nil,
+        template: nil,
+        ignore_missing: true,
+        only_running: true,
+        public: nil,
+        exclude_public: false,
+        file: '/etc/hosts',
+        backup: nil,
+        dry_run: false,
+        delete: false,
+        clear: false
+      }
+      parser.parse!(args)
+
+      if @options[:backup].nil?
+        @options[:backup] = "#{@options[:file]}.bak"
+      end
+    end
+
+    private
+
+    def parser
+      @parser ||= begin
+        OptionParser.new do |opts|
+          opts.banner = "Usage: $ ec2_hosts [options]"
+          opts.on('-v', '--vpc VPC_NAME', "Name of VPC to use. Defaults to nil.") do |opt|
+            @options[:vpc] = opt
+          end
+          opts.on('--tags TAGS', "CSV of tag names used to build host name. Defaults to nil.") do |opt|
+            @options[:tags] = opt
+          end
+          opts.on('--template TEMPLATE', "Template string to build hostname from instance tags. Defaults to nil.") do |opt|
+            @options[:template] = opt
+          end
+          opts.on('-i', '--[no-]ignore-missing', "Ignore hosts with no matching tags, or invalid template. Defaults to true.") do |opt|
+            @options[:ignore_missing] = opt
+          end
+          opts.on('-r', '--[no-]only-running', "Only list running instances. Defaults to true.") do |opt|
+            @options[:only_running] = opt
+          end
+          opts.on('-p', '--public PUBLIC', "Pattern to match for public/bastion hosts. Use public IP for these. Defaults to nil") do |opt|
+            @options[:public] = opt
+          end
+          opts.on('--[no-]exclude-public', "Exclude public hosts from list when updating hosts file. Allows them to be managed manually. Defaults to false") do |opt|
+            @options[:exclude_public] = opt
+          end
+          opts.on('-f', '--file FILE', "Hosts file to update. Defaults to /etc/hosts") do |opt|
+            @options[:file] = opt
+          end
+          opts.on('-b', '--backup BACKUP', "Path to backup original hosts file to. Defaults to FILE with '.bak' extension appended.") do |opt|
+            @options[:file] = opt
+          end
+          opts.on('--[no-]dry-run', "Dry run, do not modify hosts file. Defaults to false") do |opt|
+            @options[:dry_run] = opt
+          end
+          opts.on('--[no-]delete', "Delete the VPC from hosts file. Defaults to false") do |opt|
+            @options[:delete] = opt
+          end
+          opts.on('--[no-]clear', "Clear all ec2 host entries from hosts file. Defaults to false") do |opt|
+            @options[:clear] = opt
+          end
+          opts.on_tail("--help", "Show this message") do
+            puts opts
+            exit
+          end
+          opts.on_tail("--version", "Show version") do
+            puts ::Ec2Hosts::VERSION
+            exit
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ec2_hosts/runner.rb

@@ -0,0 +1,37 @@
+module Ec2Hosts
+  class Runner
+
+    def initialize(args)
+      @options = Options.new(args).options
+    end
+
+    def run!
+      if @options[:vpc] && @options[:clear]
+        raise ArgumentError.new("Cannot specify 'clear' and 'vpc' at the same time.")
+      end
+
+      if @options[:tags] && @options[:template]
+        raise ArgumentError.new("Cannot specify 'tags' and 'template' at the same time.")
+      end
+
+      updater = Updater.new(@options)
+
+      if @options[:clear]
+        updater.clear
+      else
+        if @options[:vpc].nil?
+          raise ArgumentError.new("No ec2 vpc specified.")
+        end
+
+        if @options[:delete]
+          new_hosts_list = []
+        else
+          hosts = Hosts.new(@options)
+          new_hosts_list = hosts.to_a
+        end
+
+        updater.update(new_hosts_list)
+      end
+    end
+  end
+end

data/lib/ec2_hosts/updater.rb

@@ -0,0 +1,176 @@
+module Ec2Hosts
+  # Updater implements a simple state machine which is used to update
+  # content between zero or more blocks of content which start and end
+  # with pre-defined "marker" lines.
+  class Updater
+
+    module Marker
+      BEFORE = 0
+      INSIDE = 1
+      AFTER = 2
+    end
+
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def update(new_hosts)
+      old_hosts = File.read(options[:file])
+
+      if old_hosts.include?(start_marker) && old_hosts.include?(end_marker)
+        # valid markers exists
+        if options[:delete]
+          new_content = delete_vpc_hosts(old_hosts)
+        else
+          new_content = gen_new_hosts(old_hosts, new_hosts)
+        end
+
+        # remove zero or more white space characters at end of file with
+        # a single new-line
+        new_content.gsub!(/\s+$/, "\n")
+
+        if options[:dry_run]
+          puts new_content
+        elsif new_content != old_hosts
+          # backup old host file
+          File.open(options[:backup], 'w') { |f| f << old_hosts }
+          # write new content
+          File.open(options[:file], 'w') { |f| f << new_content }
+        end
+      elsif old_hosts.include?(start_marker) || old_hosts.include?(end_marker)
+        raise UpdaterError.new("Invalid marker present in existing hosts content")
+      else
+        # marker doesn't exist
+        if options[:delete]
+          new_content = old_hosts
+        else
+          new_content = [old_hosts, start_marker, new_hosts, end_marker].join("\n")
+        end
+        # remove one or more white space characters at end of file with
+        # a single new-line
+        new_content.gsub!(/\s+$/, "\n")
+
+        if options[:dry_run]
+          puts new_content
+        elsif new_content != old_hosts
+          # backup old host file
+          File.open(options[:backup], 'w') { |f| f << old_hosts }
+          # write new content
+          File.open(options[:file], 'w') { |f| f << new_content }
+        end
+      end
+
+      true
+    end
+
+    def clear
+      old_hosts = File.read(options[:file])
+      new_content = old_hosts.dup
+
+      markers = old_hosts.each_line.map do |line|
+        regex = "\# (START|END) EC2 HOSTS - (.+) \#"
+        if m = line.match(/^#{regex}$/)
+          m[2]
+        end
+      end.compact.uniq
+
+      markers.each do |project|
+        new_content = delete_vpc_hosts(new_content)
+      end
+      new_content.gsub!(/\s+$/, "\n")
+
+      if options[:dry_run]
+        puts new_content
+      elsif new_content != old_hosts
+        # backup old host file
+        File.open(options[:file], 'w') { |f| f << old_hosts }
+        # write new content
+        File.open(options[:file], 'w') { |f| f << new_content }
+      end
+    end
+
+  private
+
+    def gen_new_hosts(hosts, new_hosts)
+      new_content = ''
+      marker_state = Marker::BEFORE
+      hosts.split("\n").each do |line|
+        if line == start_marker
+          if marker_state == Marker::BEFORE
+            # transition to inside the marker
+            new_content << start_marker + "\n"
+            marker_state = Marker::INSIDE
+            # add new host content
+            new_hosts.split("\n").each do |host|
+              new_content << host + "\n"
+            end
+          else
+            raise UpdaterError.new("Invalid marker state")
+          end
+        elsif line == end_marker
+          if marker_state == Marker::INSIDE
+            # transition to after the marker
+            new_content << end_marker + "\n"
+            marker_state = Marker::AFTER
+          else
+            raise UpdaterError.new("Invalid marker state")
+          end
+        else
+          case marker_state
+          when Marker::BEFORE, Marker::AFTER
+            new_content << line + "\n"
+          when Marker::INSIDE
+            # skip everything between old markers
+            next
+          end
+        end
+      end
+      new_content
+    end
+
+    def delete_vpc_hosts(hosts)
+      new_content = ''
+      marker_state = Marker::BEFORE
+      hosts.split("\n").each do |line|
+        if line == start_marker
+          if marker_state == Marker::BEFORE
+            marker_state = Marker::INSIDE
+            # don't add any content, we're deleting this block
+          else
+            raise UpdaterError.new("Invalid marker state")
+          end
+        elsif line == end_marker
+          if marker_state == Marker::INSIDE
+            marker_state = Marker::AFTER
+          else
+            raise UpdaterError.new("Invalid marker state")
+          end
+        else
+          case marker_state
+          when Marker::BEFORE, Marker::AFTER
+            new_content << line + "\n"
+          when Marker::INSIDE
+            # skip everything between old markers
+            next
+          end
+        end
+      end
+      new_content
+    end
+
+    def start_marker
+      @start_marker ||= begin
+        "# START EC2 HOSTS - #{options[:vpc]} #"
+      end
+    end
+
+    def end_marker
+      @end_marker ||= begin
+        "# END EC2 HOSTS - #{options[:vpc]} #"
+      end
+    end
+
+  end
+end

data/lib/ec2_hosts/version.rb

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

data/lib/ec2_hosts.rb

@@ -0,0 +1,12 @@
+require 'aws-sdk-v1'
+
+require 'ec2_hosts/version'
+require 'ec2_hosts/options'
+require 'ec2_hosts/hosts'
+require 'ec2_hosts/updater'
+require 'ec2_hosts/runner'
+
+module Ec2Hosts
+  class HostError < StandardError; end
+  class UpdaterError < StandardError; end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: ec2_hosts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Tongen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-v1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.60'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.60'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: Update your hosts file based on aws ec2 compute instances
+email:
+- atongen@gmail.com
+executables:
+- ec2_hosts
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/ec2_hosts
+- ec2_hosts.gemspec
+- lib/ec2_hosts.rb
+- lib/ec2_hosts/hosts.rb
+- lib/ec2_hosts/options.rb
+- lib/ec2_hosts/runner.rb
+- lib/ec2_hosts/updater.rb
+- lib/ec2_hosts/version.rb
+homepage: https://github.com/atongen/ec2_hosts
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Update your hosts file based on aws ec2 compute instances
+test_files: []