1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
|
Network Working Group M. Riegel
Request for Comments: 3017 Siemens AG
Category: Standards Track G. Zorn
Cisco Systems
December 2000
XML DTD for Roaming Access Phone Book
Status of this Memo
This document specifies an Internet standards track protocol for the
Internet community, and requests discussion and suggestions for
improvements. Please refer to the current edition of the "Internet
Official Protocol Standards" (STD 1) for the standardization state
and status of this protocol. Distribution of this memo is unlimited.
Copyright Notice
Copyright (C) The Internet Society (2000). All Rights Reserved.
Abstract
This document defines the syntax as well as the semantics of the
information to be included in the phone book for roaming
applications. It comprises the information necessary to select the
most appropriate ISP and to configure the host to get access to the
network of the provider. The specification consists of a small set of
required information elements and a variety of possible extensions.
All data is specified in XML [5] (Extensible Markup Language) syntax
leading to a concise XML DTD (Document Type Declaration) for the
phone book.
Table of Contents
1. Introduction ............................................. 3
2. Rationale for XML Usage .................................. 4
3. Specification of Requirements ............................ 5
4. Value type notations for 'stronger' typing ............... 5
5. Container Element Definitions ............................ 5
5.1. PhoneBook ............................................ 5
5.1.1. phoneBook Attribute "name" ........................ 6
5.1.2. phoneBook Attribute "version" ..................... 6
5.2. POP .................................................. 7
5.2.1. pop Attribute "entryVersion" ...................... 8
5.3. Setup ................................................ 8
5.4. Support .............................................. 9
5.5. Provider ............................................. 9
Riegel & Zorn Standards Track [Page 1]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
6. Information Element Definitions .......................... 10
6.1. Information elements defined for the POP element ..... 10
6.1.1. Address ........................................... 10
6.1.1.1. address Attribute "family" ..................... 10
6.1.1.2. address Attribute "countryCode" ................ 11
6.1.1.3. address Attribute "areaCode" ................... 11
6.1.2. Media ............................................. 11
6.1.2.1. Modem Protocols ................................ 12
6.1.2.2. ISDN Protocols ................................. 12
6.1.2.3. ATM Protocols .................................. 13
6.1.2.4. Frame Relay Protocols .......................... 13
6.1.2.5. X.25 Protocols ................................. 13
6.1.3. Minimum Data Rate ................................. 14
6.1.4. Maximum Data Rate ................................. 14
6.1.5. POP Properties .................................... 14
6.1.6. Tunneling Protocols ............................... 15
6.1.7. Dialing Script .................................... 15
6.1.8. Pricing Information ............................... 16
6.1.9. City .............................................. 16
6.1.10. Region ........................................... 16
6.1.11. Country .......................................... 16
6.1.12. POP Setup ........................................ 17
6.1.13. POP Support ...................................... 17
6.1.14. POP Provider ..................................... 17
6.2. Information elements defined for the Setup element ... 17
6.2.1. DNS Server Address ................................ 17
6.2.2. NNTP Server Name .................................. 18
6.2.3. SMTP Server Name .................................. 18
6.2.4. POP3 Server Name .................................. 18
6.2.5. IMAP Server Name .................................. 18
6.2.6. WWW Proxy ......................................... 19
6.2.7. FTP Proxy ......................................... 19
6.2.8. Winsock Proxy ..................................... 19
6.2.9. Default Gateway Address ........................... 19
6.2.10. User Name Suffix ................................. 20
6.2.11. User Name Prefix ................................. 20
6.3. Information elements defined for the support element.. 20
6.3.1. Support Telephone Number .......................... 20
6.3.2. Support Email Address ............................. 21
6.4. Information elements defined for the provider element. 21
6.4.1. Provider Name ..................................... 21
6.4.2. Provider Icon ..................................... 21
6.4.3. Provider's World Wide Web URL ..................... 21
6.4.4. Provider's Main Email Address ..................... 22
6.4.5. Billing Inquiry Email Address ..................... 22
6.4.6. Further elements .................................. 22
7. Complete XML DTD for the roaming phone book .............. 22
8. Security Considerations .................................. 28
Riegel & Zorn Standards Track [Page 2]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
9. IANA Considerations ...................................... 28
9.1. Registration of new attribute values ................. 29
9.2. Registration of new information elements ............. 29
10. References .............................................. 30
11. Appendix: Examples ...................................... 31
11.1. The most simple example ............................. 31
11.2. A more comprehensive example ........................ 31
12. Acknowledgments ......................................... 31
13. Authors' Addresses ...................................... 32
14. Full Copyright Statement ................................ 33
1. Introduction
Roaming applications depend on the delivery of information about
provided services and the procedures to get connected to the network
from the roaming consortium to the individual users as well as from
the operators of the network access servers, normally the members of
the roaming consortium, and the roaming consortium.
"phone book"
+------+ +--+
| | | ++
| ISP1 | -- | | --+
| | +---+ \ "phone book"
+------+ \ +------+
+------+ +--+ \_ | | +--+ +------+
| | | ++ | | | ++ | |
| ISP2 | -- | | -->>--- | | --- | | ->> | USER |
| | +---+ _ | | +---+ | |
+------+ / | | +------+
+------+ +--+ / +------+
| | | ++ / Roaming
| ISP# | -- | | --+ Consortium
| | +---+
+------+
The roaming consortium assembles from the individual contributions of
the providers belonging to the consortium a unified version of the
phone book for usage by the customers. Probably different groups of
users get different versions of a phone book adapted to their
particular needs. Even users might generate different subsets
especially suited to particular applications from the information
received from the roaming consortium, e.g., retrieving only entries
for a particular country or extracting all access points providing
wireless connectivity.
Riegel & Zorn Standards Track [Page 3]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
Therefore it is desirable to define a highly portable and well formed
structure of the phone book to enable easy generation and
postprocessing. 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 as
well as to enable automatic extraction of configuration
data by a wide variety of devices;
- 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 plethoric solution,
with phone book elements to fit every condition on earth, neither to
define any kind of phone book update or transfer protocol.
2. 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.
Riegel & Zorn Standards Track [Page 4]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
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.
3. 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].
4. Value type notations for 'stronger' typing
XML DTDs do not currently 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.
<?xml version="1.0" encoding="UTF-8"?>
<!-- Phone book value type notation declarations -->
<!NOTATION FQDN PUBLIC "-//IETF/roamPhoneBook/NOTATION
value Type Fully_qualified_domain_name">
<!NOTATION IPADR PUBLIC "-//IETF/roamPhoneBook/NOTATION
value Type IP_address">
<!NOTATION B64JPG PUBLIC "-//IETF/roamPhoneBook/NOTATION
value Type Base64_encoded_jpeg_image">
<!NOTATION B64GIF PUBLIC "-//IETF/roamPhoneBook/NOTATION
value Type Base64_encoded_gif_image">
5. Container Element Definitions
5.1. PhoneBook
The phoneBook element is the basic container for phone book entries.
It has two attributes, a phone book name and a phone book version
number (applying to the phone book as a whole), and always contains
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 Standards Track [Page 5]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
Syntax:
<!ELEMENT phoneBook (
pop+,
setup*,
support*,
provider*)>
<!ATTLIST phoneBook
name CDATA #REQUIRED
version CDATA #REQUIRED >
phoneBook
+-----------------------------------+
| phoneBookName (req)|
| phoneBookVersion (req)|
| +-----------------------+ |
| | pop |+ (req)|
| +-----------------------+| |
| + - - - - - - - - - - - + |
| |
| + - - - - - - - - - - - + |
| | setup |+ (opt)|
| + - - - - - - - - - - - +| |
| + - - - - - - - - - - - + |
| |
| + - - - - - - - - - - - + |
| | support |+ (opt)|
| + - - - - - - - - - - - +| |
| + - - - - - - - - - - - + |
| |
| + - - - - - - - - - - - + |
| | provider |+ (opt)|
| + - - - - - - - - - - - +| |
| + - - - - - - - - - - - + |
+-----------------------------------+
5.1.1. phoneBook Attribute "name"
The phoneBook attribute "name" is an arbitrary string assigned as an
identifier for a phone book.
5.1.2. phoneBook Attribute "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
Riegel & Zorn Standards Track [Page 6]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
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.
5.2. 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.
The following information elements are currently defined for the pop
element. Additional information elements may be defined by IANA in
future.
POP
+-----------------------------------+
| entryVersion (req)|
| +-------------------------+ |
| | address | (req)|
| +-------------------------+ |
| media (req)|
| minBitsPerSecond (opt)|
| maxBitsPerSecond (opt)|
| "popProperties" (opt)|
| "tunnelingProtocols" (opt)|
| dialScript (opt)|
| pricingInformation (opt)|
| + - - - - - - - - - - - - + |
| | "location" | (opt)|
| + - - - - - - - - - - - - + |
| + - - - - - - - - - - - - + |
| | "popSetup" | (opt)|
| + - - - - - - - - - - - - + |
| + - - - - - - - - - - - - + |
| | "popSupport" | (opt)|
| + - - - - - - - - - - - - + |
| + - - - - - - - - - - - - + |
| | "popProvider" | (opt)|
| + - - - - - - - - - - - - + |
+-----------------------------------+
Riegel & Zorn Standards Track [Page 7]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
Syntax:
<!ENTITY % popInformation
"address,
media+,
minBitsPerSecond?,
maxBitsPerSecond?,
popProperty*,
tunnelProto*,
dialScript?,
pricingInformation?,
city?,
region?,
country?,
(setup | setupPtr)?,
(support | supportPtr)?,
(provider |providerPtr)?">
<!ELEMENT pop ( %popInformation; )>
<!ATTLIST pop
entryVersion CDATA #REQUIRED>
5.2.1. pop Attribute "entryVersion"
The entryVersion attribute 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.
5.3. 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.
The following information elements are currently defined for the
Setup element. Additional information elements may be defined by
IANA in future.
Syntax:
<!ENTITY % setupInformation
"dnsServerAddress*,
nntpServerName*,
smtpServerName*,
popServerName*,
imapServerName*,
Riegel & Zorn Standards Track [Page 8]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
wwwProxyServerName*,
ftpProxyServerName*,
winsockProxyServerName*,
defaultGatewayAddress?,
userNamePrefix?,
userNameSuffix?">
<!ELEMENT setup ( %setupInformation; )>
<!ATTLIST setup
id ID #REQUIRED>
5.4. Support
The Support element includes those information elements that are
pertinent to the provision of customer support for a POP or provider.
Languages spoken by the staff at the support center might be
specified by multiple entries for the attribute value language.
Additional information elements for the Support element may be
defined by IANA in future.
Syntax:
<!ENTITY % supportInformation
"(supportTelephoneNumber | supportMailtoURL)+">
<!ELEMENT support %supportInformation; >
<!ATTLIST support
id ID #REQUIRED
language NMTOKENS #IMPLIED >
5.5. 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.
Currently the following information elements are defined for the
Provider element. Additional information elements may be defined by
IANA in future.
Syntax:
<!ENTITY % providerInformation
"providerName?,
providerIcon?,
wwwURL?,
Riegel & Zorn Standards Track [Page 9]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
generalMailtoURL?,
billingMailtoURL?,
businessCategory?,
x121Address?,
registeredAddress?,
destinationIndicator?,
preferredDeliveryMethod?,
telexNumber?,
teletexTerminalIdentifier?,
telephoneNumber?,
internationalISDNNumber?,
facsimileTelephoneNumber?,
street?,
postOfficeBox?,
postalCode?,
postalAddress?,
physicalDeliveryOfficeName?,
description?,
supportPtr*">
<!ELEMENT provider ( %providerInformation; )>
<!ATTLIST provider
id ID #REQUIRED>
6. Information Element Definitions
6.1. Information elements defined for the POP element
6.1.1. Address
The address element provides the information representing the address
of the POP. For POPs offering dial-up network access, the address
element will at least contain an IA5 string representing a telephone
number, formatted in standard fashion [4] (e.g., "+ 1 234 5678").
More detailed information may be available by optional attribute
values.
Syntax:
<!-- A network address for this POP -->
<!ELEMENT address (#PCDATA)>
6.1.1.1. address Attribute "family"
The attribute family of the element address defines the address
family to which the element value belongs. For POPs offering dial-up
network access, the addrFamily attribute will generally contain a
value for a telephone network based address family. Currently the
following attribute values are defined. Additional values may be
Riegel & Zorn Standards Track [Page 10]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
registered by IANA in future.
Value Description
------ ------------------------------------------
E164 ITU-T E.164 (PSTN, SMDS, Frame Relay, ATM)
X121 ITU-T X.121 (X.25, Frame Relay)
Syntax:
<!-- Attribute values for address family -->
<!ENTITY % addressFamily "(E164|X121)" >
<!ATTLIST address
family %addressFamily; #REQUIRED >
6.1.1.2. address Attribute "countryCode"
The countryCode attribute indicates the international dialing prefix
for the country in which the POP is located.
Syntax:
<!-- ITU dialing code for the country in which this POP is located -->
<!ATTLIST address
countryCode CDATA #IMPLIED >
6.1.1.3. address Attribute "areaCode"
The areaCode attribute contains the area or city code component of
the telephone number in the 'address' element (if any) associated
with this POP.
<!-- Area or city code component of the telephone number in the
accessTelephoneNumber element associated with this POP -->
<!ATTLIST address
areaCode CDATA #IMPLIED >
6.1.2. Media
The media element is a container describing the types of media and
related protocols supported by this POP. The following media types
are currently defined. Additional types may be registered by IANA in
future.
Value Media Type
-------- -----------
viaMODEM Modem
viaISDN ISDN
viaATM ATM
viaFR Frame Relay
viaX25 X.25
Riegel & Zorn Standards Track [Page 11]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
Syntax:
<!-- The types of media supported by this POP -->
<!ENTITY % mediaTypes "(viaMODEM|viaISDN|viaATM|viaFR|viaX25)+" >
<!ELEMENT media %mediaTypes; >
6.1.2.1. Modem Protocols
The viaMODEM element is an empty element representing by its optional
type attribute the modem protocol supported by the access devices
that can be reached at address. To define multiple available
protocols this element may be included repeatedly. The initially
defined modem protocol types are listed in the table below.
Additional values may be registered by IANA in future.
Value Duplex Speed Protocol
----- ------ ----- -------------
V21 Full 300 ITU-T V.21
V22 Full 1200 ITU-T V.22
V29 Half 9600 ITU-T V.29
V32 Full 9600 ITU-T V.32
V32B Full 14.4k ITU-T V.32bis
V34 Full 28.8k ITU-T V.34
V34B Full 33.6k ITU-T V.34bis
V90 Full 56k ITU-T V.90
Syntax
<!-- A modem media type element -->
<!ENTITY % modemProtocols "(V21|V22|V29|V32|V32B|V34|V34B|V90)" >
<!ELEMENT viaMODEM EMPTY>
<!ATTLIST viaMODEM
type %modemProtocols; #IMPLIED >
6.1.2.2. ISDN Protocols
The viaISDN element is an empty element representing by its optional
type attribute the ISDN protocol supported by the access devices that
can be reached at address. To define multiple available protocols
this element may be included repeatedly. The initially defined ISDN
protocol types are listed in the table below. Additional values may
be registered by IANA in future.
Value Speed Meaning
----- ----- -----------
V110L 19.2k ITU-T V.110
V110H 38.4k ITU-T V.110
V120L 56k ITU-T V.120
Riegel & Zorn Standards Track [Page 12]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
V120H 64k ITU-T V.120
X75 64k ITU-T X.75
HDLC 64k RFC 1618
Syntax:
<!-- An ISDN media type element -->
<!ENTITY % isdnProtocols "(V110L|V110H|V120L|V120H|X75|HDLC)">
<!ELEMENT viaISDN EMPTY>
<!ATTLIST viaISDN
type %isdnProtocols; #IMPLIED >
6.1.2.3. ATM Protocols
The viaATM element is an empty element representing by its optional
type attribute a particular protocol supported by the access devices
that can be reached at address. To define multiple available
protocols this element may be included repeatedly. Currently only
one protocol is defined. Additional values may be registered by IANA
in future.
Syntax:
<!-- An ATM media type element -->
<!ENTITY % atmProtocols "(RFC2364)">
<!ELEMENT viaATM EMPTY>
<!ATTLIST viaATM
type %atmProtocols; #IMPLIED >
6.1.2.4. Frame Relay Protocols
The viaFR element is an empty element representing by its optional
type attribute the particular protocol supported by the access
devices that can be reached at address. To define multiple available
protocols this element may be included repeatedly. Currently only
one protocol is defined. Additional values may be registered by IANA
in future.
Syntax:
<!-- A Frame Relay media type element -->
<!ENTITY % frProtocols "(RFC1973)">
<!ELEMENT viaFR EMPTY>
<!ATTLIST viaFR
type %frProtocols; #IMPLIED >
6.1.2.5. X.25 Protocols
The viaX25 element is an empty element representing by its optional
type attribute the particular protocol supported by the access
devices that can be reached at address. To define multiple available
Riegel & Zorn Standards Track [Page 13]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
protocols this element may be included repeatedly. Currently only
one protocol is defined. Additional values may be registered by IANA
in future.
Syntax:
<!-- A X.25 media type element -->
<!ENTITY % x25Protocols "(RFC1598)">
<!ELEMENT viaX25 EMPTY>
<!ATTLIST viaX25
type %x25Protocols; #IMPLIED >
6.1.3. Minimum Data Rate
The minBitsPerSecond element indicates the minimum data rate (in
bits/second) supported by the access devices at the POP.
Syntax:
<!-- Minimum data rate supported by this POP in bits/second -->
<!ELEMENT minBitsPerSecond (#PCDATA)>
6.1.4. Maximum Data Rate
The maxBitsPerSecond element indicates the maximum data rate (in
bits/second) supported by the access devices at the POP.
Syntax:
<!-- Maximum data rate supported by this POP in bits/second -->
<!ELEMENT maxBitsPerSecond (#PCDATA)>
6.1.5. POP Properties
The popProperty element is an empty element representing by its
attribute value a particular property of this POP. To define
multiple available protocols this element might be included several
times. The initially defined properties are listed in the table
below. Additional values may be registered by IANA in future.
Value Property
------ ----------------------
MPPP Multilink PPP (RFC 1990)
MOBIP Mobile IP (RFC 2002)
MCRX Multicast Reception
MCTX Multicast Transmission
Syntax:
<!-- A property characterizing this POP -->
<!ENTITY % popProperties "(MPPP|MOBIP|MCRX|MCTX)" >
Riegel & Zorn Standards Track [Page 14]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
<!ELEMENT popProperty EMPTY>
<!ATTLIST popProperty
type %popProperties; #REQUIRED>
6.1.6. Tunneling Protocols
The tunnelProto element is an empty element representing by its
attribute a tunneling protocol supported by this POP. To define
multiple available protocols this element might be included several
times. The initially defined values are listed in the table below.
Additional values may be registered by IANA in future.
Value Protocol
------ ------------------
L2TP RFC 2661 L2TP
PPTP RFC 2637 PPTP
L2F RFC 2341 L2F
ATMP RFC 2107 ATMP
AHT RFC 2402 IP AH Tunnel Mode
ESPT RFC 2406 IP ESP Tunnel Mode
IPIP RFC 1853 IP-IP
MIP RFC 2004 Minimal IP-IP
GRE RFC 1701 GRE
Syntax:
<!-- A tunneling protocol supported by this POP -->
<!ENTITY % tunnelingProtocols
"(L2TP|PPTP|L2F|ATMP|AHT|ESPT|IPIP|MIP|GRE)" >
<!ELEMENT tunnelProto EMPTY>
<!ATTLIST tunnelProto
type %tunnelingProtocols; #REQUIRED>
6.1.7. Dialing Script
The dialScript element contains the dialing script to be used when
connecting to this POP. The attribute value type of dialScript
defines the type of the script that should be used when connecting to
this POP.
Syntax:
<!-- The dial script to be used -->
<!ELEMENT dialScript (#PCDATA)>
<!ATTLIST dialScript
type CDATA #IMPLIED >
Riegel & Zorn Standards Track [Page 15]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
6.1.8. Pricing Information
The pricingInformation 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:
<!-- Pricing information for this POP -->
<!ELEMENT pricing (#PCDATA)>
6.1.9. 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
call).
Syntax:
<!-- The name of the city in which this POP is located -->
<!ELEMENT city (#PCDATA)>
6.1.10. 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:
<!-- The name of the region in which this POP is located -->
<!ELEMENT region (#PCDATA)>
6.1.11. 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:
<!-- The name of the country in which this POP is located -->
<!ELEMENT country (#PCDATA)>
Riegel & Zorn Standards Track [Page 16]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
6.1.12. 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:
<!-- Reference for setup information for this POP -->
<!ELEMENT setupPtr EMPTY>
<!ATTLIST setupPtr
setupID IDREFS #IMPLIED>
6.1.13. 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:
<!-- Reference for support information for this POP -->
<!ELEMENT supportPtr EMPTY>
<!ATTLIST supportPtr
supportID IDREFS #IMPLIED>
6.1.14. 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
element.
Syntax:
<!-- Reference for provider information for this POP -->
<!ELEMENT providerPtr EMPTY>
<!ATTLIST providerPtr
providerID IDREFS #IMPLIED>
6.2. Information elements defined for the Setup element
6.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).
Riegel & Zorn Standards Track [Page 17]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
Syntax:
<!-- Domain Name Server IP address -->
<!ELEMENT dnsServerAddress (#PCDATA)>
<!ATTLIST dnsServerAddress
value NOTATION (IPADR) #IMPLIED>
6.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:
<!-- Name of an NNTP server -->
<!ELEMENT nntpServerName (#PCDATA)>
<!ATTLIST nntpServerName
value NOTATION (FQDN) #IMPLIED>
6.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.
Syntax:
<!-- Name of an SMTP mail server -->
<!ELEMENT smtpServerName (#PCDATA)>
<!ATTLIST smtpServerName
value NOTATION (FQDN) #IMPLIED>
6.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:
<!-- Name of an POP3 mail server -->
<!ELEMENT popServerName (#PCDATA)>
<!ATTLIST popServerName
value NOTATION (FQDN) #IMPLIED>
6.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.
Riegel & Zorn Standards Track [Page 18]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
Syntax:
<!-- Name of an IMAP4 server -->
<!ELEMENT imapServerName (#PCDATA)>
<!ATTLIST imapServerName
value NOTATION (FQDN) #IMPLIED>
6.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:
<!-- Name of an WWW Proxy -->
<!ELEMENT wwwProxyServerName (#PCDATA)>
<!ATTLIST wwwProxyServerName
value NOTATION (FQDN) #IMPLIED>
6.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:
<!-- Name of an FTP Proxy -->
<!ELEMENT ftpProxyServerName (#PCDATA)>
<!ATTLIST ftpProxyServerName
value NOTATION (FQDN) #IMPLIED>
6.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:
<!-- Name of an Winsock Proxy -->
<!ELEMENT winsockProxyServerName (#PCDATA)>
<!ATTLIST winsockProxyServerName
value NOTATION (FQDN) #IMPLIED>
6.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).
Riegel & Zorn Standards Track [Page 19]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
Syntax:
<!-- Default Gateway IP address (in dotted decimal notation) -->
<!ELEMENT defaultGatewayAddress (#PCDATA)>
<!ATTLIST defaultGatewayAddress
value NOTATION (IPADR) #IMPLIED>
6.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 be
applied to the same base username.
Syntax:
<!-- User Name suffix -->
<!ELEMENT userNameSuffix (#PCDATA)>
6.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:
<!-- User Name prefix -->
<!ELEMENT userNamePrefix (#PCDATA)>
6.3. Information elements defined for the support element
6.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:
<!-- The number to be dialed to contact customer support
for this POP or provider -->
<!ELEMENT supportTelephoneNumber (#PCDATA)>
Riegel & Zorn Standards Track [Page 20]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
6.3.2. Support Email Address
The supportMailtoURL element contains a URL for the provider's
customer support email address, e.g., mailto:support@uu.net. This
URL could be used to contact customer support personnel regarding
non-urgent issues.
Syntax:
<!-- A Uniform Resource Locator for the provider's customer
support email address -->
<!ELEMENT supportMailtoURL (#PCDATA)>
6.4. Information elements defined for the provider element
6.4.1. Provider Name
The providerName element is a string containing the name of the
provider (e.g., "BIGNET Corporation").
Syntax:
<!-- The name of the provider -->
<!ELEMENT providerName (#PCDATA)>
6.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:
<!-- An icon in BASE64 encoded JPEG or GIF format -->
<!ELEMENT providerIcon (#PCDATA)>
<!ATTLIST providerIcon
value NOTATION (B64JPG | B64GIF) #IMPLIED>
6.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:
<!-- A Uniform Resource Locator for the provider's home page -->
<!ELEMENT wwwURL (#PCDATA)>
Riegel & Zorn Standards Track [Page 21]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
6.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:
<!-- A Uniform Resource Locator for the provider's
email address -->
<!ELEMENT generalMailtoURL (#PCDATA)>
6.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:
<!-- A Uniform Resource Locator for the email
address to be used for billing inquiries -->
<!ELEMENT billingMailtoURL (#PCDATA)>
6.4.6. Further elements
The remainder of the information elements of the provider element are
described in principle in [3].
7. Complete XML DTD for the roaming phone book
<?xml version="1.0" encoding="UTF-8"?>
<!-- Parameter entity declaration -->
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<!-- This section will be maintained by IANA and can be direct
referenced by the DTD specification by means of an external
parameter entity. -->
<!ENTITY % addressFamily "(E164|X121)" >
<!ENTITY % mediaTypes "(viaMODEM|viaISDN|viaATM|viaFR|viaX25)+" >
<!ENTITY % modemProtocols "(V21|V22|V29|V32|V32B|V34|V34B|V90)" >
<!ENTITY % isdnProtocols "(V110L|V110H|V120L|V120H|X75|HDLC)">
<!ENTITY % atmProtocols "(RFC2364)">
Riegel & Zorn Standards Track [Page 22]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
<!ENTITY % frProtocols "(RFC1973)">
<!ENTITY % x25Protocols "(RFC1598)">
<!ENTITY % popProperties "(MPPP|MOBIP|MCRX|MCTX)" >
<!ENTITY % tunnelingProtocols
"(L2TP|PPTP|L2F|ATMP|AHT|ESPT|IPIP|MIP|GRE)" >
<!ENTITY % popInformation
"address,
media+,
minBitsPerSecond?,
maxBitsPerSecond?,
popProperty*,
tunnelProto*,
dialScript?,
pricingInformation?,
city?,
region?,
country?,
(setup|setupPtr)?,
(support|supportPtr)?,
(provider|providerPtr)?">
<!ENTITY % setupInformation
"dnsServerAddress*,
nntpServerName*,
smtpServerName*,
popServerName*,
imapServerName*,
wwwProxyServerName*,
ftpProxyServerName*,
winsockProxyServerName*,
defaultGatewayAddress?,
userNamePrefix?,
userNameSuffix?">
<!ENTITY % supportInformation
"(supportTelephoneNumber|supportMailtoURL)+">
<!ENTITY % providerInformation
"providerName?,
providerIcon?,
wwwURL?,
generalMailtoURL?,
billingMailtoURL?,
businessCategory?,
Riegel & Zorn Standards Track [Page 23]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
x121Address?,
registeredAddress?,
destinationIndicator?,
preferredDeliveryMethod?,
telexNumber?,
teletexTerminalIdentifier?,
telephoneNumber?,
internationalISDNNumber?,
facsimileTelephoneNumber?,
street?,
postOfficeBox?,
postalCode?,
postalAddress?,
physicalDeliveryOfficeName?,
description?,
supportPtr*">
<!-- ++++++++++++++ End of IANA maintained section ++++++++++ -->
<!-- Phone book value type notation declarations -->
<!NOTATION FQDN PUBLIC "-//IETF/roamPhoneBook/NOTATION
value Type Fully_qualified_domain_name">
<!NOTATION IPADR PUBLIC "-//IETF/roamPhoneBook/NOTATION
value Type IP_address">
<!NOTATION B64JPG PUBLIC "-//IETF/roamPhoneBook/NOTATION
value Type Base64_encoded_jpeg_image">
<!NOTATION B64GIF PUBLIC "-//IETF/roamPhoneBook/NOTATION
value Type Base64_encoded_gif_image">
<!-- Phone book element declarations -->
<!ELEMENT phoneBook (
pop+,
setup*,
support*,
provider*) >
<!ATTLIST phoneBook
name CDATA #REQUIRED
version CDATA #REQUIRED >
<!ELEMENT pop ( %popInformation; )>
<!ATTLIST pop
entryVersion CDATA #REQUIRED>
<!ELEMENT setup ( %setupInformation; )>
<!ATTLIST setup
id ID #REQUIRED>
<!ELEMENT support ( %supportInformation; )>
Riegel & Zorn Standards Track [Page 24]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
<!ATTLIST support
id ID #REQUIRED
language NMTOKENS #IMPLIED >
<!ELEMENT provider ( %providerInformation; )>
<!ATTLIST provider
id ID #REQUIRED>
<!-- Information elements for pop -->
<!ELEMENT address (#PCDATA)>
<!ATTLIST address
family %addressFamily; #REQUIRED
countryCode CDATA #IMPLIED
areaCode CDATA #IMPLIED >
<!ELEMENT media %mediaTypes; >
<!ELEMENT viaMODEM EMPTY>
<!ATTLIST viaMODEM
type %modemProtocols; #IMPLIED >
<!ELEMENT viaISDN EMPTY>
<!ATTLIST viaISDN
type %isdnProtocols; #IMPLIED >
<!ELEMENT viaATM EMPTY>
<!ATTLIST viaATM
type %atmProtocols; #IMPLIED >
<!ELEMENT viaFR EMPTY>
<!ATTLIST viaFR
type %frProtocols; #IMPLIED >
<!ELEMENT viaX25 EMPTY>
<!ATTLIST viaX25
type %x25Protocols; #IMPLIED >
<!ELEMENT minBitsPerSecond (#PCDATA)>
<!ELEMENT maxBitsPerSecond (#PCDATA)>
<!ELEMENT popProperty EMPTY>
<!ATTLIST popProperty
type %popProperties; #REQUIRED >
<!ELEMENT tunnelProto EMPTY>
<!ATTLIST tunnelProto
type %tunnelingProtocols; #REQUIRED >
Riegel & Zorn Standards Track [Page 25]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
<!ELEMENT dialScript (#PCDATA)>
<!ATTLIST dialScript
type CDATA #IMPLIED >
<!ELEMENT pricing (#PCDATA)>
<!ELEMENT city (#PCDATA)>
<!ELEMENT region (#PCDATA)>
<!ELEMENT country (#PCDATA)>
<!ELEMENT setupPtr EMPTY>
<!ATTLIST setupPtr
setupID IDREFS #IMPLIED>
<!ELEMENT supportPtr EMPTY>
<!ATTLIST supportPtr
supportID IDREFS #IMPLIED>
<!ELEMENT providerPtr EMPTY>
<!ATTLIST providerPtr
providerID IDREFS #IMPLIED>
<!-- Information elements for setup -->
<!ELEMENT dnsServerAddress (#PCDATA)>
<!ATTLIST dnsServerAddress
value NOTATION (IPADR) #IMPLIED>
<!ELEMENT nntpServerName (#PCDATA)>
<!ATTLIST nntpServerName
value NOTATION (FQDN) #IMPLIED>
<!ELEMENT smtpServerName (#PCDATA)>
<!ATTLIST smtpServerName
value NOTATION (FQDN) #IMPLIED>
<!ELEMENT popServerName (#PCDATA)>
<!ATTLIST popServerName
value NOTATION (FQDN) #IMPLIED>
<!ELEMENT imapServerName (#PCDATA)>
<!ATTLIST imapServerName
value NOTATION (FQDN) #IMPLIED>
<!ELEMENT wwwProxyServerName (#PCDATA)>
<!ATTLIST wwwProxyServerName
value NOTATION (FQDN) #IMPLIED>
Riegel & Zorn Standards Track [Page 26]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
<!ELEMENT ftpProxyServerName (#PCDATA)>
<!ATTLIST ftpProxyServerName
value NOTATION (FQDN) #IMPLIED>
<!ELEMENT winsockProxyServerName (#PCDATA)>
<!ATTLIST winsockProxyServerName
value NOTATION (FQDN) #IMPLIED>
<!ELEMENT defaultGatewayAddress (#PCDATA)>
<!ATTLIST defaultGatewayAddress
value NOTATION (IPADR) #IMPLIED>
<!ELEMENT userNameSuffix (#PCDATA)>
<!ELEMENT userNamePrefix (#PCDATA)>
<!-- Information elements for support -->
<!ELEMENT supportTelephoneNumber (#PCDATA)>
<!ELEMENT supportMailtoURL (#PCDATA)>
<!-- Information elements for provider -->
<!ELEMENT providerName (#PCDATA)>
<!ELEMENT providerIcon (#PCDATA)>
<!ATTLIST providerIcon
value NOTATION (B64JPG|B64GIF) #IMPLIED>
<!ELEMENT wwwURL (#PCDATA)>
<!ELEMENT generalMailtoURL (#PCDATA)>
<!ELEMENT billingMailtoURL (#PCDATA)>
<!-- Further provider elements according to RFC1274 -->
<!ELEMENT businessCategory (#PCDATA)>
<!ELEMENT x121Address (#PCDATA)>
<!ELEMENT registeredAddress (#PCDATA)>
<!ELEMENT destinationIndicator (#PCDATA)>
<!ELEMENT preferredDeliveryMethod (#PCDATA)>
<!ELEMENT telexNumber (#PCDATA)>
Riegel & Zorn Standards Track [Page 27]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
<!ELEMENT teletexTerminalIdentifier (#PCDATA)>
<!ELEMENT telephoneNumber (#PCDATA)>
<!ELEMENT internationalISDNNumber (#PCDATA)>
<!ELEMENT facsimileTelephoneNumber (#PCDATA)>
<!ELEMENT street (#PCDATA)>
<!ELEMENT postOfficeBox (#PCDATA)>
<!ELEMENT postalCode (#PCDATA)>
<!ELEMENT postalAddress (#PCDATA)>
<!ELEMENT physicalDeliveryOfficeName (#PCDATA)>
<!ELEMENT description (#PCDATA)>
<!-- end of dtd -->
8. Security Considerations
The secure distribution and transport of information of a phone book
for roaming applications require a reliable authentication of the
issuer of the information as well as means to preserve the integrity
of the provided information.
No specific elements for security requirements are provided by the
phone book XML DTD itself. It is assumed that security of the
roaming phone book is provided by means outside of the scope of this
specification, such as signing the phone book using pgp.
9. IANA Considerations
This specification provides the possibility to define further
attribute values for all information elements owning enumerated
attribute lists as well as to extend the main structures 'pop',
'setup', 'support' and 'provider' by additional information elements.
Therefore the specification of the roaming phone book can be adopted
to future requirements without changing this document. Extensions
and refinements to this specification can be achieved by registration
of new elements and attributes by IANA.
Extending this specification with additional attributes or elements
must not change the validity of documents based on an older version
of the XML DTD. Therefore all added information elements must be
Riegel & Zorn Standards Track [Page 28]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
optional, prohibiting the mandatory inclusion of newly defined
information elements. Adding new values to enumerated attribute
lists has no backward compatibility constraints because it does not
harm the validity of attributes already defined.
To facilitate the registration of new information elements and
attribute values the DTD of the phone book has been separated in two
parts, the extensible part containing only parameter entity
declarations for ease inclusion of new values, and the fixed part
containing the detailed specification of the content and structure of
the phone book. By referencing the parameter entity declarations in
the fixed part of the specification the whole phone book becomes
extensible.
The part containing the parameter entity declarations has to be
maintained by the IANA. There are two different classes of
declarations in this part requiring different policies for
registering new values.
9.1. Registration of new attribute values
The entities 'addressFamily', 'modemProtocols', 'isdnProtocols',
'atmProtocols', 'frProtocols', 'x25Protocols', 'popProperties' and
'tunnelingProtocols' are describing enumerated attribute value lists.
Because there is no limitation in the name space of these attribute
values and newly defined attribute values can not harm the validity
of existing values, new attribute values can be assigned by
Specification Required [6].
9.2. Registration of new information elements
The entities 'mediaTypes', 'popInformation', 'setupInformation', '
supportInformation' and 'providerInformation' define the information
elements probably included in the media, pop, setup, support and
provider elements. Inserting new values into these lists extends the
phone book by arbitrarily new information elements. Inappropriate
use of the XML content model can destroy the backward compatibility
of the DTD. Therefore the assignment of new information elements
requires the approval of a Designated Expert [6]. In addition to the
insertion of a new value into the list, the detailed definition of
the information element has to be appended to the specification part
maintained by the IANA.
Riegel & Zorn Standards Track [Page 29]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
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 J. Postel, "ASSIGNED NUMBERS", STD 2, RFC 1700,
October 1994.
[3] Barker, P. and S. Kille, "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.w3.org/TR/1998/REC-xml-19980210
[6] Narten, T. and H. Alvestrand, "Guidelines for Writing an IANA
Considerations Section in RFCs", BCP 26, RFC 2434, October 1998.
Riegel & Zorn Standards Track [Page 30]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
11. Appendix: Examples
11.1. The most simple example
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE phoneBook SYSTEM "roamPhoneBook.dtd">
<phoneBook name="minimalExample" version="1">
<pop entryVersion="1">
<address family="E164">+1 234 5678901</address>
<media><viaMODEM/></media>
</pop>
</phoneBook>
11.2. A more comprehensive example
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE phoneBook SYSTEM "roamPhoneBook.dtd">
<phoneBook name="KNF_simple" version="1">
<pop entryVersion="1">
<address family="E164" countryCode="49">+49913130540</address>
<media>
<viaMODEM type="V90"/>
<viaMODEM type="V34B"/>
<viaISDN type="HDLC"/>
</media>
<setup>
<dnsServerAddress>192.168.147.5</dnsServerAddress>
<dnsServerAddress>193.175.24.33</dnsServerAddress>
</setup>
</pop>
<support id="KNF_main" language="EN DE">
<supportMailtoURL>mailto:support@franken.de</supportMailtoURL>
<supportTelephoneNumber>+499123968066</supportTelephoneNumber>
</support>
</phoneBook>
12. Acknowledgments
Thanks to Pat Calhoun, Bernard Aboba, Jay Farhat, Butch Anton,
Quentin Miller, and Ken Crocker for salient input and review.
Riegel & Zorn Standards Track [Page 31]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
13. Authors' Addresses
Questions about this memo can be directed to:
Max Riegel
Siemens AG
Hofmannstr. 51
Munich, 81359
Germany
Phone: +49 89 722 49557
EMail: maximilian.riegel@icn.siemens.de
Glen Zorn
Cisco Systems, Inc.
500 108th Avenue N.E., Suite 500
Bellevue, WA 98004
USA
Phone: +1 425 438 8218
EMail: gwz@cisco.com
Riegel & Zorn Standards Track [Page 32]
^L
RFC 3017 Roaming Access Phone Book XML DTD December 2000
14. Full Copyright Statement
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 implementation 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.
Acknowledgement
Funding for the RFC Editor function is currently provided by the
Internet Society.
Riegel & Zorn Standards Track [Page 33]
^L
|