ec2_amitools 1.0.2

data/lib/ec2/amitools/parameter_exceptions.rb

@@ -0,0 +1,34 @@
+# Copyright 2008-2014 Amazon.com, Inc. or its affiliates.  All Rights
+# Reserved.  Licensed under the Amazon Software License (the
+# "License").  You may not use this file except in compliance with the
+# License. A copy of the License is located at
+# http://aws.amazon.com/asl or in the "license" file accompanying this
+# file.  This file 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.
+
+module ParameterExceptions
+  class Error < RuntimeError
+  end
+
+  class MissingMandatory < Error
+    def initialize(name)
+      super("missing mandatory parameter: #{name}")
+    end
+  end
+
+  class InvalidCombination < Error
+    def initialize(name1, name2)
+      super("#{name1} and #{name2} may not both be provided")
+    end
+  end
+
+  class InvalidValue < Error
+    def initialize(name, value, msg=nil)
+      message = "#{name} has invalid value '#{value.to_s}'"
+      message += ": #{msg}" unless msg.nil?
+      super(message)
+    end
+  end
+end

data/lib/ec2/amitools/parameters_base.rb

@@ -0,0 +1,168 @@
+# Copyright 2008-2014 Amazon.com, Inc. or its affiliates.  All Rights
+# Reserved.  Licensed under the Amazon Software License (the
+# "License").  You may not use this file except in compliance with the
+# License. A copy of the License is located at
+# http://aws.amazon.com/asl or in the "license" file accompanying this
+# file.  This file 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.
+
+require 'optparse'
+require 'ec2/amitools/parameter_exceptions'
+require 'ec2/amitools/version'
+require 'ec2/common/s3support'
+
+class ParametersBase < OptionParser
+  include ParameterExceptions
+
+  # Descriptions for common parameters:
+  USER_CERT_PATH_DESCRIPTION = "The path to the user's PEM encoded RSA public key certificate file."
+  USER_PK_PATH_DESCRIPTION = "The path to the user's PEM encoded RSA private key file."
+  USER_DESCRIPTION = "The user's AWS access key ID."
+  PASS_DESCRIPTION = "The user's AWS secret access key."
+  USER_ACCOUNT_DESCRIPTION = "The user's EC2 user ID (Note: AWS account number, NOT Access Key ID)."
+  HELP_DESCRIPTION = "Display this help message and exit."
+  MANUAL_DESCRIPTION = "Display the user manual and exit."
+  DEBUG_DESCRIPTION = "Display debug messages."
+  VERSION_DESCRIPTION = "Display the version and copyright notice and then exit."
+  BATCH_DESCRIPTION = "Run in batch mode. No interactive prompts."
+
+  attr_accessor(:show_help,
+                :manual,
+                :version,
+                :batch_mode,
+                :debug)
+
+  #------------------------------------------------------------------------------#
+  # Methods to override in subclasses
+  #------------------------------------------------------------------------------#
+
+  def mandatory_params()
+    # Override this for mandatory parameters
+  end
+
+  def optional_params()
+    # Override this for optional parameters
+  end
+
+  def validate_params()
+    # Override this for parameter validation
+  end
+
+  def set_defaults()
+    # Override this for parameter validation
+  end
+
+  #------------------------------------------------------------------------------#
+  # Useful utility methods
+  #------------------------------------------------------------------------------#
+  
+  def early_exit?()
+    @show_help or @manual or @version
+  end
+
+  def interactive?()
+    not (early_exit? or @batch_mode)
+  end
+
+  def version_copyright_string()
+    EC2Version::version_copyright_string()
+  end
+
+  #------------------------------------------------------------------------------#
+  # Validation utility methods
+  #------------------------------------------------------------------------------#
+
+  def assert_exists(path, param)
+    unless File::exist?(path)
+      raise InvalidValue.new(param, path, "File or directory does not exist.")
+    end
+  end
+
+  def assert_glob_expands(path, param)
+    if Dir::glob(path).empty?
+      raise InvalidValue.new(param, path, "File or directory does not exist.")
+    end
+  end
+
+  def assert_file_exists(path, param)
+    unless (File::exist?(path) and File::file?(path))
+      raise InvalidValue.new(param, path, "File does not exist or is not a file.")
+    end
+  end
+
+  def assert_file_executable(path, param)
+    unless (File::executable?(path) and File::file?(path))
+      raise InvalidValue.new(param, path, "File not executable.")
+    end
+  end
+
+  def assert_directory_exists(path, param)
+    unless (File::exist?(path) and File::directory?(path))
+      raise InvalidValue.new(param, path, "Directory does not exist or is not a directory.")
+    end
+  end
+
+  def assert_option_in(option, choices, param)
+    unless choices.include?(option)
+      raise InvalidValue.new(param, option)
+    end
+  end
+
+  def assert_good_key(key, param)
+    if key.include?("/")
+      raise InvalidValue.new(param, key, "'/' character not allowed.")
+    end
+  end
+
+  #------------------------------------------------------------------------------#
+  # Parameters common to all tools
+  #------------------------------------------------------------------------------#
+
+  def common_params()
+    on('-h', '--help', HELP_DESCRIPTION) do
+      @show_help = true
+    end
+    
+    on('--version', VERSION_DESCRIPTION) do
+      @version = true
+    end
+    
+    on('--manual', MANUAL_DESCRIPTION) do
+      @manual = true
+    end
+    
+    on('--batch', BATCH_DESCRIPTION) do
+      @batch_mode = true
+    end
+    
+    on('--debug', DEBUG_DESCRIPTION) do
+      @debug = true
+    end    
+  end
+
+
+  def initialize(argv, name=nil)
+    super(argv)
+
+    # Mandatory parameters.
+    separator("")
+    separator("MANDATORY PARAMETERS")
+    mandatory_params()
+    
+    # Optional parameters.
+    separator("")
+    separator("OPTIONAL PARAMETERS")
+    common_params()
+    optional_params()
+
+    # Parse the command line parameters.
+    parse!(argv)
+
+    unless early_exit?
+      validate_params()
+      set_defaults()
+    end
+  end
+end

