Network Working Group C. Newman Internet Draft: ACAP Addressbook Dataset Class Innosoft Document: draft-ietf-acap-abook-02.txt S. Hubert University of Washington March 1998 Expires in six months ACAP Personal Addressbook Dataset Class Status of this memo This document is an Internet-Draft. 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." To view the entire list of current Internet-Drafts, please check the "1id-abstracts.txt" listing contained in the Internet-Drafts Shadow Directories on ftp.is.co.za (Africa), ftp.nordu.net (Europe), munnari.oz.au (Pacific Rim), ds.internic.net (US East Coast), or ftp.isi.edu (US West Coast). Abstract IMAP [IMAP4] allows nomadic users to access their mail store from any client, but it does not support storage of personal addressbooks. Application Configuration Access Protocol [ACAP] provides an ideal mechanism for storage of personal addressbooks. While ACAP permits the definition of vendor specific solutions to this problem, having a standard addressbook dataset class permits clients from different vendors to interoperably share the same personal addressbooks. This specification defines a standard dataset class for personal addressbooks. Newman [Page i]
Internet Draft ACAP Addressbook Dataset Class March 1998 Table of Contents Status of this memo ............................................... i Abstract .......................................................... i 1. Conventions Used in this Document ............................ 1 2. Design Issues ................................................ 1 3. ACAP Personal Addressbooks ................................... 1 3.1. ACAP Addressbook Dataset Class ............................... 1 3.2. ACAP Addressbook Capability .................................. 1 3.3. ACAP Addressbook Hierarchy ................................... 1 3. Recommended ACAP Attributes .................................. 2 3.1. Basic Attributes ............................................. 2 4.2. Naming Attributes ............................................ 3 4.3. Reference Attribute .......................................... 5 4.4. Computer Communication Attributes ............................ 5 4.5. Telephone Number Attributes .................................. 7 4.6. Postal Address Attributes .................................... 8 4.7. Commentary Attributes ........................................ 9 4.8. Locational Attributes ........................................ 9 4.9. PGP Public Keys .............................................. 10 5. Examples ..................................................... 11 6. Mapping vCards to ACAP addressbooks .......................... 12 7. References ................................................... 12 8. Security Considerations ...................................... 13 9. Authors' Addresses ............................................ 13 Appendix .......................................................... 15 A. Attribute Index .............................................. 15 Newman [Page ii]
Internet Draft ACAP Addressbook Dataset Class March 1998 1. Conventions Used in this Document The key words "MUST", "MUST NOT", "SHOULD", "SHOULD NOT", and "MAY" in this document are to be interpreted as defined in "Key words for use in RFCs to Indicate Requirement Levels" [KEYWORDS]. The attribute syntax specifications use the Augmented Backus-Naur Form (ABNF) notation as specified in [ABNF]. When UTF-8 [UTF8] is referred to in this document, it refers to Unicode version 2.0, and not Unicode version 1.1. 2. Design Issues Although this is not a white pages service, in order to provide more consistency, this was designed to match the Common Schema for Internet White Pages [WHITE-SCHEMA]. It was also designed to minimize email client complexity, provide a clean model for personal distribution lists and hierarchical addressbooks and permit storage of vCards [VCARD] for correspondents. Personal addressbooks differ from white pages services because all the attributes and entries are controlled by the user who owns the addressbook rather than a directory administrator. The user or the clients he uses may add new attributes at any time and some of these attributes are not suitable for a white pages service. 3. ACAP Personal Addressbooks 3.1. ACAP Addressbook Dataset Class Datasets whose names begin with "/addressbook" are assumed to contain addressbook entries as defined in this specification. 3.2. ACAP Addressbook Capability The "addressbook.Expand.Address" and "addressbook.Expand.Complete" attributes require active client or server support. The attribute "capability.addressbook.expand" in the "/capability/~/addressbook" entry is non-NIL if they are supported. 3.3. ACAP Addressbook Hierarchy Hierarchical addressbooks SHOULD be represented using ACAP hierarchy. Any entry in an addressbook can also be a hierarchy node by setting the "subdataset" attribute. This structure is used to represent both sub-addressbooks and mailing lists. Newman [Page 1]
Internet Draft ACAP Addressbook Dataset Class March 1998 3. Recommended ACAP Attributes The following attributes MAY be used in an ACAP addressbook entry. An addressbook entry MUST have an "entry" attribute, and one or more of "addressbook.Alias", "addressbook.CommonName" and "addressbook.Email" attributes. The purpose of this rule is to make it possible to easily select an attribute which can be displayed to a user. An addressbook entry MUST have at most one of the attributes "addressbook.List", "addressbook.Reference", and "addressbook.Email". The purpose of this rule is to force each entry to be either a regular addressbook entry with an Email address, a pointer to another addressbook entry, or a distribution list. In order to resolve ambiguities, if there is an "addressbook.List" attribute, both "addressbook.Email" and "addressbook.Reference" attributes MUST be ignored. If there is no "addressbook.List" attribute but there is an "addressbook.Email" attribute, then the "addressbook.Reference" attribute MUST be ignored. Beyond these rule, clients MAY choose any subset of these attributes as well as using registered private attributes. Clients are encouraged to provide a way to view all textual attributes in an entry regardless of whether the client knows the special semantics associated with them. The ABNF defines the content of the attribute values prior to their encoding as an ACAP string. Clients MUST conform to the syntax when generating these attributes, but MUST NOT assume that the attribute values will conform to this syntax on access. Servers MUST NOT enforce the syntax. Unless otherwise stated, all attributes in this specification are single-valued and textual. 3.1. Basic Attributes These attributes are defined in ACAP [ACAP] and have meaning in all dataset classes. This section describes how they are used in an addressbook dataset. entry The "entry" attribute is a unique string used to refer to an addressbook entry within an addressbook dataset. It is client defined and may not be suitable for display to users. subdataset The "subdataset" attribute is used both for addressbook hierarchy and for addressbook distribution lists. It Newman [Page 2]
Internet Draft ACAP Addressbook Dataset Class March 1998 indicates there is another addressbook dataset underneath this entry. If there is also an "addressbook.List" attribute, then this entry is an email distribution list and the subdataset contains the members of that list. If "subdataset" exists, then any "addressbook.Email" or "addressbook.Reference" attributes SHOULD be ignored. 4.2. Naming Attributes These attributes contain information about the name of the person or entity to which the entry refers. addressbook.CommonName The "addressbook.CommonName" attribute holds the full common name of the person or entity to which the addressbook entry refers. If a person or entity has multiple names, they may be stored in the "addressbook.AlternateNames" attribute. abook-common-name = 1*TEXT-UTF8-CHAR addressbook.GivenName The "addressbook.GivenName" attribute holds the given name of the person to which the addressbook entry refers. abook-given-name = 1*TEXT-UTF8-CHAR addressbook.Surname The "addressbook.Surname" attribute holds the surname (or family name) of the person to which the addressbook entry refers. abook-surname = 1*TEXT-UTF8-CHAR addressbook.MiddleName This holds the middle name(s) or initial(s) of the person to which the addressbook entry refers. abook-middle = 1*TEXT-UTF8-CHAR addressbook.Prefix This holds any prefixes (e.g., "Mr.", "Mrs.") for the person to which the addressbook entry refers. abook-prefix = 1*TEXT-UTF8-CHAR addressbook.Suffix This holds any suffixes (e.g., "Jr.", "M.D.") for the person Newman [Page 3]
Internet Draft ACAP Addressbook Dataset Class March 1998 to which the addressbook entry refers. abook-suffix = 1*TEXT-UTF8-CHAR addressbook.AlternateNames This is a multi-value attribute containing a list of alternate names for the entry. Short attributes describing the use of the alternate name may follow the name, separated by a NUL character. abook-alt-name = 1*TEXT-UTF8-CHAR *(NUL 1*TEXT-UTF8-CHAR) ;; multi-valued addressbook.Alias A shorthand way to refer to this entry (e.g. a nickname). Clients MUST NOT store characters which fall into the class of "white-space" or "specials" as defined in Internet Message Format [IMAIL] with the exception of period ("."). The alias is typically used by clients as a way for users to quickly refer to a particular addressbook entry via a type-in field. For this to work best, clients are encouraged to avoid using the same alias in multiple entries within a dataset. abook-alias = 1*<"." or any TEXT-UTF8-CHAR except white-space or specials as defined in [IMAIL]> addressbook.CommonName.MIME This contains the CommonName encoded as a US-ASCII string according to the rules in MIME Headers [MIME-HDRS]. This is set when a personal addressbook entry is created from an Internet Mail Address [IMAIL] which uses MIME Header encoding for the common name portion of the address. This is the preferred attribute to use for the phrase portion of the Internet Mail Address as it preserves the sender's preferred character set. Otherwise, the phrase is constructed from the "addressbook.CommonName" field with all non US-ASCII characters encoded according to MIME headers using UTF-8. This attribute SHOULD be NIL if the CommonName is made up of only US-ASCII characters or the sender's preferred character set is UTF-8. abook-mime-hdr = phrase ;; as defined in [IMAIL] Newman [Page 4]
Internet Draft ACAP Addressbook Dataset Class March 1998 4.3. Reference Attribute addressbook.Reference This addressbook entry is a reference to another ACAP addressbook entry, or an LDAP white pages entry. The reference is in the form of a relative URL. Clients SHOULD support this attribute for the local ACAP server and MAY support it for other ACAP or LDAP servers. abook-reference = relativeURL ;; as defined in [REL-URL] ;; ACAP relative URL is defined in [ACAP] 4.4. Computer Communication Attributes These attributes are related to computer communication. The format for email addresses MUST be canonicalized so it is suitable for use in both [IMAIL] and [SMTP]. This uses terminals from [IMAIL], except that free insertion of linear-white-space is not permitted. Unnecessary quoting SHOULD NOT be used. canon-addr-spec = canon-local-part "@" domain canon-local-part = quoted-string / (atom *("." atom)) addressbook.Email The primary email address for contacting the person or entity to which this entry refers. abook-email = canon-addr-spec addressbook.EmailOther This is a multi-valued attribute containing alternate email addresses for the user. The purpose of a particular email address may be included in short tokens after the address, separated by a NUL. abook-emailother = canon-addr-spec *(NUL 1*TEXT-UTF8-CHAR) addressbook.List If both this attribute and the "subdataset" attribute exist then this entry is an email distribution list. The entries in the subdataset are the members of the list. When this attribute exists, then any "addressbook.Email" or Newman [Page 5]
Internet Draft ACAP Addressbook Dataset Class March 1998 "addressbook.Reference" attributes SHOULD be ignored. abook-list = "1" addressbook.Expand.Address This is an operational attribute which is present if the ACAP server announces the ADDRESSBOOK capability. It's value is computed by the ACAP server. The result is a CRLF-separated list of all the values from the addressbook.Email attributes of this entry, any entry referred to by "addressbook.Reference" on the local server, and any entries contained in the "subdataset" on this server. This expansion is recursive. abook-expand-addr = canon-addr-spec *(CRLF canon-addr-spec) addressbook.Expand.Complete This is an operational attribute which is present if the ACAP server announces the ADDRESSBOOK capability. Its value is computed by the ACAP server. The result is a CRLF-separated list of all the Internet Mail Addresses as computed from the addressbook.Email, addressbook.CommonName, and addressbook.CommonName.MIME attributes. The entry itself, any entry referred to by "addressbook.Reference" on the local server, and any entries contained in the "subdataset" on the local server are expanded. This expansion is recursive. abook-expand-compl = mailbox *(CRLF mailbox) ;; mailbox defined in [IMAIL] without folding addressbook.List.Subscribe This entry contains a URL [BASIC-URL] for the subscription address of the mailing list to which this entry refers (mailto URLs are preferred). Any unknown "?<searchpart>" portions of a mailto URL in this context are ignored to permit future extension. abook-subscribe = url addressbook.List.Unsubscribe This entry contains a URL [BASIC-URL] for the un-subscription address of the mailing list to which this entry refers (mailto URLs are preferred). Any unknown "?<searchpart>" portions of a mailto URL in this context are ignored to permit future extension. abook-unsubscribe = url Newman [Page 6]
Internet Draft ACAP Addressbook Dataset Class March 1998 addressbook.List.Help This entry contains a URL [BASIC-URL] for help information about the mailing list to which this entry refers. Any unknown "?<searchpart>" portions of a mailto URL in this context are ignored to permit future extension. abook-listhelp = url addressbook.Subscribed If this attribute is non-NIL, then the entry refers to a mailing list address to which the addressbook's owner is currently subscribed. abook-subscribed = "1" addressbook.HomePage This contains the URL [BASIC-URL] to the primary home page describing the person or entity to which the addressbook entry refers. abook-home-page = url ;; as defined in [BASIC-URL] addressbook.HomePageOther This is a multi-valued attribute containing alternate home page URLs for the person or entity to which the addressbook entry refers. 4.5. Telephone Number Attributes Fully qualified international form is preferred for telephone numbers +1 555 555 1234 ext 54 but as these are likely to be human-entered any form is permitted. A telephone number may be qualified with attributes describing its uses. These attributes are separated from the number by a NUL character. The following attributes are initially defined: home This is a residence phone number work This is an office phone number msg This number has voice messaging support cell This is a cellular telephone number voice This number is a voice number fax This number has fax support modem This number has modem support pager This is a pager number Newman [Page 7]
Internet Draft ACAP Addressbook Dataset Class March 1998 Thus a number such as: +1 555 555 1234 ext 54<NUL>office<NUL>voice<NUL>msg Indicates an office voice phone with voice messaging. The intention is to keep the telephone attributes aligned with the vCARD [VCARD] specification. The formal syntax is as follows: abook-phone = 1*TEXT-UTF8-CHAR *(NUL abook-use-attribute) abook-use-attribute = "home" / "work" / "msg" / "cell" / "voice" / "fax" / "modem" / "pager" / abook-use-ext abook-use-ext = 1*ATOM-CHAR ;; as defined by future RFCs addressbook.Telephone This is the primary telephone number for the person referred to by the entry. addressbook.TelephoneOther This multi-valued attribute may hold additional telephone numbers. 4.6. Postal Address Attributes Postal addresses should be in the same format that they appear on an envelope, preferably fully qualified. The multiple lines are CRLF separated within the attribute. addressbook.Postal This contains the preferred postal address for the person or entity referred to by the entry. Attributes may be added to the end of the address with a NUL separator. The attributes "home" and "work" are initially defined to refer to home and work addresses. abook-postal = 1*TEXT-UTF8-CHAR *(CRLF *TEXT-UTF8-CHAR) *(NUL abook-postal-attr) abook-postal-attr = "home" / "work" / abook-use-ext Newman [Page 8]
Internet Draft ACAP Addressbook Dataset Class March 1998 addressbook.PostalOther This is a multi-valued attribute which contains alternate postal addresses. This uses the same syntax as the Postal attribute. 4.7. Commentary Attributes These are free-form text attributes used to store commentary about the entry. addressbook.Comment This is a free-form comment field where the owner of the addressbook may put comments about the person or entity referred to by the entry. abook-comment = 1*UTF8-CHAR addressbook.Description This is a free-form comment field for a self-description of the person or entity referred to by the entry. It is primarily used when an entry is imported from a remote directory. abook-description = 1*UTF8-CHAR 4.8. Locational Attributes These contain information about the location of the person or entity referred to by this entry. addressbook.Organization If the person or entity to which the entry refers is a member of an organization, this attribute contains the name of that organization. abook-organization = 1*TEXT-UTF8-CHAR addressbook.Title This is the title of the person referred to by the entry. abook-title = 1*TEXT-UTF8-CHAR addressbook.Locality This is the name of the locality where the person or entity is normally located. Newman [Page 9]
Internet Draft ACAP Addressbook Dataset Class March 1998 abook-locality = 1*TEXT-UTF8-CHAR addressbook.Country This is the ISO 3166 country code where the person or entity is normally located. abook-country = 2*3ALPHA addressbook.Language This is the language code [LANG-TAGS] for the language which the person or entity prefers to speak. abook-language = Language-Tag ;; as defined in [LANG-TAGS] addressbook.LanguageOther This is a multi-valued attribute containing language tags [LANG-TAGS] for alternate languages which the person or entity can speak. 4.9. PGP Public Keys The PGP public key for a correspondent MAY be included in the addressbook entry. Note that a field is not defined at this time for X.509 public keys, but may be defined in the future when an IETF profile of X.509 public keys is completed. addressbook.PGP.bin This holds the binary form of the primary signature PGP public key for the person or entity referred to by the addressbook entry. The format is as documented in [PGP-FMT]. Clients MUST check the version number field to permit future versions. abook-pgp = *OCTET ;; as defined in [PGP-FMT] addressbook.PGPOther.bin This is a multi-valued attribute containing alternate PGP public keys for this entry. It is assumed that the purpose for the alternate keys is encoded in the key format itself. Newman [Page 10]
Internet Draft ACAP Addressbook Dataset Class March 1998 5. Examples Some sample entries: In addressbook /addressbook/user/hubert attribute name value -------------- ----- entry ABC123 addressbook.CommonName Patrik Faltstrom addressbook.GivenName Patrik addressbook.Surname Faltstrom addressbook.Email paf@swip.net addressbook.CommonName.MIME =?ISO-8859-1?Q?Patrik_F=E4ltstr=F6m?= addressbook.Expand.Address paf@swip.net addressbook.Expand.Complete =?ISO-8859-1?Q?Patrik_F=E4ltstr=F6m?= <paf@swip.net> entry ABC567 addressbook.CommonName Terry Gray addressbook.GivenName Terry addressbook.Surname Gray addressbook.Alias teg addressbook.Email gray@cac.washington.edu addressbook.Expand.Address gray@cac.washington.edu addressbook.Expand.Complete Terry Gray <gray@cac.washington.edu> entry defghi subdataset . addressbook.List 1 addressbook.CommonName List of Two addressbook.CommonName.MIME List of Two addressbook.Expand.Address paf@swip.net gray@cac.washington.edu fred@bedrock.com addressbook.Expand.Complete =?ISO-8859-1?Q?Patrik_F=E4ltstr=F6m?= <paf@swip.net> Terry Gray <gray@cac.washington.edu> Fred Flintstone <fred@bedrock.com> In dataset /addressbook/user/hubert/defghi entry xyz1 addressbook.Reference ../ABC123 addressbook.Expand.Address paf@swip.net addressbook.Expand.Complete =?ISO-8859-1?Q?Patrik_F=E4ltstr=F6m?= <paf@swip.net> Newman [Page 11]
Internet Draft ACAP Addressbook Dataset Class March 1998 entry xyz2 addressbook.Reference ../ABC567 addressbook.Expand.Address gray@cac.washington.edu addressbook.Expand.Complete Terry Gray <gray@cac.washington.edu> entry z2t addressbook.CommonName Fred Flintstone addressbook.GivenName Fred addressbook.Surname Flintstone addressbook.Email fred@bedrock.com addressbook.CommonName.MIME Fred Flintstone addressbook.Expand.Address fred@bedrock.com addressbook.Expand.Complete Fred Flintstone <fred@bedrock.com> 6. Mapping vCards to ACAP addressbooks An ACAP addressbook is a good place to store vCards [VCARD]. It provides access to business cards of your contacts from any machine you use regularly, complete with the ability to annotate the contact information. This section describes a preliminary mapping from vCards. The intention is to map vCard attributes which do not have equivalents in this specification to an "addressbook.<attr>" attribute where <attr> is the vCard attribute name. A future specification will define this mapping precisely. 7. References [ABNF] Crocker, Overell, "Augmented BNF for Syntax Specifications: ABNF", RFC 2234, Internet Mail Consortium, Demon Internet Ltd, November 1997. [ACAP] Newman, Myers, "ACAP -- Application Configuration Access Protocol", RFC 2244, Innosoft, Netscape, November 1997. [BASIC-URL] Berners-Lee, Masinter, McCahill, "Uniform Resource Locators (URL)", RFC 1738, CERN, Xerox Coproration, University of Minnesota, December 1994. [IMAIL] Crocker, "Standard for the Format of ARPA Internet Text Messages", STD 11, RFC 822, University of Delaware, August 1982. [IMAP4] Crispin, "Internet Message Access Protocol - Version 4rev1", RFC 2060, University of Washington, December 1996. [KEYWORDS] Bradner, "Key words for use in RFCs to Indicate Requirement Levels", RFC 2119, Harvard University, March 1997. Newman [Page 12]
Internet Draft ACAP Addressbook Dataset Class March 1998 [LANG-TAGS] Alvestrand, H., "Tags for the Identification of Languages", RFC 1766, March 1995. [MBOX-NAMES] Crocker, D., "Mailbox Names for Common Services, Roles and Functions", RFC 2142, Internet Mail Consortium, May 1997. [PGP-FMT] Atkins, Stallings, Zimmermann, "PGP Message Exchange Formats", RFC 1991, MIT, Comp-Comm Consulting, Boulder Software Engineering, August 1996. [REL-URL] Fielding, "Relative Uniform Resource Locators", RFC 1808, UC Irvine, June 1995. [SMTP] Postel, "Simple Mail Transfer Protocol", RFC 821, Information Sciences Institute, August 1982. [UTF8] Yergeau, "UTF-8, a transformation format of ISO 10646", RFC 2279, Alis Technologies, January 1998. [VCARD] Dawson, Howes, "vCard MIME Directory Profile", Lotus, Netscape Communications, Work in Progress. [WHITE-SCHEMA] Genovese, Jennings, "A Common Schema for the Internet White Pages Service", RFC 2218, Microsoft, Sandia National Laboratory, October 1997. 8. Security Considerations It is important to make sure that access controls are set correctly on personal addressbooks. One should be careful of sharing information which might contain personal comments. If PGP public keys are stored in a personal addressbook it would be wise to use an ACAP protocol security layer which provides at least integrity protection. 9. Authors' Addresses Chris Newman Innosoft International, Inc. 1050 Lakes Drive West Covina, CA 91790 USA Email: chris.newman@innosoft.com Newman [Page 13]
Internet Draft ACAP Addressbook Dataset Class March 1998 Steve Hubert Networks and Distributed Computing University of Washington 4545 15th Ave. NorthEast Seattle, WA 98105-4527 USA Email: hubert@cac.washington.edu Newman [Page 14]
Internet Draft ACAP Addressbook Dataset Class March 1998 Appendix A. Attribute Index addressbook.Alias .......................................... 4 addressbook.AlternateNames ................................. 4 addressbook.Comment ........................................ 9 addressbook.CommonName ..................................... 3 addressbook.CommonName.MIME ................................ 4 addressbook.Country ........................................ 10 addressbook.Description .................................... 9 addressbook.Email .......................................... 5 addressbook.EmailOther ..................................... 5 addressbook.Expand.Address ................................. 6 addressbook.Expand.Complete ................................ 6 addressbook.GivenName ...................................... 3 addressbook.HomePage ....................................... 7 addressbook.HomePageOther .................................. 7 addressbook.Language ....................................... 10 addressbook.LanguageOther .................................. 10 addressbook.List ........................................... 5 addressbook.List.Help ...................................... 7 addressbook.List.Subscribe ................................. 6 addressbook.List.Unsubscribe ............................... 6 addressbook.Locality ....................................... 9 addressbook.MiddleName ..................................... 3 addressbook.Organization ................................... 9 addressbook.PGP.bin ........................................ 10 addressbook.PGPOther.bin ................................... 10 addressbook.Postal ......................................... 8 addressbook.PostalOther .................................... 9 addressbook.Prefix ......................................... 3 addressbook.Reference ...................................... 5 addressbook.Subscribed ..................................... 7 addressbook.Suffix ......................................... 3 addressbook.Surname ........................................ 3 addressbook.Telephone ...................................... 8 addressbook.TelephoneOther ................................. 8 addressbook.Title .......................................... 9 entry ...................................................... 2 subdataset ................................................. 2 Newman [Page 15]
