Network Working Group M. Riegel Internet-Draft Siemens AG Category: Standards Track G. Zorn Microsoft Corporation June 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 December 25, 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 Riegel, Zorn Expires December 1999 [Page 1] Internet-Draft Phone Book XML DTD June 1999 - Promoting a standard phone book format, to enhance interoperability between ISPs and roaming consortia - Defining a compact structure containing the essential information for the roaming user, to allow for storage and easy update even on small devices. It is not intended by this document to create a "Swiss army knife", with phone book elements to please everyone on Earth, neither to define any kind of phone book update or transfer protocol. 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. Riegel, Zorn Expires December 1999 [Page 2] Internet-Draft Phone Book XML DTD June 1999 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]. 5. Value type notations for 'stronger' typing XML currently does not have capabilities for 'strong typing' of the content of elements. The only type definition foreseen in the base specification is "#PCDATA", 'parsable character data'. This might be sufficient and is used throughout this document to define elements containing information mainly aimed for interpretation by human beings. 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 in cases where it seems to be desirable. 6. Phone Book Element Definitions The phoneBook element is the basic container for phone book entries. It always contains a phone book name, a phone book version number (applying to the phone book as a whole) and one or more pop elements. A phoneBook element may also contain multiple Setup, Support and Provider elements, if they are referenced to by more than one pop element. Riegel, Zorn Expires December 1999 [Page 3] Internet-Draft Phone Book XML DTD June 1999 phoneBook +-----------------------+ | phoneBookName | | phoneBookVersion | | +-----------------+ | | | pop |+ | | +-----------------+| | | + - - - - - - - - + | | | | + - - - - - - - - + | | | setup |+ | | + - - - - - - - - +| | | + - - - - - - - - + | | | | + - - - - - - - - + | | | support |+ | | + - - - - - - - - +| | | + - - - - - - - - + | | | | + - - - - - - - - + | | | provider |+ | | + - - - - - - - - +| | | + - - - - - - - - + | +-----------------------+ Syntax: 6.1. Phone Book Name The phoneBookName element is an arbitrary string assigned as an identifier for a phone book. Syntax: Riegel, Zorn Expires December 1999 [Page 4] Internet-Draft Phone Book XML DTD June 1999 6.2. Phone Book Version 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 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. Syntax: 6.3. POP The pop element contains information elements relevant to individual network points of presence (POPs). The required information 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. Syntax: 6.4. Setup The Setup element includes information elements which describe services which may change from provider to provider or even from POP to POP. Some of the values contained in these information elements may be available by other means (e.g., DHCP), but others may not. Syntax: 6.5. Support The Support element includes those information elements that are pertinent to the provision of customer support for a POP or provider. Syntax: Riegel, Zorn Expires December 1999 [Page 6] Internet-Draft Phone Book XML DTD June 1999 6.6. Provider The Provider element contains information elements pertaining to the general business operations of a given network service provider. The information 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. Syntax: 7. Information Element Definitions 7.1. New information elements defined for the POP element 7.1.1. Address Family 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 Riegel, Zorn Expires December 1999 [Page 7] Internet-Draft Phone Book XML DTD June 1999 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 Syntax: 7.1.2. Address 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"). Syntax: 7.1.3. Media The media element describes the types of media supported by this POP. The following values are defined: Type Value Riegel, Zorn Expires December 1999 [Page 8] Internet-Draft Phone Book XML DTD June 1999 ----------- ----- Modem 1 ISDN 2 ATM 3 Frame Relay 4 X.25 5 SMDS 6 Syntax: 7.1.4. Entry Version 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. Syntax: 7.1.5. Encoding Type 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. Syntax: 7.1.6. Modem Protocols The modemProtocols element is a hex encoded 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. Riegel, Zorn Expires December 1999 [Page 9] Internet-Draft Phone Book XML DTD June 1999 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 V34b 0x0040 Full 33.6k ITU-T V.34bis V90 0x0080 Full 56k ITU-T V.90 Syntax 7.1.7. ISDN Protocols The isdnProtocols element is a hex encoded 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 0x0d (00001101) 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 X75 0x0010 64k ITU-T X.75 PPP 0x0020 64k RFC 1618 Syntax: 7.1.8. City 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 Riegel, Zorn Expires December 1999 [Page 10] Internet-Draft Phone Book XML DTD June 1999 call). Syntax: 7.1.9. Region 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. Syntax: 7.1.10. Country 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. Syntax: 7.1.11. Country Code The countryCode element indicates the international dialing prefix for the country in which the POP is located. Syntax: 7.1.12. Minimum Data Rate The minBitsPerSecond element indicates the minimum data rate (in bits/second) supported by the access devices at the POP. Syntax: Riegel, Zorn Expires December 1999 [Page 11] Internet-Draft Phone Book XML DTD June 1999 7.1.13. Maximum Data Rate The maxBitsPerSecond element indicates the maximum data rate (in bits/second) supported by the access devices at the POP. Syntax: 7.1.14. Area Code 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.1.15. Unicast Routing Protocols The unicastRoutingProtocols element is a hex encoded 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 unsupported. Position Protocol -------- -------- 0x0001 Static 0x0002 RIP v1 0x0004 RIP v2 0x0008 OSPF 0x0010 IS-IS 0x0020 IGRP 0x0040 EIGRP 0x0080 BGP Syntax: Riegel, Zorn Expires December 1999 [Page 12] Internet-Draft Phone Book XML DTD June 1999 7.1.16. Multicast Routing Protocols The multicastRoutingProtocols element is a hex encoded 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 Syntax: 7.1.17. Dial Script Type The dialScript element indicates the type of dialing script that should be used when connecting to this POP. Syntax: 7.1.18. Dialing Script The dialScript element contains the dialing script to be used when connecting to this POP. Syntax: Riegel, Zorn Expires December 1999 [Page 13] Internet-Draft Phone Book XML DTD June 1999 7.1.19. Pricing Information 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. Syntax: 7.1.20. Tunneling Protocols The tunnelingProtocols element is a hex encoded 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 Syntax: 7.1.21. POP Properties The popProperties element is a hex encoded 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. Riegel, Zorn Expires December 1999 [Page 14] Internet-Draft Phone Book XML DTD June 1999 Position Property -------- ---------------------- 0x0001 Multilink 0x0002 Mobile IP 0x0004 Multicast Reception 0x0008 Multicast Transmission Syntax: 7.1.22. POP Setup The popSetup element is either a setup element, if setup is specific to this particular POP, or a reference to any of the setup elements given in the outer scope of the phonebook element. Syntax: 7.1.23. POP Support The popSupport element is either a support element, if support is specific to this particular POP, or a reference to any of the support elements given in the outer scope of the phonebook element. Syntax: 7.1.24. POP Provider The popProvider element is either a provider element, if provider information is specific to this particular POP, or a reference to any of the provider elements given in the outer scope of the phonebook Riegel, Zorn Expires December 1999 [Page 15] Internet-Draft Phone Book XML DTD June 1999 element. Syntax: 7.2. New information elements defined for the Setup element 7.2.1. DNS Server Address 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). Syntax: 7.2.2. NNTP Server Name 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. Syntax: 7.2.3. SMTP Server Name The smtpServerName element contains the FQDN of the Simple Mail Transfer Protocol (SMTP) server which should be used when connected to this POP. Riegel, Zorn Expires December 1999 [Page 16] Internet-Draft Phone Book XML DTD June 1999 Syntax: 7.2.4. POP3 Server Name The popServerName element contains the FQDN of the Post Office Protocol (POP) server which should be used when connected to this POP. Syntax: 7.2.5. IMAP Server Name The imapServerName element contains the FQDN of the Internet Mail Access Protocol (IMAP) server which should be used when connected to this POP. Syntax: 7.2.6. WWW Proxy The wwwProxyServerName element contains the FQDN of the World Wide Web (WWW) proxy server which should be used when connected to this POP. Syntax: Riegel, Zorn Expires December 1999 [Page 17] Internet-Draft Phone Book XML DTD June 1999 7.2.7. FTP Proxy The ftpProxyServerName element contains the FQDN of the File Transfer Protocol (FTP) proxy server which should be used when connected to this POP. Syntax: 7.2.8. Winsock Proxy The winsockProxyServerName element contains the FQDN of the Windows Socket (Winsock) proxy server which should be used when connected to this POP. Syntax: 7.2.9. Default Gateway Address 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). Syntax: 7.2.10. User Name Suffix 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 Riegel, Zorn Expires December 1999 [Page 18] Internet-Draft Phone Book XML DTD June 1999 be applied to the same base username. Syntax: 7.2.11. User Name Prefix 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. Syntax: 7.3. New information elements defined for the support element 7.3.1. Support Telephone Number 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". Syntax: 7.3.2. Support Languages The supportLanguages element contains a comma-separated list of languages spoken by the staff at the support center at supportTelephoneNumber. Syntax: Riegel, Zorn Expires December 1999 [Page 19] Internet-Draft Phone Book XML DTD June 1999 7.3.3. Support Email Address 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. Syntax: 7.4. New information elements defined for the provider element 7.4.1. Provider Name The providerName element is a string containing the name of the provider (e.g., "BIGNET Corporation"). Syntax: 7.4.2. Provider Icon The providerIcon attribute contains a BASE64 encoded JPEG or GIF image which may be used for 'branding' phone book entries or displayed when dialing. Syntax: 7.4.3. Provider's World Wide Web URL The wwwURL element contains a Uniform Resource Locator (URL) for the provider's Web site, for example, http://www.uu.net. Syntax: Riegel, Zorn Expires December 1999 [Page 20] Internet-Draft Phone Book XML DTD June 1999 7.4.4. Provider's Main Email Address 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. Syntax: 7.4.5. Billing Inquiry Email Address 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. Syntax: 7.4.6. Further elements The remainder of the information elements of the provider element are described in [3]. 8. Complete XML DTD for the roaming phone book Riegel, Zorn Expires December 1999 [Page 23] Internet-Draft Phone Book XML DTD June 1999 Riegel, Zorn Expires December 1999 [Page 24] Internet-Draft Phone Book XML DTD June 1999 Riegel, Zorn Expires December 1999 [Page 25] Internet-Draft Phone Book XML DTD June 1999 Riegel, Zorn Expires December 1999 [Page 26] Internet-Draft Phone Book XML DTD June 1999 Riegel, Zorn Expires December 1999 [Page 27] Internet-Draft Phone Book XML DTD June 1999 9. Security Considerations In the current revision there are no security specific elements provided within the phone book XML DTD. Security has to be provided outside of the scope of the phone book. Security specific items, like a signature for authentication the content of the phone book, may be added in a later revision, if standards are available for generating digital signatures in XML. 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. Riegel, Zorn Expires December 1999 [Page 28] Internet-Draft Phone Book XML DTD June 1999 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 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-01.txt and expires on December 25, 1999. Riegel, Zorn Expires December 1999 [Page 29]