azure-signature 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3e4bf37dea120788f3e4b8b1f1f4ba2cac0da67
-  data.tar.gz: 804102d0275a2c4a7bb01dfda9636a85e32529dc
+  metadata.gz: 88506245b215c239f08a1c85f3970c1ae0b0aa61
+  data.tar.gz: 9ebc3da7b6ccd44d3004e44dd3e4d49fa8a71a00
 SHA512:
-  metadata.gz: 3593818f612766c12b61de678db9f4766866855e17f936dd88e2fa3367cf7ba33b49557dc4f6b9925e7607bb4ae04e565d3053f4828a6f7e2814b0e79d16688d
-  data.tar.gz: ad442a9a682c1d1a921a37bd5c1baf073b1555c00bcd6df310d0d44236e4b351e703b3d057c7a19361fe21d7e59398ba3f792fa374f9baf8363d2d7f5fa5dc67
+  metadata.gz: 5fdb546f7a4af2496b7e902aedcdd4ee5b0d6bb069f9eef1b99bd75731158de052fb90374d7d3dd10e5d70a9a66e19b003a9701213b5bec48cf80522e1ec48da
+  data.tar.gz: b76a9ba3cfa945e8932dba42ec3d00854972fe867b9bc5990d9c58be461f631ce2384db1d0b333108b1f4ce2055d2f0b6e4f7f66a0cee0516bdb33e2baa64669

data/CHANGES

@@ -1,2 +1,7 @@
+= 0.2.0 - 13-Oct-2015
+* Added support for other types of signatures (blobs, queues, files).
+* The :auth_string argument no longer returns the word "Authorization".
+* Added an azure-signature file for convenience.
+
 = 0.1.0 - 25-Sep-2015
 * Initial release

data/README

@@ -21,10 +21,6 @@
   # Or pass some options
   p sig.signature(:table, :auth_string => true, :date => some_date, :verb => 'PUT')
 
-= Caveats
-  For the first release only table signatures are supported (because that's
-  what I happened to need). I'll add blob, file and queue in the future.
-
 = Acknowledgements
   I borrowed the code to canonicalize resources and headers from the
   azure-sdk-for-ruby project.

data/azure-signature.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |gem|
   gem.name      = 'azure-signature'
-  gem.version   = '0.1.0'
+  gem.version   = '0.2.0'
   gem.author    = 'Daniel J. Berger'
   gem.license   = 'Apache 2.0'
   gem.email     = 'djberg96@gmail.com'

data/lib/azure-signature.rb

@@ -0,0 +1 @@
+require_relative 'azure/signature'

data/lib/azure/signature.rb

@@ -9,7 +9,7 @@ module Azure
   # The Signature class encapsulates an canonicalized resource string.
   class Signature
     # The version of the azure-signature library.
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
 
     # The resource (URL) passed to the constructor.
     attr_reader :resource
@@ -29,6 +29,8 @@ module Azure
     alias url resource
     alias canonical_url canonical_resource
 
+    attr_reader :canonical_headers
+
     # Creates and returns an Azure::Signature object taking a +resource+ (URL)
     # as an argument and a storage account key. The +resource+ will typically
     # be an Azure storage account endpoint.
@@ -60,42 +62,162 @@ module Azure
       verb = options[:verb] || 'GET'
       date = options[:date] || Time.now.httpdate
       auth_string = options[:auth_string] || false
-      content_md5 = options[:content_md5]
-      content_type = options[:content_type]
+      content_md5 = options[:content_md5] || options['Content-MD5']
+      content_type = options[:content_type] || options['Content-Type']
 
       unless ['SharedKey', 'SharedKeyLight'].include?(auth_type)
         raise ArgumentError, "auth type must be SharedKey or SharedKeyLight"
       end
 
       if auth_type == 'SharedKey'
-        body = [verb, content_md5, content_type, date, canonical_resource].join("\n")
+        body = [verb, content_md5, content_type, date, canonical_resource].join("\n").encode('UTF-8')
+      else
+        body = [date, canonical_resource].join("\n").encode('UTF-8')
+      end
+
+      if auth_string
+        "#{auth_type} #{account_name}:" + sign(body)
       else
-        body = [date, canonical_resource].join("\n")
+        sign(body)
+      end
+    end
+
+    # Generate a signature for use with the blob service. Use the +headers+
+    # hash to pass optional information. The following additional keys are
+    # supported:
+    #
+    # - :auth_type. Either 'SharedKey' (the default) or 'SharedKeyLight'.
+    # - :verb. The http verb used for SharedKey auth. The default is 'GET'.
+    # - :x_ms_date. The x-ms-date used. The default is Time.now.httpdate.
+    # - :x_ms_version. The x-ms-version used. The default is '2015-02-21'.
+    # - :auth_string. If true, prepends the auth_type + account name to the
+    #    result and returns a string. The default is false.
+    #
+    # The other headers of potential significance are below. Note that you
+    # are not required to set any of them.
+    #
+    # - 'Content-Encoding'
+    # - 'Content-Language'
+    # - 'Content-Length'
+    # - 'Content-MD5'
+    # - 'Content-Type'
+    # - 'Date'
+    # - 'If-Modified-Since'
+    # - 'If-Match'
+    # - 'If-None-Match'
+    # - 'If-Unmodified-Since'
+    # - 'Range'
+    #
+    # The result is a digest string that you can use as an authorization header
+    # for future http requests to (presumably) Azure storage endpoints.
+    #
+    # Example:
+    #
+    #  require 'azure-signature'
+    #  require 'rest-client'
+    #
+    #  url = "https://yourstuff.blob.core.windows.net/system?restype=container&comp=list&include=snapshots"
+    #  key = "xyzabcwhatever"
+    #
+    #  sig  = Signature.new(url, key)
+    #  date = Time.now.httpdate
+    #  vers = '2015-02-21'
+    #
+    #  headers = {
+    #    'x-ms-date'    => date,
+    #    'x-ms-version' => vers,
+    #    'Accept'       => 'application/xml',
+    #    :auth_string   => true,
+    #  }
+    #
+    #  sig = sig.blob_signature(headers)
+    # headers['Authorization'] = sig
+    #
+    #  req = RestClient::Request.new(
+    #    :method => 'get',
+    #    :url => url,
+    #    :headers => headers
+    #  )
+    #
+    # response = req.execute
+    # p response.body
+    #
+    def blob_signature(headers = {})
+      auth_string = headers.delete(:auth_string) || false
+      auth_type = headers.delete(:auth_type) || 'SharedKey'
+      verb = headers.delete(:verb) || 'GET'
+
+      unless ['SharedKey', 'SharedKeyLight'].include?(auth_type)
+        raise ArgumentError, "auth type must be SharedKey or SharedKeyLight"
       end
 
