TOC 
SIMPLEH. Schulzrinne
Internet-DraftColumbia U.
Expires: December 27, 2005June 25, 2005

CIPID: Contact Information in Presence Information Data Format

draft-ietf-simple-cipid-05

Status of this Memo

By submitting this Internet-Draft, each author represents that any applicable patent or other IPR claims of which he or she is aware have been or will be disclosed, and any of which he or she becomes aware will be disclosed, in accordance with Section 6 of BCP 79.

Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet-Drafts.

Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as “work in progress.”

The list of current Internet-Drafts can be accessed at http://www.ietf.org/ietf/1id-abstracts.txt.

The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html.

This Internet-Draft will expire on December 27, 2005.

Copyright Notice

Copyright © The Internet Society (2005).

Abstract

The Presence Information Data Format (PIDF) defines a basic XML format for presenting presence information for a presentity. The Contact Information for Presence Information Data Format (CIPID) is an extension that adds elements to PIDF that provide additional contact information about a presentity and its contacts, including references to address book entries and icons.



Table of Contents

1.  Introduction
2.  Terminology and Conventions
3.  CIPID Elements
    3.1  Card Element
    3.2  Display-Name Element
    3.3  Homepage Element
    3.4  Icon Element
    3.5  Map Element
    3.6  Sound Element
4.  Example
5.  The XML Schema Definition
6.  IANA Considerations
    6.1  URN Sub-Namespace Registration for 'urn:ietf:params:xml:ns:pidf:cipid'
    6.2  Schema Registration for Schema urn:ietf:params:xml:ns:pidf:cipid'
7.  Security Considerations
8.  References
    8.1  Normative References
    8.2  Informative References
§  Author's Address
A.  Acknowledgments
§  Intellectual Property and Copyright Statements




 TOC 

1. Introduction

In its function of facilitating communication, the usefulness of presence information can be enhanced by providing basic information about a presentity or contact. This specification describes a basic set of information elements that allow a watcher to retrieve additional information about a presentity or contact.

This specification defines extensions to the PIDF [5] (Sugano, H., Fujimoto, S., Klyne, G., Bateman, A., Carr, W., and J. Peterson, “Presence Information Data Format (PIDF),” August 2004.) XML (Extensible Markup Language) [6] (Yergeau, F., Paoli, J., Sperberg-McQueen, C., Bray, T., and E. Maler, “Extensible Markup Language (XML) 1.0 (Third Edition),” February 2004.) document format.

We describe elements for providing a "business card", references to the homepage, map, representative sound, display name and an icon. All elements extend the <person> or, less commonly, <tuple> element in the presence data model (Rosenberg, J., “A Data Model for Presence,” February 2005.)[9]. The <tuple> element is only extended with CIPID elements if the information describes a service referring to another person that is marked by an RPID <relationship> element with a value other than 'self'. All elements described in this document are optional.

This additional presence information can be used in PIDF (Sugano, H., Fujimoto, S., Klyne, G., Bateman, A., Carr, W., and J. Peterson, “Presence Information Data Format (PIDF),” August 2004.)[5] documents, together with RPID (Schulzrinne, H., “RPID: Rich Presence Extensions to the Presence Information Data Format (PIDF),” June 2005.)[7], future-status (Schulzrinne, H., “Timed Presence Extensions to the Presence Information Data Format (PIDF) to Indicate Presence Information for Past and Future Time Intervals,” June 2005.)[8] and other PIDF extensions.

The namespace URI for these elements defined by this specification is a URN [2] (Moats, R., “URN Syntax,” May 1997.), using the namespace identifier 'ietf' defined by [3] (Moats, R., “A URN Namespace for IETF Documents,” August 1999.) and extended by [4] (Mealling, M., “The IETF XML Registry,” January 2004.):

   urn:ietf:params:xml:ns:pidf:cipid



 TOC 

2. Terminology and Conventions

The key words MUST, MUST NOT, REQUIRED, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL in this document are to be interpreted as described in BCP 14, RFC 2119 (Bradner, S., “Key words for use in RFCs to Indicate Requirement Levels,” March 1997.)[1].



 TOC 

3. CIPID Elements

Some of the elements below refer to content using URIs. If the watcher retrieves the content pointed to by the URI, it may reveal to the presentity that it is currently using the presence application. Thus, for increased watcher privacy, a presence application MAY want to cache these objects for later use.

3.1 Card Element

The <card> element includes a URI pointing to a business card, e.g., in LDIF (Good, G., “The LDAP Data Interchange Format (LDIF) - Technical Specification,” June 2000.)[11] or vCard (Dawson, F. and T. Howes, “vCard MIME Directory Profile,” September 1998.)[10] format.

