azure-storage-common 1.1.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1d3118c38760c68874586862f6d0ff3144f140d2
-  data.tar.gz: 86c0b9fa3ac4e07c761985354daa89b7b36fb5aa
+SHA256:
+  metadata.gz: 7452db26abde9be86812725e1b5e404bb6e516f87b91998bfc5fd947eac8c83f
+  data.tar.gz: f95cc3f2014cbef0e77e268d6f609ef13204ccad8d081dd22060cb47fa54a3af
 SHA512:
-  metadata.gz: b785d7399791a4d2e2f7a1b673064ebdf1382038f58d7b90ef01a0a5117322e7335801cd04bccbe4c25ad9856dda825a7edf0b75eb0c95301be325aab8b35c4d
-  data.tar.gz: 3f4105bb14a56a1c16c6e285215ea1a2604357ea6df7bd5d423d398ef6b3206dbee7185445a7dcff2449ec5482f8258008248bffed27440aff71264ac6dd9959
+  metadata.gz: d28194e508f11824e00131a0efa398caa590273b36dea55fbc8935880a643c3ad68428658629a3eed92aaf8599d4d9c503f0fc13d244c264741e3280e5cb01e3
+  data.tar.gz: ce4a878c07971a45bce0b8f1e436ac097aa0f9ba2ead1a18d9d5bef6ce40582cce0ae302e1e3ee9a099a07fd8c7ff02ff89cd7ef426c189bcb18c4da88ff0b2c

data/lib/azure/core.rb

@@ -0,0 +1,47 @@
+#-------------------------------------------------------------------------
+# # Copyright (c) Microsoft and contributors. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License 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 'rubygems'
+require 'nokogiri'
+require 'faraday'
+require 'faraday_middleware'
+
+module Azure
+  module Core
+    autoload :Utility,                        'azure/core/utility'
+    autoload :Logger,                         'azure/core/utility'
+    autoload :Error,                          'azure/core/error'
+    autoload :Service,                        'azure/core/service'
+    autoload :FilteredService,                'azure/core/filtered_service'
+    autoload :SignedService,                  'azure/core/signed_service'
+    autoload :Default,                        'azure/core/default'
+    module Auth
+      autoload :SharedKey,                    'azure/core/auth/shared_key'
+      autoload :Signer,                       'azure/core/auth/signer'
+      autoload :Authorizer,                   'azure/core/auth/authorizer'
+      autoload :SharedKeyLite,                'azure/core/auth/shared_key_lite'
+    end
+    module Http
+      autoload :DebugFilter,                  'azure/core/http/debug_filter'
+      autoload :HTTPError,                    'azure/core/http/http_error'
+      autoload :HttpFilter,                   'azure/core/http/http_filter'
+      autoload :HttpRequest,                  'azure/core/http/http_request'
+      autoload :HttpResponse,                 'azure/core/http/http_response'
+      autoload :RetryPolicy,                  'azure/core/http/retry_policy'
+      autoload :SignerFilter,                 'azure/core/http/signer_filter'
+    end
+  end
+
+end

data/lib/azure/core/auth/authorizer.rb

@@ -0,0 +1,36 @@
+#-------------------------------------------------------------------------
+# # Copyright (c) Microsoft and contributors. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License 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 "azure/core/configuration"
+
+module Azure
+  module Core
+    module Auth
+      class Authorizer
+        # Public: Signs an HTTP request before it's made, by adding the
+        # Authorization header
+        #
+        # request - An Azure::Core::HttpRequest that hasn't been signed
+        # signer  - A signing strategy, such as Azure::Table::Auth::SharedKey
+        #
+        # Returns the modified request
+        def sign(request, signer)
+          signature = signer.sign(request.method, request.uri, request.headers)
+          request.headers['Authorization'] = "#{signer.name} #{signature}"
+          request
+        end
+      end
+    end
+  end
+end

data/lib/azure/core/auth/shared_key.rb

