Extensions to Salted Challenge Response (SCRAM) for 2 factor authentication

SCRAM is a password based SASL authentication mechanism that provides (among other things) mutual authentication and binding to an external security layer such as TLS. Two-factor authentication (2FA) is a way to add additional security to an authentication exchange. The first "factor" is a password. The second "factor" is a verification code retrieved from an application on a mobile device or computer. 2FA is conceptually similar to a security token device that banks in some countries require for online banking. Some examples of 2FA systems are OTP (one-time password) and TOTP (Time-based One-time Password algorithm, such as ). This specification describes an extension to SCRAM to provide 2 factor authentication. SCRAM already relies on passwords for authentication. This document specifies how second "factors" can be incorporated into SCRAM authentication. It also includes a separate (but frequently used together with the 2 factor authentication) extension for quick reauthentication.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 when, and only when, they appear in all capitals, as shown here. Formal syntax is defined by including the core rules defined in Appendix B of . Example lines prefaced by "C:" are sent by the client and ones prefaced by "S:" by the server. If a single "C:" or "S:" label applies to multiple lines, then the line breaks between those lines are for editorial clarity only, and are not part of the actual protocol exchange.

This document uses several terms defined in ("Internet Security Glossary") including the following: authentication, authentication exchange, authentication information, brute force, challenge-response, cryptographic hash function, dictionary attack, eavesdropping, hash result, keyed hash, man-in-the-middle, nonce, one-way encryption function, password, replay attack and salt. Readers not familiar with these terms should use that glossary as a reference. Other terms defined in are also used in this document.

This extension doesn't add any extra roundtrips to SCRAM authentication. SCRAM was designed to be extensible, so it allows for optional and mandatory attributes, which covered by MAC codes. Second "factors" are conveyed in the second message ("client-final-message-without-proof" ABNF production) sent from the client to the server. This extension doesn't change how the client authenticates the server. This extension also doesn't cover enrollment with a 2FA system, such enrollment happends out-of-band. The server authenticates the client after receiving the second message as described in Section 3 of . If the client included "type" and "second-factor" attributes defined in this document (see ) and the server supports the specified second factor type, the server verifies content of the "second-factor" according to the "type". If the second factor verification fails, the server MUST fail authentication and SHOULD return either "replayed-second-factor" or "invalid-second-factor" error in the "e" attribute. [[It would be possible to make the extra attributes mandatory by using SCRAM's "m=", but the text above doesn't do that. This is one of open issues to resolve.]]

This reauthentication extension to SCRAM allows the server to return a token that can be used for quick reauthentication and bypasses 2 factor authentication prompt to the user. The reauthentication token is a randomly generated value . The reauthentication token is returned in the "o" attribute that is appended to the end of the "server-final-message". [[Note: it would be possible to extend SCRAM itself to do reauthentication, by including an earlier received reauthentication token in the "client-first-message" of a subsequent SCRAM authentication. This will also turn off the server checking for 2 factor authentication information, unless the reauthentication attempt is rejected by the server. In the meantime, this document presents a couple of other alternatives on how to use other SASL mechanisms with the reauthentication token.]] When the HT-* mechanism is used for the reauthentication after a successful SCRAM authentication, the reauthentication token is the SASL-HT token (see ). [[Note that the HT hash should probably match the SCRAM hash used or "be better".]]

This document defines the following new SCRAM attributes: t: This attribute specifies the type of second factor. This document defines two possible types: "totp" (see ) and "ctap1" (see ). If this attribute is specified, the "f" attribute MUST also be specified. f: This attribute specifies the value of the second factor. For "t=totp" it is 6 digit decimal number. [[Use 8 digits per Rick van Rein?]] This attribute MUST be ignored unless the "t" attribute is also specified. l: This attribute is used by some second factors (e.g. CTAP1) to specify the challenge returned by the SCRAM server. o: This attribute specifies the base64-encoded value of the reauthentication token. The following syntax specification uses the Augmented Backus-Naur Form (ABNF) notation as specified in .

reauth-token = "o=" base64 ; base64 encoding of reauthentication ; token. ; Returned in server-final-message. ]]>

When TOTP is used with SCRAM, the following values for "t" and "f" attributes (see for their generic syntax) are used: t: This attribute specifies the type of second factor. For TOTP the value is "totp". If this attribute is specified, the "f" attribute MUST also be specified. f: This attribute specifies the value of the second factor. For "t=totp" it is 6 digit decimal number. This attribute MUST be ignored unless the "t" attribute is also specified. A TOTP URI is specified with the following ABNF:

The following example extends the example from Section 5 of to demonstrate use of TOTP:

Please note that TOTP extension described in this document works in the same way with SCRAM-SHA-256/SCRAM-SHA-256-PLUS, SCRAM-SHA-512/SCRAM-SHA-512-PLUS or any other SCRAM variants that use other hash functions.

