httpclient 2.3.0.1 → 2.8.3

data/lib/httpclient/auth.rb

@@ -1,5 +1,5 @@
 # HTTPClient - HTTP client library.
-# Copyright (C) 2000-2009  NAKAMURA, Hiroshi  <nahi@ruby-lang.org>.
+# Copyright (C) 2000-2015  NAKAMURA, Hiroshi  <nahi@ruby-lang.org>.
 #
 # This program is copyrighted free software by NAKAMURA, Hiroshi.  You can
 # redistribute it and/or modify it under the same terms of Ruby's license;
@@ -8,31 +8,14 @@
 
 require 'digest/md5'
 require 'httpclient/session'
+require 'mutex_m'
 
 
 class HTTPClient
 
-  begin
-    require 'net/ntlm'
-    NTLMEnabled = true
-  rescue LoadError
-    NTLMEnabled = false
-  end
-
-  begin
-    require 'win32/sspi'
-    SSPIEnabled = true
-  rescue LoadError
-    SSPIEnabled = false
-  end
-
-  begin
-    require 'gssapi'
-    GSSAPIEnabled = true
-  rescue LoadError
-    GSSAPIEnabled = false
-  end
-
+  NTLMEnabled = false
+  SSPIEnabled = false
+  GSSAPIEnabled = false
 
   # Common abstract class for authentication filter.
   #
@@ -112,6 +95,13 @@ class HTTPClient
       @authenticator.each do |auth|
         next unless auth.set? # hasn't be set, don't use it
         if cred = auth.get(req)
+          if cred == :skip
+            # some authenticator (NTLM and Negotiate) does not
+            # need to send extra header after authorization. In such case
+            # it should block other authenticators to respond and :skip is
+            # the marker for such case.
+            return
+          end
           req.header.set('Authorization', auth.scheme + " " + cred)
           return
         end
@@ -196,6 +186,13 @@ class HTTPClient
       @authenticator.each do |auth|
         next unless auth.set? # hasn't be set, don't use it
         if cred = auth.get(req)
+          if cred == :skip
+            # some authenticator (NTLM and Negotiate) does not
+            # need to send extra header after authorization. In such case
+            # it should block other authenticators to respond and :skip is
+            # the marker for such case.
+            return
+          end
           req.header.set('Proxy-Authorization', auth.scheme + " " + cred)
           return
         end
@@ -225,44 +222,59 @@ class HTTPClient
     end
   end
 
-  # Authentication filter for handling BasicAuth negotiation.
-  # Used in WWWAuth and ProxyAuth.
-  class BasicAuth
+  # Authentication filter base class.
+  class AuthBase
     include HTTPClient::Util
 
     # Authentication scheme.
     attr_reader :scheme
 
-    # Creates new BasicAuth filter.
-    def initialize
-      @cred = nil
-      @set = false
-      @auth = {}
-      @challengeable = {}
-      @scheme = "Basic"
+    def initialize(scheme)
+      @scheme = scheme
+      @challenge = {}
     end
 
     # Resets challenge state.  Do not send '*Authorization' header until the
     # server sends '*Authentication' again.
     def reset_challenge
-      @challengeable.clear
+      synchronize do
+        @challenge.clear
+      end
+    end
+  end
+
+  # Authentication filter for handling BasicAuth negotiation.
+  # Used in WWWAuth and ProxyAuth.
+  class BasicAuth < AuthBase
+    include Mutex_m
+
+    # Send Authorization Header without receiving 401
+    attr_accessor :force_auth
+
+    # Creates new BasicAuth filter.
+    def initialize
+      super('Basic')
+      @cred = nil
+      @auth = {}
+      @force_auth = false
     end
 
     # Set authentication credential.
     # uri == nil for generic purpose (allow to use user/password for any URL).
     def set(uri, user, passwd)
-      @set = true
-      if uri.nil?
-        @cred = ["#{user}:#{passwd}"].pack('m').tr("\n", '')
-      else
-        uri = Util.uri_dirname(uri)
-        @auth[uri] = ["#{user}:#{passwd}"].pack('m').tr("\n", '')
+      synchronize do
+        if uri.nil?
+          @cred = ["#{user}:#{passwd}"].pack('m').tr("\n", '')
+        else
+          uri = Util.uri_dirname(uri)
+          @auth[uri] = ["#{user}:#{passwd}"].pack('m').tr("\n", '')
+        end
       end
     end
 
     # have we marked this as set - ie that it's valid to use in this context?
     def set?
-      @set == true
+      @cred || @auth.any?
     end
 
     # Response handler: returns credential.
