XEP-0081: Jabber MIME Type

Abstract:This document specifies a MIME type for launching a Jabber client as a helper application from most modern web browsers, and for completing basic use cases once the client is launched.
Authors:Joe Hildebrand, Peter Saint-Andre
Copyright:© 1999 - 2014 XMPP Standards Foundation. SEE LEGAL NOTICES.
Status:Retracted
Type:Standards Track
Version:0.5
Last Updated:2005-07-19

WARNING: This document has been retracted by the author(s). Implementation of the protocol described herein is not recommended. Developers desiring similar functionality are advised to implement the protocol that supersedes this one (if any).


Table of Contents


1. Introduction
2. Use Cases
    2.1. Sending a Message
    2.2. Starting a Chat
    2.3. Subscribing to Presence
    2.4. Joining a Groupchat Room
    2.5. Registering with a Service
3. Security Considerations
4. IANA Considerations
5. XMPP Registrar Considerations
    5.1. Protocol Namespaces
    5.2. IANA Interaction
6. XML Schema
7. Open Issues

Appendices
    A: Document Information
    B: Author Information
    C: Legal Notices
    D: Relation to XMPP
    E: Discussion Venue
    F: Requirements Conformance
    G: Notes
    H: Revision History


1. Introduction

The value of a URI scheme (see RFC 3986 [1]) for Jabber/XMPP communications has long been recognized within the Jabber community, and such a scheme has been formally defined in RFC 5122 [2] as a way of identifying entities that adhere to XMPP Core [3] or its antecedents. Unfortunately, URI schemes are slow to be accepted on the Internet, such that it might be years (if ever) before widely deployed software such as web browsers will support addresses of the form <xmpp:user@domain>.

Thankfully, it is not necessary for the large existing base of deployed software to support the xmpp: URI scheme in order to integrate Jabber/XMPP support. A well-accepted alternative approach [4] is to define a MIME type (in accordance with RFC 2045 [5]) and then reconfigure the relevant server and client software to correctly handle the new MIME type.

Therefore, this document defines a MIME type of "application/jabber+xml" (in particular, an XML media type in accordance with RFC 3023 [6]). Files of this MIME type would commonly be accessed with a web browser via HTTP, although other access methods are possible (e.g., attachment of the MIME type to an email message). On opening a file of this type, a browser would (by configuration) invoke an appropriate "helper" application (i.e., an external Jabber client, plugin, or internal module) that would enable the user to interact with a Jabber/XMPP server. If the user is not currently connected to a server, the invoked program would be responsible for connecting the user with appropriate prompting for authentication credentials. The file passed to the helper application would define parameters needed to complete a certain use case, such as sending a message to another user.

Note: The "application/jabber+xml" MIME type defined herein is not to be confused with the "application/xmpp+xml" MIME type defined in RFC 3923 [7]; the two MIME types address different requirements and do not overlap or conflict.

2. Use Cases

The solution MUST enable a user to complete the following use cases, support for which is REQUIRED:

In addition, the solution SHOULD enable a user to complete the following use cases, support for which is RECOMMENDED:

These use cases are defined below.

2.1 Sending a Message

In order to send a message to a contact, the user opens an XMPP file of the following form:

<?xml version='1.0' encoding='UTF-8'?>
<jabber>
  <message jid='stpeter@jabber.org'/>
</jabber>
    

The browser passes this file to the helper application, which shall instantiate an appropriate interface for sending a single message to the JID defined in the file. If the user completes the interface, the helper application shall then send a message stanza of type='normal' as specified in XMPP IM [8], first authenticating with the user's Jabber/XMPP server if necessary.

2.2 Starting a Chat

<?xml version='1.0' encoding='UTF-8'?>
<jabber>
  <chat jid='stpeter@jabber.org'/>
</jabber>
    

The browser passes this file to the helper application, which shall instantiate an appropriate interface for chatting with the JID defined in the file. If the user completes the interface, the helper application shall then send a message stanza of type='chat' as specified in XMPP IM, first authenticating with the user's Jabber/XMPP server if necessary.

2.3 Subscribing to Presence

<?xml version='1.0' encoding='UTF-8'?>
<jabber>
  <subscribe jid='stpeter@jabber.org'/>
</jabber>
    

The browser passes this file to the helper application, which shall instantiate an appropriate interface for sending a presence subscription request to the JID defined in the file (e.g., specifying a name and/or group for the contact). If the user completes the interface, the helper application shall then send a presence stanza of type='subscribe' as specified in XMPP IM, first authenticating with the user's Jabber/XMPP server if necessary. The helper application SHOULD perform a "roster set" before sending the presence subscription request, as described in XMPP IM.

