Class: Net::IMAP::SASL::CramMD5Authenticator

Inherits:
Object
  • Object
show all
Defined in:
lib/net/imap/sasl/cram_md5_authenticator.rb

Overview

Authenticator for the “CRAM-MD5” SASL mechanism, specified in RFC2195. See Net::IMAP#authenticate.

Deprecated

CRAM-MD5 is obsolete and insecure. It is included for compatibility with existing servers. draft-ietf-sasl-crammd5-to-historic recommends using SCRAM-* or PLAIN protected by TLS instead.

Additionally, RFC8314 discourage the use of cleartext and recommends TLS version 1.2 or greater be used for all traffic. With TLS CRAM-MD5 is okay, but so is PLAIN

Instance Method Summary collapse

Constructor Details

#initialize(user = nil, pass = nil, authcid: nil, username: nil, password: nil, secret: nil, warn_deprecation: true) ⇒ CramMD5Authenticator

Returns a new instance of CramMD5Authenticator.



17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/net/imap/sasl/cram_md5_authenticator.rb', line 17

def initialize(user = nil, pass = nil,
               authcid: nil, username: nil,
               password: nil, secret: nil,
               warn_deprecation: true,
               **)
  if warn_deprecation
    warn "WARNING: CRAM-MD5 mechanism is deprecated." # TODO: recommend SCRAM
  end
  require "digest/md5"
  @user = authcid || username || user
  @password = password || secret || pass
  @done = false
end

Instance Method Details

#done? ⇒ Boolean

Returns:

  • (Boolean) 


40
 
# File 'lib/net/imap/sasl/cram_md5_authenticator.rb', line 40

def done?; @done end

#initial_response? ⇒ Boolean

Returns:

  • (Boolean) 


31
 
# File 'lib/net/imap/sasl/cram_md5_authenticator.rb', line 31

def initial_response?; false end

#process(challenge) ⇒ Object 



33
34
35
36
37
38
 
# File 'lib/net/imap/sasl/cram_md5_authenticator.rb', line 33

def process(challenge)
  digest = hmac_md5(challenge, @password)
  return @user + " " + digest
ensure
  @done = true
end