@@ -0,0 +1,125 @@
+#-------------------------------------------------------------------------
+# # Copyright (c) Microsoft and contributors. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License 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 'cgi'
+require 'azure/core/auth/signer'
+
+module Azure
+  module Core
+    module Auth
+      class SharedKey < Signer
+        # The Azure account's name.
+        attr :account_name
+
+        # Initialize the Signer.
+        #
+        # @param account_name [String] The account name. Defaults to the one in the
+        #                global configuration.
+        # @param access_key   [String] The access_key encoded in Base64. Defaults to the
+        #                one in the global configuration.
+        def initialize(account_name=Azure.storage_account_name, access_key=Azure.storage_access_key)
+          @account_name = account_name
+          super(access_key)
+        end
+
+        # The name of the strategy.
+        #
+        # @return [String]
+        def name
+          'SharedKey'
+        end
+
+        # Create the signature for the request parameters
+        #
+        # @param method     [Symbol] HTTP request method.
+        # @param uri        [URI] URI of the request we're signing.
+        # @param headers    [Hash] HTTP request headers.
+        #
+        # @return           [String] base64 encoded signature
+        def sign(method, uri, headers)
+          "#{account_name}:#{super(signable_string(method, uri, headers))}"
+        end
+
+        # Sign the request
+        #
+        # @param req    [Azure::Core::Http::HttpRequest] HTTP request to sign
+        #
+        # @return       [Azure::Core::Http::HttpRequest]
+        def sign_request(req)
+          # Need to make sure Content-Length is correctly set.
+          if ((!req.body.nil?)) then
+            if (req.body.respond_to? :bytesize) then
+              req.headers['Content-Length'] = req.body.bytesize.to_s
+            elsif (req.body.respond_to? :size)
+              req.headers['Content-Length'] = req.body.size.to_s
+            end
+          end
+          req.headers['Authorization'] = "#{name} #{sign(req.method, req.uri, req.headers)}"
+          req
+        end
+
+        # Generate the string to sign.
+        #
+        # @param method     [Symbol] HTTP request method.
+        # @param uri        [URI] URI of the request we're signing.
+        # @param headers    [Hash] HTTP request headers.
+        #
+        # @return [String]
+        def signable_string(method, uri, headers)
+          [
+            method.to_s.upcase,
+            headers.fetch('Content-Encoding', ''),
+            headers.fetch('Content-Language', ''),
+            headers.fetch('Content-Length', ''),
+            headers.fetch('Content-MD5', ''),
+            headers.fetch('Content-Type', ''),
+            headers.fetch('Date', ''),
+            headers.fetch('If-Modified-Since', ''),
+            headers.fetch('If-Match', ''),
+            headers.fetch('If-None-Match', ''),
+            headers.fetch('If-Unmodified-Since', ''),
+            headers.fetch('Range', ''),
+            canonicalized_headers(headers),
+            canonicalized_resource(uri)
+          ].join("\n")
+        end
+
+        # Calculate the Canonicalized Headers string for a request.
+        #
+        # @param headers    [Hash] HTTP request headers.
+        #
+        # @return [String] a string with the canonicalized headers.
+        def canonicalized_headers(headers)
+          headers = headers.map { |k,v| [k.to_s.downcase, v] }
+          headers.select! { |k,_| k =~ /^x-ms-/ }
+          headers.sort_by! { |(k,_)| k }
+          headers.map! { |k,v| '%s:%s' % [k, v] }.join("\n")
+        end
+
+        # Calculate the Canonicalized Resource string for a request.
+        #
+        # @param uri        [URI] URI of the request we're signing.
+        #
+        # @return           [String] a string with the canonicalized resource.
+        def canonicalized_resource(uri)
+          resource = '/' + account_name + (uri.path.empty? ? '/' : uri.path)
+          params = CGI.parse(uri.query.to_s).map { |k,v| [k.downcase, v] }
+          params.sort_by! { |k,_| k }
+          params.map! { |k,v| '%s:%s' % [k, v.map(&:strip).sort.join(',')] }
+          [resource, *params].join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/azure/core/auth/shared_key_lite.rb

