warden-hmac-authentication 0.5.2 → 0.5.3

data/bin/warden-hmac-authentication

@@ -1,16 +1,68 @@
 #!/usr/bin/env ruby
-#
-# This file was generated by Bundler.
-#
-# The application 'warden-hmac-authentication' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+begin
+  require 'trollop'
+rescue LoadError => e
+  puts ""
+  puts ""
+  puts "============= ERROR ================"
+  puts ""
+  puts "You need trollop installed or in your gemfile to use the signer"
+  puts ""
+  puts "============= ERROR ================"
+  puts ""
+  puts ""
+  exit(-1)
+end
 
-require 'rubygems'
-require 'bundler/setup'
+require 'hmac/signer'
 
-load Gem.bin_path('warden-hmac-authentication', 'warden-hmac-authentication')
+opts = Trollop::options do
+  
+  version "warden-hmac-sign 0.3.0 (c) 2011 Felix Gilcher, Florian Gilcher"
+    banner <<-EOS
+  warden-hmac-authentication is used to create and validate signed urls for
+  usage with the HMAC authentication scheme used by 
+  https://github.com/Asquera/warden-hmac-authentication
+
+  Usage:
+         warden-hmac-authentication [options] <command> url
+  
+  where command is one of
+  
+    sign: signs the given url 
+    validate: validates the given url
+    
+  and where [options] are:
+  
+  EOS
+  
+  opt :algorithm, "The hashing algorithm to use for the HMAC", :type => :string, :default => "sha1"
+  opt :secret, "The shared secret for the HMAC", :type => :string, :required => true
+  opt :"auth-param", "The name for the auth param in the url", :default => "auth"
+  opt :"date", "The date to use for the signature (defaults to now)"
+end
+
+cmd = ARGV.shift
+Trollop::die "You must give a command" if cmd.nil?
+Trollop::die "You command must be one of [sign, validate]" unless ["sign", "validate"].include? cmd
+Trollop::die "You must provide a URL" if ARGV.empty?
+url = ARGV.shift
+
+secret = opts.delete(:secret)
+algorithm = opts.delete(:algorithm)
+
+signer = HMAC::Signer.new(algorithm)
+
+if "sign" == cmd
+  puts signer.sign_url(url, secret, opts)
+else
+  success = signer.validate_url_signature(url, secret, opts)
+  if success
+    puts "URL #{url} is valid"
+    exit 0
+  else
+    puts "URL #{url} does not contain a valid signature"
+    exit 1
+  end
+end

data/lib/hmac/strategies/base.rb

@@ -23,7 +23,7 @@ module Warden
             debug("authentication attempt with an empty secret")
             return fail!("Cannot authenticate with an empty secret")
           end
-    
+          
           if check_ttl? && !timestamp_valid?
             debug("authentication attempt with an invalid timestamp. Given was #{timestamp}, expected was #{Time.now.gmtime}")
             return fail!("Invalid timestamp")  
@@ -93,7 +93,11 @@ module Warden
   
         private
           def config
-            env["warden"].config[:scope_defaults][scope][:hmac]
+            if env["warden"].config[:scope_defaults][scope][:hmac]
+              env["warden"].config[:scope_defaults][scope][:hmac]
+            else
+              {}
+            end
           end
     
           def auth_param
@@ -124,6 +128,13 @@ module Warden
             config[:auth_header_format] || '%{scheme} %{signature}'
           end
           
+          # check whether a nonce is set in the request
+          #
+          # @return [Bool] True if a nonce was given in the request
+          def has_nonce?
+            nonce && !nonce.to_s.empty?
+          end
+          
           def auth_header_parse
             unless @auth_header_parse
               r = config[:auth_header_parse]

data/lib/hmac/strategies/query.rb

@@ -15,12 +15,19 @@ module Warden
         # @return [Bool] true if all required authentication information is available in the request
         # @see https://github.com/hassox/warden/wiki/Strategies
         def valid?
-          valid = auth_info.include? "signature"
+          valid = has_signature?
           valid = valid && has_timestamp? if check_ttl?
           valid = valid && has_nonce? if nonce_required?
           valid
         end
-
+        
+        # Checks that the request contains a signature
+        #
+        # @return [Bool] true if the request contains a signature
+        def has_signature?
+          auth_info.include? "signature"
+        end
+        
         # Check that the signature given in the request is valid.
         #
         # @return [Bool] true if the request is valid

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: warden-hmac-authentication
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-14 00:00:00.000000000Z
+date: 2011-12-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: &2155925200 !ruby/object:Gem::Requirement
+  requirement: &2154430420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2155925200
+  version_requirements: *2154430420
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &2155924300 !ruby/object:Gem::Requirement
+  requirement: &2154429940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,21 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2155924300
-- !ruby/object:Gem::Dependency
-  name: trollop
-  requirement: &2155923580 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: *2155923580
+  version_requirements: *2154429940
 - !ruby/object:Gem::Dependency
   name: warden
-  requirement: &2155922780 !ruby/object:Gem::Requirement
+  requirement: &2154429480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +44,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2155922780
+  version_requirements: *2154429480
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2155922360 !ruby/object:Gem::Requirement
+  requirement: &2154428920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155922360
+  version_requirements: *2154428920
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &2155921780 !ruby/object:Gem::Requirement
+  requirement: &2154428340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155921780
+  version_requirements: *2154428340
 - !ruby/object:Gem::Dependency
   name: riot
-  requirement: &2155921300 !ruby/object:Gem::Requirement
+  requirement: &2154421440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155921300
+  version_requirements: *2154421440
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &2155920720 !ruby/object:Gem::Requirement
+  requirement: &2154420320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +88,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155920720
+  version_requirements: *2154420320
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2155920200 !ruby/object:Gem::Requirement
+  requirement: &2154419880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -110,10 +99,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155920200
+  version_requirements: *2154419880
 - !ruby/object:Gem::Dependency
   name: simplecov-html
-  requirement: &2155919780 !ruby/object:Gem::Requirement
+  requirement: &2154419300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2154419300
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: &2154418520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -121,7 +121,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155919780
+  version_requirements: *2154418520
 description: ! "This gem provides request authentication via [HMAC](http://en.wikipedia.org/wiki/Hmac).
   The main usage is request based, noninteractive\n  authentication for API implementations.
   Two strategies are supported that differ mainly in how the authentication information