+      headers['x-ms-date'] ||= headers.delete(:x_ms_date) || Time.now.httpdate
+      headers['x-ms-version'] ||= headers.delete(:x_ms_version) || '2015-02-21'
+
+      if auth_type == 'SharedKeyLight'
+        headers['Date'] ||= headers['x-ms-date'] || headers[:date] || Time.now.httpdate
+      end
+
+      body = generate_string(verb, headers, auth_type).encode('UTF-8')
+
       if auth_string
-        "Authorization: #{auth_type} #{account_name}:" + sign(body)
+        "SharedKey #{account_name}:" + sign(body)
       else
         sign(body)
       end
     end
 
+    alias file_signature blob_signature
+    alias queue_signature blob_signature
+
     # Generic wrapper method for getting a signature, where +type+ can be
     # :table, :blob, :queue, or :file.
     #
-    # At the moment only :table is supported.
-    #--
-    # TODO: Add support for other types.
-    #
     def signature(type, args = {})
       case type.to_s.downcase
         when 'table'
           table_signature(args)
+        when 'blob', 'file', 'queue'
+          blob_signature(args)
+        else
+          raise ArgumentError, "invalid signature type '#{type}'"
       end
     end
 
     private
 
+    def generate_string(verb, headers, auth_type)
+      canonical_headers = canonicalize_headers(headers)
+
+      if auth_type == 'SharedKeyLight'
+       [
+          verb.to_s.upcase,
+          headers['Content-MD5'],
+          headers['Content-Type'],
+          headers['Date'],
+          canonical_headers,
+          canonical_resource
+        ].join("\n")
+      else
+        [
+          verb.to_s.upcase,
+          headers['Content-Encoding'],
+          headers['Content-Language'],
+          headers['Content-Length'],
+          headers['Content-MD5'],
+          headers['Content-Type'],
+          headers['Date'],
+          headers['If-Modified-Since'],
+          headers['If-Match'],
+          headers['If-None-Match'],
+          headers['If-Unmodified-Since'],
+          headers['Range'],
+          canonical_headers,
+          canonical_resource,
+        ].join("\n")
+      end
+    end
+
     # Generate a canonical URL from an endpoint.
     #--
     # Borrowed from azure-sdk-for-ruby. I had my own, but this was nicer.
@@ -112,8 +234,8 @@ module Azure
     #--
     # Borrowed from azure-sdk-for-ruby.
     #
-    def canonicalized_headers(headers)
-      headers = headers.map { |k,v| [k.to_s.downcase, v] }
+    def canonicalize_headers(headers)
+      headers = headers.map { |k,v| [k.to_s.gsub('_', '-').downcase, v] }
       headers.select! { |k,v| k =~ /^x-ms-/ }
       headers.sort_by! { |k,v| k }
       headers.map! { |k,v| '%s:%s' % [k, v] }

data/test/test_signature.rb

@@ -9,7 +9,7 @@ class TC_Azure_Signature < Test::Unit::TestCase
   end
 
   test "version constant is set to expected value" do
-    assert_equal("0.1.0", Azure::Signature::VERSION)
+    assert_equal("0.2.0", Azure::Signature::VERSION)
   end
 
   test "key method basic functionality" do
@@ -82,6 +82,19 @@ class TC_Azure_Signature < Test::Unit::TestCase
     assert_raise(ArgumentError){ Azure::Signature.new('http://foo/bar') }
   end
 
+  test "table_signature basic functionality" do
+    assert_respond_to(@sig, :table_signature)
+  end
+
+  test "blob_signature basic functionality" do
+    assert_respond_to(@sig, :blob_signature)
+  end
+
+  test "file_signature and queue_signature are aliases for blob_signature" do
+    assert_alias_method(@sig, :blob_signature, :file_signature)
+    assert_alias_method(@sig, :blob_signature, :queue_signature)
+  end
+
   def teardown
     @key = nil
     @url = nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: azure-signature
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel J. Berger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-25 00:00:00.000000000 Z
+date: 2015-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -41,6 +41,7 @@ files:
 - README
 - Rakefile
 - azure-signature.gemspec
+- lib/azure-signature.rb
 - lib/azure/signature.rb
 - test/test_signature.rb
 homepage: http://github.com/djberg96/azure-signature
@@ -63,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Generate authentication signatures for Azure