@@ -0,0 +1,48 @@
+#-------------------------------------------------------------------------
+# # Copyright (c) Microsoft and contributors. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License 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 "azure/core/auth/shared_key"
+
+module Azure
+  module Core
+    module Auth
+      class SharedKeyLite < SharedKey
+        # The name of the strategy.
+        #
+        # @return [String]
+        def name
+          'SharedKeyLite'
+        end
+
+        # Generate the string to sign.
+        #
+        # @param method     [Symbol] The HTTP request method.
+        # @param uri        [URI] The URI of the request we're signing.
+        # @param headers    [Hash] A Hash of HTTP request headers.
+        #
+        # Returns a plain text string.
+        def signable_string(method, uri, headers)
+          [
+            method.to_s.upcase,
+            headers.fetch('Content-MD5', ''),
+            headers.fetch('Content-Type', ''),
+            headers.fetch('Date') { raise IndexError, 'Headers must include Date' },
+            canonicalized_headers(headers),
+            canonicalized_resource(uri)
+          ].join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/azure/core/auth/signer.rb

@@ -0,0 +1,51 @@
+#-------------------------------------------------------------------------
+# # Copyright (c) Microsoft and contributors. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License 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 'openssl'
+require 'base64'
+
+module Azure
+  module Core
+    module Auth
+      # Utility class to sign strings with HMAC-256 and then encode the
+      # signed string using Base64.
+      class Signer
+        # The access key for the account
+        attr :access_key
+
+        # Initialize the Signer.
+        #
+        # @param access_key [String] The access_key encoded in Base64.
+        def initialize(access_key)
+          if access_key.nil?
+            raise ArgumentError, 'Signing key must be provided'
+          end
+
+          @access_key = Base64.decode64(access_key)
+        end
+
+        # Generate an HMAC signature.
+        #
+        # @param body [String] The string to sign.
+        #
+        # @return [String] a Base64 String signed with HMAC.
+        def sign(body)
+          signed = OpenSSL::HMAC.digest('sha256', access_key, body)
+          Base64.strict_encode64(signed)
+        end
+
+      end
+    end
+  end
+end

data/lib/azure/core/default.rb

@@ -0,0 +1,23 @@
+#-------------------------------------------------------------------------
+# # Copyright (c) Microsoft and contributors. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License 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 Azure
+  module Core
+    module Default
+      # Default User Agent header string
+      USER_AGENT   = "Azure-Core/#{Azure::Core::Version}".freeze
+    end
+  end
+end

data/lib/azure/core/error.rb

@@ -0,0 +1,21 @@
+#-------------------------------------------------------------------------
+# # Copyright (c) Microsoft and contributors. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License 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 Azure
+  module Core
+    # Superclass for errors generated from this library, so people can
+    # just rescue this for generic error handling
+    class Error < StandardError;end
+  end
+end

data/lib/azure/core/filtered_service.rb

@@ -0,0 +1,45 @@
+#-------------------------------------------------------------------------
+# # Copyright (c) Microsoft and contributors. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License 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 'azure/core/service'
+
+module Azure
+  module Core
+    # A base class for Service implementations
+    class FilteredService < Service
+
+      # Create a new instance of the FilteredService
+      #
+      # @param host     [String] The hostname. (optional, Default empty)
+      # @param options  [Hash] options including {:client} (optional, Default {})
+      def initialize(host='', options={})
+        super
+        @filters = []
+      end
+
+      attr_accessor :filters
+
+      def call(method, uri, body=nil, headers=nil, options={})
+        super(method, uri, body, headers) do |request|
+          filters.reverse.each { |filter| request.with_filter filter, options } if filters
+        end
+      end
+
+      def with_filter(filter=nil, &block)
+        filter = filter || block
+        filters.push filter if filter
+      end
+    end
+  end
+end

data/lib/azure/core/http/debug_filter.rb

@@ -0,0 +1,36 @@
+#-------------------------------------------------------------------------
+# # Copyright (c) Microsoft and contributors. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License 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 "azure/core/http/http_filter"
+
+module Azure
+  module Core
+    module Http
+      # A HttpFilter implementation that displays information about the request and response for debugging
+      class DebugFilter < HttpFilter
+        def call(req, _next)
+          puts "--REQUEST-BEGIN---------------------------"
+          puts "method:", req.method, "uri:", req.uri, "headers:", req.headers, "body:", req.body
+          puts "--REQUEST-END---------------------------"
+
+          r = _next.call
+          puts "--RESPONSE-BEGIN---------------------------"
+          puts "status_code:", r.status_code, "headers:", r.headers, "body:", r.body
+          puts "--RESPONSE-END---------------------------"
+          r
+        end
+      end
+    end
+  end
+end