Module: AWS

Defined in:
lib/AWS/exceptions.rb,
lib/AWS.rb,
lib/AWS/EC2.rb,
lib/AWS/ELB.rb,
lib/AWS/responses.rb,
lib/AWS/EC2/images.rb,
lib/AWS/EC2/console.rb,
lib/AWS/EC2/volumes.rb,
lib/AWS/EC2/keypairs.rb,
lib/AWS/EC2/products.rb,
lib/AWS/EC2/instances.rb,
lib/AWS/EC2/snapshots.rb,
lib/AWS/EC2/elastic_ips.rb,
lib/AWS/ELB/load_balancers.rb,
lib/AWS/EC2/security_groups.rb,
lib/AWS/EC2/image_attributes.rb,
lib/AWS/EC2/availability_zones.rb

Overview

– AWS EC2 CLIENT ERROR CODES AWS EC2 can throw error exceptions that contain a ‘.’ in them. since we can’t name an exception class with that ‘.’ I compressed each class name into the non-dot version. This allows us to retain the granularity of the exception. ++

Defined Under Namespace

Modules: EC2, ELB Classes: ArgumentError, AuthFailure, Base, DuplicateLoadBalancerName, Error, InstanceLimitExceeded, InsufficientInstanceCapacity, InternalError, InvalidAMIAttributeItemValue, InvalidAMIIDMalformed, InvalidAMIIDNotFound, InvalidAMIIDUnavailable, InvalidClientTokenId, InvalidConfigurationRequest, InvalidGroupDuplicate, InvalidGroupInUse, InvalidGroupNotFound, InvalidGroupReserved, InvalidInstance, InvalidInstanceIDMalformed, InvalidInstanceIDNotFound, InvalidKeyPairDuplicate, InvalidKeyPairNotFound, InvalidManifest, InvalidParameterCombination, InvalidParameterValue, InvalidPermissionDuplicate, InvalidPermissionMalformed, InvalidReservationIDMalformed, InvalidReservationIDNotFound, InvalidUserIDMalformed, LoadBalancerNotFound, Response, SignatureDoesNotMatch, TooManyLoadBalancers, Unavailable, UnknownParameter, ValidationError

Class Method Summary collapse

Class Method Details

.canonical_string(params, host, method = "POST", base = "/") ⇒ String

Builds the canonical string for signing requests. This strips out all ‘&’, ‘?’, and ‘=’ from the query string to be signed. The parameters in the path passed in must already be sorted in case-insensitive alphabetical order and must not be url encoded.

Parameters:

  • params (String) —

    the params that will be sorted and encoded as a canonical string.

  • host (String) —

    the hostname of the API endpoint.

  • method (String) (defaults to: "POST") —

    the HTTP method that will be used to submit the params.

  • base (String) (defaults to: "/") —

    the URI path that this information will be submitted to.

Returns:

  • (String) —

    the canonical request description string.



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/AWS.rb', line 45

def AWS.canonical_string(params, host, method="POST", base="/")
  # Sort, and encode parameters into a canonical string.
  sorted_params = params.sort {|x,y| x[0] <=> y[0]}
  encoded_params = sorted_params.collect do |p|
    encoded = (CGI::escape(p[0].to_s) +
               "=" + CGI::escape(p[1].to_s))
    # Ensure spaces are encoded as '%20', not '+'
    encoded.gsub('+', '%20')
  end
  sigquery = encoded_params.join("&")

  # Generate the request description string
  req_desc =
    method + "\n" +
    host + "\n" +
    base + "\n" +
    sigquery

end

.encode(secret_access_key, str, urlencode = true) ⇒ String

Encodes the given string with the secret_access_key by taking the hmac-sha1 sum, and then base64 encoding it. Optionally, it will also url encode the result of that to protect the string if it’s going to be used as a query string parameter.

Parameters:

  • secret_access_key (String) —

    the user’s secret access key for signing.

  • str (String) —

    the string to be hashed and encoded.

  • urlencode (Boolean) (defaults to: true) —

    whether or not to url encode the result., true or false

Returns:

  • (String) —

    the signed and encoded string.



74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/AWS.rb', line 74

def AWS.encode(secret_access_key, str, urlencode=true)
  digest = OpenSSL::Digest::Digest.new('sha1')
  b64_hmac =
    Base64.encode64(
      OpenSSL::HMAC.digest(digest, secret_access_key, str)).gsub("\n","")

  if urlencode
    return CGI::escape(b64_hmac)
  else
    return b64_hmac
  end
end