Class: HTTPClient::DigestAuth

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

Overview

Authentication filter for handling DigestAuth negotiation. Used in WWWAuth.

Direct Known Subclasses

ProxyDigestAuth

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ DigestAuth

Creates new DigestAuth filter.



317
318
319
320
321
322
323
 
# File 'lib/httpclient/auth.rb', line 317

def initialize
  @auth = {}
  @challenge = {}
  @set = false
  @nonce_count = 0
  @scheme = "Digest"
end

Instance Attribute Details

#scheme ⇒ Object (readonly)

Authentication scheme.



314
315
316
 
# File 'lib/httpclient/auth.rb', line 314

def scheme
  @scheme
end

Instance Method Details

#challenge(uri, param_str) ⇒ Object

Challenge handler: remember URL and challenge token for response.



364
365
366
367
 
# File 'lib/httpclient/auth.rb', line 364

def challenge(uri, param_str)
  @challenge[uri] = parse_challenge_param(param_str)
  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



350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/httpclient/auth.rb', line 350

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)
  }
  return nil unless user
  calc_cred(req, user, passwd, param)
end

#reset_challenge ⇒ Object

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



327
328
329
 
# File 'lib/httpclient/auth.rb', line 327

def reset_challenge
  @challenge.clear
end

#set(uri, user, passwd) ⇒ Object

Set authentication credential. uri == nil is ignored.



333
334
335
336
337
338
339
 
# File 'lib/httpclient/auth.rb', line 333

def set(uri, user, passwd)
  @set = true
  if uri
    uri = Util.uri_dirname(uri)
    @auth[uri] = [user, passwd]
  end
end

#set? ⇒ Boolean

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

Returns:

  • (Boolean) 


342
343
344
 
# File 'lib/httpclient/auth.rb', line 342

def set?
  @set == true
end