3.2 Display-Name Element

The <display-name> element includes the name identifying the tuple or person that the presentity suggests should be shown by the watcher user interface. It is up to watcher user interface to choose whether to heed this suggestion or use some other suitable string.

3.3 Homepage Element

The <homepage> element provides a URI pointing to general information about the tuple or person, typically a web home page.

3.4 Icon Element

The <icon> element provides a URI pointing to an image (icon) representing the tuple or person. The watcher MAY use this information to represent the tuple or person in a graphical user interface. Presentities SHOULD provide images of sizes and aspect ratios that are appropriate for rendering as an icon. Support for JPEG, PNG and GIF formats is RECOMMENDED.

3.5 Map Element

The <map> element provides a URI pointing to a map related to the tuple or person. The watcher MAY use this information to represent the tuple or person in a graphical user interface. The map may be either an image, an HTML client-side image map or a geographical information system (GIS) document, e.g., encoded as GML. Support for images formatted as PNG and GIF is RECOMMENDED.

3.6 Sound Element

The <sound> element provides a URI pointing to a sound related to the tuple or person. The watcher MAY use the sound object, such as a MIDI or MP3 file, referenced by the URL to inform the watcher that the presentity has assumed the status OPEN. Implementors are advised to create user interfaces that provide the watcher with the opportunity to choose whether to play such sounds. Support for sounds coded as MPEG-2 Layer 3 (MP3) is RECOMMENDED.



 TOC 

4. Example

An example combining RPID and CIPID is shown below:


<?xml version="1.0" encoding="UTF-8"?>
<presence xmlns="urn:ietf:params:xml:ns:pidf"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:dm="urn:ietf:params:xml:ns:pidf:data-model"
xmlns:foo="urn:ietf:params:xml:ns:foo"
xmlns:c="urn:ietf:params:xml:ns:pidf:cipid"
xmlns:r="urn:ietf:params:xml:ns:pidf:rpid"
xsi:schemaLocation="urn:ietf:params:xml:ns:pidf pidf.xsd
urn:ietf:params:xml:ns:pidf:data-model data-model.xsd
urn:ietf:params:xml:ns:pidf:cipid cipid.xsd
urn:ietf:params:xml:ns:pidf:rpid rpid.xsd"
entity="pres:someone@example.com">

  <tuple id="bs35r9">
    <status>
      <basic>open</basic>
    </status>
    <contact priority="0.8">im:someone@mobile.example.net</contact>
    <timestamp>2005-05-30T22:00:29Z</timestamp>
  </tuple>

  <tuple id="bs78">
    <status>
       <basic>closed</basic>
    </status>
    <r:relationship><r:assistant/></r:relationship>
    <c:card>http://example.com/~assistant/card.vcd</c:card>
    <c:homepage>http://example.com/~assistant</c:homepage>
    <contact priority="0.1">im:assistant@example.com</contact>
    <timestamp>2005-05-30T22:00:29Z</timestamp>
  </tuple>

  <dm:person id="p1">
    <c:card>http://example.com/~someone/card.vcd</c:card>
    <c:homepage>http://example.com/~someone</c:homepage>
    <c:icon>http://example.com/~someone/icon.gif</c:icon>
    <c:map>http://example.com/~someone/gml-map.xml</c:map>
    <c:sound>http://example.com/~someone/whoosh.wav</c:sound>
    <dm:timestamp>2005-05-30T22:02:44+05:00</dm:timestamp>
  </dm:person>
</presence>



 TOC 

5. The XML Schema Definition

The schema is shown below.



<?xml version="1.0" encoding="UTF-8"?>
<xs:schema targetNamespace="urn:ietf:params:xml:ns:pidf:cipid"
    xmlns:cipid="urn:ietf:params:xml:ns:pidf:cipid"
    xmlns:xs="http://www.w3.org/2001/XMLSchema"
    elementFormDefault="qualified"
    attributeFormDefault="unqualified">

  <xs:annotation>
    <xs:documentation>
      Describes CIPID tuple extensions for PIDF.
    </xs:documentation>
  </xs:annotation>

  <xs:element name="card" type="xs:anyURI"/>
  <xs:element name="display-name" type="xs:string"/>
  <xs:element name="homepage" type="xs:anyURI"/>
  <xs:element name="icon" type="xs:anyURI"/>
  <xs:element name="map" type="xs:anyURI"/>
  <xs:element name="sound" type="xs:anyURI"/>
</xs:schema>
 Figure 1: CIPID schema 



 TOC 

6. IANA Considerations

This document calls for IANA to register a new XML namespace URN and schema per [4] (Mealling, M., “The IETF XML Registry,” January 2004.).

