Class: HTAuth::DigestEntry

Inherits:

Object

• Object
• HTAuth::DigestEntry

show all

Defined in:

lib/htauth/digest_entry.rb

Overview

Instance Attribute Summary (collapse)

• - (Object) digest

  Returns the value of attribute digest.

• - (Object) realm

  Returns the value of attribute realm.

• - (Object) user

  Returns the value of attribute user.

Class Method Summary (collapse)

• + (Object) from_line(line)
• + (Object) is_entry!(line)

  test if a line is an entry, raise InvalidDigestEntry if it is not.

• + (Boolean) is_entry?(line)

  test if a line is an entry and return true or false.

Instance Method Summary (collapse)

• - (Boolean) authenticated?(check_password)
• - (Object) calc_digest(password)
• - (DigestEntry) initialize(user, realm, password = "") constructor

  A new instance of DigestEntry.

• - (Object) key
• - (Object) password=(new_password)
• - (Object) to_s

46
47
48
49
50

# File 'lib/htauth/digest_entry.rb', line 46

def initialize(user, realm, password = "")
  @user     = user
  @realm    = realm
  @digest   = calc_digest(password)
end

12
13
14

# File 'lib/htauth/digest_entry.rb', line 12

def digest
  @digest
end

11
12
13

# File 'lib/htauth/digest_entry.rb', line 11

def realm
  @realm
end

10
11
12

# File 'lib/htauth/digest_entry.rb', line 10

def user
  @user
end

15
16
17
18
19
20

# File 'lib/htauth/digest_entry.rb', line 15

def from_line(line)
  parts = is_entry!(line)
  d = DigestEntry.new(parts[0], parts[1])
  d.digest = parts[2]
  return d
end

26
27
28
29
30
31
32
33

# File 'lib/htauth/digest_entry.rb', line 26

def is_entry!(line)
  raise InvalidDigestEntry, "line commented out" if line =~ /\A#/
    parts = line.strip.split(":")
  raise InvalidDigestEntry, "line must be of the format username:realm:md5checksum" if parts.size != 3
  raise InvalidDigestEntry, "md5 checksum is not 32 characters long" if parts.last.size  != 32
  raise InvalidDigestEntry, "md5 checksum has invalid characters" if parts.last !~ /\A[[:xdigit:]]{32}\Z/
    return parts
end

36
37
38
39
40
41
42
43

# File 'lib/htauth/digest_entry.rb', line 36

def is_entry?(line)
  begin
    is_entry!(line)
    return true
  rescue InvalidDigestEntry
    return false
  end
end

60
61
62
63

# File 'lib/htauth/digest_entry.rb', line 60

def authenticated?(check_password)
  hd = ::Digest::MD5.hexdigest("#{user}:#{realm}:#{check_password}")
  return hd == digest
end

56
57
58

# File 'lib/htauth/digest_entry.rb', line 56

def calc_digest(password)
  ::Digest::MD5.hexdigest("#{user}:#{realm}:#{password}")
end

65
66
67

# File 'lib/htauth/digest_entry.rb', line 65

def key
        "#{user}:#{realm}"
end

52
53
54

# File 'lib/htauth/digest_entry.rb', line 52

def password=(new_password)
  @digest = calc_digest(new_password)
end

69
70
71

# File 'lib/htauth/digest_entry.rb', line 69

def to_s
        "#{user}:#{realm}:#{digest}"
end