class HTTPClient::BasicAuth
Authentication filter for handling BasicAuth negotiation. Used in WWWAuth and ProxyAuth.
Attributes
force_auth[RW]
Send Authorization Header without receiving 401
Public Class Methods
new()
click to toggle source
Creates new BasicAuth filter.
Calls superclass method
HTTPClient::AuthBase.new
# File lib/httpclient/auth.rb, line 255 def initialize super('Basic') @cred = nil @auth = {} @force_auth = false end
Public Instance Methods
challenge(uri, param_str = nil)
click to toggle source
Challenge handler: remember URL for response.
# File lib/httpclient/auth.rb, line 298 def challenge(uri, param_str = nil) synchronize { @challenge[urify(uri)] = true true } end
get(req)
click to toggle source
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
# File lib/httpclient/auth.rb, line 284 def get(req) target_uri = req.header.request_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
set(uri, user, passwd)
click to toggle source
Set authentication credential. uri == nil for generic purpose (allow to use user/password for any URL).
# File lib/httpclient/auth.rb, line 264 def set(uri, user, passwd) 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
set?()
click to toggle source
have we marked this as set - ie that it's valid to use in this context?
# File lib/httpclient/auth.rb, line 276 def set? @cred || @auth.any? end