XEP-0034: SASL Integration

2.1 Overview¶

In these examples, "client" refers to the remote entity that initiated the connection, either a Jabber client or a Jabber server. "Server" refers to the server that the remote entity is attempting to connect and authenticate to.

The steps involved for a SASL negotiation are as follows:

1. Client requests SASL authentication
2. Server responds with list of available SASL authentication mechanisms
3. Client selects mechanism
4. Server sends a challenge
5. Client responds to challenge
6. Server sends more challenges, client sends more responses

This series of challenge/response pairs continues until one of three things happens:

1. Client aborts the handshake.
2. Server reports failure.
3. Server reports success.

After authentication has completed, the client sends a packet to begin the session.

The namespace identifier for this protocol is http://www.iana.org/assignments/sasl-mechanisms.

The following examples show the dialogue between a client [C] and a server [S].

2.2 Stream initialization¶

The client begins by requesting SASL authentication as part of the normal Jabber stream negotiation. [2] The server responds by sending the available authentication mechanisms to the client along with the stream information:

C: <stream:stream xmlns='jabber:client'
                  xmlns:stream='http://etherx.jabber.org/streams'
                  xmlns:sasl='http://www.iana.org/assignments/sasl-mechanisms'
                  to='jabber.org'>
S: <stream:stream xmlns='jabber:client'
                  xmlns:stream='http://etherx.jabber.org/streams'
                  xmlns:sasl='http://www.iana.org/assignments/sasl-mechanisms'
                  id='12345678'>
   <sasl:mechanisms>
     <sasl:mechanism>PLAIN</sasl:mechanism>
     <sasl:mechanism>DIGEST-MD5</sasl:mechanism>
     <sasl:mechanism>EXTERNAL</sasl:mechanism>
   <sasl:mechanisms>
    

2.3 Mechanism selection and handshake¶

Next, the client selects an authentication mechanism:

C: <sasl:auth mechanism='PLAIN'/>
    

The server responds with a mechanism-specific challenge, which the client must respond to. More than one challenge/response pair can take place; this is mechanism-specific.

Challenges and responses are Base64 [3] encoded.

S: <sasl:challenge/>
C: <sasl:response>cm9iAHNlY3JldA==</sasl:response>
    

S: <sasl:challenge>
     cmVhbG09ImNhdGFjbHlzbS5jeCIsbm9uY2U9Ik9BNk1HOXRFUUdtMmhoIi
     xxb3A9ImF1dGgiLGNoYXJzZXQ9dXRmLTgsYWxnb3JpdGhtPW1kNS1zZXNz
   </sasl:challenge>
C: <sasl:response>
     dXNlcm5hbWU9InJvYiIscmVhbG09ImNhdGFjbHlzbS5jeCIsbm9uY2U9Ik
     9BNk1HOXRFUUdtMmhoIixjbm9uY2U9Ik9BNk1IWGg2VnFUclJrIixuYz0w
     MDAwMDAwMSxxb3A9YXV0aCxkaWdlc3QtdXJpPSJqYWJiZXIvY2F0YWNseX
     NtLmN4IixyZXNwb25zZT1kMzg4ZGFkOTBkNGJiZDc2MGExNTIzMjFmMjE0
     M2FmNyxjaGFyc2V0PXV0Zi04
   </sasl:response>
S: <sasl:challenge>
     cnNwYXV0aD1lYTQwZjYwMzM1YzQyN2I1NTI3Yjg0ZGJhYmNkZmZmZA==
   </sasl:challenge>
C: <sasl:response/>
    

For mechanisms that require the client to send data first (ie the first challenge from the server is empty), the client may optionally send its first response as part of the mechanism selection:

C: <sasl:auth mechanism='PLAIN'>cm9iAHNlY3JldA==</sasl:auth>
    

2.4 Success, failure and client abort¶

The handshake continues until authentication completes successfully, authentication fails, or the client aborts the handshake:

S: <sasl:success/>
    

S: <sasl:failure/>
    

C: <sasl:abort/>
    

Optionally, the server or client may send an informative message along with the success, failure or abort command:

S: <sasl:failure>Plaintext authentication failed (Incorrect username or password)</sasl:failure>
    

Following a failure or client abort, the client may start a new handshake. Following a successful authentication, any further attempts by the client to begin a new authentication handshake will automatically result in the server sending a failure.

