Class: Aws::Signers::S3 Private
- Inherits:
-
Object
- Object
- Aws::Signers::S3
- Defined in:
- lib/aws-sdk-core/signers/s3.rb
This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.
Constant Summary collapse
- SIGNED_QUERYSTRING_PARAMS =
This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.
Set.new(%w( acl delete cors lifecycle location logging notification partNumber policy requestPayment restore tagging torrent uploadId uploads versionId versioning versions website response-content-type response-content-language response-expires response-cache-control response-content-disposition response-content-encoding ))
Instance Attribute Summary collapse
- #credentials ⇒ Object readonly private
- #params ⇒ Object readonly private
Class Method Summary collapse
- .sign(context) ⇒ Object private
Instance Method Summary collapse
- #authorization(request) ⇒ Object private
-
#canonicalized_headers(request) ⇒ Object
private
CanonicalizedAmzHeaders.
-
#canonicalized_resource(endpoint) ⇒ Object
private
From the S3 developer guide.
- #digest(secret, string_to_sign) ⇒ Object private
- #hmac(key, value) ⇒ Object private
-
#initialize(credentials, params, force_path_style) ⇒ S3
constructor
private
A new instance of S3.
- #sign(request) ⇒ Object private
- #signature(request) ⇒ Object private
- #signed_querystring_params(endpoint) ⇒ Object private
- #signing_string_date(request) ⇒ Object private
-
#string_to_sign(request) ⇒ Object
private
From the S3 developer guide:.
Constructor Details
#initialize(credentials, params, force_path_style) ⇒ S3
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns a new instance of S3.
31 32 33 34 35 36 37 38 |
# File 'lib/aws-sdk-core/signers/s3.rb', line 31 def initialize(credentials, params, force_path_style) @credentials = credentials @params = Query::ParamList.new params.each_pair do |param_name, param_value| @params.set(param_name, param_value) end @force_path_style = force_path_style end |
Instance Attribute Details
#credentials ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
40 41 42 |
# File 'lib/aws-sdk-core/signers/s3.rb', line 40 def credentials @credentials end |
#params ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
40 41 42 |
# File 'lib/aws-sdk-core/signers/s3.rb', line 40 def params @params end |
Class Method Details
.sign(context) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
22 23 24 25 26 27 28 |
# File 'lib/aws-sdk-core/signers/s3.rb', line 22 def self.sign(context) new( context.config.credentials, context.params, context.config.force_path_style ).sign(context.http_request) end |
Instance Method Details
#authorization(request) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
49 50 51 |
# File 'lib/aws-sdk-core/signers/s3.rb', line 49 def (request) "AWS #{credentials.access_key_id}:#{signature(request)}" end |
#canonicalized_headers(request) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
CanonicalizedAmzHeaders
See the developer guide for more information on how this element is generated.
102 103 104 105 106 107 108 |
# File 'lib/aws-sdk-core/signers/s3.rb', line 102 def canonicalized_headers(request) x_amz = request.headers.select{|k, v| k =~ /^x-amz-/i } x_amz = x_amz.collect{|k, v| [k.downcase, v] } x_amz = x_amz.sort_by{|k, v| k } x_amz = x_amz.collect{|k, v| "#{k}:#{v.to_s.strip}" }.join("\n") x_amz == '' ? nil : x_amz end |
#canonicalized_resource(endpoint) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
From the S3 developer guide
CanonicalizedResource =
[ "/" ` Bucket ] `
<HTTP-Request-URI, protocol name up to the querystring> +
[ sub-resource, if present. e.g. "?acl", "?location",
"?logging", or "?torrent"];
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 |
# File 'lib/aws-sdk-core/signers/s3.rb', line 119 def canonicalized_resource(endpoint) parts = [] # virtual hosted-style requests require the hostname to appear # in the canonicalized resource prefixed by a forward slash. if bucket = params[:bucket] bucket = bucket.value ssl = endpoint.scheme == 'https' if Plugins::S3BucketDns.dns_compatible?(bucket, ssl) && !@force_path_style && !endpoint.path.match(/^\/#{Regexp.escape(bucket)}/) then parts << "/#{bucket}" end end # append the path name (no querystring) parts << endpoint.path # lastly any sub resource querystring params need to be appened # in lexigraphical ordered joined by '&' and prefixed by '?' params = signed_querystring_params(endpoint) unless params.empty? parts << '?' parts << params.sort.collect{|p| p.to_s }.join('&') end parts.join end |
#digest(secret, string_to_sign) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
60 61 62 |
# File 'lib/aws-sdk-core/signers/s3.rb', line 60 def digest(secret, string_to_sign) Base64.encode64(hmac(secret, string_to_sign)).strip end |
#hmac(key, value) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
64 65 66 |
# File 'lib/aws-sdk-core/signers/s3.rb', line 64 def hmac(key, value) OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha1'), key, value) end |
#sign(request) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
42 43 44 45 46 47 |
# File 'lib/aws-sdk-core/signers/s3.rb', line 42 def sign(request) if token = credentials.session_token request.headers["X-Amz-Security-Token"] = token end request.headers['Authorization'] = (request) end |
#signature(request) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
53 54 55 56 57 58 |
# File 'lib/aws-sdk-core/signers/s3.rb', line 53 def signature(request) secret = credentials.secret_access_key string_to_sign = string_to_sign(request) signature = digest(credentials.secret_access_key, string_to_sign) URI.escape(signature) end |
#signed_querystring_params(endpoint) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
151 152 153 154 155 |
# File 'lib/aws-sdk-core/signers/s3.rb', line 151 def signed_querystring_params(endpoint) endpoint.query.to_s.split('&').select do |p| SIGNED_QUERYSTRING_PARAMS.include?(p.split('=')[0]) end.map { |p| URI.decode(p) } end |
#signing_string_date(request) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
87 88 89 90 91 92 93 94 95 |
# File 'lib/aws-sdk-core/signers/s3.rb', line 87 def signing_string_date(request) # if a date is provided via x-amz-date then we should omit the # Date header from the signing string (should appear as a blank line) if request.headers.detect{|k,v| k.to_s =~ /^x-amz-date$/i } '' else request.headers['Date'] = Time.now.httpdate end end |
#string_to_sign(request) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
From the S3 developer guide:
StringToSign =
HTTP-Verb ` "\n" `
content-md5 ` "\n" `
content-type ` "\n" `
date ` "\n" `
CanonicalizedAmzHeaders + CanonicalizedResource;
77 78 79 80 81 82 83 84 85 |
# File 'lib/aws-sdk-core/signers/s3.rb', line 77 def string_to_sign(request) [ request.http_method, request.headers.values_at('Content-Md5', 'Content-Type').join("\n"), signing_string_date(request), canonicalized_headers(request), canonicalized_resource(request.endpoint), ].flatten.compact.join("\n") end |