%ents; ]>
User Avatar This document defines an XMPP protocol extension for exchanging user avatars, which are small images or icons associated with human users. The protocol specifies payload formats for both avatar metadata and the image data itself. The payload formats are typically transported using the personal eventing profile of XMPP publish-subscribe as specified in XEP-0163. &LEGALNOTICE; 0084 Draft Standards Track Standards XMPP Core XEP-0030 XEP-0060 XEP-0163 XEP-0008 XEP-0153 avatar data http://www.xmpp.org/schemas/avatar-data.xsd metadata http://www.xmpp.org/schemas/avatar-metadata.xsd &stpeter; &pgmillard; &temas; &xvirge; 1.1.2 2019-01-27 egp

Bump the maximum value 'width' and 'height' attributes from 255 to 65535 in the schema, to accomodate current usage.

 1.1.1 2016-07-09 XEP Editor: ssw

Fix namespace in example (thanks to Huan Nguyen for pointing out the error).

 1.1 2008-11-05 psa

For consistency with other PEP payload formats, changed stop semantics to use an empty <metadata/> element rather than a <stop/> child element.

 1.0 2007-11-07 psa

Per a vote of the XMPP Council, advanced status to Draft; concurrently, the XMPP Registrar issued the urn:xmpp:avatar:data and urn:xmpp:avatar:metadata namespaces.

 0.12 2007-08-31 psa

Clarified HTTP publishing; completed copy edit.

 0.11 2007-07-25 psa

Removed image size requirements.

 0.10 2007-06-18 psa

Changed height and width attributes from required to recommended; updated security considerations to reflect problems with SHA-1; further specified datatypes.

 0.9 2007-02-01 psa

Updated to reflect pubsub and PEP changes; added implementation notes about multiple resources and avatar synchronization; modified experimental namespaces to conform to XEP-0053.

 0.8 2006-06-19 psa

Updated to reflect pubsub and PEP changes; added implementation notes about multiple resources and avatar synchronization.

 0.7 2006-01-17 psa

Updated to use PEP.

 0.6 2005-04-13 psa

Major modification per list discussion: specified that metadata may include the same avatar in multiple alternate formats; allowed pointers to third-party avatars not available via pubsub or HTTP; changed pixel size restrictions; specified that bytes, content-type, height, id, and width are required metadata; changed type attribute to content-type; made explicit that URLs can be http: or https: URIs; more fully specified protocol, updated the examples, updated the schemas.

 0.5 2005-03-28 psa/pgm

Friendly fork per Council discussion: allowed data to be stored in a pubsub data repository or at a URL accessible via HTTP; also split text into publisher and subscriber use cases, specified requirements, added more examples, etc.

 0.4 2003-05-20 tjm

Lessen the image requirements. Include the content type in info.

 0.3 2003-05-08 tjm

Drastic change to use two nodes on pubsub, allowing for hash updates independently of the data. This makes client caching much easier. Allow only PNG and MNG currently.

 0.2 2003-05-07 tjm

Clarified the use of "current" as the item id. Fixed some example errors. Made the interaction with disco more clear. The reason to use pubsub is made more clear as well.

 0.1 2003-05-07 tjm

Initial version.

Many communication applications allow for the association of a small image or icon with a user of that application. Usually, such an "avatar" is not intended to be an accurate picture of the user's actual physical appearance, but rather a representation (often fanciful) of the user's desired self-image or a transient state of the user (such as a mood or activity). This document defines a way to incorporate avatars into current Jabber/XMPP systems by layering this functionality on top of the XMPP &xep0060; extension ("pubsub"), specifically the &xep0163; subset ("PEP"), which is designed for use in the context of XMPP instant messaging and presence systems that conform to &rfc3921;.