2.5 Session start¶

Note: that this section only applies to client-to-server connections.

Following successful authentication, the client must send a standard IQ set packet in the jabber:iq:auth namespace to start a session. The client must supply a username and resource for the session along with this packet.

C: <iq id="a1" type="get">
     <query xmlns="jabber:iq:auth">
       <username>rob</username>
     </query>
   </iq>
S: <iq id="a1" type="result">
     <query xmlns="jabber:iq:auth">
       <username>rob</username>
       <resource/>
     </query>
   </iq>
C: <iq id="a2" type="set">
     <query xmlns="jabber:iq:auth">
       <username>rob</username>
       <resource>laptop</resource>
     </query>
   </iq>
S: <iq id="a2" type="result">
     <query xmlns="jabber:iq:auth"/>
   </iq>
    

If the client attempts to start a session before authenticating, or the username given in the jabber:iq:auth packet does not match the username given in the authentication credentials (when the SASL mechanism supports it), the server will return a 401 (Unauthorized) error packet.

3.1 Legacy client-to-server authentication support¶

Until SASL authentication is in widespread use, clients and servers may support both SASL and the legacy jabber:iq:auth authentication system for client-to-server connections. Note that neither the client nor the server are required to support legacy authentication; it is simply a courtesy to users until the majority of clients and servers support SASL authentication.

If a client connects and does not request the use of SASL (that is, the SASL profile namespace identifier does not appear in the stream initializer response), then the server should disable SASL for this connection; that is, it should not add the SASL profile namespace identifier to the stream initialization response, nor should it offer any SASL mechanisms.

If a client connects to a server that does not support SASL (identified by the lack of the SASL profile namespace identifier in the stream initializer response, even though the client requested it), the client may choose to fall back to use legacy authentication.

3.2 Dialback support for server-to-server authentication¶

SASL authentication for server-to-server connections is not intended to replace dialback, as there are uses for both. Dialback is useful in an uncontrolled environment, such as the global Internet, where it is necessary to verify the identity of the remote server. SASL authentication has uses in a more controlled environment, where the administrator wishes to restrict access to a certain number of known remote servers.

To this end, the use of dialback is not deprecated. If a remote server connects and requests the use of dialback (by specifying the "jabber:server:dialback" namespace, the the local server shall not offer SASL authentication. Similarly, if the remote server connects and requests the use of SASL authentication, then the local server shall not offer dialback. In the event that the remote server requests both, the local server should terminate the stream immediately and close the connection. If the remote server requests neither, then the local server may choose to support the pre-dialback server-to-server stream, but it is recommended that the local server terminate the stream and close the connection.

Copyright

This XMPP Extension Protocol is copyright © 1999 – 2024 by the XMPP Standards Foundation (XSF).

Permissions

Permission is hereby granted, free of charge, to any person obtaining a copy of this specification (the "Specification"), to make use of the Specification without restriction, including without limitation the rights to implement the Specification in a software program, deploy the Specification in a network service, and copy, modify, merge, publish, translate, distribute, sublicense, or sell copies of the Specification, and to permit persons to whom the Specification is furnished to do so, subject to the condition that the foregoing copyright notice and this permission notice shall be included in all copies or substantial portions of the Specification. Unless separate permission is granted, modified works that are redistributed shall not contain misleading information regarding the authors, title, number, or publisher of the Specification, and shall not claim endorsement of the modified works by the authors, any organization or project to which the authors belong, or the XMPP Standards Foundation.

Disclaimer of Warranty

## NOTE WELL: This Specification is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. ##

Limitation of Liability

In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall the XMPP Standards Foundation or any author of this Specification be liable for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if the XMPP Standards Foundation or such author has been advised of the possibility of such damages.

IPR Conformance

This XMPP Extension Protocol has been contributed in full conformance with the XSF's Intellectual Property Rights Policy (a copy of which can be found at <https://xmpp.org/about/xsf/ipr-policy> or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA).

Visual Presentation

The HTML representation (you are looking at) is maintained by the XSF. It is based on the YAML CSS Framework, which is licensed under the terms of the CC-BY-SA 2.0 license.

1. RFC 4422: Simple Authentication and Security Layer (SASL) <http://tools.ietf.org/html/rfc4422>.

2. In the case of the remote entity being a server, the default namespace in the stream header will be "jabber:server".

3. RFC 2045, section 6.8.