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
|
<pre>Internet Engineering Task Force (IETF) C. Holmberg
Request for Comments: 8599 Ericsson
Category: Standards Track M. Arnold
ISSN: 2070-1721 Metaswitch Networks
May 2019
<span class="h1">Push Notification with the Session Initiation Protocol (SIP)</span>
Abstract
This document describes how a Push Notification Service (PNS) can be
used to wake a suspended Session Initiation Protocol (SIP) User Agent
(UA) with push notifications, and it also describes how the UA can
send binding-refresh REGISTER requests and receive incoming SIP
requests in an environment in which the UA may be suspended. The
document defines new SIP URI parameters to exchange PNS information
between the UA and the SIP entity that will then request that push
notifications be sent to the UA. It also defines the parameters to
trigger such push notification requests. The document also defines
new feature-capability indicators that can be used to indicate
support of this mechanism.
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="./rfc7841#section-2">Section 2 of RFC 7841</a>.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
<a href="https://www.rfc-editor.org/info/rfc8599">https://www.rfc-editor.org/info/rfc8599</a>.
<span class="grey">Holmberg & Arnold Standards Track [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
Copyright Notice
Copyright (c) 2019 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="https://trustee.ietf.org/license-info">https://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.
Table of Contents
<a href="#section-1">1</a>. Introduction . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-4">4</a>
<a href="#section-2">2</a>. Conventions . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-8">8</a>
<a href="#section-3">3</a>. Push Resource ID (PRID) . . . . . . . . . . . . . . . . . . . <a href="#page-8">8</a>
<a href="#section-4">4</a>. SIP User Agent (UA) Behavior . . . . . . . . . . . . . . . . <a href="#page-9">9</a>
<a href="#section-4.1">4.1</a>. REGISTER . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-9">9</a>
<a href="#section-4.1.1">4.1.1</a>. Request Push Notifications . . . . . . . . . . . . . <a href="#page-9">9</a>
<a href="#section-4.1.2">4.1.2</a>. Disable Push Notifications . . . . . . . . . . . . . <a href="#page-11">11</a>
<a href="#section-4.1.3">4.1.3</a>. Receive Push Notifications . . . . . . . . . . . . . <a href="#page-11">11</a>
4.1.4. Sending Binding-Refresh Requests Using Non-push
Mechanism . . . . . . . . . . . . . . . . . . . . . . <a href="#page-11">11</a>
<a href="#section-4.1.5">4.1.5</a>. Query Network PNS Capabilities . . . . . . . . . . . <a href="#page-13">13</a>
<a href="#section-5">5</a>. SIP Proxy Behavior . . . . . . . . . . . . . . . . . . . . . <a href="#page-14">14</a>
<a href="#section-5.1">5.1</a>. PNS Provider . . . . . . . . . . . . . . . . . . . . . . <a href="#page-14">14</a>
<a href="#section-5.2">5.2</a>. SIP Request Push Bucket . . . . . . . . . . . . . . . . . <a href="#page-15">15</a>
<a href="#section-5.3">5.3</a>. SIP URI Comparison Rules . . . . . . . . . . . . . . . . <a href="#page-15">15</a>
<a href="#section-5.4">5.4</a>. Indicate Support of Type of PNS . . . . . . . . . . . . . <a href="#page-15">15</a>
<a href="#section-5.5">5.5</a>. Trigger Periodic Binding Refresh . . . . . . . . . . . . <a href="#page-16">16</a>
<a href="#section-5.6">5.6</a>. SIP Requests . . . . . . . . . . . . . . . . . . . . . . <a href="#page-17">17</a>
<a href="#section-5.6.1">5.6.1</a>. REGISTER . . . . . . . . . . . . . . . . . . . . . . <a href="#page-17">17</a>
<a href="#section-5.6.2">5.6.2</a>. Initial Request for Dialog or Standalone Request . . <a href="#page-20">20</a>
<a href="#section-6">6</a>. Support of Long-Lived SIP Dialogs . . . . . . . . . . . . . . <a href="#page-23">23</a>
<a href="#section-6.1">6.1</a>. SIP UA Behavior . . . . . . . . . . . . . . . . . . . . . <a href="#page-25">25</a>
<a href="#section-6.1.1">6.1.1</a>. Initial Request for Dialog . . . . . . . . . . . . . <a href="#page-25">25</a>
<a href="#section-6.2">6.2</a>. SIP Proxy Behavior . . . . . . . . . . . . . . . . . . . <a href="#page-25">25</a>
<a href="#section-6.2.1">6.2.1</a>. REGISTER . . . . . . . . . . . . . . . . . . . . . . <a href="#page-25">25</a>
<a href="#section-6.2.2">6.2.2</a>. Initial Request for Dialog . . . . . . . . . . . . . <a href="#page-26">26</a>
<a href="#section-6.2.3">6.2.3</a>. Mid-dialog Request . . . . . . . . . . . . . . . . . <a href="#page-26">26</a>
<a href="#section-7">7</a>. Support of SIP Replaces . . . . . . . . . . . . . . . . . . . <a href="#page-27">27</a>
<a href="#section-8">8</a>. Grammar . . . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-28">28</a>
8.1. 555 (Push Notification Service Not Supported) Response
Code . . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-28">28</a>
<span class="grey">Holmberg & Arnold Standards Track [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
<a href="#section-8.2">8.2</a>. 'sip.pns' Feature-Capability Indicator . . . . . . . . . <a href="#page-28">28</a>
<a href="#section-8.3">8.3</a>. 'sip.vapid' Feature-Capability Indicator . . . . . . . . <a href="#page-28">28</a>
<a href="#section-8.4">8.4</a>. 'sip.pnsreg' Feature-Capability Indicator . . . . . . . . <a href="#page-28">28</a>
<a href="#section-8.5">8.5</a>. 'sip.pnsreg' Media Feature Tag . . . . . . . . . . . . . <a href="#page-29">29</a>
<a href="#section-8.6">8.6</a>. 'sip.pnspurr' Feature-Capability Indicator . . . . . . . <a href="#page-29">29</a>
<a href="#section-8.7">8.7</a>. SIP URI Parameters . . . . . . . . . . . . . . . . . . . <a href="#page-29">29</a>
<a href="#section-9">9</a>. PNS Registration Requirements . . . . . . . . . . . . . . . . <a href="#page-30">30</a>
10. 'pn-provider', 'pn-param', and 'pn-prid' URI Parameters for
Apple Push Notification service . . . . . . . . . . . . . . . <a href="#page-30">30</a>
11. 'pn-provider', 'pn-param', and 'pn-prid' URI Parameters for
Google Firebase Cloud Messaging (FCM) Push Notification
Service . . . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-31">31</a>
12. 'pn-provider', 'pn-param', and 'pn-prid' URI Parameters for
<a href="./rfc8030">RFC 8030</a> (Generic Event Delivery Using HTTP Push) . . . . . . <a href="#page-31">31</a>
<a href="#section-13">13</a>. Security Considerations . . . . . . . . . . . . . . . . . . . <a href="#page-32">32</a>
<a href="#section-14">14</a>. IANA Considerations . . . . . . . . . . . . . . . . . . . . . <a href="#page-33">33</a>
<a href="#section-14.1">14.1</a>. SIP URI Parameters . . . . . . . . . . . . . . . . . . . <a href="#page-33">33</a>
<a href="#section-14.1.1">14.1.1</a>. pn-provider . . . . . . . . . . . . . . . . . . . . <a href="#page-33">33</a>
<a href="#section-14.1.2">14.1.2</a>. pn-param . . . . . . . . . . . . . . . . . . . . . . <a href="#page-33">33</a>
<a href="#section-14.1.3">14.1.3</a>. pn-prid . . . . . . . . . . . . . . . . . . . . . . <a href="#page-33">33</a>
<a href="#section-14.1.4">14.1.4</a>. pn-purr . . . . . . . . . . . . . . . . . . . . . . <a href="#page-33">33</a>
<a href="#section-14.2">14.2</a>. SIP Response Codes . . . . . . . . . . . . . . . . . . . <a href="#page-34">34</a>
<a href="#section-14.2.1">14.2.1</a>. 555 (Push Notification Service Not Supported) . . . <a href="#page-34">34</a>
<a href="#section-14.3">14.3</a>. SIP Global Feature-Capability Indicator . . . . . . . . <a href="#page-34">34</a>
<a href="#section-14.3.1">14.3.1</a>. sip.pns . . . . . . . . . . . . . . . . . . . . . . <a href="#page-34">34</a>
<a href="#section-14.3.2">14.3.2</a>. sip.vapid . . . . . . . . . . . . . . . . . . . . . <a href="#page-34">34</a>
<a href="#section-14.3.3">14.3.3</a>. sip.pnsreg . . . . . . . . . . . . . . . . . . . . . <a href="#page-35">35</a>
<a href="#section-14.3.4">14.3.4</a>. sip.pnspurr . . . . . . . . . . . . . . . . . . . . <a href="#page-35">35</a>
<a href="#section-14.4">14.4</a>. SIP Media Feature Tag . . . . . . . . . . . . . . . . . <a href="#page-36">36</a>
<a href="#section-14.4.1">14.4.1</a>. sip.pnsreg . . . . . . . . . . . . . . . . . . . . . <a href="#page-36">36</a>
<a href="#section-14.5">14.5</a>. PNS Subregistry Establishment . . . . . . . . . . . . . <a href="#page-36">36</a>
<a href="#section-15">15</a>. References . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-37">37</a>
<a href="#section-15.1">15.1</a>. Normative References . . . . . . . . . . . . . . . . . . <a href="#page-37">37</a>
<a href="#section-15.2">15.2</a>. Informative References . . . . . . . . . . . . . . . . . <a href="#page-39">39</a>
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-40">40</a>
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-40">40</a>
<span class="grey">Holmberg & Arnold Standards Track [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
In order to save resources such as battery life, some devices
(especially mobile devices) and operating systems will suspend an
application that is not in use. A suspended application might not be
able to wake itself with internal timers and might not be awakened by
incoming network traffic. In such an environment, a Push
Notification Service (PNS) is used to wake the application. A PNS is
a service that sends messages requested by other applications to a
user application in order to wake the user application. These
messages are called push notifications. Push notifications might
contain payload data, depending on the application. An application
can request that a push notification be sent to a single user
application or to multiple user applications.
Typically, each operating system uses a dedicated PNS. Different
PNSs exist today. Some are based on the standardized mechanism
defined in [<a href="./rfc8030" title=""Generic Event Delivery Using HTTP Push"">RFC8030</a>], while others are proprietary. For example,
Apple iOS devices use the Apple Push Notification service (APNs)
while Android devices use the Firebase Cloud Messaging (FCM) service.
Each PNS uses PNS-specific terminology and function names. The
terminology in this document is meant to be PNS-independent. If the
PNS is based on [<a href="./rfc8030" title=""Generic Event Delivery Using HTTP Push"">RFC8030</a>], the SIP proxy takes the role of the
application server.
When a Session Initiation Protocol (SIP) User Agent (UA)[<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>] is
suspended in such an environment, it is unable to send binding-
refresh SIP REGISTER requests, unable to receive incoming SIP
requests, and might not be able to use internal timers to wake
itself. A suspended UA will not be able to maintain connections,
e.g., using the SIP Outbound Mechanism [<a href="./rfc5626" title=""Managing Client-Initiated Connections in the Session Initiation Protocol (SIP)"">RFC5626</a>], because it cannot
send periodic keep-alive messages. A PNS is needed to wake the SIP
UA so that the UA can perform these functions.
This document describes how a PNS can be used to wake a suspended UA
using push notifications, so that the UA can send binding-refresh
REGISTER requests and receive incoming SIP requests. The document
defines new SIP URI parameters and new feature-capability indicators
[<a href="./rfc6809" title=""Mechanism to Indicate Support of Features and Capabilities in the Session Initiation Protocol (SIP)"">RFC6809</a>] that can be used in SIP messages to indicate support of the
mechanism defined in this document; be used to exchange PNS
information between the UA and the SIP entity (realized as a SIP
proxy in this document) that will request that push notifications are
sent to the UA; and be used to request such push notification
requests.
<span class="grey">Holmberg & Arnold Standards Track [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
NOTE: Even if a UA is able to be awakened by means other than
receiving push notifications (e.g., by using internal timers) in
order to send periodic binding-refresh REGISTER requests, it might
still be useful to suspend the UA between the sending of binding-
refresh requests (as it will save battery life) and use push
notifications to wake the UA when an incoming SIP request UA arrives.
When a UA registers with a PNS (Figure 1), it will receive a unique
Push Resource ID (PRID) associated with the push notification
registration. The UA will use a REGISTER request to provide the PRID
to the SIP proxy, which will then request that push notifications are
sent to the UA.
When the SIP proxy receives a SIP request for a new dialog or a
standalone SIP request addressed towards a UA, or when the SIP proxy
determines that the UA needs to send a binding-refresh REGISTER
request, the SIP proxy will send a push request containing the PRID
of the UA to the PNS, which will then send a push notification to the
UA. Once the UA receives the push notification, it will be able to
send a binding-refresh REGISTER request. The proxy receives the
REGISTER request from the UA and forwards it to the SIP registrar
[<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>]. After accepting the REGISTER request, the SIP registrar
sends a 2xx response to the proxy, which forwards the response to the
UA. If the push notification request was triggered by a SIP request
addressed towards the UA, the proxy can then forward the SIP request
to the UA using normal SIP routing procedures. In some cases, the
proxy can forward the SIP request without waiting for the SIP 2xx
response to the REGISTER request from the SIP registrar. Note that
this mechanism necessarily adds delay to responding to requests
requiring push notification. The consequences of that delay are
discussed in <a href="#section-5.6.2">Section 5.6.2</a>.
If there are Network Address Translators (NATs) between the UA and
the proxy, the REGISTER request sent by the UA will create NAT
bindings that will allow the incoming SIP request that triggered the
push notification to reach the UA.
NOTE: The lifetime of any NAT binding created by the REGISTER request
only needs to be long enough for the SIP request that triggered the
push notification to reach the UA.
Figure 1 shows the generic push notification architecture supported
by the mechanism in this document.
The SIP proxy MUST be in the signaling path of REGISTER requests sent
by the UA towards the registrar, and of SIP requests (for a new
dialog or a standalone) forwarded by the proxy responsible for the
UA's domain (sometimes referred to as home proxy, Serving Call
<span class="grey">Holmberg & Arnold Standards Track [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
Session Control Function (S-CSCF), etc.) towards the UA. The proxy
can also be co-located with the proxy responsible for the UA's
domain. This will also ensure that the Request-URI of SIP requests
(for a new dialog or a standalone) can be matched against contacts in
REGISTER requests.
<span class="grey">Holmberg & Arnold Standards Track [Page 6]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
+--------+ +---------+ +-----------+ +-------------+
| | | | | | | SIP |
| SIP UA | | Push | | SIP Proxy | | Registrar / |
| | | Service | | | | Home Proxy |
+--------+ +---------+ +-----------+ +-------------+
| | | |
| Subscribe | | |
|---------------->| | |
| | | |
| PRID | | |
|<----------------| | |
| | | |
| SIP REGISTER (PRID) | |
|===================================>| |
| | |SIP REGISTER (PRID)|
| | |==================>|
| | | |
| | | SIP 200 OK |
| | |<==================|
| SIP 200 OK | | |
|<===================================| |
| | | |
| | | SIP INVITE (PRID) |
| | |<==================|
| | | |
| |Push Request (PRID) |
| |<-----------------| |
|Push Message (PRID) | |
|<----------------| | |
| | | |
| SIP REGISTER (PRID) | |
|===================================>| |
| | |SIP REGISTER (PRID)|
| | |==================>|
| | | |
| | | SIP 200 OK |
| | |<==================|
| SIP 200 OK | | |
|<===================================| |
| | | |
| SIP INVITE | | |
|<===================================| |
| | | |
------- Push Notification API
======= SIP
Figure 1: SIP Push Information Flow
<span class="grey">Holmberg & Arnold Standards Track [Page 7]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
Example of a SIP REGISTER request in the flow above:
REGISTER sip:alice@example.com SIP/2.0
Via: SIP/2.0/TCP alicemobile.example.com:5060;branch=z9hG4bKnashds7
Max-Forwards: 70
To: Alice <sip:alice@example.com>
From: Alice <sip:alice@example.com>;tag=456248
Call-ID: 843817637684230@998sdasdh09
CSeq: 1826 REGISTER
Contact: <sip:alice@alicemobile.example.com;
pn-provider=acme;
pn-param=acme-param;
pn-prid=ZTY4ZDJlMzODE1NmUgKi0K>
Expires: 7200
Content-Length: 0
Figure 2: SIP REGISTER Example
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Conventions</span>
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "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>] [<a href="./rfc8174" title=""Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words"">RFC8174</a>] when, and only when, they appear in all
capitals, as shown here.
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Push Resource ID (PRID)</span>
When a SIP UA registers with a PNS it receives a unique Push Resource
ID (PRID), which is a value associated with the registration that can
be used to generate push notifications.
The format of the PRID varies depending on the PNS.
The details regarding discovery of the PNS, and the procedures
regarding the push notification registration and maintenance, are
outside the scope of this document. The information needed to
contact the PNS is typically preconfigured in the operating system of
the device.
<span class="grey">Holmberg & Arnold Standards Track [Page 8]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. SIP User Agent (UA) Behavior</span>
<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>. REGISTER</span>
This section describes how a SIP UA sends SIP REGISTER requests
(either an initial REGISTER request for a binding or a binding-
refresh REGISTER request) in order to request and disable push
notifications from a SIP network, and to query the types of PNSs
supported by the SIP network.
Unless specified otherwise, the normal SIP UA registration procedures
[<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>] apply. The additional procedures described in this section
apply when the REGISTER request contains a 'pn-provider' SIP URI
parameter in the Contact header field URI (Figure 2).
The procedures in this section apply to individual bindings
[<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>]. If a UA creates multiple bindings (e.g., one for IPv4 and
one for IPv6), the UA needs to perform the procedures for each
binding.
NOTE: Since a push notification will trigger the UA to refresh all
bindings, if a SIP UA has created multiple bindings, it is preferable
if one can ensure that all bindings expire at the same time to help
prevent some bindings from being refreshed earlier than needed.
For privacy and security reasons, a UA MUST NOT insert the SIP URI
parameters (except for the 'pn-purr' parameter) defined in this
specification in non-REGISTER requests in order to prevent the PNS
information associated with the UA from reaching the remote peer.
For example, the UA MUST NOT insert the 'pn-prid' SIP URI parameter
in the Contact header field URI of an INVITE request. REGISTER
requests will not reach the remote peer, as they will be terminated
by the registrar of the UA. However, the registrar MUST still ensure
that the parameters are not sent to other users, e.g., using the
mechanism defined by the SIP event package for registrations
[<a href="./rfc3680" title=""A Session Initiation Protocol (SIP) Event Package for Registrations"">RFC3680</a>]. See <a href="#section-13">Section 13</a> for more information.
<span class="h4"><a class="selflink" id="section-4.1.1" href="#section-4.1.1">4.1.1</a>. Request Push Notifications</span>
This section describes the procedures that a SIP UA follows to
request push notifications from the SIP network. The procedures
assume that the UA has retrieved a PRID from a PNS. The procedures
for retrieving the PRID from the PNS are PNS-specific and outside the
scope of this specification. See PNS-specific documentation for more
details.
<span class="grey">Holmberg & Arnold Standards Track [Page 9]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
This specification does not define a mechanism to explicitly request
push notifications from the SIP network for usages other than
triggering binding-refresh REGISTER requests (e.g., for sending
periodic subscription-refresh SUBSCRIBE requests [<a href="./rfc6665" title=""SIP-Specific Event Notification"">RFC6665</a>]), nor does
it describe how to distinguish push notifications associated with
such usages from the push notifications used to trigger binding-
refresh REGISTER requests. If a SIP UA wants to use push
notifications for other usages, the UA can perform actions associated
with such usages (in addition to sending a binding-refresh REGISTER
request) whenever it receives a push notification by using the same
refresh interval that is used for the binding refreshes.
To request push notifications from the SIP network, the UA MUST
insert the following SIP URI parameters in the SIP Contact header
field URI of the REGISTER request: 'pn-provider', 'pn-prid', and
'pn-param' (if required for the specific PNS). The 'pn-provider' URI
parameter indicates the type of PNS to be used for the push
notifications.
If the UA receives a 2xx response to the REGISTER request that
contains a Feature-Caps header field [<a href="./rfc6809" title=""Mechanism to Indicate Support of Features and Capabilities in the Session Initiation Protocol (SIP)"">RFC6809</a>] with a 'sip.pns'
feature-capability indicator, with an indicator value identifying the
same type of PNS that was identified by the 'pn-provider' URI
parameter in the REGISTER request, it indicates that another SIP
Proxy in the SIP network will request that push notifications are
sent to the UA. In addition, if the same Feature-Caps header field
contains a 'sip.vapid' feature-capability indicator, it indicates
that the proxy supports use of the Voluntary Application Server
Identification (VAPID) mechanism [<a href="./rfc8292" title=""Voluntary Application Server Identification (VAPID) for Web Push"">RFC8292</a>] to restrict push
notifications to the UA.
NOTE: The VAPID-specific procedures of the SIP UA are outside the
scope of this document.
If the UA receives a non-2xx response to the REGISTER, or if the UA
receives a 2xx response that does not contain a Feature-Caps header
field [<a href="./rfc6809" title=""Mechanism to Indicate Support of Features and Capabilities in the Session Initiation Protocol (SIP)"">RFC6809</a>] with a 'sip.pns' feature-capability indicator, the UA
MUST NOT assume the proxy will request that push notifications are
sent to the UA. The actions taken by the UA in such cases are
outside the scope of this document.
If the PRID is only valid for a limited time, then the UA is
responsible for retrieving a new PRID from the PNS and sending a
binding-refresh REGISTER request with the updated 'pn-*' parameters.
If a PRID is no longer valid, and the UA is not able to retrieve a
new PRID, the UA MUST disable the push notifications associated with
the PRID (<a href="#section-4.1.2">Section 4.1.2</a>).
<span class="grey">Holmberg & Arnold Standards Track [Page 10]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
<span class="h4"><a class="selflink" id="section-4.1.2" href="#section-4.1.2">4.1.2</a>. Disable Push Notifications</span>
When a UA wants to disable previously requested push notifications,
the UA SHOULD remove the binding [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>], unless the UA is no
longer able to perform SIP procedures (e.g., due to a forced shutdown
of the UA), in which case the registrar will remove the binding once
it expires. When the UA sends the REGISTER request for removing the
binding, the UA MUST NOT insert the 'pn-prid' SIP URI parameter in
the Contact header field URI of the REGISTER request. The lack of
the parameter informs the SIP network that the UA no longer wants to
receive push notifications associated with the PRID.
<span class="h4"><a class="selflink" id="section-4.1.3" href="#section-4.1.3">4.1.3</a>. Receive Push Notifications</span>
When a UA receives a push notification, the UA MUST send a binding-
refresh REGISTER request. The UA MUST insert the same set of 'pn-*'
SIP URI parameters in the SIP Contact header field URI of the
REGISTER request that it inserted when it requested push
notifications (<a href="#section-4.1.1">Section 4.1.1</a>). Note that, in some cases, the PNS
might update the PRID value, in which case the UA will insert the new
value in the 'pn-prid' SIP URI parameter of the binding-refresh
REGISTER request.
Once the UA has received a 2xx response to the REGISTER request, the
UA might receive a SIP request for a new dialog (e.g., a SIP INVITE)
or a standalone SIP request (e.g., a SIP MESSAGE) if such a SIP
request triggered the proxy to request that the push notification was
sent to the UA. Note that, depending on which transport protocol is
used, the SIP request might reach the UA before the REGISTER
response.
If the SIP UA has created multiple bindings, the UA MUST send a
binding-refresh REGISTER request for each of those bindings when it
receives a push notification.
This specification does not define any usage of push-notification
payload. If a SIP UA receives a push notification that contains a
payload, the UA can discard the payload but will still send a
binding-refresh REGISTER request.
<span class="h4"><a class="selflink" id="section-4.1.4" href="#section-4.1.4">4.1.4</a>. Sending Binding-Refresh Requests Using Non-push Mechanism</span>
If a UA is able to send binding-refresh REGISTER requests using a
non-push mechanism (e.g., using an internal timer that periodically
wakes the UA), the UA MUST insert a 'sip.pnsreg' media feature tag
[<a href="./rfc3840" title=""Indicating User Agent Capabilities in the Session Initiation Protocol (SIP)"">RFC3840</a>] in the Contact header field of each REGISTER request.
<span class="grey">Holmberg & Arnold Standards Track [Page 11]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
If the UA receives a 2xx response to the REGISTER request that
contains a Feature-Caps header field with a 'sip.pnsreq' feature-
capability indicator, the UA MUST send a binding-refresh REGISTER
request prior to binding expiration. The indicator value indicates
the minimum time (given in seconds), prior to the binding expiration
when the UA needs to send the REGISTER request.
If the UA receives a 2xx response to the REGISTER request that does
not contain a Feature-Caps header field with a 'sip.pnsreq' feature-
capability indicator, the UA SHOULD only send a binding-refresh
REGISTER request when it receives a push notification (even if the UA
is able to use a non-push mechanism for sending binding-refresh
REGISTER requests) or when there are circumstances that require an
immediate REGISTER request to be sent (e.g., if the UA is assigned
new contact parameters due to a network configuration change).
Even if the UA is able to send binding-refresh REGISTER requests
using a non-push mechanism, the UA MUST still send a binding-refresh
REGISTER request whenever it receives a push notification
(<a href="#section-4.1.3">Section 4.1.3</a>).
NOTE: If the UA uses a non-push mechanism to wake and send binding-
refresh REGISTER requests, such REGISTER requests will update the
binding expiration timer, and the proxy does not need to request that
a push notification be sent to the UA in order to wake the UA. The
proxy will still request that a push notification be sent to the UA
when the proxy receives a SIP request addressed towards the UA
(<a href="#section-5.6.2">Section 5.6.2</a>). This allows the UA to, e.g., use timers for sending
binding-refresh REGISTER requests but be suspended (in order to save
battery resources, etc.) between sending the REGISTER requests and
using push notifications to wake the UA to process incoming calls.
<span class="grey">Holmberg & Arnold Standards Track [Page 12]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
Example of a SIP REGISTER request including a 'sip.pnsreg'
media feature tag:
REGISTER sip:alice@example.com SIP/2.0
Via: SIP/2.0/TCP alicemobile.example.com:5060;branch=z9hG4bKnashds7
Max-Forwards: 70
To: Alice <sip:alice@example.com>
From: Alice <sip:alice@example.com>;tag=456248
Call-ID: 843817637684230@998sdasdh09
CSeq: 1826 REGISTER
Contact: <sip:alice@alicemobile.example.com;
pn-provider=acme;
pn-param=acme-param;
pn-prid=ZTY4ZDJlMzODE1NmUgKi0K>;
+sip.pnsreg
Expires: 7200
Content-Length: 0
Example of a SIP REGISTER response including a 'sip.pnsreg'
media feature tag and a 'sip.pnsreq' feature-capability indicator:
SIP/2.0 200 OK
Via: SIP/2.0/TCP alicemobile.example.com:5060;branch=z9hG4bKnashds7
To: Alice <sip:alice@example.com>;tag=123987
From: Alice <sip:alice@example.com>;tag=456248
Call-ID: 843817637684230@998sdasdh09
CSeq: 1826 REGISTER
Contact: <sip:alice@alicemobile.example.com;
pn-provider=acme;
pn-param=acme-param;
pn-prid=ZTY4ZDJlMzODE1NmUgKi0K>;
+sip.pnsreg
Feature-Caps: *;+sip.pns="acme";+sip.pnsreg="121"
Expires: 7200
Content-Length: 0
Figure 3: SIP REGISTER When Using Non-push Mechanism Example
<span class="h4"><a class="selflink" id="section-4.1.5" href="#section-4.1.5">4.1.5</a>. Query Network PNS Capabilities</span>
This section describes how a SIP UA can query the types of PNSs
supported by a SIP network, and PNS-related capabilities (e.g.,
support of the VAPID mechanism). When a UA performs a query, it does
not request push notifications from the SIP network. Therefore, the
UA can perform the query before it has registered to a PNS and
received a PRID.
<span class="grey">Holmberg & Arnold Standards Track [Page 13]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
In order to perform a query, the UA MUST insert a 'pn-provider' SIP
URI parameter in the Contact header field URI of the REGISTER
request:
o If the UA inserts a 'pn-provider' parameter value, indicating
support of a type of PNS, the SIP network will only inform the UA
whether that type of PNS is supported.
o If the UA does not insert a 'pn-provider' parameter value (i.e.,
it inserts an "empty" 'pn-provider' parameter), the SIP network
will inform the UA about all types of PNSs supported by the
network. This is useful, e.g., if the UA supports more than one
type of PNS. Note that it is not possible to insert multiple
parameter values in the 'pn-provider' parameter.
The UA MUST NOT insert a 'pn-prid' SIP URI parameter in the Contact
header field URI of the REGISTER request.
If the UA receives a 2xx response to the REGISTER request, the
response will contain one or more Feature-Caps header fields with a
'sip.pns' feature-capability indicator, indicating the types of PNSs
supported by the SIP network. If the UA inserted a 'pn-provider' SIP
URI parameter value in the REGISTER request, the response will only
indicate whether the SIP network supports the type of PNS supported
by the UA.
If the UA receives a 555 (Push Notification Service Not Supported)
response to the REGISTER request, and if the UA inserted a
'pn-provider' SIP URI parameter in the REGISTER request, the response
indicates that the network does not support the type of PNS that the
UA indicated support of. If the UA did not insert a 'pn-provider'
parameter in the REGISTER request, the response indicates that the
network does not support any type of PNS while still supporting the
555 (Push Notification Service Not Supported) response.
NOTE: It is optional for a UA to perform a query before it requests
push notifications from the SIP network.
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. SIP Proxy Behavior</span>
<span class="h3"><a class="selflink" id="section-5.1" href="#section-5.1">5.1</a>. PNS Provider</span>
The type of PNS is identified by the 'pn-provider' SIP URI parameter.
In some cases, there might only be one PNS provider for a given type
of PNS, while in other cases there might be multiple providers. The
'pn-param' SIP URI parameter will provide more details associated
with the actual PNS provider to be used.
<span class="grey">Holmberg & Arnold Standards Track [Page 14]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
The protocol and format used for the push notification requests are
PNS-specific, and the details for constructing and sending a push
notification request are outside the scope of this specification.
<span class="h3"><a class="selflink" id="section-5.2" href="#section-5.2">5.2</a>. SIP Request Push Bucket</span>
When a SIP proxy receives a SIP request addressed towards a UA, that
will trigger the proxy to request that a push notification be sent to
the UA. The proxy will place the request in storage (referred to as
the SIP Request Push Bucket) and the proxy will start a timer
(referred to as the Bucket Timer) associated with the transaction. A
SIP request is removed from the bucket when one of the following has
occurred: the proxy forwards the request towards the UA, the proxy
sends an error response to the request, or the Bucket Timer times
out. The detailed procedures are described in the sections below.
Exactly how the SIP Request Push Bucket is implemented is outside the
scope of this document. One option is to use the PRID as a key to
search for SIP requests in the bucket. Note that mid-dialog requests
(<a href="#section-6">Section 6</a>) do not carry the PRID in the SIP request itself.
<span class="h3"><a class="selflink" id="section-5.3" href="#section-5.3">5.3</a>. SIP URI Comparison Rules</span>
By default, a SIP proxy uses the URI comparison rules defined in
[<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>]. However, when a SIP proxy compares the Contact header
field URI of a 2xx response to a REGISTER request with a Request-URI
of a SIP request in the SIP Request Push Bucket (<a href="#section-5.2">Section 5.2</a>), the
proxy uses the URI comparison rules with the following additions: the
'pn-prid', 'pn-provider', and 'pn-param' SIP URI parameters MUST also
match. If a 'pn-*' parameter is present in one of the compared URIs
but not in the other URI, there is no match.
If only the 'pn-*' SIP URI parameters listed above match, but other
parts of the compared URIs do not match, a proxy MAY still consider
the comparison successful based on local policy. This can occur in a
race condition when the proxy compares the Contact header field URI
of a 2xx response to a REGISTER request with a Request-URI of a SIP
request in the SIP Request Push Bucket (<a href="#section-5.2">Section 5.2</a>) if the UA had
modified some parts of the Contact header field URI in the REGISTER
request but the Request-URI of the SIP request in the SIP Request
Push Bucket still contains the old parts.
<span class="h3"><a class="selflink" id="section-5.4" href="#section-5.4">5.4</a>. Indicate Support of Type of PNS</span>
A SIP proxy uses feature-capability indicators [<a href="./rfc6809" title=""Mechanism to Indicate Support of Features and Capabilities in the Session Initiation Protocol (SIP)"">RFC6809</a>] to indicate
support of types of PNSs and additional features (e.g., VAPID)
associated with the type of PNS. A proxy MUST use a separate
Feature-Cap header field for each supported type of PNS. A feature-
<span class="grey">Holmberg & Arnold Standards Track [Page 15]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
capability indicator that indicates support of an additional feature
associated with a given type of PNS MUST be inserted in the same
Feature-Caps header field that is used to indicate support of the
type of PNS.
This specification defines the following feature-capability
indicators that a proxy can use to indicate support of additional
features associated with a given type of PNS: 'sip.vapid',
'sip.pnsreg', and 'sip.pnspurr'. These feature-capability indicators
MUST only be inserted in a Feature-Caps header field that also
contains a 'sip.pns' feature-capability indicator.
<span class="h3"><a class="selflink" id="section-5.5" href="#section-5.5">5.5</a>. Trigger Periodic Binding Refresh</span>
In order to request that a push notification be sent to a SIP UA, a
SIP proxy needs to have information about when a binding will expire.
The proxy needs to be able to retrieve the information from the
registrar using some mechanism or run its own registration timers.
Such mechanisms are outside the scope of this document but could be
implemented, e.g., by using the SIP event package for registrations
mechanism [<a href="./rfc3680" title=""A Session Initiation Protocol (SIP) Event Package for Registrations"">RFC3680</a>].
When the proxy receives an indication that the UA needs to send a
binding-refresh REGISTER request, the proxy will request that a push
notification be sent to the UA.
Note that the push notification needs to be requested early enough
for the associated binding-refresh REGISTER request to reach the
registrar before the binding expires. It is RECOMMENDED that the
proxy requests the push notification at least 120 seconds before the
binding expires.
If the UA has indicated, using the 'sip.pnsreg' media feature tag,
that it is able to wake itself using a non-push mechanism in order to
send binding-refresh REGISTER requests, and if the proxy does not
receive a REGISTER request prior to 120 seconds before the binding
expires, the proxy MAY request that a push notification be sent to
the UA to trigger the UA to send a binding-refresh REGISTER request.
NOTE: As described in <a href="#section-4.1.5">Section 4.1.5</a>, a UA might send a REGISTER
request without including a 'pn-prid' SIP URI parameter in order to
retrieve push notification capabilities from the network before the
UA expects to receive push notifications from the network. A proxy
will not request that push notifications are sent to a UA that has
not provided a 'pn-prid' SIP URI parameter (<a href="#section-5.6.2">Section 5.6.2</a>).
<span class="grey">Holmberg & Arnold Standards Track [Page 16]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
If the proxy receives information that a binding associated with a
PRID has expired, or that a binding has been removed, the proxy MUST
NOT request that further push notifications are sent to the UA using
that PRID.
<span class="h3"><a class="selflink" id="section-5.6" href="#section-5.6">5.6</a>. SIP Requests</span>
<span class="h4"><a class="selflink" id="section-5.6.1" href="#section-5.6.1">5.6.1</a>. REGISTER</span>
This section describes how a SIP proxy processes SIP REGISTER
requests (initial REGISTER request for a binding or a binding-refresh
REGISTER request).
The procedures in this section apply when the REGISTER request
contains a 'pn-provider' SIP URI parameter in the Contact header
field URI. In other cases, the proxy MUST skip the procedures in
this section and process the REGISTER request using normal SIP
procedures.
<span class="h5"><a class="selflink" id="section-5.6.1.1" href="#section-5.6.1.1">5.6.1.1</a>. Request Push Notifications</span>
This section describes the SIP proxy procedures when a SIP UA
requests push notifications from the SIP network.
The procedures in this section apply when the SIP REGISTER request
contains, in addition to the 'pn-provider' SIP URI parameter, a
'pn-prid' SIP URI parameter in the Contact header field URI of the
request.
When a proxy receives a REGISTER request that contains a Feature-Caps
header field with a 'sip.pns' feature-capability indicator, it
indicates that another proxy between this proxy and the UA supports
the type of PNS supported by the UA, and will request that push
notifications are sent to the UA. In such case, the proxy MUST skip
the rest of the procedures in this section and process the REGISTER
request using normal SIP procedures.
When a proxy receives a REGISTER request that does not contain a
Feature-Caps header field with a 'sip.pns' feature-capability
indicator, the proxy processes the request according to the
procedures below:
o If the proxy does not support the type of PNS supported by the UA,
or if the REGISTER request does not contain all information
required for the type of PNS, the proxy SHOULD forward the request
towards the registrar and skip the rest of the procedures in this
section. If the proxy knows (by means of local configuration)
that no other proxies between itself and the registrar support the
<span class="grey">Holmberg & Arnold Standards Track [Page 17]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
type of PNS supported by the UA, the proxy MAY send a SIP 555
(Push Notification Service Not Supported) response instead of
forwarding the request.
o If the proxy supports the type of PNS supported by the UA, but
considers the requested binding expiration interval [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>] to
be too short (see below), the proxy MUST either send a 423
(Interval Too Brief) response to the REGISTER request or forward
the request towards the registrar and skip the rest of the
procedures in this section.
o If the proxy supports the type of PNS supported by the UA, the
proxy MUST indicate support of that type of PNS (<a href="#section-5.4">Section 5.4</a>) in
the REGISTER request before it forwards the request towards the
registrar. This will inform proxies between the proxy and the
registrar that the proxy supports the type of PNS supported by the
UA, and that the proxy will request that push notifications are
sent to the UA.
A binding expiration interval MUST be considered too short if the
binding would expire before the proxy can request that a push
notification be sent to the UA to trigger the UA to send a binding-
refresh REGISTER request. The proxy MAY consider the interval too
short based on its own policy so as to reduce load on the system.
When a proxy receives a 2xx response to the REGISTER request, if the
proxy indicated support of a type of PNS in the REGISTER request (see
above), the proxy performs the following actions:
o If the proxy considers the binding expiration interval indicated
by the registrar too short (see above), the proxy forwards the
response towards the UA and MUST skip the rest of the procedures
in this section.
o The proxy MUST indicate support of the same type of PNS in the
REGISTER response. In addition:
* If the proxy supports the VAPID mechanism [<a href="./rfc8292" title=""Voluntary Application Server Identification (VAPID) for Web Push"">RFC8292</a>], the proxy
MUST indicate support of the mechanism, using the 'sip.vapid'
feature-capability indicator, in the REGISTER response. The
indicator value contains the public key identifying the proxy.
The proxy MUST determine whether the PNS provider supports the
VAPID mechanism before it indicates support of it.
<span class="grey">Holmberg & Arnold Standards Track [Page 18]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
* If the proxy received a 'sip.pnsreg' media feature tag in the
REGISTER request, the proxy SHOULD insert a 'sip.pnsreg'
feature-capability indicator with an indicator value bigger
than 120 in the response, unless the proxy always wants to
request that push notifications are sent to the UA in order to
trigger the UA to send a binding-refresh REGISTER request.
<span class="h5"><a class="selflink" id="section-5.6.1.2" href="#section-5.6.1.2">5.6.1.2</a>. Query Network PNS Capabilities</span>
This section describes the SIP proxy procedures when a SIP UA queries
about the push-notification support in the SIP network
(<a href="#section-4.1.5">Section 4.1.5</a>).
The procedures in this section apply when the REGISTER request
contains a 'pn-provider' SIP URI parameter, but does not contain a
'pn-prid' SIP URI parameter in the Contact header field URI of the
REGISTER request.
When a proxy receives a REGISTER request that contains a
'pn-provider' SIP URI parameter indicating the type of PNS supported
by the UA, the proxy MUST perform the following actions:
o If the proxy supports the type of PNS supported by the UA, the
proxy MUST indicate support of that type of PNS (<a href="#section-5.4">Section 5.4</a>) in
the REGISTER request before it forwards the request towards the
registrar. This will inform any other proxies between the proxy
and the registrar that the proxy supports the type of PNS
supported by the UA.
o If the proxy does not support the type of PNS supported by the UA,
and if the REGISTER request contains Feature-Caps header fields
indicating support of one or more types of PNSs, the proxy
forwards the request towards the registrar.
o If the proxy does not support the type of PNS supported by the UA,
and if the REGISTER request does not contain Feature-Caps header
fields indicating support of one or more types of PNSs, the proxy
MUST either forward the request towards the registrar or send a
SIP 555 (Push Notification Service Not Supported) response towards
the UA. The proxy MUST NOT send a SIP 555 (Push Notification
Service Not Supported) response unless it knows (by means of local
configuration) that no other proxy supports any of the types of
PNSs supported by the UA.
When a proxy receives a REGISTER request, and the 'pn-provider' SIP
URI parameter does not contain a parameter value, the proxy MUST
indicate support of each type of PNS supported by the proxy before it
forwards the request towards the registrar.
<span class="grey">Holmberg & Arnold Standards Track [Page 19]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
When a proxy receives a 2xx response to the REGISTER request, if the
proxy had indicated support of one or more types of PNSs in the
REGISTER request (see above), the proxy MUST indicate support of the
same set of types of PNSs in the response. In addition, if the proxy
supports the VAPID mechanism for one or more types of PNSs, the proxy
MUST indicate support of the mechanism for those PNSs in the
response.
<span class="h4"><a class="selflink" id="section-5.6.2" href="#section-5.6.2">5.6.2</a>. Initial Request for Dialog or Standalone Request</span>
The procedures in this section apply when a SIP proxy has indicated
that it will request that push notifications are sent to the SIP UA.
When the proxy receives a SIP request for a new dialog (e.g., a SIP
INVITE request) or a standalone SIP request (e.g., a SIP MESSAGE
request) addressed towards a SIP UA, if the Request-URI of the
request contains a 'pn-provider', a 'pn-prid', and a 'pn-param' (if
required for the specific PNS provider) SIP URI parameter, the proxy
requests that a push notification be sent to the UA using the
information in the 'pn-*' SIP URI parameters. The proxy then places
the SIP request in the SIP Request Push Bucket. The push
notification will trigger the UA to send a binding-refresh REGISTER
request that the proxy will process as described in <a href="#section-5.6.1">Section 5.6.1</a>.
In addition, the proxy MUST store the Contact URI of the REGISTER
request during the lifetime of the REGISTER transaction.
NOTE: If the proxy receives a SIP request that does not contain the
'pn-*' SIP URI parameters listed above, the proxy processing of the
request is based on local policy. If the proxy also serves requests
for UAs that do not use the SIP push mechanism, the proxy can forward
the request towards the UA. Otherwise, the proxy can reject the
request.
When the proxy receives a 2xx response to the REGISTER request, the
proxy performs the following actions:
o The proxy processes the REGISTER response as described in
<a href="#section-5.6.1">Section 5.6.1</a>.
o The proxy checks whether the SIP Request Push Bucket contains a
SIP request associated with the REGISTER transaction by comparing
(<a href="#section-5.3">Section 5.3</a>) the Contact header field URI in the REGISTER
response with the Request-URIs of the SIP requests in the bucket.
If there is a match, the proxy MUST remove the SIP request from
the bucket and forward it towards the UA.
<span class="grey">Holmberg & Arnold Standards Track [Page 20]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
The reason the proxy needs to wait for the REGISTER response before
forwarding a SIP request towards a UA is to make sure that the
REGISTER request has been accepted by the registrar, and that the UA
that initiated the REGISTER request is authorized to receive messages
for the Request-URI.
If the proxy receives a non-2xx response to the REGISTER request, the
proxy compares the Contact URI stored from the REGISTER request (see
above) with the Request-URIs of the SIP requests in the SIP Request
Push Bucket. If there is a match, the proxy SHOULD remove the
associated request from the bucket and send an error response to the
request. It is RECOMMENDED that the proxy sends either a 404 (Not
Found) response or a 480 (Temporarily Unavailable) response to the
SIP request, but other response codes can be used as well. However,
if the REGISTER response is expected to trigger a new REGISTER
request from the UA (e.g., if the registrar is requesting the UA to
perform authentication), the proxy MAY keep the SIP request in the
bucket.
If the push notification request fails (see PNS-specific
documentation for details), the proxy MUST remove the SIP request
from the bucket and send an error response to the SIP request. It is
RECOMMENDED that the proxy sends either a 404 (Not Found) response or
a 480 (Temporarily Unavailable) response, but other response codes
can be used as well.
After the proxy has requested that a push notification be sent to a
UA, if the proxy does not receive a REGISTER response with a Contact
URI that matches the Request-URI of the SIP request before the Bucket
Timer (<a href="#section-5.2">Section 5.2</a>) associated with the SIP request times out, the
proxy MUST remove the SIP request from the SIP Request Push Bucket
(<a href="#section-5.2">Section 5.2</a>) and send a 480 (Temporarily Unavailable) response. The
Bucket Timer time-out value is set based on local policy, taking the
guidelines below into consideration.
As discussed in [<a href="./rfc4320" title=""Actions Addressing Identified Issues with the Session Initiation Protocol's (SIP) Non-INVITE Transaction"">RFC4320</a>] and [<a href="./rfc4321" title=""Problems Identified Associated with the Session Initiation Protocol's (SIP) Non-INVITE Transaction"">RFC4321</a>], non-INVITE transactions must
complete immediately or risk losing a race, which results in stress
on intermediaries and state misalignment at the endpoints. The
mechanism defined in this document inherently delays the final
response to any non-INVITE request that requires a push notification.
In particular, if the proxy forwards the SIP request towards the SIP
UA, the SIP UA accepts the request, but the transaction times out at
the sender before it receives the successful response, this will
cause state misalignment between the endpoints (the sender considers
the transaction a failure, while the receiver considers the
transaction a success). The SIP proxy needs to take this into
account when it sets the value of the Bucket Timer associated with
the transaction, to make sure that the error response (triggered by a
<span class="grey">Holmberg & Arnold Standards Track [Page 21]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
Bucket Timer time out) reaches the sender before the transaction
times out. If the accumulated delay of this mechanism combined with
any other mechanisms in the path of processing the non-INVITE
transaction cannot be kept short, this mechanism should not be used.
For networks encountering such conditions, an alternative (left for
possible future work) would be for the proxy to immediately return a
new error code meaning "wait at least the number of seconds specified
in this response and retry your request" before initiating the push
notification.
NOTE: While the work on this document was ongoing, implementation
test results showed that the time it takes for a proxy to receive the
REGISTER request, from when the proxy has requested a push
notification, is typically around 2 seconds. However, the time might
vary depending on the characteristics and load of the SIP network and
the PNS.
In addition to the procedures described above, there are two cases
where a proxy, as an optimization, can forward a SIP request towards
a UA without either waiting for a 2xx response to a REGISTER request
or requesting that a push notification be sent to the UA:
o If the proxy is able to authenticate the sender of the REGISTER
request and verify that it is allowed by authorization policy, the
proxy does not need to wait for the 2xx response before it
forwards the SIP request towards the UA. In such cases, the proxy
will use the Contact URI of the REGISTER request when comparing it
against the Request-URIs of the SIP requests in the SIP Request
Push Bucket.
o If the proxy has knowledge that the UA is awake, and that the UA
is able to receive the SIP request without first sending a
binding-refresh REGISTER request, the proxy does not need to
request that a push notification be sent to the UA (the UA will
not send a binding-refresh REGISTER request) before it forwards
the SIP request towards the UA. The mechanisms for getting such
knowledge might be dependent on implementation or deployment
architecture, and are outside the scope of this document.
Some PNS providers allow payload in the push notifications. This
specification does not define usage of such payload (in addition to
any payload that might be required by the PNS itself).
<span class="grey">Holmberg & Arnold Standards Track [Page 22]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. Support of Long-Lived SIP Dialogs</span>
Some SIP dialogs might have a long lifetime with little activity.
For example, when the SIP event notification mechanism [<a href="./rfc6665" title=""SIP-Specific Event Notification"">RFC6665</a>] is
used, there might be a long period between the sending of mid-dialog
requests. Because of this, a SIP UA may be suspended and may need to
be awakened in order to be able to receive mid-dialog requests.
SIP requests for a new dialog and standalone SIP requests addressed
towards a UA with 'pn-*' SIP URI parameters allow the proxy to
request that a push notification be sent to the UA (<a href="#section-5.6.2">Section 5.6.2</a>).
However, 'pn-*' SIP URI parameters will not be present in mid-dialog
requests addressed towards the UA. Instead, the proxy needs to
support a mechanism to store the information needed to request that a
push notification be sent to the UA, and to be able to retrieve that
information when it receives a mid-dialog request addressed towards
the UA. This section defines such a mechanism. The SIP UA and SIP
proxy procedures in this section are applied in addition to the
generic procedures defined in this specification.
+--------+ +---------+ +-----------+ +-------------+
| | | | | | | SIP |
| SIP UA | | Push | | SIP Proxy | | Registrar / |
| | | Service | | | | Home Proxy |
+--------+ +---------+ +-----------+ +-------------+
| | | |
| PNS Register | | |
|---------------->| | |
| | | |
| PRID | | |
|<----------------| | |
| | | |
| SIP REGISTER (PRID) | |
|===================================>| |
| | |SIP REGISTER (PRID)|
| | |==================>|
| | | |
| | +-----------------------+ |
| | | Store PRID (key=PURR) | |
| | +-----------------------+ |
| | | |
| | | SIP 200 OK |
| | |<==================|
| SIP 200 OK (PURR) | |
|<===================================| |
| | | |
| | | |
<span class="grey">Holmberg & Arnold Standards Track [Page 23]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
| SIP INVITE (PURR) | |
|===================================>| |
| | |SIP INVITE (PURR) |
| | |==================>|
| | | |
| | | SIP 200 OK |
| | |<==================|
| SIP 200 OK | | |
|<===================================| |
| | | |
| | | |
| | | |
| | |SIP UPDATE (PURR) |
| | |<==================|
| | | |
| | +-----------------------+ |
| | | Fetch PRID (key=PURR) | |
| | +-----------------------+ |
| | | |
| |Push Request (PRID) |
| |<-----------------| |
|Push Message (PRID) | |
|<----------------| | |
| | | |
| SIP REGISTER (PRID) | |
|===================================>| |
| | |SIP REGISTER (PRID)|
| | |==================>|
| | | |
| | | SIP 200 OK |
| | |<==================|
| SIP 200 OK (PURR) | |
|<===================================| |
| | | |
| SIP UPDATE | | |
|<===================================| |
| | | |
------- Push Notification API
======= SIP
Figure 4: SIP Push Long-Lived Dialog Flow
<span class="grey">Holmberg & Arnold Standards Track [Page 24]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
<span class="h3"><a class="selflink" id="section-6.1" href="#section-6.1">6.1</a>. SIP UA Behavior</span>
<span class="h4"><a class="selflink" id="section-6.1.1" href="#section-6.1.1">6.1.1</a>. Initial Request for Dialog</span>
If the UA is willing to receive push notifications when a proxy
receives a mid-dialog request addressed towards the UA, the UA MUST
insert a 'pn-purr' SIP URI parameter (<a href="#section-6.2.1">Section 6.2.1</a>) in the Contact
header field URI of the initial request for a dialog or the 2xx
response to such requests. The UA MUST insert a parameter value
identical to the last 'sip.pnspurr' feature-capability indicator
(<a href="#section-6.2.1">Section 6.2.1</a>) that it received in a REGISTER response. If the UA
has not received a 'sip.pnspurr' feature-capability indicator, the UA
MUST NOT insert a 'pn-purr' SIP URI parameter in a request or
response.
The UA makes the decision to receive push notifications triggered by
incoming mid-dialog requests based on local policy. Such policy
might be based on the type of SIP dialog, the type of media (if any)
negotiated for the dialog [<a href="./rfc3264" title=""An Offer/Answer Model with Session Description Protocol (SDP)"">RFC3264</a>], etc.
NOTE: As the 'pn-purr' SIP URI parameter only applies to a given
dialog, the UA needs to insert a 'pn-purr' parameter in the Contact
header field URI of the request or response for each dialog in which
the UA is willing to receive push notifications triggered by incoming
mid-dialog requests.
<span class="h3"><a class="selflink" id="section-6.2" href="#section-6.2">6.2</a>. SIP Proxy Behavior</span>
<span class="h4"><a class="selflink" id="section-6.2.1" href="#section-6.2.1">6.2.1</a>. REGISTER</span>
If the proxy supports requesting push notifications triggered by mid-
dialog requests being sent to the registered UA, the proxy MUST store
the information (the 'pn-*' SIP URI parameters) needed to request
that push notifications are sent to the UA when a proxy receives an
initial REGISTER request for a binding from the UA. In addition, the
proxy MUST generate a unique (within the context of the proxy) value,
referred to as the PURR (Proxy Unique Registration Reference), that
can be used as a key to retrieve the information.
In order to prevent client fingerprinting, the proxy MUST
periodically generate a new PURR value (even if 'pn-*'parameters did
not change). However, as long as there are ongoing dialogs
associated with the old value, the proxy MUST store it so that it can
request that push notifications are sent to the UA when it receives a
mid-dialog request addressed towards the UA. In addition, the PURR
value MUST be generated in such a way so that it is unforgeable,
anonymous, and unlinkable to entities other than the proxy. It must
not be possible for an attacker to generate a valid PURR, to
<span class="grey">Holmberg & Arnold Standards Track [Page 25]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
associate a PURR with a specific user, or to determine when two PURRs
correspond to the same user. It can be generated, e.g., by utilizing
a cryptographically secure random function with an appropriately
large output size.
Whenever the proxy receives a 2xx response to a REGISTER request, the
proxy MUST insert a 'sip.pnspurr' feature-capability indicator with
the latest PURR value (see above) in the response.
<span class="h4"><a class="selflink" id="section-6.2.2" href="#section-6.2.2">6.2.2</a>. Initial Request for Dialog</span>
When a proxy receives an initial request for a dialog from a UA that
contains a 'pn-purr' SIP URI parameter in the Contact header field
URI with a PURR value that the proxy has generated (<a href="#section-6.2.1">Section 6.2.1</a>),
the proxy MUST add a Record-Route header to the request to insert
itself in the dialog route [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>] before forwarding the request.
When the proxy receives an initial request for a dialog addressed
towards the UA, and the proxy has generated a PURR value associated
with the 'pn-*' parameters inserted in the SIP URI of the request
(<a href="#section-6.2.2">Section 6.2.2</a>), the proxy MUST add a Record-Route header to the
request to insert itself in the dialog route [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>] before
forwarding the request.
<span class="h4"><a class="selflink" id="section-6.2.3" href="#section-6.2.3">6.2.3</a>. Mid-dialog Request</span>
When the proxy receives a mid-dialog SIP request addressed towards
the UA that contains a 'pn-purr' SIP URI parameter, and the proxy is
able to retrieve the stored information needed to request that a push
notification be sent to the UA (<a href="#section-6.2.1">Section 6.2.1</a>), the proxy MUST place
the SIP request in the SIP Request Push Bucket and request that a
push notification be sent to the UA.
NOTE: The 'pn-purr' SIP URI parameter will either be carried in the
Request-URI or in a Route header field [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>] of the SIP request
depending on how the route set [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>] of the mid-dialog SIP
request has been constructed.
When the proxy receives a 2xx response to a REGISTER request, the
proxy checks whether the SIP Request Push Bucket contains a mid-
dialog SIP request associated with the REGISTER transaction. If the
bucket contains such a request, the proxy MUST remove the SIP request
from the SIP Request Push Bucket and forward it towards the UA.
Note that the proxy does not perform a URI comparison (<a href="#section-5.3">Section 5.3</a>)
when processing mid-dialog requests, as a mid-dialog request will not
contain the 'pn-prid', 'pn-provider', and 'pn-param' SIP URI
<span class="grey">Holmberg & Arnold Standards Track [Page 26]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
parameters. The proxy only checks for a mid-dialog request that
contains the PURR value associated with the REGISTER 2xx response.
As described in <a href="#section-5.6.2">Section 5.6.2</a>, while waiting for the push
notification request to succeed, and then for the associated REGISTER
request and 2xx response, the proxy needs to take into consideration
that the transaction associated with the mid-dialog request will
eventually time out at the sender of the request (User Agent Client),
and the sender will consider the transaction a failure.
When a proxy sends an error response to a mid-dialog request (e.g.,
due to a transaction time out), the proxy SHOULD select a response
code that only impacts the transaction associated with the request
[<a href="./rfc5079" title=""Rejecting Anonymous Requests in the Session Initiation Protocol (SIP)"">RFC5079</a>].
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. Support of SIP Replaces</span>
[<a id="ref-RFC3891">RFC3891</a>] defines a mechanism that allows a SIP UA to replace a
dialog with another dialog. A UA that wants to replace a dialog with
another one will send an initial request for the new dialog. The
Request-URI of the request will contain the Contact header field URI
of the peer.
If a SIP proxy wants to be able to request that a push notification
be sent to a UA when it receives an initial request for a dialog that
replaces an existing dialog, using the mechanism in [<a href="./rfc3891" title=""The Session Initiation Protocol (SIP) "">RFC3891</a>], the
proxy and the UA MUST perform the following actions:
o The proxy MUST provide a PURR to the UA during registration
(<a href="#section-6.2.1">Section 6.2.1</a>).
o The UA MUST insert a 'pn-purr' SIP URI parameter in the Contact
header field URI of either the initial request for a dialog or a
2xx response to such requests (<a href="#section-6.1.1">Section 6.1.1</a>). This includes
dialogs replacing other dialogs, as those dialogs might also get
replaced.
o The proxy MUST apply the mechanism defined in <a href="#section-6.2.3">Section 6.2.3</a> to
place and retrieve the request from the SIP Request Push Bucket.
In addition, the operator needs to make sure that the initial request
for dialogs, addressed towards the UA using the contact of the
replaced dialog, will be routed to the SIP proxy (in order to request
that a push notification be sent to the UA). The procedures for
doing that are operator-specific and are outside the scope of this
specification.
<span class="grey">Holmberg & Arnold Standards Track [Page 27]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. Grammar</span>
<span class="h3"><a class="selflink" id="section-8.1" href="#section-8.1">8.1</a>. 555 (Push Notification Service Not Supported) Response Code</span>
The 555 response code is added to the "Server-Error" Status-Code
definition. 555 (Push Notification Service Not Supported) is used to
indicate that the server does not support the push notification
service identified in a 'pn-provider' SIP URI parameter.
The use of the SIP 555 response code is only defined for SIP REGISTER
responses.
<span class="h3"><a class="selflink" id="section-8.2" href="#section-8.2">8.2</a>. 'sip.pns' Feature-Capability Indicator</span>
The sip.pns feature-capability indicator, when inserted in a Feature-
Caps header field of a SIP REGISTER request or a SIP 2xx response to
a REGISTER request, indicates that the entity associated with the
indicator supports the SIP push mechanism and the type of push
notification service indicated by the indicator value. The values
defined for the 'pn-provider' SIP URI parameter are used as indicator
values.
pns-fc = "+sip.pns" EQUAL LDQUOT pns RDQUOT
pns = tag-value
tag-value = <tag-value defined in [<a href="./rfc3840" title=""Indicating User Agent Capabilities in the Session Initiation Protocol (SIP)"">RFC3840</a>]>
<span class="h3"><a class="selflink" id="section-8.3" href="#section-8.3">8.3</a>. 'sip.vapid' Feature-Capability Indicator</span>
The sip.vapid feature-capability indicator, when inserted in a SIP
2xx response to a SIP REGISTER request, denotes that the entity
associated with the indicator supports the Voluntary Application
Server Identification (VAPID) [<a href="./rfc8292" title=""Voluntary Application Server Identification (VAPID) for Web Push"">RFC8292</a>] mechanism when the entity
requests that a push notification be sent to a SIP UA. The indicator
value is a public key identifying the entity that can be used by a
SIP UA to restrict subscriptions to that entity.
vapid-fc = "+sip.vapid" EQUAL LDQUOT vapid RDQUOT
vapid = tag-value
tag-value = <tag-value defined in [<a href="./rfc3840" title=""Indicating User Agent Capabilities in the Session Initiation Protocol (SIP)"">RFC3840</a>]>
<span class="h3"><a class="selflink" id="section-8.4" href="#section-8.4">8.4</a>. 'sip.pnsreg' Feature-Capability Indicator</span>
The sip.pnsreg feature-capability indicator, when inserted in a SIP
2xx response to a SIP REGISTER request, denotes that the entity
associated with the indicator expects to receive binding-refresh
REGISTER requests from the SIP UA associated with the binding before
<span class="grey">Holmberg & Arnold Standards Track [Page 28]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
the binding expires, even if the entity does not request that a push
notification be sent to the SIP UA in order to trigger the binding-
refresh REGISTER requests. The indicator value conveys the minimum
time (given in seconds) prior to the binding expiration when the UA
MUST send the REGISTER request.
pns-fc = "+sip.pnsreg" EQUAL LDQUOT reg RDQUOT
reg = 1*DIGIT
DIGIT = <DIGIT defined in [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>]>
<span class="h3"><a class="selflink" id="section-8.5" href="#section-8.5">8.5</a>. 'sip.pnsreg' Media Feature Tag</span>
The sip.pnsreg media feature tag, when inserted in the Contact header
field of a SIP REGISTER request, indicates that the SIP UA associated
with the tag is able to send binding-refresh REGISTER requests for
the associated binding without being awakened by push notifications.
The media feature tag has no values.
pnsreg-mt = "+sip.pnsreg"
<span class="h3"><a class="selflink" id="section-8.6" href="#section-8.6">8.6</a>. 'sip.pnspurr' Feature-Capability Indicator</span>
The sip.pnspurr feature-capability indicator, when inserted in a SIP
2xx response to a SIP REGISTER request, denotes that the entity
associated with the indicator will store information that can be used
to associate a mid-dialog SIP request with the binding information in
the REGISTER request.
pnspurr-fc = "+sip.pnspurr" EQUAL LDQUOT pnspurr RDQUOT
pnspurr = tag-value
tag-value = <tag-value defined in [<a href="./rfc3840" title=""Indicating User Agent Capabilities in the Session Initiation Protocol (SIP)"">RFC3840</a>]>
<span class="h3"><a class="selflink" id="section-8.7" href="#section-8.7">8.7</a>. SIP URI Parameters</span>
This section defines new SIP URI parameters by extending the grammar
for "uri-parameter" as defined in [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>]. The ABNF [<a href="./rfc5234" title=""Augmented BNF for Syntax Specifications: ABNF"">RFC5234</a>] is
as follows:
uri-parameter =/ pn-provider / pn-param / pn-prid / pn-purr
pn-provider = "pn-provider" [EQUAL pvalue]
pn-param = "pn-param" EQUAL pvalue
pn-prid = "pn-prid" EQUAL pvalue
pn-purr = "pn-purr" EQUAL pvalue
pvalue = <pvalue defined in [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>]>
EQUAL = <EQUAL defined in [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>]>
<span class="grey">Holmberg & Arnold Standards Track [Page 29]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
The format and semantics of pn-prid and pn-param are specific to the
pn-provider value.
Parameter value characters that are not part of pvalue need to be
escaped, as defined in <a href="./rfc3261">RFC 3261</a>.
<span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. PNS Registration Requirements</span>
When a new value is registered to the PNS subregistry, a reference to
a specification that describes the usage of the PNS associated with
the value is provided. That specification MUST contain the following
information:
o The value of the 'pn-provider' SIP URI parameter.
o How the 'pn-prid' SIP URI parameter value is retrieved and set by
the SIP UA.
o How the 'pn-param' SIP URI parameter (if required for the specific
PNS provider) value is retrieved and set by the SIP UA.
<span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>. 'pn-provider', 'pn-param', and 'pn-prid' URI Parameters for Apple</span>
<span class="h2"> Push Notification service</span>
When the Apple Push Notification service (APNs) is used, the
PNS-related SIP URI parameters are set as described below.
For detailed information about the parameter values, see
<<a href="https://developer.apple.com/library/archive/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html">https://developer.apple.com/library/archive/documentation/</a>
<a href="https://developer.apple.com/library/archive/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html">NetworkingInternet/Conceptual/RemoteNotificationsPG/</a>
<a href="https://developer.apple.com/library/archive/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html">CommunicatingwithAPNs.html</a>> [<a href="#ref-pns-apns" title=""Local and Remote Notification Programming Guide: Communicating with APNs"">pns-apns</a>].
The value of the 'pn-provider' URI parameter is "apns".
Example: pn-provider=apns
The value of the 'pn-param' URI parameter is a string that is
composed of two values separated by a period (.): Team ID and Topic.
The Team ID is provided by Apple and is unique to a development team.
The Topic consists of the Bundle ID, which uniquely identifies an
application, and a service value that identifies a service associated
with the application, separated by a period (.). For Voice over IP
(VoIP) applications, the service value is "voip".
Example: pn-param=DEF123GHIJ.com.example.yourexampleapp.voip
<span class="grey">Holmberg & Arnold Standards Track [Page 30]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-31" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
NOTE: The Bundle ID might contain one or more periods (.). Hence,
within the 'pn-param' value, the first period will be separating the
Team ID from the Topic, and within the Topic, the last period will be
separating the Bundle ID from the service.
The value of the 'pn-prid' URI parameter is the device token, which
is a unique identifier assigned by Apple to a specific app on a
specific device.
Example: pn-prid=00fc13adff78512
<span class="h2"><a class="selflink" id="section-11" href="#section-11">11</a>. 'pn-provider', 'pn-param', and 'pn-prid' URI Parameters for Google</span>
<span class="h2"> Firebase Cloud Messaging (FCM) Push Notification Service</span>
When Firebase Cloud Messaging (FCM) is used, the PNS-related URI
parameters are set as described below.
For detailed information about the parameter values, see
<<a href="https://firebase.google.com/docs/cloud-messaging/concept-options">https://firebase.google.com/docs/cloud-messaging/concept-options</a>>
[<a href="#ref-pns-fcm" title=""Firebase Cloud Messaging"">pns-fcm</a>].
The value of the 'pn-provider' URI parameter is "fcm".
The value of the 'pn-param' URI parameter is the Project ID.
The value of the 'pn-prid' URI parameter is the Registration token,
which is generated by the FCM SDK for each client app instance.
<span class="h2"><a class="selflink" id="section-12" href="#section-12">12</a>. 'pn-provider', 'pn-param', and 'pn-prid' URI Parameters for <a href="./rfc8030">RFC</a></span>
<a href="./rfc8030">8030</a> (Generic Event Delivery Using HTTP Push)
When Generic Event Delivery Using HTTP Push is used, the PNS-related
URI parameters are set as described below.
The value of the 'pn-provider' URI parameter is "webpush".
The value of the 'pn-param' URI parameter MUST NOT be used.
The value of the 'pn-prid' URI parameter is the push subscription
URI.
See <a href="./rfc8030">RFC 8030</a> [<a href="./rfc8030" title=""Generic Event Delivery Using HTTP Push"">RFC8030</a>] for more details.
Note that encryption for web push [<a href="./rfc8291" title=""Message Encryption for Web Push"">RFC8291</a>] is not used; therefore,
parameters for message encryption are not defined in this
specification. Web push permits the sending of a push message
without a payload without encryption.
<span class="grey">Holmberg & Arnold Standards Track [Page 31]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-32" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
<span class="h2"><a class="selflink" id="section-13" href="#section-13">13</a>. Security Considerations</span>
The security considerations for the use and operation of any
particular PNS (e.g., how users and devices are authenticated and
authorized) are out of scope for this document. [<a href="./rfc8030" title=""Generic Event Delivery Using HTTP Push"">RFC8030</a>] documents
the security considerations for the PNS defined in that
specification. Security considerations for other PNSs are left to
their respective specifications.
Typically, the PNS requires the SIP proxy requesting push
notifications to be authenticated and authorized by the PNS. In some
cases, the PNS also requires the SIP application (or the SIP
application developer) to be identified in order for the application
to request push notifications. Unless the PNS authenticates and
authorizes the PNS, a malicious endpoint or network entity that
managed to get access to the parameters transported in the SIP
signaling might be able to request that push notifications are sent
to a UA. Such push notifications will impact the battery life of the
UA and trigger unnecessary SIP traffic.
[<a id="ref-RFC8292">RFC8292</a>] defines a mechanism that allows a proxy to identify itself
to a PNS by signing a JSON Web Token (JWT) sent to the PNS using a
key pair. The public key serves as an identifier of the proxy and
can be used by devices to restrict push notifications to the proxy
associated with the key.
Operators MUST ensure that the SIP signaling is properly secured,
e.g., using encryption, from malicious network entities. TLS MUST be
used unless the operators know that the signaling is secured using
some other mechanism that provides strong crypto properties.
In addition to the information that needs to be exchanged between a
device and the PNS in order to establish a push notification
subscription, the mechanism defined in this document does not require
any additional information to be exchanged between the device and the
PNS.
The mechanism defined in this document does not require a proxy to
insert any payload (in addition to possible payload used for the PNS
itself) when requesting push notifications.
Operators MUST ensure that the PNS-related SIP URI parameters
conveyed by a user in the Contact URI of a REGISTER request are not
sent to other users or to non-trusted network entities. One way to
convey contact information is by using the SIP event package for
registrations mechanism [<a href="./rfc3680" title=""A Session Initiation Protocol (SIP) Event Package for Registrations"">RFC3680</a>]. [<a href="./rfc3680" title=""A Session Initiation Protocol (SIP) Event Package for Registrations"">RFC3680</a>] defines generic
security considerations for the SIP event package for registrations.
As the PNS-related SIP URI parameters conveyed in the REGISTER
<span class="grey">Holmberg & Arnold Standards Track [Page 32]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-33" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
request contain sensitive information, operators that support the
event package MUST ensure that event package subscriptions are
properly authenticated and authorized, and that the SIP URI
parameters are not inserted in event notifications sent to other
users or to non-trusted network entities.
<span class="h2"><a class="selflink" id="section-14" href="#section-14">14</a>. IANA Considerations</span>
<span class="h3"><a class="selflink" id="section-14.1" href="#section-14.1">14.1</a>. SIP URI Parameters</span>
This section defines new SIP URI Parameters that extend the "SIP/SIPS
URI Parameters" subregistry [<a href="./rfc3969" title=""The Internet Assigned Number Authority (IANA) Uniform Resource Identifier (URI) Parameter Registry for the Session Initiation Protocol (SIP)"">RFC3969</a>] under the SIP Parameters
registry (<a href="https://www.iana.org/assignments/sip-parameters">https://www.iana.org/assignments/sip-parameters</a>).
<span class="h4"><a class="selflink" id="section-14.1.1" href="#section-14.1.1">14.1.1</a>. pn-provider</span>
Parameter Name: pn-provider
Predefined Values: No
Reference: <a href="./rfc8599">RFC 8599</a>
<span class="h4"><a class="selflink" id="section-14.1.2" href="#section-14.1.2">14.1.2</a>. pn-param</span>
Parameter Name: pn-param
Predefined Values: No
Reference: <a href="./rfc8599">RFC 8599</a>
<span class="h4"><a class="selflink" id="section-14.1.3" href="#section-14.1.3">14.1.3</a>. pn-prid</span>
Parameter Name: pn-prid
Predefined Values: No
Reference: <a href="./rfc8599">RFC 8599</a>
<span class="h4"><a class="selflink" id="section-14.1.4" href="#section-14.1.4">14.1.4</a>. pn-purr</span>
Parameter Name: pn-purr
Predefined Values: No
Reference: <a href="./rfc8599">RFC 8599</a>
<span class="grey">Holmberg & Arnold Standards Track [Page 33]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-34" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
<span class="h3"><a class="selflink" id="section-14.2" href="#section-14.2">14.2</a>. SIP Response Codes</span>
<span class="h4"><a class="selflink" id="section-14.2.1" href="#section-14.2.1">14.2.1</a>. 555 (Push Notification Service Not Supported)</span>
This section defines a new SIP response code that extends the
"Response Codes" subregistry [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>] under the SIP Parameters
registry (<a href="https://www.iana.org/assignments/sip-parameters">https://www.iana.org/assignments/sip-parameters</a>).
Response Code Number: 555
Default Reason Phrase: Push Notification Service Not Supported
<span class="h3"><a class="selflink" id="section-14.3" href="#section-14.3">14.3</a>. SIP Global Feature-Capability Indicator</span>
<span class="h4"><a class="selflink" id="section-14.3.1" href="#section-14.3.1">14.3.1</a>. sip.pns</span>
This section defines a new feature-capability indicator that extends
the "SIP Feature-Capability Indicator Registration Tree" subregistry
[<a href="./rfc6809" title=""Mechanism to Indicate Support of Features and Capabilities in the Session Initiation Protocol (SIP)"">RFC6809</a>] under the SIP Parameters registry
(<a href="https://www.iana.org/assignments/sip-parameters">https://www.iana.org/assignments/sip-parameters</a>).
Name: sip.pns
Description: This feature-capability indicator, when inserted in a
Feature-Caps header field of a SIP REGISTER request or a SIP 2xx
response to a REGISTER request, denotes that the entity
associated with the indicator supports the SIP push mechanism
and the type of push notification service conveyed by the
indicator value.
Reference: <a href="./rfc8599">RFC 8599</a>
Contact: IESG (iesg@ietf.org)
<span class="h4"><a class="selflink" id="section-14.3.2" href="#section-14.3.2">14.3.2</a>. sip.vapid</span>
This section defines a new feature-capability indicator that extends
the "SIP Feature-Capability Indicator Registration Tree" subregistry
[<a href="./rfc6809" title=""Mechanism to Indicate Support of Features and Capabilities in the Session Initiation Protocol (SIP)"">RFC6809</a>] under the SIP Parameters registry
(<a href="https://www.iana.org/assignments/sip-parameters">https://www.iana.org/assignments/sip-parameters</a>).
Name: sip.vapid
Description: This feature-capability indicator, when inserted in a
SIP 2xx response to a SIP REGISTER request, denotes that the
entity associated with the indicator supports the Voluntary
Application Server Identification (VAPID) mechanism when the
entity requests that a push notification be sent to a SIP UA.
<span class="grey">Holmberg & Arnold Standards Track [Page 34]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-35" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
The indicator value is a public key identifying the entity,
which can be used by a SIP UA to restrict subscriptions to
that entity.
Reference: <a href="./rfc8599">RFC 8599</a>
Contact: IESG (iesg@ietf.org)
<span class="h4"><a class="selflink" id="section-14.3.3" href="#section-14.3.3">14.3.3</a>. sip.pnsreg</span>
This section defines a new feature-capability indicator that extends
the "SIP Feature-Capability Indicator Registration Tree" subregistry
[<a href="./rfc6809" title=""Mechanism to Indicate Support of Features and Capabilities in the Session Initiation Protocol (SIP)"">RFC6809</a>] under the SIP Parameters registry
(<a href="https://www.iana.org/assignments/sip-parameters">https://www.iana.org/assignments/sip-parameters</a>).
Name: sip.pnsreg
Description: This feature-capability indicator, when inserted in a
SIP 2xx response to a SIP REGISTER request, denotes that the
entity associated with the indicator expects to receive
binding-refresh REGISTER requests for the binding from the SIP
UA associated with the binding before the binding expires, even
if the entity does not request that a push notification be sent
to the SIP UA in order to trigger the binding-refresh REGISTER
requests. The indicator value conveys the minimum time
(given in seconds) prior to the binding expiration when the UA
MUST send the REGISTER request.
Reference: <a href="./rfc8599">RFC 8599</a>
Contact: IESG (iesg@ietf.org)
<span class="h4"><a class="selflink" id="section-14.3.4" href="#section-14.3.4">14.3.4</a>. sip.pnspurr</span>
This section defines a new feature-capability indicator that extends
the "SIP Feature-Capability Indicator Registration Tree" subregistry
[<a href="./rfc6809" title=""Mechanism to Indicate Support of Features and Capabilities in the Session Initiation Protocol (SIP)"">RFC6809</a>] under the SIP Parameters registry
(<a href="https://www.iana.org/assignments/sip-parameters">https://www.iana.org/assignments/sip-parameters</a>).
Name: sip.pnspurr
Description: This feature-capability indicator, when inserted in a
SIP 2xx response to a SIP REGISTER request, conveys that
the entity associated with the indicator will store information
that can be used to associate a mid-dialog SIP request with the
binding information in the REGISTER request. The indicator
value is an identifier that can be used as a key to retrieve
the binding information.
<span class="grey">Holmberg & Arnold Standards Track [Page 35]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-36" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
Reference: <a href="./rfc8599">RFC 8599</a>
Contact: IESG (iesg@ietf.org)
<span class="h3"><a class="selflink" id="section-14.4" href="#section-14.4">14.4</a>. SIP Media Feature Tag</span>
<span class="h4"><a class="selflink" id="section-14.4.1" href="#section-14.4.1">14.4.1</a>. sip.pnsreg</span>
This section defines a new media feature tag that extends the "SIP
Media Feature Tag Registration Tree" subregistry [<a href="./rfc3840" title=""Indicating User Agent Capabilities in the Session Initiation Protocol (SIP)"">RFC3840</a>] under the
"Media Feature Tags" registry (<a href="https://www.iana.org/assignments/media-feature-tags">https://www.iana.org/assignments/</a>
<a href="https://www.iana.org/assignments/media-feature-tags">media-feature-tags</a>).
Media feature tag name: sip.pnsreg
Summary of the media feature indicated by this feature tag: This
media feature tag, when inserted in the Contact header field
of a SIP REGISTER request, conveys that the SIP UA
associated with the tag is able to send binding-refresh
REGISTER requests associated with the registration without
being awakened by push notifications.
Values appropriate for use with this feature tag: none
Related standards or documents: <a href="./rfc8599">RFC 8599</a>
Security considerations: This media feature tag does not introduce
new security considerations, as it simply indicates support for
a basic SIP feature. If an attacker manages to remove the media
feature tag, push notifications will not be requested to be sent
to the client.
Contact: IESG (iesg@ietf.org)
<span class="h3"><a class="selflink" id="section-14.5" href="#section-14.5">14.5</a>. PNS Subregistry Establishment</span>
This section creates a new subregistry, "PNS", under the SIP
Parameters registry (<a href="https://www.iana.org/assignments/sip-parameters">https://www.iana.org/assignments/</a>
<a href="https://www.iana.org/assignments/sip-parameters">sip-parameters</a>).
The purpose of the subregistry is to register SIP URI 'pn-provider'
values.
When a SIP URI 'pn-provider' value is registered in the subregistry,
it needs to meet the "Specification Required" policies defined in
[<a href="./rfc8126" title="">RFC8126</a>].
<span class="grey">Holmberg & Arnold Standards Track [Page 36]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-37" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
This subregistry is defined as a table that contains the following
three columns:
Value: The token under registration
Description: The name of the Push Notification Service (PNS)
Document: A reference to the document defining the registration
This specification registers the following values:
Value Description Document
------- -------------------------------------- ----------
apns Apple Push Notification service <a href="./rfc8599">RFC 8599</a>
fcm Firebase Cloud Messaging <a href="./rfc8599">RFC 8599</a>
webpush Generic Event Delivery Using HTTP Push <a href="./rfc8599">RFC 8599</a>
<span class="h2"><a class="selflink" id="section-15" href="#section-15">15</a>. References</span>
<span class="h3"><a class="selflink" id="section-15.1" href="#section-15.1">15.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="https://www.rfc-editor.org/info/rfc2119">https://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="https://www.rfc-editor.org/info/rfc3261">https://www.rfc-editor.org/info/rfc3261</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="https://www.rfc-editor.org/info/rfc3840">https://www.rfc-editor.org/info/rfc3840</a>>.
[<a id="ref-RFC3891">RFC3891</a>] Mahy, R., Biggs, B., and R. Dean, "The Session Initiation
Protocol (SIP) "Replaces" Header", <a href="./rfc3891">RFC 3891</a>,
DOI 10.17487/RFC3891, September 2004,
<<a href="https://www.rfc-editor.org/info/rfc3891">https://www.rfc-editor.org/info/rfc3891</a>>.
<span class="grey">Holmberg & Arnold Standards Track [Page 37]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-38" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
[<a id="ref-RFC3969">RFC3969</a>] Camarillo, G., "The Internet Assigned Number Authority
(IANA) Uniform Resource Identifier (URI) Parameter
Registry for the Session Initiation Protocol (SIP)",
<a href="https://www.rfc-editor.org/bcp/bcp99">BCP 99</a>, <a href="./rfc3969">RFC 3969</a>, DOI 10.17487/RFC3969, December 2004,
<<a href="https://www.rfc-editor.org/info/rfc3969">https://www.rfc-editor.org/info/rfc3969</a>>.
[<a id="ref-RFC5079">RFC5079</a>] Rosenberg, J., "Rejecting Anonymous Requests in the
Session Initiation Protocol (SIP)", <a href="./rfc5079">RFC 5079</a>,
DOI 10.17487/RFC5079, December 2007,
<<a href="https://www.rfc-editor.org/info/rfc5079">https://www.rfc-editor.org/info/rfc5079</a>>.
[<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="https://www.rfc-editor.org/info/rfc5234">https://www.rfc-editor.org/info/rfc5234</a>>.
[<a id="ref-RFC6809">RFC6809</a>] Holmberg, C., Sedlacek, I., and H. Kaplan, "Mechanism to
Indicate Support of Features and Capabilities in the
Session Initiation Protocol (SIP)", <a href="./rfc6809">RFC 6809</a>,
DOI 10.17487/RFC6809, November 2012,
<<a href="https://www.rfc-editor.org/info/rfc6809">https://www.rfc-editor.org/info/rfc6809</a>>.
[<a id="ref-RFC8030">RFC8030</a>] Thomson, M., Damaggio, E., and B. Raymor, Ed., "Generic
Event Delivery Using HTTP Push", <a href="./rfc8030">RFC 8030</a>,
DOI 10.17487/RFC8030, December 2016,
<<a href="https://www.rfc-editor.org/info/rfc8030">https://www.rfc-editor.org/info/rfc8030</a>>.
[<a id="ref-RFC8174">RFC8174</a>] Leiba, B., "Ambiguity of Uppercase vs Lowercase in <a href="./rfc2119">RFC</a>
<a href="./rfc2119">2119</a> Key Words", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc8174">RFC 8174</a>, DOI 10.17487/RFC8174,
May 2017, <<a href="https://www.rfc-editor.org/info/rfc8174">https://www.rfc-editor.org/info/rfc8174</a>>.
[<a id="ref-RFC8292">RFC8292</a>] Thomson, M. and P. Beverloo, "Voluntary Application Server
Identification (VAPID) for Web Push", <a href="./rfc8292">RFC 8292</a>,
DOI 10.17487/RFC8292, November 2017,
<<a href="https://www.rfc-editor.org/info/rfc8292">https://www.rfc-editor.org/info/rfc8292</a>>.
[<a id="ref-pns-apns">pns-apns</a>] Apple Inc., "Local and Remote Notification Programming
Guide: Communicating with APNs", <<a href="https://developer.apple.com/library/archive/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html">https://developer.apple.</a>
<a href="https://developer.apple.com/library/archive/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html">com/library/archive/documentation/NetworkingInternet/Conce</a>
<a href="https://developer.apple.com/library/archive/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html">ptual/RemoteNotificationsPG/CommunicatingwithAPNs.html</a>>.
[<a id="ref-pns-fcm">pns-fcm</a>] Google Inc., "Firebase Cloud Messaging",
<<a href="https://firebase.google.com/docs/cloud-messaging/concept-options">https://firebase.google.com/docs/cloud-messaging/</a>
<a href="https://firebase.google.com/docs/cloud-messaging/concept-options">concept-options</a>>.
<span class="grey">Holmberg & Arnold Standards Track [Page 38]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-39" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
<span class="h3"><a class="selflink" id="section-15.2" href="#section-15.2">15.2</a>. Informative References</span>
[<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="https://www.rfc-editor.org/info/rfc3264">https://www.rfc-editor.org/info/rfc3264</a>>.
[<a id="ref-RFC3680">RFC3680</a>] Rosenberg, J., "A Session Initiation Protocol (SIP) Event
Package for Registrations", <a href="./rfc3680">RFC 3680</a>,
DOI 10.17487/RFC3680, March 2004,
<<a href="https://www.rfc-editor.org/info/rfc3680">https://www.rfc-editor.org/info/rfc3680</a>>.
[<a id="ref-RFC4320">RFC4320</a>] Sparks, R., "Actions Addressing Identified Issues with the
Session Initiation Protocol's (SIP) Non-INVITE
Transaction", <a href="./rfc4320">RFC 4320</a>, DOI 10.17487/RFC4320, January
2006, <<a href="https://www.rfc-editor.org/info/rfc4320">https://www.rfc-editor.org/info/rfc4320</a>>.
[<a id="ref-RFC4321">RFC4321</a>] Sparks, R., "Problems Identified Associated with the
Session Initiation Protocol's (SIP) Non-INVITE
Transaction", <a href="./rfc4321">RFC 4321</a>, DOI 10.17487/RFC4321, January
2006, <<a href="https://www.rfc-editor.org/info/rfc4321">https://www.rfc-editor.org/info/rfc4321</a>>.
[<a id="ref-RFC5626">RFC5626</a>] Jennings, C., Ed., Mahy, R., Ed., and F. Audet, Ed.,
"Managing Client-Initiated Connections in the Session
Initiation Protocol (SIP)", <a href="./rfc5626">RFC 5626</a>,
DOI 10.17487/RFC5626, October 2009,
<<a href="https://www.rfc-editor.org/info/rfc5626">https://www.rfc-editor.org/info/rfc5626</a>>.
[<a id="ref-RFC6665">RFC6665</a>] Roach, A., "SIP-Specific Event Notification", <a href="./rfc6665">RFC 6665</a>,
DOI 10.17487/RFC6665, July 2012,
<<a href="https://www.rfc-editor.org/info/rfc6665">https://www.rfc-editor.org/info/rfc6665</a>>.
[<a id="ref-RFC8126">RFC8126</a>] Cotton, M., Leiba, B., and T. Narten, "Guidelines for
Writing an IANA Considerations Section in RFCs", <a href="https://www.rfc-editor.org/bcp/bcp26">BCP 26</a>,
<a href="./rfc8126">RFC 8126</a>, DOI 10.17487/RFC8126, June 2017,
<<a href="https://www.rfc-editor.org/info/rfc8126">https://www.rfc-editor.org/info/rfc8126</a>>.
[<a id="ref-RFC8291">RFC8291</a>] Thomson, M., "Message Encryption for Web Push", <a href="./rfc8291">RFC 8291</a>,
DOI 10.17487/RFC8291, November 2017,
<<a href="https://www.rfc-editor.org/info/rfc8291">https://www.rfc-editor.org/info/rfc8291</a>>.
<span class="grey">Holmberg & Arnold Standards Track [Page 39]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-40" ></span>
<span class="grey"><a href="./rfc8599">RFC 8599</a> SIP PUSH May 2019</span>
Acknowledgements
Thanks to Paul Kyzivat, Dale Worley, Ranjit Avasarala, Martin
Thomson, Mikael Klein, Susanna Sjoholm, Kari-Pekka Perttula, Liviu
Chircu, Roman Shpount, Yehoshua Gev, and Jean Mahoney for reading the
text and providing useful feedback.
Authors' Addresses
Christer Holmberg
Ericsson
Hirsalantie 11
Jorvas 02420
Finland
Email: christer.holmberg@ericsson.com
Michael Arnold
Metaswitch Networks
100 Church Street
Enfield EN2 6BQ
United Kingdom
Email: Michael.Arnold@metaswitch.com
Holmberg & Arnold Standards Track [Page 40]
</pre>
|