Note that this section describes steps to achieve Client-to-Authenticator Protocols v1 (CTAP1)/U2F 2FA in terms of CTAP2 API. When FIDO CTAP1/U2F is used with SCRAM, the following values for "t", "l" and "f" attributes (see for their generic syntax) are used: t: This attribute specifies the type of second factor. For FIDO CTAP1/U2F the value is "ctap1". If this attribute is specified, the "f" attribute MUST also be specified. l: base64-encoded challenge as returned by SCRAM server. f: This attribute specifies the value of the second factor. For "t=ctap1" it is the CBOR-serialized value of authenticatorGetAssertionResponse map described below. This attribute MUST be ignored unless the "t" attribute is also specified. SCRAM client sends U2F_AUTHENTICATE command formatted as specified in to the authenticator (e.g. a USB or NFC device). The "P1" framing parameter to U2F_AUTHENTICATE is a single octet parameter defined as follows: If "up" is set to false, set it to 0x08 (dont-enforce-user-presence-and-sign). For USB, set it to 0x07 (check-only). This should prevent call getting blocked on waiting for user input. If response returns success, then call again setting the enforce-user-presence-and-sign. For NFC, set it to 0x03 (enforce-user-presence-and-sign). The tap has already provided the presence and won't block. The "P2" framing parameter to U2F_AUTHENTICATE is a single octet that always has the value 0x00. The "request-data" framing parameter (u2fAuthenticateRequest) to U2F_AUTHENTICATE is constructed as follows: The clientData structure (see Section 5.8.1 of ) is filled in as follows: The "type" field has value "webauthn.get". The "challenge" field contains the base64url encoding of the challenge provided by the Relying Party. This is the value of the "l" attribute described above. (Note, possibly need to base64-decode and base64url-encode.) The "origin" field contains the origin of the SCRAM client in the format specified in , for example "smtp://client.example.net:587". Other fields are specified in Section 5.8.1 of . Use clientDataHash parameter of request as CTAP1/U2F challenge parameter (32 bytes). Let rpIdHash be a byte string of size 32 initialized with SHA-256 hash of rp.id parameter as CTAP1/U2F application parameter (32 bytes). (The rp.id parameter is the hostname of the SCRAM server.) Let credentialId is the byte string initialized with the id for this PublicKeyCredentialDescriptor. Let keyHandleLength be a byte initialized with length of credentialId byte string. Let u2fAuthenticateRequest be a byte string with the following structure: Length (in bytes) Description Value 32 Challenge parameter Initialized with clientDataHash parameter bytes. 32 Application parameter Initialized with rpIdHash bytes. 1 Key handle length Initialized with keyHandleLength's value. keyHandleLength Key handle Initialized with credentialId bytes. Generate authenticatorData from the U2F authentication response message received from the authenticator: Copy bits 0 (the UP bit) and bit 1 from the CTAP2/U2F response user presence byte to bits 0 and 1 of the CTAP2 flags, respectively. Set all other bits of flags to zero. Note: bit zero is the least significant bit. See also Authenticator Data section of . Let signCount be a 4-byte unsigned integer initialized with CTAP1/U2F response counter field. Let authenticatorData is a byte string of following structure: Length (in bytes) Description Value 32 SHA-256 hash of the rp.id. Initialized with rpIdHash bytes. 1 Flags Initialized with flags' value. 4 Signature counter (signCount) Initialized with signCount bytes. Let authenticatorGetAssertionResponse be a CBOR map with the following keys whose values are as follows: Set 0x01 with the credential from allowList that whose response succeeded. Set 0x02 with authenticatorData bytes. Set 0x03 with signature field from CTAP1/U2F authentication response message. Note: An ASN.1-encoded ECDSA signature value ranges over 8-72 bytes in length.

Simon Josefsson: should this be a new SASL mechanism name, e.g. CROTP-SHA-XXX? Should we pick between TOTP and FIDO2 (CTAP1)? Rick van Rein: specify a HOTP variant as well? Rick van Rein: use TOTP with 6 or 8 digits? Register both variants?

An OTP value is a sensitive piece of data and thus should only be sent over a secure channel (such as TLS). Otherwise an attacker might be able to intercept it and reuse it for authentication to the SCRAM server. TBD

IANA is requested to update the definition of the SASL family SCRAM in the SASL Mechanism registry established by to also point to this document. IANA is also requested to create a new subregistry of "SASL mechanism" for registering second factor schemes used in the "t" attribute as specified in this document. The registration template is as follows:

The registration procedure for the above subregistry is Expert Review. IANA is requested to register a new value in the subregistry defined above:

Thank you to Stephen Farrell for motivating creation of this document and to Dave Cridland for describing how TOTP can be used with XMPP in XEP-0400. Thank you to Rick van Rein, Simon Josefsson and Ludovic Bocquet for comments and corrections, but all final errors in this document remain mine.