2.4 Joining a Groupchat Room

<?xml version='1.0' encoding='UTF-8'?>
<jabber>
  <groupchat jid='jdev@conference.jabber.org'/>
</jabber>
    

The browser passes this file to the helper application, which shall instantiate an appropriate interface for joining the conference room associated with the JID defined in the file. If the user completes the interface, the helper application shall then send a directed presence stanza to the JID (appending a room nickname to the JID as the resource identifier) as described in Multi-User Chat (XEP-0045) [9], first authenticating with the user's Jabber/XMPP server if necessary.

2.5 Registering with a Service

<?xml version='1.0' encoding='UTF-8'?>
<jabber>
  <register jid='headlines.shakespeare.lit'/>
</jabber>
    

The browser passes this file to the helper application, which shall send an IQ stanza of type='get' to the service associated with the JID defined in the file in order to determine the registration requirements (first authenticating with the user's Jabber/XMPP server if necessary), as described in In-Band Registration (XEP-0077) [10]. The helper application shall then instantiate an appropriate interface for registering with the service. If the user completes the interface, the helper application shall then send an IQ stanza of type='set' to the JID as described in XEP-0077.

3. Security Considerations

Detailed security considerations for instant messaging and presence protocols are given in RFC 2779 [11] (Sections 5.1 through 5.4), and for XMPP in particular are given in RFC 3920 (Sections 12.1 through 12.6). In addition, all of the security considerations specified in RFC 3023 apply to the "application/jabber+xml" media type.

When a helper application has finished processing a file of type "application/jabber+xml", it SHOULD discard the file; this helps to prevent security-related problems that may result from HTTP caching.

4. IANA Considerations

This document requires registration of the "application/jabber+xml" content type with the Internet Assigned Numbers Authority (IANA) [12]. The registration is as follows:

To: ietf-types@iana.org

Subject: Registration of MIME media type application/jabber+xml

MIME media type name: application
MIME subtype name: jabber+xml
Required parameters: (none)
Optional parameters: (charset) Same as charset parameter of
   application/xml as specified in RFC 3023; per Section 11.5
   of RFC 3920, the charset must be UTF-8.
Encoding considerations: Same as encoding considerations of
   application/xml as specified in RFC 3023; per Section 11.5
   of RFC 3920, the encoding must be UTF-8.
Security considerations: All of the security considerations 
   specified in RFC 3023 and RFC 3920 apply to this XML media 
   type.  Refer to Section 11 of XSF XEP-0081.
Interoperability considerations: (none)
Specification: XSF XEP-0081
Applications which use this media type: non-XMPP applications
   (e.g., web browsers or email clients) that wish to invoke
   XMPP-compliant applications for instant messaging and 
   presence functionality.
Additional information: This media type is not to be confused 
   with the "application/xmpp+xml" media type, which is for 
   use by native XMPP applications.
Person and email address to contact for further information: 
   XMPP Registrar, <registrar@xmpp.org>
Intended usage: COMMON
Author/Change controller: XSF, XMPP Registrar
  

5. XMPP Registrar Considerations

5.1 Protocol Namespaces

The XMPP Registrar [13] shall include 'http://jabber.org/protocol/mimetype' in its registry of protocol namespaces.

5.2 IANA Interaction

The XMPP Registrar shall interact with the IANA in order to register the media type defined herein.

6. XML Schema

<?xml version='1.0' encoding='UTF-8'?>

<xs:schema
    xmlns:xs='http://www.w3.org/2001/XMLSchema'
    targetNamespace='http://jabber.org/protocol/mimetype'
    xmlns='http://jabber.org/protocol/mimetype'
    elementFormDefault='qualified'>

  <xs:element name='jabber'>
    <xs:complexType>
      <xs:choice>
        <xs:element name='chat' type='JabberAction'/>
        <xs:element name='groupchat' type='JabberAction'/>
        <xs:element name='message' type='JabberAction'/>
        <xs:element name='register' type='JabberAction'/>
        <xs:element name='subscribe' type='JabberAction'/>
      </xs:choice>
    </xs:complexType>
  </xs:element>

  <xs:complexType name='JabberAction'>
    <xs:restriction base='xs:string'>
      <xs:enumeration value=''/>
    </xs:restriction>
    <xs:attribute name='jid' use='required'>
  </xs:complexType>

</xs:schema>
  

7. Open Issues

  1. Add implementation notes for server MIME type registration and HTTP Content-Type output.
  2. Add implementation notes for client handling on various platforms (e.g., DDE messages in Windows).

Appendices


Appendix A: Document Information

Series: XEP
Number: 0081
Publisher: XMPP Standards Foundation
Status: Retracted
Type: Standards Track
Version: 0.5
Last Updated: 2005-07-19
Approving Body: XMPP Council
Dependencies: XMPP Core, XMPP IM, RFC 2045, RFC 3023, XEP-0045, XEP-0077
Supersedes: None
Superseded By: None
Short Name: mimetype
Source Control: HTML
This document in other formats: XML  PDF


Appendix B: Author Information

Joe Hildebrand

Email: jhildebr@cisco.com
JabberID: hildjj@jabber.org

Peter Saint-Andre

Email: stpeter@jabber.org
JabberID: stpeter@jabber.org
URI: https://stpeter.im/


Appendix C: Legal Notices

Copyright

This XMPP Extension Protocol is copyright © 1999 - 2014 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 <http://xmpp.org/about-xmpp/xsf/xsf-ipr-policy/> or obtained by writing to XMPP Standards Foundation, 1899 Wynkoop Street, Suite 600, Denver, CO 80202 USA).

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 <http://xmpp.org/about/discuss.shtml> for a complete list.

Given that this XMPP Extension Protocol normatively references IETF technologies, discussion on the <xsf-ietf@xmpp.org> list might also be appropriate.

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


Appendix F: Requirements Conformance

The following requirements keywords as used in this document are to be interpreted as described in RFC 2119: "MUST", "SHALL", "REQUIRED"; "MUST NOT", "SHALL NOT"; "SHOULD", "RECOMMENDED"; "SHOULD NOT", "NOT RECOMMENDED"; "MAY", "OPTIONAL".


Appendix G: Notes

1. RFC 3986: Uniform Resource Identifiers (URI): Generic Syntax <http://tools.ietf.org/html/rfc3986>.

2. RFC 5122: Internationalized Resource Identifiers (IRIs) and Uniform Resource Identifiers (URIs) for the Extensible Messaging and Presence Protocol (XMPP) <http://tools.ietf.org/html/rfc5122>.

3. RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core <http://tools.ietf.org/html/rfc6120>.

4. See, for instance, <http://www.mozilla.org/docs/web-developer/mimetypes.html> for information about MIME support in the Mozilla family of web browsers.

5. RFC 2045: Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies <http://tools.ietf.org/html/rfc2045>.

6. RFC 3023: XML Media Types <http://tools.ietf.org/html/rfc3023>.

7. RFC 3923: End-to-End Signing and Object Encryption for the Extensible Messaging and Presence Protocol (XMPP) <http://tools.ietf.org/html/rfc3923>.

8. RFC 6121: Extensible Messaging and Presence Protocol (XMPP): Instant Messaging and Presence <http://tools.ietf.org/html/rfc6121>.

9. XEP-0045: Multi-User Chat <http://xmpp.org/extensions/xep-0045.html>.

10. XEP-0077: In-Band Registration <http://xmpp.org/extensions/xep-0077.html>.

11. RFC 2779: A Model for Presence and Instant Messaging <http://tools.ietf.org/html/rfc2779>.

12. The Internet Assigned Numbers Authority (IANA) is the central coordinator for the assignment of unique parameter values for Internet protocols, such as port numbers and URI schemes. For further information, see <http://www.iana.org/>.

13. The XMPP Registrar maintains a list of reserved protocol namespaces as well as registries of parameters used in the context of XMPP extension protocols approved by the XMPP Standards Foundation. For further information, see <http://xmpp.org/registrar/>.


Appendix H: Revision History

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

Version 0.5 (2005-07-19)

Retracted the proposal (again) in favor of draft-saintandre-xmpp-iri. (psa)

Version 0.4 (2005-01-05)

Reinstated the proposal since it fills a need not met by RFC 3923 and draft-saintandre-xmpp-uri; specified XML schema; specified IANA considerations, including content-type registration; further specified security considerations; removed use cases for service discovery, directory search, vCard lookup, and authentication; added more detailed descriptive text to remaining use cases. (psa)

Version 0.3 (2004-07-26)

Formally retracted this proposal in favor of the relevant Internet-Drafts. (psa)

Version 0.2 (2003-08-18)

Added authentication example. (psa)

Version 0.1 (2003-04-21)

Initial version. (psa)

END