This specification provides canonical documentation of the vCard-XML format currently in use within the Jabber community.
NOTICE: This Historical specification provides canonical documentation of a protocol that is in use within the Jabber/XMPP community. This document is not a standards-track specification within the XMPP Standards Foundation's standards process; however, it may be converted to standards-track in the future or may be obsoleted by a more modern protocol.
Series: XEP
Number: 0054
Publisher: XMPP Standards Foundation
Status:
Active
Type:
Historical
Version: 1.1
Last Updated: 2003-03-26
Approving Body: XMPP Council
Dependencies: XMPP Core
Supersedes: None
Superseded By: None
Short Name: vcard-temp
Wiki Page: <http://wiki.jabber.org/index.php/vcard-temp (XEP-0054)>
JabberID:
stpeter@jabber.org
URI:
https://stpeter.im/
The preferred venue for discussion of this document is the Standards discussion list: <http://mail.jabber.org/mailman/listinfo/standards>.
Errata may be sent to <editor@xmpp.org>.
The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 3920) and XMPP IM (RFC 3921) specifications contributed by the XMPP Standards Foundation to the Internet Standards Process, which is managed by the Internet Engineering Task Force in accordance with RFC 2026. Any protocol defined in this document has been developed outside the Internet Standards Process and is to be understood as an extension to XMPP rather than as an evolution, development, or modification of XMPP itself.
The following keywords as used in this document are to be interpreted as described in RFC 2119: "MUST", "SHALL", "REQUIRED"; "MUST NOT", "SHALL NOT"; "SHOULD", "RECOMMENDED"; "SHOULD NOT", "NOT RECOMMENDED"; "MAY", "OPTIONAL".
1. Introduction
2. History
3. Use Cases
3.1. Retrieving One's vCard
3.2. Updating One's vCard
3.3. Viewing Another User's vCard
4. Security Considerations
5. IANA Considerations
6. XMPP Registrar Considerations
6.1. Protocol Namespaces
6.2. URI Query Types
7. Implementation Notes
8. DTD
Notes
Revision History
This specification documents the vCard-XML format currently in use within the Jabber community. A future specification will recommend a standards-track protocol to supersede this informational document.
The basic functionality is for a user to store and retrieve an XML representation of his or her vCard using the data storage capabilities native to all existing Jabber server implementations. This is done by by sending an <iq/> of type "set" (storage) or "get" (retrieval) to one's Jabber server containing a <vCard/> child scoped by the 'vcard-temp' namespace, with the <vCard/> element containing the actual vCard-XML elements as defined by the vCard-XML DTD. Other users may then view one's vCard information.
vCards are an existing and widely-used standard for personal user information storage, somewhat like an electronic business card. The vCard format is defined in RFC 2426 [1].
In 1998 and 1999, Frank Dawson submitted four revisions of an Internet-Draft proposing to represent the standard vCard format in XML. When the Jabber project was originally looking for a method to store personal user information, the most recent revision was draft-dawson-vcard-xml-dtd-01 [2]. He also submitted a -02 revision on November 15, 1998 [3] and a -03 revision on June 22, 1999 [4].
Unfortunately, Dawson's proposal did not move forward within the IETF's standards process. For reasons now lost in the mists of time, the Jabber project continued to use the DTD from draft-dawson-vcard-xml-dtd-01, making two small modifications to adapt it for use within Jabber (adding the JABBERID and DESC elements) but also specifying element names in all caps rather than lowercase as defined in draft-dawson-vcard-xml-dtd-01. In addition, the Jabber community followed the usage (but not DTD) in that draft regarding version information, including it as an attribute of the vCard element rather than as a child element. This format was implemented within Jabber under the 'vcard-temp' namespace.
A user may retrieve his or her own vCard by sending XML of the following form to his or her own JID (the 'to' attibute MUST NOT be included):
<iq from='stpeter@jabber.org/roundabout' id='v1' type='get'> <vCard xmlns='vcard-temp'/> </iq>
The server should then return the vCard to the user:
<iq id='v1' to='stpeter@jabber.org/roundabout' type='result'> <vCard xmlns='vcard-temp'> <FN>Peter Saint-Andre</FN> <N> <FAMILY>Saint-Andre</FAMILY> <GIVEN>Peter</GIVEN> <MIDDLE/> </N> <NICKNAME>stpeter</NICKNAME> <URL>http://www.xmpp.org/xsf/people/stpeter.shtml</URL> <BDAY>1966-08-06</BDAY> <ORG> <ORGNAME>XMPP Standards Foundation</ORGNAME> <ORGUNIT/> </ORG> <TITLE>Executive Director</TITLE> <ROLE>Patron Saint</ROLE> <TEL><WORK/><VOICE/><NUMBER>303-308-3282</NUMBER></TEL> <TEL><WORK/><FAX/><NUMBER/></TEL> <TEL><WORK/><MSG/><NUMBER/></TEL> <ADR> <WORK/> <EXTADD>Suite 600</EXTADD> <STREET>1899 Wynkoop Street</STREET> <LOCALITY>Denver</LOCALITY> <REGION>CO</REGION> <PCODE>80202</PCODE> <CTRY>USA</CTRY> </ADR> <TEL><HOME/><VOICE/><NUMBER>303-555-1212</NUMBER></TEL> <TEL><HOME/><FAX/><NUMBER/></TEL> <TEL><HOME/><MSG/><NUMBER/></TEL> <ADR> <HOME/> <EXTADD/> <STREET/> <LOCALITY>Denver</LOCALITY> <REGION>CO</REGION> <PCODE>80209</PCODE> <CTRY>USA</CTRY> </ADR> <EMAIL><INTERNET/><PREF/><USERID>stpeter@jabber.org</USERID></EMAIL> <JABBERID>stpeter@jabber.org</JABBERID> <DESC> More information about me is located on my personal website: http://www.saint-andre.com/ </DESC> </vCard> </iq>
A user may publish or update his or her vCard by sending an IQ of type "set" with no 'to' address, following the format in the previous use case.
<iq id='v2' type='set'> <vCard xmlns='vcard-temp'> <FN>Peter Saint-Andre</FN> <N> <FAMILY>Saint-Andre</FAMILY> <GIVEN>Peter</GIVEN> <MIDDLE/> </N> <NICKNAME>stpeter</NICKNAME> <URL>http://www.xmpp.org/xsf/people/stpeter.shtml</URL> <BDAY>1966-08-06</BDAY> <ORG> <ORGNAME>XMPP Standards Foundation</ORGNAME> <ORGUNIT/> </ORG> <TITLE>Executive Director</TITLE> <ROLE>Patron Saint</ROLE> <TEL><WORK/><VOICE/><NUMBER>303-308-3282</NUMBER></TEL> <TEL><WORK/><FAX/><NUMBER/></TEL> <TEL><WORK/><MSG/><NUMBER/></TEL> <ADR> <WORK/> <EXTADD>Suite 600</EXTADD> <STREET>1899 Wynkoop Street</STREET> <LOCALITY>Denver</LOCALITY> <REGION>CO</REGION> <PCODE>80202</PCODE> <CTRY>USA</CTRY> </ADR> <TEL><HOME/><VOICE/><NUMBER>303-555-1212</NUMBER></TEL> <TEL><HOME/><FAX/><NUMBER/></TEL> <TEL><HOME/><MSG/><NUMBER/></TEL> <ADR> <HOME/> <EXTADD/> <STREET/> <LOCALITY>Denver</LOCALITY> <REGION>CO</REGION> <PCODE>80209</PCODE> <CTRY>USA</CTRY> </ADR> <EMAIL><INTERNET/><PREF/><USERID>stpeter@jabber.org</USERID></EMAIL> <JABBERID>stpeter@jabber.org</JABBERID> <DESC> Check out my blog at https://stpeter.im/ </DESC> </vCard> </iq>
The server then returns an IQ-result (or an IQ-error).
<iq id='v2' to='stpeter@jabber.org/roundabout' type='result'/>
Notice that the previous IQ-set included only one changed element (the <DESC/> element). Currently there is no method for partial updates of a vCard, and the entire vCard must be sent to the server in order to update any part of the vCard.
If a user attempts to perform an IQ set on another user's vCard (i.e., by setting a 'to' address to a JID other than the sending user's bare JID), the server MUST return a 403 "Forbidden" error.
A user may view another user's vCard by sending an IQ of type "get" to the other user's bare JID.
<iq from='stpeter@jabber.org/roundabout' id='v3' to='jer@jabber.org' type='get'> <vCard xmlns='vcard-temp'/> </iq>
In accordance with XMPP Core [5], a compliant server MUST respond on behalf of the requestor and not forward the IQ to the requestee's connected resource.
<iq from='jer@jabber.org' to='stpeter@jabber.org/roundabout' type='result' id='v3'> <vCard xmlns='vcard-temp'> <FN>JeremieMiller</FN> <N> <GIVEN>Jeremie</GIVEN> <FAMILY>Miller</FAMILY> <MIDDLE/> </N> <NICKNAME>jer</NICKNAME> <EMAIL><INTERNET/><PREF/><USERID>jeremie@jabber.org</USERID></EMAIL> <JABBERID>jer@jabber.org</JABBERID> </vCard> </iq>
Note: The use of vCards is not limited to accounts associated with human users. For example, an XMPP server could itself have a vCard that defines the server's hosting organization, physical location, and relevant contact addresses.
The vCard information published to one's Jabber server is world-readable; therefore, users should exercise due caution when determining what information to include (e.g., street addresses, personal telephone numbers, or email addresses).
This document requires no interaction with the Internet Assigned Numbers Authority (IANA) [6].
The XMPP Registrar [7] includes the 'vcard-temp' namespace in its registry of official namespaces (see <http://www.xmpp.org/registrar/namespaces.html>).
As authorized by XMPP URI Query Components [8], the XMPP Registrar maintains a registry of queries and key-value pairs for use in XMPP URIs (see <http://www.xmpp.org/registrar/querytypes.html>).
The "vcard" querytype is registered as a vCard-related action.
xmpp:romeo@montague.net?vcard
<iq to='romeo@montague.net' type='get'> <vCard xmlns='vcard-temp'/> </iq>
The following submission registers the "vcard" querytype.
<querytype> <name>vcard</name> <proto>vcard-temp</proto> <desc>enables retrieval of an entity's vCard data</desc> <doc>XEP-0054</doc> </querytype>
Note the following:
The following DTD is a slightly modified version of that contained in draft-dawson-vcard-xml-dtd-01. The only modifications were to add the JABBERID and DESC elements.
<?xml version="1.0" encoding="UTF-8"?> <!-- Copyright (C) The Internet Society (2000). All Rights Reserved. This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implmentation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to the Internet Society or other Internet organizations, except as needed for the purpose of developing Internet standards in which case the procedures for copyrights defined in the Internet Standards process MUST be followed, or as required to translate it into languages other than English. The limited permissions granted above are perpetual and will not be revoked by the Internet Society or its successors or assigns. This document and the information contained herein is provided on an "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIMS 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. --> <!-- ==== --> <!-- NOTE: the following root element is not used in the modified vcard-temp DTD published by the Jabber project (now XMPP Standards Foundation) and is included here only for historical purposes; implementations that comply with vcard-temp must specify the root element as vCard, not xCard. --> <!-- Root element and container for one or more vCard objects --> <!ELEMENT xCard (vCard)+> <!-- Individual vCard container --> <!ELEMENT vCard ( (VERSION, FN, N), (NICKNAME?, PHOTO?, BDAY?, ADR?, LABEL?, TEL?, EMAIL?, JABBERID?, MAILER?, TZ?, GEO?, TITLE?, ROLE?, LOGO?, AGENT?, ORG?, CATEGORIES?, NOTE?, PRODID?, REV?, SORT-STRING?, SOUND?, UID?, URL?, CLASS?, KEY?, DESC? )*)> <!-- vCard specification version property. This MUST be 2.0, if the document conforms to RFC 2426. --> <!ELEMENT VERSION (#PCDATA)> <!-- Formatted or display name property. --> <!ELEMENT FN (#PCDATA)> <!-- Structured name property. Name components with multiple values must be specified as a comma separated list of values. --> <!ELEMENT N ( FAMILY?, GIVEN?, MIDDLE?, PREFIX?, SUFFIX?)> <!ELEMENT FAMILY (#PCDATA)> <!ELEMENT GIVEN (#PCDATA)> <!ELEMENT MIDDLE (#PCDATA)> <!ELEMENT PREFIX (#PCDATA)> <!ELEMENT SUFFIX (#PCDATA)> <!-- Nickname property. Multiple nicknames must be specified as a comma separated list value. --> <!ELEMENT NICKNAME (#PCDATA)> <!-- Photograph property. Value is either a BASE64 encoded binary value or a URI to the external content. --> <!ELEMENT PHOTO ((TYPE, BINVAL) | EXTVAL)> <!-- Birthday property. Value must be an ISO 8601 formatted date or date/time value. --> <!ELEMENT BDAY (#PCDATA)> <!-- Structured address property. Address components with multiple values must be specified as a comma separated list of values. --> <!ELEMENT ADR ( HOME?, WORK?, POSTAL?, PARCEL?, (DOM | INTL)?, PREF?, POBOX?, EXTADD?, STREET?, LOCALITY?, REGION?, PCODE?, CTRY? )> <!ELEMENT POBOX (#PCDATA)> <!ELEMENT EXTADD (#PCDATA)> <!ELEMENT STREET (#PCDATA)> <!ELEMENT LOCALITY (#PCDATA)> <!ELEMENT REGION (#PCDATA)> <!ELEMENT PCODE (#PCDATA)> <!ELEMENT CTRY (#PCDATA)> <!-- Address label property. --> <!ELEMENT LABEL ( HOME?, WORK?, POSTAL?, PARCEL?, (DOM | INTL)?, PREF?, LINE+ )> <!-- Individual label lines. --> <!ELEMENT LINE (#PCDATA)> <!-- Telephone number property. --> <!ELEMENT TEL ( HOME?, WORK?, VOICE?, FAX?, PAGER?, MSG?, CELL?, VIDEO?, BBS?, MODEM?, ISDN?, PCS?, PREF?, NUMBER )> <!-- Phone number value. --> <!ELEMENT NUMBER (#PCDATA)> <!-- Email address property. Default type is INTERNET. --> <!ELEMENT EMAIL ( HOME?, WORK?, INTERNET?, PREF?, X400?, USERID )> <!ELEMENT USERID (#PCDATA)> <!-- NOTE: the following element was added by the Jabber project (now XMPP Standards Foundation) to handle Jabber IDs; the value must be in the form of user@host --> <!ELEMENT JABBERID (#PCDATA)> <!-- Mailer (e.g., Mail User Agent Type) property. --> <!ELEMENT MAILER (#PCDATA)> <!-- Time zone's Standard Time UTC offset. Value must be an ISO 8601 formatted UTC offset. --> <!ELEMENT TZ (#PCDATA)> <!-- Geographical position. Values are the decimal degress of LATitude and LONgitude. The value should be specified to six decimal places.--> <!ELEMENT GEO (LAT, LON)> <!-- Latitude value. --> <!ELEMENT LAT (#PCDATA)> <!-- Longitude value. --> <!ELEMENT LON (#PCDATA)> <!-- Title property. --> <!ELEMENT TITLE (#PCDATA)> <!-- Role property. --> <!ELEMENT ROLE (#PCDATA)> <!-- Organization logo property. --> <!ELEMENT LOGO ((TYPE, BINVAL) | EXTVAL)> <!-- Administrative agent property. --> <!ELEMENT AGENT (vCard | EXTVAL)> <!-- Organizational name and units property. --> <!ELEMENT ORG (ORGNAME, ORGUNIT*)> <!ELEMENT ORGNAME (#PCDATA)> <!ELEMENT ORGUNIT (#PCDATA)> <!-- Application specific categories property. --> <!ELEMENT CATEGORIES (KEYWORD+)> <!ELEMENT KEYWORD (#PCDATA)> <!-- Commentary note property. --> <!ELEMENT NOTE (#PCDATA)> <!-- Identifier of product that generated the vCard property. --> <!ELEMENT PRODID (#PCDATA)> <!-- Last revised property. The value must be an ISO 8601 formatted UTC date/time. --> <!ELEMENT REV (#PCDATA)> <!-- Sort string property. --> <!ELEMENT SORT-STRING (#PCDATA)> <!-- Formatted name pronunciation property. The value is either a textual phonetic pronunciation, a BASE64 encoded binary digital audio pronunciation or a URI to an external binary digital audio pronunciation.--> <!ELEMENT SOUND (PHONETIC | BINVAL | EXTVAL)> <!-- Textual phonetic pronunciation. --> <!ELEMENT PHONETIC (#PCDATA)> <!-- Unique identifier property. --> <!ELEMENT UID (#PCDATA)> <!-- Directory URL property. --> <!ELEMENT URL (#PCDATA)> <!-- NOTE: the following element was added by the Jabber project (now XMPP Standards Foundation) to handle free-form descriptive text. --> <!ELEMENT DESC (#PCDATA)> <!-- Privacy classification property. --> <!ELEMENT CLASS (PUBLIC | PRIVATE | CONFIDENTIAL)> <!ELEMENT PUBLIC EMPTY> <!ELEMENT PRIVATE EMPTY> <!ELEMENT CONFIDENTIAL EMPTY> <!-- Authentication credential or encryption key property. --> <!ELEMENT KEY (TYPE?, CRED)> <!ELEMENT CRED (#PCDATA)> <!-- ==== --> <!-- Common elements. --> <!-- Addressing type indicators. --> <!ELEMENT HOME EMPTY> <!ELEMENT WORK EMPTY> <!ELEMENT POSTAL EMPTY> <!ELEMENT PARCEL EMPTY> <!ELEMENT DOM EMPTY> <!ELEMENT INTL EMPTY> <!ELEMENT PREF EMPTY> <!ELEMENT VOICE EMPTY> <!ELEMENT FAX EMPTY> <!ELEMENT PAGER EMPTY> <!ELEMENT MSG EMPTY> <!ELEMENT CELL EMPTY> <!ELEMENT VIDEO EMPTY> <!ELEMENT BBS EMPTY> <!ELEMENT MODEM EMPTY> <!ELEMENT ISDN EMPTY> <!ELEMENT PCS EMPTY> <!ELEMENT INTERNET EMPTY> <!ELEMENT X400 EMPTY> <!-- Format type parameter. --> <!ELEMENT TYPE (#PCDATA)> <!-- Base64 encoded binary value. --> <!ELEMENT BINVAL (#PCDATA)> <!-- URI to external binary value --> <!ELEMENT EXTVAL (#PCDATA)> <!-- ==== -->
1. RFC 2426: vCard MIME Directory Profile <http://tools.ietf.org/html/rfc2426>.
2. This document is archived at <http://www.watersprings.org/pub/id/draft-dawson-vcard-xml-dtd-01.txt>.
3. This document is archived at <http://www.watersprings.org/pub/id/draft-dawson-vcard-xml-dtd-02.txt>.
4. This document is archived at <http://www.watersprings.org/pub/id/draft-dawson-vcard-xml-dtd-03.txt>.
5. RFC 3920: Extensible Messaging and Presence Protocol (XMPP): Core <http://tools.ietf.org/html/rfc3920>.
6. The Internet Assigned Numbers Authority (IANA) is the central coordinator for the assignment of unique parameter values for Internet protocols, such as port numbers and URI schemes. For further information, see <http://www.iana.org/>.
7. The XMPP Registrar maintains a list of reserved protocol namespaces as well as registries of parameters used in the context of XMPP extension protocols approved by the XMPP Standards Foundation. For further information, see <http://www.xmpp.org/registrar/>.
8. XEP-0147: XMPP URI Query Components <http://www.xmpp.org/extensions/xep-0147.html>.
END