<pre>Network Working Group                                     P. Saint-Andre
Request for Comments: 3922                    Jabber Software Foundation
Category: Standards Track                                   October 2004


    <span class="h1">Mapping the Extensible Messaging and Presence Protocol (XMPP) to</span>
              <span class="h1">Common Presence and Instant Messaging (CPIM)</span>

Status of this Memo

   This document specifies an Internet standards track protocol for the
   Internet community, and requests discussion and suggestions for
   improvements.  Please refer to the current edition of the "Internet
   Official Protocol Standards" (STD 1) for the standardization state
   and status of this protocol.  Distribution of this memo is unlimited.

Copyright Notice

   Copyright (C) The Internet Society (2004).

Abstract

   This memo describes a mapping between the Extensible Messaging and
   Presence Protocol (XMPP) and the Common Presence and Instant
   Messaging (CPIM) specifications.

Table of Contents

   <a href="#section-1">1</a>.  Introduction . . . . . . . . . . . . . . . . . . . . . . . . .  <a href="#page-2">2</a>
   <a href="#section-2">2</a>.  Approach . . . . . . . . . . . . . . . . . . . . . . . . . . .  <a href="#page-3">3</a>
   <a href="#section-3">3</a>.  Address Mapping  . . . . . . . . . . . . . . . . . . . . . . .  <a href="#page-4">4</a>
   <a href="#section-4">4</a>.  Syntax Mapping of Instant Messages . . . . . . . . . . . . . .  <a href="#page-5">5</a>
   <a href="#section-5">5</a>.  Syntax Mapping of Presence Information . . . . . . . . . . . . <a href="#page-13">13</a>
   <a href="#section-6">6</a>.  XMPP-CPIM Gateway as Presence Service  . . . . . . . . . . . . <a href="#page-26">26</a>
   <a href="#section-7">7</a>.  Security Considerations  . . . . . . . . . . . . . . . . . . . <a href="#page-31">31</a>
   <a href="#section-8">8</a>.  References . . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-32">32</a>
   Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-33">33</a>
   Full Copyright Statement . . . . . . . . . . . . . . . . . . . . . <a href="#page-34">34</a>













