XEP-0175: Best Practices for Use of SASL ANONYMOUS

1. Introduction¶

XMPP Core [1] allows XMPP server implementations to support any SASL mechanism (see RFC 4422 [2]) when authenticating clients. This document provides recommendations regarding use of the SASL ANONYMOUS mechanism (see RFC 4505 [3]) in XMPP systems.

2. Deployment Types¶

XMPP server implementations can be deployed in a variety of settings. Although it is difficult to provide recommendations for every kind of XMPP deployment, this document attempts to strike a balance between more and less controlled settings by defining three different deployment types:

• Public deployments, such as well-known instant messaging (IM) services on the open Internet.
• Private deployments, such as enterprise IM services, technical support departments, and helplines.
• Specialized deployments that typically will be accessed in a controlled fashion, such as gaming services, members-only websites, and applications that are not used directly by human users.

3. Recommendations¶

An XMPP server implementation SHOULD NOT enable the SASL ANONYMOUS mechanism by default, but instead SHOULD force the administrator of a given service to explicitly enable support in the context of that deployment.

When a client authenticates using SASL ANONYMOUS, an XMPP server SHOULD assign a temporary, unique bare JID <localpart@domain.tld> to the client. Although the method for ensuring the uniqueness of the localpart is a matter of implementation, it is RECOMMENDED for the localpart to be a UUID as specified in RFC 4122 [4].

Although RFC 4505 [3] allows the client to provide so-called "trace data" when authenticating via SASL ANONYMOUS, it is NOT RECOMMENDED for the client to include trace data as the XML character data of the <auth/> element (instead, the <auth/> element SHOULD be empty). However, if trace data is included, the server MUST NOT use it for any purpose other than tracing (e.g., not use it as the resource identifier of the anonymous user's full JID).

Because an anonymous user is unknown to the server, the server SHOULD appropriately restrict the user's access in order to limit the possibility of malicious behavior (such as denial of service attacks as described in Best Practices to Discourage Denial of Service Attacks (XEP-0205) [5]), especially on public deployments. The following restrictions are encouraged on public deployments. Administrators of private deployments and specialized deployments are advised to take these restrictions into account when configuring their services, but can reasonably relax these restrictions if they have appropriate access controls in place or their deployment requirements cannot be met using the more restrictive profile applied in public deployments.

1. During resource binding, the server MAY ignore the resource identifier provided by the client (if any) and instead assign a resource identifier that it generates on behalf of the client.

2. The server SHOULD NOT allow the client to initiate communication with entities hosted at remote servers.

3. The server MAY allow the client to establish relationships with local services and users; such relationships might include presence subscriptions and roster additions (see XMPP IM [6]), Multi-User Chat (XEP-0045) [7] registrations, and Publish-Subscribe (XEP-0060) [8] subscriptions. (Note that allowing presence subscriptions and roster additions can create a sub-optimal user experience for the added contacts.) However, if the server permits such relationships, it MUST cancel them when the client's session ends.

4. The server MAY allow the client to store information on the server for the purpsoe of providing an optimal user experience (e.g., storage of client preferences using Private XML Storage (XEP-0049) [9]). However, if the server allows this, it SHOULD remove such information when the client's session ends.

5. The server SHOULD NOT allow the client to send large numbers of XMPP stanzas or otherwise use large amounts of system resources (e.g., by binding multiple resource identifiers or creating multiple SOCKS5 Bytestreams (XEP-0065) [10] sessions).

4. Protocol Flow¶

The RECOMMENDED protocol flow following TLS negotiation (refer to RFC 3920 [11]) is as follows:

1. Client initiates stream to server.

   <stream:stream
           xmlns:stream='http://etherx.jabber.org/streams'
           xmlns='jabber:client'
           to='example.com'
           version='1.0'>
   

2. Server replies with stream header.

   <stream:stream
           xmlns:stream='http://etherx.jabber.org/streams'
           xmlns='jabber:client'
           id='c2s_234'
           from='example.com'
           version='1.0'>
   

3. Server advertises stream features.

   <stream:features>
     <mechanisms xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>
       <mechanism>DIGEST-MD5</mechanism>
       <mechanism>ANONYMOUS</mechanism>
     </mechanisms>
   </stream:features>
   

4. Client requests SASL ANONYMOUS mechanism.

   <auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='ANONYMOUS'/>
   

5. Server sends <success/>.

   <success xmlns='urn:ietf:params:xml:ns:xmpp-sasl'/>
   

6. Client opens new stream.

   <stream:stream
           xmlns:stream='http://etherx.jabber.org/streams'
           xmlns='jabber:client'
           to='example.com'
           version='1.0'>
   

7. Server tells client that resource binding is required.

   <stream:stream
           xmlns:stream='http://etherx.jabber.org/streams'
           xmlns='jabber:client'
           id='c2s_345'
           from='example.com'
           version='1.0'>
   <stream:features>
     <bind xmlns='urn:ietf:params:xml:ns:xmpp-bind'/>
   </stream:features>
   

8. Client requests that server create a resource for it.

   <iq type='set' id='bind_1'>
     <bind xmlns='urn:ietf:params:xml:ns:xmpp-bind'/>
   </iq>
   

9. Server replies with full JID.

   <iq type='result' id='bind_1'>
     <bind xmlns='urn:ietf:params:xml:ns:xmpp-bind'>
       <jid>59BEC12A-9BAB-452B-88F8-D1563F09E549@example.com/2384F02A7E01</jid>
     </bind>
   </iq>
   

5. Service Discovery¶

A server MUST reply to a Service Discovery (XEP-0030) [12] information ("disco#info") request sent to the bare JID <localpart@domain.tld> of the user with an identity of "account/anonymous", as shown in the following example.

<iq from='59BEC12A-9BAB-452B-88F8-D1563F09E549@example.com'
    id='kj37vd95'
    to='requester@example.com/foo'
    type='result'>
  <query xmlns='http://jabber.org/protocol/disco#info'>
    <identity category='account' type='anonymous'/>
    <feature var='http://jabber.org/protocol/disco#info'/>
    <feature var='http://jabber.org/protocol/disco#items'/>
  </query>
</iq>

6. Security Considerations¶

The security considerations discussed in RFC 3920 [11] and RFC 4505 apply to the use of SASL ANONYMOUS in XMPP; specific suggestions regarding usage restrictions for anonymous users are provided under the Recommendations section of this document.

7. IANA Considerations¶

This document requires no interaction with the Internet Assigned Numbers Authority (IANA) [13].

8. XMPP Registrar Considerations¶

This document requires no interaction with the XMPP Registrar [14].

9. Acknowledgements¶

Thanks to Dave Cridland, Tuomas Koski, Jack Moffitt, Andy Skelton, and Kurt Zeilenga for their feedback.

Appendices

Appendix A: Document Information¶

Series

XEP

Number

0175

Publisher

XMPP Standards Foundation

Status

Active

Type

Informational

Version

1.2

Last Updated

2009-09-30

Approving Body

XMPP Council

Dependencies

XMPP Core

Supersedes

None

Superseded By

None

Short Name

N/A

Source Control

HTML

This document in other formats: XML  PDF

Appendix B: Author Information¶

Peter Saint-Andre

Email

stpeter@stpeter.im

JabberID

stpeter@jabber.org

URI

https://stpeter.im/

Appendix C: Legal Notices¶

Appendix D: Relation to XMPP¶

The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 6120) and XMPP IM (RFC 6121) specifications contributed by the XMPP Standards Foundation to the Internet Standards Process, which is managed by the Internet Engineering Task Force in accordance with RFC 2026. Any protocol defined in this document has been developed outside the Internet Standards Process and is to be understood as an extension to XMPP rather than as an evolution, development, or modification of XMPP itself.

