Class: Net::IMAP::SASL::ScramAuthenticator

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses: ScramSHA1Authenticator, ScramSHA256Authenticator
Super Chains via Extension / Inclusion / Inheritance
Instance Chain: self, `ScramAlgorithm`, `GS2Header`
Inherits:	Object
Defined in:	lib/net/imap/sasl/scram_authenticator.rb

Overview

Abstract base class for the “SCRAM-*” family of ::Net::IMAP::SASL mechanisms, defined in RFC5802. Use via Net::IMAP#authenticate.

Directly supported:

SCRAM-SHA-1 — ScramSHA1Authenticator
SCRAM-SHA-256 — ScramSHA256Authenticator

New SCRAM-* mechanisms can easily be added for any hash algorithm supported by OpenSSL::Digest. Subclasses need only set an appropriate DIGEST_NAME constant.

SCRAM algorithm

See the documentation and method definitions on ScramAlgorithm for an overview of the algorithm. The different mechanisms differ only by which hash function that is used (or by support for channel binding with -PLUS).

Server messages

As server messages are received, they are validated and loaded into the various attributes, e.g: #snonce, #salt, #iterations, #verifier, #server_error, etc.

Unlike many other ::Net::IMAP::SASL mechanisms, the SCRAM-* family supports mutual authentication and can return server error data in the server messages. If #process raises an Error for the server-final-message, then server_error may contain error details.

TLS Channel binding

The SCRAM-*-PLUS mechanisms and channel binding are not supported yet.

Caching SCRAM secrets

Caching of salted_password, client_key, stored_key, and server_key is not supported yet.

Constant Summary

`GS2Header` - Included

NO_NULL_CHARS, RFC5801_SASLNAME

Class Method Summary

.new(username, password, **options) ⇒ auth_ctx constructor

Creates an authenticator for one of the “SCRAM-*” ::Net::IMAP::SASL mechanisms.

Instance Attribute Summary

#authcid readonly

Alias for #username.
#authzid readonly

Authorization identity: an identity to act as or on behalf of.
#cnonce readonly

The client nonce, generated by SecureRandom.
#done? ⇒ Boolean readonly

Is the authentication exchange complete?
#iterations readonly

The iteration count for the selected hash function and user.
#min_iterations readonly

The minimal allowed iteration count.
#password (also: #secret) readonly

A password or passphrase that matches the #username.
#salt readonly

The salt used by the server for this user.
#secret readonly

Alias for #password.
#server_error readonly

An error reported by the server during the SASL exchange.
#snonce readonly

The server nonce, which must start with #cnonce
#username (also: #authcid) readonly

Authentication identity: the identity that matches the #password.
#server_first_message readonly private

Need to store this for auth_message.

Instance Method Summary

#digest

Returns a new OpenSSL::Digest object, set to the appropriate hash function for the chosen mechanism.
#initial_client_response

See RFC5802 §7 client-first-message.
#process(challenge)

responds to the server’s challenges.
#cbind_input private

Alias for GS2Header#gs2_header.
#client_final_message_without_proof private

See RFC5802 §7 client-final-message-without-proof.
#client_first_message_bare private

See RFC5802 §7 client-first-message-bare.
#final_message_with_proof private

See RFC5802 §7 client-final-message.
#format_message(hash) private
#parse_challenge(challenge) private

RFC5802 specifies “that the order of attributes in client or server messages is fixed, with the exception of extension attributes”, but this parses it simply as a hash, without respect to order.
#recv_server_final_message(server_final_message) private
#recv_server_first_message(server_first_message) private

`ScramAlgorithm` - Included

#auth_message, #client_key, #client_proof, #client_signature, #H, #Hi, #HMAC, #Normalize, #salted_password, #server_key, #server_signature, #stored_key, #XOR

`GS2Header` - Included

#gs2_authzid	The RFC5801 §4 `gs2-authzid` header, when #authzid is not empty.
#gs2_cb_flag	The RFC5801 §4 `gs2-cb-flag`:
#gs2_header	The RFC5801 §4 `gs2-header`, which prefixes the #initial_client_response.
#gs2_saslname_encode	Encodes `str` to match RFC5801_SASLNAME.

Constructor Details

.new(username, password, options) ⇒ `auth_ctx` .new(username:, password:, options) ⇒ `auth_ctx` .new(authcid:, password:, **options) ⇒ `auth_ctx`

Creates an authenticator for one of the “SCRAM-*” ::Net::IMAP::SASL mechanisms. Each subclass defines #digest to match a specific mechanism.

Called by Net::IMAP#authenticate and similar methods on other clients.

Parameters

#authcid ― Identity whose #password is used.

#username - An alias for #authcid.
#password ― Password or passphrase associated with this #username.
optional #authzid ― Alternate identity to act as or on behalf of.
optional #min_iterations - Overrides the default value (4096).

Any other keyword parameters are quietly ignored.

[ GitHub ]

# File 'lib/net/imap/sasl/scram_authenticator.rb', line 80