The protocol defined herein uses two pubsub nodes: one node for "metadata" about the avatar state (called the "metadata node") and one for the avatar data itself (called the "data node"). This separation of metadata from data conserves bandwidth and enables both the publisher and the subscriber to cache the avatar data. (For example, a user might toggle between two or three avatars, in which case the user's contacts can display a locally cached version of the images without having to retrieve or receive the full image each time.)

This protocol also allows storage of avatar data at a URL accessible via HTTP (see &rfc2616;). By "accessible via HTTP" is meant that the data is available at an http: or https: URI. This can be helpful as a fallback mechanism if a pubsub-aware data repository is not available. It also makes it possible for avatar images to be hosted on public websites (e.g., an end-user-oriented community site) and retrieved from that site rather than handled directly by the publishing client in any fashion.

Finally, this protocol also enables XMPP applications to optionally integrate with third-party services that host user avatars (e.g., online gaming systems and virtual worlds).

It is intended that this specification will supersede both &xep0008; and &xep0153; once the PEP subset of XMPP publish-subscribe is implemented and deployed widely enough.

This document addresses the following use cases for avatar publishers:

  1. Publishing avatar data
  2. Updating metadata about the current avatar
  3. Disabling avatars

This document addresses the following use cases for avatar subscribers:

  1. Discovering avatar availability
  2. Receiving notification of avatar changes
  3. Retrieving avatar data via pubsub
  4. Retrieving avatar data via HTTP

The process for publishing and updating user avatars is as follows:

  1. User publishes avatar data for "image/png" content-type to data node and optionally publishes other content-types to HTTP URLs.
  2. User publishes notification of updated avatar to metadata node, with ItemID that matches SHA-1 hash of image data for "image/png" content-type (note: this is a hash of the image data itself, not the base64-encoded version).
  3. Subscribers receive notification.
  4. Optionally (and if necessary), subscribers retrieve avatar data identified by ItemID from data node using pubsub retrieve-items feature (or via HTTP).
  5. Optionally, user disables avatar display.

This process flow is described more fully in the following sections.

Note: Before publishing avatar data and metadata, the user MUST determine if his or her server supports the PEP subset of pubsub by following the procedures specified in XEP-0163, since such support simplifies avatar publication. The following examples assume the availability of a PEP service.

Before updating the avatar metadata node, the publisher MUST make sure that the avatar data is available at the data node or URL. When publishing the avatar data to the data node, the publisher MUST ensure that the value of the pubsub ItemID is a SHA-1 hash of the data for the "image/png" content-type (this is used by the subscriber to determine if a locally cached copy can be displayed).

The following example illustrates the XML structure to be sent when publishing avatar data to the data node.

qANQR1DBwU4DX7jmYZnncm... ]]> ]]>

If the avatar will be made available via HTTP instead of a pubsub data node, the publisher MUST either verify that the avatar exists at the HTTP URL or publish it via standard HTTP methods (such methods are out of scope for this specification; refer to RFC 2616).

Whenever the publisher wishes to change its current avatar, it MUST update the metadata node. As with the data node, the publisher MUST ensure that the value of the pubsub ItemID is a SHA-1 hash of the data for the "image/png" content-type (the match between the ItemID of the data node and metadata node is used by the subscriber to determine if a locally cached copy can be displayed).

The following example shows metadata specifying avatar data that is available in only one format ("image/png") and accessible only at the data node.

]]>

The following example shows metadata specifying avatar data that is available at an HTTP URL.

]]>

The user's virtual pubsub service would then send the metadata notification to entities that have subscribed to the user's metadata node or contacts who have advertised an interest in receiving avatar metadata by including a &xep0115; feature of "urn:xmpp:avatar:metadata+notify".

]]>

As shown, depending on node configuration, the item may include &xep0033; information about the publishing resource (see XEP-0060 for details).

Upon receiving the notification, each subscriber SHOULD determine if it has a locally cached copy of that avatar (which it can do by searching for an image identified by the ItemID). If the subscriber already has a locally cached copy of the avatar image, it MUST NOT retrieve the image data.

If the subscriber does not have a locally cached copy of the avatar image, it SHOULD retrieve the data. It can do this by sending a pubsub retrieve-items request to the data node, specifying the appropriate ItemID.

]]>

The PEP service running at the user's server then SHOULD return the avatar data.

qANQR1DBwU4DX7jmYZnncm... ]]>

If the <info/> element sent to the metadata node possesses a 'url' attribute, the avatar data is hosted at a URL. Therefore, in order to retrieve the avatar image data for that content-type, the requesting entity MUST send an HTTP request to the specified URL. Methods for doing so are out of scope for this specification (see RFC 2616).

In order to temporarily disable avatar publishing, the user publishes an empty <metadata/> element to the metadata node.

]]>

As before, subscribers to the metadata node would then receive the notification.

]]>

Note: In an earlier version of this specification, the user indicated that it wanted to disable publishing by sending a <metadata/> element containing a <stop/> child element. For consistency with other PEP payload formats, support for the <stop/> element is deprecated.

The PEP subset of pubsub requires that there shall exist a one-to-one relationship between namespaces and nodes. Because the protocol defined herein stipulates the use of two nodes (one for avatar data and one for avatar metadata), we define two namespaces, each with a corresponding root element:

  • <data xmlns='urn:xmpp:avatar:data'/>
  • <metadata xmlns='urn:xmpp:avatar:metadata'/>

These are further specified below.

The <data/> element is used to communicate the avatar data itself, and only for the "image/png" content-type (support for which is REQUIRED).

IMAGE DATA ]]>

The XML character data MUST represent the image data for the avatar with a content-type of "image/png", Base64-encoded in accordance with Section 4 of &rfc4648;. (Note: Line feeds SHOULD NOT be added but MUST be accepted.)

The <data/> element MUST NOT possess any attributes.

Support for the <data/> element is REQUIRED.

The <metadata/> element is used to communicate information about the avatar. There are two allowable children of the <metadata/> element:

  • <info/>
  • <pointer/>

These are further specified below.

In addition, the <metadata/> element MAY be empty (i.e., contain no child elements); this form is used to disable avatar publishing.

The <info/> child element is used to communicate avatar metadata. Support for the <info/> element is REQUIRED.

]]>

The <info/> child element MUST be empty.

