1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749
|
<pre>Internet Engineering Task Force (IETF) M. Petit-Huguenin
Request for Comments: 8489 Impedance Mismatch
Obsoletes: <a href="./rfc5389">5389</a> G. Salgueiro
Category: Standards Track Cisco
ISSN: 2070-1721 J. Rosenberg
Five9
D. Wing
Citrix
R. Mahy
Unaffiliated
P. Matthews
Nokia
February 2020
<span class="h1">Session Traversal Utilities for NAT (STUN)</span>
Abstract
Session Traversal Utilities for NAT (STUN) is a protocol that serves
as a tool for other protocols in dealing with NAT traversal. It can
be used by an endpoint to determine the IP address and port allocated
to it by a NAT. It can also be used to check connectivity between
two endpoints and as a keep-alive protocol to maintain NAT bindings.
STUN works with many existing NATs and does not require any special
behavior from them.
STUN is not a NAT traversal solution by itself. Rather, it is a tool
to be used in the context of a NAT traversal solution.
This document obsoletes <a href="./rfc5389">RFC 5389</a>.
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/rfc8489">https://www.rfc-editor.org/info/rfc8489</a>.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
Copyright Notice
Copyright (c) 2020 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>. Overview of Operation ...........................................<a href="#page-5">5</a>
<a href="#section-3">3</a>. Terminology .....................................................<a href="#page-7">7</a>
<a href="#section-4">4</a>. Definitions .....................................................<a href="#page-7">7</a>
<a href="#section-5">5</a>. STUN Message Structure ..........................................<a href="#page-9">9</a>
<a href="#section-6">6</a>. Base Protocol Procedures .......................................<a href="#page-11">11</a>
<a href="#section-6.1">6.1</a>. Forming a Request or an Indication ........................<a href="#page-11">11</a>
<a href="#section-6.2">6.2</a>. Sending the Request or Indication .........................<a href="#page-12">12</a>
<a href="#section-6.2.1">6.2.1</a>. Sending over UDP or DTLS-over-UDP ..................<a href="#page-13">13</a>
<a href="#section-6.2.2">6.2.2</a>. Sending over TCP or TLS-over-TCP ...................<a href="#page-14">14</a>
<a href="#section-6.2.3">6.2.3</a>. Sending over TLS-over-TCP or DTLS-over-UDP .........<a href="#page-15">15</a>
<a href="#section-6.3">6.3</a>. Receiving a STUN Message ..................................<a href="#page-16">16</a>
<a href="#section-6.3.1">6.3.1</a>. Processing a Request ...............................<a href="#page-17">17</a>
<a href="#section-6.3.1.1">6.3.1.1</a>. Forming a Success or Error Response .......<a href="#page-17">17</a>
<a href="#section-6.3.1.2">6.3.1.2</a>. Sending the Success or Error Response .....<a href="#page-18">18</a>
<a href="#section-6.3.2">6.3.2</a>. Processing an Indication ...........................<a href="#page-18">18</a>
<a href="#section-6.3.3">6.3.3</a>. Processing a Success Response ......................<a href="#page-19">19</a>
<a href="#section-6.3.4">6.3.4</a>. Processing an Error Response .......................<a href="#page-19">19</a>
<a href="#section-7">7</a>. FINGERPRINT Mechanism ..........................................<a href="#page-20">20</a>
<a href="#section-8">8</a>. DNS Discovery of a Server ......................................<a href="#page-20">20</a>
<a href="#section-8.1">8.1</a>. STUN URI Scheme Semantics .................................<a href="#page-21">21</a>
<a href="#section-9">9</a>. Authentication and Message-Integrity Mechanisms ................<a href="#page-22">22</a>
<a href="#section-9.1">9.1</a>. Short-Term Credential Mechanism ...........................<a href="#page-23">23</a>
<a href="#section-9.1.1">9.1.1</a>. HMAC Key ...........................................<a href="#page-23">23</a>
<a href="#section-9.1.2">9.1.2</a>. Forming a Request or Indication ....................<a href="#page-23">23</a>
<a href="#section-9.1.3">9.1.3</a>. Receiving a Request or Indication ..................<a href="#page-23">23</a>
<a href="#section-9.1.4">9.1.4</a>. Receiving a Response ...............................<a href="#page-25">25</a>
<a href="#section-9.1.5">9.1.5</a>. Sending Subsequent Requests ........................<a href="#page-25">25</a>
<a href="#section-9.2">9.2</a>. Long-Term Credential Mechanism ............................<a href="#page-26">26</a>
<a href="#section-9.2.1">9.2.1</a>. Bid-Down Attack Prevention .........................<a href="#page-27">27</a>
<a href="#section-9.2.2">9.2.2</a>. HMAC Key ...........................................<a href="#page-27">27</a>
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
<a href="#section-9.2.3">9.2.3</a>. Forming a Request ..................................<a href="#page-28">28</a>
<a href="#section-9.2.3.1">9.2.3.1</a>. First Request .............................<a href="#page-28">28</a>
<a href="#section-9.2.3.2">9.2.3.2</a>. Subsequent Requests .......................<a href="#page-29">29</a>
<a href="#section-9.2.4">9.2.4</a>. Receiving a Request ................................<a href="#page-29">29</a>
<a href="#section-9.2.5">9.2.5</a>. Receiving a Response ...............................<a href="#page-31">31</a>
<a href="#section-10">10</a>. ALTERNATE-SERVER Mechanism ....................................<a href="#page-33">33</a>
<a href="#section-11">11</a>. Backwards Compatibility with <a href="./rfc3489">RFC 3489</a> .........................<a href="#page-34">34</a>
<a href="#section-12">12</a>. Basic Server Behavior .........................................<a href="#page-34">34</a>
<a href="#section-13">13</a>. STUN Usages ...................................................<a href="#page-35">35</a>
<a href="#section-14">14</a>. STUN Attributes ...............................................<a href="#page-36">36</a>
<a href="#section-14.1">14.1</a>. MAPPED-ADDRESS ...........................................<a href="#page-37">37</a>
<a href="#section-14.2">14.2</a>. XOR-MAPPED-ADDRESS .......................................<a href="#page-38">38</a>
<a href="#section-14.3">14.3</a>. USERNAME .................................................<a href="#page-39">39</a>
<a href="#section-14.4">14.4</a>. USERHASH .................................................<a href="#page-40">40</a>
<a href="#section-14.5">14.5</a>. MESSAGE-INTEGRITY ........................................<a href="#page-40">40</a>
<a href="#section-14.6">14.6</a>. MESSAGE-INTEGRITY-SHA256 .................................<a href="#page-41">41</a>
<a href="#section-14.7">14.7</a>. FINGERPRINT ..............................................<a href="#page-41">41</a>
<a href="#section-14.8">14.8</a>. ERROR-CODE ...............................................<a href="#page-42">42</a>
<a href="#section-14.9">14.9</a>. REALM ....................................................<a href="#page-44">44</a>
<a href="#section-14.10">14.10</a>. NONCE ...................................................<a href="#page-44">44</a>
<a href="#section-14.11">14.11</a>. PASSWORD-ALGORITHMS .....................................<a href="#page-44">44</a>
<a href="#section-14.12">14.12</a>. PASSWORD-ALGORITHM ......................................<a href="#page-45">45</a>
<a href="#section-14.13">14.13</a>. UNKNOWN-ATTRIBUTES ......................................<a href="#page-45">45</a>
<a href="#section-14.14">14.14</a>. SOFTWARE ................................................<a href="#page-46">46</a>
<a href="#section-14.15">14.15</a>. ALTERNATE-SERVER ........................................<a href="#page-46">46</a>
<a href="#section-14.16">14.16</a>. ALTERNATE-DOMAIN ........................................<a href="#page-46">46</a>
<a href="#section-15">15</a>. Operational Considerations ....................................<a href="#page-47">47</a>
<a href="#section-16">16</a>. Security Considerations .......................................<a href="#page-47">47</a>
<a href="#section-16.1">16.1</a>. Attacks against the Protocol .............................<a href="#page-47">47</a>
<a href="#section-16.1.1">16.1.1</a>. Outside Attacks ...................................<a href="#page-47">47</a>
<a href="#section-16.1.2">16.1.2</a>. Inside Attacks ....................................<a href="#page-48">48</a>
<a href="#section-16.1.3">16.1.3</a>. Bid-Down Attacks ..................................<a href="#page-48">48</a>
<a href="#section-16.2">16.2</a>. Attacks Affecting the Usage ..............................<a href="#page-50">50</a>
16.2.1. Attack I: Distributed DoS (DDoS) against a
Target ............................................<a href="#page-51">51</a>
<a href="#section-16.2.2">16.2.2</a>. Attack II: Silencing a Client .....................<a href="#page-51">51</a>
<a href="#section-16.2.3">16.2.3</a>. Attack III: Assuming the Identity of a Client .....<a href="#page-52">52</a>
<a href="#section-16.2.4">16.2.4</a>. Attack IV: Eavesdropping ..........................<a href="#page-52">52</a>
<a href="#section-16.3">16.3</a>. Hash Agility Plan ........................................<a href="#page-52">52</a>
<a href="#section-17">17</a>. IAB Considerations ............................................<a href="#page-53">53</a>
<a href="#section-18">18</a>. IANA Considerations ...........................................<a href="#page-53">53</a>
<a href="#section-18.1">18.1</a>. STUN Security Features Registry ..........................<a href="#page-53">53</a>
<a href="#section-18.2">18.2</a>. STUN Methods Registry ....................................<a href="#page-54">54</a>
<a href="#section-18.3">18.3</a>. STUN Attributes Registry .................................<a href="#page-54">54</a>
<a href="#section-18.3.1">18.3.1</a>. Updated Attributes ................................<a href="#page-55">55</a>
<a href="#section-18.3.2">18.3.2</a>. New Attributes ....................................<a href="#page-55">55</a>
<a href="#section-18.4">18.4</a>. STUN Error Codes Registry ................................<a href="#page-56">56</a>
<a href="#section-18.5">18.5</a>. STUN Password Algorithms Registry ........................<a href="#page-56">56</a>
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
<a href="#section-18.5.1">18.5.1</a>. Password Algorithms ...............................<a href="#page-57">57</a>
<a href="#section-18.5.1.1">18.5.1.1</a>. MD5 ......................................<a href="#page-57">57</a>
<a href="#section-18.5.1.2">18.5.1.2</a>. SHA-256 ..................................<a href="#page-57">57</a>
<a href="#section-18.6">18.6</a>. STUN UDP and TCP Port Numbers ............................<a href="#page-57">57</a>
<a href="#section-19">19</a>. Changes since <a href="./rfc5389">RFC 5389</a> ........................................<a href="#page-57">57</a>
<a href="#section-20">20</a>. References ....................................................<a href="#page-58">58</a>
<a href="#section-20.1">20.1</a>. Normative References .....................................<a href="#page-58">58</a>
<a href="#section-20.2">20.2</a>. Informative References ...................................<a href="#page-61">61</a>
<a href="#appendix-A">Appendix A</a>. C Snippet to Determine STUN Message Types ............<a href="#page-64">64</a>
<a href="#appendix-B">Appendix B</a>. Test Vectors .........................................<a href="#page-64">64</a>
B.1. Sample Request with Long-Term Authentication with
MESSAGE-INTEGRITY-SHA256 and USERHASH .....................<a href="#page-65">65</a>
Acknowledgements ..................................................<a href="#page-66">66</a>
Contributors ......................................................<a href="#page-66">66</a>
Authors' Addresses ................................................<a href="#page-67">67</a>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
The protocol defined in this specification, Session Traversal
Utilities for NAT (STUN), provides a tool for dealing with Network
Address Translators (NATs). It provides a means for an endpoint to
determine the IP address and port allocated by a NAT that corresponds
to its private IP address and port. It also provides a way for an
endpoint to keep a NAT binding alive. With some extensions, the
protocol can be used to do connectivity checks between two endpoints
[<a href="./rfc8445" title=""Interactive Connectivity Establishment (ICE): A Protocol for Network Address Translator (NAT) Traversal"">RFC8445</a>] or to relay packets between two endpoints [<a href="./rfc5766" title=""Traversal Using Relays around NAT (TURN): Relay Extensions to Session Traversal Utilities for NAT (STUN)"">RFC5766</a>].
In keeping with its tool nature, this specification defines an
extensible packet format, defines operation over several transport
protocols, and provides for two forms of authentication.
STUN is intended to be used in the context of one or more NAT
traversal solutions. These solutions are known as "STUN Usages".
Each usage describes how STUN is utilized to achieve the NAT
traversal solution. Typically, a usage indicates when STUN messages
get sent, which optional attributes to include, what server is used,
and what authentication mechanism is to be used. Interactive
Connectivity Establishment (ICE) [<a href="./rfc8445" title=""Interactive Connectivity Establishment (ICE): A Protocol for Network Address Translator (NAT) Traversal"">RFC8445</a>] is one usage of STUN. SIP
Outbound [<a href="./rfc5626" title=""Managing Client-Initiated Connections in the Session Initiation Protocol (SIP)"">RFC5626</a>] is another usage of STUN. In some cases, a usage
will require extensions to STUN. A STUN extension can be in the form
of new methods, attributes, or error response codes. More
information on STUN Usages can be found in <a href="#section-13">Section 13</a>.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Overview of Operation</span>
This section is descriptive only.
/-----\
// STUN \\
| Server |
\\ //
\-----/
+--------------+ Public Internet
................| NAT 2 |.......................
+--------------+
+--------------+ Private Network 2
................| NAT 1 |.......................
+--------------+
/-----\
// STUN \\
| Client |
\\ // Private Network 1
\-----/
Figure 1: One Possible STUN Configuration
One possible STUN configuration is shown in Figure 1. In this
configuration, there are two entities (called STUN agents) that
implement the STUN protocol. The lower agent in the figure is the
client, which is connected to private network 1. This network
connects to private network 2 through NAT 1. Private network 2
connects to the public Internet through NAT 2. The upper agent in
the figure is the server, which resides on the public Internet.
STUN is a client-server protocol. It supports two types of
transactions. One is a request/response transaction in which a
client sends a request to a server, and the server returns a
response. The second is an indication transaction in which either
agent -- client or server -- sends an indication that generates no
response. Both types of transactions include a transaction ID, which
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
is a randomly selected 96-bit number. For request/response
transactions, this transaction ID allows the client to associate the
response with the request that generated it; for indications, the
transaction ID serves as a debugging aid.
All STUN messages start with a fixed header that includes a method, a
class, and the transaction ID. The method indicates which of the
various requests or indications this is; this specification defines
just one method, Binding, but other methods are expected to be
defined in other documents. The class indicates whether this is a
request, a success response, an error response, or an indication.
Following the fixed header comes zero or more attributes, which are
Type-Length-Value extensions that convey additional information for
the specific message.
This document defines a single method called "Binding". The Binding
method can be used either in request/response transactions or in
indication transactions. When used in request/response transactions,
the Binding method can be used to determine the particular binding a
NAT has allocated to a STUN client. When used in either request/
response or in indication transactions, the Binding method can also
be used to keep these bindings alive.
In the Binding request/response transaction, a Binding request is
sent from a STUN client to a STUN server. When the Binding request
arrives at the STUN server, it may have passed through one or more
NATs between the STUN client and the STUN server (in Figure 1, there
are two such NATs). As the Binding request message passes through a
NAT, the NAT will modify the source transport address (that is, the
source IP address and the source port) of the packet. As a result,
the source transport address of the request received by the server
will be the public IP address and port created by the NAT closest to
the server. This is called a "reflexive transport address". The
STUN server copies that source transport address into an XOR-MAPPED-
ADDRESS attribute in the STUN Binding response and sends the Binding
response back to the STUN client. As this packet passes back through
a NAT, the NAT will modify the destination transport address in the
IP header, but the transport address in the XOR-MAPPED-ADDRESS
attribute within the body of the STUN response will remain untouched.
In this way, the client can learn its reflexive transport address
allocated by the outermost NAT with respect to the STUN server.
In some usages, STUN must be multiplexed with other protocols (e.g.,
[<a href="./rfc8445" title=""Interactive Connectivity Establishment (ICE): A Protocol for Network Address Translator (NAT) Traversal"">RFC8445</a>] and [<a href="./rfc5626" title=""Managing Client-Initiated Connections in the Session Initiation Protocol (SIP)"">RFC5626</a>]). In these usages, there must be a way to
inspect a packet and determine if it is a STUN packet or not. STUN
provides three fields in the STUN header with fixed values that can
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 6]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
be used for this purpose. If this is not sufficient, then STUN
packets can also contain a FINGERPRINT value, which can further be
used to distinguish the packets.
STUN defines a set of optional procedures that a usage can decide to
use, called "mechanisms". These mechanisms include DNS discovery, a
redirection technique to an alternate server, a fingerprint attribute
for demultiplexing, and two authentication and message-integrity
exchanges. The authentication mechanisms revolve around the use of a
username, password, and message-integrity value. Two authentication
mechanisms, the long-term credential mechanism and the short-term
credential mechanism, are defined in this specification. Each usage
specifies the mechanisms allowed with that usage.
In the long-term credential mechanism, the client and server share a
pre-provisioned username and password and perform a digest challenge/
response exchange inspired by the one defined for HTTP [<a href="./rfc7616" title=""HTTP Digest Access Authentication"">RFC7616</a>] but
differing in details. In the short-term credential mechanism, the
client and the server exchange a username and password through some
out-of-band method prior to the STUN exchange. For example, in the
ICE usage [<a href="./rfc8445" title=""Interactive Connectivity Establishment (ICE): A Protocol for Network Address Translator (NAT) Traversal"">RFC8445</a>], the two endpoints use out-of-band signaling to
exchange a username and password. These are used to integrity
protect and authenticate the request and response. There is no
challenge or nonce used.
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Terminology</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-4" href="#section-4">4</a>. Definitions</span>
STUN Agent: A STUN agent is an entity that implements the STUN
protocol. The entity can be either a STUN client or a STUN
server.
STUN Client: A STUN client is an entity that sends STUN requests and
receives STUN responses and STUN indications. A STUN client can
also send indications. In this specification, the terms "STUN
client" and "client" are synonymous.
STUN Server: A STUN server is an entity that receives STUN requests
and STUN indications and that sends STUN responses. A STUN server
can also send indications. In this specification, the terms "STUN
server" and "server" are synonymous.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 7]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
Transport Address: The combination of an IP address and port number
(such as a UDP or TCP port number).
Reflexive Transport Address: A transport address learned by a client
that identifies that client as seen by another host on an IP
network, typically a STUN server. When there is an intervening
NAT between the client and the other host, the reflexive transport
address represents the mapped address allocated to the client on
the public side of the NAT. Reflexive transport addresses are
learned from the mapped address attribute (MAPPED-ADDRESS or XOR-
MAPPED-ADDRESS) in STUN responses.
Mapped Address: Same meaning as reflexive address. This term is
retained only for historic reasons and due to the naming of the
MAPPED-ADDRESS and XOR-MAPPED-ADDRESS attributes.
Long-Term Credential: A username and associated password that
represent a shared secret between client and server. Long-term
credentials are generally granted to the client when a subscriber
enrolls in a service and persist until the subscriber leaves the
service or explicitly changes the credential.
Long-Term Password: The password from a long-term credential.
Short-Term Credential: A temporary username and associated password
that represent a shared secret between client and server. Short-
term credentials are obtained through some kind of protocol
mechanism between the client and server, preceding the STUN
exchange. A short-term credential has an explicit temporal scope,
which may be based on a specific amount of time (such as 5
minutes) or on an event (such as termination of a Session
Initiation Protocol (SIP) [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>] dialog). The specific scope
of a short-term credential is defined by the application usage.
Short-Term Password: The password component of a short-term
credential.
STUN Indication: A STUN message that does not receive a response.
Attribute: The STUN term for a Type-Length-Value (TLV) object that
can be added to a STUN message. Attributes are divided into two
types: comprehension-required and comprehension-optional. STUN
agents can safely ignore comprehension-optional attributes they
don't understand but cannot successfully process a message if it
contains comprehension-required attributes that are not
understood.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 8]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
RTO: Retransmission TimeOut, which defines the initial period of
time between transmission of a request and the first retransmit of
that request.
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. STUN Message Structure</span>
STUN messages are encoded in binary using network-oriented format
(most significant byte or octet first, also commonly known as big-
endian). The transmission order is described in detail in <a href="./rfc0791#appendix-B">Appendix B
of [RFC0791]</a>. Unless otherwise noted, numeric constants are in
decimal (base 10).
All STUN messages comprise a 20-byte header followed by zero or more
attributes. The STUN header contains a STUN message type, message
length, magic cookie, and transaction ID.
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|0 0| STUN Message Type | Message Length |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Magic Cookie |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| |
| Transaction ID (96 bits) |
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Figure 2: Format of STUN Message Header
The most significant 2 bits of every STUN message MUST be zeroes.
This can be used to differentiate STUN packets from other protocols
when STUN is multiplexed with other protocols on the same port.
The message type defines the message class (request, success
response, error response, or indication) and the message method (the
primary function) of the STUN message. Although there are four
message classes, there are only two types of transactions in STUN:
request/response transactions (which consist of a request message and
a response message) and indication transactions (which consist of a
single indication message). Response classes are split into error
and success responses to aid in quickly processing the STUN message.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 9]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
The STUN Message Type field is decomposed further into the following
structure:
0 1
2 3 4 5 6 7 8 9 0 1 2 3 4 5
+--+--+-+-+-+-+-+-+-+-+-+-+-+-+
|M |M |M|M|M|C|M|M|M|C|M|M|M|M|
|11|10|9|8|7|1|6|5|4|0|3|2|1|0|
+--+--+-+-+-+-+-+-+-+-+-+-+-+-+
Figure 3: Format of STUN Message Type Field
Here the bits in the STUN Message Type field are shown as most
significant (M11) through least significant (M0). M11 through M0
represent a 12-bit encoding of the method. C1 and C0 represent a
2-bit encoding of the class. A class of 0b00 is a request, a class
of 0b01 is an indication, a class of 0b10 is a success response, and
a class of 0b11 is an error response. This specification defines a
single method, Binding. The method and class are orthogonal, so that
for each method, a request, success response, error response, and
indication are possible for that method. Extensions defining new
methods MUST indicate which classes are permitted for that method.
For example, a Binding request has class=0b00 (request) and
method=0b000000000001 (Binding) and is encoded into the first 16 bits
as 0x0001. A Binding response has class=0b10 (success response) and
method=0b000000000001 and is encoded into the first 16 bits as
0x0101.
Note: This unfortunate encoding is due to assignment of values in
[<a href="./rfc3489" title=""STUN - Simple Traversal of User Datagram Protocol (UDP) Through Network Address Translators (NATs)"">RFC3489</a>] that did not consider encoding indication messages,
success responses, and errors responses using bit fields.
The Magic Cookie field MUST contain the fixed value 0x2112A442 in
network byte order. In [<a href="./rfc3489" title=""STUN - Simple Traversal of User Datagram Protocol (UDP) Through Network Address Translators (NATs)"">RFC3489</a>], the 32 bits comprising the Magic
Cookie field were part of the transaction ID; placing the magic
cookie in this location allows a server to detect if the client will
understand certain attributes that were added to STUN by [<a href="./rfc5389" title=""Session Traversal Utilities for NAT (STUN)"">RFC5389</a>].
In addition, it aids in distinguishing STUN packets from packets of
other protocols when STUN is multiplexed with those other protocols
on the same port.
The transaction ID is a 96-bit identifier, used to uniquely identify
STUN transactions. For request/response transactions, the
transaction ID is chosen by the STUN client for the request and
echoed by the server in the response. For indications, it is chosen
by the agent sending the indication. It primarily serves to
correlate requests with responses, though it also plays a small role
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 10]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
in helping to prevent certain types of attacks. The server also uses
the transaction ID as a key to identify each transaction uniquely
across all clients. As such, the transaction ID MUST be uniformly
and randomly chosen from the interval 0 .. 2**96-1 and MUST be
cryptographically random. Resends of the same request reuse the same
transaction ID, but the client MUST choose a new transaction ID for
new transactions unless the new request is bit-wise identical to the
previous request and sent from the same transport address to the same
IP address. Success and error responses MUST carry the same
transaction ID as their corresponding request. When an agent is
acting as a STUN server and STUN client on the same port, the
transaction IDs in requests sent by the agent have no relationship to
the transaction IDs in requests received by the agent.
The message length MUST contain the size of the message in bytes, not
including the 20-byte STUN header. Since all STUN attributes are
padded to a multiple of 4 bytes, the last 2 bits of this field are
always zero. This provides another way to distinguish STUN packets
from packets of other protocols.
Following the STUN fixed portion of the header are zero or more
attributes. Each attribute is TLV (Type-Length-Value) encoded.
Details of the encoding and the attributes themselves are given in
<a href="#section-14">Section 14</a>.
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. Base Protocol Procedures</span>
This section defines the base procedures of the STUN protocol. It
describes how messages are formed, how they are sent, and how they
are processed when they are received. It also defines the detailed
processing of the Binding method. Other sections in this document
describe optional procedures that a usage may elect to use in certain
situations. Other documents may define other extensions to STUN, by
adding new methods, new attributes, or new error response codes.
<span class="h3"><a class="selflink" id="section-6.1" href="#section-6.1">6.1</a>. Forming a Request or an Indication</span>
When formulating a request or indication message, the agent MUST
follow the rules in <a href="#section-5">Section 5</a> when creating the header. In addition,
the message class MUST be either "Request" or "Indication" (as
appropriate), and the method must be either Binding or some method
defined in another document.
The agent then adds any attributes specified by the method or the
usage. For example, some usages may specify that the agent use an
authentication method (<a href="#section-9">Section 9</a>) or the FINGERPRINT attribute
(<a href="#section-7">Section 7</a>).
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 11]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
If the agent is sending a request, it SHOULD add a SOFTWARE attribute
to the request. Agents MAY include a SOFTWARE attribute in
indications, depending on the method. Extensions to STUN should
discuss whether SOFTWARE is useful in new indications. Note that the
inclusion of a SOFTWARE attribute may have security implications; see
<a href="#section-16.1.2">Section 16.1.2</a> for details.
For the Binding method with no authentication, no attributes are
required unless the usage specifies otherwise.
All STUN messages sent over UDP or DTLS-over-UDP [<a href="./rfc6347" title=""Datagram Transport Layer Security Version 1.2"">RFC6347</a>] SHOULD be
less than the path MTU, if known.
If the path MTU is unknown for UDP, messages SHOULD be the smaller of
576 bytes and the first-hop MTU for IPv4 [<a href="./rfc1122" title=""Requirements for Internet Hosts - Communication Layers"">RFC1122</a>] and 1280 bytes for
IPv6 [<a href="./rfc8200" title=""Internet Protocol, Version 6 (IPv6) Specification"">RFC8200</a>]. This value corresponds to the overall size of the IP
packet. Consequently, for IPv4, the actual STUN message would need
to be less than 548 bytes (576 minus 20-byte IP header, minus 8-byte
UDP header, assuming no IP options are used).
If the path MTU is unknown for DTLS-over-UDP, the rules described in
the previous paragraph need to be adjusted to take into account the
size of the (13-byte) DTLS Record header, the Message Authentication
Code (MAC) size, and the padding size.
STUN provides no ability to handle the case where the request is
smaller than the MTU but the response is larger than the MTU. It is
not envisioned that this limitation will be an issue for STUN. The
MTU limitation is a SHOULD, not a MUST, to account for cases where
STUN itself is being used to probe for MTU characteristics [<a href="./rfc5780" title=""NAT Behavior Discovery Using Session Traversal Utilities for NAT (STUN)"">RFC5780</a>].
See also [<a href="#ref-STUN-PMTUD">STUN-PMTUD</a>] for a framework that uses STUN to add Path MTU
Discovery to protocols that lack such a mechanism. Outside of this
or similar applications, the MTU constraint MUST be followed.
<span class="h3"><a class="selflink" id="section-6.2" href="#section-6.2">6.2</a>. Sending the Request or Indication</span>
The agent then sends the request or indication. This document
specifies how to send STUN messages over UDP, TCP, TLS-over-TCP, or
DTLS-over-UDP; other transport protocols may be added in the future.
The STUN Usage must specify which transport protocol is used and how
the agent determines the IP address and port of the recipient.
<a href="#section-8">Section 8</a> describes a DNS-based method of determining the IP address
and port of a server that a usage may elect to use.
At any time, a client MAY have multiple outstanding STUN requests
with the same STUN server (that is, multiple transactions in
progress, with different transaction IDs). Absent other limits to
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 12]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
the rate of new transactions (such as those specified by ICE for
connectivity checks or when STUN is run over TCP), a client SHOULD
limit itself to ten outstanding transactions to the same server.
<span class="h4"><a class="selflink" id="section-6.2.1" href="#section-6.2.1">6.2.1</a>. Sending over UDP or DTLS-over-UDP</span>
When running STUN over UDP or STUN over DTLS-over-UDP [<a href="./rfc7350" title=""Datagram Transport Layer Security (DTLS) as Transport for Session Traversal Utilities for NAT (STUN)"">RFC7350</a>], it
is possible that the STUN message might be dropped by the network.
Reliability of STUN request/response transactions is accomplished
through retransmissions of the request message by the client
application itself. STUN indications are not retransmitted; thus,
indication transactions over UDP or DTLS-over-UDP are not reliable.
A client SHOULD retransmit a STUN request message starting with an
interval of RTO ("Retransmission TimeOut"), doubling after each
retransmission. The RTO is an estimate of the round-trip time (RTT)
and is computed as described in [<a href="./rfc6298" title=""Computing TCP's Retransmission Timer"">RFC6298</a>], with two exceptions.
First, the initial value for RTO SHOULD be greater than or equal to
500 ms. The exception cases for this "SHOULD" are when other
mechanisms are used to derive congestion thresholds (such as the ones
defined in ICE for fixed-rate streams) or when STUN is used in non-
Internet environments with known network capacities. In fixed-line
access links, a value of 500 ms is RECOMMENDED. Second, the value of
RTO SHOULD NOT be rounded up to the nearest second. Rather, a 1 ms
accuracy SHOULD be maintained. As with TCP, the usage of Karn's
algorithm is RECOMMENDED [<a href="#ref-KARN87" title=""Improving Round-Trip Time Estimates in Reliable Transport Protocols"">KARN87</a>]. When applied to STUN, it means
that RTT estimates SHOULD NOT be computed from STUN transactions that
result in the retransmission of a request.
The value for RTO SHOULD be cached by a client after the completion
of the transaction and used as the starting value for RTO for the
next transaction to the same server (based on equality of IP
address). The value SHOULD be considered stale and discarded if no
transactions have occurred to the same server in the last 10 minutes.
Retransmissions continue until a response is received or until a
total of Rc requests have been sent. Rc SHOULD be configurable and
SHOULD have a default of 7. If, after the last request, a duration
equal to Rm times the RTO has passed without a response (providing
ample time to get a response if only this final request actually
succeeds), the client SHOULD consider the transaction to have failed.
Rm SHOULD be configurable and SHOULD have a default of 16. A STUN
transaction over UDP or DTLS-over-UDP is also considered failed if
there has been a hard ICMP error [<a href="./rfc1122" title=""Requirements for Internet Hosts - Communication Layers"">RFC1122</a>]. For example, assuming an
RTO of 500 ms, requests would be sent at times 0 ms, 500 ms, 1500 ms,
3500 ms, 7500 ms, 15500 ms, and 31500 ms. If the client has not
received a response after 39500 ms, the client will consider the
transaction to have timed out.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 13]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
<span class="h4"><a class="selflink" id="section-6.2.2" href="#section-6.2.2">6.2.2</a>. Sending over TCP or TLS-over-TCP</span>
For TCP and TLS-over-TCP [<a href="./rfc8446" title=""The Transport Layer Security (TLS) Protocol Version 1.3"">RFC8446</a>], the client opens a TCP connection
to the server.
In some usages of STUN, STUN is the only protocol over the TCP
connection. In this case, it can be sent without the aid of any
additional framing or demultiplexing. In other usages, or with other
extensions, it may be multiplexed with other data over a TCP
connection. In that case, STUN MUST be run on top of some kind of
framing protocol, specified by the usage or extension, which allows
for the agent to extract complete STUN messages and complete
application-layer messages. The STUN service running on the well-
known port or ports discovered through the DNS procedures in
<a href="#section-8">Section 8</a> is for STUN alone, and not for STUN multiplexed with other
data. Consequently, no framing protocols are used in connections to
those servers. When additional framing is utilized, the usage will
specify how the client knows to apply it and what port to connect to.
For example, in the case of ICE connectivity checks, this information
is learned through out-of-band negotiation between client and server.
Reliability of STUN over TCP and TLS-over-TCP is handled by TCP
itself, and there are no retransmissions at the STUN protocol level.
However, for a request/response transaction, if the client has not
received a response by Ti seconds after it sent the request message,
it considers the transaction to have timed out. Ti SHOULD be
configurable and SHOULD have a default of 39.5 s. This value has
been chosen to equalize the TCP and UDP timeouts for the default
initial RTO.
In addition, if the client is unable to establish the TCP connection,
or the TCP connection is reset or fails before a response is
received, any request/response transaction in progress is considered
to have failed.
The client MAY send multiple transactions over a single TCP (or TLS-
over-TCP) connection, and it MAY send another request before
receiving a response to the previous request. The client SHOULD keep
the connection open until it:
o has no further STUN requests or indications to send over that
connection,
o has no plans to use any resources (such as a mapped address
(MAPPED-ADDRESS or XOR-MAPPED-ADDRESS) or relayed address
[<a href="./rfc5766" title=""Traversal Using Relays around NAT (TURN): Relay Extensions to Session Traversal Utilities for NAT (STUN)"">RFC5766</a>]) that were learned though STUN requests sent over that
connection,
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 14]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
o if multiplexing other application protocols over that port, has
finished using those other protocols,
o if using that learned port with a remote peer, has established
communications with that remote peer, as is required by some TCP
NAT traversal techniques (e.g., [<a href="./rfc6544" title=""TCP Candidates with Interactive Connectivity Establishment (ICE)"">RFC6544</a>]).
The details of an eventual keep-alive mechanism are left to each STUN
Usage. In any case, if a transaction fails because an idle TCP
connection doesn't work anymore, the client SHOULD send a RST and try
to open a new TCP connection.
At the server end, the server SHOULD keep the connection open and let
the client close it, unless the server has determined that the
connection has timed out (for example, due to the client
disconnecting from the network). Bindings learned by the client will
remain valid in intervening NATs only while the connection remains
open. Only the client knows how long it needs the binding. The
server SHOULD NOT close a connection if a request was received over
that connection for which a response was not sent. A server MUST NOT
ever open a connection back towards the client in order to send a
response. Servers SHOULD follow best practices regarding connection
management in cases of overload.
<span class="h4"><a class="selflink" id="section-6.2.3" href="#section-6.2.3">6.2.3</a>. Sending over TLS-over-TCP or DTLS-over-UDP</span>
When STUN is run by itself over TLS-over-TCP or DTLS-over-UDP, the
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 and
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 ciphersuites MUST be
implemented (for compatibility with older versions of this protocol),
except if deprecated by rules of a specific STUN usage. Other
ciphersuites MAY be implemented. Note that STUN clients and servers
that implement TLS version 1.3 [<a href="./rfc8446" title=""The Transport Layer Security (TLS) Protocol Version 1.3"">RFC8446</a>] or subsequent versions are
also required to implement mandatory ciphersuites from those
specifications and SHOULD disable usage of deprecated ciphersuites
when they detect support for those specifications. Perfect Forward
Secrecy (PFS) ciphersuites MUST be preferred over non-PFS
ciphersuites. Ciphersuites with known weaknesses, such as those
based on (single) DES and RC4, MUST NOT be used. Implementations
MUST disable TLS-level compression.
These recommendations are just a part of the recommendations in
[<a href="#ref-BCP195" title=""Recommendations for Secure Use of Transport Layer Security (TLS) and Datagram Transport Layer Security (DTLS)"">BCP195</a>] that implementations and deployments of a STUN Usage using
TLS or DTLS MUST follow.
When it receives the TLS Certificate message, the client MUST verify
the certificate and inspect the site identified by the certificate.
If the certificate is invalid or revoked, or if it does not identify
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 15]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
the appropriate party, the client MUST NOT send the STUN message or
otherwise proceed with the STUN transaction. The client MUST verify
the identity of the server. To do that, it follows the
identification procedures defined in [<a href="./rfc6125" title=""Representation and Verification of Domain-Based Application Service Identity within Internet Public Key Infrastructure Using X.509 (PKIX) Certificates in the Context of Transport Layer Security (TLS)"">RFC6125</a>], with a certificate
containing an identifier of type DNS-ID or CN-ID, optionally with a
wildcard character as the leftmost label, but not of type SRV-ID or
URI-ID.
When STUN is run multiplexed with other protocols over a TLS-over-TCP
connection or a DTLS-over-UDP association, the mandatory ciphersuites
and TLS handling procedures operate as defined by those protocols.
<span class="h3"><a class="selflink" id="section-6.3" href="#section-6.3">6.3</a>. Receiving a STUN Message</span>
This section specifies the processing of a STUN message. The
processing specified here is for STUN messages as defined in this
specification; additional rules for backwards compatibility are
defined in <a href="#section-11">Section 11</a>. Those additional procedures are optional, and
usages can elect to utilize them. First, a set of processing
operations is applied that is independent of the class. This is
followed by class-specific processing, described in the subsections
that follow.
When a STUN agent receives a STUN message, it first checks that the
message obeys the rules of <a href="#section-5">Section 5</a>. It checks that the first two
bits are 0, that the Magic Cookie field has the correct value, that
the message length is sensible, and that the method value is a
supported method. It checks that the message class is allowed for
the particular method. If the message class is "Success Response" or
"Error Response", the agent checks that the transaction ID matches a
transaction that is still in progress. If the FINGERPRINT extension
is being used, the agent checks that the FINGERPRINT attribute is
present and contains the correct value. If any errors are detected,
the message is silently discarded. In the case when STUN is being
multiplexed with another protocol, an error may indicate that this is
not really a STUN message; in this case, the agent should try to
parse the message as a different protocol.
The STUN agent then does any checks that are required by a
authentication mechanism that the usage has specified (see
<a href="#section-9">Section 9</a>).
Once the authentication checks are done, the STUN agent checks for
unknown attributes and known-but-unexpected attributes in the
message. Unknown comprehension-optional attributes MUST be ignored
by the agent. Known-but-unexpected attributes SHOULD be ignored by
the agent. Unknown comprehension-required attributes cause
processing that depends on the message class and is described below.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 16]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
At this point, further processing depends on the message class of the
request.
<span class="h4"><a class="selflink" id="section-6.3.1" href="#section-6.3.1">6.3.1</a>. Processing a Request</span>
If the request contains one or more unknown comprehension-required
attributes, the server replies with an error response with an error
code of 420 (Unknown Attribute) and includes an UNKNOWN-ATTRIBUTES
attribute in the response that lists the unknown comprehension-
required attributes.
Otherwise, the server then does any additional checking that the
method or the specific usage requires. If all the checks succeed,
the server formulates a success response as described below.
When run over UDP or DTLS-over-UDP, a request received by the server
could be the first request of a transaction or could be a
retransmission. The server MUST respond to retransmissions such that
the following property is preserved: if the client receives the
response to the retransmission and not the response that was sent to
the original request, the overall state on the client and server is
identical to the case where only the response to the original
retransmission is received or where both responses are received (in
which case the client will use the first). The easiest way to meet
this requirement is for the server to remember all transaction IDs
received over UDP or DTLS-over-UDP and their corresponding responses
in the last 40 seconds. However, this requires the server to hold
state and is inappropriate for any requests that are not
authenticated. Another way is to reprocess the request and recompute
the response. The latter technique MUST only be applied to requests
that are idempotent (a request is considered idempotent when the same
request can be safely repeated without impacting the overall state of
the system) and result in the same success response for the same
request. The Binding method is considered to be idempotent. Note
that there are certain rare network events that could cause the
reflexive transport address value to change, resulting in a different
mapped address in different success responses. Extensions to STUN
MUST discuss the implications of request retransmissions on servers
that do not store transaction state.
<span class="h5"><a class="selflink" id="section-6.3.1.1" href="#section-6.3.1.1">6.3.1.1</a>. Forming a Success or Error Response</span>
When forming the response (success or error), the server follows the
rules of <a href="#section-6">Section 6</a>. The method of the response is the same as that
of the request, and the message class is either "Success Response" or
"Error Response".
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 17]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
For an error response, the server MUST add an ERROR-CODE attribute
containing the error code specified in the processing above. The
reason phrase is not fixed but SHOULD be something suitable for the
error code. For certain errors, additional attributes are added to
the message. These attributes are spelled out in the description
where the error code is specified. For example, for an error code of
420 (Unknown Attribute), the server MUST include an UNKNOWN-
ATTRIBUTES attribute. Certain authentication errors also cause
attributes to be added (see <a href="#section-9">Section 9</a>). Extensions may define other
errors and/or additional attributes to add in error cases.
If the server authenticated the request using an authentication
mechanism, then the server SHOULD add the appropriate authentication
attributes to the response (see <a href="#section-9">Section 9</a>).
The server also adds any attributes required by the specific method
or usage. In addition, the server SHOULD add a SOFTWARE attribute to
the message.
For the Binding method, no additional checking is required unless the
usage specifies otherwise. When forming the success response, the
server adds an XOR-MAPPED-ADDRESS attribute to the response; this
attribute contains the source transport address of the request
message. For UDP or DTLS-over-UDP, this is the source IP address and
source UDP port of the request message. For TCP and TLS-over-TCP,
this is the source IP address and source TCP port of the TCP
connection as seen by the server.
<span class="h5"><a class="selflink" id="section-6.3.1.2" href="#section-6.3.1.2">6.3.1.2</a>. Sending the Success or Error Response</span>
The response (success or error) is sent over the same transport as
the request was received on. If the request was received over UDP or
DTLS-over-UDP, the destination IP address and port of the response
are the source IP address and port of the received request message,
and the source IP address and port of the response are equal to the
destination IP address and port of the received request message. If
the request was received over TCP or TLS-over-TCP, the response is
sent back on the same TCP connection as the request was received on.
The server is allowed to send responses in a different order than it
received the requests.
<span class="h4"><a class="selflink" id="section-6.3.2" href="#section-6.3.2">6.3.2</a>. Processing an Indication</span>
If the indication contains unknown comprehension-required attributes,
the indication is discarded and processing ceases.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 18]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
Otherwise, the agent then does any additional checking that the
method or the specific usage requires. If all the checks succeed,
the agent then processes the indication. No response is generated
for an indication.
For the Binding method, no additional checking or processing is
required, unless the usage specifies otherwise. The mere receipt of
the message by the agent has refreshed the bindings in the
intervening NATs.
Since indications are not re-transmitted over UDP or DTLS-over-UDP
(unlike requests), there is no need to handle re-transmissions of
indications at the sending agent.
<span class="h4"><a class="selflink" id="section-6.3.3" href="#section-6.3.3">6.3.3</a>. Processing a Success Response</span>
If the success response contains unknown comprehension-required
attributes, the response is discarded and the transaction is
considered to have failed.
Otherwise, the client then does any additional checking that the
method or the specific usage requires. If all the checks succeed,
the client then processes the success response.
For the Binding method, the client checks that the XOR-MAPPED-ADDRESS
attribute is present in the response. The client checks the address
family specified. If it is an unsupported address family, the
attribute SHOULD be ignored. If it is an unexpected but supported
address family (for example, the Binding transaction was sent over
IPv4, but the address family specified is IPv6), then the client MAY
accept and use the value.
<span class="h4"><a class="selflink" id="section-6.3.4" href="#section-6.3.4">6.3.4</a>. Processing an Error Response</span>
If the error response contains unknown comprehension-required
attributes, or if the error response does not contain an ERROR-CODE
attribute, then the transaction is simply considered to have failed.
Otherwise, the client then does any processing specified by the
authentication mechanism (see <a href="#section-9">Section 9</a>). This may result in a new
transaction attempt.
The processing at this point depends on the error code, the method,
and the usage; the following are the default rules:
o If the error code is 300 through 399, the client SHOULD consider
the transaction as failed unless the ALTERNATE-SERVER extension
(<a href="#section-10">Section 10</a>) is being used.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 19]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
o If the error code is 400 through 499, the client declares the
transaction failed; in the case of 420 (Unknown Attribute), the
response should contain a UNKNOWN-ATTRIBUTES attribute that gives
additional information.
o If the error code is 500 through 599, the client MAY resend the
request; clients that do so MUST limit the number of times they do
this. Unless a specific error code specifies a different value,
the number of retransmissions SHOULD be limited to 4.
Any other error code causes the client to consider the transaction
failed.
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. FINGERPRINT Mechanism</span>
This section describes an optional mechanism for STUN that aids in
distinguishing STUN messages from packets of other protocols when the
two are multiplexed on the same transport address. This mechanism is
optional, and a STUN Usage must describe if and when it is used. The
FINGERPRINT mechanism is not backwards compatible with <a href="./rfc3489">RFC 3489</a> and
cannot be used in environments where such compatibility is required.
In some usages, STUN messages are multiplexed on the same transport
address as other protocols, such as the Real-Time Transport Protocol
(RTP). In order to apply the processing described in <a href="#section-6">Section 6</a>, STUN
messages must first be separated from the application packets.
<a href="#section-5">Section 5</a> describes three fixed fields in the STUN header that can be
used for this purpose. However, in some cases, these three fixed
fields may not be sufficient.
When the FINGERPRINT extension is used, an agent includes the
FINGERPRINT attribute in messages it sends to another agent.
<a href="#section-14.7">Section 14.7</a> describes the placement and value of this attribute.
When the agent receives what it believes is a STUN message, then, in
addition to other basic checks, the agent also checks that the
message contains a FINGERPRINT attribute and that the attribute
contains the correct value. <a href="#section-6.3">Section 6.3</a> describes when in the
overall processing of a STUN message the FINGERPRINT check is
performed. This additional check helps the agent detect messages of
other protocols that might otherwise seem to be STUN messages.
<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. DNS Discovery of a Server</span>
This section describes an optional procedure for STUN that allows a
client to use DNS to determine the IP address and port of a server.
A STUN Usage must describe if and when this extension is used. To
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 20]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
use this procedure, the client must know a STUN URI [<a href="./rfc7064" title=""URI Scheme for the Session Traversal Utilities for NAT (STUN) Protocol"">RFC7064</a>]; the
usage must also describe how the client obtains this URI. Hard-
coding a STUN URI into software is NOT RECOMMENDED in case the domain
name is lost or needs to change for legal or other reasons.
When a client wishes to locate a STUN server on the public Internet
that accepts Binding request/response transactions, the STUN URI
scheme is "stun". When it wishes to locate a STUN server that
accepts Binding request/response transactions over a TLS or DTLS
session, the URI scheme is "stuns".
The syntax of the "stun" and "stuns" URIs is defined in <a href="./rfc7064#section-3.1">Section 3.1
of [RFC7064]</a>. STUN Usages MAY define additional URI schemes.
<span class="h3"><a class="selflink" id="section-8.1" href="#section-8.1">8.1</a>. STUN URI Scheme Semantics</span>
If the <host> part of a "stun" URI contains an IP address, then this
IP address is used directly to contact the server. A "stuns" URI
containing an IP address MUST be rejected. A future STUN extension
or usage may relax this requirement, provided it demonstrates how to
authenticate the STUN server and prevent man-in-the-middle attacks.
If the URI does not contain an IP address, the domain name contained
in the <host> part is resolved to a transport address using the SRV
procedures specified in [<a href="./rfc2782" title=""A DNS RR for specifying the location of services (DNS SRV)"">RFC2782</a>]. The DNS SRV service name is the
content of the <scheme> part. The protocol in the SRV lookup is the
transport protocol the client will run STUN over: "udp" for UDP and
"tcp" for TCP.
The procedures of <a href="./rfc2782">RFC 2782</a> are followed to determine the server to
contact. <a href="./rfc2782">RFC 2782</a> spells out the details of how a set of SRV records
is sorted and then tried. However, <a href="./rfc2782">RFC 2782</a> only states that the
client should "try to connect to the (protocol, address, service)"
without giving any details on what happens in the event of failure.
When following these procedures, if the STUN transaction times out
without receipt of a response, the client SHOULD retry the request to
the next server in the order defined by <a href="./rfc2782">RFC 2782</a>. Such a retry is
only possible for request/response transmissions, since indication
transactions generate no response or timeout.
In addition, instead of querying either the A or the AAAA resource
records for a domain name, a dual-stack IPv4/IPv6 client MUST query
both and try the requests with all the IP addresses received, as
specified in [<a href="./rfc8305" title=""Happy Eyeballs Version 2: Better Connectivity Using Concurrency"">RFC8305</a>].
The default port for STUN requests is 3478, for both TCP and UDP.
The default port for STUN over TLS and STUN over DTLS requests is
5349. Servers can run STUN over DTLS on the same port as STUN over
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 21]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
UDP if the server software supports determining whether the initial
message is a DTLS or STUN message. Servers can run STUN over TLS on
the same port as STUN over TCP if the server software supports
determining whether the initial message is a TLS or STUN message.
Administrators of STUN servers SHOULD use these ports in their SRV
records for UDP and TCP. In all cases, the port in DNS MUST reflect
the one on which the server is listening.
If no SRV records are found, the client performs both an A and AAAA
record lookup of the domain name, as described in [<a href="./rfc8305" title=""Happy Eyeballs Version 2: Better Connectivity Using Concurrency"">RFC8305</a>]. The
result will be a list of IP addresses, each of which can be
simultaneously contacted at the default port using UDP or TCP,
independent of the STUN Usage. For usages that require TLS, the
client connects to the IP addresses using the default STUN over TLS
port. For usages that require DTLS, the client connects to the IP
addresses using the default STUN over DTLS port.
<span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. Authentication and Message-Integrity Mechanisms</span>
This section defines two mechanisms for STUN that a client and server
can use to provide authentication and message integrity; these two
mechanisms are known as the short-term credential mechanism and the
long-term credential mechanism. These two mechanisms are optional,
and each usage must specify if and when these mechanisms are used.
Consequently, both clients and servers will know which mechanism (if
any) to follow based on knowledge of which usage applies. For
example, a STUN server on the public Internet supporting ICE would
have no authentication, whereas the STUN server functionality in an
agent supporting connectivity checks would utilize short-term
credentials. An overview of these two mechanisms is given in
<a href="#section-2">Section 2</a>.
Each mechanism specifies the additional processing required to use
that mechanism, extending the processing specified in <a href="#section-6">Section 6</a>. The
additional processing occurs in three different places: when forming
a message, when receiving a message immediately after the basic
checks have been performed, and when doing the detailed processing of
error responses.
Note that agents MUST ignore all attributes that follow MESSAGE-
INTEGRITY, with the exception of the MESSAGE-INTEGRITY-SHA256 and
FINGERPRINT attributes. Similarly, agents MUST ignore all attributes
that follow the MESSAGE-INTEGRITY-SHA256 attribute if the MESSAGE-
INTEGRITY attribute is not present, with the exception of the
FINGERPRINT attribute.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 22]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
<span class="h3"><a class="selflink" id="section-9.1" href="#section-9.1">9.1</a>. Short-Term Credential Mechanism</span>
The short-term credential mechanism assumes that, prior to the STUN
transaction, the client and server have used some other protocol to
exchange a credential in the form of a username and password. This
credential is time-limited. The time limit is defined by the usage.
As an example, in the ICE usage [<a href="./rfc8445" title=""Interactive Connectivity Establishment (ICE): A Protocol for Network Address Translator (NAT) Traversal"">RFC8445</a>], the two endpoints use out-
of-band signaling to agree on a username and password, and this
username and password are applicable for the duration of the media
session.
This credential is used to form a message-integrity check in each
request and in many responses. There is no challenge and response as
in the long-term mechanism; consequently, replay is limited by virtue
of the time-limited nature of the credential.
<span class="h4"><a class="selflink" id="section-9.1.1" href="#section-9.1.1">9.1.1</a>. HMAC Key</span>
For short-term credentials, the Hash-Based Message Authentication
Code (HMAC) key is defined as follow:
key = OpaqueString(password)
where the OpaqueString profile is defined in [<a href="./rfc8265" title=""Preparation, Enforcement, and Comparison of Internationalized Strings Representing Usernames and Passwords"">RFC8265</a>]. The encoding
used is UTF-8 [<a href="./rfc3629" title=""UTF-8, a transformation format of ISO 10646"">RFC3629</a>].
<span class="h4"><a class="selflink" id="section-9.1.2" href="#section-9.1.2">9.1.2</a>. Forming a Request or Indication</span>
For a request or indication message, the agent MUST include the
USERNAME, MESSAGE-INTEGRITY-SHA256, and MESSAGE-INTEGRITY attributes
in the message unless the agent knows from an external mechanism
which message integrity algorithm is supported by both agents. In
this case, either MESSAGE-INTEGRITY or MESSAGE-INTEGRITY-SHA256 MUST
be included in addition to USERNAME. The HMAC for the MESSAGE-
INTEGRITY attribute is computed as described in <a href="#section-14.5">Section 14.5</a>, and the
HMAC for the MESSAGE-INTEGRITY-SHA256 attributes is computed as
described in <a href="#section-14.6">Section 14.6</a>. Note that the password is never included
in the request or indication.
<span class="h4"><a class="selflink" id="section-9.1.3" href="#section-9.1.3">9.1.3</a>. Receiving a Request or Indication</span>
After the agent has done the basic processing of a message, the agent
performs the checks listed below in the order specified:
o If the message does not contain 1) a MESSAGE-INTEGRITY or a
MESSAGE-INTEGRITY-SHA256 attribute and 2) a USERNAME attribute:
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 23]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
* If the message is a request, the server MUST reject the request
with an error response. This response MUST use an error code
of 400 (Bad Request).
* If the message is an indication, the agent MUST silently
discard the indication.
o If the USERNAME does not contain a username value currently valid
within the server:
* If the message is a request, the server MUST reject the request
with an error response. This response MUST use an error code
of 401 (Unauthenticated).
* If the message is an indication, the agent MUST silently
discard the indication.
o If the MESSAGE-INTEGRITY-SHA256 attribute is present, compute the
value for the message integrity as described in <a href="#section-14.6">Section 14.6</a>,
using the password associated with the username. If the MESSAGE-
INTEGRITY-SHA256 attribute is not present, then use the same
password to compute the value for the message integrity as
described in <a href="#section-14.5">Section 14.5</a>. If the resulting value does not match
the contents of the corresponding attribute (MESSAGE-INTEGRITY-
SHA256 or MESSAGE-INTEGRITY):
* If the message is a request, the server MUST reject the request
with an error response. This response MUST use an error code
of 401 (Unauthenticated).
* If the message is an indication, the agent MUST silently
discard the indication.
If these checks pass, the agent continues to process the request or
indication. Any response generated by a server to a request that
contains a MESSAGE-INTEGRITY-SHA256 attribute MUST include the
MESSAGE-INTEGRITY-SHA256 attribute, computed using the password
utilized to authenticate the request. Any response generated by a
server to a request that contains only a MESSAGE-INTEGRITY attribute
MUST include the MESSAGE-INTEGRITY attribute, computed using the
password utilized to authenticate the request. This means that only
one of these attributes can appear in a response. The response MUST
NOT contain the USERNAME attribute.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 24]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
If any of the checks fail, a server MUST NOT include a MESSAGE-
INTEGRITY-SHA256, MESSAGE-INTEGRITY, or USERNAME attribute in the
error response. This is because, in these failure cases, the server
cannot determine the shared secret necessary to compute the MESSAGE-
INTEGRITY-SHA256 or MESSAGE-INTEGRITY attributes.
<span class="h4"><a class="selflink" id="section-9.1.4" href="#section-9.1.4">9.1.4</a>. Receiving a Response</span>
The client looks for the MESSAGE-INTEGRITY or the MESSAGE-INTEGRITY-
SHA256 attribute in the response. If present and if the client only
sent one of the MESSAGE-INTEGRITY or MESSAGE-INTEGRITY-SHA256
attributes in the request (because of the external indication in
<a href="#section-9.1.2">Section 9.1.2</a> or because this is a subsequent request as defined in
<a href="#section-9.1.5">Section 9.1.5</a>), the algorithm in the response has to match;
otherwise, the response MUST be discarded.
The client then computes the message integrity over the response as
defined in <a href="#section-14.5">Section 14.5</a> for the MESSAGE-INTEGRITY attribute or
<a href="#section-14.6">Section 14.6</a> for the MESSAGE-INTEGRITY-SHA256 attribute, using the
same password it utilized for the request. If the resulting value
matches the contents of the MESSAGE-INTEGRITY or MESSAGE-INTEGRITY-
SHA256 attribute, respectively, the response is considered
authenticated. If the value does not match, or if both MESSAGE-
INTEGRITY and MESSAGE-INTEGRITY-SHA256 are absent, the processing
depends on whether the request was sent over a reliable or an
unreliable transport.
If the request was sent over an unreliable transport, the response
MUST be discarded, as if it had never been received. This means that
retransmits, if applicable, will continue. If all the responses
received are discarded, then instead of signaling a timeout after
ending the transaction, the layer MUST signal that the integrity
protection was violated.
If the request was sent over a reliable transport, the response MUST
be discarded, and the layer MUST immediately end the transaction and
signal that the integrity protection was violated.
<span class="h4"><a class="selflink" id="section-9.1.5" href="#section-9.1.5">9.1.5</a>. Sending Subsequent Requests</span>
A client sending subsequent requests to the same server MUST send
only the MESSAGE-INTEGRITY-SHA256 or the MESSAGE-INTEGRITY attribute
that matches the attribute that was received in the response to the
initial request. Here, "same server" means same IP address and port
number, not just the same URI or SRV lookup result.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 25]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
<span class="h3"><a class="selflink" id="section-9.2" href="#section-9.2">9.2</a>. Long-Term Credential Mechanism</span>
The long-term credential mechanism relies on a long-term credential,
in the form of a username and password that are shared between client
and server. The credential is considered long-term since it is
assumed that it is provisioned for a user and remains in effect until
the user is no longer a subscriber of the system or until it is
changed. This is basically a traditional "log-in" username and
password given to users.
Because these usernames and passwords are expected to be valid for
extended periods of time, replay prevention is provided in the form
of a digest challenge. In this mechanism, the client initially sends
a request, without offering any credentials or any integrity checks.
The server rejects this request, providing the user a realm (used to
guide the user or agent in selection of a username and password) and
a nonce. The nonce provides a limited replay protection. It is a
cookie, selected by the server and encoded in such a way as to
indicate a duration of validity or client identity from which it is
valid. Only the server needs to know about the internal structure of
the cookie. The client retries the request, this time including its
username and the realm and echoing the nonce provided by the server.
The client also includes one of the message-integrity attributes
defined in this document, which provides an HMAC over the entire
request, including the nonce. The server validates the nonce and
checks the message integrity. If they match, the request is
authenticated. If the nonce is no longer valid, it is considered
"stale", and the server rejects the request, providing a new nonce.
In subsequent requests to the same server, the client reuses the
nonce, username, realm, and password it used previously. In this
way, subsequent requests are not rejected until the nonce becomes
invalid by the server, in which case the rejection provides a new
nonce to the client.
Note that the long-term credential mechanism cannot be used to
protect indications, since indications cannot be challenged. Usages
utilizing indications must either use a short-term credential or omit
authentication and message integrity for them.
To indicate that it supports this specification, a server MUST
prepend the NONCE attribute value with the character string composed
of "obMatJos2" concatenated with the (4-character) base64 [<a href="./rfc4648" title=""The Base16, Base32, and Base64 Data Encodings"">RFC4648</a>]
encoding of the 24-bit STUN Security Features as defined in
<a href="#section-18.1">Section 18.1</a>. The 24-bit Security Feature set is encoded as 3 bytes,
with bit 0 as the most significant bit of the first byte and bit 23
as the least significant bit of the third byte. If no security
features are used, then a byte array with all 24 bits set to zero
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 26]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
MUST be encoded instead. For the remainder of this document, the
term "nonce cookie" will refer to the complete 13-character string
prepended to the NONCE attribute value.
Since the long-term credential mechanism is susceptible to offline
dictionary attacks, deployments SHOULD utilize passwords that are
difficult to guess. In cases where the credentials are not entered
by the user, but are rather placed on a client device during device
provisioning, the password SHOULD have at least 128 bits of
randomness. In cases where the credentials are entered by the user,
they should follow best current practices around password structure.
<span class="h4"><a class="selflink" id="section-9.2.1" href="#section-9.2.1">9.2.1</a>. Bid-Down Attack Prevention</span>
This document introduces two new security features that provide the
ability to choose the algorithm used for password protection as well
as the ability to use an anonymous username. Both of these
capabilities are optional in order to remain backwards compatible
with previous versions of the STUN protocol.
These new capabilities are subject to bid-down attacks whereby an
attacker in the message path can remove these capabilities and force
weaker security properties. To prevent these kinds of attacks from
going undetected, the nonce is enhanced with additional information.
The value of the "nonce cookie" will vary based on the specific STUN
Security Feature bits selected. When this document makes reference
to the "nonce cookie" in a section discussing a specific STUN
Security Feature it is understood that the corresponding STUN
Security Feature bit in the "nonce cookie" is set to 1.
For example, when the PASSWORD-ALGORITHMS security feature (defined
in <a href="#section-9.2.4">Section 9.2.4</a>) is used, the corresponding "Password algorithms"
bit (defined in <a href="#section-18.1">Section 18.1</a>) is set to 1 in the "nonce cookie".
<span class="h4"><a class="selflink" id="section-9.2.2" href="#section-9.2.2">9.2.2</a>. HMAC Key</span>
For long-term credentials that do not use a different algorithm, as
specified by the PASSWORD-ALGORITHM attribute, the key is 16 bytes:
key = MD5(username ":" OpaqueString(realm)
":" OpaqueString(password))
Where MD5 is defined in [<a href="./rfc1321" title=""The MD5 Message-Digest Algorithm"">RFC1321</a>] and [<a href="./rfc6151" title=""Updated Security Considerations for the MD5 Message-Digest and the HMAC-MD5 Algorithms"">RFC6151</a>], and the OpaqueString
profile is defined in [<a href="./rfc8265" title=""Preparation, Enforcement, and Comparison of Internationalized Strings Representing Usernames and Passwords"">RFC8265</a>]. The encoding used is UTF-8
[<a href="./rfc3629" title=""UTF-8, a transformation format of ISO 10646"">RFC3629</a>].
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 27]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
The 16-byte key is formed by taking the MD5 hash of the result of
concatenating the following five fields: (1) the username, with any
quotes and trailing nulls removed, as taken from the USERNAME
attribute (in which case OpaqueString has already been applied); (2)
a single colon; (3) the realm, with any quotes and trailing nulls
removed and after processing using OpaqueString; (4) a single colon;
and (5) the password, with any trailing nulls removed and after
processing using OpaqueString. For example, if the username is
'user', the realm is 'realm', and the password is 'pass', then the
16-byte HMAC key would be the result of performing an MD5 hash on the
string 'user:realm:pass', the resulting hash being
0x8493fbc53ba582fb4c044c456bdc40eb.
The structure of the key when used with long-term credentials
facilitates deployment in systems that also utilize SIP [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>].
Typically, SIP systems utilizing SIP's digest authentication
mechanism do not actually store the password in the database.
Rather, they store a value called "H(A1)", which is equal to the key
defined above. For example, this mechanism can be used with the
authentication extensions defined in [<a href="./rfc5090" title=""RADIUS Extension for Digest Authentication"">RFC5090</a>].
When a PASSWORD-ALGORITHM is used, the key length and algorithm to
use are described in <a href="#section-18.5.1">Section 18.5.1</a>.
<span class="h4"><a class="selflink" id="section-9.2.3" href="#section-9.2.3">9.2.3</a>. Forming a Request</span>
The first request from the client to the server (as identified by
hostname if the DNS procedures of <a href="#section-8">Section 8</a> are used and by IP
address if not) is handled according to the rules in <a href="#section-9.2.3.1">Section 9.2.3.1</a>.
When the client initiates a subsequent request once a previous
request/response transaction has completed successfully, it follows
the rules in <a href="#section-9.2.3.2">Section 9.2.3.2</a>. Forming a request as a consequence of
a 401 (Unauthenticated) or 438 (Stale Nonce) error response is
covered in <a href="#section-9.2.5">Section 9.2.5</a> and is not considered a "subsequent request"
and thus does not utilize the rules described in <a href="#section-9.2.3.2">Section 9.2.3.2</a>.
Each of these types of requests have a different mandatory
attributes.
<span class="h5"><a class="selflink" id="section-9.2.3.1" href="#section-9.2.3.1">9.2.3.1</a>. First Request</span>
If the client has not completed a successful request/response
transaction with the server, it MUST omit the USERNAME, USERHASH,
MESSAGE-INTEGRITY, MESSAGE-INTEGRITY-SHA256, REALM, NONCE, PASSWORD-
ALGORITHMS, and PASSWORD-ALGORITHM attributes. In other words, the
first request is sent as if there were no authentication or message
integrity applied.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 28]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
<span class="h5"><a class="selflink" id="section-9.2.3.2" href="#section-9.2.3.2">9.2.3.2</a>. Subsequent Requests</span>
Once a request/response transaction has completed, the client will
have been presented a realm and nonce by the server and selected a
username and password with which it authenticated. The client SHOULD
cache the username, password, realm, and nonce for subsequent
communications with the server. When the client sends a subsequent
request, it MUST include either the USERNAME or USERHASH, REALM,
NONCE, and PASSWORD-ALGORITHM attributes with these cached values.
It MUST include a MESSAGE-INTEGRITY attribute or a MESSAGE-INTEGRITY-
SHA256 attribute, computed as described in Sections <a href="#section-14.5">14.5</a> and <a href="#section-14.6">14.6</a>
using the cached password. The choice between the two attributes
depends on the attribute received in the response to the first
request.
<span class="h4"><a class="selflink" id="section-9.2.4" href="#section-9.2.4">9.2.4</a>. Receiving a Request</span>
After the server has done the basic processing of a request, it
performs the checks listed below in the order specified. Note that
it is RECOMMENDED that the REALM value be the domain name of the
provider of the STUN server:
o If the message does not contain a MESSAGE-INTEGRITY or MESSAGE-
INTEGRITY-SHA256 attribute, the server MUST generate an error
response with an error code of 401 (Unauthenticated). This
response MUST include a REALM value. The response MUST include a
NONCE, selected by the server. The server MUST NOT choose the
same NONCE for two requests unless they have the same source IP
address and port. The server MAY support alternate password
algorithms, in which case it can list them in preferential order
in a PASSWORD-ALGORITHMS attribute. If the server adds a
PASSWORD-ALGORITHMS attribute, it MUST set the STUN Security
Feature "Password algorithms" bit to 1. The server MAY support
anonymous username, in which case it MUST set the STUN Security
Feature "Username anonymity" bit set to 1. The response SHOULD
NOT contain a USERNAME, USERHASH, MESSAGE-INTEGRITY, or MESSAGE-
INTEGRITY-SHA256 attribute.
Note: Reusing a NONCE for different source IP addresses or ports
was not explicitly forbidden in [<a href="./rfc5389" title=""Session Traversal Utilities for NAT (STUN)"">RFC5389</a>].
o If the message contains a MESSAGE-INTEGRITY or a MESSAGE-
INTEGRITY-SHA256 attribute, but is missing either the USERNAME or
USERHASH, REALM, or NONCE attribute, the server MUST generate an
error response with an error code of 400 (Bad Request). This
response SHOULD NOT include a USERNAME, USERHASH, NONCE, or REALM
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 29]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
attribute. The response cannot contain a MESSAGE-INTEGRITY or
MESSAGE-INTEGRITY-SHA256 attribute, as the attributes required to
generate them are missing.
o If the NONCE attribute starts with the "nonce cookie" with the
STUN Security Feature "Password algorithms" bit set to 1, the
server performs these checks in the order specified:
* If the request contains neither the PASSWORD-ALGORITHMS nor the
PASSWORD-ALGORITHM algorithm, then the request is processed as
though PASSWORD-ALGORITHM were MD5.
* Otherwise, unless (1) PASSWORD-ALGORITHM and PASSWORD-
ALGORITHMS are both present, (2) PASSWORD-ALGORITHMS matches
the value sent in the response that sent this NONCE, and (3)
PASSWORD-ALGORITHM matches one of the entries in PASSWORD-
ALGORITHMS, the server MUST generate an error response with an
error code of 400 (Bad Request).
o If the value of the USERNAME or USERHASH attribute is not valid,
the server MUST generate an error response with an error code of
401 (Unauthenticated). This response MUST include a REALM value.
The response MUST include a NONCE, selected by the server. The
response MUST include a PASSWORD-ALGORITHMS attribute. The
response SHOULD NOT contain a USERNAME or USERHASH attribute. The
response MAY include a MESSAGE-INTEGRITY or MESSAGE-INTEGRITY-
SHA256 attribute, using the previous key to calculate it.
o If the MESSAGE-INTEGRITY-SHA256 attribute is present, compute the
value for the message integrity as described in <a href="#section-14.6">Section 14.6</a>,
using the password associated with the username. Otherwise, using
the same password, compute the value for the MESSAGE-INTEGRITY
attribute as described in <a href="#section-14.5">Section 14.5</a>. If the resulting value
does not match the contents of the MESSAGE-INTEGRITY attribute or
the MESSAGE-INTEGRITY-SHA256 attribute, the server MUST reject the
request with an error response. This response MUST use an error
code of 401 (Unauthenticated). It MUST include the REALM and
NONCE attributes and SHOULD NOT include the USERNAME, USERHASH,
MESSAGE-INTEGRITY, or MESSAGE-INTEGRITY-SHA256 attribute.
o If the NONCE is no longer valid, the server MUST generate an error
response with an error code of 438 (Stale Nonce). This response
MUST include NONCE, REALM, and PASSWORD-ALGORITHMS attributes and
SHOULD NOT include the USERNAME and USERHASH attributes. The
NONCE attribute value MUST be valid. The response MAY include a
MESSAGE-INTEGRITY or MESSAGE-INTEGRITY-SHA256 attribute, using the
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 30]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-31" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
previous NONCE to calculate it. Servers can revoke nonces in
order to provide additional security. See <a href="./rfc7616#section-5.4">Section 5.4 of
[RFC7616]</a> for guidelines.
If these checks pass, the server continues to process the request.
Any response generated by the server MUST include the MESSAGE-
INTEGRITY-SHA256 attribute, computed using the username and password
utilized to authenticate the request, unless the request was
processed as though PASSWORD-ALGORITHM was MD5 (because the request
contained neither PASSWORD-ALGORITHMS nor PASSWORD-ALGORITHM). In
that case, the MESSAGE-INTEGRITY attribute MUST be used instead of
the MESSAGE-INTEGRITY-SHA256 attribute, and the REALM, NONCE,
USERNAME, and USERHASH attributes SHOULD NOT be included.
<span class="h4"><a class="selflink" id="section-9.2.5" href="#section-9.2.5">9.2.5</a>. Receiving a Response</span>
If the response is an error response with an error code of 401
(Unauthenticated) or 438 (Stale Nonce), the client MUST test if the
NONCE attribute value starts with the "nonce cookie". If so and the
"nonce cookie" has the STUN Security Feature "Password algorithms"
bit set to 1 but no PASSWORD-ALGORITHMS attribute is present, then
the client MUST NOT retry the request with a new transaction.
If the response is an error response with an error code of 401
(Unauthenticated), the client SHOULD retry the request with a new
transaction. This request MUST contain a USERNAME or a USERHASH,
determined by the client as the appropriate username for the REALM
from the error response. If the "nonce cookie" is present and has
the STUN Security Feature "Username anonymity" bit set to 1, then the
USERHASH attribute MUST be used; else, the USERNAME attribute MUST be
used. The request MUST contain the REALM, copied from the error
response. The request MUST contain the NONCE, copied from the error
response. If the response contains a PASSWORD-ALGORITHMS attribute,
the request MUST contain the PASSWORD-ALGORITHMS attribute with the
same content. If the response contains a PASSWORD-ALGORITHMS
attribute, and this attribute contains at least one algorithm that is
supported by the client, then the request MUST contain a PASSWORD-
ALGORITHM attribute with the first algorithm supported on the list.
If the response contains a PASSWORD-ALGORITHMS attribute, and this
attribute does not contain any algorithm that is supported by the
client, then the client MUST NOT retry the request with a new
transaction. The client MUST NOT perform this retry if it is not
changing the USERNAME, USERHASH, REALM, or its associated password
from the previous attempt.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 31]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-32" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
If the response is an error response with an error code of 438 (Stale
Nonce), the client MUST retry the request, using the new NONCE
attribute supplied in the 438 (Stale Nonce) response. This retry
MUST also include either the USERNAME or USERHASH, the REALM, and
either the MESSAGE-INTEGRITY or MESSAGE-INTEGRITY-SHA256 attribute.
For all other responses, if the NONCE attribute starts with the
"nonce cookie" with the STUN Security Feature "Password algorithms"
bit set to 1 but PASSWORD-ALGORITHMS is not present, the response
MUST be ignored.
If the response is an error response with an error code of 400 (Bad
Request) and does not contain either the MESSAGE-INTEGRITY or
MESSAGE-INTEGRITY-SHA256 attribute, then the response MUST be
discarded, as if it were never received. This means that
retransmits, if applicable, will continue.
Note: In this case, the 400 response will never reach the
application, resulting in a timeout.
The client looks for the MESSAGE-INTEGRITY or MESSAGE-INTEGRITY-
SHA256 attribute in the response (either success or failure). If
present, the client computes the message integrity over the response
as defined in Sections <a href="#section-14.5">14.5</a> or <a href="#section-14.6">14.6</a>, using the same password it
utilized for the request. If the resulting value matches the
contents of the MESSAGE-INTEGRITY or MESSAGE-INTEGRITY-SHA256
attribute, the response is considered authenticated. If the value
does not match, or if both MESSAGE-INTEGRITY and MESSAGE-INTEGRITY-
SHA256 are absent, the processing depends on the request being sent
over a reliable or an unreliable transport.
If the request was sent over an unreliable transport, the response
MUST be discarded, as if it had never been received. This means that
retransmits, if applicable, will continue. If all the responses
received are discarded, then instead of signaling a timeout after
ending the transaction, the layer MUST signal that the integrity
protection was violated.
If the request was sent over a reliable transport, the response MUST
be discarded, and the layer MUST immediately end the transaction and
signal that the integrity protection was violated.
If the response contains a PASSWORD-ALGORITHMS attribute, all the
subsequent requests MUST be authenticated using MESSAGE-INTEGRITY-
SHA256 only.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 32]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-33" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
<span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>. ALTERNATE-SERVER Mechanism</span>
This section describes a mechanism in STUN that allows a server to
redirect a client to another server. This extension is optional, and
a usage must define if and when this extension is used. The
ALTERNATE-SERVER attribute carries an IP address.
A server using this extension redirects a client to another server by
replying to a request message with an error response message with an
error code of 300 (Try Alternate). The server MUST include at least
one ALTERNATE-SERVER attribute in the error response, which MUST
contain an IP address of the same address family as the source IP
address of the request message. The server SHOULD include an
additional ALTERNATE-SERVER attribute, after the mandatory one, that
contains an IP address of the address family other than the source IP
address of the request message. The error response message MAY be
authenticated; however, there are use cases for ALTERNATE-SERVER
where authentication of the response is not possible or practical.
If the transaction uses TLS or DTLS, if the transaction is
authenticated by a MESSAGE-INTEGRITY-SHA256 attribute, and if the
server wants to redirect to a server that uses a different
certificate, then it MUST include an ALTERNATE-DOMAIN attribute
containing the name inside the subjectAltName of that certificate.
This series of conditions on the MESSAGE-INTEGRITY-SHA256 attribute
indicates that the transaction is authenticated and that the client
implements this specification and therefore can process the
ALTERNATE-DOMAIN attribute.
A client using this extension handles a 300 (Try Alternate) error
code as follows. The client looks for an ALTERNATE-SERVER attribute
in the error response. If one is found, then the client considers
the current transaction as failed and reattempts the request with the
server specified in the attribute, using the same transport protocol
used for the previous request. That request, if authenticated, MUST
utilize the same credentials that the client would have used in the
request to the server that performed the redirection. If the
transport protocol uses TLS or DTLS, then the client looks for an
ALTERNATE-DOMAIN attribute. If the attribute is found, the domain
MUST be used to validate the certificate using the recommendations in
[<a href="./rfc6125" title=""Representation and Verification of Domain-Based Application Service Identity within Internet Public Key Infrastructure Using X.509 (PKIX) Certificates in the Context of Transport Layer Security (TLS)"">RFC6125</a>]. The certificate MUST contain an identifier of type DNS-ID
or CN-ID (eventually with wildcards) but not of type SRV-ID or URI-
ID. If the attribute is not found, the same domain that was used for
the original request MUST be used to validate the certificate. If
the client has been redirected to a server to which it has already
sent this request within the last five minutes, it MUST ignore the
redirection and consider the transaction to have failed. This
prevents infinite ping-ponging between servers in case of redirection
loops.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 33]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-34" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
<span class="h2"><a class="selflink" id="section-11" href="#section-11">11</a>. Backwards Compatibility with <a href="./rfc3489">RFC 3489</a></span>
In addition to the backward compatibility already described in
<a href="./rfc5389#section-12">Section 12 of [RFC5389]</a>, DTLS MUST NOT be used with [<a href="./rfc3489" title=""STUN - Simple Traversal of User Datagram Protocol (UDP) Through Network Address Translators (NATs)"">RFC3489</a>]
(referred to as "classic STUN"). Any STUN request or indication
without the magic cookie (see <a href="./rfc5389#section-6">Section 6 of [RFC5389]</a>) over DTLS MUST
be considered invalid: all requests MUST generate a 500 (Server
Error) error response, and indications MUST be ignored.
<span class="h2"><a class="selflink" id="section-12" href="#section-12">12</a>. Basic Server Behavior</span>
This section defines the behavior of a basic, stand-alone STUN
server.
Historically, "classic STUN" [<a href="./rfc3489" title=""STUN - Simple Traversal of User Datagram Protocol (UDP) Through Network Address Translators (NATs)"">RFC3489</a>] only defined the behavior of a
server that was providing clients with server reflexive transport
addresses by receiving and replying to STUN Binding requests.
[<a href="./rfc5389" title=""Session Traversal Utilities for NAT (STUN)"">RFC5389</a>] redefined the protocol as an extensible framework, and the
server functionality became the sole STUN Usage defined in that
document. This STUN Usage is also known as "Basic STUN Server".
The STUN server MUST support the Binding method. It SHOULD NOT
utilize the short-term or long-term credential mechanism. This is
because the work involved in authenticating the request is more than
the work in simply processing it. It SHOULD NOT utilize the
ALTERNATE-SERVER mechanism for the same reason. It MUST support UDP
and TCP. It MAY support STUN over TCP/TLS or STUN over UDP/DTLS;
however, DTLS and TLS provide minimal security benefits in this basic
mode of operation. It does not require a keep-alive mechanism
because a TCP or TLS-over-TCP connection is closed after the end of
the Binding transaction. It MAY utilize the FINGERPRINT mechanism
but MUST NOT require it. Since the stand-alone server only runs
STUN, FINGERPRINT provides no benefit. Requiring it would break
compatibility with <a href="./rfc3489">RFC 3489</a>, and such compatibility is desirable in a
stand-alone server. Stand-alone STUN servers SHOULD support
backwards compatibility with clients using [<a href="./rfc3489" title=""STUN - Simple Traversal of User Datagram Protocol (UDP) Through Network Address Translators (NATs)"">RFC3489</a>], as described in
<a href="#section-11">Section 11</a>.
It is RECOMMENDED that administrators of STUN servers provide DNS
entries for those servers as described in <a href="#section-8">Section 8</a>. If both A and
AAAA resource records are returned, then the client can
simultaneously send STUN Binding requests to the IPv4 and IPv6
addresses (as specified in [<a href="./rfc8305" title=""Happy Eyeballs Version 2: Better Connectivity Using Concurrency"">RFC8305</a>]), as the Binding request is
idempotent. Note that the MAPPED-ADDRESS or XOR-MAPPED-ADDRESS
attributes that are returned will not necessarily match the address
family of the server address used.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 34]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-35" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
A basic STUN server is not a solution for NAT traversal by itself.
However, it can be utilized as part of a solution through STUN
Usages. This is discussed further in <a href="#section-13">Section 13</a>.
<span class="h2"><a class="selflink" id="section-13" href="#section-13">13</a>. STUN Usages</span>
STUN by itself is not a solution to the NAT traversal problem.
Rather, STUN defines a tool that can be used inside a larger
solution. The term "STUN Usage" is used for any solution that uses
STUN as a component.
A STUN Usage defines how STUN is actually utilized -- when to send
requests, what to do with the responses, and which optional
procedures defined here (or in an extension to STUN) are to be used.
A usage also defines:
o Which STUN methods are used.
o What transports are used. If DTLS-over-UDP is used, then
implementing the denial-of-service countermeasure described in
<a href="./rfc6347#section-4.2.1">Section 4.2.1 of [RFC6347]</a> is mandatory.
o What authentication and message-integrity mechanisms are used.
o The considerations around manual vs. automatic key derivation for
the integrity mechanism, as discussed in [<a href="./rfc4107" title=""Guidelines for Cryptographic Key Management"">RFC4107</a>].
o What mechanisms are used to distinguish STUN messages from other
messages. When STUN is run over TCP or TLS-over-TCP, a framing
mechanism may be required.
o How a STUN client determines the IP address and port of the STUN
server.
o How simultaneous use of IPv4 and IPv6 addresses (Happy Eyeballs
[<a href="./rfc8305" title=""Happy Eyeballs Version 2: Better Connectivity Using Concurrency"">RFC8305</a>]) works with non-idempotent transactions when both
address families are found for the STUN server.
o Whether backwards compatibility to <a href="./rfc3489">RFC 3489</a> is required.
o What optional attributes defined here (such as FINGERPRINT and
ALTERNATE-SERVER) or in other extensions are required.
o If MESSAGE-INTEGRITY-SHA256 truncation is permitted, and the
limits permitted for truncation.
o The keep-alive mechanism if STUN is run over TCP or TLS-over-TCP.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 35]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-36" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
o If anycast addresses can be used for the server in case 1) TCP or
TLS-over-TCP or 2) authentication is used.
In addition, any STUN Usage must consider the security implications
of using STUN in that usage. A number of attacks against STUN are
known (see the Security Considerations section in this document), and
any usage must consider how these attacks can be thwarted or
mitigated.
Finally, a usage must consider whether its usage of STUN is an
example of the Unilateral Self-Address Fixing approach to NAT
traversal and, if so, address the questions raised in <a href="./rfc3424">RFC 3424</a>
[<a href="./rfc3424" title=""IAB Considerations for UNilateral Self-Address Fixing (UNSAF) Across Network Address Translation"">RFC3424</a>].
<span class="h2"><a class="selflink" id="section-14" href="#section-14">14</a>. STUN Attributes</span>
After the STUN header are zero or more attributes. Each attribute
MUST be TLV encoded, with a 16-bit type, 16-bit length, and value.
Each STUN attribute MUST end on a 32-bit boundary. As mentioned
above, all fields in an attribute are transmitted most significant
bit first.
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Type | Length |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Value (variable) ....
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Figure 4: Format of STUN Attributes
The value in the Length field MUST contain the length of the Value
part of the attribute, prior to padding, measured in bytes. Since
STUN aligns attributes on 32-bit boundaries, attributes whose content
is not a multiple of 4 bytes are padded with 1, 2, or 3 bytes of
padding so that its value contains a multiple of 4 bytes. The
padding bits MUST be set to zero on sending and MUST be ignored by
the receiver.
Any attribute type MAY appear more than once in a STUN message.
Unless specified otherwise, the order of appearance is significant:
only the first occurrence needs to be processed by a receiver, and
any duplicates MAY be ignored by a receiver.
To allow future revisions of this specification to add new attributes
if needed, the attribute space is divided into two ranges.
Attributes with type values between 0x0000 and 0x7FFF are
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 36]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-37" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
comprehension-required attributes, which means that the STUN agent
cannot successfully process the message unless it understands the
attribute. Attributes with type values between 0x8000 and 0xFFFF are
comprehension-optional attributes, which means that those attributes
can be ignored by the STUN agent if it does not understand them.
The set of STUN attribute types is maintained by IANA. The initial
set defined by this specification is found in <a href="#section-18.3">Section 18.3</a>.
The rest of this section describes the format of the various
attributes defined in this specification.
<span class="h3"><a class="selflink" id="section-14.1" href="#section-14.1">14.1</a>. MAPPED-ADDRESS</span>
The MAPPED-ADDRESS attribute indicates a reflexive transport address
of the client. It consists of an 8-bit address family and a 16-bit
port, followed by a fixed-length value representing the IP address.
If the address family is IPv4, the address MUST be 32 bits. If the
address family is IPv6, the address MUST be 128 bits. All fields
must be in network byte order.
The format of the MAPPED-ADDRESS attribute is:
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|0 0 0 0 0 0 0 0| Family | Port |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| |
| Address (32 bits or 128 bits) |
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Figure 5: Format of MAPPED-ADDRESS Attribute
The address family can take on the following values:
0x01:IPv4
0x02:IPv6
The first 8 bits of the MAPPED-ADDRESS MUST be set to 0 and MUST be
ignored by receivers. These bits are present for aligning parameters
on natural 32-bit boundaries.
This attribute is used only by servers for achieving backwards
compatibility with [<a href="./rfc3489" title=""STUN - Simple Traversal of User Datagram Protocol (UDP) Through Network Address Translators (NATs)"">RFC3489</a>] clients.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 37]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-38" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
<span class="h3"><a class="selflink" id="section-14.2" href="#section-14.2">14.2</a>. XOR-MAPPED-ADDRESS</span>
The XOR-MAPPED-ADDRESS attribute is identical to the MAPPED-ADDRESS
attribute, except that the reflexive transport address is obfuscated
through the XOR function.
The format of the XOR-MAPPED-ADDRESS is:
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|0 0 0 0 0 0 0 0| Family | X-Port |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| X-Address (Variable)
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Figure 6: Format of XOR-MAPPED-ADDRESS Attribute
The Family field represents the IP address family and is encoded
identically to the Family field in MAPPED-ADDRESS.
X-Port is computed by XOR'ing the mapped port with the most
significant 16 bits of the magic cookie. If the IP address family is
IPv4, X-Address is computed by XOR'ing the mapped IP address with the
magic cookie. If the IP address family is IPv6, X-Address is
computed by XOR'ing the mapped IP address with the concatenation of
the magic cookie and the 96-bit transaction ID. In all cases, the
XOR operation works on its inputs in network byte order (that is, the
order they will be encoded in the message).
The rules for encoding and processing the first 8 bits of the
attribute's value, the rules for handling multiple occurrences of the
attribute, and the rules for processing address families are the same
as for MAPPED-ADDRESS.
Note: XOR-MAPPED-ADDRESS and MAPPED-ADDRESS differ only in their
encoding of the transport address. The former encodes the transport
address by XOR'ing it with the magic cookie. The latter encodes it
directly in binary. <a href="./rfc3489">RFC 3489</a> originally specified only MAPPED-
ADDRESS. However, deployment experience found that some NATs rewrite
the 32-bit binary payloads containing the NAT's public IP address,
such as STUN's MAPPED-ADDRESS attribute, in the well-meaning but
misguided attempt to provide a generic Application Layer Gateway
(ALG) function. Such behavior interferes with the operation of STUN
and also causes failure of STUN's message-integrity checking.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 38]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-39" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
<span class="h3"><a class="selflink" id="section-14.3" href="#section-14.3">14.3</a>. USERNAME</span>
The USERNAME attribute is used for message integrity. It identifies
the username and password combination used in the message-integrity
check.
The value of USERNAME is a variable-length value containing the
authentication username. It MUST contain a UTF-8-encoded [<a href="./rfc3629" title=""UTF-8, a transformation format of ISO 10646"">RFC3629</a>]
sequence of fewer than 509 bytes and MUST have been processed using
the OpaqueString profile [<a href="./rfc8265" title=""Preparation, Enforcement, and Comparison of Internationalized Strings Representing Usernames and Passwords"">RFC8265</a>]. A compliant implementation MUST
be able to parse a UTF-8-encoded sequence of 763 or fewer octets to
be compatible with [<a href="./rfc5389" title=""Session Traversal Utilities for NAT (STUN)"">RFC5389</a>].
Note: [<a href="./rfc5389" title=""Session Traversal Utilities for NAT (STUN)"">RFC5389</a>] mistakenly referenced the definition of UTF-8 in
[<a href="./rfc2279" title=""UTF-8, a transformation format of ISO 10646"">RFC2279</a>]. [<a href="./rfc2279" title=""UTF-8, a transformation format of ISO 10646"">RFC2279</a>] assumed up to 6 octets per characters
encoded. [<a href="./rfc2279" title=""UTF-8, a transformation format of ISO 10646"">RFC2279</a>] was replaced by [<a href="./rfc3629" title=""UTF-8, a transformation format of ISO 10646"">RFC3629</a>], which allows only 4
octets per character encoded, consistent with changes made in
Unicode 2.0 and ISO/IEC 10646.
Note: This specification uses the OpaqueString profile instead of
the UsernameCasePreserved profile for username string processing
in order to improve compatibility with deployed password stores.
Many password databases used for HTTP and SIP Digest
authentication store the MD5 hash of username:realm:password
instead of storing a plain text password. In [<a href="./rfc3489" title=""STUN - Simple Traversal of User Datagram Protocol (UDP) Through Network Address Translators (NATs)"">RFC3489</a>], STUN
authentication was designed to be compatible with these existing
databases to the extent possible, which like SIP and HTTP
performed no pre-processing of usernames and passwords other than
prohibiting non-space ASCII control characters. The next revision
of the STUN specification, [<a href="./rfc5389" title=""Session Traversal Utilities for NAT (STUN)"">RFC5389</a>], used the SASLprep [<a href="./rfc4013" title=""SASLprep: Stringprep Profile for User Names and Passwords"">RFC4013</a>]
stringprep [<a href="./rfc3454" title=""Preparation of Internationalized Strings ("">RFC3454</a>] profile to pre-process usernames and
passwords. SASLprep uses Unicode Normalization Form KC
(Compatibility Decomposition, followed by Canonical Composition)
[<a href="#ref-UAX15" title=""Unicode Normalization Forms"">UAX15</a>] and prohibits various control, space, and non-text,
deprecated, or inappropriate codepoints. The PRECIS framework
[<a href="./rfc8264" title=""PRECIS Framework: Preparation, Enforcement, and Comparison of Internationalized Strings in Application Protocols"">RFC8264</a>] obsoletes stringprep. PRECIS handling of usernames and
passwords [<a href="./rfc8265" title=""Preparation, Enforcement, and Comparison of Internationalized Strings Representing Usernames and Passwords"">RFC8265</a>] uses Unicode Normalization Form C (Canonical
Decomposition, followed by Canonical Composition). While there
are specific cases where different username strings under HTTP
Digest could be mapped to a single STUN username processed with
OpaqueString, these cases are extremely unlikely and easy to
detect and correct. With a UsernameCasePreserved profile, it
would be more likely that valid usernames under HTTP Digest would
not match their processed forms (specifically usernames containing
bidirectional text and compatibility forms). Operators are free
to further restrict the allowed codepoints in usernames to avoid
problematic characters.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 39]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-40" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
<span class="h3"><a class="selflink" id="section-14.4" href="#section-14.4">14.4</a>. USERHASH</span>
The USERHASH attribute is used as a replacement for the USERNAME
attribute when username anonymity is supported.
The value of USERHASH has a fixed length of 32 bytes. The username
MUST have been processed using the OpaqueString profile [<a href="./rfc8265" title=""Preparation, Enforcement, and Comparison of Internationalized Strings Representing Usernames and Passwords"">RFC8265</a>],
and the realm MUST have been processed using the OpaqueString profile
[<a href="./rfc8265" title=""Preparation, Enforcement, and Comparison of Internationalized Strings Representing Usernames and Passwords"">RFC8265</a>] before hashing.
The following is the operation that the client will perform to hash
the username:
userhash = SHA-256(OpaqueString(username) ":" OpaqueString(realm))
<span class="h3"><a class="selflink" id="section-14.5" href="#section-14.5">14.5</a>. MESSAGE-INTEGRITY</span>
The MESSAGE-INTEGRITY attribute contains an HMAC-SHA1 [<a href="./rfc2104" title=""HMAC: Keyed- Hashing for Message Authentication"">RFC2104</a>] of
the STUN message. The MESSAGE-INTEGRITY attribute can be present in
any STUN message type. Since it uses the SHA-1 hash, the HMAC will
be 20 bytes.
The key for the HMAC depends on which credential mechanism is in use.
<a href="#section-9.1.1">Section 9.1.1</a> defines the key for the short-term credential
mechanism, and <a href="#section-9.2.2">Section 9.2.2</a> defines the key for the long-term
credential mechanism. Other credential mechanisms MUST define the
key that is used for the HMAC.
The text used as input to HMAC is the STUN message, up to and
including the attribute preceding the MESSAGE-INTEGRITY attribute.
The Length field of the STUN message header is adjusted to point to
the end of the MESSAGE-INTEGRITY attribute. The value of the
MESSAGE-INTEGRITY attribute is set to a dummy value.
Once the computation is performed, the value of the MESSAGE-INTEGRITY
attribute is filled in, and the value of the length in the STUN
header is set to its correct value -- the length of the entire
message. Similarly, when validating the MESSAGE-INTEGRITY, the
Length field in the STUN header must be adjusted to point to the end
of the MESSAGE-INTEGRITY attribute prior to calculating the HMAC over
the STUN message, up to and including the attribute preceding the
MESSAGE-INTEGRITY attribute. Such adjustment is necessary when
attributes, such as FINGERPRINT and MESSAGE-INTEGRITY-SHA256, appear
after MESSAGE-INTEGRITY. See also [<a href="./rfc5769" title=""Test Vectors for Session Traversal Utilities for NAT (STUN)"">RFC5769</a>] for examples of such
calculations.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 40]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-41" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
<span class="h3"><a class="selflink" id="section-14.6" href="#section-14.6">14.6</a>. MESSAGE-INTEGRITY-SHA256</span>
The MESSAGE-INTEGRITY-SHA256 attribute contains an HMAC-SHA256
[<a href="./rfc2104" title=""HMAC: Keyed- Hashing for Message Authentication"">RFC2104</a>] of the STUN message. The MESSAGE-INTEGRITY-SHA256
attribute can be present in any STUN message type. The MESSAGE-
INTEGRITY-SHA256 attribute contains an initial portion of the HMAC-
SHA-256 [<a href="./rfc2104" title=""HMAC: Keyed- Hashing for Message Authentication"">RFC2104</a>] of the STUN message. The value will be at most 32
bytes, but it MUST be at least 16 bytes and MUST be a multiple of 4
bytes. The value must be the full 32 bytes unless the STUN Usage
explicitly specifies that truncation is allowed. STUN Usages may
specify a minimum length longer than 16 bytes.
The key for the HMAC depends on which credential mechanism is in use.
<a href="#section-9.1.1">Section 9.1.1</a> defines the key for the short-term credential
mechanism, and <a href="#section-9.2.2">Section 9.2.2</a> defines the key for the long-term
credential mechanism. Other credential mechanism MUST define the key
that is used for the HMAC.
The text used as input to HMAC is the STUN message, up to and
including the attribute preceding the MESSAGE-INTEGRITY-SHA256
attribute. The Length field of the STUN message header is adjusted
to point to the end of the MESSAGE-INTEGRITY-SHA256 attribute. The
value of the MESSAGE-INTEGRITY-SHA256 attribute is set to a dummy
value.
Once the computation is performed, the value of the MESSAGE-
INTEGRITY-SHA256 attribute is filled in, and the value of the length
in the STUN header is set to its correct value -- the length of the
entire message. Similarly, when validating the MESSAGE-INTEGRITY-
SHA256, the Length field in the STUN header must be adjusted to point
to the end of the MESSAGE-INTEGRITY-SHA256 attribute prior to
calculating the HMAC over the STUN message, up to and including the
attribute preceding the MESSAGE-INTEGRITY-SHA256 attribute. Such
adjustment is necessary when attributes, such as FINGERPRINT, appear
after MESSAGE-INTEGRITY-SHA256. See also <a href="#appendix-B.1">Appendix B.1</a> for examples
of such calculations.
<span class="h3"><a class="selflink" id="section-14.7" href="#section-14.7">14.7</a>. FINGERPRINT</span>
The FINGERPRINT attribute MAY be present in all STUN messages.
The value of the attribute is computed as the CRC-32 of the STUN
message up to (but excluding) the FINGERPRINT attribute itself,
XOR'ed with the 32-bit value 0x5354554e. (The XOR operation ensures
that the FINGERPRINT test will not report a false positive on a
packet containing a CRC-32 generated by an application protocol.)
The 32-bit CRC is the one defined in ITU V.42 [<a href="#ref-ITU.V42.2002">ITU.V42.2002</a>], which
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 41]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-42" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
has a generator polynomial of x^32 + x^26 + x^23 + x^22 + x^16 + x^12
+ x^11 + x^10 + x^8 + x^7 + x^5 + x^4 + x^2 + x + 1. See the sample
code for the CRC-32 in <a href="./rfc1952#section-8">Section 8 of [RFC1952]</a>.
When present, the FINGERPRINT attribute MUST be the last attribute in
the message and thus will appear after MESSAGE-INTEGRITY and MESSAGE-
INTEGRITY-SHA256.
The FINGERPRINT attribute can aid in distinguishing STUN packets from
packets of other protocols. See <a href="#section-7">Section 7</a>.
As with MESSAGE-INTEGRITY and MESSAGE-INTEGRITY-SHA256, the CRC used
in the FINGERPRINT attribute covers the Length field from the STUN
message header. Therefore, prior to computation of the CRC, this
value must be correct and include the CRC attribute as part of the
message length. When using the FINGERPRINT attribute in a message,
the attribute is first placed into the message with a dummy value;
then, the CRC is computed, and the value of the attribute is updated.
If the MESSAGE-INTEGRITY or MESSAGE-INTEGRITY-SHA256 attribute is
also present, then it must be present with the correct message-
integrity value before the CRC is computed, since the CRC is done
over the value of the MESSAGE-INTEGRITY and MESSAGE-INTEGRITY-SHA256
attributes as well.
<span class="h3"><a class="selflink" id="section-14.8" href="#section-14.8">14.8</a>. ERROR-CODE</span>
The ERROR-CODE attribute is used in error response messages. It
contains a numeric error code value in the range of 300 to 699 plus a
textual reason phrase encoded in UTF-8 [<a href="./rfc3629" title=""UTF-8, a transformation format of ISO 10646"">RFC3629</a>]; it is also
consistent in its code assignments and semantics with SIP [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>]
and HTTP [<a href="./rfc7231" title=""Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content"">RFC7231</a>]. The reason phrase is meant for diagnostic
purposes and can be anything appropriate for the error code.
Recommended reason phrases for the defined error codes are included
in the IANA registry for error codes. The reason phrase MUST be a
UTF-8-encoded [<a href="./rfc3629" title=""UTF-8, a transformation format of ISO 10646"">RFC3629</a>] sequence of fewer than 128 characters (which
can be as long as 509 bytes when encoding them or 763 bytes when
decoding them).
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Reserved, should be 0 |Class| Number |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Reason Phrase (variable) ..
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Figure 7: Format of ERROR-CODE Attribute
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 42]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-43" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
To facilitate processing, the class of the error code (the hundreds
digit) is encoded separately from the rest of the code, as shown in
Figure 7.
The Reserved bits SHOULD be 0 and are for alignment on 32-bit
boundaries. Receivers MUST ignore these bits. The Class represents
the hundreds digit of the error code. The value MUST be between 3
and 6. The Number represents the binary encoding of the error code
modulo 100, and its value MUST be between 0 and 99.
The following error codes, along with their recommended reason
phrases, are defined:
300 Try Alternate: The client should contact an alternate server for
this request. This error response MUST only be sent if the
request included either a USERNAME or USERHASH attribute and a
valid MESSAGE-INTEGRITY or MESSAGE-INTEGRITY-SHA256 attribute;
otherwise, it MUST NOT be sent and error code 400 (Bad Request)
is suggested. This error response MUST be protected with the
MESSAGE-INTEGRITY or MESSAGE-INTEGRITY-SHA256 attribute, and
receivers MUST validate the MESSAGE-INTEGRITY or MESSAGE-
INTEGRITY-SHA256 of this response before redirecting themselves
to an alternate server.
Note: Failure to generate and validate message integrity for a
300 response allows an on-path attacker to falsify a 300
response thus causing subsequent STUN messages to be sent to a
victim.
400 Bad Request: The request was malformed. The client SHOULD NOT
retry the request without modification from the previous
attempt. The server may not be able to generate a valid
MESSAGE-INTEGRITY or MESSAGE-INTEGRITY-SHA256 for this error, so
the client MUST NOT expect a valid MESSAGE-INTEGRITY or MESSAGE-
INTEGRITY-SHA256 attribute on this response.
401 Unauthenticated: The request did not contain the correct
credentials to proceed. The client should retry the request
with proper credentials.
420 Unknown Attribute: The server received a STUN packet containing
a comprehension-required attribute that it did not understand.
The server MUST put this unknown attribute in the UNKNOWN-
ATTRIBUTE attribute of its error response.
438 Stale Nonce: The NONCE used by the client was no longer valid.
The client should retry, using the NONCE provided in the
response.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 43]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-44" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
500 Server Error: The server has suffered a temporary error. The
client should try again.
<span class="h3"><a class="selflink" id="section-14.9" href="#section-14.9">14.9</a>. REALM</span>
The REALM attribute may be present in requests and responses. It
contains text that meets the grammar for "realm-value" as described
in [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>] but without the double quotes and their surrounding
whitespace. That is, it is an unquoted realm-value (and is therefore
a sequence of qdtext or quoted-pair). It MUST be a UTF-8-encoded
[<a href="./rfc3629" title=""UTF-8, a transformation format of ISO 10646"">RFC3629</a>] sequence of fewer than 128 characters (which can be as long
as 509 bytes when encoding them and as long as 763 bytes when
decoding them) and MUST have been processed using the OpaqueString
profile [<a href="./rfc8265" title=""Preparation, Enforcement, and Comparison of Internationalized Strings Representing Usernames and Passwords"">RFC8265</a>].
Presence of the REALM attribute in a request indicates that long-term
credentials are being used for authentication. Presence in certain
error responses indicates that the server wishes the client to use a
long-term credential in that realm for authentication.
<span class="h3"><a class="selflink" id="section-14.10" href="#section-14.10">14.10</a>. NONCE</span>
The NONCE attribute may be present in requests and responses. It
contains a sequence of qdtext or quoted-pair, which are defined in
[<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>]. Note that this means that the NONCE attribute will not
contain the actual surrounding quote characters. The NONCE attribute
MUST be fewer than 128 characters (which can be as long as 509 bytes
when encoding them and a long as 763 bytes when decoding them). See
<a href="./rfc7616#section-5.4">Section 5.4 of [RFC7616]</a> for guidance on selection of nonce values in
a server.
<span class="h3"><a class="selflink" id="section-14.11" href="#section-14.11">14.11</a>. PASSWORD-ALGORITHMS</span>
The PASSWORD-ALGORITHMS attribute may be present in requests and
responses. It contains the list of algorithms that the server can
use to derive the long-term password.
The set of known algorithms is maintained by IANA. The initial set
defined by this specification is found in <a href="#section-18.5">Section 18.5</a>.
The attribute contains a list of algorithm numbers and variable
length parameters. The algorithm number is a 16-bit value as defined
in <a href="#section-18.5">Section 18.5</a>. The parameters start with the length (prior to
padding) of the parameters as a 16-bit value, followed by the
parameters that are specific to each algorithm. The parameters are
padded to a 32-bit boundary, in the same manner as an attribute.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 44]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-45" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Algorithm 1 | Algorithm 1 Parameters Length |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Algorithm 1 Parameters (variable)
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Algorithm 2 | Algorithm 2 Parameters Length |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Algorithm 2 Parameters (variable)
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| ...
Figure 8: Format of PASSWORD-ALGORITHMS Attribute
<span class="h3"><a class="selflink" id="section-14.12" href="#section-14.12">14.12</a>. PASSWORD-ALGORITHM</span>
The PASSWORD-ALGORITHM attribute is present only in requests. It
contains the algorithm that the server must use to derive a key from
the long-term password.
The set of known algorithms is maintained by IANA. The initial set
defined by this specification is found in <a href="#section-18.5">Section 18.5</a>.
The attribute contains an algorithm number and variable length
parameters. The algorithm number is a 16-bit value as defined in
<a href="#section-18.5">Section 18.5</a>. The parameters starts with the length (prior to
padding) of the parameters as a 16-bit value, followed by the
parameters that are specific to the algorithm. The parameters are
padded to a 32-bit boundary, in the same manner as an attribute.
Similarly, the padding bits MUST be set to zero on sending and MUST
be ignored by the receiver.
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Algorithm | Algorithm Parameters Length |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Algorithm Parameters (variable)
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Figure 9: Format of PASSWORD-ALGORITHM Attribute
<span class="h3"><a class="selflink" id="section-14.13" href="#section-14.13">14.13</a>. UNKNOWN-ATTRIBUTES</span>
The UNKNOWN-ATTRIBUTES attribute is present only in an error response
when the response code in the ERROR-CODE attribute is 420 (Unknown
Attribute).
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 45]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-46" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
The attribute contains a list of 16-bit values, each of which
represents an attribute type that was not understood by the server.
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Attribute 1 Type | Attribute 2 Type |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Attribute 3 Type | Attribute 4 Type ...
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Figure 10: Format of UNKNOWN-ATTRIBUTES Attribute
Note: In [<a href="./rfc3489" title=""STUN - Simple Traversal of User Datagram Protocol (UDP) Through Network Address Translators (NATs)"">RFC3489</a>], this field was padded to 32 by duplicating the
last attribute. In this version of the specification, the normal
padding rules for attributes are used instead.
<span class="h3"><a class="selflink" id="section-14.14" href="#section-14.14">14.14</a>. SOFTWARE</span>
The SOFTWARE attribute contains a textual description of the software
being used by the agent sending the message. It is used by clients
and servers. Its value SHOULD include manufacturer and version
number. The attribute has no impact on operation of the protocol and
serves only as a tool for diagnostic and debugging purposes. The
value of SOFTWARE is variable length. It MUST be a UTF-8-encoded
[<a href="./rfc3629" title=""UTF-8, a transformation format of ISO 10646"">RFC3629</a>] sequence of fewer than 128 characters (which can be as long
as 509 when encoding them and as long as 763 bytes when decoding
them).
<span class="h3"><a class="selflink" id="section-14.15" href="#section-14.15">14.15</a>. ALTERNATE-SERVER</span>
The alternate server represents an alternate transport address
identifying a different STUN server that the STUN client should try.
It is encoded in the same way as MAPPED-ADDRESS and thus refers to a
single server by IP address.
<span class="h3"><a class="selflink" id="section-14.16" href="#section-14.16">14.16</a>. ALTERNATE-DOMAIN</span>
The alternate domain represents the domain name that is used to
verify the IP address in the ALTERNATE-SERVER attribute when the
transport protocol uses TLS or DTLS.
The value of ALTERNATE-DOMAIN is variable length. It MUST be a valid
DNS name [<a href="./rfc1123" title=""Requirements for Internet Hosts - Application and Support"">RFC1123</a>] (including A-labels [<a href="./rfc5890" title=""Internationalized Domain Names for Applications (IDNA): Definitions and Document Framework"">RFC5890</a>]) of 255 or fewer
ASCII characters.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 46]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-47" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
<span class="h2"><a class="selflink" id="section-15" href="#section-15">15</a>. Operational Considerations</span>
STUN MAY be used with anycast addresses, but only with UDP and in
STUN Usages where authentication is not used.
<span class="h2"><a class="selflink" id="section-16" href="#section-16">16</a>. Security Considerations</span>
Implementations and deployments of a STUN Usage using TLS or DTLS
MUST follow the recommendations in [<a href="#ref-BCP195" title=""Recommendations for Secure Use of Transport Layer Security (TLS) and Datagram Transport Layer Security (DTLS)"">BCP195</a>].
Implementations and deployments of a STUN Usage using the long-term
credential mechanism (<a href="#section-9.2">Section 9.2</a>) MUST follow the recommendations in
<a href="./rfc7616#section-5">Section 5 of [RFC7616]</a>.
<span class="h3"><a class="selflink" id="section-16.1" href="#section-16.1">16.1</a>. Attacks against the Protocol</span>
<span class="h4"><a class="selflink" id="section-16.1.1" href="#section-16.1.1">16.1.1</a>. Outside Attacks</span>
An attacker can try to modify STUN messages in transit, in order to
cause a failure in STUN operation. These attacks are detected for
both requests and responses through the message-integrity mechanism,
using either a short-term or long-term credential. Of course, once
detected, the manipulated packets will be dropped, causing the STUN
transaction to effectively fail. This attack is possible only by an
on-path attacker.
An attacker that can observe, but not modify, STUN messages in-
transit (for example, an attacker present on a shared access medium,
such as Wi-Fi) can see a STUN request and then immediately send a
STUN response, typically an error response, in order to disrupt STUN
processing. This attack is also prevented for messages that utilize
MESSAGE-INTEGRITY. However, some error responses, those related to
authentication in particular, cannot be protected by MESSAGE-
INTEGRITY. When STUN itself is run over a secure transport protocol
(e.g., TLS), these attacks are completely mitigated.
Depending on the STUN Usage, these attacks may be of minimal
consequence and thus do not require message integrity to mitigate.
For example, when STUN is used to a basic STUN server to discover a
server reflexive candidate for usage with ICE, authentication and
message integrity are not required since these attacks are detected
during the connectivity check phase. The connectivity checks
themselves, however, require protection for proper operation of ICE
overall. As described in <a href="#section-13">Section 13</a>, STUN Usages describe when
authentication and message integrity are needed.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 47]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-48" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
Since STUN uses the HMAC of a shared secret for authentication and
integrity protection, it is subject to offline dictionary attacks.
When authentication is utilized, it SHOULD be with a strong password
that is not readily subject to offline dictionary attacks.
Protection of the channel itself, using TLS or DTLS, mitigates these
attacks.
STUN supports both MESSAGE-INTEGRITY and MESSAGE-INTEGRITY-SHA256,
which makes STUN subject to bid-down attacks by an on-path attacker.
An attacker could strip the MESSAGE-INTEGRITY-SHA256 attribute,
leaving only the MESSAGE-INTEGRITY attribute and thus exploiting a
potential vulnerability. Protection of the channel itself, using TLS
or DTLS, mitigates these attacks. Timely removal of the support of
MESSAGE-INTEGRITY in a future version of STUN is necessary.
Note: The use of SHA-256 for password hashing does not meet modern
standards, which are aimed at slowing down exhaustive password
searches by providing a relatively slow minimum time to compute the
hash. Although better algorithms such as Argon2 [<a href="#ref-Argon2" title=""The memory-hard Argon2 password hash and proof-of-work function"">Argon2</a>] are
available, SHA-256 was chosen for consistency with [<a href="./rfc7616" title=""HTTP Digest Access Authentication"">RFC7616</a>].
<span class="h4"><a class="selflink" id="section-16.1.2" href="#section-16.1.2">16.1.2</a>. Inside Attacks</span>
A rogue client may try to launch a DoS attack against a server by
sending it a large number of STUN requests. Fortunately, STUN
requests can be processed statelessly by a server, making such
attacks hard to launch effectively.
A rogue client may use a STUN server as a reflector, sending it
requests with a falsified source IP address and port. In such a
case, the response would be delivered to that source IP and port.
There is no amplification of the number of packets with this attack
(the STUN server sends one packet for each packet sent by the
client), though there is a small increase in the amount of data,
since STUN responses are typically larger than requests. This attack
is mitigated by ingress source address filtering.
Revealing the specific software version of the agent through the
SOFTWARE attribute might allow them to become more vulnerable to
attacks against software that is known to contain security holes.
Implementers SHOULD make usage of the SOFTWARE attribute a
configurable option.
<span class="h4"><a class="selflink" id="section-16.1.3" href="#section-16.1.3">16.1.3</a>. Bid-Down Attacks</span>
This document adds the possibility of selecting different algorithms
to protect the confidentiality of the passwords stored on the server
side when using the long-term credential mechanism while still
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 48]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-49" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
ensuring compatibility with MD5, which was the algorithm used in
[<a href="./rfc5389" title=""Session Traversal Utilities for NAT (STUN)"">RFC5389</a>]. This selection works by having the server send to the
client the list of algorithms supported in a PASSWORD-ALGORITHMS
attribute and having the client send back a PASSWORD-ALGORITHM
attribute containing the algorithm selected.
Because the PASSWORD-ALGORITHMS attribute has to be sent in an
unauthenticated response, an on-path attacker wanting to exploit an
eventual vulnerability in MD5 can just strip the PASSWORD-ALGORITHMS
attribute from the unprotected response, thus making the server
subsequently act as if the client was implementing the version of
this protocol defined in [<a href="./rfc5389" title=""Session Traversal Utilities for NAT (STUN)"">RFC5389</a>].
To protect against this attack and other similar bid-down attacks,
the nonce is enriched with a set of security bits that indicates
which security features are in use. In the case of the selection of
the password algorithm, the matching bit is set in the nonce returned
by the server in the same response that contains the PASSWORD-
ALGORITHMS attribute. Because the nonce used in subsequent
authenticated transactions is verified by the server to be identical
to what was originally sent, it cannot be modified by an on-path
attacker. Additionally, the client is mandated to copy the received
PASSWORD-ALGORITHMS attribute in the next authenticated transaction
to that server.
An on-path attack that removes the PASSWORD-ALGORITHMS will be
detected because the client will not be able to send it back to the
server in the next authenticated transaction. The client will detect
that attack because the security bit is set but the matching
attribute is missing; this will end the session. A client using an
older version of this protocol will not send the PASSWORD-ALGORITHMS
back but can only use MD5 anyway, so the attack is inconsequential.
The on-path attack may also try to remove the security bit together
with the PASSWORD-ALGORITHMS attribute, but the server will discover
that when the next authenticated transaction contains an invalid
nonce.
An on-path attack that removes some algorithms from the PASSWORD-
ALGORITHMS attribute will be equally defeated because that attribute
will be different from the original one when the server verifies it
in the subsequent authenticated transaction.
Note that the bid-down protection mechanism introduced in this
document is inherently limited by the fact that it is not possible to
detect an attack until the server receives the second request after
the 401 (Unauthenticated) response.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 49]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-50" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
SHA-256 was chosen as the new default for password hashing for its
compatibility with [<a href="./rfc7616" title=""HTTP Digest Access Authentication"">RFC7616</a>], but because SHA-256 (like MD5) is a
comparatively fast algorithm, it does little to deter brute-force
attacks. Specifically, this means that if the user has a weak
password, an attacker that captures a single exchange can use a
brute-force attack to learn the user's password and then potentially
impersonate the user to the server and to other servers where the
same password was used. Note that such an attacker can impersonate
the user to the server itself without any brute-force attack.
A stronger (which is to say, slower) algorithm, like Argon2 [<a href="#ref-Argon2" title=""The memory-hard Argon2 password hash and proof-of-work function"">Argon2</a>],
would help both of these cases; however, in the first case, it would
only help after the database entry for this user is updated to
exclusively use that stronger mechanism.
The bid-down defenses in this protocol prevent an attacker from
forcing the client and server to complete a handshake using weaker
algorithms than they jointly support, but only if the weakest joint
algorithm is strong enough that it cannot be compromised by a brute-
force attack. However, this does not defend against many attacks on
those algorithms; specifically, an on-path attacker might perform a
bid-down attack on a client that supports both Argon2 [<a href="#ref-Argon2" title=""The memory-hard Argon2 password hash and proof-of-work function"">Argon2</a>] and
SHA-256 for password hashing and use that to collect a MESSAGE-
INTEGRITY-SHA256 value that it can then use for an offline brute-
force attack. This would be detected when the server receives the
second request, but that does not prevent the attacker from obtaining
the MESSAGE-INTEGRITY-SHA256 value.
Similarly, an attack against the USERHASH mechanism will not succeed
in establishing a session as the server will detect that the feature
was discarded on path, but the client would still have been convinced
to send its username in the clear in the USERNAME attribute, thus
disclosing it to the attacker.
Finally, when the bid-down protection mechanism is employed for a
future upgrade of the HMAC algorithm used to protect messages, it
will offer only a limited protection if the current HMAC algorithm is
already compromised.
<span class="h3"><a class="selflink" id="section-16.2" href="#section-16.2">16.2</a>. Attacks Affecting the Usage</span>
This section lists attacks that might be launched against a usage of
STUN. Each STUN Usage must consider whether these attacks are
applicable to it and, if so, discuss countermeasures.
Most of the attacks in this section revolve around an attacker
modifying the reflexive address learned by a STUN client through a
Binding request/response transaction. Since the usage of the
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 50]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-51" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
reflexive address is a function of the usage, the applicability and
remediation of these attacks are usage-specific. In common
situations, modification of the reflexive address by an on-path
attacker is easy to do. Consider, for example, the common situation
where STUN is run directly over UDP. In this case, an on-path
attacker can modify the source IP address of the Binding request
before it arrives at the STUN server. The STUN server will then
return this IP address in the XOR-MAPPED-ADDRESS attribute to the
client and send the response back to that (falsified) IP address and
port. If the attacker can also intercept this response, it can
direct it back towards the client. Protecting against this attack by
using a message-integrity check is impossible, since a message-
integrity value cannot cover the source IP address and the
intervening NAT must be able to modify this value. Instead, one
solution to prevent the attacks listed below is for the client to
verify the reflexive address learned, as is done in ICE [<a href="./rfc8445" title=""Interactive Connectivity Establishment (ICE): A Protocol for Network Address Translator (NAT) Traversal"">RFC8445</a>].
Other usages may use other means to prevent these attacks.
<span class="h4"><a class="selflink" id="section-16.2.1" href="#section-16.2.1">16.2.1</a>. Attack I: Distributed DoS (DDoS) against a Target</span>
In this attack, the attacker provides one or more clients with the
same faked reflexive address that points to the intended target.
This will trick the STUN clients into thinking that their reflexive
addresses are equal to that of the target. If the clients hand out
that reflexive address in order to receive traffic on it (for
example, in SIP messages), the traffic will instead be sent to the
target. This attack can provide substantial amplification,
especially when used with clients that are using STUN to enable
multimedia applications. However, it can only be launched against
targets for which packets from the STUN server to the target pass
through the attacker, limiting the cases in which it is possible.
<span class="h4"><a class="selflink" id="section-16.2.2" href="#section-16.2.2">16.2.2</a>. Attack II: Silencing a Client</span>
In this attack, the attacker provides a STUN client with a faked
reflexive address. The reflexive address it provides is a transport
address that routes to nowhere. As a result, the client won't
receive any of the packets it expects to receive when it hands out
the reflexive address. This exploitation is not very interesting for
the attacker. It impacts a single client, which is frequently not
the desired target. Moreover, any attacker that can mount the attack
could also deny service to the client by other means, such as
preventing the client from receiving any response from the STUN
server, or even a DHCP server. As with the attack described in
<a href="#section-16.2.1">Section 16.2.1</a>, this attack is only possible when the attacker is on
path for packets sent from the STUN server towards this unused IP
address.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 51]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-52" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
<span class="h4"><a class="selflink" id="section-16.2.3" href="#section-16.2.3">16.2.3</a>. Attack III: Assuming the Identity of a Client</span>
This attack is similar to attack II. However, the faked reflexive
address points to the attacker itself. This allows the attacker to
receive traffic that was destined for the client.
<span class="h4"><a class="selflink" id="section-16.2.4" href="#section-16.2.4">16.2.4</a>. Attack IV: Eavesdropping</span>
In this attack, the attacker forces the client to use a reflexive
address that routes to itself. It then forwards any packets it
receives to the client. This attack allows the attacker to observe
all packets sent to the client. However, in order to launch the
attack, the attacker must have already been able to observe packets
from the client to the STUN server. In most cases (such as when the
attack is launched from an access network), this means that the
attacker could already observe packets sent to the client. This
attack is, as a result, only useful for observing traffic by
attackers on the path from the client to the STUN server, but not
generally on the path of packets being routed towards the client.
Note that this attack can be trivially launched by the STUN server
itself, so users of STUN servers should have the same level of trust
in the users of STUN servers as any other node that can insert itself
into the communication flow.
<span class="h3"><a class="selflink" id="section-16.3" href="#section-16.3">16.3</a>. Hash Agility Plan</span>
This specification uses HMAC-SHA256 for computation of the message
integrity, sometimes in combination with HMAC-SHA1. If, at a later
time, HMAC-SHA256 is found to be compromised, the following remedy
should be applied:
o Both a new message-integrity attribute and a new STUN Security
Feature bit will be allocated in a Standards Track document. The
new message-integrity attribute will have its value computed using
a new hash. The STUN Security Feature bit will be used to
simultaneously 1) signal to a STUN client using the long-term
credential mechanism that this server supports this new hash
algorithm and 2) prevent bid-down attacks on the new message-
integrity attribute.
o STUN clients and servers using the short-term credential mechanism
will need to update the external mechanism that they use to signal
what message-integrity attributes are in use.
The bid-down protection mechanism described in this document is new
and thus cannot currently protect against a bid-down attack that
lowers the strength of the hash algorithm to HMAC-SHA1. This is why,
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 52]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-53" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
after a transition period, a new document updating this one will
assign a new STUN Security Feature bit for deprecating HMAC-SHA1.
When used, this bit will signal that HMAC-SHA1 is deprecated and
should no longer be used.
Similarly, if HMAC-SHA256 is found to be compromised, a new userhash
attribute and a new STUN Security Feature bit will be allocated in a
Standards Track document. The new userhash attribute will have its
value computed using a new hash. The STUN Security Feature bit will
be used to simultaneously 1) signal to a STUN client using the long-
term credential mechanism that this server supports this new hash
algorithm for the userhash attribute and 2) prevent bid-down attacks
on the new userhash attribute.
<span class="h2"><a class="selflink" id="section-17" href="#section-17">17</a>. IAB Considerations</span>
The IAB has studied the problem of Unilateral Self-Address Fixing
(UNSAF), which is the general process by which a client attempts to
determine its address in another realm on the other side of a NAT
through a collaborative protocol reflection mechanism [<a href="./rfc3424" title=""IAB Considerations for UNilateral Self-Address Fixing (UNSAF) Across Network Address Translation"">RFC3424</a>].
STUN can be used to perform this function using a Binding request/
response transaction if one agent is behind a NAT and the other is on
the public side of the NAT.
The IAB has suggested that protocols developed for this purpose
document a specific set of considerations. Because some STUN Usages
provide UNSAF functions (such as ICE [<a href="./rfc8445" title=""Interactive Connectivity Establishment (ICE): A Protocol for Network Address Translator (NAT) Traversal"">RFC8445</a>]) and others do not
(such as SIP Outbound [<a href="./rfc5626" title=""Managing Client-Initiated Connections in the Session Initiation Protocol (SIP)"">RFC5626</a>]), answers to these considerations
need to be addressed by the usages themselves.
<span class="h2"><a class="selflink" id="section-18" href="#section-18">18</a>. IANA Considerations</span>
<span class="h3"><a class="selflink" id="section-18.1" href="#section-18.1">18.1</a>. STUN Security Features Registry</span>
A STUN Security Feature set defines 24 bits as flags.
IANA has created a new registry containing the STUN Security Features
that are protected by the bid-down attack prevention mechanism
described in <a href="#section-9.2.1">Section 9.2.1</a>.
The initial STUN Security Features are:
Bit 0: Password algorithms
Bit 1: Username anonymity
Bit 2-23: Unassigned
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 53]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-54" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
Bits are assigned starting from the most significant side of the bit
set, so Bit 0 is the leftmost bit and Bit 23 is the rightmost bit.
New Security Features are assigned by Standards Action [<a href="./rfc8126" title="">RFC8126</a>].
<span class="h3"><a class="selflink" id="section-18.2" href="#section-18.2">18.2</a>. STUN Methods Registry</span>
A STUN method is a hex number in the range 0x000-0x0FF. The encoding
of a STUN method into a STUN message is described in <a href="#section-5">Section 5</a>.
STUN methods in the range 0x000-0x07F are assigned by IETF Review
[<a href="./rfc8126" title="">RFC8126</a>]. STUN methods in the range 0x080-0x0FF are assigned by
Expert Review [<a href="./rfc8126" title="">RFC8126</a>]. The responsibility of the expert is to
verify that the selected codepoint(s) is not in use and that the
request is not for an abnormally large number of codepoints.
Technical review of the extension itself is outside the scope of the
designated expert responsibility.
IANA has updated the name for method 0x002 as described below as well
as updated the reference from <a href="./rfc5389">RFC 5389</a> to <a href="./rfc8489">RFC 8489</a> for the following
STUN methods:
0x000: Reserved
0x001: Binding
0x002: Reserved; was SharedSecret prior to [<a href="./rfc5389" title=""Session Traversal Utilities for NAT (STUN)"">RFC5389</a>]
<span class="h3"><a class="selflink" id="section-18.3" href="#section-18.3">18.3</a>. STUN Attributes Registry</span>
A STUN attribute type is a hex number in the range 0x0000-0xFFFF.
STUN attribute types in the range 0x0000-0x7FFF are considered
comprehension-required; STUN attribute types in the range
0x8000-0xFFFF are considered comprehension-optional. A STUN agent
handles unknown comprehension-required and comprehension-optional
attributes differently.
STUN attribute types in the first half of the comprehension-required
range (0x0000-0x3FFF) and in the first half of the comprehension-
optional range (0x8000-0xBFFF) are assigned by IETF Review [<a href="./rfc8126" title="">RFC8126</a>].
STUN attribute types in the second half of the comprehension-required
range (0x4000-0x7FFF) and in the second half of the comprehension-
optional range (0xC000-0xFFFF) are assigned by Expert Review
[<a href="./rfc8126" title="">RFC8126</a>]. The responsibility of the expert is to verify that the
selected codepoint(s) are not in use and that the request is not for
an abnormally large number of codepoints. Technical review of the
extension itself is outside the scope of the designated expert
responsibility.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 54]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-55" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
<span class="h4"><a class="selflink" id="section-18.3.1" href="#section-18.3.1">18.3.1</a>. Updated Attributes</span>
IANA has updated the names for attributes 0x0002, 0x0004, 0x0005,
0x0007, and 0x000B as well as updated the reference from <a href="./rfc5389">RFC 5389</a> to
<a href="./rfc8489">RFC 8489</a> for each the following STUN methods.
In addition, [<a href="./rfc5389" title=""Session Traversal Utilities for NAT (STUN)"">RFC5389</a>] introduced a mistake in the name of attribute
0x0003; [<a href="./rfc5389" title=""Session Traversal Utilities for NAT (STUN)"">RFC5389</a>] called it CHANGE-ADDRESS when it was actually
previously called CHANGE-REQUEST. Thus, IANA has updated the
description for 0x0003 to read "Reserved; was CHANGE-REQUEST prior to
[<a href="./rfc5389" title=""Session Traversal Utilities for NAT (STUN)"">RFC5389</a>]".
Comprehension-required range (0x0000-0x7FFF):
0x0000: Reserved
0x0001: MAPPED-ADDRESS
0x0002: Reserved; was RESPONSE-ADDRESS prior to [<a href="./rfc5389" title=""Session Traversal Utilities for NAT (STUN)"">RFC5389</a>]
0x0003: Reserved; was CHANGE-REQUEST prior to [<a href="./rfc5389" title=""Session Traversal Utilities for NAT (STUN)"">RFC5389</a>]
0x0004: Reserved; was SOURCE-ADDRESS prior to [<a href="./rfc5389" title=""Session Traversal Utilities for NAT (STUN)"">RFC5389</a>]
0x0005: Reserved; was CHANGED-ADDRESS prior to [<a href="./rfc5389" title=""Session Traversal Utilities for NAT (STUN)"">RFC5389</a>]
0x0006: USERNAME
0x0007: Reserved; was PASSWORD prior to [<a href="./rfc5389" title=""Session Traversal Utilities for NAT (STUN)"">RFC5389</a>]
0x0008: MESSAGE-INTEGRITY
0x0009: ERROR-CODE
0x000A: UNKNOWN-ATTRIBUTES
0x000B: Reserved; was REFLECTED-FROM prior to [<a href="./rfc5389" title=""Session Traversal Utilities for NAT (STUN)"">RFC5389</a>]
0x0014: REALM
0x0015: NONCE
0x0020: XOR-MAPPED-ADDRESS
Comprehension-optional range (0x8000-0xFFFF)
0x8022: SOFTWARE
0x8023: ALTERNATE-SERVER
0x8028: FINGERPRINT
<span class="h4"><a class="selflink" id="section-18.3.2" href="#section-18.3.2">18.3.2</a>. New Attributes</span>
IANA has added the following attribute to the "STUN Attributes"
registry:
Comprehension-required range (0x0000-0x7FFF):
0x001C: MESSAGE-INTEGRITY-SHA256
0x001D: PASSWORD-ALGORITHM
0x001E: USERHASH
Comprehension-optional range (0x8000-0xFFFF)
0x8002: PASSWORD-ALGORITHMS
0x8003: ALTERNATE-DOMAIN
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 55]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-56" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
<span class="h3"><a class="selflink" id="section-18.4" href="#section-18.4">18.4</a>. STUN Error Codes Registry</span>
A STUN error code is a number in the range 0-699. STUN error codes
are accompanied by a textual reason phrase in UTF-8 [<a href="./rfc3629" title=""UTF-8, a transformation format of ISO 10646"">RFC3629</a>] that is
intended only for human consumption and can be anything appropriate;
this document proposes only suggested values.
STUN error codes are consistent in codepoint assignments and
semantics with SIP [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>] and HTTP [<a href="./rfc7231" title=""Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content"">RFC7231</a>].
New STUN error codes are assigned based on IETF Review [<a href="./rfc8126" title="">RFC8126</a>].
The specification must carefully consider how clients that do not
understand this error code will process it before granting the
request. See the rules in <a href="#section-6.3.4">Section 6.3.4</a>.
IANA has updated the reference from <a href="./rfc5389">RFC 5389</a> to <a href="./rfc8489">RFC 8489</a> for the
error codes defined in <a href="#section-14.8">Section 14.8</a>.
IANA has changed the name of the 401 error code from "Unauthorized"
to "Unauthenticated".
<span class="h3"><a class="selflink" id="section-18.5" href="#section-18.5">18.5</a>. STUN Password Algorithms Registry</span>
IANA has created a new registry titled "STUN Password Algorithms".
A password algorithm is a hex number in the range 0x0000-0xFFFF.
The initial contents of the "Password Algorithm" registry are as
follows:
0x0000: Reserved
0x0001: MD5
0x0002: SHA-256
0x0003-0xFFFF: Unassigned
Password algorithms in the first half of the range (0x0000-0x7FFF)
are assigned by IETF Review [<a href="./rfc8126" title="">RFC8126</a>]. Password algorithms in the
second half of the range (0x8000-0xFFFF) are assigned by Expert
Review [<a href="./rfc8126" title="">RFC8126</a>].
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 56]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-57" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
<span class="h4"><a class="selflink" id="section-18.5.1" href="#section-18.5.1">18.5.1</a>. Password Algorithms</span>
<span class="h5"><a class="selflink" id="section-18.5.1.1" href="#section-18.5.1.1">18.5.1.1</a>. MD5</span>
This password algorithm is taken from [<a href="./rfc1321" title=""The MD5 Message-Digest Algorithm"">RFC1321</a>].
The key length is 16 bytes, and the parameters value is empty.
Note: This algorithm MUST only be used for compatibility with
legacy systems.
key = MD5(username ":" OpaqueString(realm)
":" OpaqueString(password))
<span class="h5"><a class="selflink" id="section-18.5.1.2" href="#section-18.5.1.2">18.5.1.2</a>. SHA-256</span>
This password algorithm is taken from [<a href="./rfc7616" title=""HTTP Digest Access Authentication"">RFC7616</a>].
The key length is 32 bytes, and the parameters value is empty.
key = SHA-256(username ":" OpaqueString(realm)
":" OpaqueString(password))
<span class="h3"><a class="selflink" id="section-18.6" href="#section-18.6">18.6</a>. STUN UDP and TCP Port Numbers</span>
IANA has updated the reference from <a href="./rfc5389">RFC 5389</a> to <a href="./rfc8489">RFC 8489</a> for the
following ports in the "Service Name and Transport Protocol Port
Number Registry".
stun 3478/tcp Session Traversal Utilities for NAT (STUN) port
stun 3478/udp Session Traversal Utilities for NAT (STUN) port
stuns 5349/tcp Session Traversal Utilities for NAT (STUN) port
<span class="h2"><a class="selflink" id="section-19" href="#section-19">19</a>. Changes since <a href="./rfc5389">RFC 5389</a></span>
This specification obsoletes [<a href="./rfc5389" title=""Session Traversal Utilities for NAT (STUN)"">RFC5389</a>]. This specification differs
from <a href="./rfc5389">RFC 5389</a> in the following ways:
o Added support for DTLS-over-UDP [<a href="./rfc6347" title=""Datagram Transport Layer Security Version 1.2"">RFC6347</a>].
o Made clear that the RTO is considered stale if there are no
transactions with the server.
o Aligned the RTO calculation with [<a href="./rfc6298" title=""Computing TCP's Retransmission Timer"">RFC6298</a>].
o Updated the ciphersuites for TLS.
o Added support for STUN URI [<a href="./rfc7064" title=""URI Scheme for the Session Traversal Utilities for NAT (STUN) Protocol"">RFC7064</a>].
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 57]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-58" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
o Added support for SHA256 message integrity.
o Updated the Preparation, Enforcement, and Comparison of
Internationalized Strings (PRECIS) support to [<a href="./rfc8265" title=""Preparation, Enforcement, and Comparison of Internationalized Strings Representing Usernames and Passwords"">RFC8265</a>].
o Added protocol and registry to choose the password encryption
algorithm.
o Added support for anonymous username.
o Added protocol and registry for preventing bid-down attacks.
o Specified that sharing a NONCE is no longer permitted.
o Added the possibility of using a domain name in the alternate
server mechanism.
o Added more C snippets.
o Added test vector.
<span class="h2"><a class="selflink" id="section-20" href="#section-20">20</a>. References</span>
<span class="h3"><a class="selflink" id="section-20.1" href="#section-20.1">20.1</a>. Normative References</span>
[<a id="ref-ITU.V42.2002">ITU.V42.2002</a>]
International Telecommunication Union, "Error-correcting
procedures for DCEs using asynchronous-to-synchronous
conversion", ITU-T Recommendation V.42, March 2002.
[<a id="ref-KARN87">KARN87</a>] Karn, P. and C. Partridge, "Improving Round-Trip Time
Estimates in Reliable Transport Protocols", SIGCOMM '87,
Proceedings of the ACM workshop on Frontiers in computer
communications technology, Pages 2-7,
DOI 10.1145/55483.55484, August 1987.
[<a id="ref-RFC0791">RFC0791</a>] Postel, J., "Internet Protocol", STD 5, <a href="./rfc791">RFC 791</a>,
DOI 10.17487/RFC0791, September 1981,
<<a href="https://www.rfc-editor.org/info/rfc791">https://www.rfc-editor.org/info/rfc791</a>>.
[<a id="ref-RFC1122">RFC1122</a>] Braden, R., Ed., "Requirements for Internet Hosts -
Communication Layers", STD 3, <a href="./rfc1122">RFC 1122</a>,
DOI 10.17487/RFC1122, October 1989,
<<a href="https://www.rfc-editor.org/info/rfc1122">https://www.rfc-editor.org/info/rfc1122</a>>.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 58]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-59" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
[<a id="ref-RFC1123">RFC1123</a>] Braden, R., Ed., "Requirements for Internet Hosts -
Application and Support", STD 3, <a href="./rfc1123">RFC 1123</a>,
DOI 10.17487/RFC1123, October 1989,
<<a href="https://www.rfc-editor.org/info/rfc1123">https://www.rfc-editor.org/info/rfc1123</a>>.
[<a id="ref-RFC1321">RFC1321</a>] Rivest, R., "The MD5 Message-Digest Algorithm", <a href="./rfc1321">RFC 1321</a>,
DOI 10.17487/RFC1321, April 1992,
<<a href="https://www.rfc-editor.org/info/rfc1321">https://www.rfc-editor.org/info/rfc1321</a>>.
[<a id="ref-RFC2104">RFC2104</a>] Krawczyk, H., Bellare, M., and R. Canetti, "HMAC: Keyed-
Hashing for Message Authentication", <a href="./rfc2104">RFC 2104</a>,
DOI 10.17487/RFC2104, February 1997,
<<a href="https://www.rfc-editor.org/info/rfc2104">https://www.rfc-editor.org/info/rfc2104</a>>.
[<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-RFC2782">RFC2782</a>] Gulbrandsen, A., Vixie, P., and L. Esibov, "A DNS RR for
specifying the location of services (DNS SRV)", <a href="./rfc2782">RFC 2782</a>,
DOI 10.17487/RFC2782, February 2000,
<<a href="https://www.rfc-editor.org/info/rfc2782">https://www.rfc-editor.org/info/rfc2782</a>>.
[<a id="ref-RFC3629">RFC3629</a>] Yergeau, F., "UTF-8, a transformation format of ISO
10646", STD 63, <a href="./rfc3629">RFC 3629</a>, DOI 10.17487/RFC3629, November
2003, <<a href="https://www.rfc-editor.org/info/rfc3629">https://www.rfc-editor.org/info/rfc3629</a>>.
[<a id="ref-RFC4648">RFC4648</a>] Josefsson, S., "The Base16, Base32, and Base64 Data
Encodings", <a href="./rfc4648">RFC 4648</a>, DOI 10.17487/RFC4648, October 2006,
<<a href="https://www.rfc-editor.org/info/rfc4648">https://www.rfc-editor.org/info/rfc4648</a>>.
[<a id="ref-RFC5890">RFC5890</a>] Klensin, J., "Internationalized Domain Names for
Applications (IDNA): Definitions and Document Framework",
<a href="./rfc5890">RFC 5890</a>, DOI 10.17487/RFC5890, August 2010,
<<a href="https://www.rfc-editor.org/info/rfc5890">https://www.rfc-editor.org/info/rfc5890</a>>.
[<a id="ref-RFC6125">RFC6125</a>] Saint-Andre, P. and J. Hodges, "Representation and
Verification of Domain-Based Application Service Identity
within Internet Public Key Infrastructure Using X.509
(PKIX) Certificates in the Context of Transport Layer
Security (TLS)", <a href="./rfc6125">RFC 6125</a>, DOI 10.17487/RFC6125, March
2011, <<a href="https://www.rfc-editor.org/info/rfc6125">https://www.rfc-editor.org/info/rfc6125</a>>.
[<a id="ref-RFC6151">RFC6151</a>] Turner, S. and L. Chen, "Updated Security Considerations
for the MD5 Message-Digest and the HMAC-MD5 Algorithms",
<a href="./rfc6151">RFC 6151</a>, DOI 10.17487/RFC6151, March 2011,
<<a href="https://www.rfc-editor.org/info/rfc6151">https://www.rfc-editor.org/info/rfc6151</a>>.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 59]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-60" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
[<a id="ref-RFC6298">RFC6298</a>] Paxson, V., Allman, M., Chu, J., and M. Sargent,
"Computing TCP's Retransmission Timer", <a href="./rfc6298">RFC 6298</a>,
DOI 10.17487/RFC6298, June 2011,
<<a href="https://www.rfc-editor.org/info/rfc6298">https://www.rfc-editor.org/info/rfc6298</a>>.
[<a id="ref-RFC6347">RFC6347</a>] Rescorla, E. and N. Modadugu, "Datagram Transport Layer
Security Version 1.2", <a href="./rfc6347">RFC 6347</a>, DOI 10.17487/RFC6347,
January 2012, <<a href="https://www.rfc-editor.org/info/rfc6347">https://www.rfc-editor.org/info/rfc6347</a>>.
[<a id="ref-RFC7064">RFC7064</a>] Nandakumar, S., Salgueiro, G., Jones, P., and M. Petit-
Huguenin, "URI Scheme for the Session Traversal Utilities
for NAT (STUN) Protocol", <a href="./rfc7064">RFC 7064</a>, DOI 10.17487/RFC7064,
November 2013, <<a href="https://www.rfc-editor.org/info/rfc7064">https://www.rfc-editor.org/info/rfc7064</a>>.
[<a id="ref-RFC7350">RFC7350</a>] Petit-Huguenin, M. and G. Salgueiro, "Datagram Transport
Layer Security (DTLS) as Transport for Session Traversal
Utilities for NAT (STUN)", <a href="./rfc7350">RFC 7350</a>, DOI 10.17487/RFC7350,
August 2014, <<a href="https://www.rfc-editor.org/info/rfc7350">https://www.rfc-editor.org/info/rfc7350</a>>.
[<a id="ref-RFC7616">RFC7616</a>] Shekh-Yusef, R., Ed., Ahrens, D., and S. Bremer, "HTTP
Digest Access Authentication", <a href="./rfc7616">RFC 7616</a>,
DOI 10.17487/RFC7616, September 2015,
<<a href="https://www.rfc-editor.org/info/rfc7616">https://www.rfc-editor.org/info/rfc7616</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-RFC8200">RFC8200</a>] Deering, S. and R. Hinden, "Internet Protocol, Version 6
(IPv6) Specification", STD 86, <a href="./rfc8200">RFC 8200</a>,
DOI 10.17487/RFC8200, July 2017,
<<a href="https://www.rfc-editor.org/info/rfc8200">https://www.rfc-editor.org/info/rfc8200</a>>.
[<a id="ref-RFC8265">RFC8265</a>] Saint-Andre, P. and A. Melnikov, "Preparation,
Enforcement, and Comparison of Internationalized Strings
Representing Usernames and Passwords", <a href="./rfc8265">RFC 8265</a>,
DOI 10.17487/RFC8265, October 2017,
<<a href="https://www.rfc-editor.org/info/rfc8265">https://www.rfc-editor.org/info/rfc8265</a>>.
[<a id="ref-RFC8305">RFC8305</a>] Schinazi, D. and T. Pauly, "Happy Eyeballs Version 2:
Better Connectivity Using Concurrency", <a href="./rfc8305">RFC 8305</a>,
DOI 10.17487/RFC8305, December 2017,
<<a href="https://www.rfc-editor.org/info/rfc8305">https://www.rfc-editor.org/info/rfc8305</a>>.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 60]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-61" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
<span class="h3"><a class="selflink" id="section-20.2" href="#section-20.2">20.2</a>. Informative References</span>
[<a id="ref-Argon2">Argon2</a>] Biryukov, A., Dinu, D., Khovratovich, D., and S.
Josefsson, "The memory-hard Argon2 password hash and
proof-of-work function", Work in Progress, <a href="./draft-irtf-cfrg-argon2-09">draft-irtf-</a>
<a href="./draft-irtf-cfrg-argon2-09">cfrg-argon2-09</a>, November 2019.
[<a id="ref-BCP195">BCP195</a>] Sheffer, Y., Holz, R., and P. Saint-Andre,
"Recommendations for Secure Use of Transport Layer
Security (TLS) and Datagram Transport Layer Security
(DTLS)", <a href="https://www.rfc-editor.org/bcp/bcp195">BCP 195</a>, <a href="./rfc7525">RFC 7525</a>, May 2015,
<<a href="https://www.rfc-editor.org/info/bcp195">https://www.rfc-editor.org/info/bcp195</a>>.
[<a id="ref-RFC1952">RFC1952</a>] Deutsch, P., "GZIP file format specification version 4.3",
<a href="./rfc1952">RFC 1952</a>, DOI 10.17487/RFC1952, May 1996,
<<a href="https://www.rfc-editor.org/info/rfc1952">https://www.rfc-editor.org/info/rfc1952</a>>.
[<a id="ref-RFC2279">RFC2279</a>] Yergeau, F., "UTF-8, a transformation format of ISO
10646", <a href="./rfc2279">RFC 2279</a>, DOI 10.17487/RFC2279, January 1998,
<<a href="https://www.rfc-editor.org/info/rfc2279">https://www.rfc-editor.org/info/rfc2279</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-RFC3424">RFC3424</a>] Daigle, L., Ed. and IAB, "IAB Considerations for
UNilateral Self-Address Fixing (UNSAF) Across Network
Address Translation", <a href="./rfc3424">RFC 3424</a>, DOI 10.17487/RFC3424,
November 2002, <<a href="https://www.rfc-editor.org/info/rfc3424">https://www.rfc-editor.org/info/rfc3424</a>>.
[<a id="ref-RFC3454">RFC3454</a>] Hoffman, P. and M. Blanchet, "Preparation of
Internationalized Strings ("stringprep")", <a href="./rfc3454">RFC 3454</a>,
DOI 10.17487/RFC3454, December 2002,
<<a href="https://www.rfc-editor.org/info/rfc3454">https://www.rfc-editor.org/info/rfc3454</a>>.
[<a id="ref-RFC3489">RFC3489</a>] Rosenberg, J., Weinberger, J., Huitema, C., and R. Mahy,
"STUN - Simple Traversal of User Datagram Protocol (UDP)
Through Network Address Translators (NATs)", <a href="./rfc3489">RFC 3489</a>,
DOI 10.17487/RFC3489, March 2003,
<<a href="https://www.rfc-editor.org/info/rfc3489">https://www.rfc-editor.org/info/rfc3489</a>>.
[<a id="ref-RFC4013">RFC4013</a>] Zeilenga, K., "SASLprep: Stringprep Profile for User Names
and Passwords", <a href="./rfc4013">RFC 4013</a>, DOI 10.17487/RFC4013, February
2005, <<a href="https://www.rfc-editor.org/info/rfc4013">https://www.rfc-editor.org/info/rfc4013</a>>.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 61]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-62" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
[<a id="ref-RFC4107">RFC4107</a>] Bellovin, S. and R. Housley, "Guidelines for Cryptographic
Key Management", <a href="https://www.rfc-editor.org/bcp/bcp107">BCP 107</a>, <a href="./rfc4107">RFC 4107</a>, DOI 10.17487/RFC4107,
June 2005, <<a href="https://www.rfc-editor.org/info/rfc4107">https://www.rfc-editor.org/info/rfc4107</a>>.
[<a id="ref-RFC5090">RFC5090</a>] Sterman, B., Sadolevsky, D., Schwartz, D., Williams, D.,
and W. Beck, "RADIUS Extension for Digest Authentication",
<a href="./rfc5090">RFC 5090</a>, DOI 10.17487/RFC5090, February 2008,
<<a href="https://www.rfc-editor.org/info/rfc5090">https://www.rfc-editor.org/info/rfc5090</a>>.
[<a id="ref-RFC5389">RFC5389</a>] Rosenberg, J., Mahy, R., Matthews, P., and D. Wing,
"Session Traversal Utilities for NAT (STUN)", <a href="./rfc5389">RFC 5389</a>,
DOI 10.17487/RFC5389, October 2008,
<<a href="https://www.rfc-editor.org/info/rfc5389">https://www.rfc-editor.org/info/rfc5389</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-RFC5766">RFC5766</a>] Mahy, R., Matthews, P., and J. Rosenberg, "Traversal Using
Relays around NAT (TURN): Relay Extensions to Session
Traversal Utilities for NAT (STUN)", <a href="./rfc5766">RFC 5766</a>,
DOI 10.17487/RFC5766, April 2010,
<<a href="https://www.rfc-editor.org/info/rfc5766">https://www.rfc-editor.org/info/rfc5766</a>>.
[<a id="ref-RFC5769">RFC5769</a>] Denis-Courmont, R., "Test Vectors for Session Traversal
Utilities for NAT (STUN)", <a href="./rfc5769">RFC 5769</a>, DOI 10.17487/RFC5769,
April 2010, <<a href="https://www.rfc-editor.org/info/rfc5769">https://www.rfc-editor.org/info/rfc5769</a>>.
[<a id="ref-RFC5780">RFC5780</a>] MacDonald, D. and B. Lowekamp, "NAT Behavior Discovery
Using Session Traversal Utilities for NAT (STUN)",
<a href="./rfc5780">RFC 5780</a>, DOI 10.17487/RFC5780, May 2010,
<<a href="https://www.rfc-editor.org/info/rfc5780">https://www.rfc-editor.org/info/rfc5780</a>>.
[<a id="ref-RFC6544">RFC6544</a>] Rosenberg, J., Keranen, A., Lowekamp, B., and A. Roach,
"TCP Candidates with Interactive Connectivity
Establishment (ICE)", <a href="./rfc6544">RFC 6544</a>, DOI 10.17487/RFC6544,
March 2012, <<a href="https://www.rfc-editor.org/info/rfc6544">https://www.rfc-editor.org/info/rfc6544</a>>.
[<a id="ref-RFC7231">RFC7231</a>] Fielding, R., Ed. and J. Reschke, Ed., "Hypertext Transfer
Protocol (HTTP/1.1): Semantics and Content", <a href="./rfc7231">RFC 7231</a>,
DOI 10.17487/RFC7231, June 2014,
<<a href="https://www.rfc-editor.org/info/rfc7231">https://www.rfc-editor.org/info/rfc7231</a>>.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 62]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-63" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
[<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-RFC8264">RFC8264</a>] Saint-Andre, P. and M. Blanchet, "PRECIS Framework:
Preparation, Enforcement, and Comparison of
Internationalized Strings in Application Protocols",
<a href="./rfc8264">RFC 8264</a>, DOI 10.17487/RFC8264, October 2017,
<<a href="https://www.rfc-editor.org/info/rfc8264">https://www.rfc-editor.org/info/rfc8264</a>>.
[<a id="ref-RFC8445">RFC8445</a>] Keranen, A., Holmberg, C., and J. Rosenberg, "Interactive
Connectivity Establishment (ICE): A Protocol for Network
Address Translator (NAT) Traversal", <a href="./rfc8445">RFC 8445</a>,
DOI 10.17487/RFC8445, July 2018,
<<a href="https://www.rfc-editor.org/info/rfc8445">https://www.rfc-editor.org/info/rfc8445</a>>.
[<a id="ref-RFC8446">RFC8446</a>] Rescorla, E., "The Transport Layer Security (TLS) Protocol
Version 1.3", <a href="./rfc8446">RFC 8446</a>, DOI 10.17487/RFC8446, August 2018,
<<a href="https://www.rfc-editor.org/info/rfc8446">https://www.rfc-editor.org/info/rfc8446</a>>.
[<a id="ref-STUN-PMTUD">STUN-PMTUD</a>]
Petit-Huguenin, M., Salgueiro, G., and F. Garrido,
"Packetization Layer Path MTU Discovery (PLMTUD) For UDP
Transports Using Session Traversal Utilities for NAT
(STUN)", Work in Progress, <a href="./draft-ietf-tram-stun-pmtud-15">draft-ietf-tram-stun-pmtud-15</a>,
December 2019.
[<a id="ref-UAX15">UAX15</a>] Unicode Standard Annex #15, "Unicode Normalization Forms",
edited by Mark Davis and Ken Whistler. An integral part
of The Unicode Standard,
<<a href="http://unicode.org/reports/tr15/">http://unicode.org/reports/tr15/</a>>.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 63]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-64" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
<span class="h2"><a class="selflink" id="appendix-A" href="#appendix-A">Appendix A</a>. C Snippet to Determine STUN Message Types</span>
Given a 16-bit STUN message type value in host byte order in msg_type
parameter, below are C macros to determine the STUN message types:
<CODE BEGINS>
#define IS_REQUEST(msg_type) (((msg_type) & 0x0110) == 0x0000)
#define IS_INDICATION(msg_type) (((msg_type) & 0x0110) == 0x0010)
#define IS_SUCCESS_RESP(msg_type) (((msg_type) & 0x0110) == 0x0100)
#define IS_ERR_RESP(msg_type) (((msg_type) & 0x0110) == 0x0110)
<CODE ENDS>
A function to convert method and class into a message type:
<CODE BEGINS>
int type(int method, int cls) {
return (method & 0x1F80) << 2 | (method & 0x0070) << 1
| (method & 0x000F) | (cls & 0x0002) << 7
| (cls & 0x0001) << 4;
}
<CODE ENDS>
A function to extract the method from the message type:
<CODE BEGINS>
int method(int type) {
return (type & 0x3E00) >> 2 | (type & 0x00E0) >> 1
| (type & 0x000F);
}
<CODE ENDS>
A function to extract the class from the message type:
<CODE BEGINS>
int cls(int type) {
return (type & 0x0100) >> 7 | (type & 0x0010) >> 4;
}
<CODE ENDS>
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 64]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-65" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
<span class="h2"><a class="selflink" id="appendix-B" href="#appendix-B">Appendix B</a>. Test Vectors</span>
This section augments the list of test vectors defined in [<a href="./rfc5769" title=""Test Vectors for Session Traversal Utilities for NAT (STUN)"">RFC5769</a>]
with MESSAGE-INTEGRITY-SHA256. All the formats and definitions
listed in <a href="./rfc5769#section-2">Section 2 of [RFC5769]</a> apply here.
<span class="h3"><a class="selflink" id="appendix-B.1" href="#appendix-B.1">B.1</a>. Sample Request with Long-Term Authentication with MESSAGE-</span>
INTEGRITY-SHA256 and USERHASH
This request uses the following parameters:
Username: "<U+30DE><U+30C8><U+30EA><U+30C3><U+30AF><U+30B9>" (without
quotes) unaffected by OpaqueString [<a href="./rfc8265" title=""Preparation, Enforcement, and Comparison of Internationalized Strings Representing Usernames and Passwords"">RFC8265</a>] processing
Password: "The<U+00AD>M<U+00AA>tr<U+2168>" and "TheMatrIX" (without
quotes) respectively before and after OpaqueString [<a href="./rfc8265" title=""Preparation, Enforcement, and Comparison of Internationalized Strings Representing Usernames and Passwords"">RFC8265</a>]
processing
Nonce: "obMatJos2AAACf//499k954d6OL34oL9FSTvy64sA" (without quotes)
Realm: "example.org" (without quotes)
00 01 00 9c Request type and message length
21 12 a4 42 Magic cookie
78 ad 34 33 }
c6 ad 72 c0 } Transaction ID
29 da 41 2e }
00 1e 00 20 USERHASH attribute header
4a 3c f3 8f }
ef 69 92 bd }
a9 52 c6 78 }
04 17 da 0f } Userhash value (32 bytes)
24 81 94 15 }
56 9e 60 b2 }
05 c4 6e 41 }
40 7f 17 04 }
00 15 00 29 NONCE attribute header
6f 62 4d 61 }
74 4a 6f 73 }
32 41 41 41 }
43 66 2f 2f }
34 39 39 6b } Nonce value and padding (3 bytes)
39 35 34 64 }
36 4f 4c 33 }
34 6f 4c 39 }
46 53 54 76 }
79 36 34 73 }
41 00 00 00 }
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 65]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-66" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
00 14 00 0b REALM attribute header
65 78 61 6d }
70 6c 65 2e } Realm value (11 bytes) and padding (1 byte)
6f 72 67 00 }
00 1c 00 20 MESSAGE-INTEGRITY-SHA256 attribute header
e4 68 6c 8f }
0e de b5 90 }
13 e0 70 90 }
01 0a 93 ef } HMAC-SHA256 value
cc bc cc 54 }
4c 0a 45 d9 }
f8 30 aa 6d }
6f 73 5a 01 }
Acknowledgements
Thanks to Michael Tuexen, Tirumaleswar Reddy, Oleg Moskalenko, Simon
Perreault, Benjamin Schwartz, Rifaat Shekh-Yusef, Alan Johnston,
Jonathan Lennox, Brandon Williams, Olle Johansson, Martin Thomson,
Mihaly Meszaros, Tolga Asveren, Noriyuki Torii, Spencer Dawkins, Dale
Worley, Matthew Miller, Peter Saint-Andre, Julien Elie, Mirja
Kuehlewind, Eric Rescorla, Ben Campbell, Adam Roach, Alexey Melnikov,
and Benjamin Kaduk for the comments, suggestions, and questions that
helped improve this document.
The Acknowledgements section of <a href="./rfc5389">RFC 5389</a> appeared as follows:
The authors would like to thank Cedric Aoun, Pete Cordell, Cullen
Jennings, Bob Penfield, Xavier Marjou, Magnus Westerlund, Miguel
Garcia, Bruce Lowekamp, and Chris Sullivan for their comments, and
Baruch Sterman and Alan Hawrylyshen for initial implementations.
Thanks for Leslie Daigle, Allison Mankin, Eric Rescorla, and Henning
Schulzrinne for IESG and IAB input on this work.
Contributors
Christian Huitema and Joel Weinberger were original coauthors of
<a href="./rfc3489">RFC 3489</a>.
<span class="grey">Petit-Huguenin, et al. Standards Track [Page 66]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-67" ></span>
<span class="grey"><a href="./rfc8489">RFC 8489</a> STUN February 2020</span>
Authors' Addresses
Marc Petit-Huguenin
Impedance Mismatch
Email: marc@petit-huguenin.org
Gonzalo Salgueiro
Cisco
7200-12 Kit Creek Road
Research Triangle Park, NC 27709
United States of America
Email: gsalguei@cisco.com
Jonathan Rosenberg
Five9
Edison, NJ
United States of America
Email: jdrosen@jdrosen.net
URI: <a href="http://www.jdrosen.net">http://www.jdrosen.net</a>
Dan Wing
Citrix Systems, Inc.
United States of America
Email: dwing-ietf@fuggles.com
Rohan Mahy
Unaffiliated
Email: rohan.ietf@gmail.com
Philip Matthews
Nokia
600 March Road
Ottawa, Ontario K2K 2T6
Canada
Phone: 613-784-3139
Email: philip_matthews@magma.ca
Petit-Huguenin, et al. Standards Track [Page 67]
</pre>
|