def initialize(username_arg = nil, password_arg = nil,
               authcid: nil, username: nil,
               authzid: nil,
               password: nil, secret: nil,
               min_iterations: 4096, # see both RFC5802 and RFC7677
               cnonce: nil, # must only be set in tests
               **options)
  @username = username || username_arg || authcid or
    raise ArgumentError, "missing username (authcid)"
  @password = password || secret || password_arg or
    raise ArgumentError, "missing password"
  @authzid = authzid

  @min_iterations = Integer min_iterations
  @min_iterations.positive? or
    raise ArgumentError, "min_iterations must be positive"

  @cnonce = cnonce || SecureRandom.base64(32)
end

Instance Attribute Details

#authcid (readonly)

Alias for #username.

[ GitHub ]

# File 'lib/net/imap/sasl/scram_authenticator.rb', line 108


alias authcid username

#authzid (readonly)

Authorization identity: an identity to act as or on behalf of. The identity form is application protocol specific. If not provided or left blank, the server derives an authorization identity from the authentication identity. For example, an administrator or superuser might take on another role:

imap.authenticate "SCRAM-SHA-256", "root", passwd, authzid: "user"

The server is responsible for verifying the client’s credentials and verifying that the identity it associates with the client’s authentication identity is allowed to act as (or on behalf of) the authorization identity.

[ GitHub ]

# File 'lib/net/imap/sasl/scram_authenticator.rb', line 126


attr_reader :authzid

#cnonce (readonly)

The client nonce, generated by SecureRandom

[ GitHub ]

# File 'lib/net/imap/sasl/scram_authenticator.rb', line 133


attr_reader :cnonce

#done? ⇒ `Boolean` (readonly)

Is the authentication exchange complete?

If false, another server continuation is required.

[ GitHub ]

# File 'lib/net/imap/sasl/scram_authenticator.rb', line 185


def done?; @state == :done end

#iterations (readonly)

The iteration count for the selected hash function and user

[ GitHub ]

# File 'lib/net/imap/sasl/scram_authenticator.rb', line 142


attr_reader :iterations

#min_iterations (readonly)

The minimal allowed iteration count. Lower #iterations will raise an Error.

[ GitHub ]

# File 'lib/net/imap/sasl/scram_authenticator.rb', line 130


attr_reader :min_iterations

#password (readonly) Also known as: #secret

A password or passphrase that matches the #username.

[ GitHub ]

# File 'lib/net/imap/sasl/scram_authenticator.rb', line 111


attr_reader :password

#salt (readonly)

The salt used by the server for this user

[ GitHub ]

# File 'lib/net/imap/sasl/scram_authenticator.rb', line 139


attr_reader :salt

#secret (readonly)

Alias for #password.

[ GitHub ]

# File 'lib/net/imap/sasl/scram_authenticator.rb', line 112


alias secret password

#server_error (readonly)

An error reported by the server during the SASL exchange.

Does not include errors reported by the protocol, e.g. ::Net::IMAP::NoResponseError.

[ GitHub ]

# File 'lib/net/imap/sasl/scram_authenticator.rb', line 148


attr_reader :server_error

#server_first_message (readonly, private)

Need to store this for auth_message

[ GitHub ]

# File 'lib/net/imap/sasl/scram_authenticator.rb', line 190


attr_reader :server_first_message

#snonce (readonly)

The server nonce, which must start with #cnonce

[ GitHub ]

# File 'lib/net/imap/sasl/scram_authenticator.rb', line 136


attr_reader :snonce

#username (readonly) Also known as: #authcid

Authentication identity: the identity that matches the #password.

RFC-2831 uses the term username. “Authentication identity” is the generic term used by RFC-4422. RFC-4616 and many later RFCs abbreviate this to #authcid.

[ GitHub ]

# File 'lib/net/imap/sasl/scram_authenticator.rb', line 107


attr_reader :username

Instance Method Details

#cbind_input (private)

Alias for GS2Header#gs2_header.

[ GitHub ]

# File 'lib/net/imap/sasl/scram_authenticator.rb', line 251


alias cbind_input gs2_header

#client_final_message_without_proof (private)

See RFC5802 §7 client-final-message-without-proof.

[ GitHub ]

# File 'lib/net/imap/sasl/scram_authenticator.rb', line 240


def client_final_message_without_proof
  @client_final_message_without_proof ||=
    format_message(c: [cbind_input].pack("m0"), # channel-binding
                   r: snonce)                   # nonce
end

#client_first_message_bare (private)

See RFC5802 §7 client-first-message-bare.

[ GitHub ]

# File 'lib/net/imap/sasl/scram_authenticator.rb', line 225


def client_first_message_bare
  @client_first_message_bare ||=
    format_message(n: gs2_saslname_encode(SASL.saslprep(username)),
                   r: cnonce)
end

#digest

Returns a new OpenSSL::Digest object, set to the appropriate hash function for the chosen mechanism.

The class’s DIGEST_NAME constant must be set to the name of an algorithm supported by OpenSSL::Digest.

[ GitHub ]

# File 'lib/net/imap/sasl/scram_authenticator.rb', line 155