The defined attributes of the <info/> element are specified in the following table.

Name Definition Inclusion
bytes The size of the image data in bytes. REQUIRED
height The height of the image in pixels, if available. RECOMMENDED
id A hash of the image data for the specified content-type, where the hash is produced in accordance with the SHA-1 algorithm as specified in &rfc3174; (with binary output). REQUIRED
type The IANA-registered content type of the image data. REQUIRED
url The http: or https: URL at which the image data file is hosted; this attribute MUST NOT be included unless the image data file can be retrieved via HTTP. OPTIONAL
width The width of the image in pixels, if available. RECOMMENDED

The <metadata/> root element MAY contain more than one <info/> element. Each <info/> element MUST specify metadata for the same avatar image but in alternate content-types (e.g., "image/png", "image/gif", and "image/jpeg"), and one of the formats MUST be "image/png" to ensure interoperability. The value of the 'type' attribute MUST be an IANA-registered content type of type "image" or "video". The IANA registry of content types is located at <http://www.iana.org/assignments/media-types/>. Support for the "image/png" content type is REQUIRED. Support for the "image/gif" and "image/jpeg" content types is RECOMMENDED. Support for any other content type is OPTIONAL.

The <pointer/> child element is used to point to an avatar that is not published via pubsub or HTTP, but rather is provided by a third-party service such as an online gaming system or virtual world.

... APPLICATION-SPECIFIC DATA ... ]]>

The <pointer/> element MAY possess the following attributes if the publishing application has the relevant information:

  • bytes -- The size of the image data in bytes.
  • height -- The height of the image in pixels, if available.
  • id -- The SHA-1 hash of the image data for the specified content-type.
  • type -- The IANA-registered content type of the image data.
  • width -- The width of the image in pixels, if available.

The content of the <pointer/> element MUST be a properly-namespaced child element that specifies information about how to retrieve the avatar from the third-party service. The structure for any such child element is out of scope for this document.

Even if the <pointer> element is included, it MUST be preceded by at least one instance of the <info/> element so that implementations that do not support the <pointer/> element can display a "fallback" format of the avatar (at a minimum, "image/png").

Support for the <pointer/> element is OPTIONAL.

The following example shows metadata specifying avatar data that is available in multiple formats ("image/png", "image/gif", and "image/mng"), where the "image/png" content-type is available only at the data node and the other content-types are available HTTP URLs.

]]>

In the foregoing example, the image encapsulated in the "image/png" content type is available both at a pubsub data node and at an HTTP URL; therefore it is included twice (the second time with a 'url' attribute).

The following example shows metadata specifying avatar data that is available in "image/png" at the data node and also with a pointer to an external service.

Ancapistan Kropotkin ]]>

The pubsub "auto-subscribe" and "filtered-notifications" features enable a contact to automatically subscribe to a user's avatar. However, a contact can also explicitly determine if another user publishes avatars using this protocol by sending a &xep0030; items ("disco#items") request to the user's bare JID &LOCALBARE;.

]]>

If the user publishes avatar data to an PEP node, the result MUST contain the appropriate items.

]]>

The contact then MAY subscribe to the metadata node following the protocol specified in XEP-0060. However, the contact SHOULD NOT subscribe to the data node (instead, it SHOULD simply retrieve items from that node when needed, as described above).

If a user has multiple online resources at the same time, each resource MAY publish a different avatar. The PEP service SHOULD include the "replyto" address of the publishing resource as shown above in order to facilitate differentiation between per-resource avatars.

When a user logs in with a new resource and before publishing an avatar, its client SHOULD retrieve its last published avatar, either automatically by sending presence with the appropriate entity capabilities information (see XEP-0115) or using the "retrieve-items" method described in XEP-0060.

It is the responsibility of the receiving application to determine which avatar format to retrieve (e.g., "image/gif" rather than "image/png") and to determine the appropriate method for retrieval (e.g., HTTP rather than pubsub).

The receiving application SHOULD NOT scale up an image when displaying it.

If an avatar is not available for a contact, the receiving application MAY display the contact's photo, e.g., as provided in the contact's vCard (see &xep0054;) or other profile information.

See XEP-0060 and XEP-0163 regarding security considerations related to the underlying transport protocol.

It is possible that output of the SHA-1 hashing algorithm can result in collisions; however, the use of SHA-1 in producing a hash of the avatar data is not security-critical.

This document makes use of IANA-registered content types, but requires no interaction with &IANA;.

The ®ISTRAR; includes "urn:xmpp:avatar:data" and "urn:xmpp:avatar:metadata" in its registry of protocol namespaces (see &NAMESPACES;).

 The protocol documented by this schema is defined in XEP-0084: http://www.xmpp.org/extensions/xep-0084.html ]]> The protocol documented by this schema is defined in XEP-0084: http://www.xmpp.org/extensions/xep-0084.html ]]>

Peter Millard, a co-author of this specification from version 0.1 through version 0.7, died on April 26, 2006. The remaining authors are thankful for his work on user avatars.