Class: HTTPClient::BasicAuth

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

Overview

Authentication filter for handling BasicAuth negotiation. Used in WWWAuth and ProxyAuth.

Direct Known Subclasses

ProxyBasicAuth

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Util

#argument_to_hash, hash_find_value, #http?, #https?, #keyword_argument, try_require, uri_dirname, uri_part_of, urify

Constructor Details

#initialize ⇒ BasicAuth

Creates new BasicAuth filter.



224
225
226
227
228
229
230
231
 
# File 'lib/httpclient/auth.rb', line 224

def initialize
  super
  @cred = nil
  @auth = {}
  @challenge = {}
  @scheme = "Basic"
  @force_auth = false
end

Instance Attribute Details

#force_auth ⇒ Object

Send Authorization Header without receiving 401



221
222
223
 
# File 'lib/httpclient/auth.rb', line 221

def force_auth
  @force_auth
end

#scheme ⇒ Object (readonly)

Authentication scheme.



218
219
220
 
# File 'lib/httpclient/auth.rb', line 218

def scheme
  @scheme
end

Instance Method Details

#challenge(uri, param_str = nil) ⇒ Object

Challenge handler: remember URL for response.



277
278
279
280
281
282
 
# File 'lib/httpclient/auth.rb', line 277

def challenge(uri, param_str = nil)
  synchronize {
    @challenge[urify(uri)] = true
    true
  }
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



263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/httpclient/auth.rb', line 263

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

#reset_challenge ⇒ Object

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



235
236
237
238
239
 
# File 'lib/httpclient/auth.rb', line 235

def reset_challenge
  synchronize {
    @challenge.clear
  }
end

#set(uri, user, passwd) ⇒ Object

Set authentication credential. uri == nil for generic purpose (allow to use user/password for any URL).



243
244
245
246
247
248
249
250
251
252
 
# File 'lib/httpclient/auth.rb', line 243

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? ⇒ Boolean

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

Returns:

  • (Boolean) 


255
256
257
 
# File 'lib/httpclient/auth.rb', line 255

def set?
  @cred || @auth.any?
end