def digest; OpenSSL::Digest.new self.class::DIGEST_NAME end

#final_message_with_proof (private)

See RFC5802 §7 client-final-message.

[ GitHub ]

# File 'lib/net/imap/sasl/scram_authenticator.rb', line 233


def final_message_with_proof
  proof = [client_proof].pack("m0")
  "#{client_final_message_without_proof},p=#{proof}"
end

#format_message(hash) (private)

[ GitHub ]

# File 'lib/net/imap/sasl/scram_authenticator.rb', line 192


def format_message(hash) hash.map { _1.join("=") }.join(",") end

#initial_client_response

See RFC5802 §7 client-first-message.

[ GitHub ]

# File 'lib/net/imap/sasl/scram_authenticator.rb', line 159


def initial_client_response
  "#{gs2_header}#{client_first_message_bare}"
end

#parse_challenge(challenge) (private)

RFC5802 specifies “that the order of attributes in client or server messages is fixed, with the exception of extension attributes”, but this parses it simply as a hash, without respect to order. Note that repeated keys (violating the spec) will use the last value.

[ GitHub ]

# File 'lib/net/imap/sasl/scram_authenticator.rb', line 257


def parse_challenge(challenge)
  challenge.split(/,/).to_h {|pair| pair.split(/=/, 2) }
rescue ArgumentError
  raise Error, "unparsable challenge: %p" % [challenge]
end

#process(challenge)

responds to the server’s challenges

[ GitHub ]

# File 'lib/net/imap/sasl/scram_authenticator.rb', line 164


def process(challenge)
  case (@state ||= :initial_client_response)
  when :initial_client_response
    initial_client_response.tap { @state = :server_first_message }
  when :server_first_message
    recv_server_first_message challenge
    final_message_with_proof.tap { @state = :server_final_message }
  when :server_final_message
    recv_server_final_message challenge
    "".tap { @state = :done }
  else
    raise Error, "server sent after complete, %p" % [challenge]
  end
rescue Exception => ex
  @state = ex
  raise
end

#recv_server_final_message(server_final_message) (private)

[ GitHub ]

# File 'lib/net/imap/sasl/scram_authenticator.rb', line 211


def recv_server_final_message(server_final_message)
  sparams = parse_challenge server_final_message
  @server_error = sparams["e"] and
    raise Error, "server error: %s" % [server_error]
  verifier = sparams["v"].unpack1("m") or
    raise Error, "server did not send verifier"
  verifier == server_signature or
    raise Error, "server verify failed: %p != %p" % [
      server_signature, verifier
    ]
end

#recv_server_first_message(server_first_message) (private)

[ GitHub ]

# File 'lib/net/imap/sasl/scram_authenticator.rb', line 194


def recv_server_first_message(server_first_message)
  @server_first_message = server_first_message
  sparams = parse_challenge server_first_message
  @snonce = sparams["r"] or
    raise Error, "server did not send nonce"
  @salt = sparams["s"]&.unpack1("m") or
    raise Error, "server did not send salt"
  @iterations = sparams["i"]&.then {|i| Integer i } or
    raise Error, "server did not send iteration count"
  min_iterations <= iterations or
    raise Error, "too few iterations: %d" % [iterations]
  mext = sparams["m"] and
    raise Error, "mandatory extension: %p" % [mext]
  snonce.start_with? cnonce or
    raise Error, "invalid server nonce"
end

Class: Net::IMAP::SASL::ScramAuthenticator

Overview

SCRAM algorithm

Server messages

TLS Channel binding

Caching SCRAM secrets

Constant Summary

GS2Header - Included

Class Method Summary

Instance Attribute Summary

Instance Method Summary

ScramAlgorithm - Included

GS2Header - Included

Constructor Details

.new(username, password, **options) ⇒ auth_ctx .new(username:, password:, **options) ⇒ auth_ctx .new(authcid:, password:, **options) ⇒ auth_ctx

Parameters

Instance Attribute Details

#authcid (readonly)

#authzid (readonly)

#cnonce (readonly)

#done? ⇒ Boolean (readonly)

#iterations (readonly)

#min_iterations (readonly)

#password (readonly) Also known as: #secret

#salt (readonly)

#secret (readonly)

#server_error (readonly)

#server_first_message (readonly, private)

#snonce (readonly)

#username (readonly) Also known as: #authcid

Instance Method Details

#cbind_input (private)

#client_final_message_without_proof (private)

#client_first_message_bare (private)

#digest

#final_message_with_proof (private)

#format_message(hash) (private)

#initial_client_response

#parse_challenge(challenge) (private)

#process(challenge)

#recv_server_final_message(server_final_message) (private)

#recv_server_first_message(server_first_message) (private)

`GS2Header` - Included

`ScramAlgorithm` - Included

`GS2Header` - Included

.new(username, password, options) ⇒ `auth_ctx` .new(username:, password:, options) ⇒ `auth_ctx` .new(authcid:, password:, **options) ⇒ `auth_ctx`

#done? ⇒ `Boolean` (readonly)