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 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461
|
<pre>Internet Engineering Task Force (IETF) A. Niemi
Request for Comments: 7701
Category: Standards Track M. Garcia-Martin
ISSN: 2070-1721 Ericsson
G. Sandbakken
Cisco Systems
December 2015
<span class="h1">Multi-party Chat Using the Message Session Relay Protocol (MSRP)</span>
Abstract
The Message Session Relay Protocol (MSRP) defines a mechanism for
sending instant messages (IMs) within a peer-to-peer session,
negotiated using the Session Initiation Protocol (SIP) and the
Session Description Protocol (SDP). This document defines the
necessary tools for establishing multi-party chat sessions, or chat
rooms, using MSRP.
Status of This Memo
This is an Internet Standards Track document.
This document is a product of the Internet Engineering Task Force
(IETF). It represents the consensus of the IETF community. It has
received public review and has been approved for publication by the
Internet Engineering Steering Group (IESG). Further information on
Internet Standards is available in <a href="./rfc5741#section-2">Section 2 of RFC 5741</a>.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
<a href="http://www.rfc-editor.org/info/rfc7701">http://www.rfc-editor.org/info/rfc7701</a>.
<span class="grey">Niemi, et al. Standards Track [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
Copyright Notice
Copyright (c) 2015 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal
Provisions Relating to IETF Documents
(<a href="http://trustee.ietf.org/license-info">http://trustee.ietf.org/license-info</a>) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
This document may contain material from IETF Documents or IETF
Contributions published or made publicly available before November
10, 2008. The person(s) controlling the copyright in some of this
material may not have granted the IETF Trust the right to allow
modifications of such material outside the IETF Standards Process.
Without obtaining an adequate license from the person(s) controlling
the copyright in such materials, this document may not be modified
outside the IETF Standards Process, and derivative works of it may
not be created outside the IETF Standards Process, except to format
it for publication as an RFC or to translate it into languages other
than English.
<span class="grey">Niemi, et al. Standards Track [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
Table of Contents
<a href="#section-1">1</a>. Introduction ....................................................<a href="#page-4">4</a>
<a href="#section-2">2</a>. Terminology .....................................................<a href="#page-5">5</a>
<a href="#section-3">3</a>. Motivations and Requirements ....................................<a href="#page-6">6</a>
<a href="#section-4">4</a>. Overview of Operation ...........................................<a href="#page-7">7</a>
<a href="#section-4.1">4.1</a>. Policy Attributes of the Chat Room ........................<a href="#page-10">10</a>
<a href="#section-5">5</a>. Creating, Joining, and Deleting a Chat Room ....................<a href="#page-12">12</a>
<a href="#section-5.1">5.1</a>. Creating a Chat Room ......................................<a href="#page-12">12</a>
<a href="#section-5.2">5.2</a>. Joining a Chat Room .......................................<a href="#page-12">12</a>
<a href="#section-5.3">5.3</a>. Deleting a Chat Room ......................................<a href="#page-14">14</a>
<a href="#section-6">6</a>. Sending and Receiving Instant Messages .........................<a href="#page-14">14</a>
<a href="#section-6.1">6.1</a>. Regular Messages ..........................................<a href="#page-14">14</a>
<a href="#section-6.2">6.2</a>. Private Messages ..........................................<a href="#page-17">17</a>
<a href="#section-6.3">6.3</a>. MSRP Reports and Responses ................................<a href="#page-19">19</a>
<a href="#section-6.4">6.4</a>. Congestion Avoidance ......................................<a href="#page-20">20</a>
<a href="#section-7">7</a>. Nicknames ......................................................<a href="#page-21">21</a>
<a href="#section-7.1">7.1</a>. Using Nicknames within a Chat Room ........................<a href="#page-22">22</a>
<a href="#section-7.2">7.2</a>. Modifying a Nickname ......................................<a href="#page-24">24</a>
<a href="#section-7.3">7.3</a>. Removing a Nickname .......................................<a href="#page-25">25</a>
<a href="#section-7.4">7.4</a>. Nicknames in Conference Event Packages ....................<a href="#page-25">25</a>
<a href="#section-8">8</a>. The SDP 'chatroom' Attribute ...................................<a href="#page-25">25</a>
<a href="#section-9">9</a>. Examples .......................................................<a href="#page-28">28</a>
<a href="#section-9.1">9.1</a>. Joining a Chat Room .......................................<a href="#page-28">28</a>
<a href="#section-9.2">9.2</a>. Setting Up a Nickname .....................................<a href="#page-30">30</a>
<a href="#section-9.3">9.3</a>. Sending a Regular Message to the Chat Room ................<a href="#page-31">31</a>
<a href="#section-9.4">9.4</a>. Sending a Private Message to a Participant ................<a href="#page-33">33</a>
<a href="#section-9.5">9.5</a>. Chunked Private Message ...................................<a href="#page-35">35</a>
<a href="#section-9.6">9.6</a>. Nickname in a Conference Information Document .............<a href="#page-35">35</a>
<a href="#section-10">10</a>. IANA Considerations ...........................................<a href="#page-37">37</a>
<a href="#section-10.1">10.1</a>. New MSRP Method ..........................................<a href="#page-37">37</a>
<a href="#section-10.2">10.2</a>. New MSRP Header ..........................................<a href="#page-37">37</a>
<a href="#section-10.3">10.3</a>. New MSRP Status Codes ....................................<a href="#page-37">37</a>
<a href="#section-10.4">10.4</a>. New SDP Attribute ........................................<a href="#page-38">38</a>
<a href="#section-11">11</a>. Security Considerations .......................................<a href="#page-38">38</a>
<a href="#section-12">12</a>. References ....................................................<a href="#page-40">40</a>
<a href="#section-12.1">12.1</a>. Normative References .....................................<a href="#page-40">40</a>
<a href="#section-12.2">12.2</a>. Informative References ...................................<a href="#page-43">43</a>
Acknowledgments ...................................................<a href="#page-43">43</a>
Contributors ......................................................<a href="#page-43">43</a>
Authors' Addresses ................................................<a href="#page-44">44</a>
<span class="grey">Niemi, et al. Standards Track [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
The Message Session Relay Protocol (MSRP) [<a href="./rfc4975" title=""The Message Session Relay Protocol (MSRP)"">RFC4975</a>] defines a
mechanism for sending a series of instant messages within a session.
The Session Initiation Protocol (SIP) [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>] in combination with
the Session Description Protocol (SDP) [<a href="./rfc4566" title=""SDP: Session Description Protocol"">RFC4566</a>] allows for two peers
to establish and manage such sessions.
In another application of SIP, a User Agent (UA) can join in a multi-
party conversation called a "conference" that is hosted by a
specialized UA called a "focus" [<a href="./rfc4353" title=""A Framework for Conferencing with the Session Initiation Protocol (SIP)"">RFC4353</a>]. Such a conference can
naturally involve MSRP sessions. It is the responsibility of an
entity handling the media to relay IMs received from one participant
to the rest of the participants in the conference.
Several such systems already exist in the Internet. Participants in
a chat room can be identified with a pseudonym or nickname and can
decide whether their real identifier is disclosed to other
participants. Participants can also use a rich set of features such
as the ability to send private instant messages to other
participants.
Similar conferences supporting chat room functionality are already
available today. For example, Internet Relay Chat (IRC) [<a href="./rfc2810" title=""Internet Relay Chat: Architecture"">RFC2810</a>],
Extensible Messaging and Presence Protocol (XMPP): Core [<a href="./rfc6120" title=""Extensible Messaging and Presence Protocol (XMPP): Core"">RFC6120</a>], as
well as many other proprietary systems. Specifying equivalent
functionality for MSRP-based systems eases interworking between these
systems.
This document defines requirements, conventions, and extensions for
providing private messages and nickname management in centralized
chat rooms with MSRP. Participants in a chat room can be identified
by a pseudonym and decide if their real identifier should be
disclosed to other participants. This memo uses the SIP Conferencing
Framework [<a href="./rfc4353" title=""A Framework for Conferencing with the Session Initiation Protocol (SIP)"">RFC4353</a>] as a design basis. It also aims to be compatible
with "A Framework for Centralized Conferencing" [<a href="./rfc5239" title=""A Framework for Centralized Conferencing"">RFC5239</a>]. Should
requirements arise, future mechanisms for providing similar
functionality in generic conferences might be developed, for example,
where the media is not only restricted to MSRP. The mechanisms
described in this document provide a future compatible short-term
solution for MSRP centralized chat rooms.
<span class="grey">Niemi, et al. Standards Track [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Terminology</span>
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a> [<a href="./rfc2119" title=""Key words for use in RFCs to Indicate Requirement Levels"">RFC2119</a>] and
indicate requirement levels for compliant implementations.
This memo deals with "Tightly Coupled SIP Conferences" as defined in
the SIP Conferencing Framework [<a href="./rfc4353" title=""A Framework for Conferencing with the Session Initiation Protocol (SIP)"">RFC4353</a>] and adopts the terminology
from that document. In addition, we introduce some new terms:
Nickname: a pseudonym or descriptive name associated with a
participant. See <a href="#section-7">Section 7</a> for details.
Multi-party Chat: an instance of a tightly coupled conference, in
which the media exchanged between the participants consist of
MSRP-based IMs. Also known as a chat room.
Chat Room: a synonym for a multi-party chat.
Chat Room URI: a URI that identifies a particular chat room and
that is a synonym of a "Conference URI" as defined in <a href="./rfc4353">RFC 4353</a>
[<a href="./rfc4353" title=""A Framework for Conferencing with the Session Initiation Protocol (SIP)"">RFC4353</a>].
Sender: the chat room participant who originally created an IM and
sent it to the chat room server for further delivery.
Recipient: the destination chat room participant(s). This defaults
to the full conference participant list minus the IM Sender.
MSRP Switch: a media-level entity that is an MSRP endpoint. It is
a special MSRP endpoint that receives MSRP messages and delivers
them to the other chat room participants. The MSRP switch has a
similar role to a conference mixer with the exception that the
MSRP switch does not actually "mix" together different input media
streams; it merely relays the messages between chat room
participants.
Private IM: an IM sent in a chat room intended for a single
participant. Generally speaking, a private IM is seen by the MSRP
switch, in addition to the sender and recipient. A private IM is
usually rendered distinctly from the rest of the IMs, indicating
that the message was a private communication.
Anonymous URI: a URI concealing the participant's SIP address of
record (AOR) from the other participants in the chat room. The
allocation of such a URI is out of scope of this specification.
An anonymous URI must be valid for the length of the chat room
<span class="grey">Niemi, et al. Standards Track [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
session and will be utilized by the MSRP switch to forward
messages to and from anonymous participants. Privacy and
anonymity are discussed in greater detail in <a href="./rfc3323">RFC 3323</a> [<a href="./rfc3323" title=""A Privacy Mechanism for the Session Initiation Protocol (SIP)"">RFC3323</a>]
and <a href="./rfc3325">RFC 3325</a> [<a href="./rfc3325" title=""Private Extensions to the Session Initiation Protocol (SIP) for Asserted Identity within Trusted Networks"">RFC3325</a>].
Conference Event Package: a notification mechanism that allows
conference participants to learn conference information including
roster and state changes in a conference. This would typically be
the mechanisms defined in "A Session Initiation Protocol (SIP)
Event Package for Conference State" [<a href="./rfc4575" title=""A Session Initiation Protocol (SIP) Event Package for Conference State"">RFC4575</a>] or "Conference Event
Package Data Format Extension for Centralized Conferencing (XCON)"
[<a href="./rfc6502" title=""Conference Event Package Data Format Extension for Centralized Conferencing (XCON)"">RFC6502</a>].
Identifier: a string used to recognize or establish as being a
particular user.
To log in: to enter identifying data, as a name or password, into a
chat room, so as to be able to do work with the chat room.
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Motivations and Requirements</span>
Although conference frameworks describing many types of conferencing
applications already exist, such as the one in "A Framework for
Centralized Conferencing" [<a href="./rfc5239" title=""A Framework for Centralized Conferencing"">RFC5239</a>] and the SIP Conferencing
Framework [<a href="./rfc4353" title=""A Framework for Conferencing with the Session Initiation Protocol (SIP)"">RFC4353</a>], the exact details of session-based instant
messaging conferences (chat rooms) are not well-defined at the
moment.
To allow interoperable chat implementations, for both conference-
aware and conference-unaware UAs, certain conventions for MSRP chat
rooms need to be defined. It also seems beneficial to provide a set
of features that enhance the baseline multi-party MSRP in order to be
able to create systems that have functionality on par with existing
chat systems as well as to enable the building of interworking
gateways to these existing chat systems.
We define the following requirements:
REQ-1: A basic requirement is the existence of a chat room, where
participants can join and leave the chat room and exchange
IMs with the rest of the participants.
REQ-2: A recipient of an IM in a chat room must be able to determine
the identifier of the sender of the message. Note that the
actual identifier depends on the one that was used by the
sender when joining the chat room.
<span class="grey">Niemi, et al. Standards Track [Page 6]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
REQ-3: A recipient of an IM in a chat room must be able to determine
the identifier of the recipient of received messages. For
instance, the recipient of the message might be the entire
chat room or a single participant (i.e., a private message).
Note that the actual identifier may depend on the one that
was used by the recipient when he or she joined the chat
room.
REQ-4: It must be possible to send a message to a single participant
within the chat room (i.e., a private IM).
REQ-5: A chat room participant may have a nickname or pseudonym
associated with their real identifier.
REQ-6: It must be possible for a participant to change their
nickname during the progress of the chat room session.
REQ-7: It must be possible for a participant to be known only by an
anonymous identifier and not their real identifier by the
rest of the chat room.
REQ-8: It must be possible for chat room participants to learn the
chat room capabilities described in this document.
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Overview of Operation</span>
Before a chat room can be entered, it must be created. Users wishing
to host a chat room themselves can, of course, do just that; their UA
simply morphs from an ordinary UA into a special purpose one called a
"Focus UA". Another, commonly used setup is one where a dedicated
node in the network functions as a Focus UA.
Each chat room has an identifier of its own: a SIP URI that
participants use to join the chat room, e.g., by sending an INVITE
request to it. The conference focus processes the invitations, and
as such, maintains SIP dialogs with each participant. In a multi-
party chat, or chat room, MSRP is one of the established media
streams. Each chat room participant establishes an MSRP session with
the MSRP switch, which is a special purpose MSRP application. The
MSRP sessions can be relayed by one or more MSRP relays, which are
specified in <a href="./rfc4976">RFC 4976</a> [<a href="./rfc4976" title=""Relay Extensions for the Message Sessions Relay Protocol (MSRP)"">RFC4976</a>]. This is illustrated in Figure 1.
<span class="grey">Niemi, et al. Standards Track [Page 7]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
MSRP Sessions
+--------------------------+
| |
+---+--+ +---+--+ |
| SIP | | SIP | |
| MSRP | | MSRP | +-----+-----+
|Client| |Client| | MSRP |
+---+--+ ++--+--+ | Relay |
| | \ +-----+-----+
SIP Dialogs | / +----+ |
| | \ | MSRP Sessions
+----+------+--+ | |
| | +-+-----+-----+
| Conference | | MSRP |
| Focus UA |........| Switch |
| | | |
+----+-------+-+ +-+-----+-----+
| \ | |
SIP Dialogs | | +------+ | MSRP Sessions
| \ / |
+---+--+ +-+--+-+ +-----+-----+
| SIP | | SIP | | MSRP |
| MSRP | | MSRP | | Relay |
|Client| |Client| +-----+-----+
+---+--+ +------+ |
| |
+--------------------------+
MSRP Sessions
Figure 1: Multi-party Chat Overview Shown with MSRP Relays
and a Conference Focus UA
The MSRP switch is similar to a conference mixer in that it both
handles media sessions with each of the participants and bridges
these streams together. However, unlike a conference mixer, the MSRP
switch merely forwards messages between participants: it doesn't
actually mix the streams in any way. The system is illustrated in
Figure 2.
<span class="grey">Niemi, et al. Standards Track [Page 8]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
+------+
| MSRP |
|Client|
+------+ +--.---+ +------+
| MSRP | | | MSRP |
|Client| | _|Client|
+------._ | ,' +------+
`._ | ,'
`.. +----------+ ,'
`| |'
| MSRP |
| Switch |
,| |_
_,-'' +----------+ ``-._
+------.-' | `--+------+
| MSRP | | | MSRP |
|Client| | |Client|
+------+ | +------+
+---'--+
| MSRP |
|Client|
+------+
Figure 2: Multi-party Chat in a Centralized Chat Room
Typically, chat room participants also subscribe to a conference
event package to gather information about the conference roster in
the form of conference state notifications. For example,
participants can learn about other participants' identifiers,
including their nicknames.
All messages in the chat room use the Message/CPIM wrapper content
type [<a href="./rfc3862" title=""Common Presence and Instant Messaging (CPIM): Message Format"">RFC3862</a>], to distinguish between private and regular messages.
When a participant wants to send an instant message to the chat room,
it constructs an MSRP SEND request and submits it to the MSRP switch
including a regular payload (e.g., a Message/CPIM message that
contains text, HTML, an image, etc.). The Message/CPIM To header is
set to the chat room URI. The switch then fans out the SEND request
to all of the other participants using their existing MSRP sessions.
A participant can also send a private IM addressed to a participant
whose identifier has been learned, e.g., via a conference event
package. In this case, the sender creates an MSRP SEND request with
a Message/CPIM wrapper whose To header contains not the chat room URI
but the recipient's URI. The MSRP switch then forwards the SEND
request to that recipient. This specification supports the sending
of private messages to one and only one recipient. However, if the
<span class="grey">Niemi, et al. Standards Track [Page 9]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
recipient is logged in from different endpoints, the MSRP switch will
distribute the private message to each endpoint at which the
recipient is logged in.
We extend the current MSRP negotiation that takes place in SDP
[<a href="./rfc4566" title=""SDP: Session Description Protocol"">RFC4566</a>] to allow participants to learn whether the chat room
supports and is willing to accept (e.g., due to local policy
restrictions) certain MSRP functions defined in this memo, such as
nicknames or private messaging. This is achieved by a new 'chatroom'
attribute in SDP (please refer to <a href="#section-8">Section 8</a> for a detailed
description).
Naturally, when a participant wishes to leave a chat room, it sends a
SIP BYE request to the Focus UA and terminates the SIP dialog with
the focus and MSRP sessions with the MSRP switch.
This document assumes that each chat room is allocated its own SIP
URI. A user joining a chat room sends an INVITE request to that SIP
URI, and, as a result, a new MSRP session is established between the
user and the MSRP switch. It is assumed that an MSRP session is
mapped to a chat room. If a user wants to join a second chat room,
he creates a different INVITE request, through a different SIP
dialog, which leads to the creation of a second MSRP session between
the user and the MSRP switch. Notice that these two MSRP sessions
can still be multiplexed over the same TCP connection as per regular
MSRP procedures. However, each chat room is associated with a unique
MSRP session and a unique SIP dialog.
<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>. Policy Attributes of the Chat Room</span>
The Conference Framework with SIP [<a href="./rfc4353" title=""A Framework for Conferencing with the Session Initiation Protocol (SIP)"">RFC4353</a>] introduces the notion of
a Conference Policy as "The complete set of rules governing a
particular conference." A chat room is a specialized type of
conference, and the conference policy is sometimes extended with new
chat-specific rules. This section lists all the Conference Policy
attributes used by the present document and refers to sections in the
document where the usage of these attributes are described in greater
detail.
Nicknames: Whether the chat room accepts users to be recognized with
a nickname. See Sections <a href="#section-7">7</a>, <a href="#section-7.1">7.1</a>, and <a href="#section-8">8</a> for details. Also, the
scope of uniqueness of the nickname: the chat room (conference
instance), a realm or domain, a server, etc.
<span class="grey">Niemi, et al. Standards Track [Page 10]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
Nickname quarantine: The quarantine to be imposed on a nickname once
it is not currently in use (e.g., because the participant holding
this nickname abandons the chat room), prior to the wide
availability of this nickname to other users. This allows the
initial holder of the nickname to join the chat room during the
quarantine period and claim the same nickname they were previously
using. See <a href="#section-11">Section 11</a> for details.
Private messaging: Whether the chat room allows users to send
private messages to other users of the chat room through the MSRP
switch. See Sections <a href="#section-6.2">6.2</a> and <a href="#section-8">8</a> for details.
Deletion of the chat room: Whether the chat room can be deleted when
the creator leaves the chat room or through an out-of-band
mechanism. See <a href="#section-5.3">Section 5.3</a> for details.
Simultaneous access: Whether a user can log in from different
endpoints using the same identity. See Sections <a href="#section-6.1">6.1</a> and <a href="#section-6.2">6.2</a> for
details.
Force TLS transport: Whether the MSRP switch accepts only Transport
Layer Security (TLS) as an MSRP transport, in an effort to
guarantee confidentiality and privacy. See <a href="#section-11">Section 11</a> for
details.
Maximum message size in congested MSRP sessions: The maximum size of
messages that can be distributed to a user over a congested MSRP
session. See <a href="#section-6.4">Section 6.4</a> for details.
Chunk reception timer: The value of a time that controls the maximum
time that the MSRP switch is waiting for the reception of
different chunks belonging to the same message. If the timer
expires, the MSRP switch will discard the associated message
state. See <a href="#section-6.1">Section 6.1</a> for details.
Supported wrapped media types: The list of media types that the MSRP
switch accepts in Message/CPIM wrappers sent from participants.
This list is included in the 'accept-wrapped-types' attribute of
the MSRP message media line in SDP. If the MSRP switch accepts
additional media types to those explicitly listed, a "*" is added
to the list. A single "*" indicates that the chat room accepts
any wrapped media type.
<span class="grey">Niemi, et al. Standards Track [Page 11]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Creating, Joining, and Deleting a Chat Room</span>
<span class="h3"><a class="selflink" id="section-5.1" href="#section-5.1">5.1</a>. Creating a Chat Room</span>
Since we consider a chat room a particular type of conference having
MSRP media, the methods defined by the SIP Conference Framework
[<a href="./rfc4353" title=""A Framework for Conferencing with the Session Initiation Protocol (SIP)"">RFC4353</a>] for creating conferences are directly applicable to a chat
room.
Once a chat room is created, it is identified by a SIP URI, like any
other conference.
<span class="h3"><a class="selflink" id="section-5.2" href="#section-5.2">5.2</a>. Joining a Chat Room</span>
Participants usually join the chat room by sending an INVITE request
to the chat room URI. The chat room then uses regular SIP mechanisms
to authenticate the participant. This may include, e.g., client
certificates, SIP Digest authentication [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>], asserted network
identity [<a href="./rfc3325" title=""Private Extensions to the Session Initiation Protocol (SIP) for Asserted Identity within Trusted Networks"">RFC3325</a>], SIP Identity header field [<a href="./rfc4474" title=""Enhancements for Authenticated Identity Management in the Session Initiation Protocol (SIP)"">RFC4474</a>], etc. As
long as the user is authenticated, the INVITE request is accepted by
the focus and the user is brought into the actual chat room.
This specification requires all IMs to be wrapped in a Message/CPIM
wrapper [<a href="./rfc3862" title=""Common Presence and Instant Messaging (CPIM): Message Format"">RFC3862</a>]. Therefore, the 'accept-types' attribute for the
MSRP message media in both the SDP offer and answer need to include
at least the value 'Message/CPIM' (notice that <a href="./rfc4975">RFC 4975</a> [<a href="./rfc4975" title=""The Message Session Relay Protocol (MSRP)"">RFC4975</a>]
mandates this 'accept-types' attribute in SDP). If the 'accept-
types' attribute does not contain the value 'Message/CPIM', the
conference focus will reject the request. The actual instant message
payload type is negotiated in the 'accept-wrapped-types' attribute in
SDP (see <a href="./rfc4975">RFC 4975</a> [<a href="./rfc4975" title=""The Message Session Relay Protocol (MSRP)"">RFC4975</a>] for details). There is no default
wrapped type. Typical wrapped type values can include text/plain,
text/html, image/jpeg, image/png, audio/mp3, etc. It is RECOMMENDED
that participant endpoints add an 'accept-wrapped-types' attribute to
the MSRP 'message' media line in SDP, where the supported wrapped
types are declared, as per <a href="./rfc4975">RFC 4975</a> procedures [<a href="./rfc4975" title=""The Message Session Relay Protocol (MSRP)"">RFC4975</a>].
The MSRP switch needs to be aware of the URIs of the participant
(SIP, tel, or IM URIs) in order to validate messages sent from this
participant prior to their forwarding. This information is known to
the focus of the conference. Therefore, an interface between the
focus and the MSRP switch is assumed. However, the interface between
the focus and the MSRP switch is outside the scope of this document.
Conference-aware participants will detect that the peer is a focus
due to the presence of the "isfocus" feature tag [<a href="./rfc3840" title=""Indicating User Agent Capabilities in the Session Initiation Protocol (SIP)"">RFC3840</a>] in the
Contact header field of the 200-class response to the INVITE request.
Conference-unaware participants will not notice it is a focus, and
<span class="grey">Niemi, et al. Standards Track [Page 12]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
cannot apply the additional mechanisms defined in this document.
Participants are also aware that the mixer is an MSRP switch due to
the presence of a 'message' media type and either TCP/MSRP or
TCP/TLS/MSRP as the protocol field in the media line of SDP
[<a href="./rfc4566" title=""SDP: Session Description Protocol"">RFC4566</a>].
The conference focus of a chat room MUST only use a Message/CPIM
[<a href="./rfc3862" title=""Common Presence and Instant Messaging (CPIM): Message Format"">RFC3862</a>] top-level wrapper as a payload of MSRP messages, and the
focus MUST declare it in the SDP offer or answer as per regular
procedures in <a href="./rfc4975">RFC 4975</a> [<a href="./rfc4975" title=""The Message Session Relay Protocol (MSRP)"">RFC4975</a>]. This implies that if the
conference focus receives, from a participant's endpoint, an SDP
offer that does not include the value 'Message/CPIM' in the 'accept-
types' attribute for the MSRP message media line, the conference
focus SHOULD either reject the MSRP message media stream or reject
the complete SDP offer by using regular SIP or SDP procedures (e.g.,
creating an SDP answer that sets to zero the port of the MSRP message
media line, responding the INVITE with a 488 response, etc.).
If the conference focus accepts the participant's SDP offer, when the
conference focus generates the SDP answer, it MUST set the 'accept-
types' attribute for the MSRP message media line to a value of
'Message/CPIM'. This specification requires all IMs to be wrapped in
a Message/CPIM wrapper, therefore, the 'accept-types' attribute in
this SDP body contains a single value of 'Message/CPIM'. The actual
IM payload type is negotiated in the 'accept-wrapped-types' attribute
in SDP (see <a href="./rfc4975">RFC 4975</a> [<a href="./rfc4975" title=""The Message Session Relay Protocol (MSRP)"">RFC4975</a>] for details). The conference focus
MAY also add an 'accept-wrapped-types' attribute to the MSRP message
media line in SDP containing the supported wrapped types, according
to the supported wrapped media types policy.
Note that the Message/CPIM wrapper is used to carry the sender
information that, otherwise, it will not be available to the
recipient. Additionally, the Message/CPIM wrapper carries the
recipient information (e.g., To and Cc headers).
If the UA supports anonymous participation and the user chooses to
use it, the participant's UA SHOULD do at least one of these options:
(a) provide an anonymous URI in SIP headers that otherwise reveal
identifiers. Please refer to <a href="./rfc3323">RFC 3323</a> [<a href="./rfc3323" title=""A Privacy Mechanism for the Session Initiation Protocol (SIP)"">RFC3323</a>] for a detailed
description of which headers are subject to reveal identifiers
and how to populate them; or
(b) trust the conference focus and request privacy of their URI,
e.g., by means of the SIP Privacy header field [<a href="./rfc3323" title=""A Privacy Mechanism for the Session Initiation Protocol (SIP)"">RFC3323</a>],
network asserted identity [<a href="./rfc3325" title=""Private Extensions to the Session Initiation Protocol (SIP) for Asserted Identity within Trusted Networks"">RFC3325</a>], or a similar privacy
mechanism.
<span class="grey">Niemi, et al. Standards Track [Page 13]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
If the participant has requested privacy, the conference focus MUST
expose a participant's anonymous URI through the conference event
package [<a href="./rfc4575" title=""A Session Initiation Protocol (SIP) Event Package for Conference State"">RFC4575</a>].
The conference focus of a chat room learns the supported chat room
capabilities in the endpoint by means of the 'chatroom' attribute
exchanged in the SDP offer/answer (please refer to <a href="#section-8">Section 8</a> for a
detailed description). The conference focus MUST inform the MSRP
switch of the chat room capabilities of each participant that joins
the chat room (note that the interface defined between the conference
focus and the MSRP switch is outside the scope of this
specification). This information allows the MSRP switch, e.g., to
avoid the distribution of private messages to participants whose
endpoints do not support private messaging.
<span class="h3"><a class="selflink" id="section-5.3" href="#section-5.3">5.3</a>. Deleting a Chat Room</span>
As with creating a conference, the methods defined by the SIP
Conference Framework [<a href="./rfc4353" title=""A Framework for Conferencing with the Session Initiation Protocol (SIP)"">RFC4353</a>] for deleting a conference are directly
applicable to a chat room. The MSRP switch will terminate the MSRP
sessions with all the participants.
Deleting a chat room is an action that heavily depends on the policy
of the chat room. For example, the policy can determine whether the
chat room is deleted when the creator leaves the room or whether an
out-of-band mechanism is responsible for the deletion.
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. Sending and Receiving Instant Messages</span>
<span class="h3"><a class="selflink" id="section-6.1" href="#section-6.1">6.1</a>. Regular Messages</span>
This section describes the conventions used to send and receive IMs
that are addressed to all the participants in the chat room. These
are sent over a regular MSRP SEND request that contains a Message/
CPIM wrapper [<a href="./rfc3862" title=""Common Presence and Instant Messaging (CPIM): Message Format"">RFC3862</a>] that, in turn, contains the desired payload
(e.g., text, image, video clip, etc.).
When a chat room participant wishes to send an instant message to all
the other participants in the chat room, it constructs an MSRP SEND
request according to the procedures specified in <a href="./rfc4975">RFC 4975</a> [<a href="./rfc4975" title=""The Message Session Relay Protocol (MSRP)"">RFC4975</a>].
The sender MAY choose the desired MSRP report model (e.g., populate
the Success-Report and Failure-Report MSRP header fields).
On sending a regular message, the sender MUST populate the To header
of the Message/CPIM wrapper with the URI of the chat room. The
sender MUST also populate the From header of the Message/CPIM wrapper
with a proper identifier by which the user is recognized in the chat
room. Identifiers that can be used (among others) are:
<span class="grey">Niemi, et al. Standards Track [Page 14]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
o A SIP URI [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>] representing the participant's address-of-
record
o A tel URI [<a href="./rfc3966" title=""The tel URI for Telephone Numbers"">RFC3966</a>] representing the participant's telephone
number
o An IM URI [<a href="./rfc3860" title=""Common Profile for Instant Messaging (CPIM)"">RFC3860</a>] representing the participant's instant
messaging address
o An anonymous URI representing the participant's anonymous address
If the participant wants to remain anonymous, the participant's
endpoint MUST populate an anonymous URI in the From header of the
Message/CPIM wrapper. Other participants of the chat room will use
this anonymous URI in the To header of the Message/CPIM wrapper when
sending private messages. Notice that in order for the anonymity
mechanism to work, the anonymous URI MUST NOT reveal the
participant's SIP AOR. The mechanism for acquiring an anonymous URI
is outside the scope of this specification.
An MSRP switch that receives a SEND request from a participant SHOULD
first verify that the From header field of the Message/CPIM wrapper
is correctly populated with a valid URI of a participant. This
imposes a requirement for the focus of the conference to inform the
MSRP switch of the URIs by which the participant is known, in order
for the MSRP switch to validate messages. <a href="#section-6.3">Section 6.3</a> provides
further information with the actions to be taken in case this
validation fails.
Then the MSRP switch should inspect the To header field of the
Message/CPIM wrapper. If the MSRP switch receives a message
containing several To header fields in the Message/CPIM wrapper the
MSRP switch MUST reject the MSRP SEND request with a 403 response, as
per procedures in <a href="./rfc4975">RFC 4975</a> [<a href="./rfc4975" title=""The Message Session Relay Protocol (MSRP)"">RFC4975</a>]. Then, if the To header field
of the Message/CPIM wrapper contains the chat room URI and there are
no other To header fields, the MSRP switch can generate a copy of the
SEND request to each of the participants in the chat room except the
sender. The MSRP switch MUST NOT modify the content received in the
SEND request. However, the MSRP switch MAY re-chunk any of the
outbound MSRP SEND requests.
When generating a copy of the SEND request to each participant in the
chat room, the MSRP switch MUST evaluate the wrapped media types that
the recipient is able to accept. This was learned through the
'accept-wrapped-types' attribute of the MSRP message media line in
SDP. If the MSRP switch is aware that the media type of the wrapped
content is not acceptable to the recipient, the MSRP switch SHOULD
NOT forward this message to that endpoint. Note that this version of
<span class="grey">Niemi, et al. Standards Track [Page 15]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
the specification does not require the MSRP switch to notify the
sender about this failure. Extensions to this specification may
improve handling of unknown media types.
Note that the MSRP switch does not need to wait for the reception of
the complete MSRP chunk or MSRP message before it starts the
distribution to the rest of the participants. Instead, once the MSRP
switch has received the headers of the Message/CPIM wrapper, it
SHOULD start the distribution process. But, bear in mind that the
MSRP switch SHOULD still implement some sanity checking. Please
refer to the security considerations in <a href="#section-11">Section 11</a> for further
details.
When forwarding chunked messages as soon as they are received, the
Message/CPIM wrapper is only present at the beginning of the message,
typically within the first chunk. Subsequent chunks will contain the
rest of the message, but not the Message/CPIM headers. Therefore, an
MSRP switch that receives a subsequent message may face challenges in
determining the correct list of recipients of the message. An MSRP
switch that uses this fast forwarding procedure MUST temporarily
store the Message-ID of the MSRP message to correlate the different
chunks; it MUST also temporarily store the list of recipients to
which the initial chunks were delivered. The MSRP switch SHOULD
forward subsequent chunks only to those recipients who were sent the
initial chunks, except if the MSRP switch has knowledge that one of
the recipients of the initial chunks has dropped from the chat room.
This behavior also avoids new participants who had joined the chat
room when the first chunk was distributed from receiving subsequent
chunks that would otherwise need to be discarded.
Once the MSRP switch receives the last chunk of a message, and that
chunk is successfully sent to each of the recipients, the MSRP switch
discards the temporary storage of MSRP Message-ID and the associated
list of recipients.
In some occasions, a sender might suffer a transport error condition
(such as loss of connectivity or depletion of battery) that makes the
sending of a message incomplete, e.g., some chunks were received by
the MSRP switch, but not all of them. This is a behavior already
considered in the core MSRP specification (see <a href="./rfc4975">RFC 4975</a> <a href="./rfc4975#section-5.4">[RFC4975]
Section 5.4</a>). The problem in the context of a chat room lies with
the use of temporary storage for fast forwarding. In order to
prevent attacks related to the exhaustion of temporary storage of
chunked messages, on receiving a first chunk of a message, where the
MSRP switch is using the fast forward method, the MSRP switch MUST
set a chunk reception timer for controlling the reception of the
remaining chunks.
<span class="grey">Niemi, et al. Standards Track [Page 16]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
This chunk reception timer can be reset every time a new chunk of the
same message is received. When this timer expires, the MSRP switch
MUST consider that the sending of the message was aborted, and it MAY
discard all the message state associated with it, including the
Message-ID and the list of recipients. Additionally, if this chunk
reception timer expires, the MSRP switch MAY choose to send an abort
chunk (i.e., one with the "#" flag set) to each to the recipients.
This is just an optimization, since MSRP endpoints need to be able to
handle incomplete messages as per regular MSRP.
The specific value of this chunk reception timer is not standardized;
it is subject of local policy. However, it is recommended not to be
a short value. For example, a time interval on the order of a normal
TCP timeout (i.e., around 540 seconds) would be reasonable. A value
on the order of a few seconds would not.
An MSRP endpoint that receives a SEND request from the MSRP switch
containing a Message/CPIM wrapper SHOULD first inspect the To header
field of the Message/CPIM wrapper. If the To header field is set to
the chat room URI, it should render it as a regular message that has
been distributed to all the participants in the chat room. Then, the
MSRP endpoint SHOULD inspect the From header field of the Message/
CPIM wrapper to identify the sender. The From header field will
include a URI that identifies the sender. The endpoint might have
also received further identifier information through a subscription
to a conference event package.
It is possible that a participant, identified by a SIP AoR or other
valid URI, joins a chat room simultaneously from two or more
different SIP UAs. It is recommended that the MSRP switch implements
means to map a URI to two or more MSRP sessions. If the policy of
the chat room allows simultaneous access, the MSRP switch MUST copy
all regular messages intended to the recipient through each MSRP
session mapped to the recipient's URI.
<span class="h3"><a class="selflink" id="section-6.2" href="#section-6.2">6.2</a>. Private Messages</span>
This section describes the conventions used to send and receive
private IMs, i.e., IMs that are addressed to one participant of the
chat room rather than to all of them. The chat room has a local
policy that determines whether or not private messages are supported.
A chat room can signal support for private messages using the
'chatroom' attribute in SDP (please refer to <a href="#section-8">Section 8</a> for a detailed
description).
When a chat room participant wishes to send a private IM to a
participant in the chat room, it follows the same procedures to
create a SEND request as for regular messages (<a href="#section-6.1">Section 6.1</a>). The
<span class="grey">Niemi, et al. Standards Track [Page 17]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
only difference is that the MSRP endpoint MUST populate a single To
header of the Message/CPIM wrapper with the identifier of the
intended recipient. The identifier can be SIP, tel, and im URIs
typically learned from the information received in notifications of a
conference event package.
This version of the specification does not support sending a
private message to multiple recipients, i.e., the presence of
multiple To headers in the Message/CPIM wrapper of the MSRP SEND
request. This is due to added complexity, for example, with the
need to determine whether a message was not delivered to some of
the intended recipients. Implementations that still want to
recreate this function can send a series of single private
messages, one private message per intended recipient. The
endpoint can correlate this series of messages and create the
effect of a private message addressed to multiple recipients.
As for regular messages, an MSRP switch that receives a SEND request
from a participant SHOULD first verify that the From header field of
the Message/CPIM wrapper is correctly populated with a valid URI
(i.e., the URI is a participant of this chat room). <a href="#section-6.3">Section 6.3</a>
provides further information regarding the actions to be taken in
case this validation fails.
Then, the MSRP switch inspects the To header field of the Message/
CPIM wrapper. If the MSRP switch receives a message containing
several To header fields in the Message/CPIM wrapper, the MSRP switch
MUST reject the MSRP SEND request with a 403 response, as per
procedures in <a href="./rfc4975">RFC 4975</a> [<a href="./rfc4975" title=""The Message Session Relay Protocol (MSRP)"">RFC4975</a>]. Then, the MSRP switch verifies
that the To header of the Message/CPIM wrapper matches the URI of a
participant of the chat room. If this To header field does not
contain the URI of a participant of the chat room or if the To header
field cannot be resolved (e.g., caused by a mistyped URI), the MSRP
switch MUST reject the request with a 404 response. This new 404
status code indicates a failure to resolve the recipient URI in the
To header field of the Message/CPIM wrapper.
Notice the importance of the From and To headers in the Message/
CPIM wrapper. If an intermediary modifies these values, the MSRP
switch might not be able to identify the source or intended
destination of the message, resulting in a rejection of the
message.
Finally, the MSRP switch verifies that the recipient supports private
messages. If the recipient does not support private messages, the
MSRP switch MUST reject the request with a 428 response. This new
428 response indicates that the recipient does not support private
messages. Any potential REPORT request that the MSRP switch sends to
<span class="grey">Niemi, et al. Standards Track [Page 18]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
the sender MUST include a Message/CPIM wrapper containing the
original From header field included in the SEND request and the To
header field of the original Message/CPIM wrapper. The MSRP switch
MUST NOT forward private messages to a recipient that does not
support private messaging.
If successful, the MSRP switch should search its mapping table to
find the MSRP sessions established toward the recipient. If a match
is found, the MSRP switch MUST create a SEND request and MUST copy
the contents of the sender's message to it.
An MSRP endpoint that receives a SEND request from the MSRP switch
does the same validations as for regular messages (<a href="#section-6.1">Section 6.1</a>). If
the To header field is different from the chat room URI, the MSRP
endpoints know that this is a private message. The endpoint should
render who it is from based on the value of the From header of the
Message/CPIM wrapper. The endpoint can also use the sender's
nickname, possibly learned via a conference event package, to render
the sender of the message, instead of using the sender's actual URI.
As with regular messages, if the policy of the chat room allows
simultaneous access, the MSRP switch MUST copy all private messages
intended to the recipient through each MSRP session mapped to the
recipient's URI.
<span class="h3"><a class="selflink" id="section-6.3" href="#section-6.3">6.3</a>. MSRP Reports and Responses</span>
This section discusses the common procedures for regular and private
messages with respect to MSRP reports and responses. Any particular
procedure affecting only regular messages or only private messages is
discussed in the previous sections (Sections <a href="#section-6.1">6.1</a> or <a href="#section-6.2">6.2</a>,
respectively).
MSRP switches MUST follow the success report and failure report
handling described in <a href="./rfc4975#section-7">Section 7 of RFC 4975</a> [<a href="./rfc4975" title=""The Message Session Relay Protocol (MSRP)"">RFC4975</a>], complemented
with the procedures described in this section. The MSRP switch MUST
act as an MSRP endpoint receiver of the request, according to
<a href="./rfc4975#section-5.3">Section 5.3 of RFC 4975</a> [<a href="./rfc4975" title=""The Message Session Relay Protocol (MSRP)"">RFC4975</a>].
If the MSRP switch receives an MSRP SEND request that does not
contain a Message/CPIM wrapper, the MSRP switch MUST reject the
request with a 415 response (specified in <a href="./rfc4975">RFC 4975</a> [<a href="./rfc4975" title=""The Message Session Relay Protocol (MSRP)"">RFC4975</a>]).
If the MSRP switch receives an MSRP SEND request where the URI
included in the From header field of the Message/CPIM wrapper is not
valid, (e.g., because it does not "belong" to the sender of the
message or is not a valid participant of the chat room), the MSRP
<span class="grey">Niemi, et al. Standards Track [Page 19]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
switch MUST reject the request with a 403 response. In cases without
error, the MSRP switch MUST construct responses according to
<a href="./rfc4975#section-7.2">Section 7.2 of RFC 4975</a> [<a href="./rfc4975" title=""The Message Session Relay Protocol (MSRP)"">RFC4975</a>].
When the MSRP switch forwards a SEND request, it MAY use any report
model in the copies intended for the recipients. The receiver
reports from the recipients MUST NOT be forwarded to the originator
of the original SEND request. This could lead to having the sender
receiving multiple reports for a single MSRP request.
<span class="h3"><a class="selflink" id="section-6.4" href="#section-6.4">6.4</a>. Congestion Avoidance</span>
Congestion can occur when multiple heterogeneous interfaces are used
by a number of users who are participating in a chat room, and, in
particular, when paths become overloaded by any application. Some of
these users might have fast paths capable of high throughputs while
other users might be slow paths with constrained throughputs. Some
paths might become congested only by the chat application; other
paths gets congested by other applications. Therefore, it is
possible that a subset of the participants of the chat room are able
to send and receive a large number of messages in a short time or
with large contents (e.g., pictures), whereas others are not able to
keep up the pace.
Additionally, since MSRP uses a connection-oriented transport
protocol such as TCP, it is expected that TCP congestion control
mechanisms be activated if congestion occurs. Details on congestion
control are specified in <a href="./rfc5681">RFC 5681</a> [<a href="./rfc5681" title=""TCP Congestion Control"">RFC5681</a>].
While this document does not mandate a particular MSRP-specific
mechanism to avoid congestion in any of the paths, something that is
deemed outside the scope of this document, this document provides
some recommendations for implementors to consider.
It is RECOMMENDED that MSRP switches implement one or more MSRP-
specific strategies to detect and avoid congestion. Possible
strategies (but definitely not a comprehensive list) include:
o If the MSRP switch is writing data to a send buffer and detects
that the send buffer associated with that TCP connection is
getting full (e.g., close to 80% of its capacity), the MSRP switch
marks the associated MSRP sessions making use of that TCP
connection as "congested".
o Prior to sending a new MSRP message to a user, the MSRP switch
verifies the congested flag associated to that MSRP session. If
the MSRP session is marked as congested, the MSRP switch can apply
a congestion avoidance mechanism, such as:
<span class="grey">Niemi, et al. Standards Track [Page 20]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
* The MSRP switch MAY discard regular MSRP messages sent to that
user while the congestion flag is raised for the user's TCP
connection. In order to inform the user of the congestion, the
MSRP switch MAY send a regular MSRP message to the user whose
congestion flag is raised. This message indicates that some
other messages are being discarded due to network congestion.
However, it should be noted that this message can get stuck at
MSRP switch, if the path is fully congested, i.e., it may not
be delivered anyhow.
* The MSRP can implement a temporary policy to disallow the
distribution of messages larger than a certain size to MSRP
sessions marked as congested. Similarly, the user should be
informed of this fact by the MSRP switch sending a regular MSRP
message indicating this condition.
o If the MSRP switch determines that the congestion flag associated
with a given TCP connection has been raised for quite some time
(on the order of a few minutes), or if the interface is down, this
may be considered an indication that the TCP connection has not
been able to recover from a congestion state. The MSRP switch MAY
close this congested TCP connection as well as the MSRP session
and SIP session.
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. Nicknames</span>
A common characteristic of existing chat room services is that
participants have the ability to present themselves with a nickname
to the rest of the participants of the chat room. It is used for
easy reference of participants in the chat room and can also provide
anonymous participants with a meaningful descriptive name.
A nickname is a useful construct in many use cases, of which MSRP
chat is but one example. A nickname is associated with a URI; the
focus knows the participant by its association to this URI.
Therefore, if a user joins the chat room under the same URI from
multiple devices, he or she may request the same nickname across all
these devices.
A nickname is a user-selectable moniker by which the participant
wants to be known to the other participants. It is not a 'display-
name', but it is used somewhat like a display name. A main
difference is that a nickname is unique inside a chat room to allow
an unambiguous reference to a participant in the chat. Nicknames may
be long lived, or they may be temporary. Users also need to reserve
a nickname prior to its utilization.
<span class="grey">Niemi, et al. Standards Track [Page 21]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
This memo specifies the nickname as a string. The nickname string
MUST unambiguously be associated with a single user in the scope of
the chat room (conference instance). This scope is similar to having
a nickname unique per user inside a chat room from "Extensible
Messaging and Presence Protocol (XMPP): Core" [<a href="./rfc6120" title=""Extensible Messaging and Presence Protocol (XMPP): Core"">RFC6120</a>]. The chat
room may have policies associated with nicknames. It may not accept
nickname strings at all, or it may provide a wider unambiguous scope
like a domain or server, similar to IRC [<a href="./rfc2810" title=""Internet Relay Chat: Architecture"">RFC2810</a>].
<span class="h3"><a class="selflink" id="section-7.1" href="#section-7.1">7.1</a>. Using Nicknames within a Chat Room</span>
This memo provides a mechanism to reserve a nickname for a
participant for as long as the participant is logged into the chat
room. The mechanism is based on a NICKNAME MSRP method (see below)
and a new "Use-Nickname" header. Note that other mechanisms may
exist (for example, a web page reservation system), although they are
outside the scope of this document.
A chat room participant who has established an MSRP session with the
MSRP switch, where the MSRP switch has indicated the support and
availability of nicknames with the 'nicknames' token in the
'chatroom' SDP attribute, MAY send a NICKNAME request to the MSRP
switch. The NICKNAME request MUST include a new Use-Nickname header
that contains the nickname string that the participant wants to
reserve. This nickname string MUST NOT be zero octets in length and
MUST NOT be more than 1023 octets in length. Finally, MSRP NICKNAME
requests MUST NOT include Success-Report or Failure-Report header
fields.
Bear in mind that nickname strings, like the rest of the MSRP
message, use the UTF-8 transformation format [<a href="./rfc3629" title=""UTF-8, a transformation format of ISO 10646"">RFC3629</a>].
Therefore, a character may be encoded in more than one octet.
An MSRP switch that receives a NICKNAME request containing a
Use-Nickname header field SHOULD first verify whether the policy of
the chat room allows the nickname functionality. If not allowed, the
MSRP switch MUST reject the request with a 403 response, as per <a href="./rfc4975">RFC</a>
<a href="./rfc4975">4975</a> [<a href="./rfc4975" title=""The Message Session Relay Protocol (MSRP)"">RFC4975</a>].
If the policy of the chat room allows the usage of nicknames, any new
nickname requested MUST be prepared and compared with nicknames
already in use or reserved following the rules defined in
"Preparation, Enforcement, and Comparison of Internationalized
Strings Representing Nicknames" [<a href="./rfc7700" title=""Preparation, Enforcement, and Comparison of Internationalized Strings Representing Nicknames"">RFC7700</a>].
This mitigates the problem of nickname duplication, but it does not
solve a problem whereby users can choose similar (but different)
characters to represent two different nicknames. For example, "BOY"
<span class="grey">Niemi, et al. Standards Track [Page 22]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
and "B0Y" are different nicknames that can mislead users. The former
uses the capital letter "O" while the latter uses the number zero
"0". In many fonts, the letter "O" and the number zero "0" might be
quite similar and difficult to perceive as different characters.
Chat rooms MAY provide a mechanism to mitigate confusable nicknames.
In addition to preparing and comparing following the rules above, the
MSRP switch SHOULD only allow the reservation of an already-used
nickname if the same user (e.g., identified by the SIP AOR) that is
currently using the nickname is making this subsequent request. This
may include, e.g., allowing the participant's URI to use the same
nickname when the participant has joined the chat room from different
devices under the same URI. The participant's authenticated
identifier can be derived after a successful SIP Digest
Authentication [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>], included in a trusted SIP P-Asserted-
Identity header field [<a href="./rfc3325" title=""Private Extensions to the Session Initiation Protocol (SIP) for Asserted Identity within Trusted Networks"">RFC3325</a>], included in a valid SIP Identity
header field [<a href="./rfc4474" title=""Enhancements for Authenticated Identity Management in the Session Initiation Protocol (SIP)"">RFC4474</a>], or derived from any other present or future
SIP authentication mechanism. Once the MSRP switch has validated
that the participant is entitled to reserve the requested nickname,
the MSRP switch verifies if the suggested nickname can be accepted
(see below).
The reservation of a nickname can fail in several cases. If the
NICKNAME request contains a malformed value in the Use-Nickname
header field, the MSRP switch MUST answer the NICKNAME request with a
424 response code. This can be the case when the value of the
Use-Nickname header field does not conform to the syntax.
The reservation of a nickname can also fail if the value of the
Use-Nickname header field of the NICKNAME request is a reserved word
(not to be used as a nickname by any user) or that particular value
is already in use by another user. In these cases, the MSRP switch
MUST answer the NICKNAME request with a 425 response code.
In both error conditions (receiving a 424 or 425 response code), the
nickname usage is considered failed; the nickname is not allocated to
this user. The user can select a different nickname and retry
another NICKNAME request.
If the MSRP switch is able to accept the suggested nickname to be
used by this user, the MSRP switch MUST answer the NICKNAME request
with a 200 response as per regular MSRP procedures.
<span class="grey">Niemi, et al. Standards Track [Page 23]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
As indicated earlier, this specification defines a new MSRP header
field: Use-Nickname. The Use-Nickname header field carries a
nickname string. This specification defines the usage of the
Use-Nickname header field in NICKNAME requests. If need arises,
usages of the Use-Nickname header field in other MSRP methods should
be specified separately.
According to <a href="./rfc4975">RFC 4975</a> [<a href="./rfc4975" title=""The Message Session Relay Protocol (MSRP)"">RFC4975</a>], MSRP uses the UTF-8 transformation
format [<a href="./rfc3629" title=""UTF-8, a transformation format of ISO 10646"">RFC3629</a>]. The syntax of the MSRP NICKNAME method and the
Use-Nickname header field is built upon the MSRP formal syntax
[<a href="./rfc4975" title=""The Message Session Relay Protocol (MSRP)"">RFC4975</a>] using the Augmented Backus-Naur Form (ABNF) [<a href="./rfc5234" title=""Augmented BNF for Syntax Specifications: ABNF"">RFC5234</a>].
other-method =/ NICKNAMEm
; other-method defined in <a href="./rfc4975">RFC 4975</a>
NICKNAMEm = %x4E.49.43.4B.4E.41.4D.45 ; NICKNAME in caps
ext-header =/ Use-Nickname
; ext-header defined in <a href="./rfc4975">RFC 4975</a>
Use-Nickname = "Use-Nickname:" SP nickname
nickname = DQUOTE 1*1023(qdtext / qd-esc) DQUOTE
; qdtext and qd-esc defined in <a href="./rfc4975">RFC 4975</a>
Note that, according to <a href="./rfc4975">RFC 4975</a> [<a href="./rfc4975" title=""The Message Session Relay Protocol (MSRP)"">RFC4975</a>], "quoted-string" admits a
subset of UTF-8 characters [<a href="./rfc3629" title=""UTF-8, a transformation format of ISO 10646"">RFC3629</a>]. Please refer to <a href="./rfc4975#section-9">Section 9 of
RFC 4975</a> [<a href="./rfc4975" title=""The Message Session Relay Protocol (MSRP)"">RFC4975</a>] for more details.
Once the MSRP switch has reserved a nickname and has bound it to a
URI (e.g., a SIP AoR), the MSRP server MAY allow the usage of the
same nickname by the same user (identified by the same URI, such as a
SIP AoR) over a second MSRP session. This might be the case if the
user joins the same chat room from a different SIP UA. In this case,
the user MAY request a nickname that is the same or different than
that used in conjunction with the first MSRP session; the MSRP server
MAY accept the usage of the same nickname by the same user. The MSRP
switch MUST NOT automatically assign the same nickname to more than
one MSRP session established from the same URI, because this can
create confusion to the user as whether the same nickname is bound to
the second MSRP session.
<span class="h3"><a class="selflink" id="section-7.2" href="#section-7.2">7.2</a>. Modifying a Nickname</span>
Typically, a participant will reserve a nickname as soon as the
participant joins the chat room. But it is also possible for a
participant to modify his/her own nickname and replace it with a new
one at any time during the duration of the MSRP session.
Modification of the nickname is not different from the initial
reservation and usage of a nickname; thus, the NICKNAME method is
used as described in <a href="#section-7.1">Section 7.1</a>.
<span class="grey">Niemi, et al. Standards Track [Page 24]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
If a NICKNAME request that attempts to modify the current nickname of
the user fails for some reason, the current nickname stays in effect.
A new nickname comes into effect and the old one is released only
after a NICKNAME request is accepted with a 200 response.
<span class="h3"><a class="selflink" id="section-7.3" href="#section-7.3">7.3</a>. Removing a Nickname</span>
If the participant no longer wants to be known by a nickname in the
chat room, the participant can follow the method described in
<a href="#section-7.2">Section 7.2</a>. The nickname element of the Use-Nickname header MUST be
set to an empty quoted string.
<span class="h3"><a class="selflink" id="section-7.4" href="#section-7.4">7.4</a>. Nicknames in Conference Event Packages</span>
Typically the conference focus acts as a notifier of the conference
event package, <a href="./rfc4575">RFC 4575</a> [<a href="./rfc4575" title=""A Session Initiation Protocol (SIP) Event Package for Conference State"">RFC4575</a>]. It is RECOMMENDED that conference
foci and endpoints support <a href="./rfc6502">RFC 6502</a> [<a href="./rfc6502" title=""Conference Event Package Data Format Extension for Centralized Conferencing (XCON)"">RFC6502</a>] for providing
information regarding the conference and, in particular, supplying
information of the roster of the conference. It is also RECOMMENDED
that conference foci and endpoints support <a href="./rfc6501">RFC 6501</a> [<a href="./rfc6501" title=""Conference Information Data Model for Centralized Conferencing (XCON)"">RFC6501</a>], which
extends the <user> element originally specified in <a href="./rfc4575">RFC 4575</a> [<a href="./rfc4575" title=""A Session Initiation Protocol (SIP) Event Package for Conference State"">RFC4575</a>]
with a new 'nickname' attribute. This allows endpoints to learn the
nicknames of participants of the chat room.
<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. The SDP 'chatroom' Attribute</span>
There are a handful of use cases where a participant would like to
learn the chat room capabilities supported by the local policy of the
MSRP switch and the chat room. For example, a participant would like
to learn if the MSRP switch supports private messaging; otherwise,
the participant may send what he believes is a private IM addressed
to a participant, but since the MSRP switch does not support the
functions specified in this memo, the message would eventually be
distributed to all the participants of the chat room.
The reverse case also exists. A participant, say Alice, whose UA
does not support the extensions defined by this document joins the
chat room. The MSRP switch learns that Alice's application does not
support private messaging nor nicknames. If another participant, say
Bob, sends a private message to Alice, the MSRP switch does not
distribute it to Alice, because Alice is not able to differentiate it
from a regular message sent to the whole roster. Furthermore, if
Alice replied to this message, she would do it to the whole roster.
Because of this, the MSRP switch also keeps track of users who do not
support the extensions defined in this document.
<span class="grey">Niemi, et al. Standards Track [Page 25]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
In another scenario, the policy of a chat room may indicate that
certain functions are not allowed. For example, the policy may
indicate that nicknames or private messages are forbidden.
In order to provide the user with a good chat room experience, we
define a new 'chatroom' SDP attribute. The 'chatroom' attribute is a
media-level value attribute [<a href="./rfc4566" title=""SDP: Session Description Protocol"">RFC4566</a>] that MAY be included in
conjunction with an MSRP media stream (i.e., when an "m=" line in SDP
indicates "TCP/MSRP" or "TCP/TLS/MSRP"). The 'chatroom' attribute
without further modifiers (e.g., chat-tokens) indicates that the
endpoint supports the procedures described in this document for
transferring MSRP messages to/from a chat room. The 'chatroom'
attribute can be complemented with additional modifiers that further
indicate the intersection of support and local policy allowance for a
number of functions specified in this document. Specifically, we
provide the means to indicate support for the use of nicknames and
private messaging.
The 'chatroom' attribute merely indicates the capabilities supported
and allowed by the local policy. This attribute is not a negotiation
subject to the SDP offer/answer model [<a href="./rfc3264" title=""An Offer/Answer Model with Session Description Protocol (SDP)"">RFC3264</a>], but instead a
declaration. Therefore, a 'chatroom' attribute included in an SDP
answer does not need to be a subset of the values included in the
'chatroom' attribute of its corresponding SDP offer. Consequently,
an SDP answer MAY contain a 'chatroom' attribute even if its
corresponding SDP offer did not include it.
In subsequent SDP offer/answer [<a href="./rfc3264" title=""An Offer/Answer Model with Session Description Protocol (SDP)"">RFC3264</a>] exchanges pertaining to the
same session, the 'chatroom' attribute MAY be modified with respect
to an earlier SDP offer/answer exchange. The new value of this
attribute indicates the current support and local policy, meaning
that some restrictions can apply now or might have been removed. If
the 'chatroom' attribute is not included in a subsequent SDP offer/
answer, but a corresponding MSRP stream is still in place, it
indicates that support for the procedures indicated in this document
are disabled.
<span class="grey">Niemi, et al. Standards Track [Page 26]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
The 'chatroom' SDP attribute has the following ABNF [<a href="./rfc5234" title=""Augmented BNF for Syntax Specifications: ABNF"">RFC5234</a>] syntax:
attribute =/ chatroom-attr
; attribute defined in <a href="./rfc4566">RFC 4566</a>
chatroom-attr = chatroom-label [":" chat-token
*(SP chat-token)]
chatroom-label = "chatroom"
chat-token = (nicknames-token / private-msg-token /
ext-token)
nicknames-token = "nickname"
private-msg-token = "private-messages"
ext-token = private-token / standard-token
private-token = toplabel "." *(domainlabel ".") token
; toplabel defined in <a href="./rfc3261">RFC 3261</a>
; domainlabel defined in <a href="./rfc3261">RFC 3261</a>
; token defined in <a href="./rfc3261">RFC 3261</a>
standard-token = token
A given 'chat-token' value MUST NOT appear more than once in a
'chatroom' attribute.
A conference focus that includes the 'nicknames' token in the session
description is signaling that the MSRP switch supports and the chat
room allows the use of the procedures specified in <a href="#section-7">Section 7</a>. A
conference focus that includes the 'private-messages' in the SDP
description is signaling that the MSRP switch supports and the chat
room allows the use of the procedures specified in <a href="#section-6.2">Section 6.2</a>.
An example of the 'chatroom' attribute for an MSRP media stream that
indicates the acceptance of nicknames and private messages:
a=chatroom:nickname private-messages
An example of a 'chatroom' attribute for an MSRP media stream where
the endpoint, e.g., an MSRP switch, does not allow nicknames or
private messages.
a=chatroom
The 'chatroom' attribute allows extensibility with the addition of
new tokens. No IANA registry is provided at this time, since no
extensions are expected at the time of this writing. Extensions to
the 'chatroom' attribute can be defined in IETF documents or as
private-vendor extensions.
<span class="grey">Niemi, et al. Standards Track [Page 27]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
Extensions defined in an IETF document MUST follow the 'standard-
token' ABNF previously defined. In this type of extension, care must
be taken in the selection of the token to avoid a clash with any of
the tokens previously defined.
Private extensions MUST follow the 'private-token' ABNF previously
defined. The 'private-token' MUST be included in the DNS name of the
vendor. Then, the token is reversed in order to avoid clashes of
tokens. The following is an example of an extension named "foo.chat"
by a vendor "example.com"
a=chatroom:nickname private-messages com.example.chat.foo
Note that feature names created by different organizations are not
intended to have the same semantics or even interoperate.
<span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. Examples</span>
<span class="h3"><a class="selflink" id="section-9.1" href="#section-9.1">9.1</a>. Joining a Chat Room</span>
Figure 3 presents a flow diagram where Alice joins a chat room by
sending an INVITE request. This INVITE request contains a session
description that includes the chat room extensions defined in this
document.
Alice Conference Focus
| |
|F1: (SIP) INVITE |
|----------------------->|
|F2: (SIP) 200 OK |
|<-----------------------|
|F3: (SIP) ACK |
|----------------------->|
| |
Figure 3: Flow Diagram of a User Joining a Chat Room
<span class="grey">Niemi, et al. Standards Track [Page 28]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
F1: Alice constructs an SDP description that includes an MSRP media
stream. She also indicates her support for the chat room extensions
defined in this document. She sends the INVITE request to the chat
room server.
INVITE sip:chatroom22@chat.example.com SIP/2.0
Via: SIP/2.0/TCP client.atlanta.example.com:5060;branch=z9hG4bK74bf9
Max-Forwards: 70
From: Alice <sip:alice@atlanta.example.com>;tag=9fxced76sl
To: Chatroom 22 <sip:chatroom22@chat.example.com>
Call-ID: 3848276298220188511@atlanta.example.com
CSeq: 1 INVITE
Contact: <sip:alice@client.atlanta.example.com;transport=tcp>
Content-Type: application/sdp
Content-Length: 290
v=0
o=alice 2890844526 2890844526 IN IP4 client.atlanta.example.com
s=-
c=IN IP4 client.atlanta.example.com
m=message 7654 TCP/MSRP *
a=accept-types:message/cpim text/plain text/html
a=path:msrp://client.atlanta.example.com:7654/jshA7weztas;tcp
a=chatroom:nickname private-messages
F2: The chat room server accepts the session establishment. It
includes the 'isfocus' and other relevant feature tags in the Contact
header field of the response. The chat room server also builds an
SDP answer that forces the reception of messages wrapped in Message/
CPIM wrappers. It also includes the 'chatroom' attribute with the
allowed extensions.
SIP/2.0 200 OK
Via: SIP/2.0/TCP client.atlanta.example.com:5060;branch=z9hG4bK74bf9
;received=192.0.2.101
From: Alice <sip:alice@atlanta.example.com>;tag=9fxced76sl
To: Chatroom 22 <sip:chatroom22@chat.example.com>;tag=8321234356
Call-ID: 3848276298220188511@atlanta.example.com
CSeq: 1 INVITE
Contact: <sip:chatroom22@chat.example.com;transport=tcp> \
;methods="INVITE,BYE,OPTIONS,ACK,CANCEL,SUBSCRIBE,NOTIFY" \
;automata;isfocus;message;event="conference"
Content-Type: application/sdp
Content-Length: 290
<span class="grey">Niemi, et al. Standards Track [Page 29]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
v=0
o=chat 2890844527 2890844527 IN IP4 chat.example.com
s=-
c=IN IP4 chat.example.com
m=message 12763 TCP/MSRP *
a=accept-types:message/cpim
a=accept-wrapped-types:text/plain text/html *
a=path:msrp://chat.example.com:12763/kjhd37s2s20w2a;tcp
a=chatroom:nickname private-messages
F3: The session established is acknowledged (details not shown).
<span class="h3"><a class="selflink" id="section-9.2" href="#section-9.2">9.2</a>. Setting Up a Nickname</span>
Figure 4 shows an example of Alice setting up a nickname using the
chat room as provider. Her first proposal is not accepted because
that proposed nickname is already in use. Then, she makes a second
proposal with a new nickname. This second proposal is accepted.
Alice MSRP Switch
| |
|F1: (MSRP) NICKNAME |
|----------------------->|
|F2: (MSRP) 425 |
|<-----------------------|
|F3: (MSRP) NICKNAME |
|----------------------->|
|F4: (MSRP) 200 |
|<-----------------------|
| |
Figure 4: Flow Diagram of a User Setting up Her Nickname
F1: Alice sends an MSRP NICKNAME request that contains her proposed
nicknames in the Use-Nickname header field.
MSRP d93kswow NICKNAME
To-Path: msrp://chat.example.com:12763/kjhd37s2s20w2a;tcp
From-Path: msrp://client.atlanta.example.com:7654/jshA7weztas;tcp
Use-Nickname: "Alice the great"
-------d93kswow$
F2: The MSRP switch analyzes the existing allocation of nicknames and
detects that the nickname "Alice the great" is already provided to
another participant in the chat room. The MSRP switch answers with a
425 response.
<span class="grey">Niemi, et al. Standards Track [Page 30]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-31" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
MSRP d93kswow 425 Nickname reserved or already in use
To-Path: msrp://client.atlanta.example.com:7654/jshA7weztas;tcp
From-Path: msrp://chat.example.com:12763/kjhd37s2s20w2a;tcp
-------d93kswow$
F3: Alice receives the response. She proposes a new nickname in a
second NICKNAME request.
MSRP 09swk2d NICKNAME
To-Path: msrp://chat.example.com:12763/kjhd37s2s20w2a;tcp
From-Path: msrp://client.atlanta.example.com:7654/jshA7weztas;tcp
Use-Nickname: "Alice in Wonderland"
-------09swk2d$
F4: The MSRP switch accepts the nickname proposal and answers with a
200 response.
MSRP 09swk2d 200 OK
To-Path: msrp://client.atlanta.example.com:7654/jshA7weztas;tcp
From-Path: msrp://chat.example.com:12763/kjhd37s2s20w2a;tcp
-------09swk2d$
<span class="h3"><a class="selflink" id="section-9.3" href="#section-9.3">9.3</a>. Sending a Regular Message to the Chat Room</span>
Figure 5 is a flow diagram where Alice is sending a regular message
addressed to the chat room. The MSRP switch distributes the message
to the rest of the participants.
Alice MSRP Switch Bob Charlie
| | | |
| F1: (MSRP) SEND | | |
|--------------------->| F3: (MSRP) SEND | |
| F2: (MSRP) 200 |----------------------->| |
|<---------------------| F4: (MSRP) SEND | |
| |------------------------------->|
| | F5: (MSRP) 200 OK | |
| |<-----------------------| |
| | F6: (MSRP) 200 OK | |
| |<------------------------------ |
| | | |
| | | |
Figure 5: Sending a Regular Message to the Chat Room
<span class="grey">Niemi, et al. Standards Track [Page 31]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-32" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
F1: Alice builds a text message and wraps it in a Message/CPIM
wrapper. She addresses the message to the chat room. She encloses
the resulting Message/CPIM wrapper in an MSRP SEND request and sends
it to the MSRP switch via the existing TCP connection.
MSRP 3490visdm SEND
To-Path: msrp://chat.example.com:12763/kjhd37s2s20w2a;tcp
From-Path: msrp://client.atlanta.example.com:7654/jshA7weztas;tcp
Message-ID: 99s9s2
Byte-Range: 1-*/*
Content-Type: message/cpim
To: <sip:chatroom22@chat.example.com;transport=tcp>
From: <sip:alice@atlanta.example.com>
DateTime: 2009-03-02T15:02:31-03:00
Content-Type: text/plain
Hello guys, how are you today?
-------3490visdm$
F2: The MSRP switch acknowledges the reception of the SEND request
with a 200 (OK) response.
MSRP 3490visdm 200 OK
To-Path: msrp://client.atlanta.example.com:7654/jshA7weztas;tcp
From-Path: msrp://chat.example.com:12763/kjhd37s2s20w2a;tcp
Message-ID: 99s9s2
-------3490visdm$
F3: The MSRP switch creates a new MSRP SEND request that contains the
received Message/CPIM wrapper and sends it to Bob.
MSRP 490ej23 SEND
To-Path: msrp://client.biloxi.example.com:4923/49dufdje2;tcp
From-Path: msrp://chat.example.com:5678/jofofo3;tcp
Message-ID: 304sse2
Byte-Range: 1-*/*
Content-Type: message/cpim
To: <sip:chatroom22@chat.example.com;transport=tcp>
From: <sip:alice@atlanta.example.com>
DateTime: 2009-03-02T15:02:31-03:00
Content-Type: text/plain
Hello guys, how are you today?
-------490ej23$
<span class="grey">Niemi, et al. Standards Track [Page 32]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-33" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
Since the received message is addressed to the chat room URI in the
From header of the Message/CPIM header, Bob knows that this is a
regular message distributed to all participants in the chat room
rather than a private message addressed to him.
The rest of the message flows are analogous to the previous. They
are not shown here.
<span class="h3"><a class="selflink" id="section-9.4" href="#section-9.4">9.4</a>. Sending a Private Message to a Participant</span>
Figure 6 is a flow diagram where Alice is sending a private message
addressed to Bob's SIP AOR. The MSRP switch distributes the message
only to Bob.
Alice MSRP Switch Bob
| | |
| F1: (MSRP) SEND | |
|--------------------->| F3: (MSRP) SEND |
| F2: (MSRP) 200 |----------------------->|
|<---------------------| F4: (MSRP) 200 |
| |<-----------------------|
| | |
Figure 6: Sending a Private Message to Bob
F1: Alice builds a text message and wraps it in a Message/CPIM
wrapper. She addresses the message to Bob's URI, which she learned
from a notification in the conference event package. She encloses
the resulting Message/CPIM wrapper in an MSRP SEND request and sends
it to the MSRP switch via the existing TCP connection.
MSRP 6959ssdf SEND
To-Path: msrp://chat.example.com:12763/kjhd37s2s20w2a;tcp
From-Path: msrp://client.atlanta.example.com:7654/jshA7weztas;tcp
Message-ID: okj3kw
Byte-Range: 1-*/*
Content-Type: message/cpim
To: <sip:bob@example.com>
From: <sip:alice@example.com>
DateTime: 2009-03-02T15:02:31-03:00
Content-Type: text/plain
Hello Bob.
-------6959ssdf$
F2: The MSRP switch acknowledges the reception of the SEND request
with a 200 (OK) response.
<span class="grey">Niemi, et al. Standards Track [Page 33]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-34" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
MSRP 6959ssdfm 200 OK
To-Path: msrp://client.atlanta.example.com:7654/jshA7weztas;tcp
From-Path: msrp://chat.example.com:12763/kjhd37s2s20w2a;tcp
Message-ID: okj3kw
-------6959ssdfm$
F3: The MSRP switch creates a new MSRP SEND request that contains the
received Message/CPIM wrapper and sends it only to Bob. Bob can
distinguish the sender in the From header of the Message/CPIM
wrapper. He also identifies this as a private message due to the
presence of his own SIP AOR in the To header field of the Message/
CPIM wrapper.
MSRP 9v9s2 SEND
To-Path: msrp://client.biloxi.example.com:4923/49dufdje2;tcp
From-Path: msrp://chat.example.com:5678/jofofo3;tcp
Message-ID: d9fghe982
Byte-Range: 1-*/*
Content-Type: message/cpim
To: <sip:bob@example.com>
From: <sip:alice@atlanta.example.com>
DateTime: 2009-03-02T15:02:31-03:00
Content-Type: text/plain
Hello Bob.
-------9v9s2$
F4: Bob acknowledges the reception of the SEND request with a 200
(OK) response.
MSRP 9v9s2 200 OK
To-Path: msrp://chat.example.com:5678/jofofo3;tcp
From-Path: msrp://client.biloxi.example.com:4923/49dufdje2;tcp
Message-ID: d9fghe982
-------9v9s2$
<span class="grey">Niemi, et al. Standards Track [Page 34]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-35" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
<span class="h3"><a class="selflink" id="section-9.5" href="#section-9.5">9.5</a>. Chunked Private Message</span>
The MSRP message below is a depiction of the same private message
described in <a href="#section-9.4">Section 9.4</a>, but now the message is split in two chunks.
The MSRP switch must wait for the complete set of Message/CPIM
headers before distributing the messages.
MSRP 7443ruls SEND
To-Path: msrp://chat.example.com:12763/kjhd37s2s20w2a;tcp
From-Path: msrp://client.atlanta.example.com:7654/jshA7weztas;tcp
Message-ID: aft4to
Byte-Range: 1-*/174
Content-Type: message/cpim
To: <sip:bob@example.com>
From: <sip:alice@example.com>
-------7443ruls$
MSRP 7443ruls SEND
To-Path: msrp://chat.example.com:12763/kjhd37s2s20w2a;tcp
From-Path: msrp://client.atlanta.example.com:7654/jshA7weztas;tcp
Message-ID: aft4to
Byte-Range: 68-174/174
Content-Type: message/cpim
DateTime: 2009-03-02T15:02:31-03:00
Content-Type: text/plain
Hello Bob
-------7443ruls$
<span class="h3"><a class="selflink" id="section-9.6" href="#section-9.6">9.6</a>. Nickname in a Conference Information Document</span>
Figure 7 is a depiction of an XML conference information document
received in a SIP NOTIFY request as a notification to the XCON
Conference Event Package, <a href="./rfc6502">RFC 6502</a> [<a href="./rfc6502" title=""Conference Event Package Data Format Extension for Centralized Conferencing (XCON)"">RFC6502</a>]. The conference
information document follows the XCON Data Model specified in <a href="./rfc6501">RFC</a>
<a href="./rfc6501">6501</a> [<a href="./rfc6501" title=""Conference Information Data Model for Centralized Conferencing (XCON)"">RFC6501</a>].
The conference information document of Figure 7 presents information
of two users who are participating in the conference (see each of the
<user> elements). Each participant is bound to a nickname, shown in
the 'nickname' attribute of the <user> element.
<span class="grey">Niemi, et al. Standards Track [Page 35]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-36" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
NOTE: The purpose of Figure 7 is to show the user-to-nickname
relationship. It is believed that the example is correct,
according to <a href="./rfc6501">RFC 6501</a> [<a href="./rfc6501" title=""Conference Information Data Model for Centralized Conferencing (XCON)"">RFC6501</a>]. In case of contradictions
between this specification and <a href="./rfc6501">RFC 6501</a> [<a href="./rfc6501" title=""Conference Information Data Model for Centralized Conferencing (XCON)"">RFC6501</a>], the latter has
precedence.
<?xml version="1.0" encoding="UTF-8"?>
<conference-info
xmlns="urn:ietf:params:xml:ns:conference-info"
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info"
entity="sip:chatroom22@chat.example.com"
state="full" version="1">
<!--
CONFERENCE INFO
-->
<conference-description>
<subject>MSRP nickname example</subject>
</conference-description>
<!--
CONFERENCE STATE
-->
<conference-state>
<user-count>2</user-count>
</conference-state>
<!--
USERS
-->
<users>
<user entity="sip:bob@example.com"
state="full"
xcon:nickname="Dopey Donkey">
<display-text>Bob Hoskins</display-text>
</user>
<!--
USER
-->
<user entity="sip:alice@atlanta.example.com"
state="full"
xcon:nickname="Alice the great">
<display-text>Alice Kay</display-text>
</user>
</users>
</conference-info>
Figure 7: Nickname in a Conference Information Document
<span class="grey">Niemi, et al. Standards Track [Page 36]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-37" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
<span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>. IANA Considerations</span>
<span class="h3"><a class="selflink" id="section-10.1" href="#section-10.1">10.1</a>. New MSRP Method</span>
This specification defines a new MSRP method that has been added to
the "Methods" subregistry of the "Message Session Relay Protocol
(MSRP) Parameters" registry:
NICKNAME
See <a href="#section-7">Section 7</a> for details.
<span class="h3"><a class="selflink" id="section-10.2" href="#section-10.2">10.2</a>. New MSRP Header</span>
This specification defines a new MSRP header that has been added to
the "Header Fields" subregistry of the "Message Session Relay
Protocol (MSRP) Parameters" registry:
Use-Nickname
See <a href="#section-7">Section 7</a> for details.
<span class="h3"><a class="selflink" id="section-10.3" href="#section-10.3">10.3</a>. New MSRP Status Codes</span>
This specification defines four new MSRP status codes that have been
added to the "Status Codes" subregistry of the "Message Session Relay
Protocol (MSRP) parameters" registry.
The 404 status code indicates the failure to resolve the recipient's
URI in the To header field of the Message/CPIM wrapper in the SEND
request, e.g., due to an unknown recipient. See <a href="#section-6.2">Section 6.2</a> for
details.
The 424 status code indicates a failure in allocating the requested
nickname due to a malformed syntax in the Use-Nickname header field.
See <a href="#section-7">Section 7</a> for details.
The 425 status code indicates a failure in allocating the requested
nickname because the requested nickname in the Use-Nickname header
field is reserved or is already in use by another user. See
<a href="#section-7">Section 7</a> for details.
The 428 status code indicates that the recipient of a SEND request
does not support private messages. See <a href="#section-6.2">Section 6.2</a> for details.
Table 1 summarizes the IANA registration data with respect to new
MSRP status codes:
<span class="grey">Niemi, et al. Standards Track [Page 37]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-38" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
+-------+-------------------------------------+-----------+
| Value | Description | Reference |
+-------+-------------------------------------+-----------+
| 404 | Failure to resolve recipient's URI | <a href="./rfc7701">RFC 7701</a> |
| 424 | Malformed nickname | <a href="./rfc7701">RFC 7701</a> |
| 425 | Nickname reserved or already in use | <a href="./rfc7701">RFC 7701</a> |
| 428 | Private messages not supported | <a href="./rfc7701">RFC 7701</a> |
+-------+-------------------------------------+-----------+
Table 1: New Status Codes
<span class="h3"><a class="selflink" id="section-10.4" href="#section-10.4">10.4</a>. New SDP Attribute</span>
This specification defines a new media-level attribute in the
"Session Description Protocol (SDP) Parameters" registry. The
registration data is as follows:
Contact: Miguel Garcia <miguel.a.garcia@ericsson.com>
Phone: +34 91 339 1000
Attribute name: chatroom
Long-form attribute name: Chat Room
Type of attribute: media level only
This attribute is not subject to the charset attribute
Description: This attribute identifies support and local policy
allowance for a number of chat room related functions
Specification: <a href="./rfc7701">RFC 7701</a> (this document)
See <a href="#section-8">Section 8</a> for details.
<span class="h2"><a class="selflink" id="section-11" href="#section-11">11</a>. Security Considerations</span>
This document proposes extensions to the Message Session Relay
Protocol [<a href="./rfc4975" title=""The Message Session Relay Protocol (MSRP)"">RFC4975</a>]. Therefore, the security considerations of that
document apply to this document as well.
A chat room is, by its nature, a potential Denial-of-Service (DoS)
accelerator as it takes a message from one entity and sends it to
many. Implementers of both UAs and switches need to carefully
consider the set of anti-DoS measures that are appropriate for this
application, and switch implementations, in particular, ought to
<span class="grey">Niemi, et al. Standards Track [Page 38]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-39" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
include appropriate anti-DoS features. The details of what is
appropriate will vary over time and will also depend on the specific
needs of the implementation; thus, they cannot be specified here.
If the participant's SIP UA does not understand the "isfocus" feature
tag [<a href="./rfc3840" title=""Indicating User Agent Capabilities in the Session Initiation Protocol (SIP)"">RFC3840</a>], it will not know that it is connected to a conference
instance. The participant might not be notified that its MSRP client
will try to send messages having potential multiple recipients to the
MSRP switch. If the participant's MSRP client does not support the
extensions of this specification, it is unlikely that it will try to
send a message using the Message/CPIM wrapper content type [<a href="./rfc3862" title=""Common Presence and Instant Messaging (CPIM): Message Format"">RFC3862</a>],
and the MSRP switch will reject the request with a 415 response
[<a href="./rfc4975" title=""The Message Session Relay Protocol (MSRP)"">RFC4975</a>]. Still, if a participant's MSRP client does create a
message with a valid Message/CPIM wrapper content type [<a href="./rfc3862" title=""Common Presence and Instant Messaging (CPIM): Message Format"">RFC3862</a>]
having the To header set to the URI of the chat room and the From
header set to the URI of which the participant that is known to the
chat room, the participant might be unaware that the message can be
forwarded to multiple recipients. Equally, if the To header is set
to a valid URI of a recipient known to the chat room, the message can
be forwarded as a private message without the participant knowing.
To mitigate these problems, when the chat room detects that a UA does
not support the procedures of this document (i.e., when the SIP UA is
not chat room aware), the MSRP switch SHOULD send a regular MSRP
message indicating that the SIP UA is actually part of a chat room
and that all the messages that the user sends correctly formatted
will be distributed to a number of participants. Additionally, the
MSRP switch SHOULD also send a regular MSRP text message including
the list of participants in the chat room so that the user becomes
aware of the roster.
If a participant wants to avoid security concerns on the path between
himself and the MSRP switch (e.g., eavesdropping, faked packet
injection, or packet corruption), the participant's UA can force the
usage of MSRP over a TLS [<a href="./rfc5246" title=""The Transport Layer Security (TLS) Protocol Version 1.2"">RFC5246</a>] transport connection. This is
negotiated in the SDP offer/answer exchange as per the regular
procedures of <a href="./rfc4975">RFC 4975</a> [<a href="./rfc4975" title=""The Message Session Relay Protocol (MSRP)"">RFC4975</a>]. This negotiation will result in
both endpoints establishing a TLS [<a href="./rfc5246" title=""The Transport Layer Security (TLS) Protocol Version 1.2"">RFC5246</a>] transport connection that
is used to exchange MSRP messages. The MSRP switch may also have
local policy that forces the usage of TLS transport for all MSRP
sessions, something that is also negotiated in SDP as per the regular
procedures of <a href="./rfc4975">RFC 4975</a> [<a href="./rfc4975" title=""The Message Session Relay Protocol (MSRP)"">RFC4975</a>].
Nicknames are used to show the appearance of the participants of the
chat room. A successful takeover of a nickname from a participant
might lead to private messages being sent to the wrong destination.
The recipient's URI will be different from the URI associated with
the original owner of the nickname, but the sender might not notice
<span class="grey">Niemi, et al. Standards Track [Page 39]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-40" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
this. To avoid takeovers, the MSRP switch MUST make sure that a
nickname is unique inside a chat room. Also, the security
consideration for any authenticated identity mechanisms used to
validate the SIP AOR will apply to this document as well. The chat
room has a policy that determines the time that a nickname is still
reserved for its holder, once it is no longer being used. This
allows, e.g., a user that accidentally loses its connectivity, to
reconnect to the chat room and keep on using the same nickname. It
depends on the policy of the chat room if a nickname that has been
previously used by another participant of the chat room can be
reserved or not.
<a href="#section-7.1">Section 7.1</a> discusses the problem of similar but different nicknames
(e.g., thanks to the use of similar characters), and chat rooms MAY
provide a mechanism to mitigate confusable nicknames.
Recipients of IMs should be cautious with the rendering of content,
which can be malicious in nature. This includes, but is not limited
to, the reception of HTML and JavaScript scripts, executable code,
phishing attempts, etc. Endpoints SHOULD always request permission
from the user before executing one of these actions.
It must be noted that endpoints using a TLS client side certificate
with real names in the certificates will not be anonymous to the MSRP
switch to which they connect. While the name in the certificate
might not be used by MSRP, the server will have a certificate with
the actual name in it.
<span class="h2"><a class="selflink" id="section-12" href="#section-12">12</a>. References</span>
<span class="h3"><a class="selflink" id="section-12.1" href="#section-12.1">12.1</a>. Normative References</span>
[<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>,
DOI 10.17487/RFC2119, March 1997,
<<a href="http://www.rfc-editor.org/info/rfc2119">http://www.rfc-editor.org/info/rfc2119</a>>.
[<a id="ref-RFC3261">RFC3261</a>] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston,
A., Peterson, J., Sparks, R., Handley, M., and E.
Schooler, "SIP: Session Initiation Protocol", <a href="./rfc3261">RFC 3261</a>,
DOI 10.17487/RFC3261, June 2002,
<<a href="http://www.rfc-editor.org/info/rfc3261">http://www.rfc-editor.org/info/rfc3261</a>>.
[<a id="ref-RFC3264">RFC3264</a>] Rosenberg, J. and H. Schulzrinne, "An Offer/Answer Model
with Session Description Protocol (SDP)", <a href="./rfc3264">RFC 3264</a>,
DOI 10.17487/RFC3264, June 2002,
<<a href="http://www.rfc-editor.org/info/rfc3264">http://www.rfc-editor.org/info/rfc3264</a>>.
<span class="grey">Niemi, et al. Standards Track [Page 40]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-41" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
[<a id="ref-RFC3323">RFC3323</a>] Peterson, J., "A Privacy Mechanism for the Session
Initiation Protocol (SIP)", <a href="./rfc3323">RFC 3323</a>,
DOI 10.17487/RFC3323, November 2002,
<<a href="http://www.rfc-editor.org/info/rfc3323">http://www.rfc-editor.org/info/rfc3323</a>>.
[<a id="ref-RFC3629">RFC3629</a>] Yergeau, F., "UTF-8, a transformation format of ISO
10646", STD 63, <a href="./rfc3629">RFC 3629</a>, DOI 10.17487/RFC3629, November
2003, <<a href="http://www.rfc-editor.org/info/rfc3629">http://www.rfc-editor.org/info/rfc3629</a>>.
[<a id="ref-RFC3840">RFC3840</a>] Rosenberg, J., Schulzrinne, H., and P. Kyzivat,
"Indicating User Agent Capabilities in the Session
Initiation Protocol (SIP)", <a href="./rfc3840">RFC 3840</a>,
DOI 10.17487/RFC3840, August 2004,
<<a href="http://www.rfc-editor.org/info/rfc3840">http://www.rfc-editor.org/info/rfc3840</a>>.
[<a id="ref-RFC3860">RFC3860</a>] Peterson, J., "Common Profile for Instant Messaging
(CPIM)", <a href="./rfc3860">RFC 3860</a>, DOI 10.17487/RFC3860, August 2004,
<<a href="http://www.rfc-editor.org/info/rfc3860">http://www.rfc-editor.org/info/rfc3860</a>>.
[<a id="ref-RFC3862">RFC3862</a>] Klyne, G. and D. Atkins, "Common Presence and Instant
Messaging (CPIM): Message Format", <a href="./rfc3862">RFC 3862</a>,
DOI 10.17487/RFC3862, August 2004,
<<a href="http://www.rfc-editor.org/info/rfc3862">http://www.rfc-editor.org/info/rfc3862</a>>.
[<a id="ref-RFC4353">RFC4353</a>] Rosenberg, J., "A Framework for Conferencing with the
Session Initiation Protocol (SIP)", <a href="./rfc4353">RFC 4353</a>,
DOI 10.17487/RFC4353, February 2006,
<<a href="http://www.rfc-editor.org/info/rfc4353">http://www.rfc-editor.org/info/rfc4353</a>>.
[<a id="ref-RFC4566">RFC4566</a>] Handley, M., Jacobson, V., and C. Perkins, "SDP: Session
Description Protocol", <a href="./rfc4566">RFC 4566</a>, DOI 10.17487/RFC4566,
July 2006, <<a href="http://www.rfc-editor.org/info/rfc4566">http://www.rfc-editor.org/info/rfc4566</a>>.
[<a id="ref-RFC4575">RFC4575</a>] Rosenberg, J., Schulzrinne, H., and O. Levin, Ed., "A
Session Initiation Protocol (SIP) Event Package for
Conference State", <a href="./rfc4575">RFC 4575</a>, DOI 10.17487/RFC4575, August
2006, <<a href="http://www.rfc-editor.org/info/rfc4575">http://www.rfc-editor.org/info/rfc4575</a>>.
[<a id="ref-RFC4975">RFC4975</a>] Campbell, B., Ed., Mahy, R., Ed., and C. Jennings, Ed.,
"The Message Session Relay Protocol (MSRP)", <a href="./rfc4975">RFC 4975</a>,
DOI 10.17487/RFC4975, September 2007,
<<a href="http://www.rfc-editor.org/info/rfc4975">http://www.rfc-editor.org/info/rfc4975</a>>.
[<a id="ref-RFC4976">RFC4976</a>] Jennings, C., Mahy, R., and A. Roach, "Relay Extensions
for the Message Sessions Relay Protocol (MSRP)", <a href="./rfc4976">RFC 4976</a>,
DOI 10.17487/RFC4976, September 2007,
<<a href="http://www.rfc-editor.org/info/rfc4976">http://www.rfc-editor.org/info/rfc4976</a>>.
<span class="grey">Niemi, et al. Standards Track [Page 41]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-42" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
[<a id="ref-RFC5234">RFC5234</a>] Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax
Specifications: ABNF", STD 68, <a href="./rfc5234">RFC 5234</a>,
DOI 10.17487/RFC5234, January 2008,
<<a href="http://www.rfc-editor.org/info/rfc5234">http://www.rfc-editor.org/info/rfc5234</a>>.
[<a id="ref-RFC5239">RFC5239</a>] Barnes, M., Boulton, C., and O. Levin, "A Framework for
Centralized Conferencing", <a href="./rfc5239">RFC 5239</a>, DOI 10.17487/RFC5239,
June 2008, <<a href="http://www.rfc-editor.org/info/rfc5239">http://www.rfc-editor.org/info/rfc5239</a>>.
[<a id="ref-RFC5246">RFC5246</a>] Dierks, T. and E. Rescorla, "The Transport Layer Security
(TLS) Protocol Version 1.2", <a href="./rfc5246">RFC 5246</a>,
DOI 10.17487/RFC5246, August 2008,
<<a href="http://www.rfc-editor.org/info/rfc5246">http://www.rfc-editor.org/info/rfc5246</a>>.
[<a id="ref-RFC5681">RFC5681</a>] Allman, M., Paxson, V., and E. Blanton, "TCP Congestion
Control", <a href="./rfc5681">RFC 5681</a>, DOI 10.17487/RFC5681, September 2009,
<<a href="http://www.rfc-editor.org/info/rfc5681">http://www.rfc-editor.org/info/rfc5681</a>>.
[<a id="ref-RFC6501">RFC6501</a>] Novo, O., Camarillo, G., Morgan, D., and J. Urpalainen,
"Conference Information Data Model for Centralized
Conferencing (XCON)", <a href="./rfc6501">RFC 6501</a>, DOI 10.17487/RFC6501,
March 2012, <<a href="http://www.rfc-editor.org/info/rfc6501">http://www.rfc-editor.org/info/rfc6501</a>>.
[<a id="ref-RFC6502">RFC6502</a>] Camarillo, G., Srinivasan, S., Even, R., and J.
Urpalainen, "Conference Event Package Data Format
Extension for Centralized Conferencing (XCON)", <a href="./rfc6502">RFC 6502</a>,
DOI 10.17487/RFC6502, March 2012,
<<a href="http://www.rfc-editor.org/info/rfc6502">http://www.rfc-editor.org/info/rfc6502</a>>.
[<a id="ref-RFC7700">RFC7700</a>] Saint-Andre, P., "Preparation, Enforcement, and Comparison
of Internationalized Strings Representing Nicknames",
<a href="./rfc7700">RFC 7700</a>, DOI 10.17487/RFC7700, December 2015,
<<a href="http://www.rfc-editor.org/info/rfc7700">http://www.rfc-editor.org/info/rfc7700</a>>.
<span class="grey">Niemi, et al. Standards Track [Page 42]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-43" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
<span class="h3"><a class="selflink" id="section-12.2" href="#section-12.2">12.2</a>. Informative References</span>
[<a id="ref-RFC2810">RFC2810</a>] Kalt, C., "Internet Relay Chat: Architecture", <a href="./rfc2810">RFC 2810</a>,
DOI 10.17487/RFC2810, April 2000,
<<a href="http://www.rfc-editor.org/info/rfc2810">http://www.rfc-editor.org/info/rfc2810</a>>.
[<a id="ref-RFC3325">RFC3325</a>] Jennings, C., Peterson, J., and M. Watson, "Private
Extensions to the Session Initiation Protocol (SIP) for
Asserted Identity within Trusted Networks", <a href="./rfc3325">RFC 3325</a>,
DOI 10.17487/RFC3325, November 2002,
<<a href="http://www.rfc-editor.org/info/rfc3325">http://www.rfc-editor.org/info/rfc3325</a>>.
[<a id="ref-RFC3966">RFC3966</a>] Schulzrinne, H., "The tel URI for Telephone Numbers",
<a href="./rfc3966">RFC 3966</a>, DOI 10.17487/RFC3966, December 2004,
<<a href="http://www.rfc-editor.org/info/rfc3966">http://www.rfc-editor.org/info/rfc3966</a>>.
[<a id="ref-RFC4474">RFC4474</a>] Peterson, J. and C. Jennings, "Enhancements for
Authenticated Identity Management in the Session
Initiation Protocol (SIP)", <a href="./rfc4474">RFC 4474</a>,
DOI 10.17487/RFC4474, August 2006,
<<a href="http://www.rfc-editor.org/info/rfc4474">http://www.rfc-editor.org/info/rfc4474</a>>.
[<a id="ref-RFC6120">RFC6120</a>] Saint-Andre, P., "Extensible Messaging and Presence
Protocol (XMPP): Core", <a href="./rfc6120">RFC 6120</a>, DOI 10.17487/RFC6120,
March 2011, <<a href="http://www.rfc-editor.org/info/rfc6120">http://www.rfc-editor.org/info/rfc6120</a>>.
Acknowledgments
The authors want to thank Eva Leppanen, Adamu Haruna, Adam Roach,
Matt Lepinski, Mary Barnes, Ben Campbell, Paul Kyzivat, Adrian
Georgescu, Nancy Greene, Cullen Jennings, Flemming Andreasen, Suresh
Krishnan, Christer Holmberg, Saul Ibarra, Enrico Marocco, Alexey
Melnikov, Peter Saint-Andre, Stephen Farrell, and Martin Stiemerling
for providing comments.
Contributors
This work would have never been possible without the fruitful
discussions on the SIMPLE WG mailing list, especially with Brian
Rosen (Neustar) and Paul Kyzivat (Huawei), who provided extensive
review and improvements throughout the document.
<span class="grey">Niemi, et al. Standards Track [Page 43]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-44" ></span>
<span class="grey"><a href="./rfc7701">RFC 7701</a> Multi-party Chat MSRP December 2015</span>
Authors' Addresses
Aki Niemi
Email: aki.niemi@iki.fi
Miguel A. Garcia-Martin
Ericsson
Calle Via de los Poblados 13
Madrid, ES 28033
Spain
Email: miguel.a.garcia@ericsson.com
Geir A. Sandbakken
Cisco Systems
Philip Pedersensvei 1
1366 Lysaker
Norway
Email: geirsand@cisco.com
Niemi, et al. Standards Track [Page 44]
</pre>
|