data/lib/ec2/amitools/region.rb

@@ -0,0 +1,93 @@
+# Copyright 2008-2014 Amazon.com, Inc. or its affiliates.  All Rights
+# Reserved.  Licensed under the Amazon Software License (the
+# "License").  You may not use this file except in compliance with the
+# License. A copy of the License is located at
+# http://aws.amazon.com/asl or in the "license" file accompanying this
+# file.  This file 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.
+
+# Module to hold region informations
+#
+
+module AwsRegion
+
+  AWS_REGIONS = [
+    'eu-west-1',
+    'eu-central-1',
+    'us-east-1',
+    'us-gov-west-1',
+    'cn-north-1',
+    'us-west-1',
+    'us-west-2',
+    'ap-southeast-1',
+    'ap-southeast-2',
+    'ap-northeast-1',
+    'sa-east-1',
+  ]
+
+  S3_LOCATIONS = [
+    'EU', 'eu-west-1',
+    'eu-central-1',
+    'US',
+    'us-gov-west-1',
+    'cn-north-1',
+    'us-west-1',
+    'us-west-2',
+    'ap-southeast-1',
+    'ap-southeast-2',
+    'ap-northeast-1',
+    'sa-east-1',
+  ]
+
+  module_function
+
+  def determine_region_from_host host
+    # http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
+    if host == "s3.amazonaws.com" || host == "s3-external-1.amazonaws.com"
+      "us-east-1"
+    elsif
+      domains = host.split(".")
+      # handle s3-$REGION.amazonaws.something
+      if domains.length >= 3 && domains[0].start_with?("s3-")
+        domains[0].sub("s3-", "")
+      # handle s3.$REGION.amazonaws.something, this is specific to the cn-north-1 endpoint
+      elsif domains.length >= 3 && domains[0] == "s3"
+        domains[1]
+      else
+        "us-east-1"
+      end
+    end
+  end
+
+  def guess_region_from_s3_bucket(location)
+    if (location == "EU")
+      return "eu-west-1"
+    elsif ((location == "US") || (location == "") || (location.nil?))
+      return "us-east-1"
+    else 
+      return location
+    end
+  end
+
+  def get_s3_location(region)
+    if (region == "eu-west-1")
+      return 'EU'
+    elsif (region == "us-east-1")
+      return :unconstrained
+    else
+      return region
+    end
+  end
+
+  def regions
+    AWS_REGIONS
+  end
+
+  def s3_locations
+    S3_LOCATIONS
+  end
+
+end
+