Appendix E: Discussion Venue¶

The primary venue for discussion of XMPP Extension Protocols is the <standards@xmpp.org> discussion list.

Discussion on other xmpp.org discussion lists might also be appropriate; see <https://xmpp.org/community/> for a complete list.

Errata can be sent to <editor@xmpp.org>.

Appendix F: Requirements Conformance¶

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 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.

Appendix G: Notes¶

Appendix H: Revision History¶

Note: Older versions of this specification might be available at https://xmpp.org/extensions/attic/

1. Version 1.2 (2009-09-30)¶

   Provided more detailed recommendations regarding usage restrictions for anonymous users, including the concept of different deployment types; added note about the account/anonymous service discovery identity.

   psa
2. Version 1.1 (2007-11-07)¶

   Recommended that node identifier be a UUID; recommended that trace data not be included.

   psa
3. Version 1.0 (2006-09-20)¶

   Per a vote of the Jabber Council, advanced status to Active.

   psa
4. Version 0.1 (2006-02-09)¶

   Initial version; modified flow to remove unecessary challenge.

   psa
5. Version 0.0.1 (2006-01-24)¶

   First draft.

   psa

Appendix I: Bib(La)TeX Entry

@report{saint-andre2006n/a,
  title = {Best Practices for Use of SASL ANONYMOUS},
  author = {Saint-Andre, Peter},
  type = {XEP},
  number = {0175},
  version = {1.2},
  institution = {XMPP Standards Foundation},
  url = {https://xmpp.org/extensions/xep-0175.html},
  date = {2006-01-24/2009-09-30},
}

END