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 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269
|
<pre>Internet Engineering Task Force (IETF) Z. Shelby
Request for Comments: 7252 ARM
Category: Standards Track K. Hartke
ISSN: 2070-1721 C. Bormann
Universitaet Bremen TZI
June 2014
<span class="h1">The Constrained Application Protocol (CoAP)</span>
Abstract
The Constrained Application Protocol (CoAP) is a specialized web
transfer protocol for use with constrained nodes and constrained
(e.g., low-power, lossy) networks. The nodes often have 8-bit
microcontrollers with small amounts of ROM and RAM, while constrained
networks such as IPv6 over Low-Power Wireless Personal Area Networks
(6LoWPANs) often have high packet error rates and a typical
throughput of 10s of kbit/s. The protocol is designed for machine-
to-machine (M2M) applications such as smart energy and building
automation.
CoAP provides a request/response interaction model between
application endpoints, supports built-in discovery of services and
resources, and includes key concepts of the Web such as URIs and
Internet media types. CoAP is designed to easily interface with HTTP
for integration with the Web while meeting specialized requirements
such as multicast support, very low overhead, and simplicity for
constrained environments.
Status of This Memo
This is an Internet Standards Track document.
This document is a product of the Internet Engineering Task Force
(IETF). It represents the consensus of the IETF community. It has
received public review and has been approved for publication by the
Internet Engineering Steering Group (IESG). Further information on
Internet Standards is available in <a href="./rfc5741#section-2">Section 2 of RFC 5741</a>.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
<a href="http://www.rfc-editor.org/info/rfc7252">http://www.rfc-editor.org/info/rfc7252</a>.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
Copyright Notice
Copyright (c) 2014 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal
Provisions Relating to IETF Documents
(<a href="http://trustee.ietf.org/license-info">http://trustee.ietf.org/license-info</a>) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
<a href="#section-1">1</a>. Introduction . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-5">5</a>
<a href="#section-1.1">1.1</a>. Features . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-5">5</a>
<a href="#section-1.2">1.2</a>. Terminology . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-6">6</a>
<a href="#section-2">2</a>. Constrained Application Protocol . . . . . . . . . . . . . . <a href="#page-10">10</a>
<a href="#section-2.1">2.1</a>. Messaging Model . . . . . . . . . . . . . . . . . . . . . <a href="#page-11">11</a>
<a href="#section-2.2">2.2</a>. Request/Response Model . . . . . . . . . . . . . . . . . <a href="#page-12">12</a>
<a href="#section-2.3">2.3</a>. Intermediaries and Caching . . . . . . . . . . . . . . . <a href="#page-15">15</a>
<a href="#section-2.4">2.4</a>. Resource Discovery . . . . . . . . . . . . . . . . . . . <a href="#page-15">15</a>
<a href="#section-3">3</a>. Message Format . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-15">15</a>
<a href="#section-3.1">3.1</a>. Option Format . . . . . . . . . . . . . . . . . . . . . . <a href="#page-17">17</a>
<a href="#section-3.2">3.2</a>. Option Value Formats . . . . . . . . . . . . . . . . . . <a href="#page-19">19</a>
<a href="#section-4">4</a>. Message Transmission . . . . . . . . . . . . . . . . . . . . <a href="#page-20">20</a>
<a href="#section-4.1">4.1</a>. Messages and Endpoints . . . . . . . . . . . . . . . . . <a href="#page-20">20</a>
<a href="#section-4.2">4.2</a>. Messages Transmitted Reliably . . . . . . . . . . . . . . <a href="#page-21">21</a>
<a href="#section-4.3">4.3</a>. Messages Transmitted without Reliability . . . . . . . . <a href="#page-23">23</a>
<a href="#section-4.4">4.4</a>. Message Correlation . . . . . . . . . . . . . . . . . . . <a href="#page-24">24</a>
<a href="#section-4.5">4.5</a>. Message Deduplication . . . . . . . . . . . . . . . . . . <a href="#page-24">24</a>
<a href="#section-4.6">4.6</a>. Message Size . . . . . . . . . . . . . . . . . . . . . . <a href="#page-25">25</a>
<a href="#section-4.7">4.7</a>. Congestion Control . . . . . . . . . . . . . . . . . . . <a href="#page-26">26</a>
<a href="#section-4.8">4.8</a>. Transmission Parameters . . . . . . . . . . . . . . . . . <a href="#page-27">27</a>
<a href="#section-4.8.1">4.8.1</a>. Changing the Parameters . . . . . . . . . . . . . . . <a href="#page-27">27</a>
<a href="#section-4.8.2">4.8.2</a>. Time Values Derived from Transmission Parameters . . <a href="#page-28">28</a>
<a href="#section-5">5</a>. Request/Response Semantics . . . . . . . . . . . . . . . . . <a href="#page-31">31</a>
<a href="#section-5.1">5.1</a>. Requests . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-31">31</a>
<a href="#section-5.2">5.2</a>. Responses . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-31">31</a>
<a href="#section-5.2.1">5.2.1</a>. Piggybacked . . . . . . . . . . . . . . . . . . . . . <a href="#page-33">33</a>
<a href="#section-5.2.2">5.2.2</a>. Separate . . . . . . . . . . . . . . . . . . . . . . <a href="#page-33">33</a>
<a href="#section-5.2.3">5.2.3</a>. Non-confirmable . . . . . . . . . . . . . . . . . . . <a href="#page-34">34</a>
<a href="#section-5.3">5.3</a>. Request/Response Matching . . . . . . . . . . . . . . . . <a href="#page-34">34</a>
<a href="#section-5.3.1">5.3.1</a>. Token . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-34">34</a>
<a href="#section-5.3.2">5.3.2</a>. Request/Response Matching Rules . . . . . . . . . . . <a href="#page-35">35</a>
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<a href="#section-5.4">5.4</a>. Options . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-36">36</a>
<a href="#section-5.4.1">5.4.1</a>. Critical/Elective . . . . . . . . . . . . . . . . . . <a href="#page-37">37</a>
<a href="#section-5.4.2">5.4.2</a>. Proxy Unsafe or Safe-to-Forward and NoCacheKey . . . <a href="#page-38">38</a>
<a href="#section-5.4.3">5.4.3</a>. Length . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-38">38</a>
<a href="#section-5.4.4">5.4.4</a>. Default Values . . . . . . . . . . . . . . . . . . . <a href="#page-38">38</a>
<a href="#section-5.4.5">5.4.5</a>. Repeatable Options . . . . . . . . . . . . . . . . . <a href="#page-39">39</a>
<a href="#section-5.4.6">5.4.6</a>. Option Numbers . . . . . . . . . . . . . . . . . . . <a href="#page-39">39</a>
<a href="#section-5.5">5.5</a>. Payloads and Representations . . . . . . . . . . . . . . <a href="#page-40">40</a>
<a href="#section-5.5.1">5.5.1</a>. Representation . . . . . . . . . . . . . . . . . . . <a href="#page-40">40</a>
<a href="#section-5.5.2">5.5.2</a>. Diagnostic Payload . . . . . . . . . . . . . . . . . <a href="#page-41">41</a>
<a href="#section-5.5.3">5.5.3</a>. Selected Representation . . . . . . . . . . . . . . . <a href="#page-41">41</a>
<a href="#section-5.5.4">5.5.4</a>. Content Negotiation . . . . . . . . . . . . . . . . . <a href="#page-41">41</a>
<a href="#section-5.6">5.6</a>. Caching . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-42">42</a>
<a href="#section-5.6.1">5.6.1</a>. Freshness Model . . . . . . . . . . . . . . . . . . . <a href="#page-43">43</a>
<a href="#section-5.6.2">5.6.2</a>. Validation Model . . . . . . . . . . . . . . . . . . <a href="#page-43">43</a>
<a href="#section-5.7">5.7</a>. Proxying . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-44">44</a>
<a href="#section-5.7.1">5.7.1</a>. Proxy Operation . . . . . . . . . . . . . . . . . . . <a href="#page-44">44</a>
<a href="#section-5.7.2">5.7.2</a>. Forward-Proxies . . . . . . . . . . . . . . . . . . . <a href="#page-46">46</a>
<a href="#section-5.7.3">5.7.3</a>. Reverse-Proxies . . . . . . . . . . . . . . . . . . . <a href="#page-46">46</a>
<a href="#section-5.8">5.8</a>. Method Definitions . . . . . . . . . . . . . . . . . . . <a href="#page-47">47</a>
<a href="#section-5.8.1">5.8.1</a>. GET . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-47">47</a>
<a href="#section-5.8.2">5.8.2</a>. POST . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-47">47</a>
<a href="#section-5.8.3">5.8.3</a>. PUT . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-48">48</a>
<a href="#section-5.8.4">5.8.4</a>. DELETE . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-48">48</a>
<a href="#section-5.9">5.9</a>. Response Code Definitions . . . . . . . . . . . . . . . . <a href="#page-48">48</a>
<a href="#section-5.9.1">5.9.1</a>. Success 2.xx . . . . . . . . . . . . . . . . . . . . <a href="#page-48">48</a>
<a href="#section-5.9.2">5.9.2</a>. Client Error 4.xx . . . . . . . . . . . . . . . . . . <a href="#page-50">50</a>
<a href="#section-5.9.3">5.9.3</a>. Server Error 5.xx . . . . . . . . . . . . . . . . . . <a href="#page-51">51</a>
<a href="#section-5.10">5.10</a>. Option Definitions . . . . . . . . . . . . . . . . . . . <a href="#page-52">52</a>
<a href="#section-5.10.1">5.10.1</a>. Uri-Host, Uri-Port, Uri-Path, and Uri-Query . . . . <a href="#page-53">53</a>
<a href="#section-5.10.2">5.10.2</a>. Proxy-Uri and Proxy-Scheme . . . . . . . . . . . . . <a href="#page-54">54</a>
<a href="#section-5.10.3">5.10.3</a>. Content-Format . . . . . . . . . . . . . . . . . . . <a href="#page-55">55</a>
<a href="#section-5.10.4">5.10.4</a>. Accept . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-55">55</a>
<a href="#section-5.10.5">5.10.5</a>. Max-Age . . . . . . . . . . . . . . . . . . . . . . <a href="#page-55">55</a>
<a href="#section-5.10.6">5.10.6</a>. ETag . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-56">56</a>
<a href="#section-5.10.7">5.10.7</a>. Location-Path and Location-Query . . . . . . . . . . <a href="#page-57">57</a>
<a href="#section-5.10.8">5.10.8</a>. Conditional Request Options . . . . . . . . . . . . <a href="#page-57">57</a>
<a href="#section-5.10.9">5.10.9</a>. Size1 Option . . . . . . . . . . . . . . . . . . . . <a href="#page-59">59</a>
<a href="#section-6">6</a>. CoAP URIs . . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-59">59</a>
<a href="#section-6.1">6.1</a>. coap URI Scheme . . . . . . . . . . . . . . . . . . . . . <a href="#page-59">59</a>
<a href="#section-6.2">6.2</a>. coaps URI Scheme . . . . . . . . . . . . . . . . . . . . <a href="#page-60">60</a>
<a href="#section-6.3">6.3</a>. Normalization and Comparison Rules . . . . . . . . . . . <a href="#page-61">61</a>
<a href="#section-6.4">6.4</a>. Decomposing URIs into Options . . . . . . . . . . . . . . <a href="#page-61">61</a>
<a href="#section-6.5">6.5</a>. Composing URIs from Options . . . . . . . . . . . . . . . <a href="#page-62">62</a>
<a href="#section-7">7</a>. Discovery . . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-64">64</a>
<a href="#section-7.1">7.1</a>. Service Discovery . . . . . . . . . . . . . . . . . . . . <a href="#page-64">64</a>
<a href="#section-7.2">7.2</a>. Resource Discovery . . . . . . . . . . . . . . . . . . . <a href="#page-64">64</a>
<a href="#section-7.2.1">7.2.1</a>. 'ct' Attribute . . . . . . . . . . . . . . . . . . . <a href="#page-64">64</a>
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<a href="#section-8">8</a>. Multicast CoAP . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-65">65</a>
<a href="#section-8.1">8.1</a>. Messaging Layer . . . . . . . . . . . . . . . . . . . . . <a href="#page-65">65</a>
<a href="#section-8.2">8.2</a>. Request/Response Layer . . . . . . . . . . . . . . . . . <a href="#page-66">66</a>
<a href="#section-8.2.1">8.2.1</a>. Caching . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-67">67</a>
<a href="#section-8.2.2">8.2.2</a>. Proxying . . . . . . . . . . . . . . . . . . . . . . <a href="#page-67">67</a>
<a href="#section-9">9</a>. Securing CoAP . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-68">68</a>
<a href="#section-9.1">9.1</a>. DTLS-Secured CoAP . . . . . . . . . . . . . . . . . . . . <a href="#page-69">69</a>
<a href="#section-9.1.1">9.1.1</a>. Messaging Layer . . . . . . . . . . . . . . . . . . . <a href="#page-70">70</a>
<a href="#section-9.1.2">9.1.2</a>. Request/Response Layer . . . . . . . . . . . . . . . <a href="#page-71">71</a>
<a href="#section-9.1.3">9.1.3</a>. Endpoint Identity . . . . . . . . . . . . . . . . . . <a href="#page-71">71</a>
<a href="#section-10">10</a>. Cross-Protocol Proxying between CoAP and HTTP . . . . . . . . <a href="#page-74">74</a>
<a href="#section-10.1">10.1</a>. CoAP-HTTP Proxying . . . . . . . . . . . . . . . . . . . <a href="#page-75">75</a>
<a href="#section-10.1.1">10.1.1</a>. GET . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-76">76</a>
<a href="#section-10.1.2">10.1.2</a>. PUT . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-77">77</a>
<a href="#section-10.1.3">10.1.3</a>. DELETE . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-77">77</a>
<a href="#section-10.1.4">10.1.4</a>. POST . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-77">77</a>
<a href="#section-10.2">10.2</a>. HTTP-CoAP Proxying . . . . . . . . . . . . . . . . . . . <a href="#page-77">77</a>
<a href="#section-10.2.1">10.2.1</a>. OPTIONS and TRACE . . . . . . . . . . . . . . . . . <a href="#page-78">78</a>
<a href="#section-10.2.2">10.2.2</a>. GET . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-78">78</a>
<a href="#section-10.2.3">10.2.3</a>. HEAD . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-79">79</a>
<a href="#section-10.2.4">10.2.4</a>. POST . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-79">79</a>
<a href="#section-10.2.5">10.2.5</a>. PUT . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-79">79</a>
<a href="#section-10.2.6">10.2.6</a>. DELETE . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-80">80</a>
<a href="#section-10.2.7">10.2.7</a>. CONNECT . . . . . . . . . . . . . . . . . . . . . . <a href="#page-80">80</a>
<a href="#section-11">11</a>. Security Considerations . . . . . . . . . . . . . . . . . . . <a href="#page-80">80</a>
<a href="#section-11.1">11.1</a>. Parsing the Protocol and Processing URIs . . . . . . . . <a href="#page-80">80</a>
<a href="#section-11.2">11.2</a>. Proxying and Caching . . . . . . . . . . . . . . . . . . <a href="#page-81">81</a>
<a href="#section-11.3">11.3</a>. Risk of Amplification . . . . . . . . . . . . . . . . . <a href="#page-81">81</a>
<a href="#section-11.4">11.4</a>. IP Address Spoofing Attacks . . . . . . . . . . . . . . <a href="#page-83">83</a>
<a href="#section-11.5">11.5</a>. Cross-Protocol Attacks . . . . . . . . . . . . . . . . . <a href="#page-84">84</a>
<a href="#section-11.6">11.6</a>. Constrained-Node Considerations . . . . . . . . . . . . <a href="#page-86">86</a>
<a href="#section-12">12</a>. IANA Considerations . . . . . . . . . . . . . . . . . . . . . <a href="#page-86">86</a>
<a href="#section-12.1">12.1</a>. CoAP Code Registries . . . . . . . . . . . . . . . . . . <a href="#page-86">86</a>
<a href="#section-12.1.1">12.1.1</a>. Method Codes . . . . . . . . . . . . . . . . . . . . <a href="#page-87">87</a>
<a href="#section-12.1.2">12.1.2</a>. Response Codes . . . . . . . . . . . . . . . . . . . <a href="#page-88">88</a>
<a href="#section-12.2">12.2</a>. CoAP Option Numbers Registry . . . . . . . . . . . . . . <a href="#page-89">89</a>
<a href="#section-12.3">12.3</a>. CoAP Content-Formats Registry . . . . . . . . . . . . . <a href="#page-91">91</a>
<a href="#section-12.4">12.4</a>. URI Scheme Registration . . . . . . . . . . . . . . . . <a href="#page-93">93</a>
<a href="#section-12.5">12.5</a>. Secure URI Scheme Registration . . . . . . . . . . . . . <a href="#page-94">94</a>
<a href="#section-12.6">12.6</a>. Service Name and Port Number Registration . . . . . . . <a href="#page-95">95</a>
<a href="#section-12.7">12.7</a>. Secure Service Name and Port Number Registration . . . . <a href="#page-96">96</a>
<a href="#section-12.8">12.8</a>. Multicast Address Registration . . . . . . . . . . . . . <a href="#page-97">97</a>
<a href="#section-13">13</a>. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . <a href="#page-97">97</a>
<a href="#section-14">14</a>. References . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-98">98</a>
<a href="#section-14.1">14.1</a>. Normative References . . . . . . . . . . . . . . . . . . <a href="#page-98">98</a>
<a href="#section-14.2">14.2</a>. Informative References . . . . . . . . . . . . . . . . . <a href="#page-100">100</a>
<a href="#appendix-A">Appendix A</a>. Examples . . . . . . . . . . . . . . . . . . . . . . <a href="#page-104">104</a>
<a href="#appendix-B">Appendix B</a>. URI Examples . . . . . . . . . . . . . . . . . . . . <a href="#page-110">110</a>
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
The use of web services (web APIs) on the Internet has become
ubiquitous in most applications and depends on the fundamental
Representational State Transfer [<a href="#ref-REST" title=""Architectural Styles and the Design of Network-based Software Architectures"">REST</a>] architecture of the Web.
The work on Constrained RESTful Environments (CoRE) aims at realizing
the REST architecture in a suitable form for the most constrained
nodes (e.g., 8-bit microcontrollers with limited RAM and ROM) and
networks (e.g., 6LoWPAN, [<a href="./rfc4944" title=""Transmission of IPv6 Packets over IEEE 802.15.4 Networks"">RFC4944</a>]). Constrained networks such as
6LoWPAN support the fragmentation of IPv6 packets into small link-
layer frames; however, this causes significant reduction in packet
delivery probability. One design goal of CoAP has been to keep
message overhead small, thus limiting the need for fragmentation.
One of the main goals of CoAP is to design a generic web protocol for
the special requirements of this constrained environment, especially
considering energy, building automation, and other machine-to-machine
(M2M) applications. The goal of CoAP is not to blindly compress HTTP
[<a href="./rfc2616" title=""Hypertext Transfer Protocol -- HTTP/1.1"">RFC2616</a>], but rather to realize a subset of REST common with HTTP
but optimized for M2M applications. Although CoAP could be used for
refashioning simple HTTP interfaces into a more compact protocol,
more importantly it also offers features for M2M such as built-in
discovery, multicast support, and asynchronous message exchanges.
This document specifies the Constrained Application Protocol (CoAP),
which easily translates to HTTP for integration with the existing Web
while meeting specialized requirements such as multicast support,
very low overhead, and simplicity for constrained environments and
M2M applications.
<span class="h3"><a class="selflink" id="section-1.1" href="#section-1.1">1.1</a>. Features</span>
CoAP has the following main features:
o Web protocol fulfilling M2M requirements in constrained
environments
o UDP [<a href="./rfc0768" title=""User Datagram Protocol"">RFC0768</a>] binding with optional reliability supporting unicast
and multicast requests.
o Asynchronous message exchanges.
o Low header overhead and parsing complexity.
o URI and Content-type support.
o Simple proxy and caching capabilities.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
o A stateless HTTP mapping, allowing proxies to be built providing
access to CoAP resources via HTTP in a uniform way or for HTTP
simple interfaces to be realized alternatively over CoAP.
o Security binding to Datagram Transport Layer Security (DTLS)
[<a href="./rfc6347" title=""Datagram Transport Layer Security Version 1.2"">RFC6347</a>].
<span class="h3"><a class="selflink" id="section-1.2" href="#section-1.2">1.2</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="./rfc2119" title=""Key words for use in RFCs to Indicate Requirement Levels"">RFC2119</a>] when they appear in ALL CAPS. These words may also appear
in this document in lowercase, absent their normative meanings.
This specification requires readers to be familiar with all the terms
and concepts that are discussed in [<a href="./rfc2616" title=""Hypertext Transfer Protocol -- HTTP/1.1"">RFC2616</a>], including "resource",
"representation", "cache", and "fresh". (Having been completed
before the updated set of HTTP RFCs, <a href="./rfc7230">RFC 7230</a> to <a href="./rfc7235">RFC 7235</a>, became
available, this specification specifically references the predecessor
version -- <a href="./rfc2616">RFC 2616</a>.) In addition, this specification defines the
following terminology:
Endpoint
An entity participating in the CoAP protocol. Colloquially, an
endpoint lives on a "Node", although "Host" would be more
consistent with Internet standards usage, and is further
identified by transport-layer multiplexing information that can
include a UDP port number and a security association
(<a href="#section-4.1">Section 4.1</a>).
Sender
The originating endpoint of a message. When the aspect of
identification of the specific sender is in focus, also "source
endpoint".
Recipient
The destination endpoint of a message. When the aspect of
identification of the specific recipient is in focus, also
"destination endpoint".
Client
The originating endpoint of a request; the destination endpoint of
a response.
Server
The destination endpoint of a request; the originating endpoint of
a response.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
Origin Server
The server on which a given resource resides or is to be created.
Intermediary
A CoAP endpoint that acts both as a server and as a client towards
an origin server (possibly via further intermediaries). A common
form of an intermediary is a proxy; several classes of such
proxies are discussed in this specification.
Proxy
An intermediary that mainly is concerned with forwarding requests
and relaying back responses, possibly performing caching,
namespace translation, or protocol translation in the process. As
opposed to intermediaries in the general sense, proxies generally
do not implement specific application semantics. Based on the
position in the overall structure of the request forwarding, there
are two common forms of proxy: forward-proxy and reverse-proxy.
In some cases, a single endpoint might act as an origin server,
forward-proxy, or reverse-proxy, switching behavior based on the
nature of each request.
Forward-Proxy
An endpoint selected by a client, usually via local configuration
rules, to perform requests on behalf of the client, doing any
necessary translations. Some translations are minimal, such as
for proxy requests for "coap" URIs, whereas other requests might
require translation to and from entirely different application-
layer protocols.
Reverse-Proxy
An endpoint that stands in for one or more other server(s) and
satisfies requests on behalf of these, doing any necessary
translations. Unlike a forward-proxy, the client may not be aware
that it is communicating with a reverse-proxy; a reverse-proxy
receives requests as if it were the origin server for the target
resource.
CoAP-to-CoAP Proxy
A proxy that maps from a CoAP request to a CoAP request, i.e.,
uses the CoAP protocol both on the server and the client side.
Contrast to cross-proxy.
Cross-Proxy
A cross-protocol proxy, or "cross-proxy" for short, is a proxy
that translates between different protocols, such as a CoAP-to-
HTTP proxy or an HTTP-to-CoAP proxy. While this specification
makes very specific demands of CoAP-to-CoAP proxies, there is more
variation possible in cross-proxies.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
Confirmable Message
Some messages require an acknowledgement. These messages are
called "Confirmable". When no packets are lost, each Confirmable
message elicits exactly one return message of type Acknowledgement
or type Reset.
Non-confirmable Message
Some other messages do not require an acknowledgement. This is
particularly true for messages that are repeated regularly for
application requirements, such as repeated readings from a sensor.
Acknowledgement Message
An Acknowledgement message acknowledges that a specific
Confirmable message arrived. By itself, an Acknowledgement
message does not indicate success or failure of any request
encapsulated in the Confirmable message, but the Acknowledgement
message may also carry a Piggybacked Response (see below).
Reset Message
A Reset message indicates that a specific message (Confirmable or
Non-confirmable) was received, but some context is missing to
properly process it. This condition is usually caused when the
receiving node has rebooted and has forgotten some state that
would be required to interpret the message. Provoking a Reset
message (e.g., by sending an Empty Confirmable message) is also
useful as an inexpensive check of the liveness of an endpoint
("CoAP ping").
Piggybacked Response
A piggybacked Response is included right in a CoAP Acknowledgement
(ACK) message that is sent to acknowledge receipt of the Request
for this Response (<a href="#section-5.2.1">Section 5.2.1</a>).
Separate Response
When a Confirmable message carrying a request is acknowledged with
an Empty message (e.g., because the server doesn't have the answer
right away), a Separate Response is sent in a separate message
exchange (<a href="#section-5.2.2">Section 5.2.2</a>).
Empty Message
A message with a Code of 0.00; neither a request nor a response.
An Empty message only contains the 4-byte header.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
Critical Option
An option that would need to be understood by the endpoint
ultimately receiving the message in order to properly process the
message (<a href="#section-5.4.1">Section 5.4.1</a>). Note that the implementation of critical
options is, as the name "Option" implies, generally optional:
unsupported critical options lead to an error response or summary
rejection of the message.
Elective Option
An option that is intended to be ignored by an endpoint that does
not understand it. Processing the message even without
understanding the option is acceptable (<a href="#section-5.4.1">Section 5.4.1</a>).
Unsafe Option
An option that would need to be understood by a proxy receiving
the message in order to safely forward the message
(<a href="#section-5.4.2">Section 5.4.2</a>). Not every critical option is an unsafe option.
Safe-to-Forward Option
An option that is intended to be safe for forwarding by a proxy
that does not understand it. Forwarding the message even without
understanding the option is acceptable (<a href="#section-5.4.2">Section 5.4.2</a>).
Resource Discovery
The process where a CoAP client queries a server for its list of
hosted resources (i.e., links as defined in <a href="#section-7">Section 7</a>).
Content-Format
The combination of an Internet media type, potentially with
specific parameters given, and a content-coding (which is often
the identity content-coding), identified by a numeric identifier
defined by the "CoAP Content-Formats" registry. When the focus is
less on the numeric identifier than on the combination of these
characteristics of a resource representation, this is also called
"representation format".
Additional terminology for constrained nodes and constrained-node
networks can be found in [<a href="./rfc7228" title=""Terminology for Constrained-Node Networks"">RFC7228</a>].
In this specification, the term "byte" is used in its now customary
sense as a synonym for "octet".
All multi-byte integers in this protocol are interpreted in network
byte order.
Where arithmetic is used, this specification uses the notation
familiar from the programming language C, except that the operator
"**" stands for exponentiation.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Constrained Application Protocol</span>
The interaction model of CoAP is similar to the client/server model
of HTTP. However, machine-to-machine interactions typically result
in a CoAP implementation acting in both client and server roles. A
CoAP request is equivalent to that of HTTP and is sent by a client to
request an action (using a Method Code) on a resource (identified by
a URI) on a server. The server then sends a response with a Response
Code; this response may include a resource representation.
Unlike HTTP, CoAP deals with these interchanges asynchronously over a
datagram-oriented transport such as UDP. This is done logically
using a layer of messages that supports optional reliability (with
exponential back-off). CoAP defines four types of messages:
Confirmable, Non-confirmable, Acknowledgement, Reset. Method Codes
and Response Codes included in some of these messages make them carry
requests or responses. The basic exchanges of the four types of
messages are somewhat orthogonal to the request/response
interactions; requests can be carried in Confirmable and Non-
confirmable messages, and responses can be carried in these as well
as piggybacked in Acknowledgement messages.
One could think of CoAP logically as using a two-layer approach, a
CoAP messaging layer used to deal with UDP and the asynchronous
nature of the interactions, and the request/response interactions
using Method and Response Codes (see Figure 1). CoAP is however a
single protocol, with messaging and request/response as just features
of the CoAP header.
+----------------------+
| Application |
+----------------------+
+----------------------+ \
| Requests/Responses | |
|----------------------| | CoAP
| Messages | |
+----------------------+ /
+----------------------+
| UDP |
+----------------------+
Figure 1: Abstract Layering of CoAP
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h3"><a class="selflink" id="section-2.1" href="#section-2.1">2.1</a>. Messaging Model</span>
The CoAP messaging model is based on the exchange of messages over
UDP between endpoints.
CoAP uses a short fixed-length binary header (4 bytes) that may be
followed by compact binary options and a payload. This message
format is shared by requests and responses. The CoAP message format
is specified in <a href="#section-3">Section 3</a>. Each message contains a Message ID used
to detect duplicates and for optional reliability. (The Message ID
is compact; its 16-bit size enables up to about 250 messages per
second from one endpoint to another with default protocol
parameters.)
Reliability is provided by marking a message as Confirmable (CON). A
Confirmable message is retransmitted using a default timeout and
exponential back-off between retransmissions, until the recipient
sends an Acknowledgement message (ACK) with the same Message ID (in
this example, 0x7d34) from the corresponding endpoint; see Figure 2.
When a recipient is not at all able to process a Confirmable message
(i.e., not even able to provide a suitable error response), it
replies with a Reset message (RST) instead of an Acknowledgement
(ACK).
Client Server
| |
| CON [0x7d34] |
+----------------->|
| |
| ACK [0x7d34] |
|<-----------------+
| |
Figure 2: Reliable Message Transmission
A message that does not require reliable transmission (for example,
each single measurement out of a stream of sensor data) can be sent
as a Non-confirmable message (NON). These are not acknowledged, but
still have a Message ID for duplicate detection (in this example,
0x01a0); see Figure 3. When a recipient is not able to process a
Non-confirmable message, it may reply with a Reset message (RST).
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
Client Server
| |
| NON [0x01a0] |
+----------------->|
| |
Figure 3: Unreliable Message Transmission
See <a href="#section-4">Section 4</a> for details of CoAP messages.
As CoAP runs over UDP, it also supports the use of multicast IP
destination addresses, enabling multicast CoAP requests. <a href="#section-8">Section 8</a>
discusses the proper use of CoAP messages with multicast addresses
and precautions for avoiding response congestion.
Several security modes are defined for CoAP in <a href="#section-9">Section 9</a> ranging from
no security to certificate-based security. This document specifies a
binding to DTLS for securing the protocol; the use of IPsec with CoAP
is discussed in [<a href="#ref-IPsec-CoAP">IPsec-CoAP</a>].
<span class="h3"><a class="selflink" id="section-2.2" href="#section-2.2">2.2</a>. Request/Response Model</span>
CoAP request and response semantics are carried in CoAP messages,
which include either a Method Code or Response Code, respectively.
Optional (or default) request and response information, such as the
URI and payload media type are carried as CoAP options. A Token is
used to match responses to requests independently from the underlying
messages (<a href="#section-5.3">Section 5.3</a>). (Note that the Token is a concept separate
from the Message ID.)
A request is carried in a Confirmable (CON) or Non-confirmable (NON)
message, and, if immediately available, the response to a request
carried in a Confirmable message is carried in the resulting
Acknowledgement (ACK) message. This is called a piggybacked
response, detailed in <a href="#section-5.2.1">Section 5.2.1</a>. (There is no need for
separately acknowledging a piggybacked response, as the client will
retransmit the request if the Acknowledgement message carrying the
piggybacked response is lost.) Two examples for a basic GET request
with piggybacked response are shown in Figure 4, one successful, one
resulting in a 4.04 (Not Found) response.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
Client Server Client Server
| | | |
| CON [0xbc90] | | CON [0xbc91] |
| GET /temperature | | GET /temperature |
| (Token 0x71) | | (Token 0x72) |
+----------------->| +----------------->|
| | | |
| ACK [0xbc90] | | ACK [0xbc91] |
| 2.05 Content | | 4.04 Not Found |
| (Token 0x71) | | (Token 0x72) |
| "22.5 C" | | "Not found" |
|<-----------------+ |<-----------------+
| | | |
Figure 4: Two GET Requests with Piggybacked Responses
If the server is not able to respond immediately to a request carried
in a Confirmable message, it simply responds with an Empty
Acknowledgement message so that the client can stop retransmitting
the request. When the response is ready, the server sends it in a
new Confirmable message (which then in turn needs to be acknowledged
by the client). This is called a "separate response", as illustrated
in Figure 5 and described in more detail in <a href="#section-5.2.2">Section 5.2.2</a>.
Client Server
| |
| CON [0x7a10] |
| GET /temperature |
| (Token 0x73) |
+----------------->|
| |
| ACK [0x7a10] |
|<-----------------+
| |
... Time Passes ...
| |
| CON [0x23bb] |
| 2.05 Content |
| (Token 0x73) |
| "22.5 C" |
|<-----------------+
| |
| ACK [0x23bb] |
+----------------->|
| |
Figure 5: A GET Request with a Separate Response
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
If a request is sent in a Non-confirmable message, then the response
is sent using a new Non-confirmable message, although the server may
instead send a Confirmable message. This type of exchange is
illustrated in Figure 6.
Client Server
| |
| NON [0x7a11] |
| GET /temperature |
| (Token 0x74) |
+----------------->|
| |
| NON [0x23bc] |
| 2.05 Content |
| (Token 0x74) |
| "22.5 C" |
|<-----------------+
| |
Figure 6: A Request and a Response Carried in Non-confirmable
Messages
CoAP makes use of GET, PUT, POST, and DELETE methods in a similar
manner to HTTP, with the semantics specified in <a href="#section-5.8">Section 5.8</a>. (Note
that the detailed semantics of CoAP methods are "almost, but not
entirely unlike" [<a href="#ref-HHGTTG" title=""The Hitchhiker's Guide to the Galaxy"">HHGTTG</a>] those of HTTP methods: intuition taken from
HTTP experience generally does apply well, but there are enough
differences that make it worthwhile to actually read the present
specification.)
Methods beyond the basic four can be added to CoAP in separate
specifications. New methods do not necessarily have to use requests
and responses in pairs. Even for existing methods, a single request
may yield multiple responses, e.g., for a multicast request
(<a href="#section-8">Section 8</a>) or with the Observe option [<a href="#ref-OBSERVE" title=""Observing Resources in CoAP"">OBSERVE</a>].
URI support in a server is simplified as the client already parses
the URI and splits it into host, port, path, and query components,
making use of default values for efficiency. Response Codes relate
to a small subset of HTTP status codes with a few CoAP-specific codes
added, as defined in <a href="#section-5.9">Section 5.9</a>.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h3"><a class="selflink" id="section-2.3" href="#section-2.3">2.3</a>. Intermediaries and Caching</span>
The protocol supports the caching of responses in order to
efficiently fulfill requests. Simple caching is enabled using
freshness and validity information carried with CoAP responses. A
cache could be located in an endpoint or an intermediary. Caching
functionality is specified in <a href="#section-5.6">Section 5.6</a>.
Proxying is useful in constrained networks for several reasons,
including to limit network traffic, to improve performance, to access
resources of sleeping devices, and for security reasons. The
proxying of requests on behalf of another CoAP endpoint is supported
in the protocol. When using a proxy, the URI of the resource to
request is included in the request, while the destination IP address
is set to the address of the proxy. See <a href="#section-5.7">Section 5.7</a> for more
information on proxy functionality.
As CoAP was designed according to the REST architecture [<a href="#ref-REST" title=""Architectural Styles and the Design of Network-based Software Architectures"">REST</a>], and
thus exhibits functionality similar to that of the HTTP protocol, it
is quite straightforward to map from CoAP to HTTP and from HTTP to
CoAP. Such a mapping may be used to realize an HTTP REST interface
using CoAP or to convert between HTTP and CoAP. This conversion can
be carried out by a cross-protocol proxy ("cross-proxy"), which
converts the Method or Response Code, media type, and options to the
corresponding HTTP feature. <a href="#section-10">Section 10</a> provides more detail about
HTTP mapping.
<span class="h3"><a class="selflink" id="section-2.4" href="#section-2.4">2.4</a>. Resource Discovery</span>
Resource discovery is important for machine-to-machine interactions
and is supported using the CoRE Link Format [<a href="./rfc6690" title=""Constrained RESTful Environments (CoRE) Link Format"">RFC6690</a>] as discussed in
<a href="#section-7">Section 7</a>.
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Message Format</span>
CoAP is based on the exchange of compact messages that, by default,
are transported over UDP (i.e., each CoAP message occupies the data
section of one UDP datagram). CoAP may also be used over Datagram
Transport Layer Security (DTLS) (see <a href="#section-9.1">Section 9.1</a>). It could also be
used over other transports such as SMS, TCP, or SCTP, the
specification of which is out of this document's scope. (UDP-lite
[<a href="./rfc3828" title=""The Lightweight User Datagram Protocol (UDP-Lite)"">RFC3828</a>] and UDP zero checksum [<a href="./rfc6936" title=""Applicability Statement for the Use of IPv6 UDP Datagrams with Zero Checksums"">RFC6936</a>] are not supported by CoAP.)
CoAP messages are encoded in a simple binary format. The message
format starts with a fixed-size 4-byte header. This is followed by a
variable-length Token value, which can be between 0 and 8 bytes long.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
Following the Token value comes a sequence of zero or more CoAP
Options in Type-Length-Value (TLV) format, optionally followed by a
payload that takes up the rest of the datagram.
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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|Ver| T | TKL | Code | Message ID |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Token (if any, TKL bytes) ...
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Options (if any) ...
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|1 1 1 1 1 1 1 1| Payload (if any) ...
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Figure 7: Message Format
The fields in the header are defined as follows:
Version (Ver): 2-bit unsigned integer. Indicates the CoAP version
number. Implementations of this specification MUST set this field
to 1 (01 binary). Other values are reserved for future versions.
Messages with unknown version numbers MUST be silently ignored.
Type (T): 2-bit unsigned integer. Indicates if this message is of
type Confirmable (0), Non-confirmable (1), Acknowledgement (2), or
Reset (3). The semantics of these message types are defined in
<a href="#section-4">Section 4</a>.
Token Length (TKL): 4-bit unsigned integer. Indicates the length of
the variable-length Token field (0-8 bytes). Lengths 9-15 are
reserved, MUST NOT be sent, and MUST be processed as a message
format error.
Code: 8-bit unsigned integer, split into a 3-bit class (most
significant bits) and a 5-bit detail (least significant bits),
documented as "c.dd" where "c" is a digit from 0 to 7 for the
3-bit subfield and "dd" are two digits from 00 to 31 for the 5-bit
subfield. The class can indicate a request (0), a success
response (2), a client error response (4), or a server error
response (5). (All other class values are reserved.) As a
special case, Code 0.00 indicates an Empty message. In case of a
request, the Code field indicates the Request Method; in case of a
response, a Response Code. Possible values are maintained in the
CoAP Code Registries (<a href="#section-12.1">Section 12.1</a>). The semantics of requests
and responses are defined in <a href="#section-5">Section 5</a>.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
Message ID: 16-bit unsigned integer in network byte order. Used to
detect message duplication and to match messages of type
Acknowledgement/Reset to messages of type Confirmable/Non-
confirmable. The rules for generating a Message ID and matching
messages are defined in <a href="#section-4">Section 4</a>.
The header is followed by the Token value, which may be 0 to 8 bytes,
as given by the Token Length field. The Token value is used to
correlate requests and responses. The rules for generating a Token
and correlating requests and responses are defined in <a href="#section-5.3.1">Section 5.3.1</a>.
Header and Token are followed by zero or more Options (<a href="#section-3.1">Section 3.1</a>).
An Option can be followed by the end of the message, by another
Option, or by the Payload Marker and the payload.
Following the header, token, and options, if any, comes the optional
payload. If present and of non-zero length, it is prefixed by a
fixed, one-byte Payload Marker (0xFF), which indicates the end of
options and the start of the payload. The payload data extends from
after the marker to the end of the UDP datagram, i.e., the Payload
Length is calculated from the datagram size. The absence of the
Payload Marker denotes a zero-length payload. The presence of a
marker followed by a zero-length payload MUST be processed as a
message format error.
Implementation Note: The byte value 0xFF may also occur within an
option length or value, so simple byte-wise scanning for 0xFF is
not a viable technique for finding the payload marker. The byte
0xFF has the meaning of a payload marker only where the beginning
of another option could occur.
<span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>. Option Format</span>
CoAP defines a number of options that can be included in a message.
Each option instance in a message specifies the Option Number of the
defined CoAP option, the length of the Option Value, and the Option
Value itself.
Instead of specifying the Option Number directly, the instances MUST
appear in order of their Option Numbers and a delta encoding is used
between them: the Option Number for each instance is calculated as
the sum of its delta and the Option Number of the preceding instance
in the message. For the first instance in a message, a preceding
option instance with Option Number zero is assumed. Multiple
instances of the same option can be included by using a delta of
zero.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
Option Numbers are maintained in the "CoAP Option Numbers" registry
(<a href="#section-12.2">Section 12.2</a>). See <a href="#section-5.4">Section 5.4</a> for the semantics of the options
defined in this document.
0 1 2 3 4 5 6 7
+---------------+---------------+
| | |
| Option Delta | Option Length | 1 byte
| | |
+---------------+---------------+
\ \
/ Option Delta / 0-2 bytes
\ (extended) \
+-------------------------------+
\ \
/ Option Length / 0-2 bytes
\ (extended) \
+-------------------------------+
\ \
/ /
\ \
/ Option Value / 0 or more bytes
\ \
/ /
\ \
+-------------------------------+
Figure 8: Option Format
The fields in an option are defined as follows:
Option Delta: 4-bit unsigned integer. A value between 0 and 12
indicates the Option Delta. Three values are reserved for special
constructs:
13: An 8-bit unsigned integer follows the initial byte and
indicates the Option Delta minus 13.
14: A 16-bit unsigned integer in network byte order follows the
initial byte and indicates the Option Delta minus 269.
15: Reserved for the Payload Marker. If the field is set to this
value but the entire byte is not the payload marker, this MUST
be processed as a message format error.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
The resulting Option Delta is used as the difference between the
Option Number of this option and that of the previous option (or
zero for the first option). In other words, the Option Number is
calculated by simply summing the Option Delta values of this and
all previous options before it.
Option Length: 4-bit unsigned integer. A value between 0 and 12
indicates the length of the Option Value, in bytes. Three values
are reserved for special constructs:
13: An 8-bit unsigned integer precedes the Option Value and
indicates the Option Length minus 13.
14: A 16-bit unsigned integer in network byte order precedes the
Option Value and indicates the Option Length minus 269.
15: Reserved for future use. If the field is set to this value,
it MUST be processed as a message format error.
Value: A sequence of exactly Option Length bytes. The length and
format of the Option Value depend on the respective option, which
MAY define variable-length values. See <a href="#section-3.2">Section 3.2</a> for the
formats used in this document; options defined in other documents
MAY make use of other option value formats.
<span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a>. Option Value Formats</span>
The options defined in this document make use of the following option
value formats.
empty: A zero-length sequence of bytes.
opaque: An opaque sequence of bytes.
uint: A non-negative integer that is represented in network byte
order using the number of bytes given by the Option Length
field.
An option definition may specify a range of permissible
numbers of bytes; if it has a choice, a sender SHOULD
represent the integer with as few bytes as possible, i.e.,
without leading zero bytes. For example, the number 0 is
represented with an empty option value (a zero-length
sequence of bytes) and the number 1 by a single byte with
the numerical value of 1 (bit combination 00000001 in most
significant bit first notation). A recipient MUST be
prepared to process values with leading zero bytes.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
Implementation Note: The exceptional behavior permitted
for the sender is intended for highly constrained,
templated implementations (e.g., hardware
implementations) that use fixed-size options in the
templates.
string: A Unicode string that is encoded using UTF-8 [<a href="./rfc3629" title=""UTF-8, a transformation format of ISO 10646"">RFC3629</a>] in
Net-Unicode form [<a href="./rfc5198" title=""Unicode Format for Network Interchange"">RFC5198</a>].
Note that here, and in all other places where UTF-8
encoding is used in the CoAP protocol, the intention is
that the encoded strings can be directly used and compared
as opaque byte strings by CoAP protocol implementations.
There is no expectation and no need to perform
normalization within a CoAP implementation (except where
Unicode strings that are not known to be normalized are
imported from sources outside the CoAP protocol). Note
also that ASCII strings (that do not make use of special
control characters) are always valid UTF-8 Net-Unicode
strings.
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Message Transmission</span>
CoAP messages are exchanged asynchronously between CoAP endpoints.
They are used to transport CoAP requests and responses, the semantics
of which are defined in <a href="#section-5">Section 5</a>.
As CoAP is bound to unreliable transports such as UDP, CoAP messages
may arrive out of order, appear duplicated, or go missing without
notice. For this reason, CoAP implements a lightweight reliability
mechanism, without trying to re-create the full feature set of a
transport like TCP. It has the following features:
o Simple stop-and-wait retransmission reliability with exponential
back-off for Confirmable messages.
o Duplicate detection for both Confirmable and Non-confirmable
messages.
<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>. Messages and Endpoints</span>
A CoAP endpoint is the source or destination of a CoAP message. The
specific definition of an endpoint depends on the transport being
used for CoAP. For the transports defined in this specification, the
endpoint is identified depending on the security mode used (see
<a href="#section-9">Section 9</a>): With no security, the endpoint is solely identified by an
IP address and a UDP port number. With other security modes, the
endpoint is identified as defined by the security mode.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
There are different types of messages. The type of a message is
specified by the Type field of the CoAP Header.
Separate from the message type, a message may carry a request, a
response, or be Empty. This is signaled by the Request/Response Code
field in the CoAP Header and is relevant to the request/response
model. Possible values for the field are maintained in the CoAP Code
Registries (<a href="#section-12.1">Section 12.1</a>).
An Empty message has the Code field set to 0.00. The Token Length
field MUST be set to 0 and bytes of data MUST NOT be present after
the Message ID field. If there are any bytes, they MUST be processed
as a message format error.
<span class="h3"><a class="selflink" id="section-4.2" href="#section-4.2">4.2</a>. Messages Transmitted Reliably</span>
The reliable transmission of a message is initiated by marking the
message as Confirmable in the CoAP header. A Confirmable message
always carries either a request or response, unless it is used only
to elicit a Reset message, in which case it is Empty. A recipient
MUST either (a) acknowledge a Confirmable message with an
Acknowledgement message or (b) reject the message if the recipient
lacks context to process the message properly, including situations
where the message is Empty, uses a code with a reserved class (1, 6,
or 7), or has a message format error. Rejecting a Confirmable
message is effected by sending a matching Reset message and otherwise
ignoring it. The Acknowledgement message MUST echo the Message ID of
the Confirmable message and MUST carry a response or be Empty (see
Sections <a href="#section-5.2.1">5.2.1</a> and <a href="#section-5.2.2">5.2.2</a>). The Reset message MUST echo the Message
ID of the Confirmable message and MUST be Empty. Rejecting an
Acknowledgement or Reset message (including the case where the
Acknowledgement carries a request or a code with a reserved class, or
the Reset message is not Empty) is effected by silently ignoring it.
More generally, recipients of Acknowledgement and Reset messages MUST
NOT respond with either Acknowledgement or Reset messages.
The sender retransmits the Confirmable message at exponentially
increasing intervals, until it receives an acknowledgement (or Reset
message) or runs out of attempts.
Retransmission is controlled by two things that a CoAP endpoint MUST
keep track of for each Confirmable message it sends while waiting for
an acknowledgement (or reset): a timeout and a retransmission
counter. For a new Confirmable message, the initial timeout is set
to a random duration (often not an integral number of seconds)
between ACK_TIMEOUT and (ACK_TIMEOUT * ACK_RANDOM_FACTOR) (see
<a href="#section-4.8">Section 4.8</a>), and the retransmission counter is set to 0. When the
timeout is triggered and the retransmission counter is less than
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
MAX_RETRANSMIT, the message is retransmitted, the retransmission
counter is incremented, and the timeout is doubled. If the
retransmission counter reaches MAX_RETRANSMIT on a timeout, or if the
endpoint receives a Reset message, then the attempt to transmit the
message is canceled and the application process informed of failure.
On the other hand, if the endpoint receives an acknowledgement in
time, transmission is considered successful.
This specification makes no strong requirements on the accuracy of
the clocks used to implement the above binary exponential back-off
algorithm. In particular, an endpoint may be late for a specific
retransmission due to its sleep schedule and may catch up on the next
one. However, the minimum spacing before another retransmission is
ACK_TIMEOUT, and the entire sequence of (re-)transmissions MUST stay
in the envelope of MAX_TRANSMIT_SPAN (see <a href="#section-4.8.2">Section 4.8.2</a>), even if
that means a sender may miss an opportunity to transmit.
A CoAP endpoint that sent a Confirmable message MAY give up in
attempting to obtain an ACK even before the MAX_RETRANSMIT counter
value is reached. For example, the application has canceled the
request as it no longer needs a response, or there is some other
indication that the CON message did arrive. In particular, a CoAP
request message may have elicited a separate response, in which case
it is clear to the requester that only the ACK was lost and a
retransmission of the request would serve no purpose. However, a
responder MUST NOT in turn rely on this cross-layer behavior from a
requester, i.e., it MUST retain the state to create the ACK for the
request, if needed, even if a Confirmable response was already
acknowledged by the requester.
Another reason for giving up retransmission MAY be the receipt of
ICMP errors. If it is desired to take account of ICMP errors, to
mitigate potential spoofing attacks, implementations SHOULD take care
to check the information about the original datagram in the ICMP
message, including port numbers and CoAP header information such as
message type and code, Message ID, and Token; if this is not possible
due to limitations of the UDP service API, ICMP errors SHOULD be
ignored. Packet Too Big errors [<a href="./rfc4443" title=""Internet Control Message Protocol (ICMPv6) for the Internet Protocol Version 6 (IPv6) Specification"">RFC4443</a>] ("fragmentation needed and
DF set" for IPv4 [<a href="./rfc0792" title=""Internet Control Message Protocol"">RFC0792</a>]) cannot properly occur and SHOULD be
ignored if the implementation note in <a href="#section-4.6">Section 4.6</a> is followed;
otherwise, they SHOULD feed into a path MTU discovery algorithm
[<a href="./rfc4821" title=""Packetization Layer Path MTU Discovery"">RFC4821</a>]. Source Quench and Time Exceeded ICMP messages SHOULD be
ignored. Host, network, port, or protocol unreachable errors or
parameter problem errors MAY, after appropriate vetting, be used to
inform the application of a failure in sending.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h3"><a class="selflink" id="section-4.3" href="#section-4.3">4.3</a>. Messages Transmitted without Reliability</span>
Some messages do not require an acknowledgement. This is
particularly true for messages that are repeated regularly for
application requirements, such as repeated readings from a sensor
where eventual success is sufficient.
As a more lightweight alternative, a message can be transmitted less
reliably by marking the message as Non-confirmable. A Non-
confirmable message always carries either a request or response and
MUST NOT be Empty. A Non-confirmable message MUST NOT be
acknowledged by the recipient. A recipient MUST reject the message
if it lacks context to process the message properly, including the
case where the message is Empty, uses a code with a reserved class
(1, 6, or 7), or has a message format error. Rejecting a Non-
confirmable message MAY involve sending a matching Reset message, and
apart from the Reset message the rejected message MUST be silently
ignored.
At the CoAP level, there is no way for the sender to detect if a Non-
confirmable message was received or not. A sender MAY choose to
transmit multiple copies of a Non-confirmable message within
MAX_TRANSMIT_SPAN (limited by the provisions of <a href="#section-4.7">Section 4.7</a>, in
particular, by PROBING_RATE if no response is received), or the
network may duplicate the message in transit. To enable the receiver
to act only once on the message, Non-confirmable messages specify a
Message ID as well. (This Message ID is drawn from the same number
space as the Message IDs for Confirmable messages.)
Summarizing Sections <a href="#section-4.2">4.2</a> and <a href="#section-4.3">4.3</a>, the four message types can be used
as in Table 1. "*" means that the combination is not used in normal
operation but only to elicit a Reset message ("CoAP ping").
+----------+-----+-----+-----+-----+
| | CON | NON | ACK | RST |
+----------+-----+-----+-----+-----+
| Request | X | X | - | - |
| Response | X | X | X | - |
| Empty | * | - | X | X |
+----------+-----+-----+-----+-----+
Table 1: Usage of Message Types
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h3"><a class="selflink" id="section-4.4" href="#section-4.4">4.4</a>. Message Correlation</span>
An Acknowledgement or Reset message is related to a Confirmable
message or Non-confirmable message by means of a Message ID along
with additional address information of the corresponding endpoint.
The Message ID is a 16-bit unsigned integer that is generated by the
sender of a Confirmable or Non-confirmable message and included in
the CoAP header. The Message ID MUST be echoed in the
Acknowledgement or Reset message by the recipient.
The same Message ID MUST NOT be reused (in communicating with the
same endpoint) within the EXCHANGE_LIFETIME (<a href="#section-4.8.2">Section 4.8.2</a>).
Implementation Note: Several implementation strategies can be
employed for generating Message IDs. In the simplest case, a CoAP
endpoint generates Message IDs by keeping a single Message ID
variable, which is changed each time a new Confirmable or Non-
confirmable message is sent, regardless of the destination address
or port. Endpoints dealing with large numbers of transactions
could keep multiple Message ID variables, for example, per prefix
or destination address. (Note that some receiving endpoints may
not be able to distinguish unicast and multicast packets addressed
to it, so endpoints generating Message IDs need to make sure these
do not overlap.) It is strongly recommended that the initial
value of the variable (e.g., on startup) be randomized, in order
to make successful off-path attacks on the protocol less likely.
For an Acknowledgement or Reset message to match a Confirmable or
Non-confirmable message, the Message ID and source endpoint of the
Acknowledgement or Reset message MUST match the Message ID and
destination endpoint of the Confirmable or Non-confirmable message.
<span class="h3"><a class="selflink" id="section-4.5" href="#section-4.5">4.5</a>. Message Deduplication</span>
A recipient might receive the same Confirmable message (as indicated
by the Message ID and source endpoint) multiple times within the
EXCHANGE_LIFETIME (<a href="#section-4.8.2">Section 4.8.2</a>), for example, when its
Acknowledgement went missing or didn't reach the original sender
before the first timeout. The recipient SHOULD acknowledge each
duplicate copy of a Confirmable message using the same
Acknowledgement or Reset message but SHOULD process any request or
response in the message only once. This rule MAY be relaxed in case
the Confirmable message transports a request that is idempotent (see
<a href="#section-5.1">Section 5.1</a>) or can be handled in an idempotent fashion. Examples
for relaxed message deduplication:
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
o A server might relax the requirement to answer all retransmissions
of an idempotent request with the same response (<a href="#section-4.2">Section 4.2</a>), so
that it does not have to maintain state for Message IDs. For
example, an implementation might want to process duplicate
transmissions of a GET, PUT, or DELETE request as separate
requests if the effort incurred by duplicate processing is less
expensive than keeping track of previous responses would be.
o A constrained server might even want to relax this requirement for
certain non-idempotent requests if the application semantics make
this trade-off favorable. For example, if the result of a POST
request is just the creation of some short-lived state at the
server, it may be less expensive to incur this effort multiple
times for a request than keeping track of whether a previous
transmission of the same request already was processed.
A recipient might receive the same Non-confirmable message (as
indicated by the Message ID and source endpoint) multiple times
within NON_LIFETIME (<a href="#section-4.8.2">Section 4.8.2</a>). As a general rule that MAY be
relaxed based on the specific semantics of a message, the recipient
SHOULD silently ignore any duplicated Non-confirmable message and
SHOULD process any request or response in the message only once.
<span class="h3"><a class="selflink" id="section-4.6" href="#section-4.6">4.6</a>. Message Size</span>
While specific link layers make it beneficial to keep CoAP messages
small enough to fit into their link-layer packets (see <a href="#section-1">Section 1</a>),
this is a matter of implementation quality. The CoAP specification
itself provides only an upper bound to the message size. Messages
larger than an IP packet result in undesirable packet fragmentation.
A CoAP message, appropriately encapsulated, SHOULD fit within a
single IP packet (i.e., avoid IP fragmentation) and (by fitting into
one UDP payload) obviously needs to fit within a single IP datagram.
If the Path MTU is not known for a destination, an IP MTU of 1280
bytes SHOULD be assumed; if nothing is known about the size of the
headers, good upper bounds are 1152 bytes for the message size and
1024 bytes for the payload size.
Implementation Note: CoAP's choice of message size parameters works
well with IPv6 and with most of today's IPv4 paths. (However,
with IPv4, it is harder to absolutely ensure that there is no IP
fragmentation. If IPv4 support on unusual networks is a
consideration, implementations may want to limit themselves to
more conservative IPv4 datagram sizes such as 576 bytes; per
[<a href="./rfc0791" title=""Internet Protocol"">RFC0791</a>], the absolute minimum value of the IP MTU for IPv4 is as
low as 68 bytes, which would leave only 40 bytes minus security
overhead for a UDP payload. Implementations extremely focused on
this problem set might also set the IPv4 DF bit and perform some
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
form of path MTU discovery [<a href="./rfc4821" title=""Packetization Layer Path MTU Discovery"">RFC4821</a>]; this should generally be
unnecessary in realistic use cases for CoAP, however.) A more
important kind of fragmentation in many constrained networks is
that on the adaptation layer (e.g., 6LoWPAN L2 packets are limited
to 127 bytes including various overheads); this may motivate
implementations to be frugal in their packet sizes and to move to
block-wise transfers [<a href="#ref-BLOCK" title=""Blockwise transfers in CoAP"">BLOCK</a>] when approaching three-digit message
sizes.
Message sizes are also of considerable importance to
implementations on constrained nodes. Many implementations will
need to allocate a buffer for incoming messages. If an
implementation is too constrained to allow for allocating the
above-mentioned upper bound, it could apply the following
implementation strategy for messages not using DTLS security:
Implementations receiving a datagram into a buffer that is too
small are usually able to determine if the trailing portion of a
datagram was discarded and to retrieve the initial portion. So,
at least the CoAP header and options, if not all of the payload,
are likely to fit within the buffer. A server can thus fully
interpret a request and return a 4.13 (Request Entity Too Large;
see <a href="#section-5.9.2.9">Section 5.9.2.9</a>) Response Code if the payload was truncated.
A client sending an idempotent request and receiving a response
larger than would fit in the buffer can repeat the request with a
suitable value for the Block Option [<a href="#ref-BLOCK" title=""Blockwise transfers in CoAP"">BLOCK</a>].
<span class="h3"><a class="selflink" id="section-4.7" href="#section-4.7">4.7</a>. Congestion Control</span>
Basic congestion control for CoAP is provided by the exponential
back-off mechanism in <a href="#section-4.2">Section 4.2</a>.
In order not to cause congestion, clients (including proxies) MUST
strictly limit the number of simultaneous outstanding interactions
that they maintain to a given server (including proxies) to NSTART.
An outstanding interaction is either a CON for which an ACK has not
yet been received but is still expected (message layer) or a request
for which neither a response nor an Acknowledgment message has yet
been received but is still expected (which may both occur at the same
time, counting as one outstanding interaction). The default value of
NSTART for this specification is 1.
Further congestion control optimizations and considerations are
expected in the future, may for example provide automatic
initialization of the CoAP transmission parameters defined in
<a href="#section-4.8">Section 4.8</a>, and thus may allow a value for NSTART greater than one.
After EXCHANGE_LIFETIME, a client stops expecting a response to a
Confirmable request for which no acknowledgment message was received.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
The specific algorithm by which a client stops to "expect" a response
to a Confirmable request that was acknowledged, or to a Non-
confirmable request, is not defined. Unless this is modified by
additional congestion control optimizations, it MUST be chosen in
such a way that an endpoint does not exceed an average data rate of
PROBING_RATE in sending to another endpoint that does not respond.
Note: CoAP places the onus of congestion control mostly on the
clients. However, clients may malfunction or actually be
attackers, e.g., to perform amplification attacks (<a href="#section-11.3">Section 11.3</a>).
To limit the damage (to the network and to its own energy
resources), a server SHOULD implement some rate limiting for its
response transmission based on reasonable assumptions about
application requirements. This is most helpful if the rate limit
can be made effective for the misbehaving endpoints, only.
<span class="h3"><a class="selflink" id="section-4.8" href="#section-4.8">4.8</a>. Transmission Parameters</span>
Message transmission is controlled by the following parameters:
+-------------------+---------------+
| name | default value |
+-------------------+---------------+
| ACK_TIMEOUT | 2 seconds |
| ACK_RANDOM_FACTOR | 1.5 |
| MAX_RETRANSMIT | 4 |
| NSTART | 1 |
| DEFAULT_LEISURE | 5 seconds |
| PROBING_RATE | 1 byte/second |
+-------------------+---------------+
Table 2: CoAP Protocol Parameters
<span class="h4"><a class="selflink" id="section-4.8.1" href="#section-4.8.1">4.8.1</a>. Changing the Parameters</span>
The values for ACK_TIMEOUT, ACK_RANDOM_FACTOR, MAX_RETRANSMIT,
NSTART, DEFAULT_LEISURE (<a href="#section-8.2">Section 8.2</a>), and PROBING_RATE may be
configured to values specific to the application environment
(including dynamically adjusted values); however, the configuration
method is out of scope of this document. It is RECOMMENDED that an
application environment use consistent values for these parameters;
the specific effects of operating with inconsistent values in an
application environment are outside the scope of the present
specification.
The transmission parameters have been chosen to achieve a behavior in
the presence of congestion that is safe in the Internet. If a
configuration desires to use different values, the onus is on the
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
configuration to ensure these congestion control properties are not
violated. In particular, a decrease of ACK_TIMEOUT below 1 second
would violate the guidelines of [<a href="./rfc5405" title=""Unicast UDP Usage Guidelines for Application Designers"">RFC5405</a>]. ([<a href="#ref-RTO-CONSIDER">RTO-CONSIDER</a>] provides
some additional background.) CoAP was designed to enable
implementations that do not maintain round-trip-time (RTT)
measurements. However, where it is desired to decrease the
ACK_TIMEOUT significantly or increase NSTART, this can only be done
safely when maintaining such measurements. Configurations MUST NOT
decrease ACK_TIMEOUT or increase NSTART without using mechanisms that
ensure congestion control safety, either defined in the configuration
or in future standards documents.
ACK_RANDOM_FACTOR MUST NOT be decreased below 1.0, and it SHOULD have
a value that is sufficiently different from 1.0 to provide some
protection from synchronization effects.
MAX_RETRANSMIT can be freely adjusted, but a value that is too small
will reduce the probability that a Confirmable message is actually
received, while a larger value than given here will require further
adjustments in the time values (see <a href="#section-4.8.2">Section 4.8.2</a>).
If the choice of transmission parameters leads to an increase of
derived time values (see <a href="#section-4.8.2">Section 4.8.2</a>), the configuration mechanism
MUST ensure the adjusted value is also available to all the endpoints
with which these adjusted values are to be used to communicate.
<span class="h4"><a class="selflink" id="section-4.8.2" href="#section-4.8.2">4.8.2</a>. Time Values Derived from Transmission Parameters</span>
The combination of ACK_TIMEOUT, ACK_RANDOM_FACTOR, and MAX_RETRANSMIT
influences the timing of retransmissions, which in turn influences
how long certain information items need to be kept by an
implementation. To be able to unambiguously reference these derived
time values, we give them names as follows:
o MAX_TRANSMIT_SPAN is the maximum time from the first transmission
of a Confirmable message to its last retransmission. For the
default transmission parameters, the value is (2+4+8+16)*1.5 = 45
seconds, or more generally:
ACK_TIMEOUT * ((2 ** MAX_RETRANSMIT) - 1) * ACK_RANDOM_FACTOR
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
o MAX_TRANSMIT_WAIT is the maximum time from the first transmission
of a Confirmable message to the time when the sender gives up on
receiving an acknowledgement or reset. For the default
transmission parameters, the value is (2+4+8+16+32)*1.5 = 93
seconds, or more generally:
ACK_TIMEOUT * ((2 ** (MAX_RETRANSMIT + 1)) - 1) *
ACK_RANDOM_FACTOR
In addition, some assumptions need to be made on the characteristics
of the network and the nodes.
o MAX_LATENCY is the maximum time a datagram is expected to take
from the start of its transmission to the completion of its
reception. This constant is related to the MSL (Maximum Segment
Lifetime) of [<a href="./rfc0793" title=""Transmission Control Protocol"">RFC0793</a>], which is "arbitrarily defined to be 2
minutes" ([<a href="./rfc0793" title=""Transmission Control Protocol"">RFC0793</a>] glossary, page 81). Note that this is not
necessarily smaller than MAX_TRANSMIT_WAIT, as MAX_LATENCY is not
intended to describe a situation when the protocol works well, but
the worst-case situation against which the protocol has to guard.
We, also arbitrarily, define MAX_LATENCY to be 100 seconds. Apart
from being reasonably realistic for the bulk of configurations as
well as close to the historic choice for TCP, this value also
allows Message ID lifetime timers to be represented in 8 bits
(when measured in seconds). In these calculations, there is no
assumption that the direction of the transmission is irrelevant
(i.e., that the network is symmetric); there is just the
assumption that the same value can reasonably be used as a maximum
value for both directions. If that is not the case, the following
calculations become only slightly more complex.
o PROCESSING_DELAY is the time a node takes to turn around a
Confirmable message into an acknowledgement. We assume the node
will attempt to send an ACK before having the sender time out, so
as a conservative assumption we set it equal to ACK_TIMEOUT.
o MAX_RTT is the maximum round-trip time, or:
(2 * MAX_LATENCY) + PROCESSING_DELAY
From these values, we can derive the following values relevant to the
protocol operation:
o EXCHANGE_LIFETIME is the time from starting to send a Confirmable
message to the time when an acknowledgement is no longer expected,
i.e., message-layer information about the message exchange can be
purged. EXCHANGE_LIFETIME includes a MAX_TRANSMIT_SPAN, a
MAX_LATENCY forward, PROCESSING_DELAY, and a MAX_LATENCY for the
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
way back. Note that there is no need to consider
MAX_TRANSMIT_WAIT if the configuration is chosen such that the
last waiting period (ACK_TIMEOUT * (2 ** MAX_RETRANSMIT) or the
difference between MAX_TRANSMIT_SPAN and MAX_TRANSMIT_WAIT) is
less than MAX_LATENCY -- which is a likely choice, as MAX_LATENCY
is a worst-case value unlikely to be met in the real world. In
this case, EXCHANGE_LIFETIME simplifies to:
MAX_TRANSMIT_SPAN + (2 * MAX_LATENCY) + PROCESSING_DELAY
or 247 seconds with the default transmission parameters.
o NON_LIFETIME is the time from sending a Non-confirmable message to
the time its Message ID can be safely reused. If multiple
transmission of a NON message is not used, its value is
MAX_LATENCY, or 100 seconds. However, a CoAP sender might send a
NON message multiple times, in particular for multicast
applications. While the period of reuse is not bounded by the
specification, an expectation of reliable detection of duplication
at the receiver is on the timescales of MAX_TRANSMIT_SPAN.
Therefore, for this purpose, it is safer to use the value:
MAX_TRANSMIT_SPAN + MAX_LATENCY
or 145 seconds with the default transmission parameters; however,
an implementation that just wants to use a single timeout value
for retiring Message IDs can safely use the larger value for
EXCHANGE_LIFETIME.
Table 3 lists the derived parameters introduced in this subsection
with their default values.
+-------------------+---------------+
| name | default value |
+-------------------+---------------+
| MAX_TRANSMIT_SPAN | 45 s |
| MAX_TRANSMIT_WAIT | 93 s |
| MAX_LATENCY | 100 s |
| PROCESSING_DELAY | 2 s |
| MAX_RTT | 202 s |
| EXCHANGE_LIFETIME | 247 s |
| NON_LIFETIME | 145 s |
+-------------------+---------------+
Table 3: Derived Protocol Parameters
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Request/Response Semantics</span>
CoAP operates under a similar request/response model as HTTP: a CoAP
endpoint in the role of a "client" sends one or more CoAP requests to
a "server", which services the requests by sending CoAP responses.
Unlike HTTP, requests and responses are not sent over a previously
established connection but are exchanged asynchronously over CoAP
messages.
<span class="h3"><a class="selflink" id="section-5.1" href="#section-5.1">5.1</a>. Requests</span>
A CoAP request consists of the method to be applied to the resource,
the identifier of the resource, a payload and Internet media type (if
any), and optional metadata about the request.
CoAP supports the basic methods of GET, POST, PUT, and DELETE, which
are easily mapped to HTTP. They have the same properties of safe
(only retrieval) and idempotent (you can invoke it multiple times
with the same effects) as HTTP (see <a href="./rfc2616#section-9.1">Section 9.1 of [RFC2616]</a>). The
GET method is safe; therefore, it MUST NOT take any other action on a
resource other than retrieval. The GET, PUT, and DELETE methods MUST
be performed in such a way that they are idempotent. POST is not
idempotent, because its effect is determined by the origin server and
dependent on the target resource; it usually results in a new
resource being created or the target resource being updated.
A request is initiated by setting the Code field in the CoAP header
of a Confirmable or a Non-confirmable message to a Method Code and
including request information.
The methods used in requests are described in detail in <a href="#section-5.8">Section 5.8</a>.
<span class="h3"><a class="selflink" id="section-5.2" href="#section-5.2">5.2</a>. Responses</span>
After receiving and interpreting a request, a server responds with a
CoAP response that is matched to the request by means of a client-
generated token (<a href="#section-5.3">Section 5.3</a>); note that this is different from the
Message ID that matches a Confirmable message to its Acknowledgement.
A response is identified by the Code field in the CoAP header being
set to a Response Code. Similar to the HTTP Status Code, the CoAP
Response Code indicates the result of the attempt to understand and
satisfy the request. These codes are fully defined in <a href="#section-5.9">Section 5.9</a>.
The Response Code numbers to be set in the Code field of the CoAP
header are maintained in the CoAP Response Code Registry
(<a href="#section-12.1.2">Section 12.1.2</a>).
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
0
0 1 2 3 4 5 6 7
+-+-+-+-+-+-+-+-+
|class| detail |
+-+-+-+-+-+-+-+-+
Figure 9: Structure of a Response Code
The upper three bits of the 8-bit Response Code number define the
class of response. The lower five bits do not have any
categorization role; they give additional detail to the overall class
(Figure 9).
As a human-readable notation for specifications and protocol
diagnostics, CoAP code numbers including the Response Code are
documented in the format "c.dd", where "c" is the class in decimal,
and "dd" is the detail as a two-digit decimal. For example,
"Forbidden" is written as 4.03 -- indicating an 8-bit code value of
hexadecimal 0x83 (4*0x20+3) or decimal 131 (4*32+3).
There are 3 classes of Response Codes:
2 - Success: The request was successfully received, understood, and
accepted.
4 - Client Error: The request contains bad syntax or cannot be
fulfilled.
5 - Server Error: The server failed to fulfill an apparently valid
request.
The Response Codes are designed to be extensible: Response Codes in
the Client Error or Server Error class that are unrecognized by an
endpoint are treated as being equivalent to the generic Response Code
of that class (4.00 and 5.00, respectively). However, there is no
generic Response Code indicating success, so a Response Code in the
Success class that is unrecognized by an endpoint can only be used to
determine that the request was successful without any further
details.
The possible Response Codes are described in detail in <a href="#section-5.9">Section 5.9</a>.
Responses can be sent in multiple ways, which are defined in the
following subsections.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h4"><a class="selflink" id="section-5.2.1" href="#section-5.2.1">5.2.1</a>. Piggybacked</span>
In the most basic case, the response is carried directly in the
Acknowledgement message that acknowledges the request (which requires
that the request was carried in a Confirmable message). This is
called a "Piggybacked Response".
The response is returned in the Acknowledgement message, independent
of whether the response indicates success or failure. In effect, the
response is piggybacked on the Acknowledgement message, and no
separate message is required to return the response.
Implementation Note: The protocol leaves the decision whether to
piggyback a response or not (i.e., send a separate response) to
the server. The client MUST be prepared to receive either. On
the quality-of-implementation level, there is a strong expectation
that servers will implement code to piggyback whenever possible --
saving resources in the network and both at the client and at the
server.
<span class="h4"><a class="selflink" id="section-5.2.2" href="#section-5.2.2">5.2.2</a>. Separate</span>
It may not be possible to return a piggybacked response in all cases.
For example, a server might need longer to obtain the representation
of the resource requested than it can wait to send back the
Acknowledgement message, without risking the client repeatedly
retransmitting the request message (see also the discussion of
PROCESSING_DELAY in <a href="#section-4.8.2">Section 4.8.2</a>). The response to a request
carried in a Non-confirmable message is always sent separately (as
there is no Acknowledgement message).
One way to implement this in a server is to initiate the attempt to
obtain the resource representation and, while that is in progress,
time out an acknowledgement timer. A server may also immediately
send an acknowledgement if it knows in advance that there will be no
piggybacked response. In both cases, the acknowledgement effectively
is a promise that the request will be acted upon later.
When the server finally has obtained the resource representation, it
sends the response. When it is desired that this message is not
lost, it is sent as a Confirmable message from the server to the
client and answered by the client with an Acknowledgement, echoing
the new Message ID chosen by the server. (It may also be sent as a
Non-confirmable message; see <a href="#section-5.2.3">Section 5.2.3</a>.)
When the server chooses to use a separate response, it sends the
Acknowledgement to the Confirmable request as an Empty message. Once
the server sends back an Empty Acknowledgement, it MUST NOT send back
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
the response in another Acknowledgement, even if the client
retransmits another identical request. If a retransmitted request is
received (perhaps because the original Acknowledgement was delayed),
another Empty Acknowledgement is sent, and any response MUST be sent
as a separate response.
If the server then sends a Confirmable response, the client's
Acknowledgement to that response MUST also be an Empty message (one
that carries neither a request nor a response). The server MUST stop
retransmitting its response on any matching Acknowledgement (silently
ignoring any Response Code or payload) or Reset message.
Implementation Notes: Note that, as the underlying datagram
transport may not be sequence-preserving, the Confirmable message
carrying the response may actually arrive before or after the
Acknowledgement message for the request; for the purposes of
terminating the retransmission sequence, this also serves as an
acknowledgement. Note also that, while the CoAP protocol itself
does not make any specific demands here, there is an expectation
that the response will come within a time frame that is reasonable
from an application point of view. As there is no underlying
transport protocol that could be instructed to run a keep-alive
mechanism, the requester may want to set up a timeout that is
unrelated to CoAP's retransmission timers in case the server is
destroyed or otherwise unable to send the response.
<span class="h4"><a class="selflink" id="section-5.2.3" href="#section-5.2.3">5.2.3</a>. Non-confirmable</span>
If the request message is Non-confirmable, then the response SHOULD
be returned in a Non-confirmable message as well. However, an
endpoint MUST be prepared to receive a Non-confirmable response
(preceded or followed by an Empty Acknowledgement message) in reply
to a Confirmable request, or a Confirmable response in reply to a
Non-confirmable request.
<span class="h3"><a class="selflink" id="section-5.3" href="#section-5.3">5.3</a>. Request/Response Matching</span>
Regardless of how a response is sent, it is matched to the request by
means of a token that is included by the client in the request, along
with additional address information of the corresponding endpoint.
<span class="h4"><a class="selflink" id="section-5.3.1" href="#section-5.3.1">5.3.1</a>. Token</span>
The Token is used to match a response with a request. The token
value is a sequence of 0 to 8 bytes. (Note that every message
carries a token, even if it is of zero length.) Every request
carries a client-generated token that the server MUST echo (without
modification) in any resulting response.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
A token is intended for use as a client-local identifier for
differentiating between concurrent requests (see <a href="#section-5.3">Section 5.3</a>); it
could have been called a "request ID".
The client SHOULD generate tokens in such a way that tokens currently
in use for a given source/destination endpoint pair are unique.
(Note that a client implementation can use the same token for any
request if it uses a different endpoint each time, e.g., a different
source port number.) An empty token value is appropriate e.g., when
no other tokens are in use to a destination, or when requests are
made serially per destination and receive piggybacked responses.
There are, however, multiple possible implementation strategies to
fulfill this.
A client sending a request without using Transport Layer Security
(<a href="#section-9">Section 9</a>) SHOULD use a nontrivial, randomized token to guard
against spoofing of responses (<a href="#section-11.4">Section 11.4</a>). This protective use of
tokens is the reason they are allowed to be up to 8 bytes in size.
The actual size of the random component to be used for the Token
depends on the security requirements of the client and the level of
threat posed by spoofing of responses. A client that is connected to
the general Internet SHOULD use at least 32 bits of randomness,
keeping in mind that not being directly connected to the Internet is
not necessarily sufficient protection against spoofing. (Note that
the Message ID adds little in protection as it is usually
sequentially assigned, i.e., guessable, and can be circumvented by
spoofing a separate response.) Clients that want to optimize the
Token length may further want to detect the level of ongoing attacks
(e.g., by tallying recent Token mismatches in incoming messages) and
adjust the Token length upwards appropriately. [<a href="./rfc4086" title=""Randomness Requirements for Security"">RFC4086</a>] discusses
randomness requirements for security.
An endpoint receiving a token it did not generate MUST treat the
token as opaque and make no assumptions about its content or
structure.
<span class="h4"><a class="selflink" id="section-5.3.2" href="#section-5.3.2">5.3.2</a>. Request/Response Matching Rules</span>
The exact rules for matching a response to a request are as follows:
1. The source endpoint of the response MUST be the same as the
destination endpoint of the original request.
2. In a piggybacked response, the Message ID of the Confirmable
request and the Acknowledgement MUST match, and the tokens of the
response and original request MUST match. In a separate
response, just the tokens of the response and original request
MUST match.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
In case a message carrying a response is unexpected (the client is
not waiting for a response from the identified endpoint, at the
endpoint addressed, and/or with the given token), the response is
rejected (Sections <a href="#section-4.2">4.2</a> and <a href="#section-4.3">4.3</a>).
Implementation Note: A client that receives a response in a CON
message may want to clean up the message state right after sending
the ACK. If that ACK is lost and the server retransmits the CON,
the client may no longer have any state to which to correlate this
response, making the retransmission an unexpected message; the
client will likely send a Reset message so it does not receive any
more retransmissions. This behavior is normal and not an
indication of an error. (Clients that are not aggressively
optimized in their state memory usage will still have message
state that will identify the second CON as a retransmission.
Clients that actually expect more messages from the server
[<a href="#ref-OBSERVE" title=""Observing Resources in CoAP"">OBSERVE</a>] will have to keep state in any case.)
<span class="h3"><a class="selflink" id="section-5.4" href="#section-5.4">5.4</a>. Options</span>
Both requests and responses may include a list of one or more
options. For example, the URI in a request is transported in several
options, and metadata that would be carried in an HTTP header in HTTP
is supplied as options as well.
CoAP defines a single set of options that are used in both requests
and responses:
o Content-Format
o ETag
o Location-Path
o Location-Query
o Max-Age
o Proxy-Uri
o Proxy-Scheme
o Uri-Host
o Uri-Path
o Uri-Port
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
o Uri-Query
o Accept
o If-Match
o If-None-Match
o Size1
The semantics of these options along with their properties are
defined in detail in <a href="#section-5.10">Section 5.10</a>.
Not all options are defined for use with all methods and Response
Codes. The possible options for methods and Response Codes are
defined in Sections <a href="#section-5.8">5.8</a> and <a href="#section-5.9">5.9</a>, respectively. In case an option is
not defined for a Method or Response Code, it MUST NOT be included by
a sender and MUST be treated like an unrecognized option by a
recipient.
<span class="h4"><a class="selflink" id="section-5.4.1" href="#section-5.4.1">5.4.1</a>. Critical/Elective</span>
Options fall into one of two classes: "critical" or "elective". The
difference between these is how an option unrecognized by an endpoint
is handled:
o Upon reception, unrecognized options of class "elective" MUST be
silently ignored.
o Unrecognized options of class "critical" that occur in a
Confirmable request MUST cause the return of a 4.02 (Bad Option)
response. This response SHOULD include a diagnostic payload
describing the unrecognized option(s) (see <a href="#section-5.5.2">Section 5.5.2</a>).
o Unrecognized options of class "critical" that occur in a
Confirmable response, or piggybacked in an Acknowledgement, MUST
cause the response to be rejected (<a href="#section-4.2">Section 4.2</a>).
o Unrecognized options of class "critical" that occur in a Non-
confirmable message MUST cause the message to be rejected
(<a href="#section-4.3">Section 4.3</a>).
Note that, whether critical or elective, an option is never
"mandatory" (it is always optional): these rules are defined in order
to enable implementations to stop processing options they do not
understand or implement.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
Critical/elective rules apply to non-proxying endpoints. A proxy
processes options based on Unsafe/Safe-to-Forward classes as defined
in <a href="#section-5.7">Section 5.7</a>.
<span class="h4"><a class="selflink" id="section-5.4.2" href="#section-5.4.2">5.4.2</a>. Proxy Unsafe or Safe-to-Forward and NoCacheKey</span>
In addition to an option being marked as critical or elective,
options are also classified based on how a proxy is to deal with the
option if it does not recognize it. For this purpose, an option can
either be considered Unsafe to forward (UnSafe is set) or Safe-to-
Forward (UnSafe is clear).
In addition, for an option that is marked Safe-to-Forward, the option
number indicates whether or not it is intended to be part of the
Cache-Key (<a href="#section-5.6">Section 5.6</a>) in a request. If some of the NoCacheKey bits
are 0, it is; if all NoCacheKey bits are 1, it is not (see
<a href="#section-5.4.6">Section 5.4.6</a>).
Note: The Cache-Key indication is relevant only for proxies that do
not implement the given option as a request option and instead
rely on the Unsafe/Safe-to-Forward indication only. For example,
for ETag, actually using the request option as a part of the
Cache-Key is grossly inefficient, but it is the best thing one can
do if ETag is not implemented by a proxy, as the response is going
to differ based on the presence of the request option. A more
useful proxy that does implement the ETag request option is not
using ETag as a part of the Cache-Key.
NoCacheKey is indicated in three bits so that only one out of
eight codepoints is qualified as NoCacheKey, leaving seven out of
eight codepoints for what appears to be the more likely case.
Proxy behavior with regard to these classes is defined in
<a href="#section-5.7">Section 5.7</a>.
<span class="h4"><a class="selflink" id="section-5.4.3" href="#section-5.4.3">5.4.3</a>. Length</span>
Option values are defined to have a specific length, often in the
form of an upper and lower bound. If the length of an option value
in a request is outside the defined range, that option MUST be
treated like an unrecognized option (see <a href="#section-5.4.1">Section 5.4.1</a>).
<span class="h4"><a class="selflink" id="section-5.4.4" href="#section-5.4.4">5.4.4</a>. Default Values</span>
Options may be defined to have a default value. If the value of an
option is intended to be this default value, the option SHOULD NOT be
included in the message. If the option is not present, the default
value MUST be assumed.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
Where a critical option has a default value, this is chosen in such a
way that the absence of the option in a message can be processed
properly both by implementations unaware of the critical option and
by implementations that interpret this absence as the presence of the
default value for the option.
<span class="h4"><a class="selflink" id="section-5.4.5" href="#section-5.4.5">5.4.5</a>. Repeatable Options</span>
The definition of some options specifies that those options are
repeatable. An option that is repeatable MAY be included one or more
times in a message. An option that is not repeatable MUST NOT be
included more than once in a message.
If a message includes an option with more occurrences than the option
is defined for, each supernumerary option occurrence that appears
subsequently in the message MUST be treated like an unrecognized
option (see <a href="#section-5.4.1">Section 5.4.1</a>).
<span class="h4"><a class="selflink" id="section-5.4.6" href="#section-5.4.6">5.4.6</a>. Option Numbers</span>
An Option is identified by an option number, which also provides some
additional semantics information, e.g., odd numbers indicate a
critical option, while even numbers indicate an elective option.
Note that this is not just a convention, it is a feature of the
protocol: Whether an option is elective or critical is entirely
determined by whether its option number is even or odd.
More generally speaking, an Option number is constructed with a bit
mask to indicate if an option is Critical or Elective, Unsafe or
Safe-to-Forward, and, in the case of Safe-to-Forward, to provide a
Cache-Key indication as shown by the following figure. In the
following text, the bit mask is expressed as a single byte that is
applied to the least significant byte of the option number in
unsigned integer representation. When bit 7 (the least significant
bit) is 1, an option is Critical (and likewise Elective when 0).
When bit 6 is 1, an option is Unsafe (and likewise Safe-to-Forward
when 0). When bit 6 is 0, i.e., the option is not Unsafe, it is not
a Cache-Key (NoCacheKey) if and only if bits 3-5 are all set to 1;
all other bit combinations mean that it indeed is a Cache-Key. These
classes of options are explained in the next sections.
0 1 2 3 4 5 6 7
+---+---+---+---+---+---+---+---+
| | NoCacheKey| U | C |
+---+---+---+---+---+---+---+---+
Figure 10: Option Number Mask (Least Significant Byte)
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
An endpoint may use an equivalent of the C code in Figure 11 to
derive the characteristics of an option number "onum".
Critical = (onum & 1);
UnSafe = (onum & 2);
NoCacheKey = ((onum & 0x1e) == 0x1c);
Figure 11: Determining Characteristics from an Option Number
The option numbers for the options defined in this document are
listed in the "CoAP Option Numbers" registry (<a href="#section-12.2">Section 12.2</a>).
<span class="h3"><a class="selflink" id="section-5.5" href="#section-5.5">5.5</a>. Payloads and Representations</span>
Both requests and responses may include a payload, depending on the
Method or Response Code, respectively. If a Method or Response Code
is not defined to have a payload, then a sender MUST NOT include one,
and a recipient MUST ignore it.
<span class="h4"><a class="selflink" id="section-5.5.1" href="#section-5.5.1">5.5.1</a>. Representation</span>
The payload of requests or of responses indicating success is
typically a representation of a resource ("resource representation")
or the result of the requested action ("action result"). Its format
is specified by the Internet media type and content coding given by
the Content-Format Option. In the absence of this option, no default
value is assumed, and the format will need to be inferred by the
application (e.g., from the application context). Payload "sniffing"
SHOULD only be attempted if no content type is given.
Implementation Note: On a quality-of-implementation level, there is
a strong expectation that a Content-Format indication will be
provided with resource representations whenever possible. This is
not a "SHOULD" level requirement solely because it is not a
protocol requirement, and it also would be difficult to outline
exactly in what cases this expectation can be violated.
For responses indicating a client or server error, the payload is
considered a representation of the result of the requested action
only if a Content-Format Option is given. In the absence of this
option, the payload is a Diagnostic Payload (<a href="#section-5.5.2">Section 5.5.2</a>).
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h4"><a class="selflink" id="section-5.5.2" href="#section-5.5.2">5.5.2</a>. Diagnostic Payload</span>
If no Content-Format option is given, the payload of responses
indicating a client or server error is a brief human-readable
diagnostic message, explaining the error situation. This diagnostic
message MUST be encoded using UTF-8 [<a href="./rfc3629" title=""UTF-8, a transformation format of ISO 10646"">RFC3629</a>], more specifically
using Net-Unicode form [<a href="./rfc5198" title=""Unicode Format for Network Interchange"">RFC5198</a>].
The message is similar to the Reason-Phrase on an HTTP status line.
It is not intended for end users but for software engineers that
during debugging need to interpret it in the context of the present,
English-language specification; therefore, no mechanism for language
tagging is needed or provided. In contrast to what is usual in HTTP,
the payload SHOULD be empty if there is no additional information
beyond the Response Code.
<span class="h4"><a class="selflink" id="section-5.5.3" href="#section-5.5.3">5.5.3</a>. Selected Representation</span>
Not all responses carry a payload that provides a representation of
the resource addressed by the request. It is, however, sometimes
useful to be able to refer to such a representation in relation to a
response, independent of whether it actually was enclosed.
We use the term "selected representation" to refer to the current
representation of a target resource that would have been selected in
a successful response if the corresponding request had used the
method GET and excluded any conditional request options
(<a href="#section-5.10.8">Section 5.10.8</a>).
Certain response options provide metadata about the selected
representation, which might differ from the representation included
in the message for responses to some state-changing methods. Of the
response options defined in this specification, only the ETag
response option (<a href="#section-5.10.6">Section 5.10.6</a>) is defined as metadata about the
selected representation.
<span class="h4"><a class="selflink" id="section-5.5.4" href="#section-5.5.4">5.5.4</a>. Content Negotiation</span>
A server may be able to supply a representation for a resource in one
of multiple representation formats. Without further information from
the client, it will provide the representation in the format it
prefers.
By using the Accept Option (<a href="#section-5.10.4">Section 5.10.4</a>) in a request, the client
can indicate which content-format it prefers to receive.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h3"><a class="selflink" id="section-5.6" href="#section-5.6">5.6</a>. Caching</span>
CoAP endpoints MAY cache responses in order to reduce the response
time and network bandwidth consumption on future, equivalent
requests.
The goal of caching in CoAP is to reuse a prior response message to
satisfy a current request. In some cases, a stored response can be
reused without the need for a network request, reducing latency and
network round-trips; a "freshness" mechanism is used for this purpose
(see <a href="#section-5.6.1">Section 5.6.1</a>). Even when a new request is required, it is
often possible to reuse the payload of a prior response to satisfy
the request, thereby reducing network bandwidth usage; a "validation"
mechanism is used for this purpose (see <a href="#section-5.6.2">Section 5.6.2</a>).
Unlike HTTP, the cacheability of CoAP responses does not depend on
the request method, but it depends on the Response Code. The
cacheability of each Response Code is defined along the Response Code
definitions in <a href="#section-5.9">Section 5.9</a>. Response Codes that indicate success and
are unrecognized by an endpoint MUST NOT be cached.
For a presented request, a CoAP endpoint MUST NOT use a stored
response, unless:
o the presented request method and that used to obtain the stored
response match,
o all options match between those in the presented request and those
of the request used to obtain the stored response (which includes
the request URI), except that there is no need for a match of any
request options marked as NoCacheKey (<a href="#section-5.4">Section 5.4</a>) or recognized
by the Cache and fully interpreted with respect to its specified
cache behavior (such as the ETag request option described in
<a href="#section-5.10.6">Section 5.10.6</a>; see also <a href="#section-5.4.2">Section 5.4.2</a>), and
o the stored response is either fresh or successfully validated as
defined below.
The set of request options that is used for matching the cache entry
is also collectively referred to as the "Cache-Key". For URI schemes
other than coap and coaps, matching of those options that constitute
the request URI may be performed under rules specific to the URI
scheme.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h4"><a class="selflink" id="section-5.6.1" href="#section-5.6.1">5.6.1</a>. Freshness Model</span>
When a response is "fresh" in the cache, it can be used to satisfy
subsequent requests without contacting the origin server, thereby
improving efficiency.
The mechanism for determining freshness is for an origin server to
provide an explicit expiration time in the future, using the Max-Age
Option (see <a href="#section-5.10.5">Section 5.10.5</a>). The Max-Age Option indicates that the
response is to be considered not fresh after its age is greater than
the specified number of seconds.
The Max-Age Option defaults to a value of 60. Thus, if it is not
present in a cacheable response, then the response is considered not
fresh after its age is greater than 60 seconds. If an origin server
wishes to prevent caching, it MUST explicitly include a Max-Age
Option with a value of zero seconds.
If a client has a fresh stored response and makes a new request
matching the request for that stored response, the new response
invalidates the old response.
<span class="h4"><a class="selflink" id="section-5.6.2" href="#section-5.6.2">5.6.2</a>. Validation Model</span>
When an endpoint has one or more stored responses for a GET request,
but cannot use any of them (e.g., because they are not fresh), it can
use the ETag Option (<a href="#section-5.10.6">Section 5.10.6</a>) in the GET request to give the
origin server an opportunity both to select a stored response to be
used, and to update its freshness. This process is known as
"validating" or "revalidating" the stored response.
When sending such a request, the endpoint SHOULD add an ETag Option
specifying the entity-tag of each stored response that is applicable.
A 2.03 (Valid) response indicates the stored response identified by
the entity-tag given in the response's ETag Option can be reused
after updating it as described in <a href="#section-5.9.1.3">Section 5.9.1.3</a>.
Any other Response Code indicates that none of the stored responses
nominated in the request is suitable. Instead, the response SHOULD
be used to satisfy the request and MAY replace the stored response.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h3"><a class="selflink" id="section-5.7" href="#section-5.7">5.7</a>. Proxying</span>
A proxy is a CoAP endpoint that can be tasked by CoAP clients to
perform requests on their behalf. This may be useful, for example,
when the request could otherwise not be made, or to service the
response from a cache in order to reduce response time and network
bandwidth or energy consumption.
In an overall architecture for a Constrained RESTful Environment,
proxies can serve quite different purposes. Proxies can be
explicitly selected by clients, a role that we term "forward-proxy".
Proxies can also be inserted to stand in for origin servers, a role
that we term "reverse-proxy". Orthogonal to this distinction, a
proxy can map from a CoAP request to a CoAP request (CoAP-to-CoAP
proxy) or translate from or to a different protocol ("cross-proxy").
Full definitions of these terms are provided in <a href="#section-1.2">Section 1.2</a>.
Notes: The terminology in this specification has been selected to be
culturally compatible with the terminology used in the wider web
application environments, without necessarily matching it in every
detail (which may not even be relevant to Constrained RESTful
Environments). Not too much semantics should be ascribed to the
components of the terms (such as "forward", "reverse", or
"cross").
HTTP proxies, besides acting as HTTP proxies, often offer a
transport-protocol proxying function ("CONNECT") to enable end-to-
end transport layer security through the proxy. No such function
is defined for CoAP-to-CoAP proxies in this specification, as
forwarding of UDP packets is unlikely to be of much value in
Constrained RESTful Environments. See also <a href="#section-10.2.7">Section 10.2.7</a> for the
cross-proxy case.
When a client uses a proxy to make a request that will use a secure
URI scheme (e.g., "coaps" or "https"), the request towards the proxy
SHOULD be sent using DTLS except where equivalent lower-layer
security is used for the leg between the client and the proxy.
<span class="h4"><a class="selflink" id="section-5.7.1" href="#section-5.7.1">5.7.1</a>. Proxy Operation</span>
A proxy generally needs a way to determine potential request
parameters for a request it places to a destination, based on the
request it received from its client. This way is fully specified for
a forward-proxy but may depend on the specific configuration for a
reverse-proxy. In particular, the client of a reverse-proxy
generally does not indicate a locator for the destination,
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
necessitating some form of namespace translation in the reverse-
proxy. However, some aspects of the operation of proxies are common
to all its forms.
If a proxy does not employ a cache, then it simply forwards the
translated request to the determined destination. Otherwise, if it
does employ a cache but does not have a stored response that matches
the translated request and is considered fresh, then it needs to
refresh its cache according to <a href="#section-5.6">Section 5.6</a>. For options in the
request that the proxy recognizes, it knows whether the option is
intended to act as part of the key used in looking up the cached
value or not. For example, since requests for different Uri-Path
values address different resources, Uri-Path values are always part
of the Cache-Key, while, e.g., Token values are never part of the
Cache-Key. For options that the proxy does not recognize but that
are marked Safe-to-Forward in the option number, the option also
indicates whether it is to be included in the Cache-Key (NoCacheKey
is not all set) or not (NoCacheKey is all set). (Options that are
unrecognized and marked Unsafe lead to 4.02 Bad Option.)
If the request to the destination times out, then a 5.04 (Gateway
Timeout) response MUST be returned. If the request to the
destination returns a response that cannot be processed by the proxy
(e.g, due to unrecognized critical options or message format errors),
then a 5.02 (Bad Gateway) response MUST be returned. Otherwise, the
proxy returns the response to the client.
If a response is generated out of a cache, the generated (or implied)
Max-Age Option MUST NOT extend the max-age originally set by the
server, considering the time the resource representation spent in the
cache. For example, the Max-Age Option could be adjusted by the
proxy for each response using the formula:
proxy-max-age = original-max-age - cache-age
For example, if a request is made to a proxied resource that was
refreshed 20 seconds ago and had an original Max-Age of 60 seconds,
then that resource's proxied max-age is now 40 seconds. Considering
potential network delays on the way from the origin server, a proxy
should be conservative in the max-age values offered.
All options present in a proxy request MUST be processed at the
proxy. Unsafe options in a request that are not recognized by the
proxy MUST lead to a 4.02 (Bad Option) response being returned by the
proxy. A CoAP-to-CoAP proxy MUST forward to the origin server all
Safe-to-Forward options that it does not recognize. Similarly,
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
Unsafe options in a response that are not recognized by the CoAP-to-
CoAP proxy server MUST lead to a 5.02 (Bad Gateway) response. Again,
Safe-to-Forward options that are not recognized MUST be forwarded.
Additional considerations for cross-protocol proxying between CoAP
and HTTP are discussed in <a href="#section-10">Section 10</a>.
<span class="h4"><a class="selflink" id="section-5.7.2" href="#section-5.7.2">5.7.2</a>. Forward-Proxies</span>
CoAP distinguishes between requests made (as if) to an origin server
and requests made through a forward-proxy. CoAP requests to a
forward-proxy are made as normal Confirmable or Non-confirmable
requests to the forward-proxy endpoint, but they specify the request
URI in a different way: The request URI in a proxy request is
specified as a string in the Proxy-Uri Option (see <a href="#section-5.10.2">Section 5.10.2</a>),
while the request URI in a request to an origin server is split into
the Uri-Host, Uri-Port, Uri-Path, and Uri-Query Options (see
<a href="#section-5.10.1">Section 5.10.1</a>). Alternatively, the URI in a proxy request can be
assembled from a Proxy-Scheme option and the split options mentioned.
When a proxy request is made to an endpoint and the endpoint is
unwilling or unable to act as proxy for the request URI, it MUST
return a 5.05 (Proxying Not Supported) response. If the authority
(host and port) is recognized as identifying the proxy endpoint
itself (see <a href="#section-5.10.2">Section 5.10.2</a>), then the request MUST be treated as a
local (non-proxied) request.
Unless a proxy is configured to forward the proxy request to another
proxy, it MUST translate the request as follows: the scheme of the
request URI defines the outgoing protocol and its details (e.g., CoAP
is used over UDP for the "coap" scheme and over DTLS for the "coaps"
scheme.) For a CoAP-to-CoAP proxy, the origin server's IP address
and port are determined by the authority component of the request
URI, and the request URI is decoded and split into the Uri-Host, Uri-
Port, Uri-Path and Uri-Query Options. This consumes the Proxy-Uri or
Proxy-Scheme option, which is therefore not forwarded to the origin
server.
<span class="h4"><a class="selflink" id="section-5.7.3" href="#section-5.7.3">5.7.3</a>. Reverse-Proxies</span>
Reverse-proxies do not make use of the Proxy-Uri or Proxy-Scheme
options but need to determine the destination (next hop) of a request
from information in the request and information in their
configuration. For example, a reverse-proxy might offer various
resources as if they were its own resources, after having learned of
their existence through resource discovery. The reverse-proxy is
free to build a namespace for the URIs that identify these resources.
A reverse-proxy may also build a namespace that gives the client more
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
control over where the request goes, e.g., by embedding host
identifiers and port numbers into the URI path of the resources
offered.
In processing the response, a reverse-proxy has to be careful that
ETag option values from different sources are not mixed up on one
resource offered to its clients. In many cases, the ETag can be
forwarded unchanged. If the mapping from a resource offered by the
reverse-proxy to resources offered by its various origin servers is
not unique, the reverse-proxy may need to generate a new ETag, making
sure the semantics of this option are properly preserved.
<span class="h3"><a class="selflink" id="section-5.8" href="#section-5.8">5.8</a>. Method Definitions</span>
In this section, each method is defined along with its behavior. A
request with an unrecognized or unsupported Method Code MUST generate
a 4.05 (Method Not Allowed) piggybacked response.
<span class="h4"><a class="selflink" id="section-5.8.1" href="#section-5.8.1">5.8.1</a>. GET</span>
The GET method retrieves a representation for the information that
currently corresponds to the resource identified by the request URI.
If the request includes an Accept Option, that indicates the
preferred content-format of a response. If the request includes an
ETag Option, the GET method requests that ETag be validated and that
the representation be transferred only if validation failed. Upon
success, a 2.05 (Content) or 2.03 (Valid) Response Code SHOULD be
present in the response.
The GET method is safe and idempotent.
<span class="h4"><a class="selflink" id="section-5.8.2" href="#section-5.8.2">5.8.2</a>. POST</span>
The POST method requests that the representation enclosed in the
request be processed. The actual function performed by the POST
method is determined by the origin server and dependent on the target
resource. It usually results in a new resource being created or the
target resource being updated.
If a resource has been created on the server, the response returned
by the server SHOULD have a 2.01 (Created) Response Code and SHOULD
include the URI of the new resource in a sequence of one or more
Location-Path and/or Location-Query Options (<a href="#section-5.10.7">Section 5.10.7</a>). If the
POST succeeds but does not result in a new resource being created on
the server, the response SHOULD have a 2.04 (Changed) Response Code.
If the POST succeeds and results in the target resource being
deleted, the response SHOULD have a 2.02 (Deleted) Response Code.
POST is neither safe nor idempotent.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h4"><a class="selflink" id="section-5.8.3" href="#section-5.8.3">5.8.3</a>. PUT</span>
The PUT method requests that the resource identified by the request
URI be updated or created with the enclosed representation. The
representation format is specified by the media type and content
coding given in the Content-Format Option, if provided.
If a resource exists at the request URI, the enclosed representation
SHOULD be considered a modified version of that resource, and a 2.04
(Changed) Response Code SHOULD be returned. If no resource exists,
then the server MAY create a new resource with that URI, resulting in
a 2.01 (Created) Response Code. If the resource could not be created
or modified, then an appropriate error Response Code SHOULD be sent.
Further restrictions to a PUT can be made by including the If-Match
(see <a href="#section-5.10.8.1">Section 5.10.8.1</a>) or If-None-Match (see <a href="#section-5.10.8.2">Section 5.10.8.2</a>)
options in the request.
PUT is not safe but is idempotent.
<span class="h4"><a class="selflink" id="section-5.8.4" href="#section-5.8.4">5.8.4</a>. DELETE</span>
The DELETE method requests that the resource identified by the
request URI be deleted. A 2.02 (Deleted) Response Code SHOULD be
used on success or in case the resource did not exist before the
request.
DELETE is not safe but is idempotent.
<span class="h3"><a class="selflink" id="section-5.9" href="#section-5.9">5.9</a>. Response Code Definitions</span>
Each Response Code is described below, including any options required
in the response. Where appropriate, some of the codes will be
specified in regards to related Response Codes in HTTP [<a href="./rfc2616" title=""Hypertext Transfer Protocol -- HTTP/1.1"">RFC2616</a>];
this does not mean that any such relationship modifies the HTTP
mapping specified in <a href="#section-10">Section 10</a>.
<span class="h4"><a class="selflink" id="section-5.9.1" href="#section-5.9.1">5.9.1</a>. Success 2.xx</span>
This class of Response Code indicates that the clients request was
successfully received, understood, and accepted.
<span class="h5"><a class="selflink" id="section-5.9.1.1" href="#section-5.9.1.1">5.9.1.1</a>. 2.01 Created</span>
Like HTTP 201 "Created", but only used in response to POST and PUT
requests. The payload returned with the response, if any, is a
representation of the action result.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
If the response includes one or more Location-Path and/or Location-
Query Options, the values of these options specify the location at
which the resource was created. Otherwise, the resource was created
at the request URI. A cache receiving this response MUST mark any
stored response for the created resource as not fresh.
This response is not cacheable.
<span class="h5"><a class="selflink" id="section-5.9.1.2" href="#section-5.9.1.2">5.9.1.2</a>. 2.02 Deleted</span>
This Response Code is like HTTP 204 "No Content" but only used in
response to requests that cause the resource to cease being
available, such as DELETE and, in certain circumstances, POST. The
payload returned with the response, if any, is a representation of
the action result.
This response is not cacheable. However, a cache MUST mark any
stored response for the deleted resource as not fresh.
<span class="h5"><a class="selflink" id="section-5.9.1.3" href="#section-5.9.1.3">5.9.1.3</a>. 2.03 Valid</span>
This Response Code is related to HTTP 304 "Not Modified" but only
used to indicate that the response identified by the entity-tag
identified by the included ETag Option is valid. Accordingly, the
response MUST include an ETag Option and MUST NOT include a payload.
When a cache that recognizes and processes the ETag response option
receives a 2.03 (Valid) response, it MUST update the stored response
with the value of the Max-Age Option included in the response
(explicitly, or implicitly as a default value; see also
<a href="#section-5.6.2">Section 5.6.2</a>). For each type of Safe-to-Forward option present in
the response, the (possibly empty) set of options of this type that
are present in the stored response MUST be replaced with the set of
options of this type in the response received. (Unsafe options may
trigger similar option-specific processing as defined by the option.)
<span class="h5"><a class="selflink" id="section-5.9.1.4" href="#section-5.9.1.4">5.9.1.4</a>. 2.04 Changed</span>
This Response Code is like HTTP 204 "No Content" but only used in
response to POST and PUT requests. The payload returned with the
response, if any, is a representation of the action result.
This response is not cacheable. However, a cache MUST mark any
stored response for the changed resource as not fresh.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h5"><a class="selflink" id="section-5.9.1.5" href="#section-5.9.1.5">5.9.1.5</a>. 2.05 Content</span>
This Response Code is like HTTP 200 "OK" but only used in response to
GET requests.
The payload returned with the response is a representation of the
target resource.
This response is cacheable: Caches can use the Max-Age Option to
determine freshness (see <a href="#section-5.6.1">Section 5.6.1</a>) and (if present) the ETag
Option for validation (see <a href="#section-5.6.2">Section 5.6.2</a>).
<span class="h4"><a class="selflink" id="section-5.9.2" href="#section-5.9.2">5.9.2</a>. Client Error 4.xx</span>
This class of Response Code is intended for cases in which the client
seems to have erred. These Response Codes are applicable to any
request method.
The server SHOULD include a diagnostic payload under the conditions
detailed in <a href="#section-5.5.2">Section 5.5.2</a>.
Responses of this class are cacheable: Caches can use the Max-Age
Option to determine freshness (see <a href="#section-5.6.1">Section 5.6.1</a>). They cannot be
validated.
<span class="h5"><a class="selflink" id="section-5.9.2.1" href="#section-5.9.2.1">5.9.2.1</a>. 4.00 Bad Request</span>
This Response Code is Like HTTP 400 "Bad Request".
<span class="h5"><a class="selflink" id="section-5.9.2.2" href="#section-5.9.2.2">5.9.2.2</a>. 4.01 Unauthorized</span>
The client is not authorized to perform the requested action. The
client SHOULD NOT repeat the request without first improving its
authentication status to the server. Which specific mechanism can be
used for this is outside this document's scope; see also <a href="#section-9">Section 9</a>.
<span class="h5"><a class="selflink" id="section-5.9.2.3" href="#section-5.9.2.3">5.9.2.3</a>. 4.02 Bad Option</span>
The request could not be understood by the server due to one or more
unrecognized or malformed options. The client SHOULD NOT repeat the
request without modification.
<span class="h5"><a class="selflink" id="section-5.9.2.4" href="#section-5.9.2.4">5.9.2.4</a>. 4.03 Forbidden</span>
This Response Code is like HTTP 403 "Forbidden".
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h5"><a class="selflink" id="section-5.9.2.5" href="#section-5.9.2.5">5.9.2.5</a>. 4.04 Not Found</span>
This Response Code is like HTTP 404 "Not Found".
<span class="h5"><a class="selflink" id="section-5.9.2.6" href="#section-5.9.2.6">5.9.2.6</a>. 4.05 Method Not Allowed</span>
This Response Code is like HTTP 405 "Method Not Allowed" but with no
parallel to the "Allow" header field.
<span class="h5"><a class="selflink" id="section-5.9.2.7" href="#section-5.9.2.7">5.9.2.7</a>. 4.06 Not Acceptable</span>
This Response Code is like HTTP 406 "Not Acceptable", but with no
response entity.
<span class="h5"><a class="selflink" id="section-5.9.2.8" href="#section-5.9.2.8">5.9.2.8</a>. 4.12 Precondition Failed</span>
This Response Code is like HTTP 412 "Precondition Failed".
<span class="h5"><a class="selflink" id="section-5.9.2.9" href="#section-5.9.2.9">5.9.2.9</a>. 4.13 Request Entity Too Large</span>
This Response Code is like HTTP 413 "Request Entity Too Large".
The response SHOULD include a Size1 Option (<a href="#section-5.10.9">Section 5.10.9</a>) to
indicate the maximum size of request entity the server is able and
willing to handle, unless the server is not in a position to make
this information available.
<span class="h5"><a class="selflink" id="section-5.9.2.10" href="#section-5.9.2.10">5.9.2.10</a>. 4.15 Unsupported Content-Format</span>
This Response Code is like HTTP 415 "Unsupported Media Type".
<span class="h4"><a class="selflink" id="section-5.9.3" href="#section-5.9.3">5.9.3</a>. Server Error 5.xx</span>
This class of Response Code indicates cases in which the server is
aware that it has erred or is incapable of performing the request.
These Response Codes are applicable to any request method.
The server SHOULD include a diagnostic payload under the conditions
detailed in <a href="#section-5.5.2">Section 5.5.2</a>.
Responses of this class are cacheable: Caches can use the Max-Age
Option to determine freshness (see <a href="#section-5.6.1">Section 5.6.1</a>). They cannot be
validated.
<span class="h5"><a class="selflink" id="section-5.9.3.1" href="#section-5.9.3.1">5.9.3.1</a>. 5.00 Internal Server Error</span>
This Response Code is like HTTP 500 "Internal Server Error".
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h5"><a class="selflink" id="section-5.9.3.2" href="#section-5.9.3.2">5.9.3.2</a>. 5.01 Not Implemented</span>
This Response Code is like HTTP 501 "Not Implemented".
<span class="h5"><a class="selflink" id="section-5.9.3.3" href="#section-5.9.3.3">5.9.3.3</a>. 5.02 Bad Gateway</span>
This Response Code is like HTTP 502 "Bad Gateway".
<span class="h5"><a class="selflink" id="section-5.9.3.4" href="#section-5.9.3.4">5.9.3.4</a>. 5.03 Service Unavailable</span>
This Response Code is like HTTP 503 "Service Unavailable" but uses
the Max-Age Option in place of the "Retry-After" header field to
indicate the number of seconds after which to retry.
<span class="h5"><a class="selflink" id="section-5.9.3.5" href="#section-5.9.3.5">5.9.3.5</a>. 5.04 Gateway Timeout</span>
This Response Code is like HTTP 504 "Gateway Timeout".
<span class="h5"><a class="selflink" id="section-5.9.3.6" href="#section-5.9.3.6">5.9.3.6</a>. 5.05 Proxying Not Supported</span>
The server is unable or unwilling to act as a forward-proxy for the
URI specified in the Proxy-Uri Option or using Proxy-Scheme (see
<a href="#section-5.10.2">Section 5.10.2</a>).
<span class="h3"><a class="selflink" id="section-5.10" href="#section-5.10">5.10</a>. Option Definitions</span>
The individual CoAP options are summarized in Table 4 and explained
in the subsections of this section.
In this table, the C, U, and N columns indicate the properties
Critical, UnSafe, and NoCacheKey, respectively. Since NoCacheKey
only has a meaning for options that are Safe-to-Forward (not marked
Unsafe), the column is filled with a dash for UnSafe options.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
+-----+---+---+---+---+----------------+--------+--------+----------+
| No. | C | U | N | R | Name | Format | Length | Default |
+-----+---+---+---+---+----------------+--------+--------+----------+
| 1 | x | | | x | If-Match | opaque | 0-8 | (none) |
| 3 | x | x | - | | Uri-Host | string | 1-255 | (see |
| | | | | | | | | below) |
| 4 | | | | x | ETag | opaque | 1-8 | (none) |
| 5 | x | | | | If-None-Match | empty | 0 | (none) |
| 7 | x | x | - | | Uri-Port | uint | 0-2 | (see |
| | | | | | | | | below) |
| 8 | | | | x | Location-Path | string | 0-255 | (none) |
| 11 | x | x | - | x | Uri-Path | string | 0-255 | (none) |
| 12 | | | | | Content-Format | uint | 0-2 | (none) |
| 14 | | x | - | | Max-Age | uint | 0-4 | 60 |
| 15 | x | x | - | x | Uri-Query | string | 0-255 | (none) |
| 17 | x | | | | Accept | uint | 0-2 | (none) |
| 20 | | | | x | Location-Query | string | 0-255 | (none) |
| 35 | x | x | - | | Proxy-Uri | string | 1-1034 | (none) |
| 39 | x | x | - | | Proxy-Scheme | string | 1-255 | (none) |
| 60 | | | x | | Size1 | uint | 0-4 | (none) |
+-----+---+---+---+---+----------------+--------+--------+----------+
C=Critical, U=Unsafe, N=NoCacheKey, R=Repeatable
Table 4: Options
<span class="h4"><a class="selflink" id="section-5.10.1" href="#section-5.10.1">5.10.1</a>. Uri-Host, Uri-Port, Uri-Path, and Uri-Query</span>
The Uri-Host, Uri-Port, Uri-Path, and Uri-Query Options are used to
specify the target resource of a request to a CoAP origin server.
The options encode the different components of the request URI in a
way that no percent-encoding is visible in the option values and that
the full URI can be reconstructed at any involved endpoint. The
syntax of CoAP URIs is defined in <a href="#section-6">Section 6</a>.
The steps for parsing URIs into options is defined in <a href="#section-6.4">Section 6.4</a>.
These steps result in zero or more Uri-Host, Uri-Port, Uri-Path, and
Uri-Query Options being included in a request, where each option
holds the following values:
o the Uri-Host Option specifies the Internet host of the resource
being requested,
o the Uri-Port Option specifies the transport-layer port number of
the resource,
o each Uri-Path Option specifies one segment of the absolute path to
the resource, and
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
o each Uri-Query Option specifies one argument parameterizing the
resource.
Note: Fragments (<a href="./rfc3986#section-3.5">[RFC3986], Section 3.5</a>) are not part of the request
URI and thus will not be transmitted in a CoAP request.
The default value of the Uri-Host Option is the IP literal
representing the destination IP address of the request message.
Likewise, the default value of the Uri-Port Option is the destination
UDP port. The default values for the Uri-Host and Uri-Port Options
are sufficient for requests to most servers. Explicit Uri-Host and
Uri-Port Options are typically used when an endpoint hosts multiple
virtual servers.
The Uri-Path and Uri-Query Option can contain any character sequence.
No percent-encoding is performed. The value of a Uri-Path Option
MUST NOT be "." or ".." (as the request URI must be resolved before
parsing it into options).
The steps for constructing the request URI from the options are
defined in <a href="#section-6.5">Section 6.5</a>. Note that an implementation does not
necessarily have to construct the URI; it can simply look up the
target resource by examining the individual options.
Examples can be found in <a href="#appendix-B">Appendix B</a>.
<span class="h4"><a class="selflink" id="section-5.10.2" href="#section-5.10.2">5.10.2</a>. Proxy-Uri and Proxy-Scheme</span>
The Proxy-Uri Option is used to make a request to a forward-proxy
(see <a href="#section-5.7">Section 5.7</a>). The forward-proxy is requested to forward the
request or service it from a valid cache and return the response.
The option value is an absolute-URI (<a href="./rfc3986#section-4.3">[RFC3986], Section 4.3</a>).
Note that the forward-proxy MAY forward the request on to another
proxy or directly to the server specified by the absolute-URI. In
order to avoid request loops, a proxy MUST be able to recognize all
of its server names, including any aliases, local variations, and the
numeric IP addresses.
An endpoint receiving a request with a Proxy-Uri Option that is
unable or unwilling to act as a forward-proxy for the request MUST
cause the return of a 5.05 (Proxying Not Supported) response.
The Proxy-Uri Option MUST take precedence over any of the Uri-Host,
Uri-Port, Uri-Path or Uri-Query options (each of which MUST NOT be
included in a request containing the Proxy-Uri Option).
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
As a special case to simplify many proxy clients, the absolute-URI
can be constructed from the Uri-* options. When a Proxy-Scheme
Option is present, the absolute-URI is constructed as follows: a CoAP
URI is constructed from the Uri-* options as defined in <a href="#section-6.5">Section 6.5</a>.
In the resulting URI, the initial scheme up to, but not including,
the following colon is then replaced by the content of the Proxy-
Scheme Option. Note that this case is only applicable if the
components of the desired URI other than the scheme component
actually can be expressed using Uri-* options; for example, to
represent a URI with a userinfo component in the authority, only
Proxy-Uri can be used.
<span class="h4"><a class="selflink" id="section-5.10.3" href="#section-5.10.3">5.10.3</a>. Content-Format</span>
The Content-Format Option indicates the representation format of the
message payload. The representation format is given as a numeric
Content-Format identifier that is defined in the "CoAP Content-
Formats" registry (<a href="#section-12.3">Section 12.3</a>). In the absence of the option, no
default value is assumed, i.e., the representation format of any
representation message payload is indeterminate (<a href="#section-5.5">Section 5.5</a>).
<span class="h4"><a class="selflink" id="section-5.10.4" href="#section-5.10.4">5.10.4</a>. Accept</span>
The CoAP Accept option can be used to indicate which Content-Format
is acceptable to the client. The representation format is given as a
numeric Content-Format identifier that is defined in the "CoAP
Content-Formats" registry (<a href="#section-12.3">Section 12.3</a>). If no Accept option is
given, the client does not express a preference (thus no default
value is assumed). The client prefers the representation returned by
the server to be in the Content-Format indicated. The server returns
the preferred Content-Format if available. If the preferred Content-
Format cannot be returned, then a 4.06 "Not Acceptable" MUST be sent
as a response, unless another error code takes precedence for this
response.
<span class="h4"><a class="selflink" id="section-5.10.5" href="#section-5.10.5">5.10.5</a>. Max-Age</span>
The Max-Age Option indicates the maximum time a response may be
cached before it is considered not fresh (see <a href="#section-5.6.1">Section 5.6.1</a>).
The option value is an integer number of seconds between 0 and
2**32-1 inclusive (about 136.1 years). A default value of 60 seconds
is assumed in the absence of the option in a response.
The value is intended to be current at the time of transmission.
Servers that provide resources with strict tolerances on the value of
Max-Age SHOULD update the value before each retransmission. (See
also <a href="#section-5.7.1">Section 5.7.1</a>.)
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h4"><a class="selflink" id="section-5.10.6" href="#section-5.10.6">5.10.6</a>. ETag</span>
An entity-tag is intended for use as a resource-local identifier for
differentiating between representations of the same resource that
vary over time. It is generated by the server providing the
resource, which may generate it in any number of ways including a
version, checksum, hash, or time. An endpoint receiving an entity-
tag MUST treat it as opaque and make no assumptions about its content
or structure. (Endpoints that generate an entity-tag are encouraged
to use the most compact representation possible, in particular in
regards to clients and intermediaries that may want to store multiple
ETag values.)
<span class="h5"><a class="selflink" id="section-5.10.6.1" href="#section-5.10.6.1">5.10.6.1</a>. ETag as a Response Option</span>
The ETag Option in a response provides the current value (i.e., after
the request was processed) of the entity-tag for the "tagged
representation". If no Location-* options are present, the tagged
representation is the selected representation (<a href="#section-5.5.3">Section 5.5.3</a>) of the
target resource. If one or more Location-* options are present and
thus a location URI is indicated (<a href="#section-5.10.7">Section 5.10.7</a>), the tagged
representation is the representation that would be retrieved by a GET
request to the location URI.
An ETag response option can be included with any response for which
there is a tagged representation (e.g., it would not be meaningful in
a 4.04 or 4.00 response). The ETag Option MUST NOT occur more than
once in a response.
There is no default value for the ETag Option; if it is not present
in a response, the server makes no statement about the entity-tag for
the tagged representation.
<span class="h5"><a class="selflink" id="section-5.10.6.2" href="#section-5.10.6.2">5.10.6.2</a>. ETag as a Request Option</span>
In a GET request, an endpoint that has one or more representations
previously obtained from the resource, and has obtained ETag response
options with these, can specify an instance of the ETag Option for
one or more of these stored responses.
A server can issue a 2.03 Valid response (<a href="#section-5.9.1.3">Section 5.9.1.3</a>) in place
of a 2.05 Content response if one of the ETags given is the entity-
tag for the current representation, i.e., is valid; the 2.03 Valid
response then echoes this specific ETag in a response option.
In effect, a client can determine if any of the stored
representations is current (see <a href="#section-5.6.2">Section 5.6.2</a>) without needing to
transfer them again.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
The ETag Option MAY occur zero, one, or multiple times in a request.
<span class="h4"><a class="selflink" id="section-5.10.7" href="#section-5.10.7">5.10.7</a>. Location-Path and Location-Query</span>
The Location-Path and Location-Query Options together indicate a
relative URI that consists either of an absolute path, a query
string, or both. A combination of these options is included in a
2.01 (Created) response to indicate the location of the resource
created as the result of a POST request (see <a href="#section-5.8.2">Section 5.8.2</a>). The
location is resolved relative to the request URI.
If a response with one or more Location-Path and/or Location-Query
Options passes through a cache that interprets these options and the
implied URI identifies one or more currently stored responses, those
entries MUST be marked as not fresh.
Each Location-Path Option specifies one segment of the absolute path
to the resource, and each Location-Query Option specifies one
argument parameterizing the resource. The Location-Path and
Location-Query Option can contain any character sequence. No
percent-encoding is performed. The value of a Location-Path Option
MUST NOT be "." or "..".
The steps for constructing the location URI from the options are
analogous to <a href="#section-6.5">Section 6.5</a>, except that the first five steps are
skipped and the result is a relative URI-reference, which is then
interpreted relative to the request URI. Note that the relative URI-
reference constructed this way always includes an absolute path
(e.g., leaving out Location-Path but supplying Location-Query means
the path component in the URI is "/").
The options that are used to compute the relative URI-reference are
collectively called Location-* options. Beyond Location-Path and
Location-Query, more Location-* options may be defined in the future
and have been reserved option numbers 128, 132, 136, and 140. If any
of these reserved option numbers occurs in addition to Location-Path
and/or Location-Query and are not supported, then a 4.02 (Bad Option)
error MUST be returned.
<span class="h4"><a class="selflink" id="section-5.10.8" href="#section-5.10.8">5.10.8</a>. Conditional Request Options</span>
Conditional request options enable a client to ask the server to
perform the request only if certain conditions specified by the
option are fulfilled.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
For each of these options, if the condition given is not fulfilled,
then the server MUST NOT perform the requested method. Instead, the
server MUST respond with the 4.12 (Precondition Failed) Response
Code.
If the condition is fulfilled, the server performs the request method
as if the conditional request options were not present.
If the request would, without the conditional request options, result
in anything other than a 2.xx or 4.12 Response Code, then any
conditional request options MAY be ignored.
<span class="h5"><a class="selflink" id="section-5.10.8.1" href="#section-5.10.8.1">5.10.8.1</a>. If-Match</span>
The If-Match Option MAY be used to make a request conditional on the
current existence or value of an ETag for one or more representations
of the target resource. If-Match is generally useful for resource
update requests, such as PUT requests, as a means for protecting
against accidental overwrites when multiple clients are acting in
parallel on the same resource (i.e., the "lost update" problem).
The value of an If-Match option is either an ETag or the empty
string. An If-Match option with an ETag matches a representation
with that exact ETag. An If-Match option with an empty value matches
any existing representation (i.e., it places the precondition on the
existence of any current representation for the target resource).
The If-Match Option can occur multiple times. If any of the options
match, then the condition is fulfilled.
If there is one or more If-Match Options, but none of the options
match, then the condition is not fulfilled.
<span class="h5"><a class="selflink" id="section-5.10.8.2" href="#section-5.10.8.2">5.10.8.2</a>. If-None-Match</span>
The If-None-Match Option MAY be used to make a request conditional on
the nonexistence of the target resource. If-None-Match is useful for
resource creation requests, such as PUT requests, as a means for
protecting against accidental overwrites when multiple clients are
acting in parallel on the same resource. The If-None-Match Option
carries no value.
If the target resource does exist, then the condition is not
fulfilled.
(It is not very useful to combine If-Match and If-None-Match options
in one request, because the condition will then never be fulfilled.)
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h4"><a class="selflink" id="section-5.10.9" href="#section-5.10.9">5.10.9</a>. Size1 Option</span>
The Size1 option provides size information about the resource
representation in a request. The option value is an integer number
of bytes. Its main use is with block-wise transfers [<a href="#ref-BLOCK" title=""Blockwise transfers in CoAP"">BLOCK</a>]. In the
present specification, it is used in 4.13 responses (<a href="#section-5.9.2.9">Section 5.9.2.9</a>)
to indicate the maximum size of request entity that the server is
able and willing to handle.
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. CoAP URIs</span>
CoAP uses the "coap" and "coaps" URI schemes for identifying CoAP
resources and providing a means of locating the resource. Resources
are organized hierarchically and governed by a potential CoAP origin
server listening for CoAP requests ("coap") or DTLS-secured CoAP
requests ("coaps") on a given UDP port. The CoAP server is
identified via the generic syntax's authority component, which
includes a host component and optional UDP port number. The
remainder of the URI is considered to be identifying a resource that
can be operated on by the methods defined by the CoAP protocol. The
"coap" and "coaps" URI schemes can thus be compared to the "http" and
"https" URI schemes, respectively.
The syntax of the "coap" and "coaps" URI schemes is specified in this
section in Augmented Backus-Naur Form (ABNF) [<a href="./rfc5234" title=""Augmented BNF for Syntax Specifications: ABNF"">RFC5234</a>]. The
definitions of "host", "port", "path-abempty", "query", "segment",
"IP-literal", "IPv4address", and "reg-name" are adopted from
[<a href="./rfc3986" title=""Uniform Resource Identifier (URI): Generic Syntax"">RFC3986</a>].
Implementation Note: Unfortunately, over time, the URI format has
acquired significant complexity. Implementers are encouraged to
examine [<a href="./rfc3986" title=""Uniform Resource Identifier (URI): Generic Syntax"">RFC3986</a>] closely. For example, the ABNF for IPv6
addresses is more complicated than maybe expected. Also,
implementers should take care to perform the processing of
percent-decoding or percent-encoding exactly once on the way from
a URI to its decoded components or back. Percent-encoding is
crucial for data transparency but may lead to unusual results such
as a slash character in a path component.
<span class="h3"><a class="selflink" id="section-6.1" href="#section-6.1">6.1</a>. coap URI Scheme</span>
coap-URI = "coap:" "//" host [ ":" port ] path-abempty [ "?" query ]
If the host component is provided as an IP-literal or IPv4address,
then the CoAP server can be reached at that IP address. If host is a
registered name, then that name is considered an indirect identifier
and the endpoint might use a name resolution service, such as DNS, to
find the address of that host. The host MUST NOT be empty; if a URI
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
is received with a missing authority or an empty host, then it MUST
be considered invalid. The port subcomponent indicates the UDP port
at which the CoAP server is located. If it is empty or not given,
then the default port 5683 is assumed.
The path identifies a resource within the scope of the host and port.
It consists of a sequence of path segments separated by a slash
character (U+002F SOLIDUS "/").
The query serves to further parameterize the resource. It consists
of a sequence of arguments separated by an ampersand character
(U+0026 AMPERSAND "&"). An argument is often in the form of a
"key=value" pair.
The "coap" URI scheme supports the path prefix "/.well-known/"
defined by [<a href="./rfc5785" title=""Defining Well-Known Uniform Resource Identifiers (URIs)"">RFC5785</a>] for "well-known locations" in the namespace of a
host. This enables discovery of policy or other information about a
host ("site-wide metadata"), such as hosted resources (see
<a href="#section-7">Section 7</a>).
Application designers are encouraged to make use of short but
descriptive URIs. As the environments that CoAP is used in are
usually constrained for bandwidth and energy, the trade-off between
these two qualities should lean towards the shortness, without
ignoring descriptiveness.
<span class="h3"><a class="selflink" id="section-6.2" href="#section-6.2">6.2</a>. coaps URI Scheme</span>
coaps-URI = "coaps:" "//" host [ ":" port ] path-abempty
[ "?" query ]
All of the requirements listed above for the "coap" scheme are also
requirements for the "coaps" scheme, except that a default UDP port
of 5684 is assumed if the port subcomponent is empty or not given,
and the UDP datagrams MUST be secured through the use of DTLS as
described in <a href="#section-9.1">Section 9.1</a>.
Considerations for caching of responses to "coaps" identified
requests are discussed in <a href="#section-11.2">Section 11.2</a>.
Resources made available via the "coaps" scheme have no shared
identity with the "coap" scheme even if their resource identifiers
indicate the same authority (the same host listening to the same UDP
port). They are distinct namespaces and are considered to be
distinct origin servers.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h3"><a class="selflink" id="section-6.3" href="#section-6.3">6.3</a>. Normalization and Comparison Rules</span>
Since the "coap" and "coaps" schemes conform to the URI generic
syntax, such URIs are normalized and compared according to the
algorithm defined in <a href="./rfc3986#section-6">[RFC3986], Section 6</a>, using the defaults
described above for each scheme.
If the port is equal to the default port for a scheme, the normal
form is to elide the port subcomponent. Likewise, an empty path
component is equivalent to an absolute path of "/", so the normal
form is to provide a path of "/" instead. The scheme and host are
case insensitive and normally provided in lowercase; IP-literals are
in recommended form [<a href="./rfc5952" title=""A Recommendation for IPv6 Address Text Representation"">RFC5952</a>]; all other components are compared in a
case-sensitive manner. Characters other than those in the "reserved"
set are equivalent to their percent-encoded bytes (see <a href="./rfc3986#section-2.1">[RFC3986],
Section 2.1</a>): the normal form is to not encode them.
For example, the following three URIs are equivalent and cause the
same options and option values to appear in the CoAP messages:
coap://example.com:5683/~sensors/temp.xml
coap://EXAMPLE.com/%7Esensors/temp.xml
coap://EXAMPLE.com:/%7esensors/temp.xml
<span class="h3"><a class="selflink" id="section-6.4" href="#section-6.4">6.4</a>. Decomposing URIs into Options</span>
The steps to parse a request's options from a string |url| are as
follows. These steps either result in zero or more of the Uri-Host,
Uri-Port, Uri-Path, and Uri-Query Options being included in the
request or they fail.
1. If the |url| string is not an absolute URI ([<a href="./rfc3986" title=""Uniform Resource Identifier (URI): Generic Syntax"">RFC3986</a>]), then fail
this algorithm.
2. Resolve the |url| string using the process of reference
resolution defined by [<a href="./rfc3986" title=""Uniform Resource Identifier (URI): Generic Syntax"">RFC3986</a>]. At this stage, the URL is in
ASCII encoding [<a href="./rfc0020" title=""ASCII format for network interchange"">RFC0020</a>], even though the decoded components will
be interpreted in UTF-8 [<a href="./rfc3629" title=""UTF-8, a transformation format of ISO 10646"">RFC3629</a>] after steps 5, 8, and 9.
NOTE: It doesn't matter what it is resolved relative to, since we
already know it is an absolute URL at this point.
3. If |url| does not have a <scheme> component whose value, when
converted to ASCII lowercase, is "coap" or "coaps", then fail
this algorithm.
4. If |url| has a <fragment> component, then fail this algorithm.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
5. If the <host> component of |url| does not represent the request's
destination IP address as an IP-literal or IPv4address, include a
Uri-Host Option and let that option's value be the value of the
<host> component of |url|, converted to ASCII lowercase, and then
convert all percent-encodings ("%" followed by two hexadecimal
digits) to the corresponding characters.
NOTE: In the usual case where the request's destination IP
address is derived from the host part, this ensures that a Uri-
Host Option is only used for a <host> component of the form reg-
name.
6. If |url| has a <port> component, then let |port| be that
component's value interpreted as a decimal integer; otherwise,
let |port| be the default port for the scheme.
7. If |port| does not equal the request's destination UDP port,
include a Uri-Port Option and let that option's value be |port|.
8. If the value of the <path> component of |url| is empty or
consists of a single slash character (U+002F SOLIDUS "/"), then
move to the next step.
Otherwise, for each segment in the <path> component, include a
Uri-Path Option and let that option's value be the segment (not
including the delimiting slash characters) after converting each
percent-encoding ("%" followed by two hexadecimal digits) to the
corresponding byte.
9. If |url| has a <query> component, then, for each argument in the
<query> component, include a Uri-Query Option and let that
option's value be the argument (not including the question mark
and the delimiting ampersand characters) after converting each
percent-encoding to the corresponding byte.
Note that these rules completely resolve any percent-encoding.
<span class="h3"><a class="selflink" id="section-6.5" href="#section-6.5">6.5</a>. Composing URIs from Options</span>
The steps to construct a URI from a request's options are as follows.
These steps either result in a URI or they fail. In these steps,
percent-encoding a character means replacing each of its
(UTF-8-encoded) bytes by a "%" character followed by two hexadecimal
digits representing the byte, where the digits A-F are in uppercase
(as defined in <a href="./rfc3986#section-2.1">Section 2.1 of [RFC3986]</a>; to reduce variability, the
hexadecimal notation for percent-encoding in CoAP URIs MUST use
uppercase letters). The definitions of "unreserved" and "sub-delims"
are adopted from [<a href="./rfc3986" title=""Uniform Resource Identifier (URI): Generic Syntax"">RFC3986</a>].
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
1. If the request is secured using DTLS, let |url| be the string
"coaps://". Otherwise, let |url| be the string "coap://".
2. If the request includes a Uri-Host Option, let |host| be that
option's value, where any non-ASCII characters are replaced by
their corresponding percent-encoding. If |host| is not a valid
reg-name or IP-literal or IPv4address, fail the algorithm. If
the request does not include a Uri-Host Option, let |host| be
the IP-literal (making use of the conventions of [<a href="./rfc5952" title=""A Recommendation for IPv6 Address Text Representation"">RFC5952</a>]) or
IPv4address representing the request's destination IP address.
3. Append |host| to |url|.
4. If the request includes a Uri-Port Option, let |port| be that
option's value. Otherwise, let |port| be the request's
destination UDP port.
5. If |port| is not the default port for the scheme, then append a
single U+003A COLON character (:) followed by the decimal
representation of |port| to |url|.
6. Let |resource name| be the empty string. For each Uri-Path
Option in the request, append a single character U+002F SOLIDUS
(/) followed by the option's value to |resource name|, after
converting any character that is not either in the "unreserved"
set, in the "sub-delims" set, a U+003A COLON (:) character, or a
U+0040 COMMERCIAL AT (@) character to its percent-encoded form.
7. If |resource name| is the empty string, set it to a single
character U+002F SOLIDUS (/).
8. For each Uri-Query Option in the request, append a single
character U+003F QUESTION MARK (?) (first option) or U+0026
AMPERSAND (&) (subsequent options) followed by the option's
value to |resource name|, after converting any character that is
not either in the "unreserved" set, in the "sub-delims" set
(except U+0026 AMPERSAND (&)), a U+003A COLON (:), a U+0040
COMMERCIAL AT (@), a U+002F SOLIDUS (/), or a U+003F QUESTION
MARK (?) character to its percent-encoded form.
9. Append |resource name| to |url|.
10. Return |url|.
Note that these steps have been designed to lead to a URI in normal
form (see <a href="#section-6.3">Section 6.3</a>).
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. Discovery</span>
<span class="h3"><a class="selflink" id="section-7.1" href="#section-7.1">7.1</a>. Service Discovery</span>
As a part of discovering the services offered by a CoAP server, a
client has to learn about the endpoint used by a server.
A server is discovered by a client (knowing or) learning a URI that
references a resource in the namespace of the server. Alternatively,
clients can use multicast CoAP (see <a href="#section-8">Section 8</a>) and the "All CoAP
Nodes" multicast address to find CoAP servers.
Unless the port subcomponent in a "coap" or "coaps" URI indicates the
UDP port at which the CoAP server is located, the server is assumed
to be reachable at the default port.
The CoAP default port number 5683 MUST be supported by a server that
offers resources for resource discovery (see <a href="#section-7.2">Section 7.2</a> below) and
SHOULD be supported for providing access to other resources. The
default port number 5684 for DTLS-secured CoAP MAY be supported by a
server for resource discovery and for providing access to other
resources. In addition, other endpoints may be hosted at other
ports, e.g., in the dynamic port space.
Implementation Note: When a CoAP server is hosted by a 6LoWPAN node,
header compression efficiency is improved when it also supports a
port number in the 61616-61631 compressed UDP port space defined
in [<a href="./rfc4944" title=""Transmission of IPv6 Packets over IEEE 802.15.4 Networks"">RFC4944</a>] and [<a href="./rfc6282" title=""Compression Format for IPv6 Datagrams over IEEE 802.15.4-Based Networks"">RFC6282</a>]. (Note that, as its UDP port differs
from the default port, it is a different endpoint from the server
at the default port.)
<span class="h3"><a class="selflink" id="section-7.2" href="#section-7.2">7.2</a>. Resource Discovery</span>
The discovery of resources offered by a CoAP endpoint is extremely
important in machine-to-machine applications where there are no
humans in the loop and static interfaces result in fragility. To
maximize interoperability in a CoRE environment, a CoAP endpoint
SHOULD support the CoRE Link Format of discoverable resources as
described in [<a href="./rfc6690" title=""Constrained RESTful Environments (CoRE) Link Format"">RFC6690</a>], except where fully manual configuration is
desired. It is up to the server which resources are made
discoverable (if any).
<span class="h4"><a class="selflink" id="section-7.2.1" href="#section-7.2.1">7.2.1</a>. 'ct' Attribute</span>
This section defines a new Web Linking [<a href="./rfc5988" title=""Web Linking"">RFC5988</a>] attribute for use
with [<a href="./rfc6690" title=""Constrained RESTful Environments (CoRE) Link Format"">RFC6690</a>]. The Content-Format code "ct" attribute provides a
hint about the Content-Formats this resource returns. Note that this
is only a hint, and it does not override the Content-Format Option of
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
a CoAP response obtained by actually requesting the representation of
the resource. The value is in the CoAP identifier code format as a
decimal ASCII integer and MUST be in the range of 0-65535 (16-bit
unsigned integer). For example, "application/xml" would be indicated
as "ct=41". If no Content-Format code attribute is present, then
nothing about the type can be assumed. The Content-Format code
attribute MAY include a space-separated sequence of Content-Format
codes, indicating that multiple content-formats are available. The
syntax of the attribute value is summarized in the production "ct-
value" in Figure 12, where "cardinal", "SP", and "DQUOTE" are defined
as in [<a href="./rfc6690" title=""Constrained RESTful Environments (CoRE) Link Format"">RFC6690</a>].
ct-value = cardinal
/ DQUOTE cardinal *( 1*SP cardinal ) DQUOTE
Figure 12
<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. Multicast CoAP</span>
CoAP supports making requests to an IP multicast group. This is
defined by a series of deltas to unicast CoAP. A more general
discussion of group communication with CoAP is in [<a href="#ref-GROUPCOMM">GROUPCOMM</a>].
CoAP endpoints that offer services that they want other endpoints to
be able to find using multicast service discovery join one or more of
the appropriate all-CoAP-node multicast addresses (<a href="#section-12.8">Section 12.8</a>) and
listen on the default CoAP port. Note that an endpoint might receive
multicast requests on other multicast addresses, including the all-
nodes IPv6 address (or via broadcast on IPv4); an endpoint MUST
therefore be prepared to receive such messages but MAY ignore them if
multicast service discovery is not desired.
<span class="h3"><a class="selflink" id="section-8.1" href="#section-8.1">8.1</a>. Messaging Layer</span>
A multicast request is characterized by being transported in a CoAP
message that is addressed to an IP multicast address instead of a
CoAP endpoint. Such multicast requests MUST be Non-confirmable.
A server SHOULD be aware that a request arrived via multicast, e.g.,
by making use of modern APIs such as IPV6_RECVPKTINFO [<a href="./rfc3542" title=""Advanced Sockets Application Program Interface (API) for IPv6"">RFC3542</a>], if
available.
To avoid an implosion of error responses, when a server is aware that
a request arrived via multicast, it MUST NOT return a Reset message
in reply to a Non-confirmable message. If it is not aware, it MAY
return a Reset message in reply to a Non-confirmable message as
usual. Because such a Reset message will look identical to one for a
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
unicast message from the sender, the sender MUST avoid using a
Message ID that is also still active from this endpoint with any
unicast endpoint that might receive the multicast message.
At the time of writing, multicast messages can only be carried in UDP
not in DTLS. This means that the security modes defined for CoAP in
this document are not applicable to multicast.
<span class="h3"><a class="selflink" id="section-8.2" href="#section-8.2">8.2</a>. Request/Response Layer</span>
When a server is aware that a request arrived via multicast, the
server MAY always ignore the request, in particular if it doesn't
have anything useful to respond (e.g., if it only has an empty
payload or an error response). The decision for this may depend on
the application. (For example, in query filtering as described in
[<a href="./rfc6690" title=""Constrained RESTful Environments (CoRE) Link Format"">RFC6690</a>], a server should not respond to a multicast request if the
filter does not match. More examples are in [<a href="#ref-GROUPCOMM">GROUPCOMM</a>].)
If a server does decide to respond to a multicast request, it should
not respond immediately. Instead, it should pick a duration for the
period of time during which it intends to respond. For the purposes
of this exposition, we call the length of this period the Leisure.
The specific value of this Leisure may depend on the application or
MAY be derived as described below. The server SHOULD then pick a
random point of time within the chosen leisure period to send back
the unicast response to the multicast request. If further responses
need to be sent based on the same multicast address membership, a new
leisure period starts at the earliest after the previous one
finishes.
To compute a value for Leisure, the server should have a group size
estimate G, a target data transfer rate R (which both should be
chosen conservatively), and an estimated response size S; a rough
lower bound for Leisure can then be computed as
lb_Leisure = S * G / R
For example, for a multicast request with link-local scope on a 2.4
GHz IEEE 802.15.4 (6LoWPAN) network, G could be (relatively
conservatively) set to 100, S to 100 bytes, and the target rate to 8
kbit/s = 1 kB/s. The resulting lower bound for the Leisure is 10
seconds.
If a CoAP endpoint does not have suitable data to compute a value for
Leisure, it MAY resort to DEFAULT_LEISURE.
<span class="grey">Shelby, 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="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
When matching a response to a multicast request, only the token MUST
match; the source endpoint of the response does not need to (and will
not) be the same as the destination endpoint of the original request.
For the purposes of interpreting the Location-* options and any links
embedded in the representation, the request URI (i.e., the base URI
relative to which the response is interpreted) is formed by replacing
the multicast address in the Host component of the original request
URI by the literal IP address of the endpoint actually responding.
<span class="h4"><a class="selflink" id="section-8.2.1" href="#section-8.2.1">8.2.1</a>. Caching</span>
When a client makes a multicast request, it always makes a new
request to the multicast group (since there may be new group members
that joined meanwhile or ones that did not get the previous request).
It MAY update a cache with the received responses. Then, it uses
both cached-still-fresh and new responses as the result of the
request.
A response received in reply to a GET request to a multicast group
MAY be used to satisfy a subsequent request on the related unicast
request URI. The unicast request URI is obtained by replacing the
authority part of the request URI with the transport-layer source
address of the response message.
A cache MAY revalidate a response by making a GET request on the
related unicast request URI.
A GET request to a multicast group MUST NOT contain an ETag option.
A mechanism to suppress responses the client already has is left for
further study.
<span class="h4"><a class="selflink" id="section-8.2.2" href="#section-8.2.2">8.2.2</a>. Proxying</span>
When a forward-proxy receives a request with a Proxy-Uri or URI
constructed from Proxy-Scheme that indicates a multicast address, the
proxy obtains a set of responses as described above and sends all
responses (both cached-still-fresh and new) back to the original
client.
This specification does not provide a way to indicate the unicast-
modified request URI (base URI) in responses thus forwarded.
Proxying multicast requests is discussed in more detail in
[<a href="#ref-GROUPCOMM">GROUPCOMM</a>]; one proposal to address the base URI issue can be found
in Section 3 of [<a href="#ref-CoAP-MISC">CoAP-MISC</a>].
<span class="grey">Shelby, et al. Standards Track [Page 67]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-68" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. Securing CoAP</span>
This section defines the DTLS binding for CoAP.
During the provisioning phase, a CoAP device is provided with the
security information that it needs, including keying materials and
access control lists. This specification defines provisioning for
the RawPublicKey mode in <a href="#section-9.1.3.2.1">Section 9.1.3.2.1</a>. At the end of the
provisioning phase, the device will be in one of four security modes
with the following information for the given mode. The NoSec and
RawPublicKey modes are mandatory to implement for this specification.
NoSec: There is no protocol-level security (DTLS is disabled).
Alternative techniques to provide lower-layer security SHOULD be
used when appropriate. The use of IPsec is discussed in
[<a href="#ref-IPsec-CoAP">IPsec-CoAP</a>]. Certain link layers in use with constrained nodes
also provide link-layer security, which may be appropriate with
proper key management.
PreSharedKey: DTLS is enabled, there is a list of pre-shared keys
[<a href="./rfc4279" title=""Pre-Shared Key Ciphersuites for Transport Layer Security (TLS)"">RFC4279</a>], and each key includes a list of which nodes it can be
used to communicate with as described in <a href="#section-9.1.3.1">Section 9.1.3.1</a>. At the
extreme, there may be one key for each node this CoAP node needs
to communicate with (1:1 node/key ratio). Conversely, if more
than two entities share a specific pre-shared key, this key only
enables the entities to authenticate as a member of that group and
not as a specific peer.
RawPublicKey: DTLS is enabled and the device has an asymmetric key
pair without a certificate (a raw public key) that is validated
using an out-of-band mechanism [<a href="./rfc7250" title=""Using Raw Public Keys in Transport Layer Security (TLS) and Datagram Transport Layer Security (DTLS)"">RFC7250</a>] as described in
<a href="#section-9.1.3.2">Section 9.1.3.2</a>. The device also has an identity calculated from
the public key and a list of identities of the nodes it can
communicate with.
Certificate: DTLS is enabled and the device has an asymmetric key
pair with an X.509 certificate [<a href="./rfc5280" title=""Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile"">RFC5280</a>] that binds it to its
subject and is signed by some common trust root as described in
<a href="#section-9.1.3.3">Section 9.1.3.3</a>. The device also has a list of root trust anchors
that can be used for validating a certificate.
In the "NoSec" mode, the system simply sends the packets over normal
UDP over IP and is indicated by the "coap" scheme and the CoAP
default port. The system is secured only by keeping attackers from
being able to send or receive packets from the network with the CoAP
nodes; see <a href="#section-11.5">Section 11.5</a> for an additional complication with this
approach.
<span class="grey">Shelby, et al. Standards Track [Page 68]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-69" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
The other three security modes are achieved using DTLS and are
indicated by the "coaps" scheme and DTLS-secured CoAP default port.
The result is a security association that can be used to authenticate
(within the limits of the security model) and, based on this
authentication, authorize the communication partner. CoAP itself
does not provide protocol primitives for authentication or
authorization; where this is required, it can either be provided by
communication security (i.e., IPsec or DTLS) or by object security
(within the payload). Devices that require authorization for certain
operations are expected to require one of these two forms of
security. Necessarily, where an intermediary is involved,
communication security only works when that intermediary is part of
the trust relationships. CoAP does not provide a way to forward
different levels of authorization that clients may have with an
intermediary to further intermediaries or origin servers -- it
therefore may be required to perform all authorization at the first
intermediary.
<span class="h3"><a class="selflink" id="section-9.1" href="#section-9.1">9.1</a>. DTLS-Secured CoAP</span>
Just as HTTP is secured using Transport Layer Security (TLS) over
TCP, CoAP is secured using Datagram TLS (DTLS) [<a href="./rfc6347" title=""Datagram Transport Layer Security Version 1.2"">RFC6347</a>] over UDP
(see Figure 13). This section defines the CoAP binding to DTLS,
along with the minimal mandatory-to-implement configurations
appropriate for constrained environments. The binding is defined by
a series of deltas to unicast CoAP. In practice, DTLS is TLS with
added features to deal with the unreliable nature of the UDP
transport.
+----------------------+
| Application |
+----------------------+
+----------------------+
| Requests/Responses |
|----------------------| CoAP
| Messages |
+----------------------+
+----------------------+
| DTLS |
+----------------------+
+----------------------+
| UDP |
+----------------------+
Figure 13: Abstract Layering of DTLS-Secured CoAP
<span class="grey">Shelby, et al. Standards Track [Page 69]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-70" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
In some constrained nodes (limited flash and/or RAM) and networks
(limited bandwidth or high scalability requirements), and depending
on the specific cipher suites in use, all modes of DTLS may not be
applicable. Some DTLS cipher suites can add significant
implementation complexity as well as some initial handshake overhead
needed when setting up the security association. Once the initial
handshake is completed, DTLS adds a limited per-datagram overhead of
approximately 13 bytes, not including any initialization vectors/
nonces (e.g., 8 bytes with TLS_PSK_WITH_AES_128_CCM_8 [<a href="./rfc6655" title=""AES-CCM Cipher Suites for Transport Layer Security (TLS)"">RFC6655</a>]),
integrity check values (e.g., 8 bytes with TLS_PSK_WITH_AES_128_CCM_8
[<a href="./rfc6655" title=""AES-CCM Cipher Suites for Transport Layer Security (TLS)"">RFC6655</a>]), and padding required by the cipher suite. Whether the
use of a given mode of DTLS is applicable for a CoAP-based
application should be carefully weighed considering the specific
cipher suites that may be applicable, whether the session maintenance
makes it compatible with application flows, and whether sufficient
resources are available on the constrained nodes and for the added
network overhead. (For some modes of using DTLS, this specification
identifies a mandatory-to-implement cipher suite. This is an
implementation requirement to maximize interoperability in those
cases where these cipher suites are indeed appropriate. The specific
security policies of an application may determine the actual set of
cipher suites that can be used.) DTLS is not applicable to group
keying (multicast communication); however, it may be a component in a
future group key management protocol.
<span class="h4"><a class="selflink" id="section-9.1.1" href="#section-9.1.1">9.1.1</a>. Messaging Layer</span>
The endpoint acting as the CoAP client should also act as the DTLS
client. It should initiate a session to the server on the
appropriate port. When the DTLS handshake has finished, the client
may initiate the first CoAP request. All CoAP messages MUST be sent
as DTLS "application data".
The following rules are added for matching an Acknowledgement message
or Reset message to a Confirmable message, or a Reset message to a
Non-confirmable message: The DTLS session MUST be the same, and the
epoch MUST be the same.
A message is the same when it is sent within the same DTLS session
and same epoch and has the same Message ID.
Note: When a Confirmable message is retransmitted, a new DTLS
sequence_number is used for each attempt, even though the CoAP
Message ID stays the same. So a recipient still has to perform
deduplication as described in <a href="#section-4.5">Section 4.5</a>. Retransmissions MUST NOT
be performed across epochs.
<span class="grey">Shelby, et al. Standards Track [Page 70]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-71" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
DTLS connections in RawPublicKey and Certificate mode are set up
using mutual authentication so they can remain up and be reused for
future message exchanges in either direction. Devices can close a
DTLS connection when they need to recover resources, but in general
they should keep the connection up for as long as possible. Closing
the DTLS connection after every CoAP message exchange is very
inefficient.
<span class="h4"><a class="selflink" id="section-9.1.2" href="#section-9.1.2">9.1.2</a>. Request/Response Layer</span>
The following rules are added for matching a response to a request:
The DTLS session MUST be the same, and the epoch MUST be the same.
This means the response to a DTLS secured request MUST always be DTLS
secured using the same security session and epoch. Any attempt to
supply a NoSec response to a DTLS request simply does not match the
request and therefore MUST be rejected (unless it does match an
unrelated NoSec request).
<span class="h4"><a class="selflink" id="section-9.1.3" href="#section-9.1.3">9.1.3</a>. Endpoint Identity</span>
Devices SHOULD support the Server Name Indication (SNI) to indicate
their authority in the SNI HostName field as defined in <a href="./rfc6066#section-3">Section 3 of
[RFC6066]</a>. This is needed so that when a host that acts as a virtual
server for multiple Authorities receives a new DTLS connection, it
knows which keys to use for the DTLS session.
<span class="h5"><a class="selflink" id="section-9.1.3.1" href="#section-9.1.3.1">9.1.3.1</a>. Pre-Shared Keys</span>
When forming a connection to a new node, the system selects an
appropriate key based on which nodes it is trying to reach and then
forms a DTLS session using a PSK (Pre-Shared Key) mode of DTLS.
Implementations in these modes MUST support the mandatory-to-
implement cipher suite TLS_PSK_WITH_AES_128_CCM_8 as specified in
[<a href="./rfc6655" title=""AES-CCM Cipher Suites for Transport Layer Security (TLS)"">RFC6655</a>].
Depending on the commissioning model, applications may need to define
an application profile for identity hints (as required and detailed
in <a href="./rfc4279#section-5.2">Section 5.2 of [RFC4279]</a>) to enable the use of PSK identity hints.
The security considerations of <a href="./rfc4279#section-7">Section 7 of [RFC4279]</a> apply. In
particular, applications should carefully weigh whether or not they
need Perfect Forward Secrecy (PFS) and select an appropriate cipher
suite (<a href="./rfc4279#section-7.1">Section 7.1 of [RFC4279]</a>). The entropy of the PSK must be
sufficient to mitigate against brute-force and (where the PSK is not
chosen randomly but by a human) dictionary attacks (<a href="./rfc4279#section-7.2">Section 7.2 of
[RFC4279]</a>). The cleartext communication of client identities may
leak data or compromise privacy (<a href="./rfc4279#section-7.3">Section 7.3 of [RFC4279]</a>).
<span class="grey">Shelby, et al. Standards Track [Page 71]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-72" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h5"><a class="selflink" id="section-9.1.3.2" href="#section-9.1.3.2">9.1.3.2</a>. Raw Public Key Certificates</span>
In this mode, the device has an asymmetric key pair but without an
X.509 certificate (called a raw public key); for example, the
asymmetric key pair is generated by the manufacturer and installed on
the device (see also <a href="#section-11.6">Section 11.6</a>). A device MAY be configured with
multiple raw public keys. The type and length of the raw public key
depends on the cipher suite used. Implementations in RawPublicKey
mode MUST support the mandatory-to-implement cipher suite
TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8 as specified in [<a href="./rfc7251" title=""AES- CCM Elliptic Curve Cryptography (ECC) Cipher Suites for Transport Layer Security (TLS)"">RFC7251</a>],
[<a href="./rfc5246" title=""The Transport Layer Security (TLS) Protocol Version 1.2"">RFC5246</a>], and [<a href="./rfc4492" title=""Elliptic Curve Cryptography (ECC) Cipher Suites for Transport Layer Security (TLS)"">RFC4492</a>]. The key used MUST be ECDSA capable. The
curve secp256r1 MUST be supported [<a href="./rfc4492" title=""Elliptic Curve Cryptography (ECC) Cipher Suites for Transport Layer Security (TLS)"">RFC4492</a>]; this curve is equivalent
to the NIST P-256 curve. The hash algorithm is SHA-256.
Implementations MUST use the Supported Elliptic Curves and Supported
Point Formats Extensions [<a href="./rfc4492" title=""Elliptic Curve Cryptography (ECC) Cipher Suites for Transport Layer Security (TLS)"">RFC4492</a>]; the uncompressed point format
MUST be supported; [<a href="./rfc6090" title=""Fundamental Elliptic Curve Cryptography Algorithms"">RFC6090</a>] can be used as an implementation method.
Some guidance relevant to the implementation of this cipher suite can
be found in [<a href="#ref-W3CXMLSEC">W3CXMLSEC</a>]. The mechanism for using raw public keys
with TLS is specified in [<a href="./rfc7250" title=""Using Raw Public Keys in Transport Layer Security (TLS) and Datagram Transport Layer Security (DTLS)"">RFC7250</a>].
Implementation Note: Specifically, this means the extensions listed
in Figure 14 with at least the values listed will be present in
the DTLS handshake.
Extension: elliptic_curves
Type: elliptic_curves (0x000a)
Length: 4
Elliptic Curves Length: 2
Elliptic curves (1 curve)
Elliptic curve: secp256r1 (0x0017)
Extension: ec_point_formats
Type: ec_point_formats (0x000b)
Length: 2
EC point formats Length: 1
Elliptic curves point formats (1)
EC point format: uncompressed (0)
Extension: signature_algorithms
Type: signature_algorithms (0x000d)
Length: 4
Data (4 bytes): 00 02 04 03
HashAlgorithm: sha256 (4)
SignatureAlgorithm: ecdsa (3)
Figure 14: DTLS Extensions Present for
TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8
<span class="grey">Shelby, et al. Standards Track [Page 72]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-73" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h6"><a class="selflink" id="section-9.1.3.2.1" href="#section-9.1.3.2.1">9.1.3.2.1</a>. Provisioning</span>
The RawPublicKey mode was designed to be easily provisioned in M2M
deployments. It is assumed that each device has an appropriate
asymmetric public key pair installed. An identifier is calculated by
the endpoint from the public key as described in <a href="./rfc6920#section-2">Section 2 of
[RFC6920]</a>. All implementations that support checking RawPublicKey
identities MUST support at least the sha-256-120 mode (SHA-256
truncated to 120 bits). Implementations SHOULD also support longer
length identifiers and MAY support shorter lengths. Note that the
shorter lengths provide less security against attacks, and their use
is NOT RECOMMENDED.
Depending on how identifiers are given to the system that verifies
them, support for URI, binary, and/or human-speakable format
[<a href="./rfc6920" title=""Naming Things with Hashes"">RFC6920</a>] needs to be implemented. All implementations SHOULD
support the binary mode, and implementations that have a user
interface SHOULD also support the human-speakable format.
During provisioning, the identifier of each node is collected, for
example, by reading a barcode on the outside of the device or by
obtaining a pre-compiled list of the identifiers. These identifiers
are then installed in the corresponding endpoint, for example, an M2M
data collection server. The identifier is used for two purposes, to
associate the endpoint with further device information and to perform
access control. During (initial and ongoing) provisioning, an access
control list of identifiers with which the device may start DTLS
sessions SHOULD also be installed and maintained.
<span class="h5"><a class="selflink" id="section-9.1.3.3" href="#section-9.1.3.3">9.1.3.3</a>. X.509 Certificates</span>
Implementations in Certificate Mode MUST support the mandatory-to-
implement cipher suite TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8 as
specified in [<a href="./rfc7251" title=""AES- CCM Elliptic Curve Cryptography (ECC) Cipher Suites for Transport Layer Security (TLS)"">RFC7251</a>], [<a href="./rfc5246" title=""The Transport Layer Security (TLS) Protocol Version 1.2"">RFC5246</a>], and [<a href="./rfc4492" title=""Elliptic Curve Cryptography (ECC) Cipher Suites for Transport Layer Security (TLS)"">RFC4492</a>]. Namely, the
certificate includes a SubjectPublicKeyInfo that indicates an
algorithm of id-ecPublicKey with namedCurves secp256r1 [<a href="./rfc5480" title=""Elliptic Curve Cryptography Subject Public Key Information"">RFC5480</a>]; the
public key format is uncompressed [<a href="./rfc5480" title=""Elliptic Curve Cryptography Subject Public Key Information"">RFC5480</a>]; the hash algorithm is
SHA-256; if included, the key usage extension indicates
digitalSignature. Certificates MUST be signed with ECDSA using
secp256r1, and the signature MUST use SHA-256. The key used MUST be
ECDSA capable. The curve secp256r1 MUST be supported [<a href="./rfc4492" title=""Elliptic Curve Cryptography (ECC) Cipher Suites for Transport Layer Security (TLS)"">RFC4492</a>]; this
curve is equivalent to the NIST P-256 curve. The hash algorithm is
SHA-256. Implementations MUST use the Supported Elliptic Curves and
Supported Point Formats Extensions [<a href="./rfc4492" title=""Elliptic Curve Cryptography (ECC) Cipher Suites for Transport Layer Security (TLS)"">RFC4492</a>]; the uncompressed point
format MUST be supported; [<a href="./rfc6090" title=""Fundamental Elliptic Curve Cryptography Algorithms"">RFC6090</a>] can be used as an implementation
method.
<span class="grey">Shelby, et al. Standards Track [Page 73]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-74" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
The subject in the certificate would be built out of a long-term
unique identifier for the device such as the EUI-64 [<a href="#ref-EUI64" title=""Guidelines for 64-bit Global Identifier (EUI-64 (TM))"">EUI64</a>]. The
subject could also be based on the Fully Qualified Domain Name (FQDN)
that was used as the Host part of the CoAP URI. However, the
device's IP address should not typically be used as the subject, as
it would change over time. The discovery process used in the system
would build up the mapping between IP addresses of the given devices
and the subject for each device. Some devices could have more than
one subject and would need more than a single certificate.
When a new connection is formed, the certificate from the remote
device needs to be verified. If the CoAP node has a source of
absolute time, then the node SHOULD check that the validity dates of
the certificate are within range. The certificate MUST be validated
as appropriate for the security requirements, using functionality
equivalent to the algorithm specified in <a href="./rfc5280#section-6">Section 6 of [RFC5280]</a>. If
the certificate contains a SubjectAltName, then the authority of the
request URI MUST match at least one of the authorities of any CoAP
URI found in a field of URI type in the SubjectAltName set. If there
is no SubjectAltName in the certificate, then the authority of the
request URI MUST match the Common Name (CN) found in the certificate
using the matching rules defined in [<a href="./rfc3280" title=""Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile"">RFC3280</a>] with the exception that
certificates with wildcards are not allowed.
CoRE support for certificate status checking requires further study.
As a mapping of the Online Certificate Status Protocol (OCSP)
[<a href="./rfc6960" title=""X.509 Internet Public Key Infrastructure Online Certificate Status Protocol - OCSP"">RFC6960</a>] onto CoAP is not currently defined and OCSP may also not be
easily applicable in all environments, an alternative approach may be
using the TLS Certificate Status Request extension (<a href="./rfc6066#section-8">Section 8 of
[RFC6066]</a>; also known as "OCSP stapling") or preferably the Multiple
Certificate Status Extension ([<a href="./rfc6961" title=""The Transport Layer Security (TLS) Multiple Certificate Status Request Extension"">RFC6961</a>]), if available.
If the system has a shared key in addition to the certificate, then a
cipher suite that includes the shared key such as
TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA [<a href="./rfc5489" title=""ECDHE_PSK Cipher Suites for Transport Layer Security (TLS)"">RFC5489</a>] SHOULD be used.
<span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>. Cross-Protocol Proxying between CoAP and HTTP</span>
CoAP supports a limited subset of HTTP functionality, and thus cross-
protocol proxying to HTTP is straightforward. There might be several
reasons for proxying between CoAP and HTTP, for example, when
designing a web interface for use over either protocol or when
realizing a CoAP-HTTP proxy. Likewise, CoAP could equally be proxied
to other protocols such as XMPP [<a href="./rfc6120" title=""Extensible Messaging and Presence Protocol (XMPP): Core"">RFC6120</a>] or SIP [<a href="./rfc3264" title=""An Offer/Answer Model with Session Description Protocol (SDP)"">RFC3264</a>]; the
definition of these mechanisms is out of scope for this
specification.
<span class="grey">Shelby, et al. Standards Track [Page 74]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-75" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
There are two possible directions to access a resource via a forward-
proxy:
CoAP-HTTP Proxying: Enables CoAP clients to access resources on HTTP
servers through an intermediary. This is initiated by including
the Proxy-Uri or Proxy-Scheme Option with an "http" or "https" URI
in a CoAP request to a CoAP-HTTP proxy.
HTTP-CoAP Proxying: Enables HTTP clients to access resources on CoAP
servers through an intermediary. This is initiated by specifying
a "coap" or "coaps" URI in the Request-Line of an HTTP request to
an HTTP-CoAP proxy.
Either way, only the request/response model of CoAP is mapped to
HTTP. The underlying model of Confirmable or Non-confirmable
messages, etc., is invisible and MUST have no effect on a proxy
function. The following sections describe the handling of requests
to a forward-proxy. Reverse-proxies are not specified, as the proxy
function is transparent to the client with the proxy acting as if it
were the origin server. However, similar considerations apply to
reverse-proxies as to forward-proxies, and there generally will be an
expectation that reverse-proxies operate in a similar way forward-
proxies would. As an implementation note, HTTP client libraries may
make it hard to operate an HTTP-CoAP forward-proxy by not providing a
way to put a CoAP URI on the HTTP Request-Line; reverse-proxying may
therefore lead to wider applicability of a proxy. A separate
specification may define a convention for URIs operating such an
HTTP-CoAP reverse-proxy [<a href="#ref-MAPPING" title=""Guidelines for HTTP-CoAP Mapping Implementations"">MAPPING</a>].
<span class="h3"><a class="selflink" id="section-10.1" href="#section-10.1">10.1</a>. CoAP-HTTP Proxying</span>
If a request contains a Proxy-Uri or Proxy-Scheme Option with an
'http' or 'https' URI [<a href="./rfc2616" title=""Hypertext Transfer Protocol -- HTTP/1.1"">RFC2616</a>], then the receiving CoAP endpoint
(called "the proxy" henceforth) is requested to perform the operation
specified by the request method on the indicated HTTP resource and
return the result to the client. (See also <a href="#section-5.7">Section 5.7</a> for how the
request to the proxy is formulated, including security requirements.)
This section specifies for any CoAP request the CoAP response that
the proxy should return to the client. How the proxy actually
satisfies the request is an implementation detail, although the
typical case is expected to be that the proxy translates and forwards
the request to an HTTP origin server.
<span class="grey">Shelby, et al. Standards Track [Page 75]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-76" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
Since HTTP and CoAP share the basic set of request methods,
performing a CoAP request on an HTTP resource is not so different
from performing it on a CoAP resource. The meanings of the
individual CoAP methods when performed on HTTP resources are
explained in the subsections of this section.
If the proxy is unable or unwilling to service a request with an HTTP
URI, a 5.05 (Proxying Not Supported) response is returned to the
client. If the proxy services the request by interacting with a
third party (such as the HTTP origin server) and is unable to obtain
a result within a reasonable time frame, a 5.04 (Gateway Timeout)
response is returned; if a result can be obtained but is not
understood, a 5.02 (Bad Gateway) response is returned.
<span class="h4"><a class="selflink" id="section-10.1.1" href="#section-10.1.1">10.1.1</a>. GET</span>
The GET method requests the proxy to return a representation of the
HTTP resource identified by the request URI.
Upon success, a 2.05 (Content) Response Code SHOULD be returned. The
payload of the response MUST be a representation of the target HTTP
resource, and the Content-Format Option MUST be set accordingly. The
response MUST indicate a Max-Age value that is no greater than the
remaining time the representation can be considered fresh. If the
HTTP entity has an entity-tag, the proxy SHOULD include an ETag
Option in the response and process ETag Options in requests as
described below.
A client can influence the processing of a GET request by including
the following option:
Accept: The request MAY include an Accept Option, identifying the
preferred response content-format.
ETag: The request MAY include one or more ETag Options, identifying
responses that the client has stored. This requests the proxy to
send a 2.03 (Valid) response whenever it would send a 2.05
(Content) response with an entity-tag in the requested set
otherwise. Note that CoAP ETags are always strong ETags in the
HTTP sense; CoAP does not have the equivalent of HTTP weak ETags,
and there is no good way to make use of these in a cross-proxy.
<span class="grey">Shelby, et al. Standards Track [Page 76]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-77" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h4"><a class="selflink" id="section-10.1.2" href="#section-10.1.2">10.1.2</a>. PUT</span>
The PUT method requests the proxy to update or create the HTTP
resource identified by the request URI with the enclosed
representation.
If a new resource is created at the request URI, a 2.01 (Created)
response MUST be returned to the client. If an existing resource is
modified, a 2.04 (Changed) response MUST be returned to indicate
successful completion of the request.
<span class="h4"><a class="selflink" id="section-10.1.3" href="#section-10.1.3">10.1.3</a>. DELETE</span>
The DELETE method requests the proxy to delete the HTTP resource
identified by the request URI at the HTTP origin server.
A 2.02 (Deleted) response MUST be returned to the client upon success
or if the resource does not exist at the time of the request.
<span class="h4"><a class="selflink" id="section-10.1.4" href="#section-10.1.4">10.1.4</a>. POST</span>
The POST method requests the proxy to have the representation
enclosed in the request be processed by the HTTP origin server. The
actual function performed by the POST method is determined by the
origin server and dependent on the resource identified by the request
URI.
If the action performed by the POST method does not result in a
resource that can be identified by a URI, a 2.04 (Changed) response
MUST be returned to the client. If a resource has been created on
the origin server, a 2.01 (Created) response MUST be returned.
<span class="h3"><a class="selflink" id="section-10.2" href="#section-10.2">10.2</a>. HTTP-CoAP Proxying</span>
If an HTTP request contains a Request-URI with a "coap" or "coaps"
URI, then the receiving HTTP endpoint (called "the proxy" henceforth)
is requested to perform the operation specified by the request method
on the indicated CoAP resource and return the result to the client.
This section specifies for any HTTP request the HTTP response that
the proxy should return to the client. Unless otherwise specified,
all the statements made are RECOMMENDED behavior; some highly
constrained implementations may need to resort to shortcuts. How the
proxy actually satisfies the request is an implementation detail,
although the typical case is expected to be that the proxy translates
and forwards the request to a CoAP origin server. The meanings of
the individual HTTP methods when performed on CoAP resources are
explained in the subsections of this section.
<span class="grey">Shelby, et al. Standards Track [Page 77]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-78" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
If the proxy is unable or unwilling to service a request with a CoAP
URI, a 501 (Not Implemented) response is returned to the client. If
the proxy services the request by interacting with a third party
(such as the CoAP origin server) and is unable to obtain a result
within a reasonable time frame, a 504 (Gateway Timeout) response is
returned; if a result can be obtained but is not understood, a 502
(Bad Gateway) response is returned.
<span class="h4"><a class="selflink" id="section-10.2.1" href="#section-10.2.1">10.2.1</a>. OPTIONS and TRACE</span>
As the OPTIONS and TRACE methods are not supported in CoAP, a 501
(Not Implemented) error MUST be returned to the client.
<span class="h4"><a class="selflink" id="section-10.2.2" href="#section-10.2.2">10.2.2</a>. GET</span>
The GET method requests the proxy to return a representation of the
CoAP resource identified by the Request-URI.
Upon success, a 200 (OK) response is returned. The payload of the
response MUST be a representation of the target CoAP resource, and
the Content-Type and Content-Encoding header fields MUST be set
accordingly. The response MUST indicate a max-age directive that
indicates a value no greater than the remaining time the
representation can be considered fresh. If the CoAP response has an
ETag option, the proxy should include an ETag header field in the
response.
A client can influence the processing of a GET request by including
the following options:
Accept: The most-preferred media type of the HTTP Accept header
field in a request is mapped to a CoAP Accept option. HTTP Accept
media-type ranges, parameters, and extensions are not supported by
the CoAP Accept option. If the proxy cannot send a response that
is acceptable according to the combined Accept field value, then
the proxy sends a 406 (Not Acceptable) response. The proxy MAY
then retry the request with further media types from the HTTP
Accept header field.
Conditional GETs: Conditional HTTP GET requests that include an "If-
Match" or "If-None-Match" request-header field can be mapped to a
corresponding CoAP request. The "If-Modified-Since" and "If-
Unmodified-Since" request-header fields are not directly supported
by CoAP but are implemented locally by a caching proxy.
<span class="grey">Shelby, et al. Standards Track [Page 78]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-79" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h4"><a class="selflink" id="section-10.2.3" href="#section-10.2.3">10.2.3</a>. HEAD</span>
The HEAD method is identical to GET except that the server MUST NOT
return a message-body in the response.
Although there is no direct equivalent of HTTP's HEAD method in CoAP,
an HTTP-CoAP proxy responds to HEAD requests for CoAP resources, and
the HTTP headers are returned without a message-body.
Implementation Note: An HTTP-CoAP proxy may want to try using a
block-wise transfer option [<a href="#ref-BLOCK" title=""Blockwise transfers in CoAP"">BLOCK</a>] to minimize the amount of data
actually transferred, but it needs to be prepared for the case
that the origin server does not support block-wise transfers.
<span class="h4"><a class="selflink" id="section-10.2.4" href="#section-10.2.4">10.2.4</a>. POST</span>
The POST method requests the proxy to have the representation
enclosed in the request be processed by the CoAP origin server. The
actual function performed by the POST method is determined by the
origin server and dependent on the resource identified by the request
URI.
If the action performed by the POST method does not result in a
resource that can be identified by a URI, a 200 (OK) or 204 (No
Content) response MUST be returned to the client. If a resource has
been created on the origin server, a 201 (Created) response MUST be
returned.
If any of the Location-* Options are present in the CoAP response, a
Location header field constructed from the values of these options is
returned.
<span class="h4"><a class="selflink" id="section-10.2.5" href="#section-10.2.5">10.2.5</a>. PUT</span>
The PUT method requests the proxy to update or create the CoAP
resource identified by the Request-URI with the enclosed
representation.
If a new resource is created at the Request-URI, a 201 (Created)
response is returned to the client. If an existing resource is
modified, either the 200 (OK) or 204 (No Content) Response Codes is
sent to indicate successful completion of the request.
<span class="grey">Shelby, et al. Standards Track [Page 79]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-80" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h4"><a class="selflink" id="section-10.2.6" href="#section-10.2.6">10.2.6</a>. DELETE</span>
The DELETE method requests the proxy to delete the CoAP resource
identified by the Request-URI at the CoAP origin server.
A successful response is 200 (OK) if the response includes an entity
describing the status or 204 (No Content) if the action has been
enacted but the response does not include an entity.
<span class="h4"><a class="selflink" id="section-10.2.7" href="#section-10.2.7">10.2.7</a>. CONNECT</span>
This method cannot currently be satisfied by an HTTP-CoAP proxy
function, as TLS to DTLS tunneling has not yet been specified. For
now, a 501 (Not Implemented) error is returned to the client.
<span class="h2"><a class="selflink" id="section-11" href="#section-11">11</a>. Security Considerations</span>
This section analyzes the possible threats to the protocol. It is
meant to inform protocol and application developers about the
security limitations of CoAP as described in this document. As CoAP
realizes a subset of the features in HTTP/1.1, the security
considerations in <a href="./rfc2616#section-15">Section 15 of [RFC2616]</a> are also pertinent to CoAP.
This section concentrates on describing limitations specific to CoAP.
<span class="h3"><a class="selflink" id="section-11.1" href="#section-11.1">11.1</a>. Parsing the Protocol and Processing URIs</span>
A network-facing application can exhibit vulnerabilities in its
processing logic for incoming packets. Complex parsers are well-
known as a likely source of such vulnerabilities, such as the ability
to remotely crash a node, or even remotely execute arbitrary code on
it. CoAP attempts to narrow the opportunities for introducing such
vulnerabilities by reducing parser complexity, by giving the entire
range of encodable values a meaning where possible, and by
aggressively reducing complexity that is often caused by unnecessary
choice between multiple representations that mean the same thing.
Much of the URI processing has been moved to the clients, further
reducing the opportunities for introducing vulnerabilities into the
servers. Even so, the URI processing code in CoAP implementations is
likely to be a large source of remaining vulnerabilities and should
be implemented with special care. CoAP access control
implementations need to ensure they don't introduce vulnerabilities
through discrepancies between the code deriving access control
decisions from a URI and the code finally serving up the resource
addressed by the URI. The most complex parser remaining could be the
one for the CoRE Link Format, although this also has been designed
with a goal of reduced implementation complexity [<a href="./rfc6690" title=""Constrained RESTful Environments (CoRE) Link Format"">RFC6690</a>]. (See
also <a href="./rfc2616#section-15.2">Section 15.2 of [RFC2616]</a>.)
<span class="grey">Shelby, et al. Standards Track [Page 80]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-81" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h3"><a class="selflink" id="section-11.2" href="#section-11.2">11.2</a>. Proxying and Caching</span>
As mentioned in <a href="./rfc2616#section-15.7">Section 15.7 of [RFC2616]</a>, proxies are by their very
nature men-in-the-middle, breaking any IPsec or DTLS protection that
a direct CoAP message exchange might have. They are therefore
interesting targets for breaking confidentiality or integrity of CoAP
message exchanges. As noted in [<a href="./rfc2616" title=""Hypertext Transfer Protocol -- HTTP/1.1"">RFC2616</a>], they are also interesting
targets for breaking availability.
The threat to confidentiality and integrity of request/response data
is amplified where proxies also cache. Note that CoAP does not
define any of the cache-suppressing Cache-Control options that
HTTP/1.1 provides to better protect sensitive data.
For a caching implementation, any access control considerations that
would apply to making the request that generated the cache entry also
need to be applied to the value in the cache. This is relevant for
clients that implement multiple security domains, as well as for
proxies that may serve multiple clients. Also, a caching proxy MUST
NOT make cached values available to requests that have lesser
transport-security properties than those the proxy would require to
perform request forwarding in the first place.
Unlike the "coap" scheme, responses to "coaps" identified requests
are never "public" and thus MUST NOT be reused for shared caching,
unless the cache is able to make equivalent access control decisions
to the ones that led to the cached entry. They can, however, be
reused in a private cache if the message is cacheable by default in
CoAP.
Finally, a proxy that fans out Separate Responses (as opposed to
piggybacked Responses) to multiple original requesters may provide
additional amplification (see <a href="#section-11.3">Section 11.3</a>).
<span class="h3"><a class="selflink" id="section-11.3" href="#section-11.3">11.3</a>. Risk of Amplification</span>
CoAP servers generally reply to a request packet with a response
packet. This response packet may be significantly larger than the
request packet. An attacker might use CoAP nodes to turn a small
attack packet into a larger attack packet, an approach known as
amplification. There is therefore a danger that CoAP nodes could
become implicated in denial-of-service (DoS) attacks by using the
amplifying properties of the protocol: an attacker that is attempting
to overload a victim but is limited in the amount of traffic it can
generate can use amplification to generate a larger amount of
traffic.
<span class="grey">Shelby, et al. Standards Track [Page 81]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-82" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
This is particularly a problem in nodes that enable NoSec access, are
accessible from an attacker, and can access potential victims (e.g.,
on the general Internet), as the UDP protocol provides no way to
verify the source address given in the request packet. An attacker
need only place the IP address of the victim in the source address of
a suitable request packet to generate a larger packet directed at the
victim.
As a mitigating factor, many constrained networks will only be able
to generate a small amount of traffic, which may make CoAP nodes less
attractive for this attack. However, the limited capacity of the
constrained network makes the network itself a likely victim of an
amplification attack.
Therefore, large amplification factors SHOULD NOT be provided in the
response if the request is not authenticated. A CoAP server can
reduce the amount of amplification it provides to an attacker by
using slicing/blocking modes of CoAP [<a href="#ref-BLOCK" title=""Blockwise transfers in CoAP"">BLOCK</a>] and offering large
resource representations only in relatively small slices. For
example, for a 1000-byte resource, a 10-byte request might result in
an 80-byte response (with a 64-byte block) instead of a 1016-byte
response, considerably reducing the amplification provided.
CoAP also supports the use of multicast IP addresses in requests, an
important requirement for M2M. Multicast CoAP requests may be the
source of accidental or deliberate DoS attacks, especially over
constrained networks. This specification attempts to reduce the
amplification effects of multicast requests by limiting when a
response is returned. To limit the possibility of malicious use,
CoAP servers SHOULD NOT accept multicast requests that can not be
authenticated in some way, cryptographically or by some multicast
boundary limiting the potential sources. If possible, a CoAP server
SHOULD limit the support for multicast requests to the specific
resources where the feature is required.
On some general-purpose operating systems providing a POSIX-style API
[<a href="#ref-IEEE1003.1">IEEE1003.1</a>], it is not straightforward to find out whether a packet
received was addressed to a multicast address. While many
implementations will know whether they have joined a multicast group,
this creates a problem for packets addressed to multicast addresses
of the form FF0x::1, which are received by every IPv6 node.
Implementations SHOULD make use of modern APIs such as
IPV6_RECVPKTINFO [<a href="./rfc3542" title=""Advanced Sockets Application Program Interface (API) for IPv6"">RFC3542</a>], if available, to make this determination.
<span class="grey">Shelby, et al. Standards Track [Page 82]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-83" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h3"><a class="selflink" id="section-11.4" href="#section-11.4">11.4</a>. IP Address Spoofing Attacks</span>
Due to the lack of a handshake in UDP, a rogue endpoint that is free
to read and write messages carried by the constrained network (i.e.,
NoSec or PreSharedKey deployments with a nodes/key ratio > 1:1), may
easily attack a single endpoint, a group of endpoints, as well as the
whole network, e.g., by:
1. spoofing a Reset message in response to a Confirmable message or
Non-confirmable message, thus making an endpoint "deaf"; or
2. spoofing an ACK in response to a CON message, thus potentially
preventing the sender of the CON message from retransmitting, and
drowning out the actual response; or
3. spoofing the entire response with forged payload/options (this
has different levels of impact: from single-response disruption,
to much bolder attacks on the supporting infrastructure, e.g.,
poisoning proxy caches, or tricking validation/lookup interfaces
in resource directories and, more generally, any component that
stores global network state and uses CoAP as the messaging
facility to handle setting or updating state is a potential
target.); or
4. spoofing a multicast request for a target node; this may result
in network congestion/collapse, a DoS attack on the victim, or
forced wake-up from sleeping; or
5. spoofing observe messages, etc.
Response spoofing by off-path attackers can be detected and mitigated
even without transport layer security by choosing a nontrivial,
randomized token in the request (<a href="#section-5.3.1">Section 5.3.1</a>). [<a href="./rfc4086" title=""Randomness Requirements for Security"">RFC4086</a>] discusses
randomness requirements for security.
In principle, other kinds of spoofing can be detected by CoAP only in
case Confirmable message semantics is used, because of unexpected
Acknowledgement or Reset messages coming from the deceived endpoint.
But this imposes keeping track of the used Message IDs, which is not
always possible, and moreover detection becomes available usually
after the damage is already done. This kind of attack can be
prevented using security modes other than NoSec.
With or without source address spoofing, a client can attempt to
overload a server by sending requests, preferably complex ones, to a
server; address spoofing makes tracing back, and blocking, this
attack harder. Given that the cost of a CON request is small, this
attack can easily be executed. Under this attack, a constrained node
<span class="grey">Shelby, et al. Standards Track [Page 83]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-84" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
with limited total energy available may exhaust that energy much more
quickly than planned (battery depletion attack). Also, if the client
uses a Confirmable message and the server responds with a Confirmable
separate response to a (possibly spoofed) address that does not
respond, the server will have to allocate buffer and retransmission
logic for each response up to the exhaustion of MAX_TRANSMIT_SPAN,
making it more likely that it runs out of resources for processing
legitimate traffic. The latter problem can be mitigated somewhat by
limiting the rate of responses as discussed in <a href="#section-4.7">Section 4.7</a>. An
attacker could also spoof the address of a legitimate client; this
might cause the server, if it uses separate responses, to block
legitimate responses to that client because of NSTART=1. All these
attacks can be prevented using a security mode other than NoSec, thus
leaving only attacks on the security protocol.
<span class="h3"><a class="selflink" id="section-11.5" href="#section-11.5">11.5</a>. Cross-Protocol Attacks</span>
The ability to incite a CoAP endpoint to send packets to a fake
source address can be used not only for amplification, but also for
cross-protocol attacks against a victim listening to UDP packets at a
given address (IP address and port). This would occur as follows:
o The attacker sends a message to a CoAP endpoint with the given
address as the fake source address.
o The CoAP endpoint replies with a message to the given source
address.
o The victim at the given address receives a UDP packet that it
interprets according to the rules of a different protocol.
This may be used to circumvent firewall rules that prevent direct
communication from the attacker to the victim but happen to allow
communication from the CoAP endpoint (which may also host a valid
role in the other protocol) to the victim.
Also, CoAP endpoints may be the victim of a cross-protocol attack
generated through an endpoint of another UDP-based protocol such as
DNS. In both cases, attacks are possible if the security properties
of the endpoints rely on checking IP addresses (and firewalling off
direct attacks sent from outside using fake IP addresses). In
general, because of their lack of context, UDP-based protocols are
relatively easy targets for cross-protocol attacks.
Finally, CoAP URIs transported by other means could be used to incite
clients to send messages to endpoints of other protocols.
<span class="grey">Shelby, et al. Standards Track [Page 84]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-85" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
One mitigation against cross-protocol attacks is strict checking of
the syntax of packets received, combined with sufficient difference
in syntax. As an example, it might help if it were difficult to
incite a DNS server to send a DNS response that would pass the checks
of a CoAP endpoint. Unfortunately, the first two bytes of a DNS
reply are an ID that can be chosen by the attacker and that map into
the interesting part of the CoAP header, and the next two bytes are
then interpreted as CoAP's Message ID (i.e., any value is
acceptable). The DNS count words may be interpreted as multiple
instances of a (nonexistent but elective) CoAP option 0, or possibly
as a Token. The echoed query finally may be manufactured by the
attacker to achieve a desired effect on the CoAP endpoint; the
response added by the server (if any) might then just be interpreted
as added payload.
1 1 1 1 1 1
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
| ID | T, TKL, code
+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
|QR| Opcode |AA|TC|RD|RA| Z | RCODE | Message ID
+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
| QDCOUNT | (options 0)
+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
| ANCOUNT | (options 0)
+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
| NSCOUNT | (options 0)
+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
| ARCOUNT | (options 0)
+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
Figure 15: DNS Header (<a href="./rfc1035#section-4.1.1">[RFC1035], Section 4.1.1</a>) vs. CoAP Message
In general, for any pair of protocols, one of the protocols can very
well have been designed in a way that enables an attacker to cause
the generation of replies that look like messages of the other
protocol. It is often much harder to ensure or prove the absence of
viable attacks than to generate examples that may not yet completely
enable an attack but might be further developed by more creative
minds. Cross-protocol attacks can therefore only be completely
mitigated if endpoints don't authorize actions desired by an attacker
just based on trusting the source IP address of a packet.
Conversely, a NoSec environment that completely relies on a firewall
for CoAP security not only needs to firewall off the CoAP endpoints
but also all other endpoints that might be incited to send UDP
messages to CoAP endpoints using some other UDP-based protocol.
<span class="grey">Shelby, et al. Standards Track [Page 85]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-86" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
In addition to the considerations above, the security considerations
for DTLS with respect to cross-protocol attacks apply. For example,
if the same DTLS security association ("connection") is used to carry
data of multiple protocols, DTLS no longer provides protection
against cross-protocol attacks between these protocols.
<span class="h3"><a class="selflink" id="section-11.6" href="#section-11.6">11.6</a>. Constrained-Node Considerations</span>
Implementers on constrained nodes often find themselves without a
good source of entropy [<a href="./rfc4086" title=""Randomness Requirements for Security"">RFC4086</a>]. If that is the case, the node MUST
NOT be used for processes that require good entropy, such as key
generation. Instead, keys should be generated externally and added
to the device during manufacturing or commissioning.
Due to their low processing power, constrained nodes are particularly
susceptible to timing attacks. Special care must be taken in
implementation of cryptographic primitives.
Large numbers of constrained nodes will be installed in exposed
environments and will have little resistance to tampering, including
recovery of keying materials. This needs to be considered when
defining the scope of credentials assigned to them. In particular,
assigning a shared key to a group of nodes may make any single
constrained node a target for subverting the entire group.
<span class="h2"><a class="selflink" id="section-12" href="#section-12">12</a>. IANA Considerations</span>
<span class="h3"><a class="selflink" id="section-12.1" href="#section-12.1">12.1</a>. CoAP Code Registries</span>
This document defines two sub-registries for the values of the Code
field in the CoAP header within the "Constrained RESTful Environments
(CoRE) Parameters" registry, hereafter referred to as the "CoRE
Parameters" registry.
Values in the two sub-registries are eight-bit values notated as
three decimal digits c.dd separated by a period between the first and
the second digit; the first digit c is between 0 and 7 and denotes
the code class; the second and third digits dd denote a decimal
number between 00 and 31 for the detail.
<span class="grey">Shelby, et al. Standards Track [Page 86]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-87" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
All Code values are assigned by sub-registries according to the
following ranges:
0.00 Indicates an Empty message (see <a href="#section-4.1">Section 4.1</a>).
0.01-0.31 Indicates a request. Values in this range are assigned by
the "CoAP Method Codes" sub-registry (see <a href="#section-12.1.1">Section 12.1.1</a>).
1.00-1.31 Reserved
2.00-5.31 Indicates a response. Values in this range are assigned by
the "CoAP Response Codes" sub-registry (see
<a href="#section-12.1.2">Section 12.1.2</a>).
6.00-7.31 Reserved
<span class="h4"><a class="selflink" id="section-12.1.1" href="#section-12.1.1">12.1.1</a>. Method Codes</span>
The name of the sub-registry is "CoAP Method Codes".
Each entry in the sub-registry must include the Method Code in the
range 0.01-0.31, the name of the method, and a reference to the
method's documentation.
Initial entries in this sub-registry are as follows:
+------+--------+-----------+
| Code | Name | Reference |
+------+--------+-----------+
| 0.01 | GET | [<a href="./rfc7252">RFC7252</a>] |
| 0.02 | POST | [<a href="./rfc7252">RFC7252</a>] |
| 0.03 | PUT | [<a href="./rfc7252">RFC7252</a>] |
| 0.04 | DELETE | [<a href="./rfc7252">RFC7252</a>] |
+------+--------+-----------+
Table 5: CoAP Method Codes
All other Method Codes are Unassigned.
The IANA policy for future additions to this sub-registry is "IETF
Review or IESG Approval" as described in [<a href="./rfc5226" title="">RFC5226</a>].
The documentation of a Method Code should specify the semantics of a
request with that code, including the following properties:
o The Response Codes the method returns in the success case.
o Whether the method is idempotent, safe, or both.
<span class="grey">Shelby, et al. Standards Track [Page 87]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-88" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h4"><a class="selflink" id="section-12.1.2" href="#section-12.1.2">12.1.2</a>. Response Codes</span>
The name of the sub-registry is "CoAP Response Codes".
Each entry in the sub-registry must include the Response Code in the
range 2.00-5.31, a description of the Response Code, and a reference
to the Response Code's documentation.
Initial entries in this sub-registry are as follows:
+------+------------------------------+-----------+
| Code | Description | Reference |
+------+------------------------------+-----------+
| 2.01 | Created | [<a href="./rfc7252">RFC7252</a>] |
| 2.02 | Deleted | [<a href="./rfc7252">RFC7252</a>] |
| 2.03 | Valid | [<a href="./rfc7252">RFC7252</a>] |
| 2.04 | Changed | [<a href="./rfc7252">RFC7252</a>] |
| 2.05 | Content | [<a href="./rfc7252">RFC7252</a>] |
| 4.00 | Bad Request | [<a href="./rfc7252">RFC7252</a>] |
| 4.01 | Unauthorized | [<a href="./rfc7252">RFC7252</a>] |
| 4.02 | Bad Option | [<a href="./rfc7252">RFC7252</a>] |
| 4.03 | Forbidden | [<a href="./rfc7252">RFC7252</a>] |
| 4.04 | Not Found | [<a href="./rfc7252">RFC7252</a>] |
| 4.05 | Method Not Allowed | [<a href="./rfc7252">RFC7252</a>] |
| 4.06 | Not Acceptable | [<a href="./rfc7252">RFC7252</a>] |
| 4.12 | Precondition Failed | [<a href="./rfc7252">RFC7252</a>] |
| 4.13 | Request Entity Too Large | [<a href="./rfc7252">RFC7252</a>] |
| 4.15 | Unsupported Content-Format | [<a href="./rfc7252">RFC7252</a>] |
| 5.00 | Internal Server Error | [<a href="./rfc7252">RFC7252</a>] |
| 5.01 | Not Implemented | [<a href="./rfc7252">RFC7252</a>] |
| 5.02 | Bad Gateway | [<a href="./rfc7252">RFC7252</a>] |
| 5.03 | Service Unavailable | [<a href="./rfc7252">RFC7252</a>] |
| 5.04 | Gateway Timeout | [<a href="./rfc7252">RFC7252</a>] |
| 5.05 | Proxying Not Supported | [<a href="./rfc7252">RFC7252</a>] |
+------+------------------------------+-----------+
Table 6: CoAP Response Codes
The Response Codes 3.00-3.31 are Reserved for future use. All other
Response Codes are Unassigned.
The IANA policy for future additions to this sub-registry is "IETF
Review or IESG Approval" as described in [<a href="./rfc5226" title="">RFC5226</a>].
<span class="grey">Shelby, et al. Standards Track [Page 88]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-89" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
The documentation of a Response Code should specify the semantics of
a response with that code, including the following properties:
o The methods the Response Code applies to.
o Whether payload is required, optional, or not allowed.
o The semantics of the payload. For example, the payload of a 2.05
(Content) response is a representation of the target resource; the
payload in an error response is a human-readable diagnostic
payload.
o The format of the payload. For example, the format in a 2.05
(Content) response is indicated by the Content-Format Option; the
format of the payload in an error response is always Net-Unicode
text.
o Whether the response is cacheable according to the freshness
model.
o Whether the response is validatable according to the validation
model.
o Whether the response causes a cache to mark responses stored for
the request URI as not fresh.
<span class="h3"><a class="selflink" id="section-12.2" href="#section-12.2">12.2</a>. CoAP Option Numbers Registry</span>
This document defines a sub-registry for the Option Numbers used in
CoAP options within the "CoRE Parameters" registry. The name of the
sub-registry is "CoAP Option Numbers".
Each entry in the sub-registry must include the Option Number, the
name of the option, and a reference to the option's documentation.
<span class="grey">Shelby, et al. Standards Track [Page 89]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-90" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
Initial entries in this sub-registry are as follows:
+--------+------------------+-----------+
| Number | Name | Reference |
+--------+------------------+-----------+
| 0 | (Reserved) | [<a href="./rfc7252">RFC7252</a>] |
| 1 | If-Match | [<a href="./rfc7252">RFC7252</a>] |
| 3 | Uri-Host | [<a href="./rfc7252">RFC7252</a>] |
| 4 | ETag | [<a href="./rfc7252">RFC7252</a>] |
| 5 | If-None-Match | [<a href="./rfc7252">RFC7252</a>] |
| 7 | Uri-Port | [<a href="./rfc7252">RFC7252</a>] |
| 8 | Location-Path | [<a href="./rfc7252">RFC7252</a>] |
| 11 | Uri-Path | [<a href="./rfc7252">RFC7252</a>] |
| 12 | Content-Format | [<a href="./rfc7252">RFC7252</a>] |
| 14 | Max-Age | [<a href="./rfc7252">RFC7252</a>] |
| 15 | Uri-Query | [<a href="./rfc7252">RFC7252</a>] |
| 17 | Accept | [<a href="./rfc7252">RFC7252</a>] |
| 20 | Location-Query | [<a href="./rfc7252">RFC7252</a>] |
| 35 | Proxy-Uri | [<a href="./rfc7252">RFC7252</a>] |
| 39 | Proxy-Scheme | [<a href="./rfc7252">RFC7252</a>] |
| 60 | Size1 | [<a href="./rfc7252">RFC7252</a>] |
| 128 | (Reserved) | [<a href="./rfc7252">RFC7252</a>] |
| 132 | (Reserved) | [<a href="./rfc7252">RFC7252</a>] |
| 136 | (Reserved) | [<a href="./rfc7252">RFC7252</a>] |
| 140 | (Reserved) | [<a href="./rfc7252">RFC7252</a>] |
+--------+------------------+-----------+
Table 7: CoAP Option Numbers
The IANA policy for future additions to this sub-registry is split
into three tiers as follows. The range of 0..255 is reserved for
options defined by the IETF (IETF Review or IESG Approval). The
range of 256..2047 is reserved for commonly used options with public
specifications (Specification Required). The range of 2048..64999 is
for all other options including private or vendor-specific ones,
which undergo a Designated Expert review to help ensure that the
option semantics are defined correctly. The option numbers between
65000 and 65535 inclusive are reserved for experiments. They are not
meant for vendor-specific use of any kind and MUST NOT be used in
operational deployments.
<span class="grey">Shelby, et al. Standards Track [Page 90]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-91" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
+-------------+---------------------------------------+
| Range | Registration Procedures |
+-------------+---------------------------------------+
| 0-255 | IETF Review or IESG Approval |
| 256-2047 | Specification Required |
| 2048-64999 | Expert Review |
| 65000-65535 | Experimental use (no operational use) |
+-------------+---------------------------------------+
Table 8: CoAP Option Numbers: Registration Procedures
The documentation of an Option Number should specify the semantics of
an option with that number, including the following properties:
o The meaning of the option in a request.
o The meaning of the option in a response.
o Whether the option is critical or elective, as determined by the
Option Number.
o Whether the option is Safe-to-Forward, and, if yes, whether it is
part of the Cache-Key, as determined by the Option Number (see
<a href="#section-5.4.2">Section 5.4.2</a>).
o The format and length of the option's value.
o Whether the option must occur at most once or whether it can occur
multiple times.
o The default value, if any. For a critical option with a default
value, a discussion on how the default value enables processing by
implementations that do not support the critical option
(<a href="#section-5.4.4">Section 5.4.4</a>).
<span class="h3"><a class="selflink" id="section-12.3" href="#section-12.3">12.3</a>. CoAP Content-Formats Registry</span>
Internet media types are identified by a string, such as
"application/xml" [<a href="./rfc2046" title=""Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types"">RFC2046</a>]. In order to minimize the overhead of
using these media types to indicate the format of payloads, this
document defines a sub-registry for a subset of Internet media types
to be used in CoAP and assigns each, in combination with a content-
coding, a numeric identifier. The name of the sub-registry is "CoAP
Content-Formats", within the "CoRE Parameters" registry.
<span class="grey">Shelby, et al. Standards Track [Page 91]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-92" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
Each entry in the sub-registry must include the media type registered
with IANA, the numeric identifier in the range 0-65535 to be used for
that media type in CoAP, the content-coding associated with this
identifier, and a reference to a document describing what a payload
with that media type means semantically.
CoAP does not include a separate way to convey content-encoding
information with a request or response, and for that reason the
content-encoding is also specified for each identifier (if any). If
multiple content-encodings will be used with a media type, then a
separate Content-Format identifier for each is to be registered.
Similarly, other parameters related to an Internet media type, such
as level, can be defined for a CoAP Content-Format entry.
Initial entries in this sub-registry are as follows:
+--------------------------+----------+----+------------------------+
| Media type | Encoding | ID | Reference |
+--------------------------+----------+----+------------------------+
| text/plain; | - | 0 | [<a href="./rfc2046" title=""Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types"">RFC2046</a>] [<a href="./rfc3676" title=""The Text/Plain Format and DelSp Parameters"">RFC3676</a>] |
| charset=utf-8 | | | [<a href="./rfc5147" title=""URI Fragment Identifiers for the text/plain Media Type"">RFC5147</a>] |
| application/link-format | - | 40 | [<a href="./rfc6690" title=""Constrained RESTful Environments (CoRE) Link Format"">RFC6690</a>] |
| application/xml | - | 41 | [<a href="./rfc3023" title=""XML Media Types"">RFC3023</a>] |
| application/octet-stream | - | 42 | [<a href="./rfc2045" title=""Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies"">RFC2045</a>] [<a href="./rfc2046" title=""Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types"">RFC2046</a>] |
| application/exi | - | 47 | [<a href="#ref-REC-exi-20140211">REC-exi-20140211</a>] |
| application/json | - | 50 | [<a href="./rfc7159" title=""The JavaScript Object Notation (JSON) Data Interchange Format"">RFC7159</a>] |
+--------------------------+----------+----+------------------------+
Table 9: CoAP Content-Formats
The identifiers between 65000 and 65535 inclusive are reserved for
experiments. They are not meant for vendor-specific use of any kind
and MUST NOT be used in operational deployments. The identifiers
between 256 and 9999 are reserved for future use in IETF
specifications (IETF Review or IESG Approval). All other identifiers
are Unassigned.
Because the namespace of single-byte identifiers is so small, the
IANA policy for future additions in the range 0-255 inclusive to the
sub-registry is "Expert Review" as described in [<a href="./rfc5226" title="">RFC5226</a>]. The IANA
policy for additions in the range 10000-64999 inclusive is "First
Come First Served" as described in [<a href="./rfc5226" title="">RFC5226</a>]. This is summarized in
the following table.
<span class="grey">Shelby, et al. Standards Track [Page 92]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-93" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
+-------------+---------------------------------------+
| Range | Registration Procedures |
+-------------+---------------------------------------+
| 0-255 | Expert Review |
| 256-9999 | IETF Review or IESG Approval |
| 10000-64999 | First Come First Served |
| 65000-65535 | Experimental use (no operational use) |
+-------------+---------------------------------------+
Table 10: CoAP Content-Formats: Registration Procedures
In machine-to-machine applications, it is not expected that generic
Internet media types such as text/plain, application/xml or
application/octet-stream are useful for real applications in the long
term. It is recommended that M2M applications making use of CoAP
request new Internet media types from IANA indicating semantic
information about how to create or parse a payload. For example, a
Smart Energy application payload carried as XML might request a more
specific type like application/se+xml or application/se-exi.
<span class="h3"><a class="selflink" id="section-12.4" href="#section-12.4">12.4</a>. URI Scheme Registration</span>
This document contains the request for the registration of the
Uniform Resource Identifier (URI) scheme "coap". The registration
request complies with [<a href="./rfc4395" title=""Guidelines and Registration Procedures for New URI Schemes"">RFC4395</a>].
URI scheme name.
coap
Status.
Permanent.
URI scheme syntax.
Defined in <a href="./rfc7252#section-6.1">Section 6.1 of [RFC7252]</a>.
URI scheme semantics.
The "coap" URI scheme provides a way to identify resources that
are potentially accessible over the Constrained Application
Protocol (CoAP). The resources can be located by contacting the
governing CoAP server and operated on by sending CoAP requests to
the server. This scheme can thus be compared to the "http" URI
scheme [<a href="./rfc2616" title=""Hypertext Transfer Protocol -- HTTP/1.1"">RFC2616</a>]. See <a href="./rfc7252#section-6">Section 6 of [RFC7252]</a> for the details of
operation.
Encoding considerations.
The scheme encoding conforms to the encoding rules established for
URIs in [<a href="./rfc3986" title=""Uniform Resource Identifier (URI): Generic Syntax"">RFC3986</a>], i.e., internationalized and reserved characters
are expressed using UTF-8-based percent-encoding.
<span class="grey">Shelby, et al. Standards Track [Page 93]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-94" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
Applications/protocols that use this URI scheme name.
The scheme is used by CoAP endpoints to access CoAP resources.
Interoperability considerations.
None.
Security considerations.
See <a href="./rfc7252#section-11.1">Section 11.1 of [RFC7252]</a>.
Contact.
IETF Chair <chair@ietf.org>
Author/Change controller.
IESG <iesg@ietf.org>
References.
[<a href="./rfc7252">RFC7252</a>]
<span class="h3"><a class="selflink" id="section-12.5" href="#section-12.5">12.5</a>. Secure URI Scheme Registration</span>
This document contains the request for the registration of the
Uniform Resource Identifier (URI) scheme "coaps". The registration
request complies with [<a href="./rfc4395" title=""Guidelines and Registration Procedures for New URI Schemes"">RFC4395</a>].
URI scheme name.
coaps
Status.
Permanent.
URI scheme syntax.
Defined in <a href="./rfc7252#section-6.2">Section 6.2 of [RFC7252]</a>.
URI scheme semantics.
The "coaps" URI scheme provides a way to identify resources that
are potentially accessible over the Constrained Application
Protocol (CoAP) using Datagram Transport Layer Security (DTLS) for
transport security. The resources can be located by contacting
the governing CoAP server and operated on by sending CoAP requests
to the server. This scheme can thus be compared to the "https"
URI scheme [<a href="./rfc2616" title=""Hypertext Transfer Protocol -- HTTP/1.1"">RFC2616</a>]. See <a href="./rfc7252#section-6">Section 6 of [RFC7252]</a> for the details
of operation.
Encoding considerations.
The scheme encoding conforms to the encoding rules established for
URIs in [<a href="./rfc3986" title=""Uniform Resource Identifier (URI): Generic Syntax"">RFC3986</a>], i.e., internationalized and reserved characters
are expressed using UTF-8-based percent-encoding.
<span class="grey">Shelby, et al. Standards Track [Page 94]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-95" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
Applications/protocols that use this URI scheme name.
The scheme is used by CoAP endpoints to access CoAP resources
using DTLS.
Interoperability considerations.
None.
Security considerations.
See <a href="./rfc7252#section-11.1">Section 11.1 of [RFC7252]</a>.
Contact.
IETF Chair <chair@ietf.org>
Author/Change controller.
IESG <iesg@ietf.org>
References.
[<a href="./rfc7252">RFC7252</a>]
<span class="h3"><a class="selflink" id="section-12.6" href="#section-12.6">12.6</a>. Service Name and Port Number Registration</span>
One of the functions of CoAP is resource discovery: a CoAP client can
ask a CoAP server about the resources offered by it (see <a href="#section-7">Section 7</a>).
To enable resource discovery just based on the knowledge of an IP
address, the CoAP port for resource discovery needs to be
standardized.
IANA has assigned the port number 5683 and the service name "coap",
in accordance with [<a href="./rfc6335" title=""Internet Assigned Numbers Authority (IANA) Procedures for the Management of the Service Name and Transport Protocol Port Number Registry"">RFC6335</a>].
Besides unicast, CoAP can be used with both multicast and anycast.
Service Name.
coap
Transport Protocol.
udp
Assignee.
IESG <iesg@ietf.org>
Contact.
IETF Chair <chair@ietf.org>
Description.
Constrained Application Protocol (CoAP)
<span class="grey">Shelby, et al. Standards Track [Page 95]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-96" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
Reference.
[<a href="./rfc7252">RFC7252</a>]
Port Number.
5683
<span class="h3"><a class="selflink" id="section-12.7" href="#section-12.7">12.7</a>. Secure Service Name and Port Number Registration</span>
CoAP resource discovery may also be provided using the DTLS-secured
CoAP "coaps" scheme. Thus, the CoAP port for secure resource
discovery needs to be standardized.
IANA has assigned the port number 5684 and the service name "coaps",
in accordance with [<a href="./rfc6335" title=""Internet Assigned Numbers Authority (IANA) Procedures for the Management of the Service Name and Transport Protocol Port Number Registry"">RFC6335</a>].
Besides unicast, DTLS-secured CoAP can be used with anycast.
Service Name.
coaps
Transport Protocol.
udp
Assignee.
IESG <iesg@ietf.org>
Contact.
IETF Chair <chair@ietf.org>
Description.
DTLS-secured CoAP
Reference.
[<a href="./rfc7252">RFC7252</a>]
Port Number.
5684
<span class="grey">Shelby, et al. Standards Track [Page 96]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-97" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h3"><a class="selflink" id="section-12.8" href="#section-12.8">12.8</a>. Multicast Address Registration</span>
<a href="#section-8">Section 8</a>, "Multicast CoAP", defines the use of multicast. IANA has
assigned the following multicast addresses for use by CoAP nodes:
IPv4 -- "All CoAP Nodes" address 224.0.1.187, from the "IPv4
Multicast Address Space Registry". As the address is used for
discovery that may span beyond a single network, it has come from
the Internetwork Control Block (224.0.1.x, <a href="./rfc5771">RFC 5771</a>).
IPv6 -- "All CoAP Nodes" address FF0X::FD, from the "IPv6 Multicast
Address Space Registry", in the "Variable Scope Multicast
Addresses" space (<a href="./rfc3307">RFC 3307</a>). Note that there is a distinct
multicast address for each scope that interested CoAP nodes should
listen to; CoAP needs the Link-Local and Site-Local scopes only.
<span class="h2"><a class="selflink" id="section-13" href="#section-13">13</a>. Acknowledgements</span>
Brian Frank was a contributor to and coauthor of early versions of
this specification.
Special thanks to Peter Bigot, Esko Dijk, and Cullen Jennings for
substantial contributions to the ideas and text in the document,
along with countless detailed reviews and discussions.
Thanks to Floris Van den Abeele, Anthony Baire, Ed Beroset, Berta
Carballido, Angelo P. Castellani, Gilbert Clark, Robert Cragie,
Pierre David, Esko Dijk, Lisa Dusseault, Mehmet Ersue, Thomas
Fossati, Tobias Gondrom, Bert Greevenbosch, Tom Herbst, Jeroen
Hoebeke, Richard Kelsey, Sye Loong Keoh, Ari Keranen, Matthias
Kovatsch, Avi Lior, Stephan Lohse, Salvatore Loreto, Kerry Lynn,
Andrew McGregor, Alexey Melnikov, Guido Moritz, Petri Mutka, Colin
O'Flynn, Charles Palmer, Adriano Pezzuto, Thomas Poetsch, Robert
Quattlebaum, Akbar Rahman, Eric Rescorla, Dan Romascanu, David Ryan,
Peter Saint-Andre, Szymon Sasin, Michael Scharf, Dale Seed, Robby
Simpson, Peter van der Stok, Michael Stuber, Linyi Tian, Gilman
Tolle, Matthieu Vial, Maciej Wasilak, Fan Xianyou, and Alper Yegin
for helpful comments and discussions that have shaped the document.
Special thanks also to the responsible IETF area director at the time
of completion, Barry Leiba, and the IESG reviewers, Adrian Farrel,
Martin Stiemerling, Pete Resnick, Richard Barnes, Sean Turner,
Spencer Dawkins, Stephen Farrell, and Ted Lemon, who contributed in-
depth reviews.
Some of the text has been borrowed from the working documents of the
IETF HTTPBIS working group.
<span class="grey">Shelby, et al. Standards Track [Page 97]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-98" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h2"><a class="selflink" id="section-14" href="#section-14">14</a>. References</span>
<span class="h3"><a class="selflink" id="section-14.1" href="#section-14.1">14.1</a>. Normative References</span>
[<a id="ref-RFC0768">RFC0768</a>] Postel, J., "User Datagram Protocol", STD 6, <a href="./rfc768">RFC 768</a>,
August 1980.
[<a id="ref-RFC2045">RFC2045</a>] Freed, N. and N. Borenstein, "Multipurpose Internet Mail
Extensions (MIME) Part One: Format of Internet Message
Bodies", <a href="./rfc2045">RFC 2045</a>, November 1996.
[<a id="ref-RFC2046">RFC2046</a>] Freed, N. and N. Borenstein, "Multipurpose Internet Mail
Extensions (MIME) Part Two: Media Types", <a href="./rfc2046">RFC 2046</a>,
November 1996.
[<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>, March 1997.
[<a id="ref-RFC2616">RFC2616</a>] Fielding, R., Gettys, J., Mogul, J., Frystyk, H.,
Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext
Transfer Protocol -- HTTP/1.1", <a href="./rfc2616">RFC 2616</a>, June 1999.
[<a id="ref-RFC3023">RFC3023</a>] Murata, M., St. Laurent, S., and D. Kohn, "XML Media
Types", <a href="./rfc3023">RFC 3023</a>, January 2001.
[<a id="ref-RFC3629">RFC3629</a>] Yergeau, F., "UTF-8, a transformation format of ISO
10646", STD 63, <a href="./rfc3629">RFC 3629</a>, November 2003.
[<a id="ref-RFC3676">RFC3676</a>] Gellens, R., "The Text/Plain Format and DelSp Parameters",
<a href="./rfc3676">RFC 3676</a>, February 2004.
[<a id="ref-RFC3986">RFC3986</a>] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
Resource Identifier (URI): Generic Syntax", STD 66, <a href="./rfc3986">RFC</a>
<a href="./rfc3986">3986</a>, January 2005.
[<a id="ref-RFC4279">RFC4279</a>] Eronen, P. and H. Tschofenig, "Pre-Shared Key Ciphersuites
for Transport Layer Security (TLS)", <a href="./rfc4279">RFC 4279</a>, December
2005.
[<a id="ref-RFC4395">RFC4395</a>] Hansen, T., Hardie, T., and L. Masinter, "Guidelines and
Registration Procedures for New URI Schemes", <a href="https://www.rfc-editor.org/bcp/bcp35">BCP 35</a>, <a href="./rfc4395">RFC</a>
<a href="./rfc4395">4395</a>, February 2006.
[<a id="ref-RFC5147">RFC5147</a>] Wilde, E. and M. Duerst, "URI Fragment Identifiers for the
text/plain Media Type", <a href="./rfc5147">RFC 5147</a>, April 2008.
[<a id="ref-RFC5198">RFC5198</a>] Klensin, J. and M. Padlipsky, "Unicode Format for Network
Interchange", <a href="./rfc5198">RFC 5198</a>, March 2008.
<span class="grey">Shelby, et al. Standards Track [Page 98]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-99" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
[<a id="ref-RFC5226">RFC5226</a>] Narten, T. and H. Alvestrand, "Guidelines for Writing an
IANA Considerations Section in RFCs", <a href="https://www.rfc-editor.org/bcp/bcp26">BCP 26</a>, <a href="./rfc5226">RFC 5226</a>,
May 2008.
[<a id="ref-RFC5234">RFC5234</a>] Crocker, D. and P. Overell, "Augmented BNF for Syntax
Specifications: ABNF", STD 68, <a href="./rfc5234">RFC 5234</a>, January 2008.
[<a id="ref-RFC5246">RFC5246</a>] Dierks, T. and E. Rescorla, "The Transport Layer Security
(TLS) Protocol Version 1.2", <a href="./rfc5246">RFC 5246</a>, August 2008.
[<a id="ref-RFC5280">RFC5280</a>] Cooper, D., Santesson, S., Farrell, S., Boeyen, S.,
Housley, R., and W. Polk, "Internet X.509 Public Key
Infrastructure Certificate and Certificate Revocation List
(CRL) Profile", <a href="./rfc5280">RFC 5280</a>, May 2008.
[<a id="ref-RFC5480">RFC5480</a>] Turner, S., Brown, D., Yiu, K., Housley, R., and T. Polk,
"Elliptic Curve Cryptography Subject Public Key
Information", <a href="./rfc5480">RFC 5480</a>, March 2009.
[<a id="ref-RFC5785">RFC5785</a>] Nottingham, M. and E. Hammer-Lahav, "Defining Well-Known
Uniform Resource Identifiers (URIs)", <a href="./rfc5785">RFC 5785</a>, April
2010.
[<a id="ref-RFC5952">RFC5952</a>] Kawamura, S. and M. Kawashima, "A Recommendation for IPv6
Address Text Representation", <a href="./rfc5952">RFC 5952</a>, August 2010.
[<a id="ref-RFC5988">RFC5988</a>] Nottingham, M., "Web Linking", <a href="./rfc5988">RFC 5988</a>, October 2010.
[<a id="ref-RFC6066">RFC6066</a>] Eastlake, D., "Transport Layer Security (TLS) Extensions:
Extension Definitions", <a href="./rfc6066">RFC 6066</a>, January 2011.
[<a id="ref-RFC6347">RFC6347</a>] Rescorla, E. and N. Modadugu, "Datagram Transport Layer
Security Version 1.2", <a href="./rfc6347">RFC 6347</a>, January 2012.
[<a id="ref-RFC6690">RFC6690</a>] Shelby, Z., "Constrained RESTful Environments (CoRE) Link
Format", <a href="./rfc6690">RFC 6690</a>, August 2012.
[<a id="ref-RFC6920">RFC6920</a>] Farrell, S., Kutscher, D., Dannewitz, C., Ohlman, B.,
Keranen, A., and P. Hallam-Baker, "Naming Things with
Hashes", <a href="./rfc6920">RFC 6920</a>, April 2013.
[<a id="ref-RFC7250">RFC7250</a>] Wouters, P., Tschofenig, H., Gilmore, J., Weiler, S., and
T. Kivinen, "Using Raw Public Keys in Transport Layer
Security (TLS) and Datagram Transport Layer Security
(DTLS)", <a href="./rfc7250">RFC 7250</a>, June 2014.
<span class="grey">Shelby, et al. Standards Track [Page 99]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-100" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
[<a id="ref-RFC7251">RFC7251</a>] McGrew, D., Bailey, D., Campagna, M., and R. Dugal, "AES-
CCM Elliptic Curve Cryptography (ECC) Cipher Suites for
Transport Layer Security (TLS)", <a href="./rfc7251">RFC 7251</a>, June 2014.
<span class="h3"><a class="selflink" id="section-14.2" href="#section-14.2">14.2</a>. Informative References</span>
[<a id="ref-BLOCK">BLOCK</a>] Bormann, C. and Z. Shelby, <a style="text-decoration: none" href='https://www.google.com/search?sitesearch=datatracker.ietf.org%2Fdoc%2Fhtml%2F&q=inurl:draft-+%22Blockwise+transfers+in+CoAP%22'>"Blockwise transfers in CoAP"</a>,
Work in Progress, October 2013.
[<a id="ref-CoAP-MISC">CoAP-MISC</a>]
Bormann, C. and K. Hartke, "Miscellaneous additions to
CoAP", Work in Progress, December 2013.
[<a id="ref-EUI64">EUI64</a>] IEEE Standards Association, "Guidelines for 64-bit Global
Identifier (EUI-64 (TM))", Registration Authority
Tutorials, April 2010, <<a href="http://standards.ieee.org/regauth/oui/tutorials/EUI64.html">http://standards.ieee.org/regauth/</a>
<a href="http://standards.ieee.org/regauth/oui/tutorials/EUI64.html">oui/tutorials/EUI64.html</a>>.
[<a id="ref-GROUPCOMM">GROUPCOMM</a>]
Rahman, A. and E. Dijk, <a style="text-decoration: none" href='https://www.google.com/search?sitesearch=datatracker.ietf.org%2Fdoc%2Fhtml%2F&q=inurl:draft-+%22Group+Communication+for+CoAP%22'>"Group Communication for CoAP"</a>,
Work in Progress, December 2013.
[<a id="ref-HHGTTG">HHGTTG</a>] Adams, D., "The Hitchhiker's Guide to the Galaxy", Pan
Books ISBN 3320258648, 1979.
[<a id="ref-IEEE1003.1">IEEE1003.1</a>]
IEEE and The Open Group, "Portable Operating System
Interface (POSIX)", The Open Group Base Specifications
Issue 7, IEEE 1003.1, 2013 Edition,
<<a href="http://pubs.opengroup.org/onlinepubs/9699919799/">http://pubs.opengroup.org/onlinepubs/9699919799/</a>>.
[<a id="ref-IPsec-CoAP">IPsec-CoAP</a>]
Bormann, C., <a style="text-decoration: none" href='https://www.google.com/search?sitesearch=datatracker.ietf.org%2Fdoc%2Fhtml%2F&q=inurl:draft-+%22Using+CoAP+with+IPsec%22'>"Using CoAP with IPsec"</a>, Work in Progress,
December 2012.
[<a id="ref-MAPPING">MAPPING</a>] Castellani, A., Loreto, S., Rahman, A., Fossati, T., and
E. Dijk, "Guidelines for HTTP-CoAP Mapping
Implementations", Work in Progress, February 2014.
[<a id="ref-OBSERVE">OBSERVE</a>] Hartke, K., <a style="text-decoration: none" href='https://www.google.com/search?sitesearch=datatracker.ietf.org%2Fdoc%2Fhtml%2F&q=inurl:draft-+%22Observing+Resources+in+CoAP%22'>"Observing Resources in CoAP"</a>, Work in
Progress, April 2014.
[<a id="ref-REC-exi-20140211">REC-exi-20140211</a>]
Schneider, J., Kamiya, T., Peintner, D., and R. Kyusakov,
"Efficient XML Interchange (EXI) Format 1.0 (Second
Edition)", W3C Recommendation REC-exi-20140211, February
2014, <<a href="http://www.w3.org/TR/2014/REC-exi-20140211/">http://www.w3.org/TR/2014/REC-exi-20140211/</a>>.
<span class="grey">Shelby, et al. Standards Track [Page 100]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-101" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
[<a id="ref-REST">REST</a>] Fielding, R., "Architectural Styles and the Design of
Network-based Software Architectures", Ph.D. Dissertation,
University of California, Irvine, 2000,
<<a href="http://www.ics.uci.edu/~fielding/pubs/dissertation/fielding_dissertation.pdf">http://www.ics.uci.edu/~fielding/pubs/dissertation/</a>
<a href="http://www.ics.uci.edu/~fielding/pubs/dissertation/fielding_dissertation.pdf">fielding_dissertation.pdf</a>>.
[<a id="ref-RFC0020">RFC0020</a>] Cerf, V., "ASCII format for network interchange", <a href="./rfc20">RFC 20</a>,
October 1969.
[<a id="ref-RFC0791">RFC0791</a>] Postel, J., "Internet Protocol", STD 5, <a href="./rfc791">RFC 791</a>, September
1981.
[<a id="ref-RFC0792">RFC0792</a>] Postel, J., "Internet Control Message Protocol", STD 5,
<a href="./rfc792">RFC 792</a>, September 1981.
[<a id="ref-RFC0793">RFC0793</a>] Postel, J., "Transmission Control Protocol", STD 7, <a href="./rfc793">RFC</a>
<a href="./rfc793">793</a>, September 1981.
[<a id="ref-RFC1035">RFC1035</a>] Mockapetris, P., "Domain names - implementation and
specification", STD 13, <a href="./rfc1035">RFC 1035</a>, November 1987.
[<a id="ref-RFC3264">RFC3264</a>] Rosenberg, J. and H. Schulzrinne, "An Offer/Answer Model
with Session Description Protocol (SDP)", <a href="./rfc3264">RFC 3264</a>, June
2002.
[<a id="ref-RFC3280">RFC3280</a>] Housley, R., Polk, W., Ford, W., and D. Solo, "Internet
X.509 Public Key Infrastructure Certificate and
Certificate Revocation List (CRL) Profile", <a href="./rfc3280">RFC 3280</a>,
April 2002.
[<a id="ref-RFC3542">RFC3542</a>] Stevens, W., Thomas, M., Nordmark, E., and T. Jinmei,
"Advanced Sockets Application Program Interface (API) for
IPv6", <a href="./rfc3542">RFC 3542</a>, May 2003.
[<a id="ref-RFC3828">RFC3828</a>] Larzon, L-A., Degermark, M., Pink, S., Jonsson, L-E., and
G. Fairhurst, "The Lightweight User Datagram Protocol
(UDP-Lite)", <a href="./rfc3828">RFC 3828</a>, July 2004.
[<a id="ref-RFC4086">RFC4086</a>] Eastlake, D., Schiller, J., and S. Crocker, "Randomness
Requirements for Security", <a href="https://www.rfc-editor.org/bcp/bcp106">BCP 106</a>, <a href="./rfc4086">RFC 4086</a>, June 2005.
[<a id="ref-RFC4443">RFC4443</a>] Conta, A., Deering, S., and M. Gupta, "Internet Control
Message Protocol (ICMPv6) for the Internet Protocol
Version 6 (IPv6) Specification", <a href="./rfc4443">RFC 4443</a>, March 2006.
[<a id="ref-RFC4492">RFC4492</a>] Blake-Wilson, S., Bolyard, N., Gupta, V., Hawk, C., and B.
Moeller, "Elliptic Curve Cryptography (ECC) Cipher Suites
for Transport Layer Security (TLS)", <a href="./rfc4492">RFC 4492</a>, May 2006.
<span class="grey">Shelby, et al. Standards Track [Page 101]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-102" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
[<a id="ref-RFC4821">RFC4821</a>] Mathis, M. and J. Heffner, "Packetization Layer Path MTU
Discovery", <a href="./rfc4821">RFC 4821</a>, March 2007.
[<a id="ref-RFC4944">RFC4944</a>] Montenegro, G., Kushalnagar, N., Hui, J., and D. Culler,
"Transmission of IPv6 Packets over IEEE 802.15.4
Networks", <a href="./rfc4944">RFC 4944</a>, September 2007.
[<a id="ref-RFC5405">RFC5405</a>] Eggert, L. and G. Fairhurst, "Unicast UDP Usage Guidelines
for Application Designers", <a href="https://www.rfc-editor.org/bcp/bcp145">BCP 145</a>, <a href="./rfc5405">RFC 5405</a>, November
2008.
[<a id="ref-RFC5489">RFC5489</a>] Badra, M. and I. Hajjeh, "ECDHE_PSK Cipher Suites for
Transport Layer Security (TLS)", <a href="./rfc5489">RFC 5489</a>, March 2009.
[<a id="ref-RFC6090">RFC6090</a>] McGrew, D., Igoe, K., and M. Salter, "Fundamental Elliptic
Curve Cryptography Algorithms", <a href="./rfc6090">RFC 6090</a>, February 2011.
[<a id="ref-RFC6120">RFC6120</a>] Saint-Andre, P., "Extensible Messaging and Presence
Protocol (XMPP): Core", <a href="./rfc6120">RFC 6120</a>, March 2011.
[<a id="ref-RFC6282">RFC6282</a>] Hui, J. and P. Thubert, "Compression Format for IPv6
Datagrams over IEEE 802.15.4-Based Networks", <a href="./rfc6282">RFC 6282</a>,
September 2011.
[<a id="ref-RFC6335">RFC6335</a>] Cotton, M., Eggert, L., Touch, J., Westerlund, M., and S.
Cheshire, "Internet Assigned Numbers Authority (IANA)
Procedures for the Management of the Service Name and
Transport Protocol Port Number Registry", <a href="https://www.rfc-editor.org/bcp/bcp165">BCP 165</a>, <a href="./rfc6335">RFC</a>
<a href="./rfc6335">6335</a>, August 2011.
[<a id="ref-RFC6655">RFC6655</a>] McGrew, D. and D. Bailey, "AES-CCM Cipher Suites for
Transport Layer Security (TLS)", <a href="./rfc6655">RFC 6655</a>, July 2012.
[<a id="ref-RFC6936">RFC6936</a>] Fairhurst, G. and M. Westerlund, "Applicability Statement
for the Use of IPv6 UDP Datagrams with Zero Checksums",
<a href="./rfc6936">RFC 6936</a>, April 2013.
[<a id="ref-RFC6960">RFC6960</a>] Santesson, S., Myers, M., Ankney, R., Malpani, A.,
Galperin, S., and C. Adams, "X.509 Internet Public Key
Infrastructure Online Certificate Status Protocol - OCSP",
<a href="./rfc6960">RFC 6960</a>, June 2013.
[<a id="ref-RFC6961">RFC6961</a>] Pettersen, Y., "The Transport Layer Security (TLS)
Multiple Certificate Status Request Extension", <a href="./rfc6961">RFC 6961</a>,
June 2013.
[<a id="ref-RFC7159">RFC7159</a>] Bray, T., "The JavaScript Object Notation (JSON) Data
Interchange Format", <a href="./rfc7159">RFC 7159</a>, March 2014.
<span class="grey">Shelby, et al. Standards Track [Page 102]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-103" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
[<a id="ref-RFC7228">RFC7228</a>] Bormann, C., Ersue, M., and A. Keranen, "Terminology for
Constrained-Node Networks", <a href="./rfc7228">RFC 7228</a>, May 2014.
[<a id="ref-RTO-CONSIDER">RTO-CONSIDER</a>]
Allman, M., <a style="text-decoration: none" href='https://www.google.com/search?sitesearch=datatracker.ietf.org%2Fdoc%2Fhtml%2F&q=inurl:draft-+%22Retransmission+Timeout+Considerations%22'>"Retransmission Timeout Considerations"</a>, Work
in Progress, May 2012.
[<a id="ref-W3CXMLSEC">W3CXMLSEC</a>]
Wenning, R., "Report of the XML Security PAG", W3C XML
Security PAG, October 2012,
<<a href="http://www.w3.org/2011/xmlsec-pag/pagreport.html">http://www.w3.org/2011/xmlsec-pag/pagreport.html</a>>.
<span class="grey">Shelby, et al. Standards Track [Page 103]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-104" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
<span class="h2"><a class="selflink" id="appendix-A" href="#appendix-A">Appendix A</a>. Examples</span>
This section gives a number of short examples with message flows for
GET requests. These examples demonstrate the basic operation, the
operation in the presence of retransmissions, and multicast.
Figure 16 shows a basic GET request causing a piggybacked response:
The client sends a Confirmable GET request for the resource
coap://server/temperature to the server with a Message ID of 0x7d34.
The request includes one Uri-Path Option (Delta 0 + 11 = 11, Length
11, Value "temperature"); the Token is left empty. This request is a
total of 16 bytes long. A 2.05 (Content) response is returned in the
Acknowledgement message that acknowledges the Confirmable request,
echoing both the Message ID 0x7d34 and the empty Token value. The
response includes a Payload of "22.3 C" and is 11 bytes long.
Client Server
| |
| |
+----->| Header: GET (T=CON, Code=0.01, MID=0x7d34)
| GET | Uri-Path: "temperature"
| |
| |
|<-----+ Header: 2.05 Content (T=ACK, Code=2.05, MID=0x7d34)
| 2.05 | Payload: "22.3 C"
| |
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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| 1 | 0 | 0 | GET=1 | MID=0x7d34 |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| 11 | 11 | "temperature" (11 B) ...
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| 1 | 2 | 0 | 2.05=69 | MID=0x7d34 |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|1 1 1 1 1 1 1 1| "22.3 C" (6 B) ...
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Figure 16: Confirmable Request; Piggybacked Response
<span class="grey">Shelby, et al. Standards Track [Page 104]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-105" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
Figure 17 shows a similar example, but with the inclusion of an non-
empty Token (Value 0x20) in the request and the response, increasing
the sizes to 17 and 12 bytes, respectively.
Client Server
| |
| |
+----->| Header: GET (T=CON, Code=0.01, MID=0x7d35)
| GET | Token: 0x20
| | Uri-Path: "temperature"
| |
| |
|<-----+ Header: 2.05 Content (T=ACK, Code=2.05, MID=0x7d35)
| 2.05 | Token: 0x20
| | Payload: "22.3 C"
| |
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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| 1 | 0 | 1 | GET=1 | MID=0x7d35 |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| 0x20 |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| 11 | 11 | "temperature" (11 B) ...
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| 1 | 2 | 1 | 2.05=69 | MID=0x7d35 |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| 0x20 |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|1 1 1 1 1 1 1 1| "22.3 C" (6 B) ...
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Figure 17: Confirmable Request; Piggybacked Response
<span class="grey">Shelby, et al. Standards Track [Page 105]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-106" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
In Figure 18, the Confirmable GET request is lost. After ACK_TIMEOUT
seconds, the client retransmits the request, resulting in a
piggybacked response as in the previous example.
Client Server
| |
| |
+----X | Header: GET (T=CON, Code=0.01, MID=0x7d36)
| GET | Token: 0x31
| | Uri-Path: "temperature"
TIMEOUT |
| |
+----->| Header: GET (T=CON, Code=0.01, MID=0x7d36)
| GET | Token: 0x31
| | Uri-Path: "temperature"
| |
| |
|<-----+ Header: 2.05 Content (T=ACK, Code=2.05, MID=0x7d36)
| 2.05 | Token: 0x31
| | Payload: "22.3 C"
| |
Figure 18: Confirmable Request (Retransmitted); Piggybacked Response
<span class="grey">Shelby, et al. Standards Track [Page 106]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-107" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
In Figure 19, the first Acknowledgement message from the server to
the client is lost. After ACK_TIMEOUT seconds, the client
retransmits the request.
Client Server
| |
| |
+----->| Header: GET (T=CON, Code=0.01, MID=0x7d37)
| GET | Token: 0x42
| | Uri-Path: "temperature"
| |
| |
| X----+ Header: 2.05 Content (T=ACK, Code=2.05, MID=0x7d37)
| 2.05 | Token: 0x42
| | Payload: "22.3 C"
TIMEOUT |
| |
+----->| Header: GET (T=CON, Code=0.01, MID=0x7d37)
| GET | Token: 0x42
| | Uri-Path: "temperature"
| |
| |
|<-----+ Header: 2.05 Content (T=ACK, Code=2.05, MID=0x7d37)
| 2.05 | Token: 0x42
| | Payload: "22.3 C"
| |
Figure 19: Confirmable Request; Piggybacked Response (Retransmitted)
<span class="grey">Shelby, et al. Standards Track [Page 107]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-108" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
In Figure 20, the server acknowledges the Confirmable request and
sends a 2.05 (Content) response separately in a Confirmable message.
Note that the Acknowledgement message and the Confirmable response do
not necessarily arrive in the same order as they were sent. The
client acknowledges the Confirmable response.
Client Server
| |
| |
+----->| Header: GET (T=CON, Code=0.01, MID=0x7d38)
| GET | Token: 0x53
| | Uri-Path: "temperature"
| |
| |
|<- - -+ Header: (T=ACK, Code=0.00, MID=0x7d38)
| |
| |
|<-----+ Header: 2.05 Content (T=CON, Code=2.05, MID=0xad7b)
| 2.05 | Token: 0x53
| | Payload: "22.3 C"
| |
| |
+- - ->| Header: (T=ACK, Code=0.00, MID=0xad7b)
| |
Figure 20: Confirmable Request; Separate Response
<span class="grey">Shelby, et al. Standards Track [Page 108]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-109" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
Figure 21 shows an example where the client loses its state (e.g.,
crashes and is rebooted) right after sending a Confirmable request,
so the separate response arriving some time later comes unexpected.
In this case, the client rejects the Confirmable response with a
Reset message. Note that the unexpected ACK is silently ignored.
Client Server
| |
| |
+----->| Header: GET (T=CON, Code=0.01, MID=0x7d39)
| GET | Token: 0x64
| | Uri-Path: "temperature"
CRASH |
| |
|<- - -+ Header: (T=ACK, Code=0.00, MID=0x7d39)
| |
| |
|<-----+ Header: 2.05 Content (T=CON, Code=2.05, MID=0xad7c)
| 2.05 | Token: 0x64
| | Payload: "22.3 C"
| |
| |
+- - ->| Header: (T=RST, Code=0.00, MID=0xad7c)
| |
Figure 21: Confirmable Request; Separate Response (Unexpected)
Figure 22 shows a basic GET request where the request and the
response are Non-confirmable, so both may be lost without notice.
Client Server
| |
| |
+----->| Header: GET (T=NON, Code=0.01, MID=0x7d40)
| GET | Token: 0x75
| | Uri-Path: "temperature"
| |
| |
|<-----+ Header: 2.05 Content (T=NON, Code=2.05, MID=0xad7d)
| 2.05 | Token: 0x75
| | Payload: "22.3 C"
| |
Figure 22: Non-confirmable Request; Non-confirmable Response
<span class="grey">Shelby, et al. Standards Track [Page 109]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-110" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
In Figure 23, the client sends a Non-confirmable GET request to a
multicast address: all nodes in link-local scope. There are 3
servers on the link: A, B and C. Servers A and B have a matching
resource, therefore they send back a Non-confirmable 2.05 (Content)
response. The response sent by B is lost. C does not have matching
response, therefore it sends a Non-confirmable 4.04 (Not Found)
response.
Client ff02::1 A B C
| | | | |
| | | | |
+------>| | | | Header: GET (T=NON, Code=0.01, MID=0x7d41)
| GET | | | | Token: 0x86
| | | | Uri-Path: "temperature"
| | | |
| | | |
|<------------+ | | Header: 2.05 (T=NON, Code=2.05, MID=0x60b1)
| 2.05 | | | Token: 0x86
| | | | Payload: "22.3 C"
| | | |
| | | |
| X------------+ | Header: 2.05 (T=NON, Code=2.05, MID=0x01a0)
| 2.05 | | | Token: 0x86
| | | | Payload: "20.9 C"
| | | |
| | | |
|<------------------+ Header: 4.04 (T=NON, Code=4.04, MID=0x952a)
| 4.04 | | | Token: 0x86
| | | |
Figure 23: Non-confirmable Request (Multicast); Non-confirmable
Response
<span class="h2"><a class="selflink" id="appendix-B" href="#appendix-B">Appendix B</a>. URI Examples</span>
The following examples demonstrate different sets of Uri options, and
the result after constructing an URI from them. In addition to the
options, <a href="#section-6.5">Section 6.5</a> refers to the destination IP address and port,
but not all paths of the algorithm cause the destination IP address
and port to be included in the URI.
o Input:
Destination IP Address = [2001:db8::2:1]
Destination UDP Port = 5683
<span class="grey">Shelby, et al. Standards Track [Page 110]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-111" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
Output:
coap://[2001:db8::2:1]/
o Input:
Destination IP Address = [2001:db8::2:1]
Destination UDP Port = 5683
Uri-Host = "example.net"
Output:
coap://example.net/
o Input:
Destination IP Address = [2001:db8::2:1]
Destination UDP Port = 5683
Uri-Host = "example.net"
Uri-Path = ".well-known"
Uri-Path = "core"
Output:
coap://example.net/.well-known/core
o Input:
Destination IP Address = [2001:db8::2:1]
Destination UDP Port = 5683
Uri-Host = "xn--18j4d.example"
Uri-Path = the string composed of the Unicode characters U+3053
U+3093 U+306b U+3061 U+306f, usually represented in UTF-8 as
E38193E38293E381ABE381A1E381AF hexadecimal
Output:
coap://xn--18j4d.example/
%E3%81%93%E3%82%93%E3%81%AB%E3%81%A1%E3%81%AF
(The line break has been inserted for readability; it is not
part of the URI.)
<span class="grey">Shelby, et al. Standards Track [Page 111]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-112" ></span>
<span class="grey"><a href="./rfc7252">RFC 7252</a> The Constrained Application Protocol (CoAP) June 2014</span>
o Input:
Destination IP Address = 198.51.100.1
Destination UDP Port = 61616
Uri-Path = ""
Uri-Path = "/"
Uri-Path = ""
Uri-Path = ""
Uri-Query = "//"
Uri-Query = "?&"
Output:
coap://198.51.100.1:61616//%2F//?%2F%2F&?%26
Authors' Addresses
Zach Shelby
ARM
150 Rose Orchard
San Jose, CA 95134
USA
Phone: +1-408-203-9434
EMail: zach.shelby@arm.com
Klaus Hartke
Universitaet Bremen TZI
Postfach 330440
Bremen D-28359
Germany
Phone: +49-421-218-63905
EMail: hartke@tzi.org
Carsten Bormann
Universitaet Bremen TZI
Postfach 330440
Bremen D-28359
Germany
Phone: +49-421-218-63921
EMail: cabo@tzi.org
Shelby, et al. Standards Track [Page 112]
</pre>
|