data/lib/ec2/amitools/s3toolparameters.rb

@@ -0,0 +1,183 @@
+# Copyright 2008-2014 Amazon.com, Inc. or its affiliates.  All Rights
+# Reserved.  Licensed under the Amazon Software License (the
+# "License").  You may not use this file except in compliance with the
+# License. A copy of the License is located at
+# http://aws.amazon.com/asl or in the "license" file accompanying this
+# file.  This file 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.
+
+require 'ec2/common/constants'
+require 'ec2/amitools/parameters_base'
+require 'ec2/amitools/region'
+
+#------------------------------------------------------------------------------#
+
+class S3ToolParameters < ParametersBase
+
+  BUCKET_DESCRIPTION = ["The bucket to use. This is an S3 bucket,",
+                        "followed by an optional S3 key prefix using '/' as a delimiter."]
+  MANIFEST_DESCRIPTION = "The path to the manifest file."
+  DELEGATION_TOKEN_DESCRIPTION = "The delegation token pass along to the AWS request."
+  URL_DESCRIPTION = "The S3 service URL. Defaults to https://s3.amazonaws.com."
+  REGION_DESCRIPTION = "The S3 region. Defaults to us-east-1."
+  SIGV2_DESCRIPTION = "Use old signature version 2 signing"
+  PROFILE_PATH = '/latest/meta-data/iam/security-credentials/'
+  PROFILE_HOST = '169.254.169.254'
+
+  REGION_MAP = {
+    'us-east-1' => 'https://s3.amazonaws.com',
+    'us-west-2' => 'https://s3-us-west-2.amazonaws.com',
+    'us-west-1' => 'https://s3-us-west-1.amazonaws.com',
+    'eu-west-1' => 'https://s3-eu-west-1.amazonaws.com',
+    'eu-central-1' => 'https://s3.eu-central-1.amazonaws.com',
+    'ap-southeast-1' => 'https://s3-ap-southeast-1.amazonaws.com',
+    'ap-southeast-2' => 'https://s3-ap-southeast-2.amazonaws.com',
+    'ap-northeast-1' => 'https://s3-ap-northeast-1.amazonaws.com',
+    'sa-east-1' => 'https://s3-sa-east-1.amazonaws.com',
+    'cn-north-1' => 'https://s3.cn-north-1.amazonaws.com.cn',
+    'us-gov-west-1' => 'https://s3-us-gov-west-1.amazonaws.com'
+  }
+
+  VALID_SIGV = ['2', '4']
+
+  DEFAULT_URL = 'https://s3.amazonaws.com'
+  DEFAULT_REGION = 'us-east-1'
+
+
+  attr_accessor :bucket,
+                :keyprefix,
+                :user,      # This now contains all the creds.
+                :pass,      # pass is just kept for backwards compatibility.
+                :url,
+                :region,
+                :sigv
+
+  #------------------------------------------------------------------------------#
+
+  def split_container(container)
+    splitbits = container.sub(%r{^/*},'').sub(%r{/*$},'').split("/")
+    bucket = splitbits.shift
+    keyprefix = splitbits.join("/")
+    keyprefix += "/" unless keyprefix.empty?
+    @keyprefix = keyprefix
+    @bucket = bucket
+  end
+  
+  #----------------------------------------------------------------------------#
+
+  def mandatory_params()
+    on('-b', '--bucket BUCKET', String, *BUCKET_DESCRIPTION) do |container|
+      @container = container
+      split_container(@container)
+    end
+    
+    on('-a', '--access-key USER', String, USER_DESCRIPTION) do |user|
+      @user = {} if @user.nil?
+      @user['aws_access_key_id'] = user
+    end
+    
+    on('-s', '--secret-key PASSWORD', String, PASS_DESCRIPTION) do |pass|
+      @user = {} if @user.nil?
+      @user['aws_secret_access_key'] = pass
+      @pass = pass
+    end
+    
+    on('-t', '--delegation-token TOKEN', String, DELEGATION_TOKEN_DESCRIPTION) do |token|
+      @user = {} if @user.nil?
+      @user['aws_delegation_token'] = token
+    end
+  end
+
+  #----------------------------------------------------------------------------#
+
+  def optional_params()
+    on('--url URL', String, URL_DESCRIPTION) do |url|
+      @url = url
+    end
+
+    on('--region REGION', REGION_DESCRIPTION) do |region|
+      @region = region
+    end
+
+    on('--sigv VERSION', SIGV2_DESCRIPTION) do |version_number|
+      @sigv = version_number
+    end
+  end
+
+  #----------------------------------------------------------------------------#
+
+  def get_creds_from_instance_profile
+  end
+
+  def get_creds_from_instance_profile
+    begin
+      require 'json'
+      require 'net/http'
+      profile_name = Net::HTTP.get(PROFILE_HOST, PROFILE_PATH)
+      unless (profile_name.nil? || profile_name.strip.empty?)
+        creds_blob = Net::HTTP.get(PROFILE_HOST, PROFILE_PATH + profile_name.strip)
+        creds = JSON.parse(creds_blob)
+        @user = {
+          'aws_access_key_id' => creds['AccessKeyId'],
+          'aws_secret_access_key' => creds['SecretAccessKey'],
+          'aws_delegation_token' => creds['Token'],
+        }
+        @pass = creds['SecretAccessKey']
+      end
+    rescue Exception => e
+      @user = nil
+    end
+  end
+
+  def validate_params()
+    unless @user
+        get_creds_from_instance_profile
+    end
+    raise MissingMandatory.new('--access-key') unless @user && @user['aws_access_key_id']
+    raise MissingMandatory.new('--secret-key') unless @pass
+    raise MissingMandatory.new('--bucket') unless @container
+    if @sigv && !VALID_SIGV.include?(@sigv)
+      raise InvalidValue.new('--sigv', @sigv, "Please specify one of these values: #{VALID_SIGV.join(', ')}")
+    end
+  end
+
+  #----------------------------------------------------------------------------#
+
+  def set_defaults()
+    # We need three values to be set after this point:
+    #   region - which will specify the region of the endpoint used for sigv4
+    #   url - the url of the endpoint
+    #   location - the S3 bucket location
+    #
+    # We allow the user to override any of these values. The client only has
+    # to specify the region value.
+    if @region
+      @url ||= REGION_MAP[@region]
+    elsif @location
+      @region = case @location
+        when "EU" then "eu-west-1"
+        when "US", :unconstrained then "us-east-1"
+        else @location
+      end
+      @url ||= REGION_MAP[@region]
+    elsif @url
+      STDERR.puts "Specifying url has been deprecated, please use only --region"
+      uri = URI.parse(@url)
+      if @region.nil?
+        begin
+          @region = AwsRegion::determine_region_from_host uri.host
+          STDERR.puts "Region determined to be #{@region}"
+        rescue => e
+          STDERR.puts "No region specified and could not determine region from given url"
+          @region = nil
+        end
+      end
+    else
+      @url ||= DEFAULT_URL
+      @region ||= DEFAULT_REGION
+    end
+    @sigv ||= EC2::Common::SIGV4
+  end
+end