6.1 URN Sub-Namespace Registration for 'urn:ietf:params:xml:ns:pidf:cipid'

URI:
urn:ietf:params:xml:ns:pidf:cipid
Description:
This is the XML namespace for XML elements defined by RFCXXXX to describe contact information presence information extensions for the status element in the PIDF presence document format in the application/pidf+xml content type.
Registrant Contact:
IETF, SIMPLE working group, simple@ietf.org; Henning Schulzrinne, hgs@cs.columbia.edu
XML:

 BEGIN
 <?xml version="1.0"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.0//EN"
 "http://www.w3.org/TR/xhtml-basic/xhtml-basic10.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml
 <head>
    <meta http-equiv="content-type"
    content="text/html;charset=iso-8859-1"/>
    <title>CIPID -- Contact Information in Presence Information
      Data Format</title>
 </head>
 <body>
   <h1>Namespace for contact information presence extension
       (status)</h1>
   <h2>urn:ietf:params:xml:ns:pidf:cipid</h2>
   <p>See <a href="URL of published RFC">RFCXXXX</a>.</p>
 </body>
 </html>
 END

6.2 Schema Registration for Schema urn:ietf:params:xml:ns:pidf:cipid'

URI:
please assign
Registrant Contact:
IESG
XML:
See Figure 1 (CIPID schema)


 TOC 

7. Security Considerations

The security issues are similar to those for RPID (Schulzrinne, H., “RPID: Rich Presence Extensions to the Presence Information Data Format (PIDF),” June 2005.)[7]. Watchers need to restrict which content types of content pointed to by <icon>, <homepage>, <map>, <sound>, and <vcard> elements they render.

Also, when a watcher accesses these URIs, the presentity may deduce that the watcher is currently using the presence application. Thus, a presence application concerned about leaking this information may want to cache these objects for later use. (A presentity could easily customize the URLs for each watcher, so that it can tell who is referencing the objects.)

Icons and other URIs in this document could be used as a covert channel to convey messages to the watcher, outside the content monitoring that might be in place for instant messages or other communications channels. Thus, entities that worry about such channels may want to prohibit the usage of URLs pointing to resources outside their domain, for example.



 TOC 

8. References



 TOC 

8.1 Normative References

[1] Bradner, S., “Key words for use in RFCs to Indicate Requirement Levels,” BCP 14, RFC 2119, March 1997 (TXT, HTML, XML).
[2] Moats, R., “URN Syntax,” RFC 2141, May 1997 (TXT, HTML, XML).
[3] Moats, R., “A URN Namespace for IETF Documents,” RFC 2648, August 1999.
[4] Mealling, M., “The IETF XML Registry,” BCP 81, RFC 3688, January 2004.
[5] Sugano, H., Fujimoto, S., Klyne, G., Bateman, A., Carr, W., and J. Peterson, “Presence Information Data Format (PIDF),” RFC 3863, August 2004.
[6] Yergeau, F., Paoli, J., Sperberg-McQueen, C., Bray, T., and E. Maler, “Extensible Markup Language (XML) 1.0 (Third Edition),” W3C REC REC-xml-20040204, February 2004.


 TOC 

8.2 Informative References

[7] Schulzrinne, H., “RPID: Rich Presence Extensions to the Presence Information Data Format (PIDF),” draft-ietf-simple-rpid-06 (work in progress), June 2005.
[8] Schulzrinne, H., “Timed Presence Extensions to the Presence Information Data Format (PIDF) to Indicate Presence Information for Past and Future Time Intervals,” draft-ietf-simple-future-03 (work in progress), June 2005.
[9] Rosenberg, J., “A Data Model for Presence,” draft-ietf-simple-presence-data-model-02 (work in progress), February 2005.
[10] Dawson, F. and T. Howes, “vCard MIME Directory Profile,” RFC 2426, September 1998 (TXT, HTML, XML).
[11] Good, G., “The LDAP Data Interchange Format (LDIF) - Technical Specification,” RFC 2849, June 2000.


 TOC 

Author's Address

  Henning Schulzrinne
  Columbia University
  Department of Computer Science
  450 Computer Science Building
  New York, NY 10027
  US
Phone:  +1 212 939 7004
Email:  hgs+simple@cs.columbia.edu
URI:  http://www.cs.columbia.edu


 TOC 

Appendix A. Acknowledgments

This document is based on the discussions within the IETF SIMPLE working group. Aki Niemi, Vijay Gurbani, Hisham Khartabil, Paul Kyzivat, Eva Leppanen, Mikko Lonnfors, Jon Peterson and Jonathan Rosenberg provided helpful comments.



 TOC 

Intellectual Property Statement

Disclaimer of Validity

Copyright Statement

Acknowledgment