From: http://www.ietf.org/internet-drafts/draft-ietf-roamops-phonebook-xml-00.txt Date: 1999-03-09 --------------------------------------------------------------------------- Network Working Group M. Riegel Internet-Draft Siemens AG Category: Standards Track G. Zorn Microsoft Corporation Feb 1999 XML DTD for Phone Books 1. Status of this Memo This document is an Internet-Draft and is in full conformance with all provisions of Section 10 of RFC2026. 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. The distribution of this memo is unlimited. It is filed as , and expires August 15, 1999. Please send comments to the Roaming Operations Working Group mailing list (roamops@tdmx.rutgers.edu) or to the editor of this draft (maximilian.riegel@icn.siemens.de). 2. Abstract This document describes the information to be included in the standard phone book for roaming applications. All data is described in XML [5] (Extensible Markup Language) syntax leading to a concise XML DTD (Document Type Declaration) for the phone book. Goals of this document include: - Creating a flexible, extensible and robust framework upon which to build a standard phone book - Promoting a standard phone book format, to enhance interoperability between ISPs and roaming consortia Riegel, Zorn Expires August 1999 [Page 1] Internet-Draft Phone Book XML DTD February 1999 Non-goals of this document include: - Attempting to create a "Swiss army knife", with phone book elements to please everyone on Earth - Definition of either server-server or client-server phone book update or transfer protocols 3. Rationale for XML Usage XML is rapidly becoming a standard format for data exchange between different applications also taking into account the transfer and access of data over the web. XML is used as syntax for expressing the structure and content of a roaming phone book to enable widespread usage and access to many different kind of media (e.g. paper, CDROM, www) using a widespread selection of access devices. Furthermore XML enables: - Extensibility - Flexibility - Integration with directories Extensibility is important because phone books are living documents; as such, it is unlikely that all the semantic requirements of arbitrary Internet service providers (ISPs) would be met by a fixed scheme, no matter how well thought out. Phone book designers must be free to create new attributes in a well-understood fashion to meet changing business needs. Flexibility is required of the attribute definition syntax for many of the same reasons that semantic extensibility is necessary. If we assume that phone book designers may need to define elements of arbitrary type, the syntax chosen must be able to represent these data objects cleanly. Using XML for describing the data content of the phone book fits this bill nicely, since it can be used to unambiguously describe virtually any data type. Integration with directories: although it is unlikely that phone books will be stored in the directory due to performance considerations, the creation of a XML DTD describing phone book content leaves that option open, with relatively little incremental effort required to implement it. 4. Specification of Requirements In this document, the key words "MAY", "MUST, "MUST NOT", "optional", "recommended", "SHOULD", and "SHOULD NOT", are to be interpreted as described in [1]. Riegel, Zorn Expires August 1999 [Page 2] Internet-Draft Phone Book XML DTD February 1999 5. Value type notations for 'stronger' typing XML does not have capabilities for 'strong typing' of the content of elements. The only type definition foreseen in the base specification is "#PCDATA", 'parseable character data' comprising everything. To enable a more concise description of the content of particular elements several value type notations are introduced. This allows for a more detailed type description of the content of elements. 6. Phone Book Element Definitions This document includes definitions of the following components: - Phone Book - Provider - POP - Support - Setup 6.1. Phone Book 6.1.1. Description The Phone Book element is the basic container for phone book entries. It always contains a phone book version number (applying to the phone book as a whole), a phone book name and one or more references to POP objects. A Phone Book element may also contain multiple references to Provider and Setup elements (described below). Riegel, Zorn Expires August 1999 [Page 3] Internet-Draft Phone Book XML DTD February 1999 6.1.2. Syntax 6.2. Provider 6.2.1. Description The Provider element contains child elements pertaining to the general business operations of a given network service provider. The child elements include such things as telephone number, mailing address, etc., as well as URLs for e-mail and a World Wide Web site. A Provider element may also contain a reference to support information. 6.2.2. Syntax Riegel, Zorn Expires August 1999 [Page 4] Internet-Draft Phone Book XML DTD February 1999 6.3. POP 6.3.1. Description The POP element contains child elements relevant to individual network points of presence (POPs). The required child elements are addrFamily, address, media and entryVersion. The media element represents the media types supported by the POP, while the entryVersion element is a monotonically-increasing integer which should be incremented whenever the object is modified. 6.3.2. Syntax 6.4. Support 6.4.1. Description The Support element includes those child elements that are pertinent to the provision of customer support for a POP or provider. Riegel, Zorn Expires August 1999 [Page 5] Internet-Draft Phone Book XML DTD February 1999 6.4.2. Syntax 6.5. Setup 6.5.1. Description The Setup element includes child elements which describe services which may change from provider to provider or even from POP to POP. Many of the values contained in these child elements may be available by other means (e.g., DHCP), but others may not. 6.5.2. Syntax in +0.3i 7. Child Element Definitions 7.1. Child elements defined for the Phone Book element 7.1.1. Phone Book Version 7.1.1.1. Description The phoneBookVersion attribute is an integer representing the version of the phone book; it is a monotonically increasing counter which should be incremented each time the phone book is modified. This element can be used by a server to help decide what (if any) actions are required to bring a client's phone book up to date. For example, the client can, at connect time, send an update request to the server including in the request the version number of its current phone Riegel, Zorn Expires August 1999 [Page 6] Internet-Draft Phone Book XML DTD February 1999 book. If the client's phone book version is not the same as the server's current phone book version, the server can easily take appropriate action, e.g., reply with a URL pointing to a file containing the differences between the client and server phone books. 7.1.1.2. Syntax 7.1.2. Phone Book Name 7.1.2.1. Description The phoneBookName element is an arbitrary string assigned as an identifier for a phone book. 7.1.2.2. Syntax 7.1.3. POP Pointer 7.1.3.1. Description The popPointer element is a reference pointing to a POP element for this phone book. 7.1.3.2. Syntax 7.1.4. Setup Pointer 7.1.4.1. Description The setupPointer element is a reference pointing to a Setup element for this phone book. 7.1.4.2. Syntax 7.1.5. Provider Pointer 7.1.5.1. Description The providerPointer element is a reference pointing to a Provider element for this phone book. 7.1.5.2. Syntax 7.1.6. Support Pointer 7.1.6.1. Description The supportPointer element is a reference pointing to a Support element for this phone book. 7.1.6.2. Syntax 7.2. New child elements defined for the Provider element 7.2.1. Provider Name 7.2.1.1. Description The providerName element is a string containing the name of the provider (e.g., "BIGNET Corporation"). 7.2.1.2. Syntax 7.2.2. Provider Icon Riegel, Zorn Expires August 1999 [Page 8] Internet-Draft Phone Book XML DTD February 1999 7.2.2.1. Description The providerIcon attribute contains a JPEG graphic which may be used for 'branding' phone book entries or displayed when dialing. 7.2.2.2. Syntax 7.2.3. Provider's World Wide Web URL 7.2.3.1. Description The wwwURL element contains a Uniform Resource Locator (URL) for the provider's Web site, for example, http://www.uu.net. 7.2.3.2. Syntax 7.2.4. Provider's Main Email Address 7.2.4.1. Description The generalMailtoURL element contains a URL for the provider's main email address, for example, mailto://contact@uu.net. This URL could be used for general correspondence, complaints, etc. 7.2.4.2. Syntax 7.2.5. Billing Inquiry Email Address 7.2.5.1. Description The billingMailtoURL element contains a URL for the provider's billing support email address, for example, mailto://billing@uu.net. This URL could be used to for correspondence regarding billing and payment issues. Riegel, Zorn Expires August 1999 [Page 9] Internet-Draft Phone Book XML DTD February 1999 7.2.5.2. Syntax 7.2.6. Further elements The remainder of the child elements of the Provider element are described in [3]. 7.3. New child elements defined for the POP element 7.3.1. Address Family 7.3.1.1. Description The addrFamily element is an integer which represents the address family to which the value in the address attribute (below) belongs. For POPs offering dial-up network access, the addrFamily attribute will generally contain a value for a telephone network based address family. The current list of IANA-assigned address family numbers is reproduced below for convenience; for an up-to-date list, see [2]. Number Description ------ -------------------------------------- 0 Reserved 1 IP (IP version 4) 2 IP6 (IP version 6) 3 NSAP 4 HDLC (8-bit multidrop) 5 BBN 1822 6 802 (includes all 802 media plus Ethernet "canonical format") 7 E.163 8 E.164 (SMDS, Frame Relay, ATM) 9 F.69 (Telex) 10 X.121 (X.25, Frame Relay) 11 IPX 12 Appletalk 13 Decnet IV 14 Banyan Vines 65535 Reserved Riegel, Zorn Expires August 1999 [Page 10] Internet-Draft Phone Book XML DTD February 1999 7.3.1.2. Syntax 7.3.2. Address 7.3.2.1. Description The address element in a binary quantity representing the address of the POP. For POPs offering dial-up network access, the address attribute will generally contain an IA5 string representing a telephone number, formatted in standard fashion [4] (e.g. "+ 1 234 5678"). 7.3.2.2. Syntax 7.3.3. Media 7.3.3.1. Description The media element describes the types of media supported by this POP. The following values are defined: in +0.3i Type Value ----------- ----- Modem 1 ISDN 2 ATM 3 Frame Relay 4 X.25 5 SMDS 6 NH 4 Syntax Riegel, Zorn Expires August 1999 [Page 11] Internet-Draft Phone Book XML DTD February 1999 7.3.4. Entry Version NH 4 Description The entryVersion element is an integer representing the version of the POP object; it is a monotonically increasing counter which should be incremented each time the object is modified. This attribute may be useful in merging and updating phone books. 7.3.4.1. Syntax 7.3.5. Encoding Type 7.3.5.1. Description The encodingType element is an integer representing the type of encoding used within a specific address family The value '0' is reserved and represents the native encoding. 7.3.5.2. Syntax 7.3.6. Modem Protocols 7.3.6.1. Description in +0.3i The modemProtocols element is a bit string representing the modem protocols supported by the access devices that can be reached at address. The initially defined modem protocol flags are listed in the table below. All 'Position' values are in hexadecimal, all 'Speed' values are in bits per second. If the bit in 'Position' is 1, 'Protocol' is supported; otherwise, 'Protocol' is unsupported. For example, the string 00110001 (0x31) means that V.21, V.32bis and V.34 are supported while V.22, V.29 and V.32 are not. Name Position Duplex Speed Protocol ---- -------- ------ ----- ------------- V21 0x0001 Full 300 ITU-T V.21 V22 0x0002 Full 1200 ITU-T V.22 V29 0x0004 Half 9600 ITU-T V.29 V32 0x0008 Full 9600 ITU-T V.32 V32b 0x0010 Full 14.4k ITU-T V.32bis V34 0x0020 Full 28.8k ITU-T V.34 VF 0x0040 Full V.FAST Riegel, Zorn Expires August 1999 [Page 12] Internet-Draft Phone Book XML DTD February 1999 Question: Are these flags useful? If so, are there more that need to be added? 7.3.6.2. Syntax 7.3.7. ISDN Protocols 7.3.7.1. Description The isdnProtocols element is a bit string representing the ISDN protocols supported by the access devices that can be reached at address. The initially defined ISDN protocols are listed in the table below. All 'Value. values are in hexadecimal, all 'Speed' values are in bits per second. If the bit in 'Position' is 1, 'Protocol' is supported; otherwise, 'Protocol' is unsupported. For example, the string 00001101 (0x0d) means that V.120 is supported at both 56K and 64K bps while V.110 is supported only at 19.2K bps. Name Value Speed Meaning ----- ------ ----- ----------- V110L 0x0001 19.2k ITU-T V.110 V110H 0x0002 38.4k ITU-T V.110 V120L 0x0004 56k ITU-T V.120 V120H 0x0008 64k ITU-T V.120 Question: Are the ISDN flags useful? If so, should there be more? 7.3.7.2. Syntax 7.3.8. City 7.3.8.1. Description in +0.3i The city element contains the name of the city in which the POP is located (not the city(s) from which it is accessible by a local call). Riegel, Zorn Expires August 1999 [Page 13] Internet-Draft Phone Book XML DTD February 1999 7.3.8.2. Syntax 7.3.9. Region NH 4 Description The region element contains the name of the region in which the POP is located. In the United States, this would be the name of a state or (for Washington, D.C.) administrative district. In other countries, it might be the name of a province, parish or county. 7.3.9.1. Syntax 7.3.10. Country 7.3.10.1. Description The country element contains the name of the country in which the POP is located. The country name may be abbreviated (e.g., "USA" for the United States of America or "UK" for the United Kingdom) but if abbreviations are used the usage must be consistent within a given phone book. 7.3.10.2. Syntax 7.3.11. Country Code 7.3.11.1. Description The countryCode element indicates the international dialing prefix for the country in which the POP is located. NH 4 Syntax Riegel, Zorn Expires August 1999 [Page 14] Internet-Draft Phone Book XML DTD February 1999 7.3.12. Minimum Data Rate 7.3.12.1. Description The minBitsPerSecond element indicates the minimum data rate (in bits/second) supported by the access devices at the POP. 7.3.12.2. Syntax 7.3.13. Maximum Data Rate 7.3.13.1. Description The maxBitsPerSecond element indicates the maximum data rate (in bits/second) supported by the access devices at the POP. 7.3.13.2. Syntax 7.3.14. Area Code 7.3.14.1. Description The areaCode element contains the area or city code component of the telephone number in the 'address' element (if any) associated with this POP. 7.3.14.2. Syntax 7.3.15. Unicast Routing Protocols 7.3.15.1. Description The unicastRoutingProtocols element is a bitstring representing the unicast routing protocols supported by this POP. The initially defined values are listed in the table below. If the bit in 'Position' is 1, 'Protocol' is supported; otherwise, 'Protocol' is Riegel, Zorn Expires August 1999 [Page 15] Internet-Draft Phone Book XML DTD February 1999 unsupported. Position Protocol -------- -------- 0x0001 Static 0x0002 RIP v1 0x0004 RIP v2 0x0008 OSPF 0x0010 IS-IS 0x0020 IGRP 0x0040 EIGRP 0x0080 BGP 7.3.15.2. Syntax 7.3.16. Multicast Routing Protocols 7.3.16.1. Description The multicastRoutingProtocols element is a bitstring representing the multicast routing protocols supported by this POP. The initially defined values are listed in the table below. If the bit in 'Position' is 1, 'Protocol' is supported; otherwise, 'Protocol' is unsupported. Position Protocol -------- ---------- 0x0001 Static 0x0002 DVMRP 0x0004 SM-PIM 0x0008 DM-PIM 0x0010 CBT v1 0x0020 CBT v2 0x0040 BGMP 0x0080 Proxy IGMP 7.3.16.2. Syntax Riegel, Zorn Expires August 1999 [Page 16] Internet-Draft Phone Book XML DTD February 1999 7.3.17. Dial Script Type 7.3.17.1. Description The dialScript element indicates the type of dialing script that should be used when connecting to this POP. Question: What kinds of scripts are there? 7.3.17.2. Syntax 7.3.18. Dialing Script 7.3.18.1. Description The dialScript element contains the dialing script to be used when connecting to this POP. 7.3.18.2. Syntax 7.3.19. Pricing Information 7.3.19.1. Description The pricing element is a free-form string representing pricing information for this POP. It may be anything from a simple string indicating relative expense (e.g., "$$$$" for a very expensive POP) to a paragraph describing time-of-day and other differential pricing variables. 7.3.19.2. Syntax 7.3.20. Tunneling Protocols Riegel, Zorn Expires August 1999 [Page 17] Internet-Draft Phone Book XML DTD February 1999 7.3.20.1. Description The tunnelingProtocols element is a bitstring representing the tunneling protocols supported by this POP. The initially defined values are listed in the table below. If the bit in 'Position' is 1, 'Protocol' is supported; otherwise, 'Protocol' is unsupported. Position Protocol -------- ------------------ 0x0001 PPTP 0x0002 L2F 0x0004 L2TP 0x0008 ATMP 0x0010 VTP 0x0020 IP AH Tunnel Mode 0x0040 IP-IP 0x0080 Minimal IP-IP 0x0100 IP ESP Tunnel Mode 0x0200 GRE 0x0400 Bay DVS 7.3.20.2. Syntax 7.3.21. POP Properties 7.3.21.1. Description The popProperties element is a bitstring representing a variety of Boolean properties characterizing this POP. The initially defined properties are listed in the table below. If the bit in 'Position' is 1, 'Property' is supported; otherwise, 'Property' is unsupported. in +0.3i Position Property -------- ---------------------- 0x0001 Multilink 0x0002 Mobile IP 0x0004 Multicast Reception 0x0008 Multicast Transmission 7.3.21.2. Syntax Riegel, Zorn Expires August 1999 [Page 18] Internet-Draft Phone Book XML DTD February 1999 7.3.22. POP Setup Pointer 7.3.22.1. Description The popSetupPointer element is a Distinguished Name which points to a Setup object for this POP. 7.3.22.2. Syntax 7.3.23. POP Support Pointer 7.3.23.1. Description The popSupportPointer element is a Distinguished Name which points to a Support object for this POP. 7.3.23.2. Syntax 7.3.24. POP Provider Pointer 7.3.24.1. Description The popProviderPointer element is a Distinguished Name which points to a Provider object for this POP. 7.3.24.2. Syntax 7.4. New child elements defined for the Support element Riegel, Zorn Expires August 1999 [Page 19] Internet-Draft Phone Book XML DTD February 1999 7.4.1. Support Telephone Number 7.4.1.1. Description The supportTelephoneNumber element contains a number that may be called to reach the support center for a particular provider or POP. This element is basically a string and should contain the entire telephone number in international form, e.g., "+1 425 838 8080". 7.4.1.2. Syntax in +0.3i 7.4.2. Support Languages 7.4.2.1. Description The supportLanguages element contains a comma-separated list of languages spoken by the staff at the support center at supportTelephoneNumber. Question: Is there a standard way to represent languages (like country codes for phone numbers)? 7.4.2.2. Syntax 7.4.3. Support Email Address 7.4.3.1. Description The supportMailtoURL element contains a URL for the provider's customer support email address, for example, mailto://support@uu.net. This URL could be used to contact customer support personnel regarding non-urgent issues. 7.4.3.2. Syntax Riegel, Zorn Expires August 1999 [Page 20] Internet-Draft Phone Book XML DTD February 1999 7.5. New child elements defined for the Setup element 7.5.1. DNS Server Address 7.5.1.1. Description The dnsServerAddress element represents the IP address of the Domain Name Service (DNS) server which should be used when connected to this POP. The address is represented in the form of a string in dotted- decimal notation (e.g., 192.168.101.1). 7.5.1.2. Syntax 7.5.2. NNTP Server Name 7.5.2.1. Description The nntpServerName element contains the fully qualified domain name (FQDN) of the Network News Transfer Protocol (NNTP) server which should be used when connected to this POP. 7.5.2.2. Syntax 7.5.3. SMTP Server Name 7.5.3.1. Description The smtpServerName element contains the FQDN of the Simple Mail Transfer Protocol (SMTP) server which should be used when connected to this POP. 7.5.3.2. Syntax Riegel, Zorn Expires August 1999 [Page 21] Internet-Draft Phone Book XML DTD February 1999 7.5.4. POP3 Server Name 7.5.4.1. Description The popServerName element contains the FQDN of the Post Office Protocol (POP) server which should be used when connected to this POP. 7.5.4.2. Syntax 7.5.5. IMAP Server Name 7.5.5.1. Description The imapServerName element contains the FQDN of the Internet Mail Access Protocol (IMAP) server which should be used when connected to this POP. 7.5.5.2. Syntax 7.5.6. WWW Proxy 7.5.6.1. Description The wwwProxyServerName element contains the FQDN of the World Wide Web (WWW) proxy server which should be used when connected to this POP. 7.5.6.2. Syntax 7.5.7. FTP Proxy 7.5.7.1. Description The ftpProxyServerName element contains the FQDN of the File Transfer Protocol (FTP) proxy server which should be used when connected to this POP. Riegel, Zorn Expires August 1999 [Page 22] Internet-Draft Phone Book XML DTD February 1999 7.5.7.2. Syntax 7.5.8. Winsock Proxy 7.5.8.1. Description ThewinsockProxyServerName element contains the FQDN of the Windows Socket (Winsock) proxy server which should be used when connected to this POP. 7.5.8.2. Syntax 7.5.9. Default Gateway Address 7.5.9.1. Description The defaulttGatewayAddress element represents the address of the default gateway which should be used when connected to this POP. The address is represented in the form of a string in dotted-decimal notation (e.g., 192.168.101.1). 7.5.9.2. Syntax NAME ' 7.5.10. User Name Suffix 7.5.10.1. Description The userNameSuffix element represents a string which should be concatenated to the base username. For example, if the base username is "userA" and the value of this element is "@bigco.com", the resulting augmented username would be "userA@bigco.com". An intelligent dialer may concatenate the string automatically. Note that both the userNameSuffix and the userNamePrefix (below) may be applied to the same base username. NH 4 Syntax Riegel, Zorn Expires August 1999 [Page 23] Internet-Draft Phone Book XML DTD February 1999 7.5.11. User Name Prefix 7.5.11.1. Description The userNamePrefix element represents a string to which the base username should be concatenated. For example, if the base username is "userB" and the value of this element is "BIGCO/" the resulting augmented username would be "BIGCO/userB". An intelligent dialer may perform the concatenation automatically. Note that both the userNameSuffix (above) and the userNamePrefix may be applied to the same base username. 7.5.11.2. Syntax 8. Complete XML DTD for the roaming phone book Riegel, Zorn Expires August 1999 [Page 27] Internet-Draft Phone Book XML DTD February 1999 Riegel, Zorn Expires August 1999 [Page 28] Internet-Draft Phone Book XML DTD February 1999 Riegel, Zorn Expires August 1999 [Page 29] Internet-Draft Phone Book XML DTD February 1999 Riegel, Zorn Expires August 1999 [Page 30] Internet-Draft Phone Book XML DTD February 1999 Riegel, Zorn Expires August 1999 [Page 31] Internet-Draft Phone Book XML DTD February 1999 NAME ' Riegel, Zorn Expires August 1999 [Page 32] Internet-Draft Phone Book XML DTD February 1999 9. Security Considerations None (submissions welcome). 10. References [1] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997 [2] Reynolds, J. and Postel, J., "ASSIGNED NUMBERS", STD 2, RFC 1700, October 1994 [3] Barker, P. and Kille, S., "The COSINE and Internet X.500 Schema", RFC 1274, November 1991 [4] ITU Rec. E.123, "Notation for national and international telephone numbers", 1988 [5] "Extensible Markup Language (XML) 1.0" W3C Recommendation 10-February-1998 http://www.w3org.org/TR/1998/REC-xml-19980210 11. Acknowledgements Thanks to Bernard Aboba (aboba@internaut.com), Jay Farhat (jfarhat@ipass.com), Butch Anton (butch@ipass.com), Quentin Miller (quentinm@microsoft.com), and Ken Crocker (kcrocker@microsoft.com) for salient input and review. 12. Author's Addresses Questions about this memo can be directed to: Max Riegel Siemens AG Hofmannstr. 51 Munich, 81359 Germany Phone: +49 89 722 49557 E-Mail: maximilian.riegel@icn.siemens.de Riegel, Zorn Expires August 1999 [Page 33] Internet-Draft Phone Book XML DTD February 1999 Glen Zorn Microsoft Corporation One Microsoft Way Redmond, Washington 98052 Phone: +1 425 703 1559 E-Mail: glennz@microsoft.com 13. Expiration Date This memo is filed as draft-ietf-roamops-phonebook-xml-00.txt and expires on August 15, 1999. Riegel, Zorn Expires August 1999 [Page 34]