Class: HTTPClient::OAuth

Inherits:
Object
  • Object
show all
Includes:
Util
Defined in:
lib/httpclient/auth.rb

Overview

Authentication filter for handling OAuth negotiation. Used in WWWAuth.

CAUTION: This impl only support '#7 Accessing Protected Resources' in OAuth Core 1.0 spec for now. You need to obtain Access token and Access secret by yourself.

CAUTION: This impl does NOT support OAuth Request Body Hash spec for now. oauth.googlecode.com/svn/spec/ext/body_hash/1.0/oauth-bodyhash.html

Defined Under Namespace

Classes: Config

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Util

#argument_to_hash, #force_binary, hash_find_value, #https?, #keyword_argument, uri_dirname, uri_part_of, #urify

Constructor Details

#initializeOAuth

Creates new DigestAuth filter.



671
672
673
674
675
676
677
678
679
680
# File 'lib/httpclient/auth.rb', line 671

def initialize
  @config = nil # common config
  @auth = {} # configs for each site
  @challengeable = {}
  @nonce_count = 0
  @signature_handler = {
    'HMAC-SHA1' => method(:sign_hmac_sha1)
  }
  @scheme = "OAuth"
end

Instance Attribute Details

#schemeObject (readonly)

Authentication scheme.



601
602
603
# File 'lib/httpclient/auth.rb', line 601

def scheme
  @scheme
end

Class Method Details

.escape(str) ⇒ Object

:nodoc:



654
655
656
657
658
659
660
661
662
663
664
# File 'lib/httpclient/auth.rb', line 654

def self.escape(str) # :nodoc:
  if str.respond_to?(:force_encoding)
    str.dup.force_encoding('BINARY').gsub(/([^a-zA-Z0-9_.~-]+)/) {
      '%' + $1.unpack('H2' * $1.bytesize).join('%').upcase
    }
  else
    str.gsub(/([^a-zA-Z0-9_.~-]+)/n) {
      '%' + $1.unpack('H2' * $1.bytesize).join('%').upcase
    }
  end
end

Instance Method Details

#challenge(uri, param_str = nil) ⇒ Object

Challenge handler: remember URL for response.



736
737
738
739
740
741
742
743
# File 'lib/httpclient/auth.rb', line 736

def challenge(uri, param_str = nil)
  if uri.nil?
    @challengeable[nil] = true
  else
    @challengeable[urify(uri)] = true
  end
  true
end

#escape(str) ⇒ Object



666
667
668
# File 'lib/httpclient/auth.rb', line 666

def escape(str)
  self.class.escape(str)
end

#get(req) ⇒ Object

Response handler: returns credential. It sends cred only when a given uri is;

  • child page of challengeable(got *Authenticate before) uri and,

  • child page of defined credential



725
726
727
728
729
730
731
732
733
# File 'lib/httpclient/auth.rb', line 725

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
  }
  config = get_config(target_uri) || @config
  return nil unless config
  calc_cred(req, config)
end

#get_config(uri = nil) ⇒ Object

Get authentication credential.



710
711
712
713
714
715
716
717
718
719
# File 'lib/httpclient/auth.rb', line 710

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
end

#reset_challengeObject

Resets challenge state. Do not send '*Authorization' header until the server sends '*Authentication' again.



684
685
686
# File 'lib/httpclient/auth.rb', line 684

def reset_challenge
  @challengeable.clear
end

#set(*args) ⇒ Object

Set authentication credential. You cannot set OAuth config via WWWAuth#set_auth. Use OAuth#config=



690
691
692
# File 'lib/httpclient/auth.rb', line 690

def set(*args)
  # not supported
end

#set?Boolean

have we marked this as set - ie that it's valid to use in this context?



695
696
697
# File 'lib/httpclient/auth.rb', line 695

def set?
  true
end

#set_config(uri, config) ⇒ Object

Set authentication credential.



700
701
702
703
704
705
706
707
# File 'lib/httpclient/auth.rb', line 700

def set_config(uri, config)
  if uri.nil?
    @config = config
  else
    uri = Util.uri_dirname(urify(uri))
    @auth[uri] = config
  end
end