fssh 0.0.1

data/Gemfile

@@ -0,0 +1 @@
+gemspec

data/LICENSE

@@ -0,0 +1,177 @@
+
+                              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

data/README.md

@@ -0,0 +1,70 @@
+## fssh
+
+Easily ssh into remote Amazon EC2 hosts by name.  Eg. `fssh hellfire`.
+
+## Installation
+
+`gem install fssh`
+
+## Setup
+
+Add your Amazon security credentials as variables in your shell.  Usually this is done via a file like your `~/.bash_profile` or `~/.bashrc`:
+
+```
+export AMAZON_ACCESS_KEY_ID=...
+export AMAZON_ACCESS_SECRET=...
+```
+
+Create the file `~/.fssh` that will contain your fssh config in YAML format.  Mine looks something like this:
+
+```
+:local_private_key_file: ~/.ssh/private.pem
+:remote_private_key_file: /home/camertron/.ssh/private.pem
+:gateway:
+  - :name: bastion
+    :except:
+      - bastion
+  - :name: bastion2
+		:except:
+			- bastion2
+		:only:
+			- hellfire
+:username: camertron
+```
+
+1.  The local and remote key files should point to your Amazon-issued .pem file.  If you don't use a gateway, the remote key file isn't necessary since you don't need to hop more than once.
+2.  You can specify more than one gateway and when to use it via the `:only` and `:except` options.  It's usually a good idea to put the gateway's name into the `:except` list since you don't want to connect to the gateway through itself (right?).  Use the `:only` list to indicate servers that should always be connected to via this gateway.  In the example above, a connection to the `hellfire` server will happen through the `bastion2` gateway.
+3.  Specify the username you want to connect to the remote server as.
+
+## Usage
+
+SSH to and (optionally) run a command on a remote ec2 server:
+
+`fssh server_name [command]`
+
+Securely copy a file from a remote ec2 server to your local machine or vice-versa. For the most part, the `fscp` command uses the same `host:/path/` syntax that the `scp` command uses:
+
+`fscp server_name:/remote_path local_path`
+
+`fscp local_path, server_name:/remote_path`
+
+## Requirements
+
+The fssh gem assumes you have OpenSSH (or some variant) installed and that you're running some *nix-based operating system like Linux or Mac OS.  The `fscp` command also relies on the existence of netcat.
+
+## Running Tests
+
+`bundle exec rake` or `bundle exec rspec`
+
+## Authors
+
+* Cameron C. Dutro: http://github.com/camertron
+
+## Links
+* amazon-ec2 gem: [https://github.com/grempe/amazon-ec2](https://github.com/grempe/amazon-ec2)
+
+## License
+
+Copyright 2012 Forrager.
+
+Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0

data/Rakefile

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+
+# Copyright 2012 Forrager
+# http://www.apache.org/licenses/LICENSE-2.0
+
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+
+require 'bundler'
+require 'digest'
+
+require 'rspec/core/rake_task'
+require 'rubygems/package_task'
+
+require './lib/fssh'
+
+Bundler::GemHelper.install_tasks
+
+task :default => :spec
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = './spec/**/*_spec.rb'
+end

data/bin/fscp

@@ -0,0 +1,65 @@
+#! /usr/bin/env ruby
+
+# encoding: UTF-8
+
+# Copyright 2012 Forrager
+# http://www.apache.org/licenses/LICENSE-2.0
+
+require 'rubygems' unless ENV["NO_RUBYGEMS"]
+require 'fssh'
+
+if ARGV[0] && ARGV[1]
+  if ARGV[0].include?(":")
+    remote_path = ARGV[0]
+    local_path = ARGV[1]
+    direction = :down
+  else
+    remote_path = ARGV[1]
+    local_path = ARGV[0]
+    direction = :up
+  end
+
+  server_name, remote_path = remote_path.split(":")
+  cli = FSSH::CLI.new(server_name)
+else
+  puts "fscp must be given a remote path and a local path, eg: fscp hellfire:/tmp/file ~/Desktop"
+  exit 1
+end
+
+unless cli.private_key_exists?
+  puts "Could not find #{cli.config.local_private_key_file}"
+  exit 1
+end
+
+puts " * Finding instances ..."
+cli.find_instances
+
+if cli.find_gateway
+  puts " * Found gateway"
+end
+
+if cli.find_server
+  puts " * Found #{cli.server_name}"
+else
+  puts " * Couldn't find server with name #{cli.server_name}"
+  exit 1
+end
+
+command = if cli.hops.size == 1
+  case direction
+    when :down
+      "scp -i #{cli.config.local_private_key_file} #{cli.config.username}@#{cli.hops.first.dns_name}:#{remote_path} #{local_path}"
+    when :up
+      "scp -i #{cli.config.local_private_key_file} #{local_path} #{cli.config.username}@#{cli.hops.first.dns_name}:#{remote_path}"
+  end
+else
+  case direction
+    when :down
+      %Q(scp -i #{cli.config.local_private_key_file} -Cp -o "ProxyCommand ssh -i #{cli.config.local_private_key_file} #{cli.config.username}@#{cli.hops.first.dns_name} nc #{cli.hops[1].private_dns_name} 22" #{cli.config.username}@#{cli.hops[1].private_dns_name}:#{remote_path} #{local_path})
+    when :up
+      %Q(scp -i #{cli.config.local_private_key_file} -Cp -o "ProxyCommand ssh -i #{cli.config.local_private_key_file} #{cli.config.username}@#{cli.hops.first.dns_name} nc #{cli.hops[1].private_dns_name} 22" #{local_path} #{cli.config.username}@#{cli.hops[1].private_dns_name}:#{remote_path})
+  end
+end
+
+puts " * Executing #{command}"
+exec command

data/bin/fssh

@@ -0,0 +1,45 @@
+#! /usr/bin/env ruby
+
+# encoding: UTF-8
+
+# Copyright 2012 Forrager
+# http://www.apache.org/licenses/LICENSE-2.0
+
+require 'rubygems' unless ENV["NO_RUBYGEMS"]
+require 'fssh'
+
+if ARGV[0]
+  cli = FSSH::CLI.new(ARGV[0])
+else
+  puts "fssh must be given the name of the server to connect to, eg: fssh my_awesome_server"
+  exit 1
+end
+
+remote_command = (ARGV[1..-1] || "").join(" ")
+
+unless cli.private_key_exists?
+  puts "Could not find #{cli.config.local_private_key_file}"
+  exit 1
+end
+
+puts " * Finding instances ..."
+cli.find_instances
+
+if cli.find_gateway
+  puts " * Found gateway"
+end
+
+if cli.find_server
+  puts " * Found #{cli.server_name}"
+else
+  puts " * Couldn't find server with name #{cli.server_name}"
+  exit 1
+end
+
+command = cli.hops.each_with_index.map do |hop, idx|
+  cmd = "ssh -t -t -i #{idx == 0 ? cli.config.local_private_key_file : cli.config.remote_private_key_file} "
+  cmd + "#{cli.config.username}@#{idx == 0 ? hop.dns_name : hop.private_dns_name}"
+end.join(" ") + " #{remote_command}"
+
+puts " * Executing: #{command}"
+exec command

data/fssh.gemspec

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+
+# Copyright 2012 Forrager
+# http://www.apache.org/licenses/LICENSE-2.0
+
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'fssh/version'
+
+Gem::Specification.new do |s|
+  s.name     = "fssh"
+  s.version  = ::FSSH::VERSION
+  s.authors  = ["Cameron Dutro"]
+  s.email    = ["cameron@forrager.com"]
+  s.homepage = "http://forrager.com"
+
+  s.description = s.summary = "Easily ssh into remote Amazon EC2 hosts by name."
+
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.summary  = ""
+
+  s.add_dependency 'amazon-ec2', '~> 0.9.17'
+
+  s.require_path = 'lib'
+
+  s.files = Dir["{lib}/**/*", "Gemfile", "History.txt", "LICENSE", "README.md", "Rakefile", "fssh.gemspec"]
+  s.executables << "fssh"
+  s.executables << "fscp"
+end

data/lib/fssh.rb

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+
+# Copyright 2012 Forrager
+# http://www.apache.org/licenses/LICENSE-2.0
+
+require 'aws'
+require 'yaml'
+
+module FSSH
+  autoload :Instance,      "fssh/instance"
+  autoload :ServerSet,     "fssh/server_set"
+  autoload :ServerManager, "fssh/server_manager"
+  autoload :Config,        "fssh/config"
+  autoload :CLI,           "fssh/cli"
+end

data/lib/fssh/cli.rb

@@ -0,0 +1,63 @@
+# encoding: UTF-8
+
+# Copyright 2012 Forrager
+# http://www.apache.org/licenses/LICENSE-2.0
+
+module FSSH
+  class CLI
+    attr_reader :server_name, :config, :config_file
+    attr_reader :instances, :server, :gateway
+
+    def initialize(server_name)
+      @server_name = server_name
+      load_config
+    end
+
+    def find_instances
+      @instances = FSSH::ServerManager.instances
+      !!@instances
+    end
+
+    def find_gateway
+      running = @instances.filter_running
+      @gateway_config = @config.resolve_gateway(server_name)
+
+      if @gateway_config
+        @gateway = running.filter_group(@gateway_config[:name]).first
+        true
+      else
+        false
+      end
+    end
+
+    def find_server
+      if !@gateway_config || @gateway_config[:name] != @server_name
+        running = @instances.filter_running
+        @server = running.filter_tags("Name" => @server_name).first
+        !!@server.base
+      else
+        true
+      end
+    end
+
+    def private_key_exists?
+      File.exist?(File.expand_path(@config.local_private_key_file))
+    end
+
+    def hops
+      @hops ||= [@gateway, @server].compact
+    end
+
+    protected
+
+    def load_config
+      @config_file = File.expand_path("~/.fssh")
+
+      if File.exist?(@config_file)
+        @config = FSSH::Config.load_file(@config_file)
+      else
+        raise "Couldn't find .fssh config file at #{@config_fie}"
+      end
+    end
+  end
+end

data/lib/fssh/config.rb

@@ -0,0 +1,41 @@
+# encoding: UTF-8
+
+# Copyright 2012 Forrager
+# http://www.apache.org/licenses/LICENSE-2.0
+
+module FSSH
+  class Config
+    attr_reader :data
+
+    class << self
+      def load_file(file)
+        result = Config.new
+        result.instance_variable_set(:'@data', YAML.load_file(file))
+        result
+      end
+
+      def load(content)
+        result = Config.new
+        result.instance_variable_set(:'@data', YAML.load(content))
+        result
+      end
+    end
+
+    def [](key)
+      @data[key]
+    end
+
+    def method_missing(method)
+      @data[method]
+    end
+
+    def resolve_gateway(server)
+      @data[:gateway].find do |rules|
+        passed = true
+        passed &&= rules[:except].none? { |rule| server == rule } if rules[:except]
+        passed &&= rules[:only].include?(server) if rules[:only]
+        passed
+      end
+    end
+  end
+end

data/lib/fssh/instance.rb

@@ -0,0 +1,24 @@
+# encoding: UTF-8
+
+# Copyright 2012 Forrager
+# http://www.apache.org/licenses/LICENSE-2.0
+
+module FSSH
+  class Instance
+    def initialize(instance)
+      @instance = instance
+    end
+
+    def base
+      @instance
+    end
+
+    def dns_name
+      base.instancesSet.item.first.dnsName
+    end
+
+    def private_dns_name
+      base.instancesSet.item.first.privateDnsName
+    end
+  end
+end

data/lib/fssh/server_manager.rb

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+
+# Copyright 2012 Forrager
+# http://www.apache.org/licenses/LICENSE-2.0
+
+module FSSH
+  class ServerManager
+    class << self
+      def client
+        @client ||= AWS::EC2::Base.new(
+          :access_key_id => ENV["AMAZON_ACCESS_KEY_ID"],
+          :secret_access_key => ENV["AMAZON_ACCESS_SECRET"]
+        )
+      end
+
+      def instances
+        @instances ||= ServerSet.new(client.describe_instances.reservationSet.item)
+      end
+    end
+  end
+end

data/lib/fssh/server_set.rb

@@ -0,0 +1,54 @@
+# encoding: UTF-8
+
+# Copyright 2012 Forrager
+# http://www.apache.org/licenses/LICENSE-2.0
+
+module FSSH
+  class ServerSet
+    def initialize(instances)
+      @instances = instances
+    end
+
+    def filter_group(group)
+      ServerSet.new(@instances.select do |item|
+        item.groupSet.item.any? do |set|
+          set.groupId == group
+        end
+      end)
+    end
+
+    def filter_running
+      ServerSet.new(@instances.select do |item|
+        item.instancesSet.item.first.instanceState.name == "running"
+      end)
+    end
+
+    def filter_tags(tags = {})
+      ServerSet.new(@instances.select do |item|
+        item.instancesSet.item.first.tagSet.item.any? do |instance_tag|
+          tags.include?(instance_tag["key"]) && tags[instance_tag["key"]] == instance_tag["value"]
+        end
+      end)
+    end
+
+    def dns_names
+      @instances.map { |instance| instance.instancesSet.item.first.dnsName }
+    end
+
+    def first
+      Instance.new(@instances.first)
+    end
+
+    def [](index)
+      Instance.new(@instances[index])
+    end
+
+    def size
+      @instances.size
+    end
+
+    def -(arr)
+      ServerSet.new(@instances - arr)
+    end
+  end
+end

data/lib/fssh/version.rb

@@ -0,0 +1,8 @@
+# encoding: UTF-8
+
+# Copyright 2012 Forrager
+# http://www.apache.org/licenses/LICENSE-2.0
+
+module FSSH
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: fssh
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Cameron Dutro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: amazon-ec2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.17
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.17
+description: Easily ssh into remote Amazon EC2 hosts by name.
+email:
+- cameron@forrager.com
+executables:
+- fssh
+- fscp
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/fssh/cli.rb
+- lib/fssh/config.rb
+- lib/fssh/instance.rb
+- lib/fssh/server_manager.rb
+- lib/fssh/server_set.rb
+- lib/fssh/version.rb
+- lib/fssh.rb
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fssh.gemspec
+- bin/fssh
+- bin/fscp
+homepage: http://forrager.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ''
+test_files: []