<span class="grey">Saint-Andre                 Standards Track                     [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>.  Introduction</span>

<span class="h3"><a class="selflink" id="section-1.1" href="#section-1.1">1.1</a>.  Overview</span>

   The Instant Messaging and Presence (IMPP) Working Group has defined
   an abstract framework for interoperability among instant messaging
   (IM) and presence systems that are compliant with [<a href="#ref-IMP-REQS" title="&quot;Instant Messaging / Presence Protocol Requirements&quot;">IMP-REQS</a>].  This
   framework is commonly called Common Presence and Instant Messaging or
   "CPIM".  The CPIM family of specifications include a Common Profile
   for Instant Messaging [<a href="#ref-CPIM" title="&quot;Common Profile for Instant Messaging (CPIM)&quot;">CPIM</a>] (also called CPIM), a Common Profile for
   Presence [<a href="#ref-CPP" title="&quot;Common Profile for Presence (CPP)&quot;">CPP</a>], a CPIM Message Format [<a href="#ref-MSGFMT" title="&quot;Common Presence and Instant Messaging (CPIM): Message Format&quot;">MSGFMT</a>], and a Common Presence
   Information Data Format [<a href="#ref-PIDF" title="&quot;Presence Information Data Format (PIDF)&quot;">PIDF</a>].  (Note: To prevent confusion, Common
   Presence and Instant Messaging is referred to herein collectively as
   "the CPIM specifications", whereas the Common Profile for Instant
   Messaging is referred to as "CPIM".)

   This memo describes how the Extensible Messaging and Presence
   Protocol ([<a href="#ref-XMPP-CORE" title="&quot;Extensible Messaging and Presence Protocol (XMPP): Core&quot;">XMPP-CORE</a>], [<a href="#ref-XMPP-IM" title="&quot;Extensible Messaging and Presence Protocol (XMPP): Instant Messaging and Presence&quot;">XMPP-IM</a>]) maps to the abstract model
   contained in the CPIM specifications, mainly for the purpose of
   establishing gateways between XMPP services and non-XMPP services
   that conform to [<a href="#ref-IMP-REQS" title="&quot;Instant Messaging / Presence Protocol Requirements&quot;">IMP-REQS</a>].  Such a gateway, referred to herein as an
   "XMPP-CPIM gateway", may be established to interpret the protocols of
   one service and translate them into the protocols of the other
   service.  We can visualize this relationship as follows:

     +-------------+        +-------------+        +------------+
     |             |        |             |        |            |
     |    XMPP     |        |  XMPP-CPIM  |        |  Non-XMPP  |
     |   Service   | &lt;----&gt; |   Gateway   | &lt;----&gt; |  Service   |
     |             |        |             |        |            |
     +-------------+        +-------------+        +------------+

   This memo defines a mapping for use by a gateway that translates
   between XMPP and a non-XMPP protocol via the CPIM specifications.
   Such a gateway is not an intermediate hop on a network of non-XMPP
   servers (whose native formats may or may not be defined by the CPIM
   specifications), but a dedicated translator between XMPP and a
   non-XMPP protocol, where the CPIM specifications define the common
   formats into which the protocols are translated for purposes of
   interworking.

   The mapping defined herein applies to instant messages and presence
   information that are not encrypted or signed for end-to-end security.
   For information about secure communications to or from an XMPP
   service through an XMPP-CPIM gateway, refer to [<a href="#ref-XMPP-E2E" title="&quot;End-to-End Signing and Object Encryption in the Extensible Messaging and Presence Protocol (XMPP)&quot;">XMPP-E2E</a>].






<span class="grey">Saint-Andre                 Standards Track                     [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


<span class="h3"><a class="selflink" id="section-1.2" href="#section-1.2">1.2</a>.  Terminology</span>

   This memo inherits vocabulary defined in [<a href="#ref-IMP-MODEL" title="&quot;A Model for Presence and Instant Messaging&quot;">IMP-MODEL</a>].  Terms such as
   CLOSED, INSTANT INBOX, INSTANT MESSAGE, OPEN , PRESENCE SERVICE,
   PRESENTITY, SUBSCRIPTION, and WATCHER are used in the same meaning as
   defined therein.

   This memo also inherits vocabulary defined in [<a href="#ref-XMPP-CORE" title="&quot;Extensible Messaging and Presence Protocol (XMPP): Core&quot;">XMPP-CORE</a>].  Terms
   such as ENTITY, NODE IDENTIFIER, DOMAIN IDENTIFIER, RESOURCE
   IDENTIFIER, MESSAGE STANZA, and PRESENCE STANZA are used in the same
   meaning as defined therein.

<span class="h3"><a class="selflink" id="section-1.3" href="#section-1.3">1.3</a>.  Conventions Used in this Document</span>

   The capitalized key words "MUST", "MUST NOT", "REQUIRED", "SHALL",
   "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and
   "OPTIONAL" in this document are to be interpreted as described in
   [<a href="#ref-TERMS" title="&quot;Key words for use in RFCs to Indicate Requirement Levels&quot;">TERMS</a>].

<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>.  Approach</span>

   XMPP and CPIM are distinctly foreign technologies.  Therefore, care
   must be taken in mapping between XMPP and the abstract syntax defined
   by the CPIM specifications.

   At root, XMPP is a data transport protocol for streaming XML elements
   (called "stanzas") between any two endpoints on the network; message
   and presence stanzas are two of the core data elements defined in
   XMPP and are often used to exchange instant messages and presence
   information between IM users (although the inherent extensibility of
   XML enables applications to use the general semantics of these stanza
   types for other purposes).  XMPP is not based on [<a href="#ref-MIME" title="&quot;Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies&quot;">MIME</a>]; instead,
   [<a href="#ref-XMPP-CORE" title="&quot;Extensible Messaging and Presence Protocol (XMPP): Core&quot;">XMPP-CORE</a>] defines XML schemas for both message and presence stanzas
   (for example, the &lt;body/&gt; child of a message stanza contains XML
   character data that is usually intended to be read by a human user).

   The CPIM specifications provide common formats for instant messaging
   and presence through two [<a href="#ref-MIME" title="&quot;Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies&quot;">MIME</a>] content-types: "Message/CPIM" for
   messages ([<a href="#ref-MSGFMT" title="&quot;Common Presence and Instant Messaging (CPIM): Message Format&quot;">MSGFMT</a>]) and "application/pidf+xml" for presence ([<a href="#ref-PIDF" title="&quot;Presence Information Data Format (PIDF)&quot;">PIDF</a>]).
   The syntax of "Message/CPIM" objects is similar to but stricter than
   that defined in [<a href="./rfc2822" title="&quot;Internet Message Format&quot;">RFC2822</a>], and provides the ability to include
   arbitrary MIME media types [<a href="#ref-MIMETYPES" title="&quot;Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types&quot;">MIMETYPES</a>].  By contrast, each
   "application/pidf+xml" object is a complete XML document whose
   structure is defined by an XML schema.







<span class="grey">Saint-Andre                 Standards Track                     [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


   The approach taken herein is to specify mappings from XMPP elements
   and attributes to the headers and MIME formats defined by [<a href="#ref-MSGFMT" title="&quot;Common Presence and Instant Messaging (CPIM): Message Format&quot;">MSGFMT</a>]
   and [<a href="#ref-PIDF" title="&quot;Presence Information Data Format (PIDF)&quot;">PIDF</a>] in order to comply with the semantics defined by [<a href="#ref-CPIM" title="&quot;Common Profile for Instant Messaging (CPIM)&quot;">CPIM</a>]
   and [<a href="#ref-CPP" title="&quot;Common Profile for Presence (CPP)&quot;">CPP</a>].  Naturally, mappings in the opposite direction are
   provided as well.

<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>.  Address Mapping</span>

<span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>.  Overview</span>

   Address mapping may be required since the address formats used to
   identify XMPP entities (specified in [<a href="#ref-XMPP-CORE" title="&quot;Extensible Messaging and Presence Protocol (XMPP): Core&quot;">XMPP-CORE</a>]) are different from
   those used to identify instant inboxes (the im: URI scheme specified
   in [<a href="#ref-CPIM" title="&quot;Common Profile for Instant Messaging (CPIM)&quot;">CPIM</a>]) and presentities (the pres: URI scheme specified in
   [<a href="#ref-CPP" title="&quot;Common Profile for Presence (CPP)&quot;">CPP</a>]).  In particular, different characters are allowed in im: and
   pres: URIs than are allowed in XMPP addresses:

   o  The following [<a href="#ref-US-ASCII" title="&quot;ASCII format for network interchange&quot;">US-ASCII</a>] characters are allowed in im:/pres: URIs
      but not in XMPP addresses: #26; (&amp;), #27; ('), and #2f; (/).
   o  Many non-US-ASCII (specifically, UTF-8) characters are allowed in
      XMPP addresses but not allowed in im:/pres: URIs, since XMPP
      allows internationalized local-part addresses.

   Note: In this document we discuss characters allowed in local-part
   addresses only (i.e., we have ruled the mapping of domain names as
   out of scope for the initial version of this document, since it is a
   matter for the Domain Name System and the translation of fully
   internationalized domain names).

<span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a>.  XMPP to CPIM</span>

   The following is a high-level algorithm for mapping an XMPP address
   to an im: or pres: URI:

   1.  Split XMPP address into node identifier (local-part; mapping
       described in remaining steps), domain identifier (hostname;
       mapping is out of scope), and resource identifier (specifier for
       particular device or connection; discard this for cross-system
       interoperability)

   2.  Apply Nodeprep profile of [<a href="#ref-STRINGPREP" title="&quot;Preparation of Internationalized Strings (stringprep)&quot;">STRINGPREP</a>] (as specified in
       [<a href="#ref-XMPP-CORE" title="&quot;Extensible Messaging and Presence Protocol (XMPP): Core&quot;">XMPP-CORE</a>]) for canonicalization (OPTIONAL)

   3.  Translate #26; to &amp;, #27; to ', and #2f; to / respectively

   4.  For each byte, if the byte is not in the set A-Za-z0-9!$*.?_~+=
       then change to %hexhex as described in Section 2.2.5 of
       [<a href="#ref-URL-GUIDE" title="&quot;Guidelines for new URL Schemes&quot;">URL-GUIDE</a>]



<span class="grey">Saint-Andre                 Standards Track                     [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


   5.  Combine resulting local-part with mapped hostname to form
       local@domain address

   6.  Prepend with 'im:' scheme (for XMPP &lt;message/&gt; stanzas) or
       'pres:' scheme (for XMPP &lt;presence/&gt; stanzas)

<span class="h3"><a class="selflink" id="section-3.3" href="#section-3.3">3.3</a>.  CPIM to XMPP</span>

   The following is a high-level algorithm for mapping an im: or pres:
   URI to an XMPP address:

   1.  Remove URI scheme

   2.  Split at the first '@' character into local-part and hostname
       (mapping the latter is out of scope)

   3.  Translate %hexhex to equivalent octets as described in <a href="#section-2.2.5">Section</a>
       <a href="#section-2.2.5">2.2.5</a> of [<a href="#ref-URL-GUIDE" title="&quot;Guidelines for new URL Schemes&quot;">URL-GUIDE</a>]

   4.  Treat result as a UTF-8 string

   5.  Translate &amp; to #26;, ' to #27;, and / to #2f respectively

   6.  Apply Nodeprep profile of [<a href="#ref-STRINGPREP" title="&quot;Preparation of Internationalized Strings (stringprep)&quot;">STRINGPREP</a>] (as specified in
       [<a href="#ref-XMPP-CORE" title="&quot;Extensible Messaging and Presence Protocol (XMPP): Core&quot;">XMPP-CORE</a>]) for canonicalization (OPTIONAL)

   7.  Recombine local-part with mapped hostname to form local@domain
       address

<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>.  Syntax Mapping of Instant Messages</span>

   This section describes how a gateway SHOULD map instant messages
   between an XMPP service and a non-XMPP service using a "Message/CPIM"
   object as the bearer of encapsulated text content in order to comply
   with the instant messaging semantics defined by [<a href="#ref-CPIM" title="&quot;Common Profile for Instant Messaging (CPIM)&quot;">CPIM</a>].

<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>.  Message Syntax Mapping from XMPP to CPIM Specifications</span>

   This section defines the mapping of syntax primitives from XMPP
   message stanzas to "Message/CPIM" objects with encapsulated text
   content.

   Note: As specified in [<a href="#ref-MIME" title="&quot;Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies&quot;">MIME</a>], the default Content-type of a MIME
   object is "Content-type: text/plain; charset=us-ascii".  Because XMPP
   uses the [<a href="#ref-UTF-8" title="&quot;UTF-8, a transformation format of ISO 10646&quot;">UTF-8</a>] character encoding exclusively, the encapsulated
   MIME object generated by an XMPP-CPIM gateway MUST set the





<span class="grey">Saint-Andre                 Standards Track                     [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


   "Content-type" MUST be set to "text/plain" and the charset MUST be
   set to "utf-8".

<span class="h4"><a class="selflink" id="section-4.1.1" href="#section-4.1.1">4.1.1</a>.  From Address</span>

   The 'from' attribute of an XMPP message stanza maps to the 'From'
   header of a "Message/CPIM" object.  In XMPP, the sender's server
   stamps or validates the "from" address and sets its value to the full
   &lt;user@host/resource&gt; negotiated between client and server during
   authentication and resource binding as defined in [<a href="#ref-XMPP-CORE" title="&quot;Extensible Messaging and Presence Protocol (XMPP): Core&quot;">XMPP-CORE</a>].  Thus
   an XMPP-CPIM gateway will receive from the sender's XMPP server a
   message stanza containing a "from" address of the form
   &lt;user@host/resource&gt;.  To map the 'from' attribute of an XMPP message
   stanza to the 'From' header of a "Message/CPIM" object, the gateway
   MUST remove the resource identifier, MUST append the "im:"  Instant
   Messaging URI scheme to the front of the address, and MAY include a
   CPIM "Formal-name" for the sender (if known).

   Example: From Address Mapping

   XMPP 'from' attribute
     &lt;message from='juliet@example.com/balcony'&gt;
       ...
     &lt;/message&gt;

   CPIM 'From' header
     From: Juliet Capulet &lt;im:juliet@example.com&gt;

<span class="h4"><a class="selflink" id="section-4.1.2" href="#section-4.1.2">4.1.2</a>.  To Address</span>

   The 'to' attribute of an XMPP message stanza maps to the 'To' header
   of a "Message/CPIM" object.  In XMPP, the sender SHOULD include a
   'to' attribute on a message stanza, and MUST include it if the
   message is intended for delivery to another user.  Thus an XMPP-CPIM
   gateway will receive from the sender's XMPP server a message stanza
   containing a "to" address of the form &lt;user@host&gt; or
   &lt;user@host/resource&gt;.  To map the 'to' attribute of an XMPP message
   stanza to the 'To' header of a "Message/CPIM" object, the gateway
   MUST remove the resource identifier (if included), MUST append the
   "im:" Instant Messaging URI scheme to the front of the address, and
   MAY include a CPIM "Formal-name" for the recipient (if known).










<span class="grey">Saint-Andre                 Standards Track                     [Page 6]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


   Example: To Address Mapping

   XMPP 'to' attribute
     &lt;message to='romeo@example.net/orchard'&gt;
       ...
     &lt;/message&gt;

   CPIM 'To' header
     To: Romeo Montague &lt;im:romeo@example.net&gt;

<span class="h4"><a class="selflink" id="section-4.1.3" href="#section-4.1.3">4.1.3</a>.  Stanza ID</span>

   An XMPP message stanza MAY possess an 'id' attribute, which is used
   by the sending application for the purpose of tracking stanzas and is
   not a globally-unique identifier such as is defined by the MIME
   Content-ID header.  Because the XMPP 'id' attribute does not have the
   same meaning as the MIME Content-ID header, it SHOULD NOT be mapped
   to that header; however, if the 'id' is known to be unique (e.g., if
   it is generated to be unique by the XMPP server and that fact is
   known by the XMPP-CPIM gateway), then it SHOULD be so mapped.

<span class="h4"><a class="selflink" id="section-4.1.4" href="#section-4.1.4">4.1.4</a>.  Message Type</span>

   An XMPP message stanza MAY possess a 'type' attribute, which is used
   by the sending application to capture the conversational context of
   the message.  There is no mapping of an XMPP 'type' attribute to a
   "Message/CPIM" header, common MIME features, or encapsulated text
   content.  Therefore if an XMPP stanza received by an XMPP-CPIM
   gateway possesses a 'type' attribute, the gateway SHOULD ignore the
   value provided.

<span class="h4"><a class="selflink" id="section-4.1.5" href="#section-4.1.5">4.1.5</a>.  Message Thread</span>

   An XMPP message stanza MAY contain a &lt;thread/&gt; child element to
   specify the conversation thread in which the message is situated.
   There is no mapping of an XMPP &lt;thread/&gt; element to a "Message/CPIM"
   header, common MIME features, or encapsulated text content. Therefore
   if an XMPP message stanza received by an XMPP-CPIM gateway contains a
   &lt;thread/&gt; child element, the gateway SHOULD ignore the value
   provided.

<span class="h4"><a class="selflink" id="section-4.1.6" href="#section-4.1.6">4.1.6</a>.  Message Subject</span>

   An XMPP message stanza MAY include a &lt;subject/&gt; child element.  If
   included, it maps to the 'Subject' header of a "Message/CPIM" object.
   To map the XMPP &lt;subject/&gt; element to the 'Subject' header of a
   "Message/CPIM" object, the gateway SHOULD simply map the XML
   character data of the XMPP &lt;subject/&gt; element to the value of the



<span class="grey">Saint-Andre                 Standards Track                     [Page 7]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


   'Subject' header.  The &lt;subject/&gt; element MAY include an 'xml:lang'
   attribute specifying the language in which the subject is written. If
   an 'xml:lang' attribute is provided, it MUST be mapped by including
   ';lang=tag' after the header name and colon, where 'tag' is the value
   of the 'xml:lang' attribute.

   Example: Subject Mapping

   XMPP &lt;subject/&gt; element
     &lt;subject&gt;Hi!&lt;/subject&gt;
     &lt;subject xml:lang='cz'&gt;Ahoj!&lt;/subject&gt;

   CPIM 'Subject' header
     Subject: Hi!
     Subject:;lang=cz Ahoj!

<span class="h4"><a class="selflink" id="section-4.1.7" href="#section-4.1.7">4.1.7</a>.  Message Body</span>

   The &lt;body/&gt; child element of an XMPP message stanza is used to
   provide the primary meaning of the message.  The XML character data
   of the XMPP &lt;body/&gt; element maps to the encapsulated text message
   content.

   Example: Message Body

   XMPP message &lt;body/&gt;
     &lt;message&gt;
       &lt;body&gt;Wherefore art thou, Romeo?&lt;/body&gt;
     &lt;/message&gt;

   Encapsulated MIME text content
     Content-type: text/plain; charset=utf-8
     Content-ID: &lt;123456789@example.net&gt;

     Wherefore art thou, Romeo?

<span class="h4"><a class="selflink" id="section-4.1.8" href="#section-4.1.8">4.1.8</a>.  Message Extensions</span>

   As defined in [<a href="#ref-XMPP-CORE" title="&quot;Extensible Messaging and Presence Protocol (XMPP): Core&quot;">XMPP-CORE</a>], an XMPP message stanza may contain
   "extended" content in any namespace in order to supplement or extend
   the semantics of the core message stanza.  With the exception of
   extended information qualified by the
   'urn:ietf:params:xml:ns:xmpp-e2e' namespace as defined in [<a href="#ref-XMPP-E2E" title="&quot;End-to-End Signing and Object Encryption in the Extensible Messaging and Presence Protocol (XMPP)&quot;">XMPP-E2E</a>],
   an XMPP-CPIM gateway SHOULD ignore such information and not pass it
   through the gateway to the intended recipient.  No mapping for such
   information is defined.





<span class="grey">Saint-Andre                 Standards Track                     [Page 8]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


<span class="h4"><a class="selflink" id="section-4.1.9" href="#section-4.1.9">4.1.9</a>.  Gateway-Generated CPIM Syntax</span>

   CPIM specifies the existence of "Message/CPIM" headers in addition to
   those described above, but there is no exact analogue for those
   headers in the core XMPP specifications.  These include:

   o  cc -- specifies the address of an entity that is to receive a
      "courtesy copy" of the message (i.e., a non-primary addressee)
   o  DateTime -- specifies the datetime at which the message was sent
   o  NS -- specifies the namespace of a feature extension
   o  Require -- specifies mandatory-to-recognize features

   An XMPP-CPIM gateway MAY independently generate such headers based on
   its own information (e.g., the datetime at which it received a
   message stanza from an XMPP entity) or based on data encoded in
   non-core XMPP extensions, but rules for doing so are out of scope for
   this memo.

<span class="h3"><a class="selflink" id="section-4.2" href="#section-4.2">4.2</a>.  Message Syntax Mapping from CPIM Specifications to XMPP</span>

   This section defines the mapping of syntax primitives from
   "Message/CPIM" objects with encapsualted text content to XMPP message
   stanzas.

<span class="h4"><a class="selflink" id="section-4.2.1" href="#section-4.2.1">4.2.1</a>.  From Address</span>

   The 'From' header of a "Message/CPIM" object maps to the 'from'
   attribute of an XMPP message stanza.  To map the CPIM 'From' header
   to the XMPP 'from' attribute, the gateway MUST remove the "im:"
   Instant Messaging URI scheme from the front of the address and MUST
   remove the CPIM "Formal-name" (if provided).

   Example: From Address Mapping

   CPIM 'From' header
     From: Romeo Montague &lt;im:romeo@example.net&gt;

   XMPP 'from' attribute
     &lt;message from='romeo@example.net'&gt;
       ...
     &lt;/message&gt;

<span class="h4"><a class="selflink" id="section-4.2.2" href="#section-4.2.2">4.2.2</a>.  To Address</span>

   The 'To' header of a "Message/CPIM" object maps to the 'to' attribute
   of an XMPP message stanza.  To map the CPIM 'To' header to the XMPP
   'to' attribute, the gateway MUST remove the "im:" Instant Messaging
   URI scheme from the front of the address and MUST remove the CPIM



<span class="grey">Saint-Andre                 Standards Track                     [Page 9]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


   "Formal-name" (if provided).  If the gateway possesses knowledge of
   the resource identifier in use by the XMPP entity, the gateway MAY
   append the resource identifier to the address.

   Example: To Address Mapping

   CPIM 'To' header
     To: Juliet Capulet &lt;im:juliet@example.com&gt;

   XMPP 'to' attribute
     &lt;message to='juliet@example.com/balcony'&gt;
       ...
     &lt;/message&gt;

<span class="h4"><a class="selflink" id="section-4.2.3" href="#section-4.2.3">4.2.3</a>.  Courtesy Copy</span>

   The core XMPP specification does not include syntax for specifying a
   "courtesy copy" (non-primary addressee) for a message stanza.
   Therefore, if an XMPP-CPIM gateway receives a "Message/CPIM" object
   that contains a 'cc' header, it SHOULD NOT pass the information
   contained in that header on to the XMPP recipient.

<span class="h4"><a class="selflink" id="section-4.2.4" href="#section-4.2.4">4.2.4</a>.  DateTime Header</span>

   The core XMPP specification does not include syntax for specifying
   the datetime at which a message stanza was sent.  Therefore, if an
   XMPP-CPIM gateway receives a "Message/CPIM" object that contains a
   'DateTime' header, it SHOULD NOT pass the information contained in
   that header on to the XMPP recipient.

<span class="h4"><a class="selflink" id="section-4.2.5" href="#section-4.2.5">4.2.5</a>.  Message Subject</span>

   The 'Subject' header of a "Message/CPIM" object maps to the
   &lt;subject/&gt; child element of an XMPP message stanza.  To map the CPIM
   'Subject' header to the XMPP &lt;subject/&gt; element, the gateway SHOULD
   simply map the value of the 'Subject' header to the XML character
   data of the XMPP &lt;subject/&gt; element.  The 'Subject' header MAY
   specify the "lang" in which the subject is written.  If "lang"
   information is provided, it MUST be mapped to the 'xml:lang'
   attribute of the &lt;subject/&gt; element, where the value of the
   'xml:lang' attribute is the "tag" value supplied in the string
   ';lang=tag' included after the CPIM 'Subject' header name and colon.









<span class="grey">Saint-Andre                 Standards Track                    [Page 10]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


   Example: Subject Mapping

   CPIM 'Subject' header
     Subject: Hi!
     Subject:;lang=cz Ahoj!

   XMPP &lt;subject/&gt; element
     &lt;subject&gt;Hi!&lt;/subject&gt;
     &lt;subject xml:lang='cz'&gt;Ahoj!&lt;/subject&gt;

<span class="h4"><a class="selflink" id="section-4.2.6" href="#section-4.2.6">4.2.6</a>.  Header Extensions</span>

   "Message/CPIM" objects MAY include an optional 'NS' header to specify
   the namespace of a feature extension.  An XMPP-CPIM gateway MUST NOT
   pass such headers through to the XMPP recipient, and no mapping for
   such headers is defined.

<span class="h4"><a class="selflink" id="section-4.2.7" href="#section-4.2.7">4.2.7</a>.  Require Header</span>

   "Message/CPIM" objects MAY include an optional 'Require' header to
   specify mandatory-to-recognize features.  In general, such a header
   would be included by the non-XMPP sending application to (1) insist
   that the receiving application needs to understand functionality
   specified by a particular header or (2) indicate that some non-header
   semantics need to be implemented by the receiving application in
   order to understand the contents of the message (e.g.,
   "Locale.MustRenderKanji").  Because the mandatory-to-recognize
   features would be required of the XMPP receiving application rather
   than the XMPP-CPIM gateway itself, the gateway cannot properly handle
   the 'Require' header without detailed knowledge about the
   capabilities of the XMPP receiving application.  Therefore, it seems
   appropriate that the XMPP-CPIM gateway SHOULD return a warning or
   error to the non-XMPP sending application if it includes one or more
   'Require' headers in a "Message/CPIM" object; the exact nature of the
   warning or error will depend on the nature of the non-XMPP technology
   used by the foreign system, and is not defined herein.  Furthermore,
   any mapping of the 'Require' header into XMPP or an XMPP extension is
   left up to the implementation or to a future specification.

<span class="h4"><a class="selflink" id="section-4.2.8" href="#section-4.2.8">4.2.8</a>.  MIME Content-ID</span>

   XMPP does not include an element or attribute that captures a
   globally unique ID as is defined for the Content-ID MIME header as
   specified in [<a href="#ref-MIME" title="&quot;Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies&quot;">MIME</a>].  If an XMPP-CPIM gateway receives a MIME object
   that includes a Content-ID, it MAY provide the Content-ID as the
   value of the message stanza's 'id' attribute, but this is OPTIONAL.





<span class="grey">Saint-Andre                 Standards Track                    [Page 11]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


   Example: Content-ID for Encapsulated Object

   MIME header
     Content-ID: &lt;123456789@example.net&gt;

   XMPP 'id' attribute (OPTIONAL)
     &lt;message id='123456789@example.net'&gt;
       ...
     &lt;/message&gt;

<span class="h4"><a class="selflink" id="section-4.2.9" href="#section-4.2.9">4.2.9</a>.  Message Body</span>

   If the Content-type of an encapsulated MIME object is "text/plain",
   then the encapsulated text message content maps to the XML character
   data of the &lt;body/&gt; child element of an XMPP message stanza.

   Example: Message Body

   Encapsulated MIME text content
     Content-type: text/plain; charset=utf-8
     Content-ID: &lt;123456789@example.net&gt;

     Wherefore art thou?

   XMPP message &lt;body/&gt;
     &lt;message id='123456789@example.net'&gt;
       &lt;body&gt;Wherefore art thou?&lt;/body&gt;
     &lt;/message&gt;

   If the Content-Type is not "text/plain", the XMPP-CPIM gateway MAY
   map the content to an XMPP extension but MUST NOT map it to the
   &lt;body/&gt; child of the XMPP message stanza, which is allowed to contain
   XML character data only.  The only exception to this rule is a
   multi-part MIME object of the kind specified in [<a href="#ref-XMPP-E2E" title="&quot;End-to-End Signing and Object Encryption in the Extensible Messaging and Presence Protocol (XMPP)&quot;">XMPP-E2E</a>], which is
   to be mapped as described in that memo.

   If the charset is "US-ASCII" or "UTF-8", the gateway MUST map the
   "Message/CPIM" object; otherwise it SHOULD NOT.

<span class="h4"><a class="selflink" id="section-4.2.10" href="#section-4.2.10">4.2.10</a>.  Gateway-Generated XMPP Syntax</span>

   XMPP specifies the existence of a 'type' attribute for XMPP message
   stanzas, which enables the sender to define the conversational
   context of the message.  There is no exact analogue for this
   attribute in CPIM.  An XMPP-CPIM gateway MAY independently generate
   the 'type' attribute based on its own information, but this is
   OPTIONAL and rules for doing so are out of scope for this memo.




<span class="grey">Saint-Andre                 Standards Track                    [Page 12]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>.  Syntax Mapping of Presence Information</span>

   This section describes how a gateway SHOULD map presence information
   between an XMPP service and a non-XMPP service using a "Message/CPIM"
   object as the bearer of an encapsulated [<a href="#ref-PIDF" title="&quot;Presence Information Data Format (PIDF)&quot;">PIDF</a>] object in order to
   comply with the presence semantics defined by [<a href="#ref-CPP" title="&quot;Common Profile for Presence (CPP)&quot;">CPP</a>].

<span class="h3"><a class="selflink" id="section-5.1" href="#section-5.1">5.1</a>.  Presence Syntax Mapping from XMPP to CPIM Specifications</span>

   This section defines the mapping of syntax primitives from XMPP
   presence stanzas to "Message/CPIM" objects with encapsulated
   "application/pidf+xml" objects.

   Note: As specified in [<a href="#ref-MIME" title="&quot;Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies&quot;">MIME</a>], the default Content-type of a MIME
   object is "Content-type: text/plain; charset=us-ascii".  Because XMPP
   uses the [<a href="#ref-UTF-8" title="&quot;UTF-8, a transformation format of ISO 10646&quot;">UTF-8</a>] character encoding exclusively and because PIDF
   specifies the "application/pidf+xml" MIME type, the encapsulated MIME
   object generated by an XMPP-CPIM gateway for presence information
   MUST set the 'Content-type' header for that object.  The
   "Content-type" MUST be set to "application/pidf+xml" and the charset
   MUST be set to "utf-8".

<span class="h4"><a class="selflink" id="section-5.1.1" href="#section-5.1.1">5.1.1</a>.  From Address</span>

   The 'from' attribute of an XMPP presence stanza maps to the 'From'
   header of a "Message/CPIM" object.  In XMPP, the sender's server
   stamps or validates the "from" address and sets its value to the
   &lt;user@host/resource&gt; negotiated between client and server during
   authenticating and resource binding as defined in [<a href="#ref-XMPP-CORE" title="&quot;Extensible Messaging and Presence Protocol (XMPP): Core&quot;">XMPP-CORE</a>].  Thus
   an XMPP-CPIM gateway will receive from the sender's XMPP server a
   presence stanza containing a "from" address of the form
   &lt;user@host/resource&gt;.  To map the 'from' attribute of an XMPP
   presence stanza to the 'From' header of a "Message/CPIM" object, the
   gateway MUST remove the resource identifier, MUST append the "im:"
   Instant Messaging URI scheme to the front of the address, and MAY
   include a CPIM "Formal-name" for the sender (if known).

   Example: From Address Mapping

   XMPP 'from' attribute
     &lt;presence from='juliet@example.com/balcony'&gt;
       ...
     &lt;/presence&gt;

   CPIM 'From' header
     From: Juliet Capulet &lt;im:juliet@example.com&gt;





<span class="grey">Saint-Andre                 Standards Track                    [Page 13]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


   In addition, the 'from' attribute of an XMPP presence stanza maps to
   the 'entity' attribute of a PIDF &lt;presence/&gt; root element.  To map
   the XMPP 'from' attribute to the PIDF 'entity' attribute, the gateway
   MUST remove the resource identifier and MUST append the "pres:"
   Instant Messaging URI scheme to the front of the address.

   Example: From Address Mapping (PIDF)

   XMPP 'from' attribute
     &lt;presence from='juliet@example.com/balcony'&gt;
       ...
     &lt;/presence&gt;

   PIDF 'entity' attribute
     &lt;presence entity='pres:juliet@example.com'&gt;
       ...
     &lt;/presence&gt;

   Finally, an XMPP-CPIM gateway SHOULD map the resource identifier of
   the XMPP address contained in the XMPP 'from' attribute to the 'id'
   attribute of the PIDF &lt;tuple/&gt; child element.

   Example: Resource Identifier Mapping

   XMPP 'from' attribute
     &lt;presence from='juliet@example.com/balcony'&gt;
       ...
     &lt;/presence&gt;

   PIDF 'id' for &lt;tuple/&gt;
     &lt;presence entity='pres:juliet@example.com'&gt;
       &lt;tuple id='balcony'&gt;
         ...
       &lt;/tuple&gt;
     &lt;/presence&gt;

<span class="h4"><a class="selflink" id="section-5.1.2" href="#section-5.1.2">5.1.2</a>.  To Address</span>

   The 'to' attribute of an XMPP presence stanza maps to the 'To' header
   of a "Message/CPIM" object.  In XMPP, the sender MAY include a 'to'
   attribute on a presence stanza, and MUST include it if the presence
   stanza is intended for delivery directly to another user (presence
   stanzas intended for broadcasting are stamped with a 'to' address by
   the sender's server).  Thus an XMPP-CPIM gateway will receive from
   the sender's XMPP server a presence stanza containing a "to" address
   of the form &lt;user@host&gt; or &lt;user@host/resource&gt;.  To map the 'to'
   attribute of an XMPP presence stanza to the 'To' header of a
   "Message/CPIM" object, the gateway MUST remove the resource



<span class="grey">Saint-Andre                 Standards Track                    [Page 14]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


   identifier (if included), MUST append the "im:" Instant Messaging URI
   scheme to the front of the address, and MAY include a CPIM
   "Formal-name" for the recipient (if known).

   Example: To Address Mapping

   XMPP 'to' attribute
     &lt;presence to='romeo@example.net/orchard'&gt;
       ...
     &lt;/presence&gt;

   CPIM 'To' header
     To: Romeo Montague &lt;im:romeo@example.net&gt;

<span class="h4"><a class="selflink" id="section-5.1.3" href="#section-5.1.3">5.1.3</a>.  Stanza ID</span>

   An XMPP presence stanza MAY possess an 'id' attribute, which is used
   by the sending application for the purpose of tracking stanzas and is
   not a globally-unique identifier such as is defined by the MIME
   Content-ID header.  Because the XMPP 'id' attribute does not have the
   same meaning as the MIME Content-ID header, it SHOULD NOT be mapped
   to that header; however, if the 'id' is known to be unique (e.g., if
   it is generated to be unique by the XMPP server and that fact is
   known by the XMPP-CPIM gateway), then it SHOULD be so mapped.

<span class="h4"><a class="selflink" id="section-5.1.4" href="#section-5.1.4">5.1.4</a>.  Presence Type</span>

   An XMPP presence stanza MAY possess a 'type' attribute.  If no 'type'
   attribute is included, the presence stanza indicates that the sender
   is available; this state maps to the PIDF basic presence type of
   OPEN.  If the 'type' attribute has a value of "unavailable", the
   presence stanza indicates that the sender is no longer available;
   this state maps to the PIDF basic presence type of CLOSED.  Thus both
   the absence of a 'type' attribute and a 'type' attribute set to a
   value of "unavailable" correspond to the [<a href="#ref-CPP" title="&quot;Common Profile for Presence (CPP)&quot;">CPP</a>] "notify operation".
   All other presence types are used to manage presence subscriptions or
   probe for current presence; mappings for these other presence types
   are defined under XMPP-CPIM Gateway as Presence Service (<a href="#section-6">Section 6</a>).

   Example: Available Presence

   XMPP available presence
     &lt;presence from='juliet@example.com/balcony'/&gt;

   PIDF basic presence (OPEN)
     &lt;?xml version='1.0' encoding='UTF-8'?&gt;
     &lt;presence xmlns='urn:ietf:params:xml:ns:pidf'
               entity='pres:juliet@example.com'&gt;



<span class="grey">Saint-Andre                 Standards Track                    [Page 15]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


       &lt;tuple id='balcony'&gt;
         &lt;status&gt;
           &lt;basic&gt;open&lt;/basic&gt;
         &lt;/status&gt;
       &lt;/tuple&gt;
     &lt;/presence&gt;

   Example: Unavailable Presence

   XMPP unavailable presence
     &lt;presence from='juliet@example.com/balcony' type='unavailable'/&gt;

   PIDF basic presence (CLOSED)
     &lt;?xml version='1.0' encoding='UTF-8'?&gt;
     &lt;presence xmlns='urn:ietf:params:xml:ns:pidf'
               entity='pres:romeo@example.net'&gt;
       &lt;tuple id='balcony'&gt;
         &lt;status&gt;
           &lt;basic&gt;closed&lt;/basic&gt;
         &lt;/status&gt;
       &lt;/tuple&gt;
     &lt;/presence&gt;

<span class="h4"><a class="selflink" id="section-5.1.5" href="#section-5.1.5">5.1.5</a>.  Show Element</span>

   The &lt;show/&gt; child element of an XMPP presence stanza provides
   additional information about the sender's availability.  The XML
   character data of the XMPP &lt;show/&gt; element maps to extended &lt;status/&gt;
   content in PIDF.  The defined values of the &lt;show/&gt; element are
   'away', 'chat', 'dnd', and 'xa'; as soon as values are specified for
   extended status states in the 'urn:ietf:params:xml:ns:pidf:im'
   namespace, the XMPP values will be mapped to the PIDF values.

   Example: Show Element

   XMPP &lt;show/&gt; element
     &lt;presence from='juliet@example.com/balcony'&gt;
       &lt;show&gt;away&lt;/show&gt;
     &lt;/presence&gt;

   PIDF extended presence information
     &lt;?xml version='1.0' encoding='UTF-8'?&gt;
     &lt;presence xmlns='urn:ietf:params:xml:ns:pidf'
               xmlns:im='urn:ietf:params:xml:ns:pidf:im'
               entity='pres:juliet@example.com'&gt;
       &lt;tuple id='balcony'&gt;
         &lt;status&gt;
           &lt;basic&gt;open&lt;/basic&gt;



<span class="grey">Saint-Andre                 Standards Track                    [Page 16]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


           &lt;im:im&gt;away&lt;/im:im&gt;
         &lt;/status&gt;
       &lt;/tuple&gt;
     &lt;/presence&gt;

<span class="h4"><a class="selflink" id="section-5.1.6" href="#section-5.1.6">5.1.6</a>.  Status Element</span>

   The &lt;status/&gt; child element of an XMPP presence stanza provides a
   user-defined, natural-language description of the sender's detailed
   availability state.  The XMPP &lt;status/&gt; element maps to the PIDF
   &lt;note/&gt; child of the PIDF &lt;tuple/&gt; element.

   Example: Status Element

   XMPP &lt;status/&gt; element
     &lt;presence from='juliet@example.com/balcony'&gt;
       &lt;show&gt;away&lt;/show&gt;
       &lt;status&gt;retired to the chamber&lt;/status&gt;
     &lt;/presence&gt;

   PIDF &lt;note/&gt; element
     &lt;?xml version='1.0' encoding='UTF-8'?&gt;
     &lt;presence xmlns='urn:ietf:params:xml:ns:pidf'
               xmlns:im='urn:ietf:params:xml:ns:pidf:im'
               entity='pres:juliet@example.com'&gt;
       &lt;tuple id='balcony'&gt;
         &lt;status&gt;
           &lt;basic&gt;open&lt;/basic&gt;
           &lt;im:im&gt;away&lt;/im:im&gt;
         &lt;/status&gt;
         &lt;note&gt;retired to the chamber&lt;/note&gt;
       &lt;/tuple&gt;
     &lt;/presence&gt;

<span class="h4"><a class="selflink" id="section-5.1.7" href="#section-5.1.7">5.1.7</a>.  Presence Priority</span>

   An XMPP presence stanza MAY contain a &lt;priority/&gt; child element whose
   value is an integer between -128 and +127.  The value of this element
   MAY be mapped to the 'priority' attribute of the &lt;contact/&gt; child of
   the PIDF &lt;tuple/&gt; element.  If the value of the XMPP &lt;priority/&gt;
   element is negative, an XMPP-CPIM gateway MUST NOT map the value. The
   range of allowable values for the PIDF 'priority' attribute is any
   decimal number from zero to one inclusive, with a maximum of three
   decimal places.  If an XMPP-CPIM gateway maps these values, it SHOULD
   treat XMPP &lt;priority&gt;0&lt;/priority&gt; as PIDF priority='0' and XMPP
   &lt;priority&gt;127&lt;/priority&gt; as PIDF priority='1', mapping intermediate
   values appropriately so that they are unique (e.g., XMPP priority 1
   to PIDF priority 0.007, XMPP priority 2 to PIDF priority 0.015, and



<span class="grey">Saint-Andre                 Standards Track                    [Page 17]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


   so on up through mapping XMPP priority 126 to PIDF priority 0.992;
   note that this is an example only, and that the exact mapping shall
   be determined by the XMPP-CPIM gateway).

   Example: Presence Priority

   XMPP &lt;status/&gt; element
     &lt;presence from='juliet@example.com/balcony'&gt;
       &lt;priority&gt;13&lt;/priority&gt;
     &lt;/presence&gt;

   PIDF &lt;note/&gt; element
     &lt;?xml version='1.0' encoding='UTF-8'?&gt;
     &lt;presence xmlns='urn:ietf:params:xml:ns:pidf'
               entity='pres:juliet@example.com'&gt;
       &lt;tuple id='balcony'&gt;
         ...
         &lt;contact priority='0.102'&gt;im:juliet@example.com&lt;/contact&gt;
       &lt;/tuple&gt;
     &lt;/presence&gt;

<span class="h4"><a class="selflink" id="section-5.1.8" href="#section-5.1.8">5.1.8</a>.  Presence Extensions</span>

   As defined in [<a href="#ref-XMPP-CORE" title="&quot;Extensible Messaging and Presence Protocol (XMPP): Core&quot;">XMPP-CORE</a>], an XMPP presence stanza may contain
   "extended" content in any namespace in order to supplement or extend
   the semantics of the core presence stanza.  With the exception of
   extended information qualified by the
   'urn:ietf:params:xml:ns:xmpp-e2e' namespace as defined in [<a href="#ref-XMPP-E2E" title="&quot;End-to-End Signing and Object Encryption in the Extensible Messaging and Presence Protocol (XMPP)&quot;">XMPP-E2E</a>],
   an XMPP-CPIM gateway SHOULD ignore such information and not pass it
   through the gateway to the intended recipient.  No mapping for such
   information is defined.

<span class="h4"><a class="selflink" id="section-5.1.9" href="#section-5.1.9">5.1.9</a>.  Gateway-Generated CPIM and PIDF Syntax</span>

<span class="h5"><a class="selflink" id="section-5.1.9.1" href="#section-5.1.9.1">5.1.9.1</a>.  CPIM Message Headers</span>

   CPIM specifies the existence of "Message/CPIM" headers in addition to
   those described above, but there is no exact analogue for those
   headers in the core XMPP specifications.  These include:

   o  cc -- specifies the address of an entity that is to receive a
      "courtesy copy" of the presence information (i.e., a non-primary
      addressee)

   o  DateTime -- specifies the datetime at which the presence
      information was sent

   o  NS -- specifies the namespace of a feature extension



<span class="grey">Saint-Andre                 Standards Track                    [Page 18]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


   o  Subject -- specifies the subject or topic of the encapsulated
      "Message/CPIM" object

   o  Require -- specifies mandatory-to-recognize features

   An XMPP-CPIM gateway MAY independently generate such headers based on
   its own information (e.g., the datetime at which it received a
   presence stanza from an XMPP entity) or based on data encoded in
   non-core XMPP extensions, but rules for doing so are out of scope for
   this memo.

<span class="h5"><a class="selflink" id="section-5.1.9.2" href="#section-5.1.9.2">5.1.9.2</a>.  PIDF Elements</span>

   PIDF specifies the existence of XML elements in addition to those
   described above, but there is no exact analogue for those XML
   elements in the core XMPP specifications.  These include:

   o  &lt;contact/&gt; -- specifies an address (e.g., an im:, tel:, or mailto:
      URI) at which one may communicate with the presentity; an
      XMPP-CPIM gateway MAY include this element, in which case it
      SHOULD set its value to the &lt;user@host&gt; of the XMPP sender,
      prepended by the "im:" Instant Messaging URI scheme.

   o  &lt;timestamp/&gt; -- specifies the datetime at which the presence
      information was sent; an XMPP-CPIM gateway MAY independently
      generate this element based on its own information (e.g., the
      datetime at which it received the presence stanza from an XMPP
      entity) or based on data encoded in non-core XMPP extensions, but
      rules for doing so are out of scope for this memo.

<span class="h3"><a class="selflink" id="section-5.2" href="#section-5.2">5.2</a>.  Presence Syntax Mapping from CPIM Specifications to XMPP</span>

   This section defines the mapping of syntax primitives from
   "Message/CPIM" objects with encapsulated "application/pidf+xml"
   objects to XMPP presence stanzas.

   Note: An XMPP-CPIM gateway MUST NOT map to an XMPP presence stanza a
   "Message/CPIM" object whose encapsulated MIME object has a
   Content-type other than "application/pidf+xml" (with the exception of
   multi-part MIME objects as specified in [<a href="#ref-XMPP-E2E" title="&quot;End-to-End Signing and Object Encryption in the Extensible Messaging and Presence Protocol (XMPP)&quot;">XMPP-E2E</a>]).

<span class="h4"><a class="selflink" id="section-5.2.1" href="#section-5.2.1">5.2.1</a>.  From Address</span>

   The 'From' header of a "Message/CPIM" object maps to the &lt;user@host&gt;
   portion of the 'from' attribute of an XMPP presence stanza, and the
   'id' attribute of the PIDF &lt;tuple/&gt; child element maps to the
   resource identifier portion XMPP 'from' attribute.  Therefore, to map
   the CPIM and PIDF information to the XMPP 'from' attribute, the



<span class="grey">Saint-Andre                 Standards Track                    [Page 19]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


   gateway MUST remove the "im:" Instant Messaging URI scheme from the
   front of the address and MUST remove the CPIM "Formal-name" (if
   provided) in order to generate the &lt;user@host&gt; portion of the XMPP
   'from' attribute, then add a '/' character followed by the value of
   the PIDF &lt;tuple/&gt; element's 'id' attribute.

   Example: From Address Mapping

   CPIM 'From' header
     From: Romeo Montague &lt;im:romeo@example.net&gt;

   XMPP 'from' attribute
     &lt;presence from='romeo@example.net'&gt;
       ...
     &lt;/presence&gt;

   Example: Resource Identifier Mapping

   XMPP 'from' attribute
     &lt;presence from='juliet@example.com/balcony'&gt;
       ...
     &lt;/presence&gt;

   PIDF 'id' for &lt;tuple/&gt;
     &lt;presence entity='pres:juliet@example.com'&gt;
       &lt;tuple id='balcony'&gt;
         ...
       &lt;/tuple&gt;
     &lt;/presence&gt;

<span class="h4"><a class="selflink" id="section-5.2.2" href="#section-5.2.2">5.2.2</a>.  To Address</span>

   The 'To' header of a "Message/CPIM" object maps to the 'to' attribute
   of an XMPP presence stanza.  To map the CPIM 'To' header to the XMPP
   'to' attribute, the gateway MUST remove the "im:" Instant Messaging
   URI scheme from the front of the address and MUST remove the CPIM
   "Formal-name" (if provided).  If the gateway possesses knowledge of
   the resource identifier in use by the XMPP entity, the gateway MAY
   append the resource identifier to the address.












<span class="grey">Saint-Andre                 Standards Track                    [Page 20]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


   Example: To Address Mapping

   CPIM 'To' header
     To: Juliet Capulet &lt;im:juliet@example.com&gt;

   XMPP 'to' attribute
     &lt;presence to='juliet@example.com/balcony'&gt;
       ...
     &lt;/presence&gt;

<span class="h4"><a class="selflink" id="section-5.2.3" href="#section-5.2.3">5.2.3</a>.  Courtesy Copy</span>

   The core XMPP specification does not include syntax for specifying a
   "courtesy copy" (non-primary addressee) for a presence stanza.
   Therefore, if an XMPP-CPIM gateway receives a "Message/CPIM" object
   with encapsulated PIDF object that contains a 'cc' header, it SHOULD
   NOT pass the information contained in that header on to the XMPP
   recipient.

<span class="h4"><a class="selflink" id="section-5.2.4" href="#section-5.2.4">5.2.4</a>.  DateTime Header</span>

   The core XMPP specification does not include syntax for specifying
   the datetime at which a presence stanza was sent.  Therefore, if an
   XMPP-CPIM gateway receives a "Message/CPIM" object with encapsulated
   PIDF object that contains a 'DateTime' header, it SHOULD NOT pass the
   information contained in that header on to the XMPP recipient.

<span class="h4"><a class="selflink" id="section-5.2.5" href="#section-5.2.5">5.2.5</a>.  Subject Header</span>

   An XMPP presence stanza contains no information that can be mapped to
   the 'Subject' header of a "Message/CPIM" object.  Therefore, if an
   XMPP-CPIM gateway receives a "Message/CPIM" object with encapsulated
   PIDF object that contains a 'Subject' header, it SHOULD NOT pass the
   information contained in that header on to the XMPP recipient.

<span class="h4"><a class="selflink" id="section-5.2.6" href="#section-5.2.6">5.2.6</a>.  Header Extensions</span>

   "Message/CPIM" objects MAY include an optional 'NS' header to specify
   the namespace of a feature extension.  An XMPP-CPIM gateway MUST NOT
   pass such headers through to the XMPP recipient, and no mapping for
   such headers is defined.

<span class="h4"><a class="selflink" id="section-5.2.7" href="#section-5.2.7">5.2.7</a>.  Require Header</span>

   "Message/CPIM" objects MAY include an optional 'Require' header to
   specify mandatory-to-recognize features.  An XMPP-CPIM gateway MUST
   NOT pass such headers through to the XMPP recipient, and no mapping
   for such headers is defined.



<span class="grey">Saint-Andre                 Standards Track                    [Page 21]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


<span class="h4"><a class="selflink" id="section-5.2.8" href="#section-5.2.8">5.2.8</a>.  MIME Content-ID</span>

   XMPP does not include an element or attribute that captures a
   globally unique ID as is defined for the Content-ID MIME header as
   specified in [<a href="#ref-MIME" title="&quot;Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies&quot;">MIME</a>].  If an XMPP-CPIM gateway receives a MIME object
   that includes a Content-ID, it MAY provide the Content-ID as the
   value of the presence stanza's 'id' attribute, but this is OPTIONAL.

   Example: Content-ID for Encapsulated Object

   MIME header
     Content-ID: &lt;123456789@example.net&gt;

   XMPP 'id' attribute (OPTIONAL)
     &lt;presence id='123456789@example.net'&gt;
       ...
     &lt;/presence&gt;

<span class="h4"><a class="selflink" id="section-5.2.9" href="#section-5.2.9">5.2.9</a>.  Basic Presence Status</span>

   The basic presence status types defined in PIDF are OPEN and CLOSED.
   The PIDF basic presence status of OPEN maps to an XMPP presence
   stanza that possesses no 'type' attribute (indicating default
   availability).  The PIDF basic presence status of CLOSED maps to an
   XMPP presence stanza that possesses a 'type' attribute with a value
   of "unavailable".

   Example: OPEN Presence

   PIDF basic presence (OPEN)
     &lt;?xml version='1.0' encoding='UTF-8'?&gt;
     &lt;presence xmlns='urn:ietf:params:xml:ns:pidf'
               entity='pres:romeo@example.net'&gt;
       &lt;tuple id='orchard'&gt;
         &lt;status&gt;
           &lt;basic&gt;open&lt;/basic&gt;
         &lt;/status&gt;
       &lt;/tuple&gt;
     &lt;/presence&gt;

   XMPP available presence
     &lt;presence from='romeo@example.net/orchard'/&gt;









<span class="grey">Saint-Andre                 Standards Track                    [Page 22]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


   Example: CLOSED Presence

   PIDF basic presence (CLOSED)
     &lt;?xml version='1.0' encoding='UTF-8'?&gt;
     &lt;presence xmlns='urn:ietf:params:xml:ns:pidf'
               entity='pres:romeo@example.net'&gt;
       &lt;tuple id='orchard'&gt;
         &lt;status&gt;
           &lt;basic&gt;closed&lt;/basic&gt;
         &lt;/status&gt;
       &lt;/tuple&gt;
     &lt;/presence&gt;

   XMPP unavailable presence
     &lt;presence from='romeo@example.net/orchard'
               type='unavailable'/&gt;

<span class="h4"><a class="selflink" id="section-5.2.10" href="#section-5.2.10">5.2.10</a>.  Extended Status Information</span>

   PIDF documents may contain extended &lt;status/&gt; content.  As of this
   writing there are no pre-defined extended status states that can be
   mapped to the defined values of the XMPP &lt;show/&gt; element ('away',
   'chat', 'dnd', and 'xa').  Once PIDF extensions for such extended
   status states are defined within the Internet Standards Process, a
   gateway SHOULD map those extensions; however, any such mapping is out
   of scope for this memo, since the relevant PIDF extensions have not
   yet been defined.

   Example: Extended Status Information (provisional)

   PIDF extended presence information
     &lt;?xml version='1.0' encoding='UTF-8'?&gt;
     &lt;presence xmlns='urn:ietf:params:xml:ns:pidf'
               xmlns:im='urn:ietf:params:xml:ns:pidf:im'
               entity='pres:romeo@example.net'&gt;
       &lt;tuple id='orchard'&gt;
         &lt;status&gt;
           &lt;basic&gt;open&lt;/basic&gt;
           &lt;im:im&gt;busy&lt;/im:im&gt;
         &lt;/status&gt;
       &lt;/tuple&gt;
     &lt;/presence&gt;

   XMPP &lt;show/&gt; element
     &lt;presence from='romeo@example.net/orchard'&gt;
       &lt;show&gt;dnd&lt;/show&gt;
     &lt;/presence&gt;




<span class="grey">Saint-Andre                 Standards Track                    [Page 23]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


<span class="h4"><a class="selflink" id="section-5.2.11" href="#section-5.2.11">5.2.11</a>.  Note Element</span>

   A PIDF &lt;tuple/&gt; element may contain a &lt;note/&gt; child that provides a
   user-defined, natural-language description of the sender's detailed
   availability state.  The PIDF &lt;note/&gt; element maps to the XMPP
   &lt;status/&gt; element.

   Example: Note Element

   PIDF &lt;note/&gt; element
     &lt;?xml version='1.0' encoding='UTF-8'?&gt;
     &lt;presence xmlns='urn:ietf:params:xml:ns:pidf'
               xmlns:im='urn:ietf:params:xml:ns:pidf:im'
               entity='pres:romeo@example.net'&gt;
       &lt;tuple id='orchard'&gt;
         &lt;status&gt;
           &lt;basic&gt;open&lt;/basic&gt;
           &lt;im:im&gt;busy&lt;/im:im&gt;
         &lt;/status&gt;
         &lt;note&gt;Wooing Juliet&lt;/note&gt;
       &lt;/tuple&gt;
     &lt;/presence&gt;

   XMPP &lt;status/&gt; element
     &lt;presence from='romeo@example.net/orchard'&gt;
       &lt;show&gt;dnd&lt;/show&gt;
       &lt;status&gt;Wooing Juliet&lt;/status&gt;
     &lt;/presence&gt;

   A PIDF document with zero tuples MAY contain one or more &lt;note/&gt;
   elements as direct children of the PIDF &lt;presence/&gt; element.  There
   is no mapping of such a PIDF document to an XMPP presence stanza; an
   entity on the non-XMPP side of an XMPP-CPIM gateway SHOULD NOT send
   such a PIDF document to an XMPP recipient if possible, and an
   XMPP-CPIM gateway MUST NOT map such a PIDF document to an XMPP
   presence stanza (see Zero Resources (<a href="#section-6.3.2">Section 6.3.2</a>)).

<span class="h4"><a class="selflink" id="section-5.2.12" href="#section-5.2.12">5.2.12</a>.  Contact Element</span>

   A PIDF document may contain a &lt;contact/&gt; element specifying the URI
   of an address at which the principal can be contacted (e.g., an im:,
   tel:, or mailto: URI).  The core XMPP specification does not include
   syntax for specifying the URI of a contact address, since the contact
   address is implicit in the 'from' attribute of the XMPP presence
   stanza.  Therefore, if an XMPP-CPIM gateway receives a "Message/CPIM"
   object with encapsulated PIDF object that contains a &lt;contact/&gt;





<span class="grey">Saint-Andre                 Standards Track                    [Page 24]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


   element, it SHOULD NOT pass the XML character data of the &lt;contact/&gt;
   element on to the XMPP recipient.  (However, see Inclusion of
   Complete PIDF Document (<a href="#section-5.2.15">Section 5.2.15</a>) below.)

   Example: PIDF Contact Element

   PIDF &lt;contact/&gt; element
     &lt;?xml version='1.0' encoding='UTF-8'?&gt;
     &lt;presence xmlns='urn:ietf:params:xml:ns:pidf'
               entity='pres:romeo@example.net'&gt;
       &lt;tuple id='orchard'&gt;
         ...
         &lt;contact&gt;im:romeo@example.net&lt;/contact&gt;
       &lt;/tuple&gt;
     &lt;/presence&gt;

   XMPP presence stanza
     &lt;presence from='romeo@example.net/orchard'/&gt;

<span class="h4"><a class="selflink" id="section-5.2.13" href="#section-5.2.13">5.2.13</a>.  Presence Priority</span>

   The &lt;contact/&gt; child of the PIDF &lt;tuple/&gt; element MAY possess a
   'priority' attribute whose value is a decimal number between zero and
   one (with a maximum of three decimal places).  The value of this
   attribute MAY be mapped to the &lt;priority/&gt; child element of an XMPP
   presence stanza.  An XMPP-CPIM gateway MUST NOT map PIDF priority
   values to negative values of the XMPP &lt;priority/&gt; element.  If an
   XMPP-CPIM gateway maps these values, it SHOULD treat PIDF
   priority='0' as XMPP &lt;priority&gt;0&lt;/priority&gt; and PIDF priority='1' as
   &lt;priority&gt;127&lt;/priority&gt;, mapping intermediate values appropriately
   so that they are unique (e.g., PIDF priorities between 0.001 and
   0.007 to XMPP priority 1, PIDF priorities between 0.008 and 0.015 to
   XMPP priority 2, and so on up through mapping PIDF priorities between
   0.992 and 0.999 to XMPP priority 126; note that this is an example
   only, and that the exact mapping shall be determined by the XMPP-CPIM
   gateway).

<span class="h4"><a class="selflink" id="section-5.2.14" href="#section-5.2.14">5.2.14</a>.  Timestamp Element</span>

   The core XMPP specification does not include syntax for specifying
   the datetime or timestamp at which a presence stanza was sent.
   Therefore, if an XMPP-CPIM gateway receives a "Message/CPIM" object
   with encapsulated PIDF object that contains a &lt;timestamp/&gt; element,
   it SHOULD NOT pass the XML character data of the &lt;timestamp/&gt; element
   on to the XMPP recipient.






<span class="grey">Saint-Andre                 Standards Track                    [Page 25]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


<span class="h4"><a class="selflink" id="section-5.2.15" href="#section-5.2.15">5.2.15</a>.  Inclusion of Complete PIDF Document</span>

   Certain PIDF elements do not map to XMPP presence stanza syntax
   (e.g., the XML character data of the &lt;contact/&gt; element).  However,
   an XMPP client may be able to handle such information by parsing a
   native PIDF document.  To make this possible, an XMPP-CPIM gateway
   MAY include the complete PIDF document as a child element of the
   presence stanza, as described in [<a href="#ref-XMPP-PIDF" title="&quot;Transporting Presence Information Data/Format (PIDF) over the Extensible Messaging and Presence Protocol (XMPP)&quot;">XMPP-PIDF</a>].  If an XMPP client does
   not understand this extended data, it naturally MUST ignore it.

<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>.  XMPP-CPIM Gateway as Presence Service</span>

   [<a id="ref-CPP">CPP</a>] defines semantics for an abstract presence service.  An
   XMPP-CPIM gateway MAY function as such a presence service, and if so
   an XMPP entity can use defined XMPP syntax to interact with the
   gateway's presence service.  Because [<a href="#ref-PIDF" title="&quot;Presence Information Data Format (PIDF)&quot;">PIDF</a>] does not specify syntax
   for semantic operations such as subscribe, this section defines only
   the XMPP interactions with the presence service offered by an
   XMPP-CPIM gateway, not the translation of such XMPP syntax into PIDF.
   (Note: Detailed information about XMPP presence services can be found
   in [<a href="#ref-XMPP-IM" title="&quot;Extensible Messaging and Presence Protocol (XMPP): Instant Messaging and Presence&quot;">XMPP-IM</a>]; as much as possible, an XMPP-CPIM gateway SHOULD
   implement the syntax, semantics, and server business rules defined
   therein.)

<span class="h3"><a class="selflink" id="section-6.1" href="#section-6.1">6.1</a>.  Requesting a Subscription</span>

   If an XMPP entity wants to subscribe to the presence information of a
   non-XMPP presentity through an XMPP-CPIM gateway, it MUST send a
   presence stanza of type "subscribe" to the target presentity.  The
   syntax mapping is as follows:

   o  The XMPP 'from' attribute (user@host) MUST be mapped to the CPP
      "watcher parameter" field (pres:user@host).  The XMPP-CPIM gateway
      MUST append the "pres:" Presence URI scheme to the front of the
      address.

   o  The XMPP 'to' attribute (user@host) MUST be mapped to the CPP
      "target parameter" field (pres:user@host).  The XMPP-CPIM gateway
      MUST append the "pres:" Presence URI scheme to the front of the
      address.

   o  There is no XMPP mapping for the CPP "duration parameter", since
      XMPP subscriptions are active until they have been explicitly
      "unsubscribed".

   o  The XMPP 'id' attribute SHOULD be mapped to the CPP "TransID"
      field.




<span class="grey">Saint-Andre                 Standards Track                    [Page 26]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


   If the target presentity approves the subscription request (through
   whatever protocol it uses to interact with the gateway), the
   XMPP-CPIM gateway MUST return a presence stanza of type "subscribed"
   to the XMPP entity and notify the XMPP entity of the target's current
   available presence.  Thereafter, until the subscription is cancelled,
   the gateway MUST notify the subscribing XMPP entity every time the
   target's presence information changes.

   If the target presentity denies the subscription request, the
   XMPP-CPIM gateway MUST return a presence stanza of type
   "unsubscribed" to the XMPP entity and MUST NOT invoke the notify
   operation.

   In addition to the approval and denial cases, one of the following
   exceptions may occur:

   o  The target parameter (XMPP "to" address) does not refer to a valid
      presentity; if this exception occurs, the XMPP-CPIM gateway MUST
      return an &lt;item-not-found/&gt; stanza error to the XMPP entity.

   o  Access control rules do not permit the entity to subscribe to the
      target; if this exception occurs, the XMPP-CPIM gateway MUST
      return a &lt;forbidden/&gt; stanza error to the XMPP entity.

   o  There exists a pre-existing subscription or in-progress subscribe
      operation between the XMPP entity and the target presentity; if
      this exception occurs, the XMPP-CPIM gateway SHOULD return a
      &lt;conflict/&gt; stanza error to the XMPP entity.

   XMPP services assume that a subscription is active until it is
   explicitly terminated.  However, non-XMPP services may implement
   subscriptions of limited duration, which must be periodically
   refreshed in order to mimic the permanence of XMPP subscriptions.
   Therefore, an XMPP-to-CPIM gateway may need to send such refreshes to
   the non-XMPP entity on behalf of the XMPP entity to that the
   subscription does not expire.  Whether such refreshes are necessary
   depends on the native protocol implemented by the CPIM-aware non-XMPP
   service to which the gateway is translating.

<span class="h3"><a class="selflink" id="section-6.2" href="#section-6.2">6.2</a>.  Receiving a Subscription Request</span>

   If a non-XMPP presentity wants to subscribe to the presence
   information of an XMPP entity through an XMPP-CPIM gateway, it MUST
   use whatever protocol it uses to interact with the gateway in order
   to request the subscription; subject to local access rules, the
   gateway MUST then send a presence stanza of type "subscribe" to the
   XMPP entity from the non-XMPP watcher.  The syntax mapping is as
   follows:



<span class="grey">Saint-Andre                 Standards Track                    [Page 27]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


   o  The CPP "watcher parameter" field (pres:user@host) MUST be mapped
      to the XMPP 'from' attribute (user@host).  The XMPP-CPIM gateway
      MUST remove the "pres:" Presence URI scheme from the front of the
      address.

   o  The CPP "target parameter" field (pres:user@host) MUST be mapped
      to the XMPP 'to' attribute (user@host).  The XMPP-CPIM gateway
      MUST remove the "pres:" Presence URI scheme from the front of the
      address.

   o  There is no XMPP mapping for the CPP "duration parameter", since
      XMPP subscriptions are active until they have been explicitly
      "unsubscribed".

   o  The CPP "TransID" field SHOULD be mapped to the XMPP 'id'
      attribute.

   If the target XMPP entity approves the subscription request, it MUST
   send a presence stanza of type "subscribed" to the watcher
   presentity.  The XMPP-CPIM gateway MUST then notify the watcher
   presentity of the target XMPP entity's current available presence.
   Thereafter, until the subscription is cancelled, the gateway MUST
   notify the watcher presentity every time the target's presence
   information changes.

   If the target XMPP entity denies the subscription request, it MUST
   send a presence stanza of type "unsubscribed" to the watcher
   presentity.  The XMPP-CPIM gateway MUST NOT invoke the notify
   operation.

   In addition to the approval and denial cases, one of the following
   exceptions MAY occur:

   o  The target parameter (XMPP "to" address) does not refer to a valid
      XMPP entity

   o  Access control rules do not permit the watcher presentity to
      subscribe to the target XMPP entity

   o  There exists a pre-existing subscription or in-progress subscribe
      operation between the watcher presentity and the target XMPP
      entity

   If any of these exceptions occurs, the XMPP-CPIM gateway MUST inform
   the watcher presentity of failure.






<span class="grey">Saint-Andre                 Standards Track                    [Page 28]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


   XMPP services assume that a subscription is active until it is
   explicitly terminated.  With the exception of handling duration
   parameters whose value is zero, handling duration parameters will be
   highly dependent on the implementation and requirements of the
   XMPP-CPIM gateway.  Since there are no explicit requirements for
   supporting a "duration parameter" specified in either [<a href="#ref-IMP-MODEL" title="&quot;A Model for Presence and Instant Messaging&quot;">IMP-MODEL</a>] or
   [<a href="#ref-IMP-REQS" title="&quot;Instant Messaging / Presence Protocol Requirements&quot;">IMP-REQS</a>], duration parameter mapping is a local issue that falls
   outside the scope of this memo.  However, an XMPP-CPIM gateway MAY
   keep track of the duration parameter if received from an entity on
   the non-XMPP service and delete the subscription after that duration
   parameter expires.

<span class="h3"><a class="selflink" id="section-6.3" href="#section-6.3">6.3</a>.  The Notify Operation</span>

   An XMPP-CPIM gateway invokes the CPP "notify operation" whenever the
   presence information associated with an XMPP entity or CPP presentity
   changes and there are subscribers to that information on the other
   side of the gateway.  The syntax mapping for presence information
   related to a notify operation is defined under Mapping for Presence
   (<a href="#section-5">Section 5</a>).

<span class="h4"><a class="selflink" id="section-6.3.1" href="#section-6.3.1">6.3.1</a>.  Multiple Resources</span>

   Semantically, PIDF contains the notion of multiple presence "tuples".
   Normally, a PIDF document will contain at least one tuple but MAY
   contain more than one tuple (or zero tuples, for which see next
   section).  In the terminology of XMPP, each tuple would map to
   presence information for a separate resource.  However, XMPP does not
   include the ability to send presence information about more than one
   resource at a time, since the resource that generates the presence
   information is contained in the 'from' address of a presence stanza.
   Therefore, an XMPP-CPIM gateway that acts as a presence service
   SHOULD split a PIDF document that contains multiple tuples into
   multiple XMPP presence stanzas, and SHOULD generate only one PIDF
   document (with multiple tuples) if an XMPP user currently has
   multiple connected resources.

   In the interest of not multiplying XMPP stanzas beyond necessity, an
   XMPP-CPIM gateway SHOULD generate an XMPP presence stanza only if the
   presence information contained in a PIDF tuple communicates a change
   in the availability status of the device or application associated
   with that tuple ID.

   In the interest of complying with the PIDF recommendation to provide
   information about multiple "resources" in multiple tuples rather than
   in multiple PIDF documents, an XMPP-CPIM gateway SHOULD include





<span class="grey">Saint-Andre                 Standards Track                    [Page 29]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


   information about all of an XMPP user's resources in one PIDF
   document (with one tuple for each resource), even if the availability
   status of only one resource has changed.

<span class="h4"><a class="selflink" id="section-6.3.2" href="#section-6.3.2">6.3.2</a>.  Zero Resources</span>

   A PIDF document may contain zero tuples.  For example:

   PIDF Document with Zero Tuples

     &lt;presence entity='pres:juliet@example.com'
               xmlns='urn:ietf:params:xml:ns:pidf'/&gt;

   Because (1) the 'entity' attribute of a PIDF &lt;presence/&gt; element maps
   to the &lt;user@host&gt; portion of an XMPP address and (2) the 'id'
   attribute of a PIDF &lt;tuple/&gt; element maps to the resource identifier
   portion of an XMPP address, a PIDF document that contains zero tuples
   would provide presence information about a &lt;user@host&gt; rather than a
   &lt;user@host/resource&gt; when mapped to XMPP.  Although the notion of
   presence notifications about a mere user rather than one of the
   user's resources is nearly meaningless in the XMPP context, an
   XMPP-CPIM gateway SHOULD map a PIDF document with zero tuples to an
   XMPP presence stanza whose 'from' address is the user@host of the
   non-XMPP entity.  However, an XMPP-CPIM gateway MUST NOT generate a
   PIDF document with zero &lt;tuple/&gt; children when receiving a presence
   stanza from an XMPP entity (i.e., all PIDF documents communicated by
   the gateway to a non-XMPP service MUST contain at least one &lt;tuple/&gt;
   element).

<span class="h3"><a class="selflink" id="section-6.4" href="#section-6.4">6.4</a>.  Unsubscribing</span>

   If an XMPP entity wants to unsubscribe from the presence of a
   non-XMPP presentity through an XMPP-CPIM gateway, it MUST send a
   presence stanza of type "unsubscribe" to the target presentity.  The
   syntax mapping is as follows:

   o  The XMPP 'from' attribute (user@host) MUST be mapped to the CPP
      "watcher parameter" field (pres:user@host).  The XMPP-CPIM gateway
      MUST append the "pres:" Presence URI scheme to the front of the
      address.

   o  The XMPP 'to' attribute (user@host) MUST be mapped to the CPP
      "target parameter" field (pres:user@host).  The XMPP-CPIM gateway
      MUST append the "pres:" Presence URI scheme to the front of the
      address.

   o  The CPP "duration parameter" MUST be set to zero.




<span class="grey">Saint-Andre                 Standards Track                    [Page 30]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-31" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


   o  The XMPP 'id' attribute SHOULD be mapped to the CPP "TransID"
      field.

   If the target parameter (XMPP "to" address) does not refer to a valid
   presentity, the XMPP-CPIM gateway MUST return an &lt;item-not-found/&gt;
   stanza error to the XMPP entity.

   Upon receiving the presence stanza of type "unsubscribe" from the
   XMPP entity, the XMPP-CPIM gateway MUST NOT send further presence
   notifications to the XMPP entity.

<span class="h3"><a class="selflink" id="section-6.5" href="#section-6.5">6.5</a>.  Cancelling a Subscription</span>

   If an XMPP entity wants to cancel a non-XMPP presentity's
   subscription to the entity's presence through an XMPP-CPIM gateway,
   it MUST send a presence stanza of type "unsubscribed" to the target
   presentity.  The syntax mapping is as follows:

   o  The XMPP 'from' attribute (user@host) MUST be mapped to the CPP
      "watcher parameter" field (pres:user@host).  The XMPP-CPIM gateway
      MUST add the "pres:" Presence URI scheme to the front of the
      address.

   o  The XMPP 'to' attribute (user@host) MUST be mapped to the CPP
      "target parameter" field (pres:user@host).  The XMPP-CPIM gateway
      MUST add the "pres:" Presence URI scheme to the front of the
      address.
   o  The CPP "duration parameter" MUST be set to zero.

   o  The XMPP 'id' attribute SHOULD be mapped to the CPP "TransID"
      field.

   Upon receiving the presence stanza of type "unsubscribed" from the
   XMPP entity, the XMPP-CPIM gateway MUST NOT send further presence
   notifications to the watcher presentity.

<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>.  Security Considerations</span>

   Detailed security considerations for instant messaging and presence
   protocols are given in [<a href="#ref-IMP-REQS" title="&quot;Instant Messaging / Presence Protocol Requirements&quot;">IMP-REQS</a>], specifically in Sections <a href="#section-5.1">5.1</a>
   through 5.4.

   This document specifies methods for exchanging instant messages and
   presence information through a gateway that implements [<a href="#ref-CPIM" title="&quot;Common Profile for Instant Messaging (CPIM)&quot;">CPIM</a>] and
   [<a href="#ref-CPP" title="&quot;Common Profile for Presence (CPP)&quot;">CPP</a>].  Such a gateway MUST be compliant with the minimum security
   requirements of the instant messaging and presence protocols with
   which it interfaces.  The introduction of gateways to the security
   model of instant messaging and presence in <a href="./rfc2779">RFC 2779</a> also introduces



<span class="grey">Saint-Andre                 Standards Track                    [Page 31]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-32" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


   some new risks.  In particular, end-to-end security properties
   (especially confidentiality and integrity) between instant messaging
   and presence user agents that interface through an XMPP-CPIM gateway
   can be provided only if common formats are supported; these formats
   are specified fully in [<a href="#ref-XMPP-E2E" title="&quot;End-to-End Signing and Object Encryption in the Extensible Messaging and Presence Protocol (XMPP)&quot;">XMPP-E2E</a>].

<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>.  References</span>

<span class="h3"><a class="selflink" id="section-8.1" href="#section-8.1">8.1</a>.  Normative References</span>

   [<a id="ref-CPIM">CPIM</a>]       Peterson, J., "Common Profile for Instant Messaging
                (CPIM)", <a href="./rfc3860">RFC 3860</a>, August 2004.

   [<a id="ref-CPP">CPP</a>]        Peterson, J., "Common Profile for Presence (CPP)", <a href="./rfc3859">RFC</a>
                <a href="./rfc3859">3859</a>, August 2004.

   [<a id="ref-IMP-MODEL">IMP-MODEL</a>]  Day, M., Rosenberg, J., and H. Sugano, "A Model for
                Presence and Instant Messaging", <a href="./rfc2778">RFC 2778</a>, February
                2000.

   [<a id="ref-IMP-REQS">IMP-REQS</a>]   Day, M., Aggarwal, S., Mohr, G., and J. Vincent,
                "Instant Messaging / Presence Protocol Requirements",
                <a href="./rfc2779">RFC 2779</a>, February 2000.

   [<a id="ref-MIME">MIME</a>]       Freed, N. and N. Borenstein, "Multipurpose Internet Mail
                Extensions (MIME) Part One: Format of Internet Message
                Bodies", <a href="./rfc2045">RFC 2045</a>, November 1996.

   [<a id="ref-MSGFMT">MSGFMT</a>]     Klyne, G. and D. Atkins, "Common Presence and Instant
                Messaging (CPIM): Message Format", <a href="./rfc3862">RFC 3862</a>, August
                2004.

   [<a id="ref-PIDF">PIDF</a>]       Sugano, H., Fujimoto, S., Klyne, G., Bateman, A., Carr,
                W., and J. Peterson, "Presence Information Data Format
                (PIDF)", <a href="./rfc3863">RFC 3863</a>, August 2004.

   [<a id="ref-STRINGPREP">STRINGPREP</a>] Hoffman, P. and M. Blanchet, "Preparation of
                Internationalized Strings (stringprep)", <a href="./rfc3454">RFC 3454</a>,
                December 2002.

   [<a id="ref-TERMS">TERMS</a>]      Bradner, S., "Key words for use in RFCs to Indicate
                Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>, March 1997.

   [<a id="ref-URL-GUIDE">URL-GUIDE</a>]  Masinter, L., Alvestrand, H., Zigmond, D., and R. Petke,
                "Guidelines for new URL Schemes", <a href="./rfc2718">RFC 2718</a>, November
                1999.





<span class="grey">Saint-Andre                 Standards Track                    [Page 32]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-33" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


   [<a id="ref-US-ASCII">US-ASCII</a>]   Cerf, V., "ASCII format for network interchange", <a href="./rfc20">RFC</a>
                <a href="./rfc20">20</a>, October 1969.

   [<a id="ref-UTF-8">UTF-8</a>]      Yergeau, F., "UTF-8, a transformation format of ISO
                10646", STD 63, <a href="./rfc3629">RFC 3629</a>, November 2003.

   [<a id="ref-XMPP-CORE">XMPP-CORE</a>]  Saint-Andre, P., Ed., "Extensible Messaging and Presence
                Protocol (XMPP): Core", <a href="./rfc3920">RFC 3920</a>, October 2004.

   [<a id="ref-XMPP-E2E">XMPP-E2E</a>]   Saint-Andre, P., Ed., "End-to-End Signing and Object
                Encryption in the Extensible Messaging and Presence
                Protocol (XMPP)", <a href="./rfc3923">RFC 3923</a>, October 2004.

   [<a id="ref-XMPP-IM">XMPP-IM</a>]    Saint-Andre (ed.), P., "Extensible Messaging and
                Presence Protocol (XMPP): Instant Messaging and
                Presence", <a href="./rfc3921">RFC 3921</a>, October 2004.

<span class="h3"><a class="selflink" id="section-8.2" href="#section-8.2">8.2</a>.  Informative References</span>

   [<a id="ref-RFC2822">RFC2822</a>]    Resnick, P., Ed., "Internet Message Format", <a href="./rfc2822">RFC 2822</a>,
                April 2001.

   [<a id="ref-MIMETYPES">MIMETYPES</a>]  Freed, N. and N. Borenstein, "Multipurpose Internet Mail
                Extensions (MIME) Part Two: Media Types", <a href="./rfc2046">RFC 2046</a>,
                November 1996.

   [<a id="ref-XMPP-PIDF">XMPP-PIDF</a>]  Saint-Andre, P., "Transporting Presence Information
                Data/Format (PIDF) over the Extensible Messaging and
                Presence Protocol (XMPP)", Work in Progress, February
                2004.

Author's Address

   Peter Saint-Andre
   Jabber Software Foundation

   EMail: stpeter@jabber.org














<span class="grey">Saint-Andre                 Standards Track                    [Page 33]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-34" ></span>
<span class="grey"><a href="./rfc3922">RFC 3922</a>                      XMPP to CPIM                  October 2004</span>


Full Copyright Statement

   Copyright (C) The Internet Society (2004).

   This document is subject to the rights, licenses and restrictions
   contained in <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a>, and except as set forth therein, the authors
   retain all their rights.

   This document and the information contained herein are provided on an
   "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/S HE
   REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE
   INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR
   IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF
   THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
   WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Intellectual Property

   The IETF takes no position regarding the validity or scope of any
   Intellectual Property Rights or other rights that might be claimed to
   pertain to the implementation or use of the technology described in
   this document or the extent to which any license under such rights
   might or might not be available; nor does it represent that it has
   made any independent effort to identify any such rights.  Information
   on the IETF's procedures with respect to rights in IETF Documents can
   be found in <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and <a href="https://www.rfc-editor.org/bcp/bcp79">BCP 79</a>.

   Copies of IPR disclosures made to the IETF Secretariat and any
   assurances of licenses to be made available, or the result of an
   attempt made to obtain a general license or permission for the use of
   such proprietary rights by implementers or users of this
   specification can be obtained from the IETF on-line IPR repository at
   <a href="http://www.ietf.org/ipr">http://www.ietf.org/ipr</a>.

   The IETF invites any interested party to bring to its attention any
   copyrights, patents or patent applications, or other proprietary
   rights that may cover technology that may be required to implement
   this standard.  Please address the information to the IETF at ietf-
   ipr@ietf.org.

Acknowledgement

   Funding for the RFC Editor function is currently provided by the
   Internet Society.







Saint-Andre                 Standards Track                    [Page 34]
</pre>