@@ -271,76 +283,75 @@ class HTTPClient
     # * child page of defined credential
     def get(req)
       target_uri = req.header.request_uri
-      return nil unless @challengeable.find { |uri, ok|
-        Util.uri_part_of(target_uri, uri) and ok
-      }
-      return @cred if @cred
-      Util.hash_find_value(@auth) { |uri, cred|
-        Util.uri_part_of(target_uri, uri)
+      synchronize {
+        return nil if !@force_auth and !@challenge.any? { |uri, ok|
+          Util.uri_part_of(target_uri, uri) and ok
+        }
+        return @cred if @cred
+        Util.hash_find_value(@auth) { |uri, cred|
+          Util.uri_part_of(target_uri, uri)
+        }
       }
     end
 
     # Challenge handler: remember URL for response.
     def challenge(uri, param_str = nil)
-      @challengeable[urify(uri)] = true
-      true
+      synchronize {
+        @challenge[urify(uri)] = true
+        true
+      }
     end
   end
 
   class ProxyBasicAuth < BasicAuth
-
     def set(uri, user, passwd)
-      @set = true
-      @cred = ["#{user}:#{passwd}"].pack('m').tr("\n", '')
+      synchronize do
+        @cred = ["#{user}:#{passwd}"].pack('m').tr("\n", '')
+      end
     end
 
     def get(req)
-      target_uri = req.header.request_uri
-      return nil unless @challengeable['challenged']
-      @cred
+      synchronize {
+        return nil if !@force_auth and !@challenge['challenged']
+        @cred
+      }
     end
 
     # Challenge handler: remember URL for response.
     def challenge(uri, param_str = nil)
-      @challengeable['challenged'] = true
-      true
+      synchronize {
+        @challenge['challenged'] = true
+        true
+      }
     end
   end
 
   # Authentication filter for handling DigestAuth negotiation.
   # Used in WWWAuth.
-  class DigestAuth
-    # Authentication scheme.
-    attr_reader :scheme
+  class DigestAuth < AuthBase
+    include Mutex_m
 
     # Creates new DigestAuth filter.
     def initialize
+      super('Digest')
       @auth = {}
-      @challenge = {}
-      @set = false
       @nonce_count = 0
-      @scheme = "Digest"
-    end
-
-    # Resets challenge state.  Do not send '*Authorization' header until the
-    # server sends '*Authentication' again.
-    def reset_challenge
-      @challenge.clear
     end
 
     # Set authentication credential.
     # uri == nil is ignored.
     def set(uri, user, passwd)
-      @set = true
-      if uri
-        uri = Util.uri_dirname(uri)
-        @auth[uri] = [user, passwd]
+      synchronize do
+        if uri
+          uri = Util.uri_dirname(uri)
+          @auth[uri] = [user, passwd]
+        end
       end
     end
 
     # have we marked this as set - ie that it's valid to use in this context?
     def set?
-      @set == true
+      @auth.any?
     end
 
     # Response handler: returns credential.
@@ -349,21 +360,25 @@ class HTTPClient
     # * child page of defined credential
     def get(req)
       target_uri = req.header.request_uri
-      param = Util.hash_find_value(@challenge) { |uri, v|
-        Util.uri_part_of(target_uri, uri)
-      }
-      return nil unless param
-      user, passwd = Util.hash_find_value(@auth) { |uri, auth_data|
-        Util.uri_part_of(target_uri, uri)
+      synchronize {
+        param = Util.hash_find_value(@challenge) { |uri, v|
+          Util.uri_part_of(target_uri, uri)
+        }
+        return nil unless param
+        user, passwd = Util.hash_find_value(@auth) { |uri, auth_data|
+          Util.uri_part_of(target_uri, uri)
+        }
+        return nil unless user
+        calc_cred(req, user, passwd, param)
       }
-      return nil unless user
-      calc_cred(req, user, passwd, param)
     end
 
     # Challenge handler: remember URL and challenge token for response.
     def challenge(uri, param_str)
-      @challenge[uri] = parse_challenge_param(param_str)
-      true
+      synchronize {
+        @challenge[uri] = parse_challenge_param(param_str)
+        true
+      }
     end
 
   private
@@ -445,127 +460,131 @@ class HTTPClient
 
     # overrides DigestAuth#set. sets default user name and password. uri is not used.
     def set(uri, user, passwd)
-      @set = true
-      @auth = [user, passwd]
+      synchronize do
+        @auth = [user, passwd]
+      end
     end
 
     # overrides DigestAuth#get. Uses default user name and password
     # regardless of target uri if the proxy has required authentication
     # before
     def get(req)
-      target_uri = req.header.request_uri
-      param = @challenge
-      return nil unless param
-      user, passwd = @auth
-      return nil unless user
-      calc_cred(req, user, passwd, param)
+      synchronize {
+        param = @challenge
+        return nil unless param
+        user, passwd = @auth
+        return nil unless user
+        calc_cred(req, user, passwd, param)
+      }
     end
 
     def reset_challenge
-      @challenge = nil
+      synchronize do
+        @challenge = nil
+      end
     end
 
     def challenge(uri, param_str)
-      @challenge = parse_challenge_param(param_str)
-      true
+      synchronize {
+        @challenge = parse_challenge_param(param_str)
+        true
+      }
     end
-
   end
 
   # Authentication filter for handling Negotiate/NTLM negotiation.
   # Used in WWWAuth and ProxyAuth.
   #
   # NegotiateAuth depends on 'ruby/ntlm' module.
-  class NegotiateAuth
-    # Authentication scheme.
-    attr_reader :scheme
+  class NegotiateAuth < AuthBase
+    include Mutex_m
+
     # NTLM opt for ruby/ntlm.  {:ntlmv2 => true} by default.
     attr_reader :ntlm_opt
 
     # Creates new NegotiateAuth filter.
     def initialize(scheme = "Negotiate")
+      super(scheme)
       @auth = {}
       @auth_default = nil
-      @challenge = {}
-      @scheme = scheme
-      @set = false
       @ntlm_opt = {
         :ntlmv2 => true
       }
     end
 
-    # Resets challenge state.  Do not send '*Authorization' header until the
-    # server sends '*Authentication' again.
-    def reset_challenge
-      @challenge.clear
-    end
-
     # Set authentication credential.
     # uri == nil for generic purpose (allow to use user/password for any URL).
     def set(uri, user, passwd)
-      @set = true
-      if uri
-        uri = Util.uri_dirname(uri)
-        @auth[uri] = [user, passwd]
-      else
-        @auth_default = [user, passwd]
+      synchronize do
+        if uri
+          uri = Util.uri_dirname(uri)
+          @auth[uri] = [user, passwd]
+        else
+          @auth_default = [user, passwd]
+        end
       end
     end
 
     # have we marked this as set - ie that it's valid to use in this context?
     def set?
-      @set == true
+      @auth_default || @auth.any?
     end
 
     # Response handler: returns credential.
     # See ruby/ntlm for negotiation state transition.
     def get(req)
-      return nil unless NTLMEnabled
       target_uri = req.header.request_uri
-      domain_uri, param = @challenge.find { |uri, v|
-        Util.uri_part_of(target_uri, uri)
-      }
-      return nil unless param
-      user, passwd = Util.hash_find_value(@auth) { |uri, auth_data|
-        Util.uri_part_of(target_uri, uri)
+      synchronize {
+        _domain_uri, param = @challenge.find { |uri, v|
+          Util.uri_part_of(target_uri, uri)
+        }
+        return nil unless param
+        user, passwd = Util.hash_find_value(@auth) { |uri, auth_data|
+          Util.uri_part_of(target_uri, uri)
+        }
+        unless user
+          user, passwd = @auth_default
+        end
+        return nil unless user
+        Util.try_require('net/ntlm') || return
+        domain = nil
+        domain, user = user.split("\\") if user.index("\\")
+        state = param[:state]
+        authphrase = param[:authphrase]
+        case state
+        when :init
+          t1 = Net::NTLM::Message::Type1.new
+          t1.domain = domain if domain
+          t1.encode64
+        when :response
+          t2 = Net::NTLM::Message.decode64(authphrase)
+          param = {:user => user, :password => passwd}
+          param[:domain] = domain if domain
+          t3 = t2.response(param, @ntlm_opt.dup)
+          @challenge[target_uri][:state] = :done
+          t3.encode64
+        when :done
+          :skip
+        else
+          nil
+        end
       }
-      unless user
-        user, passwd = @auth_default
-      end
-      return nil unless user
-      domain = nil
-      domain, user = user.split("\\") if user.index("\\")
-      state = param[:state]
-      authphrase = param[:authphrase]
-      case state
-      when :init
-        t1 = Net::NTLM::Message::Type1.new
-        t1.domain = domain if domain
-        return t1.encode64
-      when :response
-        t2 = Net::NTLM::Message.decode64(authphrase)
-        param = {:user => user, :password => passwd}
-        param[:domain] = domain if domain
-        t3 = t2.response(param, @ntlm_opt.dup)
-        @challenge.delete(domain_uri)
-        return t3.encode64
-      end
-      nil
     end
 
     # Challenge handler: remember URL and challenge token for response.
     def challenge(uri, param_str)
-      return false unless NTLMEnabled
-      if param_str.nil? or @challenge[uri].nil?
-        c = @challenge[uri] = {}
-        c[:state] = :init
-        c[:authphrase] = ""
-      else
-        c = @challenge[uri]
-        c[:state] = :response
-        c[:authphrase] = param_str
-      end
-      true
+      synchronize {
+        if param_str.nil? or @challenge[uri].nil?
+          c = @challenge[uri] = {}
+          c[:state] = :init
+          c[:authphrase] = ""
+        else
+          c = @challenge[uri]
+          c[:state] = :response
+          c[:authphrase] = param_str
+        end
+        true
+      }
     end
   end
 
@@ -574,20 +593,12 @@ class HTTPClient
   # Used in ProxyAuth.
   #
   # SSPINegotiateAuth depends on 'win32/sspi' module.
-  class SSPINegotiateAuth
-    # Authentication scheme.
-    attr_reader :scheme
+  class SSPINegotiateAuth < AuthBase
+    include Mutex_m
 
     # Creates new SSPINegotiateAuth filter.
     def initialize
-      @challenge = {}
-      @scheme = "Negotiate"
-    end
-
-    # Resets challenge state.  Do not send '*Authorization' header until the
-    # server sends '*Authentication' again.
-    def reset_challenge
-      @challenge.clear
+      super('Negotiate')
     end
 
     # Set authentication credential.
@@ -597,58 +608,64 @@ class HTTPClient
       # not supported
     end
 
-    # have we marked this as set - ie that it's valid to use in this context?
+    # Check always (not effective but it works)
     def set?
-      SSPIEnabled || GSSAPIEnabled
+      !@challenge.empty?
     end
 
     # Response handler: returns credential.
     # See win32/sspi for negotiation state transition.
     def get(req)
-      return nil unless SSPIEnabled || GSSAPIEnabled
       target_uri = req.header.request_uri
-      domain_uri, param = @challenge.find { |uri, v|
-        Util.uri_part_of(target_uri, uri)
-      }
-      return nil unless param
-      state = param[:state]
-      authenticator = param[:authenticator]
-      authphrase = param[:authphrase]
-      case state
-      when :init
-        if SSPIEnabled
-          authenticator = param[:authenticator] = Win32::SSPI::NegotiateAuth.new
-          return authenticator.get_initial_token(@scheme)
-        else # use GSSAPI
-          authenticator = param[:authenticator] = GSSAPI::Simple.new(domain_uri.host, 'HTTP')
-          # Base64 encode the context token
-          return [authenticator.init_context].pack('m').gsub(/\n/,'')
-        end
-      when :response
-        @challenge.delete(domain_uri)
-        if SSPIEnabled
-          return authenticator.complete_authentication(authphrase)
-        else # use GSSAPI
-          return authenticator.init_context(authphrase.unpack('m').pop)
+      synchronize {
+        domain_uri, param = @challenge.find { |uri, v|
+          Util.uri_part_of(target_uri, uri)
+        }
+        return nil unless param
+        Util.try_require('win32/sspi') || Util.try_require('gssapi') || return
+        state = param[:state]
+        authenticator = param[:authenticator]
+        authphrase = param[:authphrase]
+        case state
+        when :init
+          if defined?(Win32::SSPI)
+            authenticator = param[:authenticator] = Win32::SSPI::NegotiateAuth.new
+            authenticator.get_initial_token(@scheme)
+          else # use GSSAPI
+            authenticator = param[:authenticator] = GSSAPI::Simple.new(domain_uri.host, 'HTTP')
+            # Base64 encode the context token
+            [authenticator.init_context].pack('m').gsub(/\n/,'')
+          end
+        when :response
+          @challenge[target_uri][:state] = :done
+          if defined?(Win32::SSPI)
+            authenticator.complete_authentication(authphrase)
+          else # use GSSAPI
+            authenticator.init_context(authphrase.unpack('m').pop)
+          end
+        when :done
+          :skip
+        else
+          nil
         end
-      end
-      nil
+      }
     end
 
     # Challenge handler: remember URL and challenge token for response.
     def challenge(uri, param_str)
-      return false unless SSPIEnabled || GSSAPIEnabled
-      if param_str.nil? or @challenge[uri].nil?
-        c = @challenge[uri] = {}
-        c[:state] = :init
-        c[:authenticator] = nil
-        c[:authphrase] = ""
-      else
-        c = @challenge[uri]
-        c[:state] = :response
-        c[:authphrase] = param_str
-      end
-      true
+      synchronize {
+        if param_str.nil? or @challenge[uri].nil?
+          c = @challenge[uri] = {}
+          c[:state] = :init
+          c[:authenticator] = nil
+          c[:authphrase] = ""
+        else
+          c = @challenge[uri]
+          c[:state] = :response
+          c[:authphrase] = param_str
+        end
+        true
+      }
     end
   end
 
@@ -662,11 +679,8 @@ class HTTPClient
   # CAUTION: This impl does NOT support OAuth Request Body Hash spec for now.
   # http://oauth.googlecode.com/svn/spec/ext/body_hash/1.0/oauth-bodyhash.html
   #
-  class OAuth
-    include HTTPClient::Util
-
-    # Authentication scheme.
-    attr_reader :scheme
+  class OAuth < AuthBase
+    include Mutex_m
 
     class Config
       include HTTPClient::Util
@@ -737,20 +751,13 @@ class HTTPClient
 
     # Creates new DigestAuth filter.
     def initialize
+      super('OAuth')
       @config = nil # common config
       @auth = {} # configs for each site
-      @challengeable = {}
       @nonce_count = 0
       @signature_handler = {
         'HMAC-SHA1' => method(:sign_hmac_sha1)
       }
-      @scheme = "OAuth"
-    end
-
-    # Resets challenge state.  Do not send '*Authorization' header until the
-    # server sends '*Authentication' again.
-    def reset_challenge
-      @challengeable.clear
     end
 
     # Set authentication credential.
@@ -759,31 +766,28 @@ class HTTPClient
       # not supported
     end
 
-    # have we marked this as set - ie that it's valid to use in this context?
+    # Check always (not effective but it works)
     def set?
-      true
+      !@challenge.empty?
     end
 
     # Set authentication credential.
     def set_config(uri, config)
-      if uri.nil?
-        @config = config
-      else
-        uri = Util.uri_dirname(urify(uri))
-        @auth[uri] = config
+      synchronize do
+        if uri.nil?
+          @config = config
+        else
+          uri = Util.uri_dirname(urify(uri))
+          @auth[uri] = config
+        end
       end
     end
 
     # Get authentication credential.
     def get_config(uri = nil)
-      if uri.nil?
-        @config
-      else
-        uri = urify(uri)
-        Util.hash_find_value(@auth) { |cand_uri, cred|
-          Util.uri_part_of(uri, cand_uri)
-        }
-      end
+      synchronize {
+        do_get_config(uri)
+      }
     end
 
     # Response handler: returns credential.
@@ -792,33 +796,54 @@ class HTTPClient
     # * child page of defined credential
     def get(req)
       target_uri = req.header.request_uri
-      return nil unless @challengeable[nil] or @challengeable.find { |uri, ok|
-        Util.uri_part_of(target_uri, uri) and ok
+      synchronize {
+        return nil unless @challenge[nil] or @challenge.find { |uri, ok|
+          Util.uri_part_of(target_uri, uri) and ok
+        }
+        config = do_get_config(target_uri) || @config
+        return nil unless config
+        calc_cred(req, config)
       }
-      config = get_config(target_uri) || @config
-      return nil unless config
-      calc_cred(req, config)
     end
 
     # Challenge handler: remember URL for response.
+    #
+    # challenge() in OAuth handler always returns false to avoid connection
+    # retry which should not work in OAuth authentication context.  This
+    # method just remember URL (nil means 'any') for the next connection.
+    # Normally OAuthClient handles this correctly but see how it uses when
+    # you need to use this class directly.
     def challenge(uri, param_str = nil)
+      synchronize {
+        if uri.nil?
+          @challenge[nil] = true
+        else
+          @challenge[urify(uri)] = true
+        end
+        false
+      }
+    end
+
+  private
+
+    def do_get_config(uri = nil)
       if uri.nil?
-        @challengeable[nil] = true
+        @config
       else
-        @challengeable[urify(uri)] = true
+        uri = urify(uri)
+        Util.hash_find_value(@auth) { |cand_uri, cred|
+          Util.uri_part_of(uri, cand_uri)
+        }
       end
-      true
     end
 
-  private
-
     def calc_cred(req, config)
       header = {}
       header['oauth_consumer_key'] = config.consumer_key
-      header['oauth_token'] = config.token
       header['oauth_signature_method'] = config.signature_method
       header['oauth_timestamp'] = config.debug_timestamp || Time.now.to_i.to_s
       header['oauth_nonce'] = config.debug_nonce || generate_nonce()
+      header['oauth_token'] = config.token if config.token
       header['oauth_version'] = config.version if config.version
       header['oauth_callback'] = config.callback if config.callback
       header['oauth_verifier'] = config.verifier if config.verifier