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
|
<!DOCTYPE html>
<html lang="en" class="RFC">
<head>
<meta charset="utf-8">
<meta content="Common,Latin" name="scripts">
<meta content="initial-scale=1.0" name="viewport">
<title>RFC 9176: Constrained RESTful Environments (CoRE) Resource Directory</title>
<meta content="Christian Amsüss" name="author">
<meta content="Zach Shelby" name="author">
<meta content="Michael Koster" name="author">
<meta content="Carsten Bormann" name="author">
<meta content="Peter van der Stok" name="author">
<meta content="
In many Internet of Things (IoT) applications, direct discovery of resources is not
practical due to sleeping nodes or networks where multicast traffic
is inefficient. These problems can be solved by employing an entity called
a Resource Directory (RD), which contains information about resources held on
other servers, allowing lookups to be performed for those resources. The input to an RD is composed of links, and the output is composed of links constructed from the information stored in the RD. This
document specifies the web interfaces that an RD supports for web servers to discover the RD and to register, maintain, look up,
and remove information on resources. Furthermore, new target attributes useful
in conjunction with an RD are defined.
" name="description">
<meta content="xml2rfc 3.12.2" name="generator">
<meta content="CoRE" name="keyword">
<meta content="Web Linking" name="keyword">
<meta content="Resource Discovery" name="keyword">
<meta content="Resource Directory" name="keyword">
<meta content="9176" name="rfc.number">
<!-- Generator version information:
xml2rfc 3.12.2
Python 3.6.15
appdirs 1.4.4
ConfigArgParse 1.4.1
google-i18n-address 2.4.0
html5lib 1.0.1
intervaltree 3.0.2
Jinja2 2.11.3
kitchen 1.2.6
lxml 4.4.2
pycairo 1.15.1
pycountry 19.8.18
pyflakes 2.1.1
PyYAML 5.4.1
requests 2.24.0
setuptools 40.5.0
six 1.14.0
WeasyPrint 52.5
-->
<link href="rfc9176.xml" rel="alternate" type="application/rfc+xml">
<link href="#copyright" rel="license">
<style type="text/css">/*
NOTE: Changes at the bottom of this file overrides some earlier settings.
Once the style has stabilized and has been adopted as an official RFC style,
this can be consolidated so that style settings occur only in one place, but
for now the contents of this file consists first of the initial CSS work as
provided to the RFC Formatter (xml2rfc) work, followed by itemized and
commented changes found necssary during the development of the v3
formatters.
*/
/* fonts */
@import url('https://fonts.googleapis.com/css?family=Noto+Sans'); /* Sans-serif */
@import url('https://fonts.googleapis.com/css?family=Noto+Serif'); /* Serif (print) */
@import url('https://fonts.googleapis.com/css?family=Roboto+Mono'); /* Monospace */
@viewport {
zoom: 1.0;
width: extend-to-zoom;
}
@-ms-viewport {
width: extend-to-zoom;
zoom: 1.0;
}
/* general and mobile first */
html {
}
body {
max-width: 90%;
margin: 1.5em auto;
color: #222;
background-color: #fff;
font-size: 14px;
font-family: 'Noto Sans', Arial, Helvetica, sans-serif;
line-height: 1.6;
scroll-behavior: smooth;
}
.ears {
display: none;
}
/* headings */
#title, h1, h2, h3, h4, h5, h6 {
margin: 1em 0 0.5em;
font-weight: bold;
line-height: 1.3;
}
#title {
clear: both;
border-bottom: 1px solid #ddd;
margin: 0 0 0.5em 0;
padding: 1em 0 0.5em;
}
.author {
padding-bottom: 4px;
}
h1 {
font-size: 26px;
margin: 1em 0;
}
h2 {
font-size: 22px;
margin-top: -20px; /* provide offset for in-page anchors */
padding-top: 33px;
}
h3 {
font-size: 18px;
margin-top: -36px; /* provide offset for in-page anchors */
padding-top: 42px;
}
h4 {
font-size: 16px;
margin-top: -36px; /* provide offset for in-page anchors */
padding-top: 42px;
}
h5, h6 {
font-size: 14px;
}
#n-copyright-notice {
border-bottom: 1px solid #ddd;
padding-bottom: 1em;
margin-bottom: 1em;
}
/* general structure */
p {
padding: 0;
margin: 0 0 1em 0;
text-align: left;
}
div, span {
position: relative;
}
div {
margin: 0;
}
.alignRight.art-text {
background-color: #f9f9f9;
border: 1px solid #eee;
border-radius: 3px;
padding: 1em 1em 0;
margin-bottom: 1.5em;
}
.alignRight.art-text pre {
padding: 0;
}
.alignRight {
margin: 1em 0;
}
.alignRight > *:first-child {
border: none;
margin: 0;
float: right;
clear: both;
}
.alignRight > *:nth-child(2) {
clear: both;
display: block;
border: none;
}
svg {
display: block;
}
.alignCenter.art-text {
background-color: #f9f9f9;
border: 1px solid #eee;
border-radius: 3px;
padding: 1em 1em 0;
margin-bottom: 1.5em;
}
.alignCenter.art-text pre {
padding: 0;
}
.alignCenter {
margin: 1em 0;
}
.alignCenter > *:first-child {
border: none;
/* this isn't optimal, but it's an existence proof. PrinceXML doesn't
support flexbox yet.
*/
display: table;
margin: 0 auto;
}
/* lists */
ol, ul {
padding: 0;
margin: 0 0 1em 2em;
}
ol ol, ul ul, ol ul, ul ol {
margin-left: 1em;
}
li {
margin: 0 0 0.25em 0;
}
.ulCompact li {
margin: 0;
}
ul.empty, .ulEmpty {
list-style-type: none;
}
ul.empty li, .ulEmpty li {
margin-top: 0.5em;
}
ul.ulBare, li.ulBare {
margin-left: 0em !important;
}
ul.compact, .ulCompact,
ol.compact, .olCompact {
line-height: 100%;
margin: 0 0 0 2em;
}
/* definition lists */
dl {
}
dl > dt {
float: left;
margin-right: 1em;
}
/*
dl.nohang > dt {
float: none;
}
*/
dl > dd {
margin-bottom: .8em;
min-height: 1.3em;
}
dl.compact > dd, .dlCompact > dd {
margin-bottom: 0em;
}
dl > dd > dl {
margin-top: 0.5em;
margin-bottom: 0em;
}
/* links */
a {
text-decoration: none;
}
a[href] {
color: #22e; /* Arlen: WCAG 2019 */
}
a[href]:hover {
background-color: #f2f2f2;
}
figcaption a[href],
a[href].selfRef {
color: #222;
}
/* XXX probably not this:
a.selfRef:hover {
background-color: transparent;
cursor: default;
} */
/* Figures */
tt, code, pre, code {
background-color: #f9f9f9;
font-family: 'Roboto Mono', monospace;
}
pre {
border: 1px solid #eee;
margin: 0;
padding: 1em;
}
img {
max-width: 100%;
}
figure {
margin: 0;
}
figure blockquote {
margin: 0.8em 0.4em 0.4em;
}
figcaption {
font-style: italic;
margin: 0 0 1em 0;
}
@media screen {
pre {
overflow-x: auto;
max-width: 100%;
max-width: calc(100% - 22px);
}
}
/* aside, blockquote */
aside, blockquote {
margin-left: 0;
padding: 1.2em 2em;
}
blockquote {
background-color: #f9f9f9;
color: #111; /* Arlen: WCAG 2019 */
border: 1px solid #ddd;
border-radius: 3px;
margin: 1em 0;
}
cite {
display: block;
text-align: right;
font-style: italic;
}
/* tables */
table {
width: 100%;
margin: 0 0 1em;
border-collapse: collapse;
border: 1px solid #eee;
}
th, td {
text-align: left;
vertical-align: top;
padding: 0.5em 0.75em;
}
th {
text-align: left;
background-color: #e9e9e9;
}
tr:nth-child(2n+1) > td {
background-color: #f5f5f5;
}
table caption {
font-style: italic;
margin: 0;
padding: 0;
text-align: left;
}
table p {
/* XXX to avoid bottom margin on table row signifiers. If paragraphs should
be allowed within tables more generally, it would be far better to select on a class. */
margin: 0;
}
/* pilcrow */
a.pilcrow {
color: #666; /* Arlen: AHDJ 2019 */
text-decoration: none;
visibility: hidden;
user-select: none;
-ms-user-select: none;
-o-user-select:none;
-moz-user-select: none;
-khtml-user-select: none;
-webkit-user-select: none;
-webkit-touch-callout: none;
}
@media screen {
aside:hover > a.pilcrow,
p:hover > a.pilcrow,
blockquote:hover > a.pilcrow,
div:hover > a.pilcrow,
li:hover > a.pilcrow,
pre:hover > a.pilcrow {
visibility: visible;
}
a.pilcrow:hover {
background-color: transparent;
}
}
/* misc */
hr {
border: 0;
border-top: 1px solid #eee;
}
.bcp14 {
font-variant: small-caps;
}
.role {
font-variant: all-small-caps;
}
/* info block */
#identifiers {
margin: 0;
font-size: 0.9em;
}
#identifiers dt {
width: 3em;
clear: left;
}
#identifiers dd {
float: left;
margin-bottom: 0;
}
/* Fix PDF info block run off issue */
@media print {
#identifiers dd {
float: none;
}
}
#identifiers .authors .author {
display: inline-block;
margin-right: 1.5em;
}
#identifiers .authors .org {
font-style: italic;
}
/* The prepared/rendered info at the very bottom of the page */
.docInfo {
color: #666; /* Arlen: WCAG 2019 */
font-size: 0.9em;
font-style: italic;
margin-top: 2em;
}
.docInfo .prepared {
float: left;
}
.docInfo .prepared {
float: right;
}
/* table of contents */
#toc {
padding: 0.75em 0 2em 0;
margin-bottom: 1em;
}
nav.toc ul {
margin: 0 0.5em 0 0;
padding: 0;
list-style: none;
}
nav.toc li {
line-height: 1.3em;
margin: 0.75em 0;
padding-left: 1.2em;
text-indent: -1.2em;
}
/* references */
.references dt {
text-align: right;
font-weight: bold;
min-width: 7em;
}
.references dd {
margin-left: 8em;
overflow: auto;
}
.refInstance {
margin-bottom: 1.25em;
}
.references .ascii {
margin-bottom: 0.25em;
}
/* index */
.index ul {
margin: 0 0 0 1em;
padding: 0;
list-style: none;
}
.index ul ul {
margin: 0;
}
.index li {
margin: 0;
text-indent: -2em;
padding-left: 2em;
padding-bottom: 5px;
}
.indexIndex {
margin: 0.5em 0 1em;
}
.index a {
font-weight: 700;
}
/* make the index two-column on all but the smallest screens */
@media (min-width: 600px) {
.index ul {
-moz-column-count: 2;
-moz-column-gap: 20px;
}
.index ul ul {
-moz-column-count: 1;
-moz-column-gap: 0;
}
}
/* authors */
address.vcard {
font-style: normal;
margin: 1em 0;
}
address.vcard .nameRole {
font-weight: 700;
margin-left: 0;
}
address.vcard .label {
font-family: "Noto Sans",Arial,Helvetica,sans-serif;
margin: 0.5em 0;
}
address.vcard .type {
display: none;
}
.alternative-contact {
margin: 1.5em 0 1em;
}
hr.addr {
border-top: 1px dashed;
margin: 0;
color: #ddd;
max-width: calc(100% - 16px);
}
/* temporary notes */
.rfcEditorRemove::before {
position: absolute;
top: 0.2em;
right: 0.2em;
padding: 0.2em;
content: "The RFC Editor will remove this note";
color: #9e2a00; /* Arlen: WCAG 2019 */
background-color: #ffd; /* Arlen: WCAG 2019 */
}
.rfcEditorRemove {
position: relative;
padding-top: 1.8em;
background-color: #ffd; /* Arlen: WCAG 2019 */
border-radius: 3px;
}
.cref {
background-color: #ffd; /* Arlen: WCAG 2019 */
padding: 2px 4px;
}
.crefSource {
font-style: italic;
}
/* alternative layout for smaller screens */
@media screen and (max-width: 1023px) {
body {
padding-top: 2em;
}
#title {
padding: 1em 0;
}
h1 {
font-size: 24px;
}
h2 {
font-size: 20px;
margin-top: -18px; /* provide offset for in-page anchors */
padding-top: 38px;
}
#identifiers dd {
max-width: 60%;
}
#toc {
position: fixed;
z-index: 2;
top: 0;
right: 0;
padding: 0;
margin: 0;
background-color: inherit;
border-bottom: 1px solid #ccc;
}
#toc h2 {
margin: -1px 0 0 0;
padding: 4px 0 4px 6px;
padding-right: 1em;
min-width: 190px;
font-size: 1.1em;
text-align: right;
background-color: #444;
color: white;
cursor: pointer;
}
#toc h2::before { /* css hamburger */
float: right;
position: relative;
width: 1em;
height: 1px;
left: -164px;
margin: 6px 0 0 0;
background: white none repeat scroll 0 0;
box-shadow: 0 4px 0 0 white, 0 8px 0 0 white;
content: "";
}
#toc nav {
display: none;
padding: 0.5em 1em 1em;
overflow: auto;
height: calc(100vh - 48px);
border-left: 1px solid #ddd;
}
}
/* alternative layout for wide screens */
@media screen and (min-width: 1024px) {
body {
max-width: 724px;
margin: 42px auto;
padding-left: 1.5em;
padding-right: 29em;
}
#toc {
position: fixed;
top: 42px;
right: 42px;
width: 25%;
margin: 0;
padding: 0 1em;
z-index: 1;
}
#toc h2 {
border-top: none;
border-bottom: 1px solid #ddd;
font-size: 1em;
font-weight: normal;
margin: 0;
padding: 0.25em 1em 1em 0;
}
#toc nav {
display: block;
height: calc(90vh - 84px);
bottom: 0;
padding: 0.5em 0 0;
overflow: auto;
}
img { /* future proofing */
max-width: 100%;
height: auto;
}
}
/* pagination */
@media print {
body {
width: 100%;
}
p {
orphans: 3;
widows: 3;
}
#n-copyright-notice {
border-bottom: none;
}
#toc, #n-introduction {
page-break-before: always;
}
#toc {
border-top: none;
padding-top: 0;
}
figure, pre {
page-break-inside: avoid;
}
figure {
overflow: scroll;
}
h1, h2, h3, h4, h5, h6 {
page-break-after: avoid;
}
h2+*, h3+*, h4+*, h5+*, h6+* {
page-break-before: avoid;
}
pre {
white-space: pre-wrap;
word-wrap: break-word;
font-size: 10pt;
}
table {
border: 1px solid #ddd;
}
td {
border-top: 1px solid #ddd;
}
}
/* This is commented out here, as the string-set: doesn't
pass W3C validation currently */
/*
.ears thead .left {
string-set: ears-top-left content();
}
.ears thead .center {
string-set: ears-top-center content();
}
.ears thead .right {
string-set: ears-top-right content();
}
.ears tfoot .left {
string-set: ears-bottom-left content();
}
.ears tfoot .center {
string-set: ears-bottom-center content();
}
.ears tfoot .right {
string-set: ears-bottom-right content();
}
*/
@page :first {
padding-top: 0;
@top-left {
content: normal;
border: none;
}
@top-center {
content: normal;
border: none;
}
@top-right {
content: normal;
border: none;
}
}
@page {
size: A4;
margin-bottom: 45mm;
padding-top: 20px;
/* The follwing is commented out here, but set appropriately by in code, as
the content depends on the document */
/*
@top-left {
content: 'Internet-Draft';
vertical-align: bottom;
border-bottom: solid 1px #ccc;
}
@top-left {
content: string(ears-top-left);
vertical-align: bottom;
border-bottom: solid 1px #ccc;
}
@top-center {
content: string(ears-top-center);
vertical-align: bottom;
border-bottom: solid 1px #ccc;
}
@top-right {
content: string(ears-top-right);
vertical-align: bottom;
border-bottom: solid 1px #ccc;
}
@bottom-left {
content: string(ears-bottom-left);
vertical-align: top;
border-top: solid 1px #ccc;
}
@bottom-center {
content: string(ears-bottom-center);
vertical-align: top;
border-top: solid 1px #ccc;
}
@bottom-right {
content: '[Page ' counter(page) ']';
vertical-align: top;
border-top: solid 1px #ccc;
}
*/
}
/* Changes introduced to fix issues found during implementation */
/* Make sure links are clickable even if overlapped by following H* */
a {
z-index: 2;
}
/* Separate body from document info even without intervening H1 */
section {
clear: both;
}
/* Top align author divs, to avoid names without organization dropping level with org names */
.author {
vertical-align: top;
}
/* Leave room in document info to show Internet-Draft on one line */
#identifiers dt {
width: 8em;
}
/* Don't waste quite as much whitespace between label and value in doc info */
#identifiers dd {
margin-left: 1em;
}
/* Give floating toc a background color (needed when it's a div inside section */
#toc {
background-color: white;
}
/* Make the collapsed ToC header render white on gray also when it's a link */
@media screen and (max-width: 1023px) {
#toc h2 a,
#toc h2 a:link,
#toc h2 a:focus,
#toc h2 a:hover,
#toc a.toplink,
#toc a.toplink:hover {
color: white;
background-color: #444;
text-decoration: none;
}
}
/* Give the bottom of the ToC some whitespace */
@media screen and (min-width: 1024px) {
#toc {
padding: 0 0 1em 1em;
}
}
/* Style section numbers with more space between number and title */
.section-number {
padding-right: 0.5em;
}
/* prevent monospace from becoming overly large */
tt, code, pre, code {
font-size: 95%;
}
/* Fix the height/width aspect for ascii art*/
pre.sourcecode,
.art-text pre {
line-height: 1.12;
}
/* Add styling for a link in the ToC that points to the top of the document */
a.toplink {
float: right;
margin-right: 0.5em;
}
/* Fix the dl styling to match the RFC 7992 attributes */
dl > dt,
dl.dlParallel > dt {
float: left;
margin-right: 1em;
}
dl.dlNewline > dt {
float: none;
}
/* Provide styling for table cell text alignment */
table td.text-left,
table th.text-left {
text-align: left;
}
table td.text-center,
table th.text-center {
text-align: center;
}
table td.text-right,
table th.text-right {
text-align: right;
}
/* Make the alternative author contact informatio look less like just another
author, and group it closer with the primary author contact information */
.alternative-contact {
margin: 0.5em 0 0.25em 0;
}
address .non-ascii {
margin: 0 0 0 2em;
}
/* With it being possible to set tables with alignment
left, center, and right, { width: 100%; } does not make sense */
table {
width: auto;
}
/* Avoid reference text that sits in a block with very wide left margin,
because of a long floating dt label.*/
.references dd {
overflow: visible;
}
/* Control caption placement */
caption {
caption-side: bottom;
}
/* Limit the width of the author address vcard, so names in right-to-left
script don't end up on the other side of the page. */
address.vcard {
max-width: 30em;
margin-right: auto;
}
/* For address alignment dependent on LTR or RTL scripts */
address div.left {
text-align: left;
}
address div.right {
text-align: right;
}
/* Provide table alignment support. We can't use the alignX classes above
since they do unwanted things with caption and other styling. */
table.right {
margin-left: auto;
margin-right: 0;
}
table.center {
margin-left: auto;
margin-right: auto;
}
table.left {
margin-left: 0;
margin-right: auto;
}
/* Give the table caption label the same styling as the figcaption */
caption a[href] {
color: #222;
}
@media print {
.toplink {
display: none;
}
/* avoid overwriting the top border line with the ToC header */
#toc {
padding-top: 1px;
}
/* Avoid page breaks inside dl and author address entries */
.vcard {
page-break-inside: avoid;
}
}
/* Tweak the bcp14 keyword presentation */
.bcp14 {
font-variant: small-caps;
font-weight: bold;
font-size: 0.9em;
}
/* Tweak the invisible space above H* in order not to overlay links in text above */
h2 {
margin-top: -18px; /* provide offset for in-page anchors */
padding-top: 31px;
}
h3 {
margin-top: -18px; /* provide offset for in-page anchors */
padding-top: 24px;
}
h4 {
margin-top: -18px; /* provide offset for in-page anchors */
padding-top: 24px;
}
/* Float artwork pilcrow to the right */
@media screen {
.artwork a.pilcrow {
display: block;
line-height: 0.7;
margin-top: 0.15em;
}
}
/* Make pilcrows on dd visible */
@media screen {
dd:hover > a.pilcrow {
visibility: visible;
}
}
/* Make the placement of figcaption match that of a table's caption
by removing the figure's added bottom margin */
.alignLeft.art-text,
.alignCenter.art-text,
.alignRight.art-text {
margin-bottom: 0;
}
.alignLeft,
.alignCenter,
.alignRight {
margin: 1em 0 0 0;
}
/* In print, the pilcrow won't show on hover, so prevent it from taking up space,
possibly even requiring a new line */
@media print {
a.pilcrow {
display: none;
}
}
/* Styling for the external metadata */
div#external-metadata {
background-color: #eee;
padding: 0.5em;
margin-bottom: 0.5em;
display: none;
}
div#internal-metadata {
padding: 0.5em; /* to match the external-metadata padding */
}
/* Styling for title RFC Number */
h1#rfcnum {
clear: both;
margin: 0 0 -1em;
padding: 1em 0 0 0;
}
/* Make .olPercent look the same as <ol><li> */
dl.olPercent > dd {
margin-bottom: 0.25em;
min-height: initial;
}
/* Give aside some styling to set it apart */
aside {
border-left: 1px solid #ddd;
margin: 1em 0 1em 2em;
padding: 0.2em 2em;
}
aside > dl,
aside > ol,
aside > ul,
aside > table,
aside > p {
margin-bottom: 0.5em;
}
/* Additional page break settings */
@media print {
figcaption, table caption {
page-break-before: avoid;
}
}
/* Font size adjustments for print */
@media print {
body { font-size: 10pt; line-height: normal; max-width: 96%; }
h1 { font-size: 1.72em; padding-top: 1.5em; } /* 1*1.2*1.2*1.2 */
h2 { font-size: 1.44em; padding-top: 1.5em; } /* 1*1.2*1.2 */
h3 { font-size: 1.2em; padding-top: 1.5em; } /* 1*1.2 */
h4 { font-size: 1em; padding-top: 1.5em; }
h5, h6 { font-size: 1em; margin: initial; padding: 0.5em 0 0.3em; }
}
/* Sourcecode margin in print, when there's no pilcrow */
@media print {
.artwork,
.sourcecode {
margin-bottom: 1em;
}
}
/* Avoid narrow tables forcing too narrow table captions, which may render badly */
table {
min-width: 20em;
}
/* ol type a */
ol.type-a { list-style-type: lower-alpha; }
ol.type-A { list-style-type: upper-alpha; }
ol.type-i { list-style-type: lower-roman; }
ol.type-I { list-style-type: lower-roman; }
/* Apply the print table and row borders in general, on request from the RPC,
and increase the contrast between border and odd row background sligthtly */
table {
border: 1px solid #ddd;
}
td {
border-top: 1px solid #ddd;
}
tr:nth-child(2n+1) > td {
background-color: #f8f8f8;
}
/* Use style rules to govern display of the TOC. */
@media screen and (max-width: 1023px) {
#toc nav { display: none; }
#toc.active nav { display: block; }
}
/* Add support for keepWithNext */
.keepWithNext {
break-after: avoid-page;
break-after: avoid-page;
}
/* Add support for keepWithPrevious */
.keepWithPrevious {
break-before: avoid-page;
}
/* Change the approach to avoiding breaks inside artwork etc. */
figure, pre, table, .artwork, .sourcecode {
break-before: auto;
break-after: auto;
}
/* Avoid breaks between <dt> and <dd> */
dl {
break-before: auto;
break-inside: auto;
}
dt {
break-before: auto;
break-after: avoid-page;
}
dd {
break-before: avoid-page;
break-after: auto;
orphans: 3;
widows: 3
}
span.break, dd.break {
margin-bottom: 0;
min-height: 0;
break-before: auto;
break-inside: auto;
break-after: auto;
}
/* Undo break-before ToC */
@media print {
#toc {
break-before: auto;
}
}
/* Text in compact lists should not get extra bottim margin space,
since that would makes the list not compact */
ul.compact p, .ulCompact p,
ol.compact p, .olCompact p {
margin: 0;
}
/* But the list as a whole needs the extra space at the end */
section ul.compact,
section .ulCompact,
section ol.compact,
section .olCompact {
margin-bottom: 1em; /* same as p not within ul.compact etc. */
}
/* The tt and code background above interferes with for instance table cell
backgrounds. Changed to something a bit more selective. */
tt, code {
background-color: transparent;
}
p tt, p code, li tt, li code {
background-color: #f8f8f8;
}
/* Tweak the pre margin -- 0px doesn't come out well */
pre {
margin-top: 0.5px;
}
/* Tweak the comact list text */
ul.compact, .ulCompact,
ol.compact, .olCompact,
dl.compact, .dlCompact {
line-height: normal;
}
/* Don't add top margin for nested lists */
li > ul, li > ol, li > dl,
dd > ul, dd > ol, dd > dl,
dl > dd > dl {
margin-top: initial;
}
/* Elements that should not be rendered on the same line as a <dt> */
/* This should match the element list in writer.text.TextWriter.render_dl() */
dd > div.artwork:first-child,
dd > aside:first-child,
dd > figure:first-child,
dd > ol:first-child,
dd > div:first-child > pre.sourcecode,
dd > table:first-child,
dd > ul:first-child {
clear: left;
}
/* fix for weird browser behaviour when <dd/> is empty */
dt+dd:empty::before{
content: "\00a0";
}
/* Make paragraph spacing inside <li> smaller than in body text, to fit better within the list */
li > p {
margin-bottom: 0.5em
}
/* Don't let p margin spill out from inside list items */
li > p:last-of-type {
margin-bottom: 0;
}
</style>
<link href="rfc-local.css" rel="stylesheet" type="text/css">
<link href="https://dx.doi.org/10.17487/rfc9176" rel="alternate">
<link href="urn:issn:2070-1721" rel="alternate">
<link href="https://datatracker.ietf.org/doc/draft-ietf-core-resource-directory-28" rel="prev">
</head>
<body>
<script src="https://www.rfc-editor.org/js/metadata.min.js"></script>
<table class="ears">
<thead><tr>
<td class="left">RFC 9176</td>
<td class="center">CoRE Resource Directory</td>
<td class="right">April 2022</td>
</tr></thead>
<tfoot><tr>
<td class="left">Amsüss, et al.</td>
<td class="center">Standards Track</td>
<td class="right">[Page]</td>
</tr></tfoot>
</table>
<div id="external-metadata" class="document-information"></div>
<div id="internal-metadata" class="document-information">
<dl id="identifiers">
<dt class="label-stream">Stream:</dt>
<dd class="stream">Internet Engineering Task Force (IETF)</dd>
<dt class="label-rfc">RFC:</dt>
<dd class="rfc"><a href="https://www.rfc-editor.org/rfc/rfc9176" class="eref">9176</a></dd>
<dt class="label-category">Category:</dt>
<dd class="category">Standards Track</dd>
<dt class="label-published">Published:</dt>
<dd class="published">
<time datetime="2022-04" class="published">April 2022</time>
</dd>
<dt class="label-issn">ISSN:</dt>
<dd class="issn">2070-1721</dd>
<dt class="label-authors">Authors:</dt>
<dd class="authors">
<div class="author">
<div class="author-name">C. Amsüss, <span class="editor">Ed.</span>
</div>
</div>
<div class="author">
<div class="author-name">Z. Shelby</div>
<div class="org">Edge Impulse</div>
</div>
<div class="author">
<div class="author-name">M. Koster</div>
<div class="org">PassiveLogic</div>
</div>
<div class="author">
<div class="author-name">C. Bormann</div>
<div class="org">Universität Bremen TZI</div>
</div>
<div class="author">
<div class="author-name">P. van der Stok</div>
<div class="org">vanderstok consultancy</div>
</div>
</dd>
</dl>
</div>
<h1 id="rfcnum">RFC 9176</h1>
<h1 id="title">Constrained RESTful Environments (CoRE) Resource Directory</h1>
<section id="section-abstract">
<h2 id="abstract"><a href="#abstract" class="selfRef">Abstract</a></h2>
<p id="section-abstract-1">In many Internet of Things (IoT) applications, direct discovery of resources is not
practical due to sleeping nodes or networks where multicast traffic
is inefficient. These problems can be solved by employing an entity called
a Resource Directory (RD), which contains information about resources held on
other servers, allowing lookups to be performed for those resources. The input to an RD is composed of links, and the output is composed of links constructed from the information stored in the RD. This
document specifies the web interfaces that an RD supports for web servers to discover the RD and to register, maintain, look up,
and remove information on resources. Furthermore, new target attributes useful
in conjunction with an RD are defined.<a href="#section-abstract-1" class="pilcrow">¶</a></p>
</section>
<div id="status-of-memo">
<section id="section-boilerplate.1">
<h2 id="name-status-of-this-memo">
<a href="#name-status-of-this-memo" class="section-name selfRef">Status of This Memo</a>
</h2>
<p id="section-boilerplate.1-1">
This is an Internet Standards Track document.<a href="#section-boilerplate.1-1" class="pilcrow">¶</a></p>
<p id="section-boilerplate.1-2">
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 Section 2 of
RFC 7841.<a href="#section-boilerplate.1-2" class="pilcrow">¶</a></p>
<p id="section-boilerplate.1-3">
Information about the current status of this document, any
errata, and how to provide feedback on it may be obtained at
<span><a href="https://www.rfc-editor.org/info/rfc9176">https://www.rfc-editor.org/info/rfc9176</a></span>.<a href="#section-boilerplate.1-3" class="pilcrow">¶</a></p>
</section>
</div>
<div id="copyright">
<section id="section-boilerplate.2">
<h2 id="name-copyright-notice">
<a href="#name-copyright-notice" class="section-name selfRef">Copyright Notice</a>
</h2>
<p id="section-boilerplate.2-1">
Copyright (c) 2022 IETF Trust and the persons identified as the
document authors. All rights reserved.<a href="#section-boilerplate.2-1" class="pilcrow">¶</a></p>
<p id="section-boilerplate.2-2">
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(<span><a href="https://trustee.ietf.org/license-info">https://trustee.ietf.org/license-info</a></span>) 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 Revised BSD License text as described in
Section 4.e of the Trust Legal Provisions and are provided without
warranty as described in the Revised BSD License.<a href="#section-boilerplate.2-2" class="pilcrow">¶</a></p>
</section>
</div>
<div id="toc">
<section id="section-toc.1">
<a href="#" onclick="scroll(0,0)" class="toplink">▲</a><h2 id="name-table-of-contents">
<a href="#name-table-of-contents" class="section-name selfRef">Table of Contents</a>
</h2>
<nav class="toc"><ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.1">
<p id="section-toc.1-1.1.1" class="keepWithNext"><a href="#section-1" class="xref">1</a>. <a href="#name-introduction" class="xref">Introduction</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2">
<p id="section-toc.1-1.2.1" class="keepWithNext"><a href="#section-2" class="xref">2</a>. <a href="#name-terminology" class="xref">Terminology</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.3">
<p id="section-toc.1-1.3.1"><a href="#section-3" class="xref">3</a>. <a href="#name-architecture-and-use-cases" class="xref">Architecture and Use Cases</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.3.2.1">
<p id="section-toc.1-1.3.2.1.1" class="keepWithNext"><a href="#section-3.1" class="xref">3.1</a>. <a href="#name-principles" class="xref">Principles</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.3.2.2">
<p id="section-toc.1-1.3.2.2.1"><a href="#section-3.2" class="xref">3.2</a>. <a href="#name-architecture" class="xref">Architecture</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.3.2.3">
<p id="section-toc.1-1.3.2.3.1"><a href="#section-3.3" class="xref">3.3</a>. <a href="#name-rd-content-model" class="xref">RD Content Model</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.3.2.4">
<p id="section-toc.1-1.3.2.4.1"><a href="#section-3.4" class="xref">3.4</a>. <a href="#name-link-local-addresses-and-zo" class="xref">Link-Local Addresses and Zone Identifiers</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.3.2.5">
<p id="section-toc.1-1.3.2.5.1"><a href="#section-3.5" class="xref">3.5</a>. <a href="#name-use-case-cellular-m2m" class="xref">Use Case: Cellular M2M</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.3.2.6">
<p id="section-toc.1-1.3.2.6.1"><a href="#section-3.6" class="xref">3.6</a>. <a href="#name-use-case-home-and-building-" class="xref">Use Case: Home and Building Automation</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.3.2.7">
<p id="section-toc.1-1.3.2.7.1"><a href="#section-3.7" class="xref">3.7</a>. <a href="#name-use-case-link-catalogues" class="xref">Use Case: Link Catalogues</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.4">
<p id="section-toc.1-1.4.1"><a href="#section-4" class="xref">4</a>. <a href="#name-rd-discovery-and-other-inte" class="xref">RD Discovery and Other Interface-Independent Components</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.4.2.1">
<p id="section-toc.1-1.4.2.1.1"><a href="#section-4.1" class="xref">4.1</a>. <a href="#name-finding-a-resource-director" class="xref">Finding a Resource Directory</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.4.2.1.2.1">
<p id="section-toc.1-1.4.2.1.2.1.1"><a href="#section-4.1.1" class="xref">4.1.1</a>. <a href="#name-resource-directory-address-" class="xref">Resource Directory Address Option (RDAO)</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.4.2.1.2.2">
<p id="section-toc.1-1.4.2.1.2.2.1"><a href="#section-4.1.2" class="xref">4.1.2</a>. <a href="#name-using-dns-sd-to-discover-a-" class="xref">Using DNS-SD to Discover a Resource Directory</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.4.2.2">
<p id="section-toc.1-1.4.2.2.1"><a href="#section-4.2" class="xref">4.2</a>. <a href="#name-payload-content-formats" class="xref">Payload Content Formats</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.4.2.3">
<p id="section-toc.1-1.4.2.3.1"><a href="#section-4.3" class="xref">4.3</a>. <a href="#name-uri-discovery" class="xref">URI Discovery</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.5">
<p id="section-toc.1-1.5.1"><a href="#section-5" class="xref">5</a>. <a href="#name-registration" class="xref">Registration</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.5.2.1">
<p id="section-toc.1-1.5.2.1.1"><a href="#section-5.1" class="xref">5.1</a>. <a href="#name-simple-registration" class="xref">Simple Registration</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.5.2.2">
<p id="section-toc.1-1.5.2.2.1"><a href="#section-5.2" class="xref">5.2</a>. <a href="#name-third-party-registration" class="xref">Third-Party Registration</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.5.2.3">
<p id="section-toc.1-1.5.2.3.1"><a href="#section-5.3" class="xref">5.3</a>. <a href="#name-operations-on-the-registrat" class="xref">Operations on the Registration Resource</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.5.2.3.2.1">
<p id="section-toc.1-1.5.2.3.2.1.1"><a href="#section-5.3.1" class="xref">5.3.1</a>. <a href="#name-registration-update" class="xref">Registration Update</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.5.2.3.2.2">
<p id="section-toc.1-1.5.2.3.2.2.1"><a href="#section-5.3.2" class="xref">5.3.2</a>. <a href="#name-registration-removal" class="xref">Registration Removal</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.5.2.3.2.3">
<p id="section-toc.1-1.5.2.3.2.3.1"><a href="#section-5.3.3" class="xref">5.3.3</a>. <a href="#name-further-operations" class="xref">Further Operations</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.5.2.3.2.4">
<p id="section-toc.1-1.5.2.3.2.4.1"><a href="#section-5.3.4" class="xref">5.3.4</a>. <a href="#name-request-freshness" class="xref">Request Freshness</a></p>
</li>
</ul>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.6">
<p id="section-toc.1-1.6.1"><a href="#section-6" class="xref">6</a>. <a href="#name-rd-lookup" class="xref">RD Lookup</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.6.2.1">
<p id="section-toc.1-1.6.2.1.1"><a href="#section-6.1" class="xref">6.1</a>. <a href="#name-resource-lookup" class="xref">Resource Lookup</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.6.2.2">
<p id="section-toc.1-1.6.2.2.1"><a href="#section-6.2" class="xref">6.2</a>. <a href="#name-lookup-filtering" class="xref">Lookup Filtering</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.6.2.3">
<p id="section-toc.1-1.6.2.3.1"><a href="#section-6.3" class="xref">6.3</a>. <a href="#name-resource-lookup-examples" class="xref">Resource Lookup Examples</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.6.2.4">
<p id="section-toc.1-1.6.2.4.1"><a href="#section-6.4" class="xref">6.4</a>. <a href="#name-endpoint-lookup" class="xref">Endpoint Lookup</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.7">
<p id="section-toc.1-1.7.1"><a href="#section-7" class="xref">7</a>. <a href="#name-security-policies" class="xref">Security Policies</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.7.2.1">
<p id="section-toc.1-1.7.2.1.1"><a href="#section-7.1" class="xref">7.1</a>. <a href="#name-endpoint-name" class="xref">Endpoint Name</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.7.2.1.2.1">
<p id="section-toc.1-1.7.2.1.2.1.1"><a href="#section-7.1.1" class="xref">7.1.1</a>. <a href="#name-random-endpoint-names" class="xref">Random Endpoint Names</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.7.2.2">
<p id="section-toc.1-1.7.2.2.1"><a href="#section-7.2" class="xref">7.2</a>. <a href="#name-entered-links" class="xref">Entered Links</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.7.2.3">
<p id="section-toc.1-1.7.2.3.1"><a href="#section-7.3" class="xref">7.3</a>. <a href="#name-link-confidentiality" class="xref">Link Confidentiality</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.7.2.4">
<p id="section-toc.1-1.7.2.4.1"><a href="#section-7.4" class="xref">7.4</a>. <a href="#name-segmentation" class="xref">Segmentation</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.7.2.5">
<p id="section-toc.1-1.7.2.5.1"><a href="#section-7.5" class="xref">7.5</a>. <a href="#name-first-come-first-remembered" class="xref">"First Come First Remembered": A Default Policy</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.8">
<p id="section-toc.1-1.8.1"><a href="#section-8" class="xref">8</a>. <a href="#name-security-considerations" class="xref">Security Considerations</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.8.2.1">
<p id="section-toc.1-1.8.2.1.1"><a href="#section-8.1" class="xref">8.1</a>. <a href="#name-discovery" class="xref">Discovery</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.8.2.2">
<p id="section-toc.1-1.8.2.2.1"><a href="#section-8.2" class="xref">8.2</a>. <a href="#name-endpoint-identification-and" class="xref">Endpoint Identification and Authentication</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.8.2.3">
<p id="section-toc.1-1.8.2.3.1"><a href="#section-8.3" class="xref">8.3</a>. <a href="#name-access-control" class="xref">Access Control</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.8.2.4">
<p id="section-toc.1-1.8.2.4.1"><a href="#section-8.4" class="xref">8.4</a>. <a href="#name-denial-of-service-attacks" class="xref">Denial-of-Service Attacks</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.8.2.5">
<p id="section-toc.1-1.8.2.5.1"><a href="#section-8.5" class="xref">8.5</a>. <a href="#name-skipping-freshness-checks" class="xref">Skipping Freshness Checks</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.9">
<p id="section-toc.1-1.9.1"><a href="#section-9" class="xref">9</a>. <a href="#name-iana-considerations" class="xref">IANA Considerations</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.9.2.1">
<p id="section-toc.1-1.9.2.1.1"><a href="#section-9.1" class="xref">9.1</a>. <a href="#name-resource-types" class="xref">Resource Types</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.9.2.2">
<p id="section-toc.1-1.9.2.2.1"><a href="#section-9.2" class="xref">9.2</a>. <a href="#name-ipv6-nd-resource-directory-" class="xref">IPv6 ND Resource Directory Address Option</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.9.2.3">
<p id="section-toc.1-1.9.2.3.1"><a href="#section-9.3" class="xref">9.3</a>. <a href="#name-rd-parameters-registry" class="xref">RD Parameters Registry</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.9.2.3.2.1">
<p id="section-toc.1-1.9.2.3.2.1.1"><a href="#section-9.3.1" class="xref">9.3.1</a>. <a href="#name-full-description-of-the-end" class="xref">Full Description of the "Endpoint Type" RD Parameter</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.9.2.4">
<p id="section-toc.1-1.9.2.4.1"><a href="#section-9.4" class="xref">9.4</a>. <a href="#name-endpoint-type-et-rd-paramet" class="xref">Endpoint Type (et=) RD Parameter Values</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.9.2.5">
<p id="section-toc.1-1.9.2.5.1"><a href="#section-9.5" class="xref">9.5</a>. <a href="#name-multicast-address-registrat" class="xref">Multicast Address Registration</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.9.2.6">
<p id="section-toc.1-1.9.2.6.1"><a href="#section-9.6" class="xref">9.6</a>. <a href="#name-well-known-uris" class="xref">Well-Known URIs</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.9.2.7">
<p id="section-toc.1-1.9.2.7.1"><a href="#section-9.7" class="xref">9.7</a>. <a href="#name-service-name-and-transport-" class="xref">Service Name and Transport Protocol Port Number Registry</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.10">
<p id="section-toc.1-1.10.1"><a href="#section-10" class="xref">10</a>. <a href="#name-examples" class="xref">Examples</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.10.2.1">
<p id="section-toc.1-1.10.2.1.1"><a href="#section-10.1" class="xref">10.1</a>. <a href="#name-lighting-installation" class="xref">Lighting Installation</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.10.2.1.2.1">
<p id="section-toc.1-1.10.2.1.2.1.1"><a href="#section-10.1.1" class="xref">10.1.1</a>. <a href="#name-installation-characteristic" class="xref">Installation Characteristics</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.10.2.1.2.2">
<p id="section-toc.1-1.10.2.1.2.2.1"><a href="#section-10.1.2" class="xref">10.1.2</a>. <a href="#name-rd-entries" class="xref">RD Entries</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.10.2.2">
<p id="section-toc.1-1.10.2.2.1"><a href="#section-10.2" class="xref">10.2</a>. <a href="#name-oma-lightweight-m2m-lwm2m" class="xref">OMA Lightweight M2M (LwM2M)</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.11">
<p id="section-toc.1-1.11.1"><a href="#section-11" class="xref">11</a>. <a href="#name-references" class="xref">References</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.11.2.1">
<p id="section-toc.1-1.11.2.1.1"><a href="#section-11.1" class="xref">11.1</a>. <a href="#name-normative-references" class="xref">Normative References</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.11.2.2">
<p id="section-toc.1-1.11.2.2.1"><a href="#section-11.2" class="xref">11.2</a>. <a href="#name-informative-references" class="xref">Informative References</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.12">
<p id="section-toc.1-1.12.1"><a href="#appendix-A" class="xref">Appendix A</a>. <a href="#name-groups-registration-and-loo" class="xref">Groups Registration and Lookup</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.13">
<p id="section-toc.1-1.13.1"><a href="#appendix-B" class="xref">Appendix B</a>. <a href="#name-web-links-and-the-resource-" class="xref">Web Links and the Resource Directory</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.13.2.1">
<p id="section-toc.1-1.13.2.1.1"><a href="#appendix-B.1" class="xref">B.1</a>. <a href="#name-a-simple-example" class="xref">A Simple Example</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.13.2.1.2.1">
<p id="section-toc.1-1.13.2.1.2.1.1"><a href="#appendix-B.1.1" class="xref">B.1.1</a>. <a href="#name-resolving-the-uris" class="xref">Resolving the URIs</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.13.2.1.2.2">
<p id="section-toc.1-1.13.2.1.2.2.1"><a href="#appendix-B.1.2" class="xref">B.1.2</a>. <a href="#name-interpreting-attributes-and" class="xref">Interpreting Attributes and Relations</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.13.2.2">
<p id="section-toc.1-1.13.2.2.1"><a href="#appendix-B.2" class="xref">B.2</a>. <a href="#name-a-slightly-more-complex-exa" class="xref">A Slightly More Complex Example</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.13.2.3">
<p id="section-toc.1-1.13.2.3.1"><a href="#appendix-B.3" class="xref">B.3</a>. <a href="#name-enter-the-resource-director" class="xref">Enter the Resource Directory</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.13.2.4">
<p id="section-toc.1-1.13.2.4.1"><a href="#appendix-B.4" class="xref">B.4</a>. <a href="#name-a-note-on-differences-betwe" class="xref">A Note on Differences between Link-Format and Link Header Fields</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.14">
<p id="section-toc.1-1.14.1"><a href="#appendix-C" class="xref">Appendix C</a>. <a href="#name-limited-link-format" class="xref">Limited Link Format</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.15">
<p id="section-toc.1-1.15.1"><a href="#appendix-D" class="xref"></a><a href="#name-acknowledgments" class="xref">Acknowledgments</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.16">
<p id="section-toc.1-1.16.1"><a href="#appendix-E" class="xref"></a><a href="#name-authors-addresses" class="xref">Authors' Addresses</a></p>
</li>
</ul>
</nav>
</section>
</div>
<div id="introduction">
<section id="section-1">
<h2 id="name-introduction">
<a href="#section-1" class="section-number selfRef">1. </a><a href="#name-introduction" class="section-name selfRef">Introduction</a>
</h2>
<p id="section-1-1">In the work on Constrained RESTful Environments (CoRE), a Representational State Transfer (REST) architecture
suitable for constrained nodes (e.g., with limited RAM and ROM <span>[<a href="#RFC7228" class="xref">RFC7228</a>]</span>)
and networks (e.g., IPv6 over Low-Power Wireless Personal Area Network (6LoWPAN) <span>[<a href="#RFC4944" class="xref">RFC4944</a>]</span>)
has been established and is used in
Internet of Things (IoT) or
machine-to-machine (M2M) applications, such as smart energy
and building automation.<a href="#section-1-1" class="pilcrow">¶</a></p>
<p id="section-1-2">The discovery of resources offered by a constrained server is very important
in machine-to-machine applications where there are no humans in the loop and
static interfaces result in fragility. The discovery of resources provided by
an HTTP web server is typically called web linking <span>[<a href="#RFC8288" class="xref">RFC8288</a>]</span>. The use of
web linking for the description and discovery of resources hosted by
constrained web servers is specified by the CoRE Link Format
<span>[<a href="#RFC6690" class="xref">RFC6690</a>]</span>. However, <span>[<a href="#RFC6690" class="xref">RFC6690</a>]</span> only describes how to discover
resources from the web server that hosts them by querying
<code>/.well-known/core</code>. In many constrained scenarios, direct discovery of resources is
not practical due to sleeping nodes or networks where
multicast traffic is inefficient. These problems can be solved by employing
an entity called a Resource Directory (RD), which contains information about resources held on
other servers, allowing lookups to be performed for those resources.<a href="#section-1-2" class="pilcrow">¶</a></p>
<p id="section-1-3">This document specifies the web interfaces that an RD supports for web servers to discover the RD and to register, maintain, look up,
and remove information on resources. Furthermore, new target attributes useful in
conjunction with an RD are defined. Although the examples in
this document show the use of these interfaces with the Constrained Application Protocol (CoAP) <span>[<a href="#RFC7252" class="xref">RFC7252</a>]</span>, they
can be applied in an equivalent manner to HTTP <span>[<a href="#RFC7230" class="xref">RFC7230</a>]</span>.<a href="#section-1-3" class="pilcrow">¶</a></p>
</section>
</div>
<div id="terminology">
<section id="section-2">
<h2 id="name-terminology">
<a href="#section-2" class="section-number selfRef">2. </a><a href="#name-terminology" class="section-name selfRef">Terminology</a>
</h2>
<p id="section-2-1">The key words "<span class="bcp14">MUST</span>", "<span class="bcp14">MUST NOT</span>", "<span class="bcp14">REQUIRED</span>", "<span class="bcp14">SHALL</span>", "<span class="bcp14">SHALL NOT</span>",
"<span class="bcp14">SHOULD</span>", "<span class="bcp14">SHOULD NOT</span>", "<span class="bcp14">RECOMMENDED</span>", "<span class="bcp14">NOT RECOMMENDED</span>", "<span class="bcp14">MAY</span>", and "<span class="bcp14">OPTIONAL</span>"
in this
document are to be interpreted as described in BCP 14 <span>[<a href="#RFC2119" class="xref">RFC2119</a>]</span> <span>[<a href="#RFC8174" class="xref">RFC8174</a>]</span>
when, and only when, they appear in all capitals, as shown here.<a href="#section-2-1" class="pilcrow">¶</a></p>
<p id="section-2-2">The term "byte" is used in its now customary sense as a synonym for "octet".<a href="#section-2-2" class="pilcrow">¶</a></p>
<p id="section-2-3">This specification requires readers to be familiar with all the terms and
concepts that are discussed in <span>[<a href="#RFC3986" class="xref">RFC3986</a>]</span>, <span>[<a href="#RFC8288" class="xref">RFC8288</a>]</span>, and <span>[<a href="#RFC6690" class="xref">RFC6690</a>]</span>. Readers should
also be familiar with the terms and concepts discussed in <span>[<a href="#RFC7252" class="xref">RFC7252</a>]</span>. To
describe the REST interfaces defined in this specification, the URI Template
format is used <span>[<a href="#RFC6570" class="xref">RFC6570</a>]</span>.<a href="#section-2-3" class="pilcrow">¶</a></p>
<p id="section-2-4">This specification makes use of the following additional terminology:<a href="#section-2-4" class="pilcrow">¶</a></p>
<span class="break"></span><dl class="dlNewline" id="section-2-5">
<dt id="section-2-5.1">Resolve Against</dt>
<dd style="margin-left: 1.5em" id="section-2-5.2">The expression "a URI reference is <em>resolved against</em> a base URI" is used
to describe the process of <span>[<a href="#RFC3986" class="xref">RFC3986</a>], <a href="https://www.rfc-editor.org/rfc/rfc3986#section-5.2" class="relref">Section 5.2</a></span>.
Noteworthy corner cases include the following: (1) if the URI reference is a (full)
URI, resolving against any base URI gives the original
full URI and (2) resolving an empty URI reference gives the base
URI without any fragment identifier.<a href="#section-2-5.2" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-2-5.3">Resource Directory (RD)</dt>
<dd style="margin-left: 1.5em" id="section-2-5.4">
<p id="section-2-5.4.1">A web entity that stores information about web resources and
implements the REST interfaces defined in this specification for
discovery, for the creation, maintenance, and removal of
registrations, and for lookup of the registered resources.<a href="#section-2-5.4.1" class="pilcrow">¶</a></p>
</dd>
<dd class="break"></dd>
<dt id="section-2-5.5">Sector</dt>
<dd style="margin-left: 1.5em" id="section-2-5.6">
<p id="section-2-5.6.1">In the context of an RD, a sector is a logical grouping of endpoints.<a href="#section-2-5.6.1" class="pilcrow">¶</a></p>
<p id="section-2-5.6.2">The abbreviation "d=" is used for the sector in query parameters for
compatibility with deployed implementations.<a href="#section-2-5.6.2" class="pilcrow">¶</a></p>
</dd>
<dd class="break"></dd>
<dt id="section-2-5.7">Endpoint (EP)</dt>
<dd style="margin-left: 1.5em" id="section-2-5.8">
<p id="section-2-5.8.1">Endpoint (EP) is a term used to describe a web server or client
in <span>[<a href="#RFC7252" class="xref">RFC7252</a>]</span>. In the context of
this specification, an endpoint is used to describe a web server
that registers resources to the RD. An endpoint is identified by its
endpoint name, which is included during registration, and has a
unique name within the associated sector of the registration.<a href="#section-2-5.8.1" class="pilcrow">¶</a></p>
</dd>
<dd class="break"></dd>
<dt id="section-2-5.9">Registration Base URI</dt>
<dd style="margin-left: 1.5em" id="section-2-5.10">
<p id="section-2-5.10.1">The base URI of a registration is a URI that typically gives scheme and
authority information about an endpoint. The registration base URI is provided at
registration time and is used by the RD to
resolve relative references of the registration into URIs.<a href="#section-2-5.10.1" class="pilcrow">¶</a></p>
</dd>
<dd class="break"></dd>
<dt id="section-2-5.11">Target</dt>
<dd style="margin-left: 1.5em" id="section-2-5.12">
<p id="section-2-5.12.1">The target of a link is the destination address (URI) of the link. It is
sometimes identified with "href=" or displayed as <code><target></code>.
Relative targets need resolving with respect to the base URI (<span><a href="https://www.rfc-editor.org/rfc/rfc3986#section-5.2" class="relref">Section 5.2</a> of [<a href="#RFC3986" class="xref">RFC3986</a>]</span>).<a href="#section-2-5.12.1" class="pilcrow">¶</a></p>
<p id="section-2-5.12.2">This use of the term "target" is consistent with the use in <span>[<a href="#RFC8288" class="xref">RFC8288</a>]</span>.<a href="#section-2-5.12.2" class="pilcrow">¶</a></p>
</dd>
<dd class="break"></dd>
<dt id="section-2-5.13">Context</dt>
<dd style="margin-left: 1.5em" id="section-2-5.14">
<p id="section-2-5.14.1">The context of a link is the source address (URI) of the link
and describes which resource is linked to the target.
A link's context is made explicit in serialized links as the "anchor=" attribute.<a href="#section-2-5.14.1" class="pilcrow">¶</a></p>
<p id="section-2-5.14.2">This use of the term "context" is consistent with the use in <span>[<a href="#RFC8288" class="xref">RFC8288</a>]</span>.<a href="#section-2-5.14.2" class="pilcrow">¶</a></p>
</dd>
<dd class="break"></dd>
<dt id="section-2-5.15">Directory Resource</dt>
<dd style="margin-left: 1.5em" id="section-2-5.16">
<p id="section-2-5.16.1">A directory resource is a resource in the RD containing registration resources.<a href="#section-2-5.16.1" class="pilcrow">¶</a></p>
</dd>
<dd class="break"></dd>
<dt id="section-2-5.17">Registration Resource</dt>
<dd style="margin-left: 1.5em" id="section-2-5.18">
<p id="section-2-5.18.1">A registration resource is a resource in the RD that contains information about an
endpoint and its links.<a href="#section-2-5.18.1" class="pilcrow">¶</a></p>
</dd>
<dd class="break"></dd>
<dt id="section-2-5.19">Commissioning Tool (CT)</dt>
<dd style="margin-left: 1.5em" id="section-2-5.20">
<p id="section-2-5.20.1">A Commissioning Tool (CT) is a device that assists during installation events
by assigning values to parameters, naming endpoints and groups, or adapting
the installation to the needs of the applications.<a href="#section-2-5.20.1" class="pilcrow">¶</a></p>
</dd>
<dd class="break"></dd>
<dt id="section-2-5.21">Registrant-EP</dt>
<dd style="margin-left: 1.5em" id="section-2-5.22">
<p id="section-2-5.22.1">A registrant-EP is the endpoint that is registered into the RD. The registrant-EP can
register itself, or a CT registers the registrant-EP.<a href="#section-2-5.22.1" class="pilcrow">¶</a></p>
</dd>
<dd class="break"></dd>
<dt id="section-2-5.23">Resource Directory Address Option (RDAO)</dt>
<dd style="margin-left: 1.5em" id="section-2-5.24">
<p id="section-2-5.24.1">A Resource Directory Address Option (RDAO) is a new IPv6 Neighbor Discovery option defined
for announcing an RD's address.<a href="#section-2-5.24.1" class="pilcrow">¶</a></p>
</dd>
<dd class="break"></dd>
</dl>
</section>
</div>
<div id="arch">
<section id="section-3">
<h2 id="name-architecture-and-use-cases">
<a href="#section-3" class="section-number selfRef">3. </a><a href="#name-architecture-and-use-cases" class="section-name selfRef">Architecture and Use Cases</a>
</h2>
<div id="principles">
<section id="section-3.1">
<h3 id="name-principles">
<a href="#section-3.1" class="section-number selfRef">3.1. </a><a href="#name-principles" class="section-name selfRef">Principles</a>
</h3>
<p id="section-3.1-1">The RD is primarily a tool to make discovery operations more
efficient than querying <code>/.well-known/core</code> on all connected devices or across
boundaries that would limit those operations.<a href="#section-3.1-1" class="pilcrow">¶</a></p>
<p id="section-3.1-2">It provides information about resources hosted by other devices that could otherwise only be obtained by
directly querying the <code>/.well-known/core</code> resource on these other devices, either by a unicast request or a multicast request.<a href="#section-3.1-2" class="pilcrow">¶</a></p>
<p id="section-3.1-3">Information <span class="bcp14">SHOULD</span> only be stored in the RD
if it can be obtained by querying the described device's
<code>/.well-known/core</code> resource directly.<a href="#section-3.1-3" class="pilcrow">¶</a></p>
<p id="section-3.1-4">Data in the RD can only be provided by the
device that hosts the data or a dedicated Commissioning Tool (CT).
These CTs act on behalf of endpoints too constrained, or generally
unable, to present that information themselves. No other client can modify data
in the RD. Changes to the information in the RD do not propagate automatically back to the web servers from where the information originated.<a href="#section-3.1-4" class="pilcrow">¶</a></p>
</section>
</div>
<div id="architecture">
<section id="section-3.2">
<h3 id="name-architecture">
<a href="#section-3.2" class="section-number selfRef">3.2. </a><a href="#name-architecture" class="section-name selfRef">Architecture</a>
</h3>
<p id="section-3.2-1">The RD architecture is illustrated in <a href="#fig-arch" class="xref">Figure 1</a>. An
RD is used as a repository of registrations
describing resources hosted on other web servers, also called endpoints
(EPs).
An endpoint is a web server associated with a scheme, IP address, and port. A physical node may host one or more endpoints. The
RD implements a set of REST interfaces for endpoints to register and maintain
RD registrations and for endpoints to
look up resources from the RD. An RD can be logically segmented by the use of sectors.<a href="#section-3.2-1" class="pilcrow">¶</a></p>
<p id="section-3.2-2">A mechanism to discover an RD using CoRE Link Format <span>[<a href="#RFC6690" class="xref">RFC6690</a>]</span> is defined.<a href="#section-3.2-2" class="pilcrow">¶</a></p>
<p id="section-3.2-3">Registrations in the RD are soft state and need to be periodically refreshed.<a href="#section-3.2-3" class="pilcrow">¶</a></p>
<p id="section-3.2-4">An endpoint uses specific interfaces to register, update, and remove a registration. It is also possible for an RD to fetch web links
from endpoints and add their contents to its registrations.<a href="#section-3.2-4" class="pilcrow">¶</a></p>
<p id="section-3.2-5">At the first registration of an endpoint, a "registration resource" is created,
the location of which is returned to the registering endpoint. The registering
endpoint uses this registration resource to manage the contents of registrations.<a href="#section-3.2-5" class="pilcrow">¶</a></p>
<p id="section-3.2-6">A lookup interface for discovering any of the web links stored in the RD is
provided using the CoRE Link Format.<a href="#section-3.2-6" class="pilcrow">¶</a></p>
<span id="name-the-rd-architecture"></span><div id="fig-arch">
<figure id="figure-1">
<div class="alignLeft art-ascii-art art-text artwork" id="section-3.2-7.1">
<pre>
Registration Lookup
Interface Interface
+----+ | |
| EP |---- | |
+----+ ---- | |
--|- +------+ |
+----+ | ----| | | +--------+
| EP | ---------|-----| RD |----|-----| Client |
+----+ | ----| | | +--------+
--|- +------+ |
+----+ ---- | |
| CT |---- | |
+----+
</pre>
</div>
<figcaption><a href="#figure-1" class="selfRef">Figure 1</a>:
<a href="#name-the-rd-architecture" class="selfRef">The RD Architecture</a>
</figcaption></figure>
</div>
<p id="section-3.2-8">A registrant-EP <span class="bcp14">MAY</span> keep concurrent registrations to more than one RD at the same time
if explicitly configured to do so,
but that is not expected to be supported by typical EP implementations.
Any such registrations are independent of each other.
The usual expectation when multiple discovery mechanisms or addresses are configured
is that they constitute a fall-back path for a single registration.<a href="#section-3.2-8" class="pilcrow">¶</a></p>
</section>
</div>
<div id="ER-model">
<section id="section-3.3">
<h3 id="name-rd-content-model">
<a href="#section-3.3" class="section-number selfRef">3.3. </a><a href="#name-rd-content-model" class="section-name selfRef">RD Content Model</a>
</h3>
<p id="section-3.3-1">The Entity-Relationship (ER) models shown in Figures <a href="#fig-ER-WKC" class="xref">2</a> and <a href="#fig-ER-RD" class="xref">3</a> model the contents of <code>/.well-known/core</code> and the RD respectively, with entity-relationship diagrams <span>[<a href="#ER" class="xref">ER</a>]</span>. Entities (rectangles) are used for concepts that exist independently. Attributes (ovals) are used for concepts that exist only in connection with a related entity. Relations (diamonds) give a semantic meaning to the relation between entities. Numbers specify the cardinality of the relations.<a href="#section-3.3-1" class="pilcrow">¶</a></p>
<p id="section-3.3-2">Some of the attribute values are URIs. Those values are always full URIs and never relative references in the information model.
However, they can be expressed as relative references in serializations, and they often are.<a href="#section-3.3-2" class="pilcrow">¶</a></p>
<p id="section-3.3-3">These models provide an abstract view of the information expressed in link-format documents and an RD. They cover the concepts but not necessarily all details of an RD's operation; they are meant to give an overview and not be a template for implementations.<a href="#section-3.3-3" class="pilcrow">¶</a></p>
<span id="name-er-model-of-the-content-of-"></span><div id="fig-ER-WKC">
<figure id="figure-2">
<div class="alignLeft art-ascii-art art-text artwork" id="section-3.3-4.1">
<pre>
+----------------------+
| /.well-known/core |
+----------------------+
|
| 1
////////\\\\\\\
< contains >
\\\\\\\\///////
|
| 0+
+--------------------+
| link |
+--------------------+
|
| 1 oooooooo
+-----o target o
| oooooooo
oooooooooooo 0+ |
o target o--------+
o attribute o | 0+ oooooo
oooooooooooo +-----o rel o
| oooooo
|
| 1 ooooooooo
+-----o context o
ooooooooo
</pre>
</div>
<figcaption><a href="#figure-2" class="selfRef">Figure 2</a>:
<a href="#name-er-model-of-the-content-of-" class="selfRef">ER Model of the Content of <code>/.well-known/core</code></a>
</figcaption></figure>
</div>
<p id="section-3.3-5"><a href="#fig-ER-WKC" class="xref">Figure 2</a> models the contents of
<code>/.well-known/core</code>, which contains a set of links belonging to the hosting web server.<a href="#section-3.3-5" class="pilcrow">¶</a></p>
<p id="section-3.3-6">The web server is free to choose links it deems appropriate to be exposed in its <code>/.well-known/core</code>.
Typically, the links describe resources that are served by the host, but the set can also contain links to resources on other servers (see examples in <span><a href="https://www.rfc-editor.org/rfc/rfc6690#section-5" class="relref">Section 5</a> of [<a href="#RFC6690" class="xref">RFC6690</a>]</span>).
The set does not necessarily contain links to all resources served by the host.<a href="#section-3.3-6" class="pilcrow">¶</a></p>
<p id="section-3.3-7">A link has the following attributes (see <span><a href="https://www.rfc-editor.org/rfc/rfc8288#section-5" class="relref">Section 5</a> of [<a href="#RFC8288" class="xref">RFC8288</a>]</span>):<a href="#section-3.3-7" class="pilcrow">¶</a></p>
<ul class="normal">
<li class="normal" id="section-3.3-8.1">
<p id="section-3.3-8.1.1">Zero or more link relations:
They describe relations between the link context and the link target.<a href="#section-3.3-8.1.1" class="pilcrow">¶</a></p>
<p id="section-3.3-8.1.2">In link-format serialization, they are expressed as space-separated values in the
"rel" attribute and default to "hosts".<a href="#section-3.3-8.1.2" class="pilcrow">¶</a></p>
</li>
<li class="normal" id="section-3.3-8.2">
<p id="section-3.3-8.2.1">A link context URI: It defines the source of the relation, e.g., <em>who</em> "hosts" something.<a href="#section-3.3-8.2.1" class="pilcrow">¶</a></p>
<p id="section-3.3-8.2.2">In link-format serialization, it is expressed in the "anchor" attribute and defaults
to the Origin of the target (practically, the target with its path and later components
removed).<a href="#section-3.3-8.2.2" class="pilcrow">¶</a></p>
</li>
<li class="normal" id="section-3.3-8.3">
<p id="section-3.3-8.3.1">A link target URI: It defines the destination of the relation (e.g., <em>what</em> is hosted) and is
the topic of all target attributes.<a href="#section-3.3-8.3.1" class="pilcrow">¶</a></p>
<p id="section-3.3-8.3.2">In link-format serialization, it is expressed between angular brackets and
sometimes called the "href".<a href="#section-3.3-8.3.2" class="pilcrow">¶</a></p>
</li>
<li class="normal" id="section-3.3-8.4">Other target attributes (e.g., resource type (rt), interface (if), or content format (ct)): These provide additional information about the target URI.<a href="#section-3.3-8.4" class="pilcrow">¶</a>
</li>
</ul>
<span id="name-er-model-of-the-content-of-t"></span><div id="fig-ER-RD">
<figure id="figure-3">
<div class="alignLeft art-ascii-art art-text artwork" id="section-3.3-9.1">
<pre>
+--------------+
+ RD +
+--------------+
| 1
|
|
|
|
//////\\\\
< contains >
\\\\\/////
|
0+ |
ooooooo 1 +---------------+
o base o-------| registration |
ooooooo +---------------+
| | 1
| +--------------+
oooooooo 1 | |
o href o----+ /////\\\\
oooooooo | < contains >
| \\\\\/////
oooooooo 1 | |
o ep o----+ | 0+
oooooooo | +------------------+
| | link |
oooooooo 0-1 | +------------------+
o d o----+ |
oooooooo | | 1 oooooooo
| +-----o target o
oooooooo 1 | | oooooooo
o lt o----+ ooooooooooo 0+ |
oooooooo | o target o-----+
| o attribute o | 0+ oooooo
ooooooooooo 0+ | ooooooooooo +-----o rel o
o endpoint o----+ | oooooo
o attribute o |
ooooooooooo | 1 ooooooooo
+----o context o
ooooooooo
</pre>
</div>
<figcaption><a href="#figure-3" class="selfRef">Figure 3</a>:
<a href="#name-er-model-of-the-content-of-t" class="selfRef">ER Model of the Content of the RD</a>
</figcaption></figure>
</div>
<p id="section-3.3-10"><a href="#fig-ER-RD" class="xref">Figure 3</a> models the contents of
the RD, which contains, in addition to <code>/.well-known/core</code>, 0 to n registrations of
endpoints.<a href="#section-3.3-10" class="pilcrow">¶</a></p>
<p id="section-3.3-11">A registration is associated with one endpoint. A registration defines a set of links,
as defined for <code>/.well-known/core</code>. A registration has six types of attributes:<a href="#section-3.3-11" class="pilcrow">¶</a></p>
<ul class="normal">
<li class="normal" id="section-3.3-12.1">an endpoint name ("ep", a Unicode string) unique within a sector<a href="#section-3.3-12.1" class="pilcrow">¶</a>
</li>
<li class="normal" id="section-3.3-12.2">a registration base URI ("base", a URI typically describing the scheme://authority part)<a href="#section-3.3-12.2" class="pilcrow">¶</a>
</li>
<li class="normal" id="section-3.3-12.3">a lifetime ("lt")<a href="#section-3.3-12.3" class="pilcrow">¶</a>
</li>
<li class="normal" id="section-3.3-12.4">a registration resource location inside the RD ("href")<a href="#section-3.3-12.4" class="pilcrow">¶</a>
</li>
<li class="normal" id="section-3.3-12.5">optionally, a sector ("d", a Unicode string)<a href="#section-3.3-12.5" class="pilcrow">¶</a>
</li>
<li class="normal" id="section-3.3-12.6">optional additional endpoint attributes (from <a href="#iana-registry" class="xref">Section 9.3</a>)<a href="#section-3.3-12.6" class="pilcrow">¶</a>
</li>
</ul>
<p id="section-3.3-13">The cardinality of "base" is currently 1;
future documents are invited to extend the RD specification to support multiple values (e.g., <span>[<a href="#I-D.silverajan-core-coap-protocol-negotiation" class="xref">COAP-PROT-NEG</a>]</span>).
Its value is used as a base URI when resolving URIs in the links contained in the endpoint.<a href="#section-3.3-13" class="pilcrow">¶</a></p>
<p id="section-3.3-14">Links are modeled as they are in <a href="#fig-ER-WKC" class="xref">Figure 2</a>.<a href="#section-3.3-14" class="pilcrow">¶</a></p>
</section>
</div>
<div id="linklocal">
<section id="section-3.4">
<h3 id="name-link-local-addresses-and-zo">
<a href="#section-3.4" class="section-number selfRef">3.4. </a><a href="#name-link-local-addresses-and-zo" class="section-name selfRef">Link-Local Addresses and Zone Identifiers</a>
</h3>
<p id="section-3.4-1">Registration base URIs can contain link-local IP addresses.
To be usable across hosts, those cannot be serialized to
contain zone identifiers (see <span>[<a href="#RFC6874" class="xref">RFC6874</a>], <a href="https://www.rfc-editor.org/rfc/rfc6874#section-1" class="relref">Section 1</a></span>).<a href="#section-3.4-1" class="pilcrow">¶</a></p>
<p id="section-3.4-2">Link-local addresses can only be used on a single link
(therefore, RD servers cannot announce them when queried on a different link),
and lookup clients using them need to keep track of which interface they got them from.<a href="#section-3.4-2" class="pilcrow">¶</a></p>
<p id="section-3.4-3">Therefore, it is advisable in many scenarios
to use addresses with larger scopes, if available.<a href="#section-3.4-3" class="pilcrow">¶</a></p>
</section>
</div>
<div id="cellular">
<section id="section-3.5">
<h3 id="name-use-case-cellular-m2m">
<a href="#section-3.5" class="section-number selfRef">3.5. </a><a href="#name-use-case-cellular-m2m" class="section-name selfRef">Use Case: Cellular M2M</a>
</h3>
<p id="section-3.5-1">Over the last few years, mobile operators around the world
have focused on development of M2M solutions in order to
expand the business to the new type of users: machines. The
machines are connected directly to a mobile network using an appropriate
embedded wireless interface (GSM/General Packet Radio Service (GPRS), Wideband Code Division Multiple Access (W-CDMA), LTE, etc.) or via a gateway providing
short- and wide-range wireless interfaces.
The ambition in such systems is to build them from reusable components.
These speed up development and deployment
and enable shared use of machines across different applications.
One crucial component of such systems
is the discovery of resources (and thus the endpoints they are hosted on) capable of providing required
information at a given time or acting on instructions from the end users.<a href="#section-3.5-1" class="pilcrow">¶</a></p>
<p id="section-3.5-2">Imagine a scenario where endpoints installed on vehicles enable
tracking of the position of these vehicles for fleet management purposes and allow
monitoring of environment parameters. During the boot-up process,
endpoints register with an RD, which is hosted by the
mobile operator or somewhere in the cloud. Periodically, these endpoints
update their registration and may modify resources they offer.<a href="#section-3.5-2" class="pilcrow">¶</a></p>
<p id="section-3.5-3">When endpoints are not always connected, for example, because they enter
a sleep mode, a remote server is usually used to provide proxy access to
the endpoints. Mobile apps or web applications for environment monitoring contact the RD, look up the endpoints capable of providing information about the environment using an appropriate set of link parameters, obtain information on how to contact them (URLs of the proxy server), and then initiate interaction to obtain information that is finally processed, displayed on the screen, and usually stored in a database. Similarly, fleet management systems provide
the appropriate link parameters to the RD to look up for EPs deployed on
the vehicles the application is responsible for.<a href="#section-3.5-3" class="pilcrow">¶</a></p>
</section>
</div>
<div id="automation">
<section id="section-3.6">
<h3 id="name-use-case-home-and-building-">
<a href="#section-3.6" class="section-number selfRef">3.6. </a><a href="#name-use-case-home-and-building-" class="section-name selfRef">Use Case: Home and Building Automation</a>
</h3>
<p id="section-3.6-1">Home and commercial building automation systems can benefit from the use
of IoT web services. The discovery requirements of these applications are
demanding. Home automation usually relies on run-time discovery to commission
the system, whereas, in building automation, a combination of professional
commissioning and run-time discovery is used. Both home and building automation
involve peer-to-peer interactions between endpoints and involve battery-powered
sleeping devices.
Both can use the common RD infrastructure to establish device interactions efficiently
but can pick security policies suitable for their needs.<a href="#section-3.6-1" class="pilcrow">¶</a></p>
<p id="section-3.6-2">Two phases can be discerned for a network servicing the system: (1) installation and (2) operation. During the operational phase, the network is connected to the Internet with a border router (e.g., a 6LoWPAN Border Router (6LBR) <span>[<a href="#RFC6775" class="xref">RFC6775</a>]</span>), and the nodes connected to the network can use the Internet services that are provided by the IP or network administrator. During the installation phase, the network is completely stand-alone, no border router is connected, and the network only supports the IP communication between the connected nodes. The installation phase is usually followed by the operational phase.
As an RD's operations work without hard dependencies on names or addresses,
it can be used for discovery across both phases.<a href="#section-3.6-2" class="pilcrow">¶</a></p>
</section>
</div>
<div id="usecase-catalogues">
<section id="section-3.7">
<h3 id="name-use-case-link-catalogues">
<a href="#section-3.7" class="section-number selfRef">3.7. </a><a href="#name-use-case-link-catalogues" class="section-name selfRef">Use Case: Link Catalogues</a>
</h3>
<p id="section-3.7-1">Resources may be shared through data brokers that have no knowledge beforehand
of who is going to consume the data. An RD can be used to hold
links about resources and services hosted anywhere to make them discoverable
by a general class of applications.<a href="#section-3.7-1" class="pilcrow">¶</a></p>
<p id="section-3.7-2">For example, environmental and weather sensors that generate data for public
consumption may provide data to an intermediary server or broker. Sensor
data are published to the intermediary upon changes or at regular intervals.
Descriptions of the sensors that resolve to links to sensor data may be published
to an RD. Applications wishing to consume the data can use
RD lookup to discover and resolve links
to the desired resources and endpoints. The RD service need
not be coupled with the data intermediary service. Mapping of RDs
to data intermediaries may be many-to-many.<a href="#section-3.7-2" class="pilcrow">¶</a></p>
<p id="section-3.7-3">Metadata in web link formats, such as the one defined in <span>[<a href="#RFC6690" class="xref">RFC6690</a>]</span>, which may be internally stored as triples or relation/attribute
pairs providing metadata about resource links, need to be supported by RDs. External catalogues that are
represented in other formats may be converted to common web linking formats for
storage and access by RDs. Since it is common practice for these
to be encoded in URNs <span>[<a href="#RFC8141" class="xref">RFC8141</a>]</span>, simple and lossless structural transforms should
generally be sufficient to store external metadata in RDs.<a href="#section-3.7-3" class="pilcrow">¶</a></p>
<p id="section-3.7-4">The additional features of an RD allow sectors to be defined
to enable access to a particular set of resources from particular applications.
This provides isolation and protection of sensitive data when needed. Application groups with multicast addresses may be defined to support efficient data transport.<a href="#section-3.7-4" class="pilcrow">¶</a></p>
</section>
</div>
</section>
</div>
<div id="rd-discovery-and-other-interface-independent-components">
<section id="section-4">
<h2 id="name-rd-discovery-and-other-inte">
<a href="#section-4" class="section-number selfRef">4. </a><a href="#name-rd-discovery-and-other-inte" class="section-name selfRef">RD Discovery and Other Interface-Independent Components</a>
</h2>
<p id="section-4-1">This and the following sections define the required set of REST interfaces between an RD,
endpoints, and lookup clients. Although the examples throughout these sections assume the use of
CoAP <span>[<a href="#RFC7252" class="xref">RFC7252</a>]</span>, these REST interfaces can also be realized using HTTP <span>[<a href="#RFC7230" class="xref">RFC7230</a>]</span>.
The multicast discovery and simple registration operations are exceptions to that,
as they rely on mechanisms unavailable in HTTP.
In all definitions in these sections, both CoAP response codes (with dot notation) and HTTP response codes
(without dot notation) are shown. An RD implementing this specification <span class="bcp14">MUST</span> support
the discovery, registration, update, lookup, and removal interfaces.<a href="#section-4-1" class="pilcrow">¶</a></p>
<p id="section-4-2">All operations on the contents of the RD <span class="bcp14">MUST</span> be atomic and idempotent.<a href="#section-4-2" class="pilcrow">¶</a></p>
<p id="section-4-3">For several operations, interface templates are given in list form;
those describe the operation participants, request codes, URIs, content formats, and outcomes.
Sections of those templates contain normative content about
Interaction, Method, URI Template, and URI Template Variables,
as well as the details of the Success condition.
The additional sections
for options (such as Content-Format) and for Failure codes
give typical cases that an implementation of the RD should deal with.
Those serve to illustrate the typical responses
to readers who are not yet familiar with all the details of CoAP-based interfaces;
they do not limit how a server may respond under atypical circumstances.<a href="#section-4-3" class="pilcrow">¶</a></p>
<p id="section-4-4">REST clients (registrant-EPs and CTs during registration and maintenance, lookup clients, and RD servers during simple registrations)
must be prepared to receive any unsuccessful code and act upon it
according to its definition, options, and/or payload to the best of their capabilities,
falling back to failing the operation if recovery is not possible.
In particular, they <span class="bcp14">SHOULD</span> retry the request upon 5.03 (Service Unavailable; 503 in HTTP)
according to the Max-Age (Retry-After in HTTP) option
and <span class="bcp14">SHOULD</span> fall back to link format when receiving 4.15 (Unsupported Content-Format; 415 in HTTP).<a href="#section-4-4" class="pilcrow">¶</a></p>
<p id="section-4-5">An RD <span class="bcp14">MAY</span> make the information submitted to it available to further
directories (subject to security policies on link confidentiality)
if it can ensure that a loop does not form. The protocol used
between directories to ensure loop-free operation is outside the scope of
this document.<a href="#section-4-5" class="pilcrow">¶</a></p>
<div id="finding_an_rd">
<section id="section-4.1">
<h3 id="name-finding-a-resource-director">
<a href="#section-4.1" class="section-number selfRef">4.1. </a><a href="#name-finding-a-resource-director" class="section-name selfRef">Finding a Resource Directory</a>
</h3>
<p id="section-4.1-1">A (re)starting device may want to find one or more RDs
before it can discover their URIs. Dependent on the operational conditions, one or more of the techniques below apply.<a href="#section-4.1-1" class="pilcrow">¶</a></p>
<p id="section-4.1-2">The device may be preconfigured to exercise specific mechanisms for
finding the RD:<a href="#section-4.1-2" class="pilcrow">¶</a></p>
<ol start="1" type="1" class="normal type-1" id="section-4.1-3">
<li id="section-4.1-3.1">It may be configured with a specific IP address for the RD. That IP
address may also be an anycast address, allowing the network to
forward RD requests to an RD that is topologically close; each
target network environment in which some of these preconfigured
nodes are to be brought up is then configured with a route for this
anycast address that leads to an appropriate RD. (Instead of using
an anycast address, a multicast address can also be preconfigured.
The RD servers then need to configure one of their
interfaces with this multicast address.)<a href="#section-4.1-3.1" class="pilcrow">¶</a>
</li>
<li id="section-4.1-3.2">It may be configured with a DNS name for the RD and use DNS to return
the IP address of the RD; it can find a DNS server to perform the lookup using the usual mechanisms for finding DNS servers.<a href="#section-4.1-3.2" class="pilcrow">¶</a>
</li>
<li id="section-4.1-3.3">It may be configured to use a service discovery mechanism, such as
DNS-based Service Discovery (DNS-SD), as outlined in <a href="#rd-using-dnssd" class="xref">Section 4.1.2</a>.<a href="#section-4.1-3.3" class="pilcrow">¶</a>
</li>
</ol>
<p id="section-4.1-4">For cases where the device is not specifically configured with a way
to find an RD, the network may want to provide a
suitable default.<a href="#section-4.1-4" class="pilcrow">¶</a></p>
<ol start="1" type="1" class="normal type-1" id="section-4.1-5">
<li id="section-4.1-5.1">The IPv6 Neighbor Discovery option RDAO (<a href="#rdao" class="xref">Section 4.1.1</a>) can do that.<a href="#section-4.1-5.1" class="pilcrow">¶</a>
</li>
<li id="section-4.1-5.2">When DHCP is in use,
this could be provided via a DHCP option (no such option is defined
at the time of writing).<a href="#section-4.1-5.2" class="pilcrow">¶</a>
</li>
</ol>
<p id="section-4.1-6">Finally, if neither the device nor the network offers any specific
configuration, the device may want to employ heuristics to find a
suitable RD.<a href="#section-4.1-6" class="pilcrow">¶</a></p>
<p id="section-4.1-7">The present specification does not fully define these heuristics but
suggests a number of candidates:<a href="#section-4.1-7" class="pilcrow">¶</a></p>
<ol start="1" type="1" class="normal type-1" id="section-4.1-8">
<li id="section-4.1-8.1">In a 6LoWPAN, just assume the 6LBR can act as an
RD (using the Authoritative Border Router Option (ABRO) to find that <span>[<a href="#RFC6775" class="xref">RFC6775</a>]</span>).
Confirmation can be obtained by sending a unicast GET to
<code>coap://[6LBR]/.well-known/core?rt=core.rd*</code>.<a href="#section-4.1-8.1" class="pilcrow">¶</a>
</li>
<li id="section-4.1-8.2">In a network that supports multicast well, discover the RD using
a multicast query for <code>/.well-known/core</code>, as specified in CoRE Link
Format <span>[<a href="#RFC6690" class="xref">RFC6690</a>]</span>, and send a Multicast GET to
<code>coap://[ff0x::fe]/.well-known/core?rt=core.rd*</code>. RDs within the
multicast scope will answer the query.<a href="#section-4.1-8.2" class="pilcrow">¶</a>
</li>
</ol>
<p id="section-4.1-9">When answering a multicast request directed at a link-local group,
the RD may want to respond from a routable address;
this makes it easier for registrants to use one of their own routable addresses for registration.
When source addresses are selected using the mechanism described in <span>[<a href="#RFC6724" class="xref">RFC6724</a>]</span>,
this can be achieved by applying the changes of its Section <a href="https://www.rfc-editor.org/rfc/rfc6724#section-10.4" class="relref">10.4</a>,
picking public addresses in Rule 7 of its Section <a href="https://www.rfc-editor.org/rfc/rfc6724#section-5" class="relref">5</a>,
and superseding Rule 8 with preferring the source address's precedence.<a href="#section-4.1-9" class="pilcrow">¶</a></p>
<p id="section-4.1-10">As some of the RD addresses obtained by the methods listed here are
just (more or less educated) guesses, endpoints <span class="bcp14">MUST</span> make use of any
error messages to very strictly rate-limit requests to candidate IP
addresses that don't work out. For example, an ICMP Destination
Unreachable message (and, in particular, the port unreachable code for
this message) may indicate the lack of a CoAP server on the candidate
host, or a CoAP error response code, such as 4.05 (Method Not Allowed),
may indicate unwillingness of a CoAP server to act as a directory
server.<a href="#section-4.1-10" class="pilcrow">¶</a></p>
<p id="section-4.1-11">The following RD discovery mechanisms are recommended:<a href="#section-4.1-11" class="pilcrow">¶</a></p>
<ul class="normal">
<li class="normal" id="section-4.1-12.1">In managed networks with border routers that need stand-alone operation, the RDAO is recommended (e.g., the operational phase described in <a href="#automation" class="xref">Section 3.6</a>).<a href="#section-4.1-12.1" class="pilcrow">¶</a>
</li>
<li class="normal" id="section-4.1-12.2">In managed networks without border routers (no Internet services available), the use of a preconfigured anycast address is recommended (e.g., the installation phase described in <a href="#automation" class="xref">Section 3.6</a>).<a href="#section-4.1-12.2" class="pilcrow">¶</a>
</li>
<li class="normal" id="section-4.1-12.3">In networks managed using DNS-SD, the use of DNS-SD for discovery, as described in <a href="#rd-using-dnssd" class="xref">Section 4.1.2</a>, is recommended.<a href="#section-4.1-12.3" class="pilcrow">¶</a>
</li>
</ul>
<p id="section-4.1-13">The use of multicast discovery in mesh networks is <span class="bcp14">NOT RECOMMENDED</span>.<a href="#section-4.1-13" class="pilcrow">¶</a></p>
<div id="rdao">
<section id="section-4.1.1">
<h4 id="name-resource-directory-address-">
<a href="#section-4.1.1" class="section-number selfRef">4.1.1. </a><a href="#name-resource-directory-address-" class="section-name selfRef">Resource Directory Address Option (RDAO)</a>
</h4>
<p id="section-4.1.1-1">The Resource Directory Address Option (RDAO) carries
information about the address of the RD in RAs (Router Advertisements) of IPv6 Neighbor Discovery (ND),
similar to how Recursive DNS Server (RDNSS) options <span>[<a href="#RFC8106" class="xref">RFC8106</a>]</span> are sent. This information is
needed when endpoints cannot discover the RD with a link-local
or realm-local scope multicast address, for instance, because the
endpoint and the RD are separated by a
6LBR. In many circumstances, the availability of DHCP cannot be guaranteed
during commissioning of the network either. The presence and the use of the RD is
essential during commissioning.<a href="#section-4.1.1-1" class="pilcrow">¶</a></p>
<p id="section-4.1.1-2">It is possible to send multiple RDAOs in one message,
indicating as many RD addresses.<a href="#section-4.1.1-2" class="pilcrow">¶</a></p>
<p id="section-4.1.1-3">The RDAO format is:<a href="#section-4.1.1-3" class="pilcrow">¶</a></p>
<span id="name-resource-directory-address-o"></span><div id="fig-rdao">
<figure id="figure-4">
<div class="alignLeft art-ascii-art art-text artwork" id="section-4.1.1-4.1">
<pre>
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Type | Length = 3 | Reserved |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Valid Lifetime |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| |
+ +
| |
+ RD Address +
| |
+ +
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
</pre>
</div>
<figcaption><a href="#figure-4" class="selfRef">Figure 4</a>:
<a href="#name-resource-directory-address-o" class="selfRef">Resource Directory Address Option</a>
</figcaption></figure>
</div>
<p id="section-4.1.1-5">Fields:<a href="#section-4.1.1-5" class="pilcrow">¶</a></p>
<span class="break"></span><dl class="dlParallel" id="section-4.1.1-6">
<dt id="section-4.1.1-6.1">Type:</dt>
<dd style="margin-left: 9.0em" id="section-4.1.1-6.2">41<a href="#section-4.1.1-6.2" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-4.1.1-6.3">Length:</dt>
<dd style="margin-left: 9.0em" id="section-4.1.1-6.4"> 8-bit unsigned integer. The length of
the option in units of 8 bytes.
Always 3.<a href="#section-4.1.1-6.4" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-4.1.1-6.5">Reserved:</dt>
<dd style="margin-left: 9.0em" id="section-4.1.1-6.6">This field is unused. It <span class="bcp14">MUST</span> be
initialized to zero by the sender and
<span class="bcp14">MUST</span> be ignored by the receiver.<a href="#section-4.1.1-6.6" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-4.1.1-6.7">Valid Lifetime:</dt>
<dd style="margin-left: 9.0em" id="section-4.1.1-6.8">32-bit unsigned integer. The length of
time in seconds (relative to
the time the packet is received) that
this RD address is valid.
A value of all zero bits (0x0) indicates
that this RD address
is not valid anymore.<a href="#section-4.1.1-6.8" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-4.1.1-6.9">RD Address:</dt>
<dd style="margin-left: 9.0em" id="section-4.1.1-6.10"> IPv6 address of the RD.<a href="#section-4.1.1-6.10" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
</dl>
</section>
</div>
<div id="rd-using-dnssd">
<section id="section-4.1.2">
<h4 id="name-using-dns-sd-to-discover-a-">
<a href="#section-4.1.2" class="section-number selfRef">4.1.2. </a><a href="#name-using-dns-sd-to-discover-a-" class="section-name selfRef">Using DNS-SD to Discover a Resource Directory</a>
</h4>
<p id="section-4.1.2-1">An RD can advertise its presence in DNS-SD <span>[<a href="#RFC6763" class="xref">RFC6763</a>]</span>
using the service names defined in this document: <code>_core-rd._udp</code> (for CoAP), <code>_core-rd-dtls._udp</code>
(for CoAP over DTLS), <code>_core-rd._tcp</code> (for CoAP over TCP), or
<code>_core-rd-tls._tcp</code> (for CoAP over TLS).
(For the WebSocket transports of CoAP, no service is defined,
as DNS-SD is typically unavailable in environments where CoAP over WebSockets is
used.)<a href="#section-4.1.2-1" class="pilcrow">¶</a></p>
<p id="section-4.1.2-2">The selection of the service indicates the protocol used, and
the SRV record points the client to a host name and port to use as a starting point for
the "URI discovery" steps of <a href="#discovery" class="xref">Section 4.3</a>.<a href="#section-4.1.2-2" class="pilcrow">¶</a></p>
<p id="section-4.1.2-3">This section is a simplified, concrete application of the more generic mechanism
specified in <span>[<a href="#I-D.ietf-core-rd-dns-sd" class="xref">CORE-RD-DNS-SD</a>]</span>.<a href="#section-4.1.2-3" class="pilcrow">¶</a></p>
</section>
</div>
</section>
</div>
<div id="payload-content-formats">
<section id="section-4.2">
<h3 id="name-payload-content-formats">
<a href="#section-4.2" class="section-number selfRef">4.2. </a><a href="#name-payload-content-formats" class="section-name selfRef">Payload Content Formats</a>
</h3>
<p id="section-4.2-1">RDs implementing this specification <span class="bcp14">MUST</span> support the
<code>application/link-format</code> content format (ct=40).<a href="#section-4.2-1" class="pilcrow">¶</a></p>
<p id="section-4.2-2">RDs implementing this specification <span class="bcp14">MAY</span> support additional content formats.<a href="#section-4.2-2" class="pilcrow">¶</a></p>
<p id="section-4.2-3">Any additional content format supported by an RD implementing this
specification <span class="bcp14">SHOULD</span> be able to express all the information expressible in link format.
It <span class="bcp14">MAY</span> be able to express information that is inexpressible in link format,
but those expressions <span class="bcp14">SHOULD</span> be avoided where possible.<a href="#section-4.2-3" class="pilcrow">¶</a></p>
</section>
</div>
<div id="discovery">
<section id="section-4.3">
<h3 id="name-uri-discovery">
<a href="#section-4.3" class="section-number selfRef">4.3. </a><a href="#name-uri-discovery" class="section-name selfRef">URI Discovery</a>
</h3>
<p id="section-4.3-1">Before an endpoint can make use of an RD, it must first know the RD's address
and port and the URI path information for its REST APIs. This section defines
discovery of the RD and its URIs using the well-known interface of the
CoRE Link Format <span>[<a href="#RFC6690" class="xref">RFC6690</a>]</span> after having discovered a host, as described in <a href="#finding_an_rd" class="xref">Section 4.1</a>.<a href="#section-4.3-1" class="pilcrow">¶</a></p>
<p id="section-4.3-2">Discovery of the RD registration URI is performed by sending either a multicast or
unicast GET request to <code>/.well-known/core</code> and including a resource type (rt)
parameter <span>[<a href="#RFC6690" class="xref">RFC6690</a>]</span> with the value "core.rd" in the query string. Likewise, a
resource type parameter value of "core.rd-lookup*" is used to discover the
URIs for RD lookup operations, and "core.rd*" is used to discover all URIs for RD operations.
Upon success, the response will contain a payload with
a link format entry for each RD function discovered, indicating the URI
of the RD function returned and the corresponding resource type. When performing
multicast discovery, the multicast IP address used will depend on the scope required
and the multicast capabilities of the network (see <a href="#mc-registration" class="xref">Section 9.5</a>).<a href="#section-4.3-2" class="pilcrow">¶</a></p>
<p id="section-4.3-3">An RD <span class="bcp14">MAY</span> provide hints about the content formats it supports in the links it exposes or registers, using the "ct" target attribute, as shown in the example below. Clients <span class="bcp14">MAY</span> use these hints to select alternate content formats for interaction with the RD.<a href="#section-4.3-3" class="pilcrow">¶</a></p>
<p id="section-4.3-4">HTTP does not support multicast, and, consequently, only unicast discovery can be
supported using the HTTP <code>/.well-known/core</code> resource.<a href="#section-4.3-4" class="pilcrow">¶</a></p>
<p id="section-4.3-5">RDs implementing this specification <span class="bcp14">MUST</span> support query filtering for
the rt parameter, as defined in <span>[<a href="#RFC6690" class="xref">RFC6690</a>]</span>.<a href="#section-4.3-5" class="pilcrow">¶</a></p>
<p id="section-4.3-6">While the link targets in this discovery step are often expressed in path-absolute form,
this is not a requirement.
Clients of the RD <span class="bcp14">SHOULD</span> therefore accept URIs of all schemes they support,
both as URIs and relative references,
and not limit the set of discovered URIs to those hosted at the address used for URI discovery.<a href="#section-4.3-6" class="pilcrow">¶</a></p>
<p id="section-4.3-7">With security policies where the client requires the RD to be authorized to act as an RD,
that authorization may be limited to resources on which the authorized RD advertises the adequate resource types.
Clients that have obtained links they cannot rely on yet
can repeat the "URI discovery" step at the <code>/.well-known/core</code> resource of the indicated host
to obtain the resource type information from an authorized source.<a href="#section-4.3-7" class="pilcrow">¶</a></p>
<p id="section-4.3-8">The URI discovery operation can yield multiple URIs of a given resource type.
The client of the RD can try out any of the discovered addresses.<a href="#section-4.3-8" class="pilcrow">¶</a></p>
<p id="section-4.3-9">The discovery request interface is specified as follows
(this is exactly the well-known interface of <span>[<a href="#RFC6690" class="xref">RFC6690</a>], <a href="https://www.rfc-editor.org/rfc/rfc6690#section-4" class="relref">Section 4</a></span>,
with the additional requirement that the server <span class="bcp14">MUST</span> support query filtering):<a href="#section-4.3-9" class="pilcrow">¶</a></p>
<span class="break"></span><dl class="dlParallel" id="section-4.3-10">
<dt id="section-4.3-10.1">Interaction:</dt>
<dd style="margin-left: 1.5em" id="section-4.3-10.2"> EP, CT, or Client -> RD<a href="#section-4.3-10.2" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-4.3-10.3">Method:</dt>
<dd style="margin-left: 1.5em" id="section-4.3-10.4">GET<a href="#section-4.3-10.4" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-4.3-10.5">URI Template:</dt>
<dd style="margin-left: 1.5em" id="section-4.3-10.6">
<code>/.well-known/core{?rt}</code><a href="#section-4.3-10.6" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-4.3-10.7">URI Template Variables:</dt>
<dd style="margin-left: 1.5em" id="section-4.3-10.8">
<p id="section-4.3-10.8.1"><br></p>
<span class="break"></span><dl class="dlParallel" id="section-4.3-10.8.2">
<dt id="section-4.3-10.8.2.1">rt := </dt>
<dd style="margin-left: 1.5em" id="section-4.3-10.8.2.2">Resource Type. <span class="bcp14">SHOULD</span> contain one of the values "core.rd",
"core.rd-lookup*",
"core.rd-lookup-res", "core.rd-lookup-ep", or "core.rd*"<a href="#section-4.3-10.8.2.2" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
</dl>
</dd>
<dd class="break"></dd>
<dt id="section-4.3-10.9">Accept:</dt>
<dd style="margin-left: 1.5em" id="section-4.3-10.10">absent, <code>application/link-format</code>, or any other media type representing web links<a href="#section-4.3-10.10" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
</dl>
<p id="section-4.3-11">The following response is expected on this interface:<a href="#section-4.3-11" class="pilcrow">¶</a></p>
<span class="break"></span><dl class="dlParallel" id="section-4.3-12">
<dt id="section-4.3-12.1">Success:</dt>
<dd style="margin-left: 1.5em" id="section-4.3-12.2">2.05 (Content) or 200 (OK) with an
<code>application/link-format</code> or other web link payload containing one or more matching entries for the RD resource.<a href="#section-4.3-12.2" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
</dl>
<p id="section-4.3-13">The following example shows an endpoint discovering an RD using this interface,
thus learning that the directory resource location in this example is /rd and that the
content format delivered by the server hosting the resource is <code>application/link-format</code>
(ct=40). Note that it is up to the RD to choose its RD locations.<a href="#section-4.3-13" class="pilcrow">¶</a></p>
<span id="name-example-discovery-exchange"></span><div id="example-discovery">
<figure id="figure-5">
<div id="section-4.3-14.1">
<pre class="sourcecode">
Req: GET coap://[ff02::fe]/.well-known/core?rt=core.rd*
Res: 2.05 Content
Payload:
</rd>;rt=core.rd;ct=40,
</rd-lookup/ep>;rt=core.rd-lookup-ep;ct=40,
</rd-lookup/res>;rt=core.rd-lookup-res;ct=40
</pre>
</div>
<figcaption><a href="#figure-5" class="selfRef">Figure 5</a>:
<a href="#name-example-discovery-exchange" class="selfRef">Example Discovery Exchange</a>
</figcaption></figure>
</div>
<p id="section-4.3-15">The following example shows the way of indicating that a client may request
alternate content formats. The Content-Format code attribute "ct" <span class="bcp14">MAY</span>
include a space-separated sequence of Content-Format codes, as specified in <span><a href="https://www.rfc-editor.org/rfc/rfc7252#section-7.2.1" class="relref">Section 7.2.1</a> of [<a href="#RFC7252" class="xref">RFC7252</a>]</span>, indicating that multiple
content formats are available. The example below shows the required Content-Format 40
(<code>application/link-format</code>) indicated, as well as Concise Binary Object Representation (CBOR)
and JSON representations in the style of <span>[<a href="#I-D.ietf-core-links-json" class="xref">CORE-LINKS-JSON</a>]</span>
(for which the experimental values 65060 and 65050 are used in this example). The RD resource locations /rd
and /rd-lookup are example values. The server in this example also indicates that
it is capable of providing observation on resource lookups.<a href="#section-4.3-15" class="pilcrow">¶</a></p>
<span id="name-example-discovery-exchange-"></span><div id="example-discovery-ct">
<figure id="figure-6">
<div id="section-4.3-16.1">
<pre class="sourcecode">
Req: GET coap://[ff02::fe]/.well-known/core?rt=core.rd*
Res: 2.05 Content
Payload:
</rd>;rt=core.rd;ct=40,
</rd-lookup/res>;rt=core.rd-lookup-res;ct="40 65060 65050";obs,
</rd-lookup/ep>;rt=core.rd-lookup-ep;ct="40 65060 65050"
</pre>
</div>
<figcaption><a href="#figure-6" class="selfRef">Figure 6</a>:
<a href="#name-example-discovery-exchange-" class="selfRef">Example Discovery Exchange Indicating Additional Content-Formats</a>
</figcaption></figure>
</div>
<p id="section-4.3-17">For maintenance, management, and debugging,
it can be useful to identify the components that constitute the RD server.
The identification can be used to find client-server incompatibilities,
supported features, required updates, and other aspects.
The well-known interface described in <span><a href="https://www.rfc-editor.org/rfc/rfc6690#section-4" class="relref">Section 4</a> of [<a href="#RFC6690" class="xref">RFC6690</a>]</span> can be used to find such data.<a href="#section-4.3-17" class="pilcrow">¶</a></p>
<p id="section-4.3-18">It would typically be stored in an implementation information link
(as described in <span>[<a href="#I-D.bormann-t2trg-rel-impl" class="xref">T2TRG-REL-IMPL</a>]</span>).<a href="#section-4.3-18" class="pilcrow">¶</a></p>
<span id="name-example-exchange-of-obtaini"></span><div id="example-impl-discovery">
<figure id="figure-7">
<div id="section-4.3-19.1">
<pre class="sourcecode">
Req: GET /.well-known/core?rel=impl-info
Res: 2.05 Content
Payload:
<http://software.example.com/shiny-resource-directory/1.0beta1>;
rel=impl-info
</pre>
</div>
<figcaption><a href="#figure-7" class="selfRef">Figure 7</a>:
<a href="#name-example-exchange-of-obtaini" class="selfRef">Example Exchange of Obtaining Implementation Information Using the Relation Type Currently Proposed in <em class="xref">[T2TRG-REL-IMPL]</em></a>
</figcaption></figure>
</div>
<p id="section-4.3-20">Note that, depending on the particular server's architecture,
such a link could be anchored at the RD server's root
(as in this example) or
at individual RD components.
The latter is to be expected when different applications
are run on the same server.<a href="#section-4.3-20" class="pilcrow">¶</a></p>
</section>
</div>
</section>
</div>
<div id="registration">
<section id="section-5">
<h2 id="name-registration">
<a href="#section-5" class="section-number selfRef">5. </a><a href="#name-registration" class="section-name selfRef">Registration</a>
</h2>
<p id="section-5-1">After discovering the location of an RD, a registrant-EP or CT <span class="bcp14">MAY</span>
register the resources of the registrant-EP using the registration interface. This interface
accepts a POST from an endpoint containing the list of resources to be added
to the directory as the message payload in the CoRE Link Format <span>[<a href="#RFC6690" class="xref">RFC6690</a>]</span> or other representations of web links, along with query
parameters indicating the name of the endpoint and, optionally, the sector,
lifetime, and base URI of the registration.
It is expected that other specifications will define further parameters (see
<a href="#iana-registry" class="xref">Section 9.3</a>). The RD then creates a new registration resource in the RD and returns its location. The receiving endpoint <span class="bcp14">MUST</span> use that
location when refreshing registrations using this interface. Registration
resources in the RD are kept active for the period indicated by the lifetime
parameter. The creating endpoint is responsible for refreshing the registration resource within this
period, using either the registration or update interface. The registration
interface <span class="bcp14">MUST</span> be implemented to be idempotent, so that registering twice
with the same endpoint parameters ep and d (sector) does not create multiple registration resources.<a href="#section-5-1" class="pilcrow">¶</a></p>
<p id="section-5-2">The following rules apply for a registration request targeting a given (ep, d) value pair:<a href="#section-5-2" class="pilcrow">¶</a></p>
<ul class="normal">
<li class="normal" id="section-5-3.1">When the (ep, d) value pair of the registration request is different from any existing registration,
a new registration is generated.<a href="#section-5-3.1" class="pilcrow">¶</a>
</li>
<li class="normal" id="section-5-3.2">When the (ep, d) value pair of the registration request is equal to an existing registration,
the content and parameters of the existing registration are replaced with the content of the registration request.
As with changes to registration resources, security policies (<a href="#policies" class="xref">Section 7</a>) usually require such requests to come from the same device.<a href="#section-5-3.2" class="pilcrow">¶</a>
</li>
</ul>
<p id="section-5-4">The posted link-format document can (and typically does) contain relative references
both in its link targets and in its anchors; it can also contain empty anchors.
The RD server needs to resolve these references in order to faithfully represent them in lookups.
They are resolved against the base URI of the registration,
which is provided either explicitly in the <code>base</code> parameter or constructed implicitly from the requester's URI, as constructed from its network address and scheme.<a href="#section-5-4" class="pilcrow">¶</a></p>
<p id="section-5-5">For media types to which <a href="#limitedlinkformat" class="xref">Appendix C</a> applies
(i.e., documents in <code>application/link-format</code>),
request bodies <span class="bcp14">MUST</span> be expressed in Limited Link Format.<a href="#section-5-5" class="pilcrow">¶</a></p>
<p id="section-5-6">The registration request interface is specified as follows:<a href="#section-5-6" class="pilcrow">¶</a></p>
<span class="break"></span><dl class="dlParallel" id="section-5-7">
<dt id="section-5-7.1">Interaction:</dt>
<dd style="margin-left: 1.5em" id="section-5-7.2">EP or CT -> RD<a href="#section-5-7.2" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-5-7.3">Method:</dt>
<dd style="margin-left: 1.5em" id="section-5-7.4">POST<a href="#section-5-7.4" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-5-7.5">URI Template:</dt>
<dd style="margin-left: 1.5em" id="section-5-7.6">{+rd}{?ep,d,lt,base,extra-attrs*}<a href="#section-5-7.6" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-5-7.7">URI Template Variables:</dt>
<dd style="margin-left: 1.5em" id="section-5-7.8">
<p id="section-5-7.8.1"><br></p>
<span class="break"></span><dl class="dlParallel" id="section-5-7.8.2">
<dt id="section-5-7.8.2.1">rd :=</dt>
<dd style="margin-left: 1.5em" id="section-5-7.8.2.2">RD registration URI
(mandatory). This is the location of
the RD, as obtained from discovery.<a href="#section-5-7.8.2.2" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-5-7.8.2.3">ep :=</dt>
<dd style="margin-left: 1.5em" id="section-5-7.8.2.4">
<p id="section-5-7.8.2.4.1">Endpoint name (mostly mandatory). The endpoint name is an identifier
that <span class="bcp14">MUST</span> be unique within a sector.<a href="#section-5-7.8.2.4.1" class="pilcrow">¶</a></p>
<p id="section-5-7.8.2.4.2">As the endpoint name is a Unicode string, it is
encoded in UTF-8 (and possibly percent encoded) during
variable expansion (see <span>[<a href="#RFC6570" class="xref">RFC6570</a>], <a href="https://www.rfc-editor.org/rfc/rfc6570#section-3.2.1" class="relref">Section 3.2.1</a></span>). The endpoint name <span class="bcp14">MUST NOT</span> contain any
character in the inclusive ranges 0-31 or 127-159.<a href="#section-5-7.8.2.4.2" class="pilcrow">¶</a></p>
<p id="section-5-7.8.2.4.3">The maximum length of this parameter is 63 bytes encoded in UTF-8.<a href="#section-5-7.8.2.4.3" class="pilcrow">¶</a></p>
<p id="section-5-7.8.2.4.4">If the RD is configured to recognize the endpoint that is to be authorized to use
exactly
one endpoint name, the RD assigns that name. In that case, giving the endpoint name
becomes optional for the client; if the client gives any other endpoint name, it is
not authorized to perform the registration.<a href="#section-5-7.8.2.4.4" class="pilcrow">¶</a></p>
</dd>
<dd class="break"></dd>
<dt id="section-5-7.8.2.5">d :=</dt>
<dd style="margin-left: 1.5em" id="section-5-7.8.2.6">
<p id="section-5-7.8.2.6.1">Sector (optional). This is the sector to which this endpoint belongs.
When this parameter is not present, the
RD <span class="bcp14">MAY</span> associate the endpoint with a configured default sector
(possibly based on the endpoint's authorization)
or leave it empty.<a href="#section-5-7.8.2.6.1" class="pilcrow">¶</a></p>
<p id="section-5-7.8.2.6.2">The sector is encoded like the ep parameter and is limited to 63 bytes encoded in
UTF-8 as well.<a href="#section-5-7.8.2.6.2" class="pilcrow">¶</a></p>
</dd>
<dd class="break"></dd>
<dt id="section-5-7.8.2.7">lt := </dt>
<dd style="margin-left: 1.5em" id="section-5-7.8.2.8">Lifetime (optional). This is the lifetime of the registration in seconds, with a
range of 1-4294967295.
If no lifetime is included in the initial registration, a default value of
90000 (25 hours) <span class="bcp14">SHOULD</span> be assumed.<a href="#section-5-7.8.2.8" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-5-7.8.2.9">base :=</dt>
<dd style="margin-left: 1.5em" id="section-5-7.8.2.10">
<p id="section-5-7.8.2.10.1">Base URI (optional). This parameter sets the base URI of the registration, under
which the relative links in the payload are to be interpreted. The specified URI
typically does not have a path component of its own and <span class="bcp14">MUST</span> be
suitable as a base URI to resolve any relative references given in the registration.
The parameter is therefore usually of the shape "scheme://authority" for
HTTP and CoAP URIs.
The URI <span class="bcp14">SHOULD NOT</span> have a query or fragment component,
as any non-empty relative part in a reference would remove those parts from the
resulting URI.<a href="#section-5-7.8.2.10.1" class="pilcrow">¶</a></p>
<p id="section-5-7.8.2.10.2">In the absence of this parameter, the scheme of the protocol, the source address,
and the source port of the registration request are assumed.
The base URI is consecutively constructed by concatenating the used protocol's scheme
with the characters "://", the requester's source address as an address literal,
and ":" followed by its port (if it was not the protocol's default
one). This is analogous to the process described in <span>[<a href="#RFC7252" class="xref">RFC7252</a>], <a href="https://www.rfc-editor.org/rfc/rfc7252#section-6.5" class="relref">Section 6.5</a></span>.<a href="#section-5-7.8.2.10.2" class="pilcrow">¶</a></p>
<p id="section-5-7.8.2.10.3">This parameter is
mandatory when the directory is filled by a third party, such as a
commissioning tool.<a href="#section-5-7.8.2.10.3" class="pilcrow">¶</a></p>
<p id="section-5-7.8.2.10.4">If the registrant-EP uses an ephemeral port to register with, it
<span class="bcp14">MUST</span> include the base
parameter in the registration to provide a valid network path.<a href="#section-5-7.8.2.10.4" class="pilcrow">¶</a></p>
<p id="section-5-7.8.2.10.5">A registrant that cannot be reached by potential lookup clients at the address it
registers from
(e.g., because it is behind some form of Network Address Translation (NAT))
<span class="bcp14">MUST</span> provide a reachable base address with its registration.<a href="#section-5-7.8.2.10.5" class="pilcrow">¶</a></p>
<p id="section-5-7.8.2.10.6">If the base URI contains a link-local IP literal, it <span class="bcp14">MUST NOT</span>
contain a Zone Identifier
and <span class="bcp14">MUST</span> be local to the link on which the registration request is
received.<a href="#section-5-7.8.2.10.6" class="pilcrow">¶</a></p>
<p id="section-5-7.8.2.10.7">Endpoints that register with a base that contains a path component
cannot efficiently express their registrations in Limited Link Format (<a href="#limitedlinkformat" class="xref">Appendix C</a>).
Those applications should use different representations of links to which <a href="#limitedlinkformat" class="xref">Appendix C</a> is not applicable
(e.g., <span>[<a href="#I-D.ietf-core-coral" class="xref">CORE-CORAL</a>]</span>).<a href="#section-5-7.8.2.10.7" class="pilcrow">¶</a></p>
</dd>
<dd class="break"></dd>
<dt id="section-5-7.8.2.11">extra-attrs :=</dt>
<dd style="margin-left: 1.5em" id="section-5-7.8.2.12">Additional registration attributes (optional). The endpoint can pass any
parameter registered in <a href="#iana-registry" class="xref">Section 9.3</a> to the
directory. If the RD is
aware of the parameter's specified semantics, it processes the parameter accordingly.
Otherwise, it <span class="bcp14">MUST</span> store the unknown key and its value(s) as an
endpoint attribute for further lookup.<a href="#section-5-7.8.2.12" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
</dl>
</dd>
<dd class="break"></dd>
<dt id="section-5-7.9">Content-Format:</dt>
<dd style="margin-left: 1.5em" id="section-5-7.10">
<code>application/link-format</code> or any other indicated media type representing web links<a href="#section-5-7.10" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
</dl>
<p id="section-5-8">The following response is expected on this interface:<a href="#section-5-8" class="pilcrow">¶</a></p>
<span class="break"></span><dl class="dlParallel" id="section-5-9">
<dt id="section-5-9.1">Success:</dt>
<dd style="margin-left: 1.5em" id="section-5-9.2">
<p id="section-5-9.2.1">2.01 (Created) or 201 (Created). The Location-Path option or Location header
field <span class="bcp14">MUST</span> be included in the response. This location
<span class="bcp14">MUST</span> be a stable identifier generated by the RD, as it is used
for all subsequent operations on this registration resource. The registration
resource location thus returned is for the purpose of updating the lifetime
of the registration and for maintaining the content of the
registered links, including updating and deleting links.<a href="#section-5-9.2.1" class="pilcrow">¶</a></p>
<p id="section-5-9.2.2">A registration with an already-registered ep and d value pair
responds with the same success code and location as the original registration;
the set of links registered with the endpoint is replaced with the links
from the payload.<a href="#section-5-9.2.2" class="pilcrow">¶</a></p>
<p id="section-5-9.2.3">The location <span class="bcp14">MUST NOT</span> have a query or fragment component,
as that could conflict with query parameters during the registration update
operation. Therefore, the Location-Query option <span class="bcp14">MUST NOT</span> be
present in a successful response.<a href="#section-5-9.2.3" class="pilcrow">¶</a></p>
</dd>
<dd class="break"></dd>
</dl>
<p id="section-5-10">If the registration fails, including request timeouts,
or if delays from Service Unavailable responses with Max-Age or Retry-After
accumulate to exceed the registrant's configured timeouts,
it <span class="bcp14">SHOULD</span> pick another registration URI from the "URI discovery" step of <a href="#discovery" class="xref">Section 4.3</a>,
and, if there is only one or the list is exhausted,
pick other choices from the "finding a resource directory" step of <a href="#finding_an_rd" class="xref">Section 4.1</a>.
Care has to be taken to consider the freshness of results obtained earlier,
e.g., the result of a <code>/.well-known/core</code> response,
the lifetime of an RDAO, and DNS responses.
Any rate limits and persistent errors from the "finding a resource directory" step
must be considered for the whole registration time,
not only for a single operation.<a href="#section-5-10" class="pilcrow">¶</a></p>
<p id="section-5-11">The following example shows a registrant-EP with the name "node1" registering
two resources to an RD using this interface. The location "/rd"
is an example RD location discovered in a request similar to <a href="#example-discovery" class="xref">Figure 5</a>.<a href="#section-5-11" class="pilcrow">¶</a></p>
<span id="name-example-registration-payloa"></span><div id="example-payload">
<figure id="figure-8">
<div id="section-5-12.1">
<pre class="sourcecode">
Req: POST coap://rd.example.com/rd?ep=node1
Content-Format: 40
Payload:
</sensors/temp>;rt=temperature-c;if=sensor,
<http://www.example.com/sensors/temp>;
anchor="/sensors/temp";rel=describedby
Res: 2.01 Created
Location-Path: /rd/4521
</pre>
</div>
<figcaption><a href="#figure-8" class="selfRef">Figure 8</a>:
<a href="#name-example-registration-payloa" class="selfRef">Example Registration Payload</a>
</figcaption></figure>
</div>
<p id="section-5-13">An RD may optionally support HTTP. Here is an example of almost the same registration operation above when done using HTTP.<a href="#section-5-13" class="pilcrow">¶</a></p>
<span id="name-example-registration-payload"></span><div id="example-payload-http">
<figure id="figure-9">
<div id="section-5-14.1">
<pre class="sourcecode">
Req:
POST /rd?ep=node1&base=http://[2001:db8:1::1] HTTP/1.1
Host: rd.example.com
Content-Type: application/link-format
</sensors/temp>;rt=temperature-c;if=sensor,
<http://www.example.com/sensors/temp>;
anchor="/sensors/temp";rel=describedby
Res:
HTTP/1.1 201 Created
Location: /rd/4521
</pre>
</div>
<figcaption><a href="#figure-9" class="selfRef">Figure 9</a>:
<a href="#name-example-registration-payload" class="selfRef">Example Registration Payload as Expressed Using HTTP</a>
</figcaption></figure>
</div>
<div id="simple">
<section id="section-5.1">
<h3 id="name-simple-registration">
<a href="#section-5.1" class="section-number selfRef">5.1. </a><a href="#name-simple-registration" class="section-name selfRef">Simple Registration</a>
</h3>
<p id="section-5.1-1">Not all endpoints hosting resources are expected to know how to upload links to an RD, as described in <a href="#registration" class="xref">Section 5</a>. Instead, simple endpoints can implement the simple registration approach described in this section. An RD implementing this specification <span class="bcp14">MUST</span> implement simple registration. However, there may
be security reasons why this form of directory discovery would be disabled.<a href="#section-5.1-1" class="pilcrow">¶</a></p>
<p id="section-5.1-2">This approach requires that the registrant-EP makes available the hosted resources
that it wants to be discovered as links on its <code>/.well-known/core</code> interface, as
specified in <span>[<a href="#RFC6690" class="xref">RFC6690</a>]</span>.
The links in that document are subject to the same limitations as the payload of a registration
(with respect to <a href="#limitedlinkformat" class="xref">Appendix C</a>).<a href="#section-5.1-2" class="pilcrow">¶</a></p>
<ul class="normal">
<li class="normal" id="section-5.1-3.1">The registrant-EP finds one or more addresses of the directory server, as described in <a href="#finding_an_rd" class="xref">Section 4.1</a>.<a href="#section-5.1-3.1" class="pilcrow">¶</a>
</li>
<li class="normal" id="section-5.1-3.2">
<p id="section-5.1-3.2.1">The registrant-EP sends (and regularly refreshes with) a POST
request to the <code>/.well-known/rd</code> URI of the directory server of choice. The
body of the POST request is empty and triggers the resource
directory server to perform GET requests (redone before lifetime expiry) at the requesting registrant-EP's
<code>/.well-known/core</code> to obtain the link-format payload to register.<a href="#section-5.1-3.2.1" class="pilcrow">¶</a></p>
<p id="section-5.1-3.2.2">The registrant-EP includes the same registration parameters in the POST request as
it would with a regular registration, per <a href="#registration" class="xref">Section 5</a>. The registration base URI of the registration is taken from the
registrant-EP's network address (as is default with regular registrations).<a href="#section-5.1-3.2.2" class="pilcrow">¶</a></p>
<p id="section-5.1-3.2.3">The following is an example request from the registrant-EP to the RD (unanswered
until the next step):<a href="#section-5.1-3.2.3" class="pilcrow">¶</a></p>
<span id="name-first-half-example-exchange"></span><div id="example-simple1">
<figure id="figure-10">
<div id="section-5.1-3.2.4.1">
<pre class="sourcecode">
Req: POST /.well-known/rd?lt=6000&ep=node1
(No payload)
</pre>
</div>
<figcaption><a href="#figure-10" class="selfRef">Figure 10</a>:
<a href="#name-first-half-example-exchange" class="selfRef">First-Half Example Exchange of a Simple Registration</a>
</figcaption></figure>
</div>
</li>
<li class="normal" id="section-5.1-3.3">
<p id="section-5.1-3.3.1">The RD queries the registrant-EP's discovery resource to determine the success of
the operation. It <span class="bcp14">SHOULD</span> keep a cache of the discovery resource and not
query it again as long as it is fresh.<a href="#section-5.1-3.3.1" class="pilcrow">¶</a></p>
<p id="section-5.1-3.3.2">The following is an example request from the RD to the registrant-EP:<a href="#section-5.1-3.3.2" class="pilcrow">¶</a></p>
<span id="name-example-exchange-of-the-rd-"></span><div id="example-simple2">
<figure id="figure-11">
<div id="section-5.1-3.3.3.1">
<pre class="sourcecode">
Req: GET /.well-known/core
Accept: 40
Res: 2.05 Content
Content-Format: 40
Payload:
</sen/temp>
</pre>
</div>
<figcaption><a href="#figure-11" class="selfRef">Figure 11</a>:
<a href="#name-example-exchange-of-the-rd-" class="selfRef">Example Exchange of the RD Querying the Simple Endpoint</a>
</figcaption></figure>
</div>
</li>
</ul>
<p id="section-5.1-4">With this response, the RD would answer the previous step's request:<a href="#section-5.1-4" class="pilcrow">¶</a></p>
<span id="name-second-half-example-exchang"></span><div id="example-simple3">
<figure id="figure-12">
<div id="section-5.1-5.1">
<pre class="sourcecode">
Res: 2.04 Changed
</pre>
</div>
<figcaption><a href="#figure-12" class="selfRef">Figure 12</a>:
<a href="#name-second-half-example-exchang" class="selfRef">Second-Half Example Exchange of a Simple Registration</a>
</figcaption></figure>
</div>
<p id="section-5.1-6">The sequence of fetching the registration content before sending a successful response
was chosen to make responses reliable,
and the point about caching was chosen to still allow very constrained registrants.
Registrants <span class="bcp14">MUST</span> be able to serve a GET request to <code>/.well-known/core</code> after having requested registration.
Constrained devices <span class="bcp14">MAY</span> regard the initial request as temporarily failed when they need RAM occupied by their own request to serve the RD's GET
and retry later when the RD already has a cached representation of their discovery resources.
Then, the RD can reply immediately, and the registrant can receive the response.<a href="#section-5.1-6" class="pilcrow">¶</a></p>
<p id="section-5.1-7">The simple registration request interface is specified as follows:<a href="#section-5.1-7" class="pilcrow">¶</a></p>
<span class="break"></span><dl class="dlParallel" id="section-5.1-8">
<dt id="section-5.1-8.1">Interaction:</dt>
<dd style="margin-left: 1.5em" id="section-5.1-8.2">EP -> RD<a href="#section-5.1-8.2" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-5.1-8.3">Method: </dt>
<dd style="margin-left: 1.5em" id="section-5.1-8.4">POST<a href="#section-5.1-8.4" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-5.1-8.5">URI Template: </dt>
<dd style="margin-left: 1.5em" id="section-5.1-8.6">
<code>/.well-known/rd{?ep,d,lt,extra-attrs*}</code><a href="#section-5.1-8.6" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
</dl>
<p id="section-5.1-9">URI Template Variables are the same as for registration in <a href="#registration" class="xref">Section 5</a>.
The base attribute is not accepted to keep the registration interface simple;
that rules out registration over CoAP-over-TCP or HTTP that would need to specify one.
For some time during this document's development, the URI Template <code>/.well-known/core{?ep,...}</code> was in use instead.<a href="#section-5.1-9" class="pilcrow">¶</a></p>
<p id="section-5.1-10">The following response is expected on this interface:<a href="#section-5.1-10" class="pilcrow">¶</a></p>
<span class="break"></span><dl class="dlParallel" id="section-5.1-11">
<dt id="section-5.1-11.1">Success:</dt>
<dd style="margin-left: 1.5em" id="section-5.1-11.2">2.04 (Changed)<a href="#section-5.1-11.2" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
</dl>
<p id="section-5.1-12">For the second interaction triggered by the above, the
registrant-EP takes the role of server and the RD takes the role of
client. (Note that this is exactly the well-known interface
of <span>[<a href="#RFC6690" class="xref">RFC6690</a>], <a href="https://www.rfc-editor.org/rfc/rfc6690#section-4" class="relref">Section 4</a></span>):<a href="#section-5.1-12" class="pilcrow">¶</a></p>
<span class="break"></span><dl class="dlParallel" id="section-5.1-13">
<dt id="section-5.1-13.1">Interaction:</dt>
<dd style="margin-left: 1.5em" id="section-5.1-13.2">RD -> EP<a href="#section-5.1-13.2" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-5.1-13.3">Method:</dt>
<dd style="margin-left: 1.5em" id="section-5.1-13.4">GET<a href="#section-5.1-13.4" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-5.1-13.5">URI Template:</dt>
<dd style="margin-left: 1.5em" id="section-5.1-13.6">
<code>/.well-known/core</code><a href="#section-5.1-13.6" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
</dl>
<p id="section-5.1-14">The following response is expected on this interface:<a href="#section-5.1-14" class="pilcrow">¶</a></p>
<span class="break"></span><dl class="dlParallel" id="section-5.1-15">
<dt id="section-5.1-15.1">Success:</dt>
<dd style="margin-left: 1.5em" id="section-5.1-15.2">2.05 (Content)<a href="#section-5.1-15.2" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
</dl>
<p id="section-5.1-16">When the RD uses any authorization credentials to access the endpoint's discovery
resource or when it is deployed in a location where third parties might reach it but not
the endpoint, it <span class="bcp14">SHOULD</span> verify that the apparent registrant-EP intends to
register with the given registration parameters
before revealing the obtained discovery information to lookup clients.
An easy way to do that is to verify the simple registration request's sender address using
the Echo option, as described in <span>[<a href="#RFC9175" class="xref">RFC9175</a>], <a href="https://www.rfc-editor.org/rfc/rfc9175#section-2.4" class="relref">Section 2.4</a></span>.<a href="#section-5.1-16" class="pilcrow">¶</a></p>
<p id="section-5.1-17">The RD <span class="bcp14">MUST</span> delete registrations created by simple registration after the expiration of their lifetime. Additional operations on the registration resource cannot be executed because no registration location is returned.<a href="#section-5.1-17" class="pilcrow">¶</a></p>
</section>
</div>
<div id="third-party-registration">
<section id="section-5.2">
<h3 id="name-third-party-registration">
<a href="#section-5.2" class="section-number selfRef">5.2. </a><a href="#name-third-party-registration" class="section-name selfRef">Third-Party Registration</a>
</h3>
<p id="section-5.2-1">For some applications, even simple registration may be too taxing
for some very constrained devices, in particular, if the security requirements
become too onerous.<a href="#section-5.2-1" class="pilcrow">¶</a></p>
<p id="section-5.2-2">In a controlled environment (e.g., building control), the RD
can be filled by a third-party device, called a Commissioning Tool (CT). The CT can fill the RD from a database or other means. For
that purpose scheme, the IP address and port of the URI of the registered device is
the value of the "base" parameter of the registration described in <a href="#registration" class="xref">Section 5</a>.<a href="#section-5.2-2" class="pilcrow">¶</a></p>
<p id="section-5.2-3">It should be noted that the value of the "base" parameter applies to all the links of the registration and has consequences for the anchor value of the individual links, as exemplified in <a href="#weblink" class="xref">Appendix B</a>. A potential (currently nonexistent) "base" attribute of the link is not affected by the value of "base" parameter in the registration.<a href="#section-5.2-3" class="pilcrow">¶</a></p>
</section>
</div>
<div id="operations-on-the-registration-resource">
<section id="section-5.3">
<h3 id="name-operations-on-the-registrat">
<a href="#section-5.3" class="section-number selfRef">5.3. </a><a href="#name-operations-on-the-registrat" class="section-name selfRef">Operations on the Registration Resource</a>
</h3>
<p id="section-5.3-1">This section describes how the registering endpoint can maintain the registrations that it created. The registering endpoint can be the registrant-EP or the CT. The registrations are resources of the RD.<a href="#section-5.3-1" class="pilcrow">¶</a></p>
<p id="section-5.3-2">An endpoint should not use this interface for registrations that it did not create.
This is usually enforced by security policies,
which, in general, require equivalent credentials for creation of and operations on a
registration.<a href="#section-5.3-2" class="pilcrow">¶</a></p>
<p id="section-5.3-3">After the initial registration, the registering endpoint retains the returned location of the registration resource for further operations, including refreshing the registration in order to extend the lifetime and "keep-alive" the registration. When the lifetime of the registration has expired, the RD <span class="bcp14">SHOULD NOT</span> respond to discovery queries concerning this endpoint. The RD <span class="bcp14">SHOULD</span> continue to provide access to the registration resource after a registration timeout occurs in order to enable the registering endpoint to eventually refresh the registration. The RD <span class="bcp14">MAY</span> eventually remove the registration resource for the purpose of garbage collection. If the registration resource is removed, the corresponding endpoint will need to be reregistered.<a href="#section-5.3-3" class="pilcrow">¶</a></p>
<p id="section-5.3-4">The registration resource may also be used to cancel the registration using DELETE and to perform further operations beyond the scope of this specification.<a href="#section-5.3-4" class="pilcrow">¶</a></p>
<p id="section-5.3-5">Operations on the registration resource are sensitive to reordering;
<a href="#freshness" class="xref">Section 5.3.4</a> describes how order is restored.<a href="#section-5.3-5" class="pilcrow">¶</a></p>
<p id="section-5.3-6">The operations on the registration resource are described below.<a href="#section-5.3-6" class="pilcrow">¶</a></p>
<div id="update">
<section id="section-5.3.1">
<h4 id="name-registration-update">
<a href="#section-5.3.1" class="section-number selfRef">5.3.1. </a><a href="#name-registration-update" class="section-name selfRef">Registration Update</a>
</h4>
<p id="section-5.3.1-1">The update interface is used by the registering endpoint to refresh or update its
registration with an RD. To use the interface, the registering endpoint sends a POST request to the registration resource returned by the initial registration operation.<a href="#section-5.3.1-1" class="pilcrow">¶</a></p>
<p id="section-5.3.1-2">An update <span class="bcp14">MAY</span> update registration parameters, such as lifetime, base URI, or others.
Parameters that are not being changed should not
be included in an update. Adding parameters that have not changed increases
the size of the message but does not have any other implications.
Parameters are included as query parameters in an update operation, as
in <a href="#registration" class="xref">Section 5</a>.<a href="#section-5.3.1-2" class="pilcrow">¶</a></p>
<p id="section-5.3.1-3">A registration update resets the timeout of the registration to the (possibly
updated) lifetime of the registration, independent of whether an <code>lt</code> parameter
was given.<a href="#section-5.3.1-3" class="pilcrow">¶</a></p>
<p id="section-5.3.1-4">If the base URI of the registration is changed in an update,
relative references submitted in the original registration or later updates are resolved anew against the new base.<a href="#section-5.3.1-4" class="pilcrow">¶</a></p>
<p id="section-5.3.1-5">The registration update operation only describes the use of POST with an empty payload.
Future standards might describe the semantics of using content formats and payloads
with the POST method to update the links of a registration (see <a href="#link-up" class="xref">Section 5.3.3</a>).<a href="#section-5.3.1-5" class="pilcrow">¶</a></p>
<p id="section-5.3.1-6">The update registration request interface is specified as follows:<a href="#section-5.3.1-6" class="pilcrow">¶</a></p>
<span class="break"></span><dl class="dlParallel" id="section-5.3.1-7">
<dt id="section-5.3.1-7.1">Interaction:</dt>
<dd style="margin-left: 1.5em" id="section-5.3.1-7.2">EP or CT -> RD<a href="#section-5.3.1-7.2" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-5.3.1-7.3">Method:</dt>
<dd style="margin-left: 1.5em" id="section-5.3.1-7.4">POST<a href="#section-5.3.1-7.4" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-5.3.1-7.5">URI Template:</dt>
<dd style="margin-left: 1.5em" id="section-5.3.1-7.6">{+location}{?lt,base,extra-attrs*}<a href="#section-5.3.1-7.6" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-5.3.1-7.7">URI Template Variables:</dt>
<dd style="margin-left: 1.5em" id="section-5.3.1-7.8">
<p id="section-5.3.1-7.8.1"><br></p>
<span class="break"></span><dl class="dlParallel" id="section-5.3.1-7.8.2">
<dt id="section-5.3.1-7.8.2.1">location :=</dt>
<dd style="margin-left: 1.5em" id="section-5.3.1-7.8.2.2">This is the location returned by the RD as a result of a successful
earlier registration.<a href="#section-5.3.1-7.8.2.2" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-5.3.1-7.8.2.3">lt :=</dt>
<dd style="margin-left: 1.5em" id="section-5.3.1-7.8.2.4">Lifetime (optional). This is the lifetime of the registration in seconds,
with a range of 1-4294967295. If no lifetime is included, the previous last
lifetime set on a previous update or the original registration
(falling back to 90000) <span class="bcp14">SHOULD</span> be used.<a href="#section-5.3.1-7.8.2.4" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-5.3.1-7.8.2.5">base :=</dt>
<dd style="margin-left: 1.5em" id="section-5.3.1-7.8.2.6">
<p id="section-5.3.1-7.8.2.6.1">Base URI (optional). This parameter updates the base URI established in the
original registration to a new value and is subject to
the same restrictions as in the registration.<a href="#section-5.3.1-7.8.2.6.1" class="pilcrow">¶</a></p>
<p id="section-5.3.1-7.8.2.6.2">If the parameter is set in an update, it is stored by the RD as the new
base URI under which to interpret the relative links present in the payload of
the original registration.<a href="#section-5.3.1-7.8.2.6.2" class="pilcrow">¶</a></p>
<p id="section-5.3.1-7.8.2.6.3">If the parameter is not set in the request but was set before, the previous
base URI value is kept unmodified.<a href="#section-5.3.1-7.8.2.6.3" class="pilcrow">¶</a></p>
<p id="section-5.3.1-7.8.2.6.4">If the parameter is not set in the request and was not set before either, the
source address and source port of the update request are stored as the
base URI.<a href="#section-5.3.1-7.8.2.6.4" class="pilcrow">¶</a></p>
</dd>
<dd class="break"></dd>
<dt id="section-5.3.1-7.8.2.7">extra-attrs :=</dt>
<dd style="margin-left: 1.5em" id="section-5.3.1-7.8.2.8">
<p id="section-5.3.1-7.8.2.8.1">Additional registration attributes (optional). As with the registration,
the RD processes them if it knows their semantics. Otherwise, unknown
attributes are stored as endpoint attributes, overriding any previously
stored endpoint attributes of the same key.<a href="#section-5.3.1-7.8.2.8.1" class="pilcrow">¶</a></p>
<p id="section-5.3.1-7.8.2.8.2">Note that this default behavior does not allow removing an endpoint attribute
in an update. For attributes whose functionality depends on the endpoints'
ability to remove them in an update,
it can make sense to define a value whose presence is equivalent to the absence
of a value. As an alternative, an extension can define different updating rules
for their attributes. That necessitates either discovering whether the RD is
aware of that extension or tolerating the default behavior.<a href="#section-5.3.1-7.8.2.8.2" class="pilcrow">¶</a></p>
</dd>
<dd class="break"></dd>
</dl>
</dd>
<dd class="break"></dd>
<dt id="section-5.3.1-7.9">Content-Format:</dt>
<dd style="margin-left: 1.5em" id="section-5.3.1-7.10">none (no payload)<a href="#section-5.3.1-7.10" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
</dl>
<p id="section-5.3.1-8">The following responses are expected on this interface:<a href="#section-5.3.1-8" class="pilcrow">¶</a></p>
<span class="break"></span><dl class="dlParallel" id="section-5.3.1-9">
<dt id="section-5.3.1-9.1">Success:</dt>
<dd style="margin-left: 1.5em" id="section-5.3.1-9.2">2.04 (Changed) or 204 (No Content) if the update was successfully processed.<a href="#section-5.3.1-9.2" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-5.3.1-9.3">Failure:</dt>
<dd style="margin-left: 1.5em" id="section-5.3.1-9.4">4.04 (Not Found) or 404 (Not Found). Registration does not exist (e.g., may have
been removed).<a href="#section-5.3.1-9.4" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
</dl>
<p id="section-5.3.1-10">If the registration update fails in any way, including "Not Found" and request timeouts,
or if the time indicated in a Service Unavailable Max-Age/Retry-After exceeds the remaining lifetime,
the registering endpoint <span class="bcp14">SHOULD</span> attempt registration again.<a href="#section-5.3.1-10" class="pilcrow">¶</a></p>
<p id="section-5.3.1-11">The following example shows how the registering endpoint resets the timeout on its registration resource at
an RD using this interface with the example location value /rd/4521:<a href="#section-5.3.1-11" class="pilcrow">¶</a></p>
<span id="name-example-update-of-a-registr"></span><div id="example-update">
<figure id="figure-13">
<div id="section-5.3.1-12.1">
<pre class="sourcecode">
Req: POST /rd/4521
Res: 2.04 Changed
</pre>
</div>
<figcaption><a href="#figure-13" class="selfRef">Figure 13</a>:
<a href="#name-example-update-of-a-registr" class="selfRef">Example Update of a Registration</a>
</figcaption></figure>
</div>
<p id="section-5.3.1-13">The following example shows the registering endpoint updating its registration resource at
an RD using this interface with the example location value /rd/4521. The initial registration by the registering endpoint set the following values:<a href="#section-5.3.1-13" class="pilcrow">¶</a></p>
<ul class="normal">
<li class="normal" id="section-5.3.1-14.1">endpoint name (ep)=endpoint1<a href="#section-5.3.1-14.1" class="pilcrow">¶</a>
</li>
<li class="normal" id="section-5.3.1-14.2">lifetime (lt)=500<a href="#section-5.3.1-14.2" class="pilcrow">¶</a>
</li>
<li class="normal" id="section-5.3.1-14.3">base URI (base)=coap://local-proxy-old.example.com<a href="#section-5.3.1-14.3" class="pilcrow">¶</a>
</li>
<li class="normal" id="section-5.3.1-14.4">payload of <a href="#example-payload" class="xref">Figure 8</a><a href="#section-5.3.1-14.4" class="pilcrow">¶</a>
</li>
</ul>
<p id="section-5.3.1-15">The initial state of the RD is reflected in the following request:<a href="#section-5.3.1-15" class="pilcrow">¶</a></p>
<span id="name-example-lookup-before-a-cha"></span><div id="example-update-base-lookup-pre">
<figure id="figure-14">
<div id="section-5.3.1-16.1">
<pre class="sourcecode">
Req: GET /rd-lookup/res?ep=endpoint1
Res: 2.05 Content
Payload:
<coap://local-proxy-old.example.com/sensors/temp>;
rt=temperature-c;if=sensor,
<http://www.example.com/sensors/temp>;
anchor="coap://local-proxy-old.example.com/sensors/temp";
rel=describedby
</pre>
</div>
<figcaption><a href="#figure-14" class="selfRef">Figure 14</a>:
<a href="#name-example-lookup-before-a-cha" class="selfRef">Example Lookup Before a Change to the Base Address</a>
</figcaption></figure>
</div>
<p id="section-5.3.1-17">The following example shows the registering endpoint changing the base URI to <code>coaps://new.example.com:5684</code>:<a href="#section-5.3.1-17" class="pilcrow">¶</a></p>
<span id="name-example-registration-update"></span><div id="example-update-base">
<figure id="figure-15">
<div id="section-5.3.1-18.1">
<pre class="sourcecode">
Req: POST /rd/4521?base=coaps://new.example.com
Res: 2.04 Changed
</pre>
</div>
<figcaption><a href="#figure-15" class="selfRef">Figure 15</a>:
<a href="#name-example-registration-update" class="selfRef">Example Registration Update that Changes the Base Address</a>
</figcaption></figure>
</div>
<p id="section-5.3.1-19">The consecutive query returns:<a href="#section-5.3.1-19" class="pilcrow">¶</a></p>
<span id="name-example-lookup-after-a-chan"></span><div id="example-update-base-lookup-post">
<figure id="figure-16">
<div id="section-5.3.1-20.1">
<pre class="sourcecode">
Req: GET /rd-lookup/res?ep=endpoint1
Res: 2.05 Content
Payload:
<coaps://new.example.com/sensors/temp>;
rt=temperature-c;if=sensor,
<http://www.example.com/sensors/temp>;
anchor="coaps://new.example.com/sensors/temp";
rel=describedby
</pre>
</div>
<figcaption><a href="#figure-16" class="selfRef">Figure 16</a>:
<a href="#name-example-lookup-after-a-chan" class="selfRef">Example Lookup After a Change to the Base Address</a>
</figcaption></figure>
</div>
</section>
</div>
<div id="removal">
<section id="section-5.3.2">
<h4 id="name-registration-removal">
<a href="#section-5.3.2" class="section-number selfRef">5.3.2. </a><a href="#name-registration-removal" class="section-name selfRef">Registration Removal</a>
</h4>
<p id="section-5.3.2-1">Although RD registrations have soft state and will eventually time out after their
lifetime, the registering endpoint <span class="bcp14">SHOULD</span> explicitly remove an entry from the RD if it
knows it will no longer be available (for example, on shutdown). This is
accomplished using a removal interface on the RD by performing a DELETE on
the endpoint resource.<a href="#section-5.3.2-1" class="pilcrow">¶</a></p>
<p id="section-5.3.2-2">The removal request interface is specified as follows:<a href="#section-5.3.2-2" class="pilcrow">¶</a></p>
<span class="break"></span><dl class="dlParallel" id="section-5.3.2-3">
<dt id="section-5.3.2-3.1">Interaction:</dt>
<dd style="margin-left: 1.5em" id="section-5.3.2-3.2">EP or CT -> RD<a href="#section-5.3.2-3.2" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-5.3.2-3.3">Method:</dt>
<dd style="margin-left: 1.5em" id="section-5.3.2-3.4">DELETE<a href="#section-5.3.2-3.4" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-5.3.2-3.5">URI Template:</dt>
<dd style="margin-left: 1.5em" id="section-5.3.2-3.6">{+location}<a href="#section-5.3.2-3.6" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-5.3.2-3.7">URI Template Variables:</dt>
<dd style="margin-left: 1.5em" id="section-5.3.2-3.8">
<p id="section-5.3.2-3.8.1"><br></p>
<span class="break"></span><dl class="dlParallel" id="section-5.3.2-3.8.2">
<dt id="section-5.3.2-3.8.2.1">location :=</dt>
<dd style="margin-left: 1.5em" id="section-5.3.2-3.8.2.2">This is the location returned by the RD as a result of a successful
earlier registration.<a href="#section-5.3.2-3.8.2.2" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
</dl>
</dd>
<dd class="break"></dd>
</dl>
<p id="section-5.3.2-4"> The following responses are expected on this interface:<a href="#section-5.3.2-4" class="pilcrow">¶</a></p>
<span class="break"></span><dl class="dlParallel" id="section-5.3.2-5">
<dt id="section-5.3.2-5.1">Success:</dt>
<dd style="margin-left: 1.5em" id="section-5.3.2-5.2">2.02 (Deleted) or 204 (No Content) upon successful deletion.<a href="#section-5.3.2-5.2" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-5.3.2-5.3">Failure:</dt>
<dd style="margin-left: 1.5em" id="section-5.3.2-5.4">4.04 (Not Found) or 404 (Not Found). Registration does not exist (e.g., may
already have been removed).<a href="#section-5.3.2-5.4" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
</dl>
<p id="section-5.3.2-6">The following example shows successful removal of the endpoint from the RD
with example location value /rd/4521:<a href="#section-5.3.2-6" class="pilcrow">¶</a></p>
<span id="name-example-of-a-registration-r"></span><div id="example-removal">
<figure id="figure-17">
<div id="section-5.3.2-7.1">
<pre class="sourcecode">
Req: DELETE /rd/4521
Res: 2.02 Deleted
</pre>
</div>
<figcaption><a href="#figure-17" class="selfRef">Figure 17</a>:
<a href="#name-example-of-a-registration-r" class="selfRef">Example of a Registration Removal</a>
</figcaption></figure>
</div>
</section>
</div>
<div id="link-up">
<section id="section-5.3.3">
<h4 id="name-further-operations">
<a href="#section-5.3.3" class="section-number selfRef">5.3.3. </a><a href="#name-further-operations" class="section-name selfRef">Further Operations</a>
</h4>
<p id="section-5.3.3-1">Additional operations on the registration can be specified in future documents, for
example:<a href="#section-5.3.3-1" class="pilcrow">¶</a></p>
<ul class="normal">
<li class="normal" id="section-5.3.3-2.1">Send iPATCH (or PATCH) updates <span>[<a href="#RFC8132" class="xref">RFC8132</a>]</span> to add,
remove, or change the links of a registration.<a href="#section-5.3.3-2.1" class="pilcrow">¶</a>
</li>
<li class="normal" id="section-5.3.3-2.2">Use GET to read the currently stored set of links in a registration resource.<a href="#section-5.3.3-2.2" class="pilcrow">¶</a>
</li>
</ul>
<p id="section-5.3.3-3">Those operations are out of scope of this document and will require media types suitable for modifying sets of links.<a href="#section-5.3.3-3" class="pilcrow">¶</a></p>
</section>
</div>
<div id="freshness">
<section id="section-5.3.4">
<h4 id="name-request-freshness">
<a href="#section-5.3.4" class="section-number selfRef">5.3.4. </a><a href="#name-request-freshness" class="section-name selfRef">Request Freshness</a>
</h4>
<p id="section-5.3.4-1">Some security mechanisms usable with an RD allow out-of-order request processing
or do not even mandate replay protection at all.
The RD needs to ensure that operations on the registration resource
are executed in an order that does not distort the client's intentions.<a href="#section-5.3.4-1" class="pilcrow">¶</a></p>
<p id="section-5.3.4-2">This ordering of operations is expressed in terms of freshness, as defined in <span>[<a href="#RFC9175" class="xref">RFC9175</a>]</span>.
Requests that alter a resource's state need to be fresh relative to the latest request
that altered that state in a conflicting way.<a href="#section-5.3.4-2" class="pilcrow">¶</a></p>
<p id="section-5.3.4-3">An RD <span class="bcp14">SHOULD</span> determine a request's freshness
and <span class="bcp14">MUST</span> use the Echo option if it requires request freshness and cannot determine it in any other way.
An endpoint <span class="bcp14">MUST</span> support the use of the Echo option.
(One reason why an RD would not require freshness is when no relevant registration properties are covered by its security policies.)<a href="#section-5.3.4-3" class="pilcrow">¶</a></p>
<div id="efficient-use-of-echo-by-an-rd">
<section id="section-5.3.4.1">
<h5 id="name-efficient-use-of-echo-by-an">
<a href="#section-5.3.4.1" class="section-number selfRef">5.3.4.1. </a><a href="#name-efficient-use-of-echo-by-an" class="section-name selfRef">Efficient Use of Echo by an RD</a>
</h5>
<p id="section-5.3.4.1-1">To keep latency and traffic added by the freshness requirements to a minimum,
RDs should avoid naive (sufficient but inefficient) freshness criteria.<a href="#section-5.3.4.1-1" class="pilcrow">¶</a></p>
<p id="section-5.3.4.1-2">Some simple mechanisms the RD can employ are:<a href="#section-5.3.4.1-2" class="pilcrow">¶</a></p>
<ul class="normal">
<li class="normal" id="section-5.3.4.1-3.1">
<p id="section-5.3.4.1-3.1.1">State counter. The RD can keep a monotonous counter that increments
whenever a registration changes. For every registration resource, it stores
the post-increment value of that resource's last change. Requests altering
them need to have at least that value encoded in their Echo option
and are otherwise rejected with a 4.01 (Unauthorized) and the current
counter value as the Echo value. If other applications on the same server
use Echo as well, that encoding may include a prefix indicating that it
pertains to the RD's counter.<a href="#section-5.3.4.1-3.1.1" class="pilcrow">¶</a></p>
<p id="section-5.3.4.1-3.1.2">The value associated with a resource needs to be kept across the removal
of registrations if the same registration resource is to be reused.<a href="#section-5.3.4.1-3.1.2" class="pilcrow">¶</a></p>
<p id="section-5.3.4.1-3.1.3">The counter can be reset (and the values of removed resources forgotten)
when all previous security associations are reset.<a href="#section-5.3.4.1-3.1.3" class="pilcrow">¶</a></p>
<p id="section-5.3.4.1-3.1.4">This is the "Persistent Counter" method of <span>[<a href="#RFC9175" class="xref">RFC9175</a>], <a href="https://www.rfc-editor.org/rfc/rfc9175#appendix-A" class="relref">Appendix A</a></span>.<a href="#section-5.3.4.1-3.1.4" class="pilcrow">¶</a></p>
</li>
<li class="normal" id="section-5.3.4.1-3.2">
<p id="section-5.3.4.1-3.2.1">Preemptive Echo values. The current state counter can be sent in an Echo
option not only when requests are rejected with 4.01 (Unauthorized) but
also with successful responses. Thus, clients can be provided with Echo
values sufficient for their next request on a regular basis. This is also described in <span><a href="https://www.rfc-editor.org/rfc/rfc9175#section-2.3" class="relref">Section 2.3</a> of [<a href="#RFC9175" class="xref">RFC9175</a>]</span><a href="#section-5.3.4.1-3.2.1" class="pilcrow">¶</a></p>
<p id="section-5.3.4.1-3.2.2"> While endpoints may discard received Echo values at leisure between
requests, they are encouraged to retain these values for the next request
to avoid additional round trips.<a href="#section-5.3.4.1-3.2.2" class="pilcrow">¶</a></p>
</li>
<li class="normal" id="section-5.3.4.1-3.3">If the RD can ensure that only one security association has modifying access to any registration at any given time
and that security association provides order on the requests,
that order is sufficient to show request freshness.<a href="#section-5.3.4.1-3.3" class="pilcrow">¶</a>
</li>
</ul>
</section>
</div>
<div id="examples-of-echo-usage">
<section id="section-5.3.4.2">
<h5 id="name-examples-of-echo-usage">
<a href="#section-5.3.4.2" class="section-number selfRef">5.3.4.2. </a><a href="#name-examples-of-echo-usage" class="section-name selfRef">Examples of Echo Usage</a>
</h5>
<p id="section-5.3.4.2-1"><a href="#example-freshness" class="xref">Figure 18</a> shows the interactions of an endpoint
that has forgotten the server's latest Echo value
and temporarily reduces its registration lifetime:<a href="#section-5.3.4.2-1" class="pilcrow">¶</a></p>
<span id="name-example-update-of-a-registra"></span><div id="example-freshness">
<figure id="figure-18">
<div id="section-5.3.4.2-2.1">
<pre class="sourcecode">
Req: POST /rd/4521?lt=7200
Res: 4.01 Unauthorized
Echo: 0x0123
(EP tries again immediately.)
Req: POST /rd/4521?lt=7200
Echo: 0x0123
Res: 2.04 Changed
Echo: 0x0124
(Later, the EP regains its confidence in its long-term reachability.)
Req: POST /rd/4521?lt=90000
Echo: 0x0124
Res: 2.04 Changed
Echo: 0x0247
</pre>
</div>
<figcaption><a href="#figure-18" class="selfRef">Figure 18</a>:
<a href="#name-example-update-of-a-registra" class="selfRef">Example Update of a Registration</a>
</figcaption></figure>
</div>
<p id="section-5.3.4.2-3">The other examples do not show Echo options for two reasons: (1) for simplicity
and (2) because they lack the context for any example values to have meaning.<a href="#section-5.3.4.2-3" class="pilcrow">¶</a></p>
</section>
</div>
</section>
</div>
</section>
</div>
</section>
</div>
<div id="lookup">
<section id="section-6">
<h2 id="name-rd-lookup">
<a href="#section-6" class="section-number selfRef">6. </a><a href="#name-rd-lookup" class="section-name selfRef">RD Lookup</a>
</h2>
<p id="section-6-1">To discover the resources registered with the RD,
a lookup interface must be provided. This lookup interface
is defined as a default, and it is assumed that RDs may also support lookups
to return resource descriptions in alternative formats (e.g., JSON or CBOR link format <span>[<a href="#I-D.ietf-core-links-json" class="xref">CORE-LINKS-JSON</a>]</span>)
or use more advanced interfaces (e.g., supporting context- or semantic-based lookup) on different resources that are discovered independently.<a href="#section-6-1" class="pilcrow">¶</a></p>
<p id="section-6-2">RD lookup allows lookups for endpoints and resources
using attributes defined in this document and for use with the CoRE
Link Format. The result of a lookup request is the list of links (if any)
corresponding to the type of lookup. Thus, an endpoint lookup <span class="bcp14">MUST</span> return a list of endpoints, and a resource lookup <span class="bcp14">MUST</span> return a list of links to resources.<a href="#section-6-2" class="pilcrow">¶</a></p>
<p id="section-6-3">The lookup type implemented by a lookup resource is indicated by a resource type, as per <a href="#lookup-types" class="xref">Table 1</a>:<a href="#section-6-3" class="pilcrow">¶</a></p>
<span id="name-lookup-types"></span><div id="lookup-types">
<table class="center" id="table-1">
<caption>
<a href="#table-1" class="selfRef">Table 1</a>:
<a href="#name-lookup-types" class="selfRef">Lookup Types</a>
</caption>
<thead>
<tr>
<th class="text-left" rowspan="1" colspan="1">Lookup Type</th>
<th class="text-left" rowspan="1" colspan="1">Resource Type</th>
<th class="text-left" rowspan="1" colspan="1">Mandatory</th>
</tr>
</thead>
<tbody>
<tr>
<td class="text-left" rowspan="1" colspan="1">Resource</td>
<td class="text-left" rowspan="1" colspan="1">core.rd-lookup-res</td>
<td class="text-left" rowspan="1" colspan="1">Mandatory</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">Endpoint</td>
<td class="text-left" rowspan="1" colspan="1">core.rd-lookup-ep</td>
<td class="text-left" rowspan="1" colspan="1">Mandatory</td>
</tr>
</tbody>
</table>
</div>
<div id="resource-lookup">
<section id="section-6.1">
<h3 id="name-resource-lookup">
<a href="#section-6.1" class="section-number selfRef">6.1. </a><a href="#name-resource-lookup" class="section-name selfRef">Resource Lookup</a>
</h3>
<p id="section-6.1-1">Resource lookup results in links that are semantically equivalent to the links submitted to the RD by the registrant.
The links and link parameters returned by the lookup are equal to the originally submitted ones,
except that the target reference is fully resolved
and that the anchor reference is fully resolved if it is present in the lookup result at all.<a href="#section-6.1-1" class="pilcrow">¶</a></p>
<p id="section-6.1-2">Links that did not have an anchor attribute in the registration are returned without an anchor attribute.
Links of which href or anchor was submitted as a (full) URI are returned with the respective attribute unmodified.<a href="#section-6.1-2" class="pilcrow">¶</a></p>
<p id="section-6.1-3">The above rules allow the client to interpret the response as links without any further knowledge of the storage conventions of the RD.
The RD <span class="bcp14">MAY</span> replace the registration base URIs with a configured intermediate proxy, e.g., in the case of an HTTP lookup interface for CoAP endpoints.<a href="#section-6.1-3" class="pilcrow">¶</a></p>
<p id="section-6.1-4">If the base URI of a registration contains a link-local address,
the RD <span class="bcp14">MUST NOT</span> show its links unless the lookup was made from the
link on which the registered endpoint can be reached.
The RD <span class="bcp14">MUST NOT</span> include zone identifiers in the resolved URIs.<a href="#section-6.1-4" class="pilcrow">¶</a></p>
</section>
</div>
<div id="lookup-filtering">
<section id="section-6.2">
<h3 id="name-lookup-filtering">
<a href="#section-6.2" class="section-number selfRef">6.2. </a><a href="#name-lookup-filtering" class="section-name selfRef">Lookup Filtering</a>
</h3>
<p id="section-6.2-1">Using the Accept option, the requester can control whether the returned list is returned in CoRE Link Format (<code>application/link-format</code>, default) or in alternate content formats (e.g., from <span>[<a href="#I-D.ietf-core-links-json" class="xref">CORE-LINKS-JSON</a>]</span>).<a href="#section-6.2-1" class="pilcrow">¶</a></p>
<p id="section-6.2-2">Multiple search criteria <span class="bcp14">MAY</span> be included in a lookup. All included criteria <span class="bcp14">MUST</span> match for a link to be returned. The RD <span class="bcp14">MUST</span> support matching with multiple search criteria.<a href="#section-6.2-2" class="pilcrow">¶</a></p>
<p id="section-6.2-3">A link matches a search criterion if it has an attribute of
the same name and the same value, allowing for a trailing "*"
wildcard operator, as in <span><a href="https://www.rfc-editor.org/rfc/rfc6690#section-4.1" class="relref">Section 4.1</a> of [<a href="#RFC6690" class="xref">RFC6690</a>]</span>. Attributes that are defined as
<code>relation-types</code> (in the link-format ABNF) match if the
search value matches any of their values (see <span><a href="https://www.rfc-editor.org/rfc/rfc6690#section-4.1" class="relref">Section 4.1</a> of [<a href="#RFC6690" class="xref">RFC6690</a>]</span>;
for example, <code>?if=tag:example.net,2020:sensor</code> matches
<code>;if="example.regname tag:example.net,2020:sensor";</code>.
A resource link also matches a search criterion if its
endpoint would match the criterion, and vice versa, an
endpoint link matches a search criterion if any of its
resource links matches it.<a href="#section-6.2-3" class="pilcrow">¶</a></p>
<p id="section-6.2-4">Note that <code>href</code> is a valid search criterion and matches target references. Like all search criteria, on a resource lookup, it can match the target reference of the resource link itself but also the registration resource of the endpoint that registered it.
Queries for resource link targets <span class="bcp14">MUST</span> be in URI form (i.e., not relative references) and are matched against a resolved link target. Queries for endpoints <span class="bcp14">SHOULD</span> be expressed in path-absolute form if possible and <span class="bcp14">MUST</span> be expressed in URI form otherwise; the RD <span class="bcp14">SHOULD</span> recognize either.
The <code>anchor</code> attribute is usable for resource lookups and, if queried, <span class="bcp14">MUST</span> be in URI form as well.<a href="#section-6.2-4" class="pilcrow">¶</a></p>
<p id="section-6.2-5">Additional query parameters "page" and "count" are used to obtain lookup results in specified increments using pagination, where count specifies how many links to return and page specifies which subset of links organized in sequential pages, each containing 'count' links, starting with link zero and page zero. Thus, specifying a count of 10 and page of 0 will return the first 10 links in the result set (links 0-9). Specifying a count of 10 and page of 1 will return the next 'page' containing links 10-19, and so on.
Unlike block-wise transfer of a complete result set,
these parameters ensure that each chunk of results can be interpreted on its own.
This simplifies the processing
but can result in duplicate or missed items when coinciding with changes from the registration interface.<a href="#section-6.2-5" class="pilcrow">¶</a></p>
<p id="section-6.2-6">Endpoints that are interested in a lookup result repeatedly or continuously can use
mechanisms such as ETag caching, resource observation <span>[<a href="#RFC7641" class="xref">RFC7641</a>]</span>,
or any future mechanism that might allow more efficient observations of collections.
These are advertised, detected, and used according to their own specifications
and can be used with the lookup interface as with any other resource.<a href="#section-6.2-6" class="pilcrow">¶</a></p>
<p id="section-6.2-7">When resource observation is used,
every time the set of matching links changes or the content of a matching link changes, the RD sends a notification with the matching link set.
The notification contains the successful current response to the given request,
especially with respect to representing zero matching links
(see "Success" item below).<a href="#section-6.2-7" class="pilcrow">¶</a></p>
<p id="section-6.2-8">The lookup interface is specified as follows:<a href="#section-6.2-8" class="pilcrow">¶</a></p>
<span class="break"></span><dl class="dlParallel" id="section-6.2-9">
<dt id="section-6.2-9.1">Interaction:</dt>
<dd style="margin-left: 1.5em" id="section-6.2-9.2">Client -> RD<a href="#section-6.2-9.2" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-6.2-9.3">Method:</dt>
<dd style="margin-left: 1.5em" id="section-6.2-9.4">GET<a href="#section-6.2-9.4" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-6.2-9.5">URI Template:</dt>
<dd style="margin-left: 1.5em" id="section-6.2-9.6">{+type-lookup-location}{?page,count,search*}<a href="#section-6.2-9.6" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-6.2-9.7">URI Template Variables:</dt>
<dd style="margin-left: 1.5em" id="section-6.2-9.8">
<p id="section-6.2-9.8.1"><br></p>
<span class="break"></span><dl class="dlParallel" id="section-6.2-9.8.2">
<dt id="section-6.2-9.8.2.1">type-lookup-location :=</dt>
<dd style="margin-left: 1.5em" id="section-6.2-9.8.2.2">RD lookup URI for a given lookup type (mandatory). The address is
discovered as described in <a href="#discovery" class="xref">Section 4.3</a>.<a href="#section-6.2-9.8.2.2" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-6.2-9.8.2.3">search := </dt>
<dd style="margin-left: 1.5em" id="section-6.2-9.8.2.4">
<p id="section-6.2-9.8.2.4.1"> Search criteria for limiting the number of results (optional). The search
criteria are an associative array, expressed in a form-style query,
as per the URI Template (see <span>[<a href="#RFC6570" class="xref">RFC6570</a>]</span>, Sections
<a href="https://www.rfc-editor.org/rfc/rfc6570#section-2.4.2" class="relref">2.4.2</a> and <a href="https://www.rfc-editor.org/rfc/rfc6570#section-3.2.8" class="relref">3.2.8</a>).<a href="#section-6.2-9.8.2.4.1" class="pilcrow">¶</a></p>
</dd>
<dd class="break"></dd>
<dt id="section-6.2-9.8.2.5">page :=</dt>
<dd style="margin-left: 1.5em" id="section-6.2-9.8.2.6">Page (optional). This parameter cannot be used without the count
parameter. Results are returned from result set in pages that contain
'count' links starting from index (page * count). Page numbering starts
with zero.<a href="#section-6.2-9.8.2.6" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-6.2-9.8.2.7">count := </dt>
<dd style="margin-left: 1.5em" id="section-6.2-9.8.2.8">Count (optional). The number of results is limited to this parameter value. If
the page parameter is also present, the response <span class="bcp14">MUST</span> only include
'count' links starting with the (page * count) link in the result set from the
query. If the count parameter is not present, then the response <span class="bcp14">MUST</span>
return all matching links in the result set. Link numbering starts with zero.<a href="#section-6.2-9.8.2.8" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
</dl>
</dd>
<dd class="break"></dd>
<dt id="section-6.2-9.9">Accept:</dt>
<dd style="margin-left: 1.5em" id="section-6.2-9.10">absent, <code>application/link-format</code>, or any other indicated media type representing web
links<a href="#section-6.2-9.10" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
</dl>
<p id="section-6.2-10"> The following responses codes are defined for this interface:<a href="#section-6.2-10" class="pilcrow">¶</a></p>
<span class="break"></span><dl class="dlParallel" id="section-6.2-11">
<dt id="section-6.2-11.1">Success:</dt>
<dd style="margin-left: 1.5em" id="section-6.2-11.2">
<p id="section-6.2-11.2.1">2.05 (Content) or 200 (OK) with an <code>application/link-format</code> or other
web link payload containing matching entries for the lookup.<a href="#section-6.2-11.2.1" class="pilcrow">¶</a></p>
<p id="section-6.2-11.2.2">The payload can contain zero links (which is an empty payload in the link format described in <span>[<a href="#RFC6690" class="xref">RFC6690</a>]</span> but could also be <code>[]</code>
in JSON-based formats), indicating that no entities matched the request.<a href="#section-6.2-11.2.2" class="pilcrow">¶</a></p>
</dd>
<dd class="break"></dd>
</dl>
</section>
</div>
<div id="resource-lookup-examples">
<section id="section-6.3">
<h3 id="name-resource-lookup-examples">
<a href="#section-6.3" class="section-number selfRef">6.3. </a><a href="#name-resource-lookup-examples" class="section-name selfRef">Resource Lookup Examples</a>
</h3>
<p id="section-6.3-1">The examples in this section assume the existence of CoAP hosts with a default CoAP port 61616. HTTP hosts are possible and do not change the nature of the examples.<a href="#section-6.3-1" class="pilcrow">¶</a></p>
<p id="section-6.3-2">The following example shows a client performing a resource lookup with the example resource lookup locations discovered in <a href="#example-discovery" class="xref">Figure 5</a>:<a href="#section-6.3-2" class="pilcrow">¶</a></p>
<span id="name-example-of-a-resource-looku"></span><div id="example-lookup-res">
<figure id="figure-19">
<div id="section-6.3-3.1">
<pre class="sourcecode">
Req: GET /rd-lookup/res?rt=tag:example.org,2020:temperature
Res: 2.05 Content
Payload:
<coap://[2001:db8:3::123]:61616/temp>;
rt="tag:example.org,2020:temperature"
</pre>
</div>
<figcaption><a href="#figure-19" class="selfRef">Figure 19</a>:
<a href="#name-example-of-a-resource-looku" class="selfRef">Example of a Resource Lookup</a>
</figcaption></figure>
</div>
<p id="section-6.3-4">A client that wants to be notified of new resources as they show up can use
this observation:<a href="#section-6.3-4" class="pilcrow">¶</a></p>
<span id="name-example-of-an-observing-res"></span><div id="example-lookup-obs">
<figure id="figure-20">
<div id="section-6.3-5.1">
<pre class="sourcecode">
Req: GET /rd-lookup/res?rt=tag:example.org,2020:light
Observe: 0
Res: 2.05 Content
Observe: 23
Payload: empty
(at a later point in time)
Res: 2.05 Content
Observe: 24
Payload:
<coap://[2001:db8:3::124]/west>;rt="tag:example.org,2020:light",
<coap://[2001:db8:3::124]/south>;rt="tag:example.org,2020:light",
<coap://[2001:db8:3::124]/east>;rt="tag:example.org,2020:light"
</pre>
</div>
<figcaption><a href="#figure-20" class="selfRef">Figure 20</a>:
<a href="#name-example-of-an-observing-res" class="selfRef">Example of an Observing Resource Lookup</a>
</figcaption></figure>
</div>
<p id="section-6.3-6">The following example shows a client performing a paginated resource lookup:<a href="#section-6.3-6" class="pilcrow">¶</a></p>
<span id="name-example-of-paginated-resour"></span><div id="example-lookup-page">
<figure id="figure-21">
<div id="section-6.3-7.1">
<pre class="sourcecode">
Req: GET /rd-lookup/res?page=0&count=5
Res: 2.05 Content
Payload:
<coap://[2001:db8:3::123]:61616/res/0>;ct=60,
<coap://[2001:db8:3::123]:61616/res/1>;ct=60,
<coap://[2001:db8:3::123]:61616/res/2>;ct=60,
<coap://[2001:db8:3::123]:61616/res/3>;ct=60,
<coap://[2001:db8:3::123]:61616/res/4>;ct=60
Req: GET /rd-lookup/res?page=1&count=5
Res: 2.05 Content
Payload:
<coap://[2001:db8:3::123]:61616/res/5>;ct=60,
<coap://[2001:db8:3::123]:61616/res/6>;ct=60,
<coap://[2001:db8:3::123]:61616/res/7>;ct=60,
<coap://[2001:db8:3::123]:61616/res/8>;ct=60,
<coap://[2001:db8:3::123]:61616/res/9>;ct=60
</pre>
</div>
<figcaption><a href="#figure-21" class="selfRef">Figure 21</a>:
<a href="#name-example-of-paginated-resour" class="selfRef">Example of Paginated Resource Lookup</a>
</figcaption></figure>
</div>
<p id="section-6.3-8">The following example shows a client performing a lookup of all resources
of all endpoints of a given endpoint type. It assumes that two endpoints (with endpoint
names <code>sensor1</code> and <code>sensor2</code>) have previously registered with their respective
addresses (<code>coap://sensor1.example.com</code> and <code>coap://sensor2.example.com</code>) and
posted the very payload of the 6th response of <span><a href="https://www.rfc-editor.org/rfc/rfc6690#section-5" class="relref">Section 5</a> of [<a href="#RFC6690" class="xref">RFC6690</a>]</span>.<a href="#section-6.3-8" class="pilcrow">¶</a></p>
<p id="section-6.3-9">It demonstrates how absolute link targets stay unmodified, while relative ones
are resolved:<a href="#section-6.3-9" class="pilcrow">¶</a></p>
<span id="name-example-of-a-resource-lookup"></span><div id="example-lookup-multiple">
<figure id="figure-22">
<div id="section-6.3-10.1">
<pre class="sourcecode">
Req: GET /rd-lookup/res?et=tag:example.com,2020:platform
Res: 2.05 Content
Payload:
<coap://sensor1.example.com/sensors>;ct=40;title="Sensor Index",
<coap://sensor1.example.com/sensors/temp>;rt=temperature-c;if=sensor,
<coap://sensor1.example.com/sensors/light>;rt=light-lux;if=sensor,
<http://www.example.com/sensors/t123>;rel=describedby;
anchor="coap://sensor1.example.com/sensors/temp",
<coap://sensor1.example.com/t>;rel=alternate;
anchor="coap://sensor1.example.com/sensors/temp",
<coap://sensor2.example.com/sensors>;ct=40;title="Sensor Index",
<coap://sensor2.example.com/sensors/temp>;rt=temperature-c;if=sensor,
<coap://sensor2.example.com/sensors/light>;rt=light-lux;if=sensor,
<http://www.example.com/sensors/t123>;rel=describedby;
anchor="coap://sensor2.example.com/sensors/temp",
<coap://sensor2.example.com/t>;rel=alternate;
anchor="coap://sensor2.example.com/sensors/temp"
</pre>
</div>
<figcaption><a href="#figure-22" class="selfRef">Figure 22</a>:
<a href="#name-example-of-a-resource-lookup" class="selfRef">Example of a Resource Lookup from Multiple Endpoints</a>
</figcaption></figure>
</div>
</section>
</div>
<div id="ep-lookup">
<section id="section-6.4">
<h3 id="name-endpoint-lookup">
<a href="#section-6.4" class="section-number selfRef">6.4. </a><a href="#name-endpoint-lookup" class="section-name selfRef">Endpoint Lookup</a>
</h3>
<p id="section-6.4-1">The endpoint lookup returns links to and information about registration resources,
which themselves can only be manipulated by the registering endpoint.<a href="#section-6.4-1" class="pilcrow">¶</a></p>
<p id="section-6.4-2">Endpoint registration resources are annotated with their endpoint names (ep), sectors
(d, if present), and registration base URI (base; reports the registrant-EP's address if
no explicit base was given), as well as a constant resource type (rt="core.rd-ep"); the
lifetime (lt) is not reported.
Additional endpoint attributes are added as target attributes to their endpoint link
unless their specification says otherwise.<a href="#section-6.4-2" class="pilcrow">¶</a></p>
<p id="section-6.4-3">Links to endpoints <span class="bcp14">SHOULD</span> be presented in path-absolute form or, if
required, as (full) URIs. (This ensures that the output conforms to Limited Link Format,
as described in <a href="#limitedlinkformat" class="xref">Appendix C</a>.)<a href="#section-6.4-3" class="pilcrow">¶</a></p>
<p id="section-6.4-4">Base addresses that contain link-local addresses <span class="bcp14">MUST NOT</span> include zone
identifiers, and such registrations <span class="bcp14">MUST NOT</span> be shown unless the lookup was made from the same link from which the
registration was made.<a href="#section-6.4-4" class="pilcrow">¶</a></p>
<p id="section-6.4-5">While the endpoint lookup does expose the registration resources,
the RD does not need to make them accessible to clients.
Clients <span class="bcp14">SHOULD NOT</span> attempt to dereference or manipulate them.<a href="#section-6.4-5" class="pilcrow">¶</a></p>
<p id="section-6.4-6"> An RD can report registrations in lookup whose URI scheme and
authority differ from that of the lookup resource.
Lookup clients <span class="bcp14">MUST</span> be prepared to see arbitrary URIs as registration
resources in the results and treat them as opaque identifiers;
the precise semantics of such links are left to future specifications.<a href="#section-6.4-6" class="pilcrow">¶</a></p>
<p id="section-6.4-7">The following example shows a client performing an endpoint lookup that is limited to
endpoints of endpoint type <code>tag:example.com,2020:platform</code>:<a href="#section-6.4-7" class="pilcrow">¶</a></p>
<span id="name-example-of-endpoint-lookup"></span><div id="example-lookup-ep">
<figure id="figure-23">
<div id="section-6.4-8.1">
<pre class="sourcecode">
Req: GET /rd-lookup/ep?et=tag:example.com,2020:platform
Res: 2.05 Content
Payload:
</rd/1234>;base="coap://[2001:db8:3::127]:61616";ep=node5;
et="tag:example.com,2020:platform";ct=40;rt=core.rd-ep,
</rd/4521>;base="coap://[2001:db8:3::129]:61616";ep=node7;
et="tag:example.com,2020:platform";ct=40;d=floor-3;
rt=core.rd-ep
</pre>
</div>
<figcaption><a href="#figure-23" class="selfRef">Figure 23</a>:
<a href="#name-example-of-endpoint-lookup" class="selfRef">Example of Endpoint Lookup</a>
</figcaption></figure>
</div>
</section>
</div>
</section>
</div>
<div id="policies">
<section id="section-7">
<h2 id="name-security-policies">
<a href="#section-7" class="section-number selfRef">7. </a><a href="#name-security-policies" class="section-name selfRef">Security Policies</a>
</h2>
<p id="section-7-1">The security policies that are applicable to an RD strongly depend on the application
and are not set out normatively here.<a href="#section-7-1" class="pilcrow">¶</a></p>
<p id="section-7-2">This section provides a list of aspects that applications should consider when describing their use of the RD,
without claiming to cover all cases.
It uses terminology of <span>[<a href="#I-D.ietf-ace-oauth-authz" class="xref">ACE-OAUTH-AUTHZ</a>]</span>,
in which the RD acts as the Resource Server (RS), and both registrant-EPs and lookup clients act as Clients (C) with support from an Authorization Server (AS),
without the intention of ruling out other schemes (e.g., those based on certificates/Public Key Infrastructures (PKIs)).<a href="#section-7-2" class="pilcrow">¶</a></p>
<p id="section-7-3">Any, all, or none of the below can apply to an application.
Which are relevant depends on its protection objectives.<a href="#section-7-3" class="pilcrow">¶</a></p>
<p id="section-7-4">Security policies are set by configuration of the RD or by choice of the implementation.
Lookup clients (and, where relevant, endpoints) can only trust an RD to uphold them if it is authenticated
and authorized to serve as an RD according to the application's requirements.<a href="#section-7-4" class="pilcrow">¶</a></p>
<div id="secure-ep">
<section id="section-7.1">
<h3 id="name-endpoint-name">
<a href="#section-7.1" class="section-number selfRef">7.1. </a><a href="#name-endpoint-name" class="section-name selfRef">Endpoint Name</a>
</h3>
<p id="section-7.1-1">Whenever an RD needs to provide trustworthy results to clients doing endpoint lookup
or resource lookup with filtering on the endpoint name,
the RD must ensure that the registrant is authorized to use the given endpoint name.
This applies both to registration and later to operations on the registration resource.
It is immaterial whether the client is the registrant-EP itself or a CT is doing the registration.
The RD cannot tell the difference, and CTs may use authorization credentials authorizing only operations on that particular endpoint name or a wider range of endpoint names.<a href="#section-7.1-1" class="pilcrow">¶</a></p>
<p id="section-7.1-2">It is up to the concrete security policy to describe
how the endpoint name and sector are transported when certificates are used.
For example, it may describe how SubjectAltName dNSName entries are mapped to endpoint and domain names.<a href="#section-7.1-2" class="pilcrow">¶</a></p>
<div id="arbitrary-ep">
<section id="section-7.1.1">
<h4 id="name-random-endpoint-names">
<a href="#section-7.1.1" class="section-number selfRef">7.1.1. </a><a href="#name-random-endpoint-names" class="section-name selfRef">Random Endpoint Names</a>
</h4>
<p id="section-7.1.1-1">Conversely, in applications where the RD does not check the endpoint name,
the authorized registering endpoint can generate a random number (or string) that identifies the endpoint.
The RD should then remember unique properties of the registrant,
associate them with the registration for as long as its registration resource is active (which may be longer than the registration's lifetime),
and require the same properties for operations on the registration resource.<a href="#section-7.1.1-1" class="pilcrow">¶</a></p>
<p id="section-7.1.1-2">Registrants that are prepared to pick a different identifier when their initial attempt
(or attempts, in the unlikely case of two subsequent collisions)
at registration is unauthorized should pick an identifier at least twice as long as would be needed to enumerate the expected number of registrants;
registrants without any such recovery options should pick significantly longer endpoint names (e.g., using Universally Unique Identifier (UUID) URNs <span>[<a href="#RFC4122" class="xref">RFC4122</a>]</span>).<a href="#section-7.1.1-2" class="pilcrow">¶</a></p>
</section>
</div>
</section>
</div>
<div id="entered-links">
<section id="section-7.2">
<h3 id="name-entered-links">
<a href="#section-7.2" class="section-number selfRef">7.2. </a><a href="#name-entered-links" class="section-name selfRef">Entered Links</a>
</h3>
<p id="section-7.2-1">When lookup clients expect that certain types of links can only originate from certain endpoints,
then the RD needs to apply filtering to the links an endpoint may register.<a href="#section-7.2-1" class="pilcrow">¶</a></p>
<p id="section-7.2-2">For example, if clients use an RD to find a server that provides firmware updates,
then any registrant that wants to register (or update) links to firmware sources will need to provide suitable credentials to do so, independently of its endpoint name.<a href="#section-7.2-2" class="pilcrow">¶</a></p>
<p id="section-7.2-3">Note that the impact of having undesirable links in the RD depends on the application.
If the client requires the firmware server to present credentials as a firmware server,
a fraudulent link's impact is limited to the client revealing its intention to obtain updates and slowing down the client until it finds a legitimate firmware server;
if the client accepts any credentials from the server as long as they fit the provided URI, the impact is larger.<a href="#section-7.2-3" class="pilcrow">¶</a></p>
<p id="section-7.2-4">An RD may also require that links are only registered if the registrant is authorized to publish information about the anchor (or even target) of the link.
One way to do this is to demand that the registrant present the same credentials in its role as a registering client that it would need to present in its role as a server when contacted at the resources' URI. These credentials may include using the address and port that are part of the URI.
Such a restriction places severe practical limitations on the links that can be registered.<a href="#section-7.2-4" class="pilcrow">¶</a></p>
<p id="section-7.2-5">As above, the impact of undesirable links depends on the extent to which the lookup client relies on the RD.
To avoid the limitations, RD applications should consider prescribing that lookup clients only use the discovered information as hints
and describe which pieces of information need to be verified because they impact the application's security.
A straightforward way to verify such information is to request it again from an authorized server, typically the one that hosts the target resource.
That is similar to what happens in <a href="#discovery" class="xref">Section 4.3</a> when the "URI discovery" step is repeated.<a href="#section-7.2-5" class="pilcrow">¶</a></p>
</section>
</div>
<div id="link-confidentiality">
<section id="section-7.3">
<h3 id="name-link-confidentiality">
<a href="#section-7.3" class="section-number selfRef">7.3. </a><a href="#name-link-confidentiality" class="section-name selfRef">Link Confidentiality</a>
</h3>
<p id="section-7.3-1">When registrants publish information in the RD that is not available to any client that would query the registrant's <code>/.well-known/core</code> interface,
or when lookups to that interface are subject to stricter firewalling than lookups to the RD,
the RD may need to limit which lookup clients may access the information.<a href="#section-7.3-1" class="pilcrow">¶</a></p>
<p id="section-7.3-2">In this case, the endpoint (and not the lookup clients) needs to be careful to check the RD's authorization.
The RD needs to check any lookup client's authorization
before revealing information directly (in resource lookup)
or indirectly (when using it to satisfy a resource lookup search criterion).<a href="#section-7.3-2" class="pilcrow">¶</a></p>
</section>
</div>
<div id="segmentation">
<section id="section-7.4">
<h3 id="name-segmentation">
<a href="#section-7.4" class="section-number selfRef">7.4. </a><a href="#name-segmentation" class="section-name selfRef">Segmentation</a>
</h3>
<p id="section-7.4-1">Within a single RD, different security policies can apply.<a href="#section-7.4-1" class="pilcrow">¶</a></p>
<p id="section-7.4-2">One example of this are multi-tenant deployments separated by the sector (d) parameter.
Some sectors might apply limitations on the endpoint names available,
while others use a random identifier approach to endpoint names and place limits on the entered links based on their attributes instead.<a href="#section-7.4-2" class="pilcrow">¶</a></p>
<p id="section-7.4-3">Care must be taken in such setups to determine the applicable access control measures to each operation.
One easy way to do that is to mandate the use of the sector parameter on all operations,
as no credentials are suitable for operations across sector borders anyway.<a href="#section-7.4-3" class="pilcrow">¶</a></p>
</section>
</div>
<div id="first-come-first-remembered-a-default-policy">
<section id="section-7.5">
<h3 id="name-first-come-first-remembered">
<a href="#section-7.5" class="section-number selfRef">7.5. </a><a href="#name-first-come-first-remembered" class="section-name selfRef">"First Come First Remembered": A Default Policy</a>
</h3>
<p id="section-7.5-1">The "First Come First Remembered" policy is provided both as a reference example for a
security policy definition and as a policy that implementations may choose to use as
default policy in the absence of any other configuration. It is designed to enable efficient
discovery operations even in ad hoc settings.<a href="#section-7.5-1" class="pilcrow">¶</a></p>
<p id="section-7.5-2">Under this policy, the RD accepts registrations for any endpoint name that is not assigned to an active registration resource
and only accepts registration updates from the same endpoint.
The policy is minimal in that it does not make any promises to lookup clients about the claims of Sections <a href="#entered-links" class="xref">7.2</a> and <a href="#link-confidentiality" class="xref">7.3</a>,
and promises about the claims in <a href="#secure-ep" class="xref">Section 7.1</a> are limited to the lifetime of that endpoint's registration.
It does however promise the endpoint that, for the duration of its registration, its links will be discoverable on the RD.<a href="#section-7.5-2" class="pilcrow">¶</a></p>
<p id="section-7.5-3">When a registration or operation is attempted, the RD <span class="bcp14">MUST</span> determine the client's subject name or public key:<a href="#section-7.5-3" class="pilcrow">¶</a></p>
<ul class="normal">
<li class="normal" id="section-7.5-4.1">If the client's credentials indicate any subject name that is certified by any authority that the RD recognizes (which may be the system's trust anchor store), all such subject names are stored.
With credentials based on CWT or JWT (as common with Authentication and Authorization for Constrained Environments (ACE)), the Subject (sub) claim is stored as a single name, if it exists.
With X.509 certificates, the Common Name (CN) and the complete list of SubjectAltName entries are stored.
In both cases, the authority that certified the claim is stored along with the subject, as the latter may only be locally unique.<a href="#section-7.5-4.1" class="pilcrow">¶</a>
</li>
<li class="normal" id="section-7.5-4.2">Otherwise, if the client proves possession of a private key, the matching public key is stored.
This applies both to raw public keys and to the public keys indicated in certificates that failed the above authority check.<a href="#section-7.5-4.2" class="pilcrow">¶</a>
</li>
<li class="normal" id="section-7.5-4.3">If neither is present, a reference to the security session itself is stored.
With (D)TLS, that is the connection itself or the session resumption information, if available.
With OSCORE, that is the security context.<a href="#section-7.5-4.3" class="pilcrow">¶</a>
</li>
</ul>
<p id="section-7.5-5">As part of the registration operation, that information is stored along with the registration resource.<a href="#section-7.5-5" class="pilcrow">¶</a></p>
<p id="section-7.5-6">The RD <span class="bcp14">MUST</span> accept all registrations whose registration resource is not already active,
as long as they are made using a security layer supported by the RD.<a href="#section-7.5-6" class="pilcrow">¶</a></p>
<p id="section-7.5-7">Any operation on a registration resource,
including registrations that lead to an existing registration resource,
<span class="bcp14">MUST</span> be rejected by the RD unless all the stored information is found in the new request's credentials.<a href="#section-7.5-7" class="pilcrow">¶</a></p>
<p id="section-7.5-8">Note that, even though subject names are compared in this policy,
they are never directly compared to endpoint names,
and an endpoint cannot expect to "own" any particular endpoint name outside of an active registration --
even if a certificate says so.
It is an accepted shortcoming of this approach that the endpoint has no indication of whether the RD remembers it by its subject name or public key;
recognition by subject happens on a best-effort basis (given the RD may not recognize any authority).
Clients <span class="bcp14">MUST</span> be prepared to pick a different endpoint name when rejected by the RD initially or after a change in their credentials;
picking an endpoint name, as per <a href="#arbitrary-ep" class="xref">Section 7.1.1</a>, is an easy option for that.<a href="#section-7.5-8" class="pilcrow">¶</a></p>
<p id="section-7.5-9">For this policy to be usable without configuration, clients should not set a sector name in their registrations.
An RD can set a default sector name for registrations accepted under this policy,
which is especially useful in a segmented setup where different policies apply to different sectors.
The configuration of such a behavior, as well as any other configuration applicable to such an RD
(i.e., the set of recognized authorities),
is out of scope for this document.<a href="#section-7.5-9" class="pilcrow">¶</a></p>
</section>
</div>
</section>
</div>
<div id="security-considerations">
<section id="section-8">
<h2 id="name-security-considerations">
<a href="#section-8" class="section-number selfRef">8. </a><a href="#name-security-considerations" class="section-name selfRef">Security Considerations</a>
</h2>
<p id="section-8-1">The security considerations as described in <span><a href="https://www.rfc-editor.org/rfc/rfc8288#section-5" class="relref">Section 5</a> of [<a href="#RFC8288" class="xref">RFC8288</a>]</span> and <span><a href="https://www.rfc-editor.org/rfc/rfc6690#section-6" class="relref">Section 6</a> of [<a href="#RFC6690" class="xref">RFC6690</a>]</span> apply. The <code>/.well-known/core</code> resource may be
protected, e.g., using DTLS when hosted on a CoAP server, as described in
<span>[<a href="#RFC7252" class="xref">RFC7252</a>]</span>.<a href="#section-8-1" class="pilcrow">¶</a></p>
<p id="section-8-2">Access that is limited or affects sensitive data <span class="bcp14">SHOULD</span> be protected,
e.g., using (D)TLS or OSCORE <span>[<a href="#RFC8613" class="xref">RFC8613</a>]</span>;
which aspects of the RD this affects depends on the security policies of the application (see <a href="#policies" class="xref">Section 7</a>).<a href="#section-8-2" class="pilcrow">¶</a></p>
<div id="seccons-discovery">
<section id="section-8.1">
<h3 id="name-discovery">
<a href="#section-8.1" class="section-number selfRef">8.1. </a><a href="#name-discovery" class="section-name selfRef">Discovery</a>
</h3>
<p id="section-8.1-1">Most steps in discovery of the RD, and possibly its resources, are not covered by CoAP's security mechanisms.
This will not endanger the security properties of the registrations and lookup itself
(where the client requires authorization of the RD if it expects any security properties of the operation)
but may leak the client's intention to third parties
and allow them to slow down the process.<a href="#section-8.1-1" class="pilcrow">¶</a></p>
<p id="section-8.1-2">To mitigate that, clients can retain the RD's address,
use secure discovery options (such as configured addresses),
and send queries for RDs in a very general form (e.g., <code>?rt=core.rd*</code> rather than <code>?rt=core.rd-lookup-ep</code>).<a href="#section-8.1-2" class="pilcrow">¶</a></p>
</section>
</div>
<div id="endpoint_identification">
<section id="section-8.2">
<h3 id="name-endpoint-identification-and">
<a href="#section-8.2" class="section-number selfRef">8.2. </a><a href="#name-endpoint-identification-and" class="section-name selfRef">Endpoint Identification and Authentication</a>
</h3>
<p id="section-8.2-1">An endpoint (name, sector) pair is unique within the set of endpoints registered by the RD. An endpoint <span class="bcp14">MUST NOT</span> be identified by its protocol, port, or IP
address, as these may change over the lifetime of an endpoint.<a href="#section-8.2-1" class="pilcrow">¶</a></p>
<p id="section-8.2-2">Every operation performed by an endpoint on an RD
<span class="bcp14">SHOULD</span> be mutually authenticated using a pre-shared key, a raw public key, or
certificate-based security.<a href="#section-8.2-2" class="pilcrow">¶</a></p>
<p id="section-8.2-3">Consider the following threat: two devices, A and B, are registered at a single server. Both devices have unique, per-device credentials for use with DTLS to make sure that only parties with authorization to access A or B can do so.<a href="#section-8.2-3" class="pilcrow">¶</a></p>
<p id="section-8.2-4">Now, imagine that a malicious device A wants to sabotage the device B. It uses its credentials during the DTLS exchange. Then, it specifies the
endpoint name of device B as the name of its own endpoint in device A. If the server does not check
whether the identifier provided in the DTLS handshake matches the
identifier used at the CoAP layer, then it may be inclined to use the
endpoint name for looking up what information to provision to the malicious device.<a href="#section-8.2-4" class="pilcrow">¶</a></p>
<p id="section-8.2-5">Endpoint authorization needs to be checked on registration and registration resource operations
independently of whether there are configured requirements on the credentials for a given endpoint name and sector (<a href="#secure-ep" class="xref">Section 7.1</a>)
or whether arbitrary names are accepted (<a href="#arbitrary-ep" class="xref">Section 7.1.1</a>).<a href="#section-8.2-5" class="pilcrow">¶</a></p>
<p id="section-8.2-6">Simple registration could be used to circumvent address-based access control.
An attacker would send a simple registration request with the victim's address as the source address
and later look up the victim's <code>/.well-known/core</code> content in the RD.
Mitigation for this is recommended in <a href="#simple" class="xref">Section 5.1</a>.<a href="#section-8.2-6" class="pilcrow">¶</a></p>
<p id="section-8.2-7">The registration resource path is visible to any client that is allowed endpoint lookup
and can be extracted by resource lookup clients as well.
The same goes for registration attributes that are shown as target attributes or lookup attributes.
The RD needs to consider this in the choice of registration resource paths,
as do administrators or endpoints in their choice of attributes.<a href="#section-8.2-7" class="pilcrow">¶</a></p>
</section>
</div>
<div id="access-control">
<section id="section-8.3">
<h3 id="name-access-control">
<a href="#section-8.3" class="section-number selfRef">8.3. </a><a href="#name-access-control" class="section-name selfRef">Access Control</a>
</h3>
<p id="section-8.3-1">Access control <span class="bcp14">SHOULD</span> be performed separately for the RD registration and lookup
API paths, as different endpoints may be authorized to register
with an RD from those authorized to look up endpoints from the RD. Such access
control <span class="bcp14">SHOULD</span> be performed in as fine-grained a level as possible. For example,
access control for lookups could be performed either at the sector, endpoint,
or resource level.<a href="#section-8.3-1" class="pilcrow">¶</a></p>
<p id="section-8.3-2">The precise access controls necessary (and the consequences of failure to enforce them)
depend on the protection objectives of the application and the security policies (<a href="#policies" class="xref">Section 7</a>) derived from them.<a href="#section-8.3-2" class="pilcrow">¶</a></p>
</section>
</div>
<div id="denial-of-service-attacks">
<section id="section-8.4">
<h3 id="name-denial-of-service-attacks">
<a href="#section-8.4" class="section-number selfRef">8.4. </a><a href="#name-denial-of-service-attacks" class="section-name selfRef">Denial-of-Service Attacks</a>
</h3>
<p id="section-8.4-1">Services that run over UDP unprotected are vulnerable to unknowingly
amplify and distribute a DoS attack, as UDP does not require a return
routability check.
Since RD lookup responses can be significantly
larger than requests, RDs are prone to this.<a href="#section-8.4-1" class="pilcrow">¶</a></p>
<p id="section-8.4-2"><span>[<a href="#RFC7252" class="xref">RFC7252</a>]</span> describes this at length in its Section <a href="https://www.rfc-editor.org/rfc/rfc7252#section-11.3" class="relref">11.3</a>,
including some mitigation by using small block sizes in responses.
<span>[<a href="#RFC9175" class="xref">RFC9175</a>]</span> updates that
by describing a source address verification mechanism using the Echo option.<a href="#section-8.4-2" class="pilcrow">¶</a></p>
</section>
</div>
<div id="skipping-freshness-checks">
<section id="section-8.5">
<h3 id="name-skipping-freshness-checks">
<a href="#section-8.5" class="section-number selfRef">8.5. </a><a href="#name-skipping-freshness-checks" class="section-name selfRef">Skipping Freshness Checks</a>
</h3>
<p id="section-8.5-1">When RD-based applications are built in which request freshness checks are not performed,
these concerns need to be balanced:<a href="#section-8.5-1" class="pilcrow">¶</a></p>
<ul class="normal">
<li class="normal" id="section-8.5-2.1">
<p id="section-8.5-2.1.1">When alterations to registration attributes are reordered,
an attacker may create any combination of attributes ever set,
with the attack difficulty determined by the security layer's replay properties.<a href="#section-8.5-2.1.1" class="pilcrow">¶</a></p>
<p id="section-8.5-2.1.2">
For example, if <a href="#example-freshness" class="xref">Figure 18</a> were conducted without freshness assurances,
an attacker could later reset the lifetime back to 7200.
Thus, the device is made unreachable to lookup clients.<a href="#section-8.5-2.1.2" class="pilcrow">¶</a></p>
</li>
<li class="normal" id="section-8.5-2.2">
<p id="section-8.5-2.2.1">When registration updates without query parameters
(which just serve to restart the lifetime) can be reordered,
an attacker can use intercepted messages to give the appearance of the device being
alive to the RD.<a href="#section-8.5-2.2.1" class="pilcrow">¶</a></p>
<p id="section-8.5-2.2.2">This is unacceptable when the RD's security policy promises reachability of
endpoints (e.g., when disappearing devices would trigger further investigation)
but may be acceptable with other policies.<a href="#section-8.5-2.2.2" class="pilcrow">¶</a></p>
</li>
</ul>
</section>
</div>
</section>
</div>
<div id="iana-considerations">
<section id="section-9">
<h2 id="name-iana-considerations">
<a href="#section-9" class="section-number selfRef">9. </a><a href="#name-iana-considerations" class="section-name selfRef">IANA Considerations</a>
</h2>
<div id="iana-rt">
<section id="section-9.1">
<h3 id="name-resource-types">
<a href="#section-9.1" class="section-number selfRef">9.1. </a><a href="#name-resource-types" class="section-name selfRef">Resource Types</a>
</h3>
<p id="section-9.1-1">IANA has added the following values to the "Resource Type (rt=) Link Target Attribute Values"
subregistry of the "Constrained RESTful Environments (CoRE) Parameters"
registry defined in <span>[<a href="#RFC6690" class="xref">RFC6690</a>]</span>:<a href="#section-9.1-1" class="pilcrow">¶</a></p>
<span id="name-additions-to-resource-type-"></span><table class="center" id="table-2">
<caption>
<a href="#table-2" class="selfRef">Table 2</a>:
<a href="#name-additions-to-resource-type-" class="selfRef">Additions to Resource Type (rt=) Link Target Attribute Values Subregistry</a>
</caption>
<thead>
<tr>
<th class="text-left" rowspan="1" colspan="1">Value</th>
<th class="text-left" rowspan="1" colspan="1">Description</th>
<th class="text-left" rowspan="1" colspan="1">Reference</th>
</tr>
</thead>
<tbody>
<tr>
<td class="text-left" rowspan="1" colspan="1">core.rd</td>
<td class="text-left" rowspan="1" colspan="1">Directory resource of an RD</td>
<td class="text-left" rowspan="1" colspan="1">RFC 9176, <a href="#discovery" class="xref">Section 4.3</a>
</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">core.rd-lookup-res</td>
<td class="text-left" rowspan="1" colspan="1">Resource lookup of an RD</td>
<td class="text-left" rowspan="1" colspan="1">RFC 9176, <a href="#discovery" class="xref">Section 4.3</a>
</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">core.rd-lookup-ep</td>
<td class="text-left" rowspan="1" colspan="1">Endpoint lookup of an RD</td>
<td class="text-left" rowspan="1" colspan="1">RFC 9176, <a href="#discovery" class="xref">Section 4.3</a>
</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">core.rd-ep</td>
<td class="text-left" rowspan="1" colspan="1">Endpoint resource of an RD</td>
<td class="text-left" rowspan="1" colspan="1">RFC 9176, <a href="#lookup" class="xref">Section 6</a>
</td>
</tr>
</tbody>
</table>
</section>
</div>
<div id="ipv6-nd-resource-directory-address-option">
<section id="section-9.2">
<h3 id="name-ipv6-nd-resource-directory-">
<a href="#section-9.2" class="section-number selfRef">9.2. </a><a href="#name-ipv6-nd-resource-directory-" class="section-name selfRef">IPv6 ND Resource Directory Address Option</a>
</h3>
<p id="section-9.2-1">IANA has registered one new ND option type in the "IPv6 Neighbor
Discovery Option Formats" subregistry of the "Internet Control Message
Protocol version 6 (ICMPv6) Parameters" registry:<a href="#section-9.2-1" class="pilcrow">¶</a></p>
<span id="name-addition-to-ipv6-neighbor-d"></span><table class="center" id="table-3">
<caption>
<a href="#table-3" class="selfRef">Table 3</a>:
<a href="#name-addition-to-ipv6-neighbor-d" class="selfRef">Addition to IPv6 Neighbor Discovery Option Formats Subregistry</a>
</caption>
<thead>
<tr>
<th class="text-left" rowspan="1" colspan="1">Type</th>
<th class="text-left" rowspan="1" colspan="1">Description</th>
<th class="text-left" rowspan="1" colspan="1">Reference</th>
</tr>
</thead>
<tbody>
<tr>
<td class="text-left" rowspan="1" colspan="1">41</td>
<td class="text-left" rowspan="1" colspan="1">Resource Directory Address Option</td>
<td class="text-left" rowspan="1" colspan="1">RFC 9176</td>
</tr>
</tbody>
</table>
</section>
</div>
<div id="iana-registry">
<section id="section-9.3">
<h3 id="name-rd-parameters-registry">
<a href="#section-9.3" class="section-number selfRef">9.3. </a><a href="#name-rd-parameters-registry" class="section-name selfRef">RD Parameters Registry</a>
</h3>
<p id="section-9.3-1">This specification defines a new subregistry for registration and
lookup parameters called "RD Parameters" within the "Constrained
RESTful Environments (CoRE) Parameters" registry. Although this
specification defines a basic set of parameters, it is expected that
other standards that make use of this interface will define new
ones.<a href="#section-9.3-1" class="pilcrow">¶</a></p>
<p id="section-9.3-2">Each entry in the registry must include:<a href="#section-9.3-2" class="pilcrow">¶</a></p>
<ul class="normal">
<li class="normal" id="section-9.3-3.1">the human-readable name of the parameter,<a href="#section-9.3-3.1" class="pilcrow">¶</a>
</li>
<li class="normal" id="section-9.3-3.2">the short name, as used in query parameters or target attributes,<a href="#section-9.3-3.2" class="pilcrow">¶</a>
</li>
<li class="normal" id="section-9.3-3.3">syntax and validity requirements (if any),<a href="#section-9.3-3.3" class="pilcrow">¶</a>
</li>
<li class="normal" id="section-9.3-3.4">indication of whether it can be passed as a query parameter at registration of
endpoints, passed as a query parameter in lookups, or expressed as a target
attribute,<a href="#section-9.3-3.4" class="pilcrow">¶</a>
</li>
<li class="normal" id="section-9.3-3.5">a description, and<a href="#section-9.3-3.5" class="pilcrow">¶</a>
</li>
<li class="normal" id="section-9.3-3.6">a link to reference documentation.<a href="#section-9.3-3.6" class="pilcrow">¶</a>
</li>
</ul>
<p id="section-9.3-4">The query parameter <span class="bcp14">MUST</span> be both a valid URI query key <span>[<a href="#RFC3986" class="xref">RFC3986</a>]</span> and a token as used in <span>[<a href="#RFC8288" class="xref">RFC8288</a>]</span>.<a href="#section-9.3-4" class="pilcrow">¶</a></p>
<p id="section-9.3-5">The reference documentation must give details on whether the parameter can be updated and how it is to be processed in lookups.<a href="#section-9.3-5" class="pilcrow">¶</a></p>
<p id="section-9.3-6">The mechanisms around new RD parameters should be designed in such a way that they tolerate RD implementations that are unaware of the parameter and expose any parameter passed at registration or updates in endpoint lookups. (For example, if a parameter used at registration were to be confidential, the registering endpoint should be instructed to only set that parameter if the RD advertises support for keeping it confidential at the discovery step.)<a href="#section-9.3-6" class="pilcrow">¶</a></p>
<p id="section-9.3-7">Initial entries in this subregistry are as follows:<a href="#section-9.3-7" class="pilcrow">¶</a></p>
<span id="name-new-rd-parameters-registry"></span><div id="tab-registry">
<table class="center" id="table-4">
<caption>
<a href="#table-4" class="selfRef">Table 4</a>:
<a href="#name-new-rd-parameters-registry" class="selfRef">New RD Parameters Registry</a>
</caption>
<thead>
<tr>
<th class="text-left" rowspan="1" colspan="1">Name</th>
<th class="text-left" rowspan="1" colspan="1">Short</th>
<th class="text-left" rowspan="1" colspan="1">Validity</th>
<th class="text-left" rowspan="1" colspan="1">Use</th>
<th class="text-left" rowspan="1" colspan="1">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="text-left" rowspan="1" colspan="1">Endpoint Name</td>
<td class="text-left" rowspan="1" colspan="1">ep</td>
<td class="text-left" rowspan="1" colspan="1">Unicode*</td>
<td class="text-left" rowspan="1" colspan="1">RLA</td>
<td class="text-left" rowspan="1" colspan="1">Name of the endpoint</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">Lifetime</td>
<td class="text-left" rowspan="1" colspan="1">lt</td>
<td class="text-left" rowspan="1" colspan="1">1-4294967295</td>
<td class="text-left" rowspan="1" colspan="1">R</td>
<td class="text-left" rowspan="1" colspan="1">Lifetime of the registration in seconds</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">Sector</td>
<td class="text-left" rowspan="1" colspan="1">d</td>
<td class="text-left" rowspan="1" colspan="1">Unicode*</td>
<td class="text-left" rowspan="1" colspan="1">RLA</td>
<td class="text-left" rowspan="1" colspan="1">Sector to which this endpoint belongs</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">Registration Base URI</td>
<td class="text-left" rowspan="1" colspan="1">base</td>
<td class="text-left" rowspan="1" colspan="1">URI</td>
<td class="text-left" rowspan="1" colspan="1">RLA</td>
<td class="text-left" rowspan="1" colspan="1">The scheme, address, port, and path at which this server is
available</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">Page</td>
<td class="text-left" rowspan="1" colspan="1">page</td>
<td class="text-left" rowspan="1" colspan="1">Integer</td>
<td class="text-left" rowspan="1" colspan="1">L</td>
<td class="text-left" rowspan="1" colspan="1">Used for pagination</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">Count</td>
<td class="text-left" rowspan="1" colspan="1">count</td>
<td class="text-left" rowspan="1" colspan="1">Integer</td>
<td class="text-left" rowspan="1" colspan="1">L</td>
<td class="text-left" rowspan="1" colspan="1">Used for pagination</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">Endpoint Type</td>
<td class="text-left" rowspan="1" colspan="1">et</td>
<td class="text-left" rowspan="1" colspan="1">
RFC 9176, <a href="#et-description" class="xref">Section 9.3.1</a>
</td>
<td class="text-left" rowspan="1" colspan="1">RLA</td>
<td class="text-left" rowspan="1" colspan="1">Semantic type of the endpoint (see RFC 9176, <a href="#et-registry" class="xref">Section 9.4</a>)</td>
</tr>
</tbody>
</table>
</div>
<p id="section-9.3-9">Where:<a href="#section-9.3-9" class="pilcrow">¶</a></p>
<span class="break"></span><dl class="dlParallel" id="section-9.3-10">
<dt id="section-9.3-10.1">Short:</dt>
<dd style="margin-left: 1.5em" id="section-9.3-10.2">Short name used in query parameters or target attributes<a href="#section-9.3-10.2" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-9.3-10.3">Validity:</dt>
<dd style="margin-left: 1.5em" id="section-9.3-10.4">
<p id="section-9.3-10.4.1"><br></p>
<span class="break"></span><dl class="dlParallel" id="section-9.3-10.4.2">
<dt id="section-9.3-10.4.2.1">Unicode* = </dt>
<dd style="margin-left: 1.5em" id="section-9.3-10.4.2.2">up to 63 bytes of UTF-8-encoded Unicode, with no control characters as per
<a href="#registration" class="xref">Section 5</a><a href="#section-9.3-10.4.2.2" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
</dl>
</dd>
<dd class="break"></dd>
<dt id="section-9.3-10.5">Use:</dt>
<dd style="margin-left: 1.5em" id="section-9.3-10.6">
<p id="section-9.3-10.6.1"><br></p>
<span class="break"></span><dl class="dlCompact dlParallel" id="section-9.3-10.6.2">
<dt id="section-9.3-10.6.2.1">R =</dt>
<dd style="margin-left: 1.5em" id="section-9.3-10.6.2.2">used at registration<a href="#section-9.3-10.6.2.2" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-9.3-10.6.2.3">L =</dt>
<dd style="margin-left: 1.5em" id="section-9.3-10.6.2.4">used at lookup<a href="#section-9.3-10.6.2.4" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-9.3-10.6.2.5">A =</dt>
<dd style="margin-left: 1.5em" id="section-9.3-10.6.2.6">expressed in the target attribute<a href="#section-9.3-10.6.2.6" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
</dl>
</dd>
<dd class="break"></dd>
</dl>
<p id="section-9.3-11">The descriptions for the options defined in this document are only summarized here.
To which registrations they apply and when they are to be shown are described in the respective sections of this document.
All their reference documentation entries point to this document.<a href="#section-9.3-11" class="pilcrow">¶</a></p>
<p id="section-9.3-12">The IANA policy for future additions to the subregistry is Expert Review,
as described in <span>[<a href="#RFC8126" class="xref">RFC8126</a>]</span>. The evaluation should consider
formal criteria,
duplication of functionality (i.e., is the new entry redundant with an existing one?),
topical suitability (e.g., is the described property actually a property of the endpoint and not a property of a particular resource, in which case it should go into the payload of the registration and need not be registered?),
and the potential for conflict with commonly used target attributes (e.g., <code>if</code> could be used as a parameter for conditional registration if it were not to be used in lookup or attributes but would make a bad parameter for lookup because a resource lookup with an <code>if</code> query parameter could ambiguously filter by the registered endpoint property or the target attribute <span>[<a href="#RFC6690" class="xref">RFC6690</a>]</span>).<a href="#section-9.3-12" class="pilcrow">¶</a></p>
<div id="et-description">
<section id="section-9.3.1">
<h4 id="name-full-description-of-the-end">
<a href="#section-9.3.1" class="section-number selfRef">9.3.1. </a><a href="#name-full-description-of-the-end" class="section-name selfRef">Full Description of the "Endpoint Type" RD Parameter</a>
</h4>
<p id="section-9.3.1-1">An endpoint registering at an RD can describe itself with
endpoint types, similar to how resources are described with resource
types in <span>[<a href="#RFC6690" class="xref">RFC6690</a>]</span>. An endpoint
type is expressed as a string, which can be either a URI or one of
the values defined in the "Endpoint Type (et=) RD Parameter Values"
subregistry. Endpoint types can be passed in the <code>et</code> query
parameter as part of extra-attrs at the "registration" step of <a href="#registration" class="xref">Section 5</a>, are shown
on endpoint lookups using the <code>et</code> target attribute, and can
be filtered for using <code>et</code> as a search criterion in resource
and endpoint lookup. Multiple endpoint types are given as separate
query parameters or link attributes.<a href="#section-9.3.1-1" class="pilcrow">¶</a></p>
<p id="section-9.3.1-2">Note that the endpoint type differs from the resource type in that it uses multiple
attributes rather than space-separated values.
As a result, RDs implementing this specification automatically support correct
filtering in the lookup interfaces from the rules for unknown endpoint
attributes.<a href="#section-9.3.1-2" class="pilcrow">¶</a></p>
</section>
</div>
</section>
</div>
<div id="et-registry">
<section id="section-9.4">
<h3 id="name-endpoint-type-et-rd-paramet">
<a href="#section-9.4" class="section-number selfRef">9.4. </a><a href="#name-endpoint-type-et-rd-paramet" class="section-name selfRef">Endpoint Type (et=) RD Parameter Values</a>
</h3>
<p id="section-9.4-1">This specification establishes a new subregistry called "Endpoint
Type (et=) RD Parameter Values" within the "Constrained RESTful
Environments (CoRE) Parameters" registry.
The registry properties (required policy, requirements, and template) are
identical to those of the "Resource Type (rt=) Link Target Attribute
Values" subregistry defined in <span>[<a href="#RFC6690" class="xref">RFC6690</a>]</span>;
in short, the review policy is IETF Review for
values starting with "core" and Specification Required for others.<a href="#section-9.4-1" class="pilcrow">¶</a></p>
<p id="section-9.4-2">The requirements to be enforced are:<a href="#section-9.4-2" class="pilcrow">¶</a></p>
<ul class="normal">
<li class="normal" id="section-9.4-3.1">The values <span class="bcp14">MUST</span> be related to the purpose described in <a href="#et-description" class="xref">Section 9.3.1</a>.<a href="#section-9.4-3.1" class="pilcrow">¶</a>
</li>
<li class="normal" id="section-9.4-3.2">The registered values <span class="bcp14">MUST</span> conform to the ABNF reg-rel-type definition of
<span>[<a href="#RFC6690" class="xref">RFC6690</a>]</span> and <span class="bcp14">MUST NOT</span> be a URI.<a href="#section-9.4-3.2" class="pilcrow">¶</a>
</li>
<li class="normal" id="section-9.4-3.3">It is recommended to use the period "." character for segmentation.<a href="#section-9.4-3.3" class="pilcrow">¶</a>
</li>
</ul>
<p id="section-9.4-4">The initial contents of the registry are as follows:<a href="#section-9.4-4" class="pilcrow">¶</a></p>
<span id="name-new-endpoint-type-et-rd-par"></span><table class="center" id="table-5">
<caption>
<a href="#table-5" class="selfRef">Table 5</a>:
<a href="#name-new-endpoint-type-et-rd-par" class="selfRef">New Endpoint Type (et=) RD Parameter Values Registry</a>
</caption>
<thead>
<tr>
<th class="text-left" rowspan="1" colspan="1">Value</th>
<th class="text-left" rowspan="1" colspan="1">Description</th>
<th class="text-left" rowspan="1" colspan="1">Reference</th>
</tr>
</thead>
<tbody>
<tr>
<td class="text-left" rowspan="1" colspan="1">core.rd-group</td>
<td class="text-left" rowspan="1" colspan="1">An application group, as described in RFC 9176, <a href="#groups" class="xref">Appendix A</a>.</td>
<td class="text-left" rowspan="1" colspan="1">RFC 9176</td>
</tr>
</tbody>
</table>
</section>
</div>
<div id="mc-registration">
<section id="section-9.5">
<h3 id="name-multicast-address-registrat">
<a href="#section-9.5" class="section-number selfRef">9.5. </a><a href="#name-multicast-address-registrat" class="section-name selfRef">Multicast Address Registration</a>
</h3>
<p id="section-9.5-1">
IANA has assigned
the following multicast addresses for use by CoAP nodes:<a href="#section-9.5-1" class="pilcrow">¶</a></p>
<span class="break"></span><dl class="dlParallel" id="section-9.5-2">
<dt id="section-9.5-2.1">IPv4</dt>
<dd style="margin-left: 1.5em" id="section-9.5-2.2">-- "All CoRE Resource Directories" address 224.0.1.190, in the
"Internetwork Control Block (224.0.1.0 - 224.0.1.255 (224.0.1/24))"
subregistry within 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)
<span>[<a href="#RFC5771" class="xref">RFC5771</a>]</span>.<a href="#section-9.5-2.2" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
<dt id="section-9.5-2.3">IPv6</dt>
<dd style="margin-left: 1.5em" id="section-9.5-2.4">-- "All CoRE Resource Directories" address ff0x::fe, in
the "Variable Scope Multicast Addresses" subregistry within the "IPv6
Multicast Address Space Registry" <span>[<a href="#RFC3307" class="xref">RFC3307</a>]</span>. 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.<a href="#section-9.5-2.4" class="pilcrow">¶</a>
</dd>
<dd class="break"></dd>
</dl>
</section>
</div>
<div id="well-known-uris">
<section id="section-9.6">
<h3 id="name-well-known-uris">
<a href="#section-9.6" class="section-number selfRef">9.6. </a><a href="#name-well-known-uris" class="section-name selfRef">Well-Known URIs</a>
</h3>
<p id="section-9.6-1">IANA has registered the URI suffix "rd" in the "Well-Known URIs"
registry as follows:<a href="#section-9.6-1" class="pilcrow">¶</a></p>
<span id="name-addition-to-well-known-uris"></span><table class="center" id="table-6">
<caption>
<a href="#table-6" class="selfRef">Table 6</a>:
<a href="#name-addition-to-well-known-uris" class="selfRef">Addition to Well-Known URIs Registry</a>
</caption>
<thead>
<tr>
<th class="text-left" rowspan="1" colspan="1">URI Suffix</th>
<th class="text-left" rowspan="1" colspan="1">Change Controller</th>
<th class="text-left" rowspan="1" colspan="1">Reference</th>
<th class="text-left" rowspan="1" colspan="1">Status</th>
</tr>
</thead>
<tbody>
<tr>
<td class="text-left" rowspan="1" colspan="1">rd</td>
<td class="text-left" rowspan="1" colspan="1">IETF</td>
<td class="text-left" rowspan="1" colspan="1">RFC 9176</td>
<td class="text-left" rowspan="1" colspan="1">permanent</td>
</tr>
</tbody>
</table>
</section>
</div>
<div id="service-names-and-transport-protocol-port-number-registry">
<section id="section-9.7">
<h3 id="name-service-name-and-transport-">
<a href="#section-9.7" class="section-number selfRef">9.7. </a><a href="#name-service-name-and-transport-" class="section-name selfRef">Service Name and Transport Protocol Port Number Registry</a>
</h3>
<p id="section-9.7-1">IANA has added four new items to the "Service Name and Transport Protocol Port Number Registry" as follows:<a href="#section-9.7-1" class="pilcrow">¶</a></p>
<span id="name-additions-to-service-name-a"></span><table class="center" id="table-7">
<caption>
<a href="#table-7" class="selfRef">Table 7</a>:
<a href="#name-additions-to-service-name-a" class="selfRef">Additions to Service Name and Transport Protocol Port Number Registry</a>
</caption>
<thead>
<tr>
<th class="text-left" rowspan="1" colspan="1">Service Name</th>
<th class="text-left" rowspan="1" colspan="1">Transport Protocol</th>
<th class="text-left" rowspan="1" colspan="1">Description</th>
<th class="text-left" rowspan="1" colspan="1">Reference</th>
</tr>
</thead>
<tbody>
<tr>
<td class="text-left" rowspan="1" colspan="1">core-rd</td>
<td class="text-left" rowspan="1" colspan="1">udp</td>
<td class="text-left" rowspan="1" colspan="1">Resource Directory accessed using CoAP</td>
<td class="text-left" rowspan="1" colspan="1">RFC 9176</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">core-rd-dtls</td>
<td class="text-left" rowspan="1" colspan="1">udp</td>
<td class="text-left" rowspan="1" colspan="1">Resource Directory accessed using CoAP over DTLS</td>
<td class="text-left" rowspan="1" colspan="1">RFC 9176</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">core-rd</td>
<td class="text-left" rowspan="1" colspan="1">tcp</td>
<td class="text-left" rowspan="1" colspan="1">Resource Directory accessed using CoAP over TCP</td>
<td class="text-left" rowspan="1" colspan="1">RFC 9176</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">core-rd-tls</td>
<td class="text-left" rowspan="1" colspan="1">tcp</td>
<td class="text-left" rowspan="1" colspan="1">Resource Directory accessed using CoAP over TLS</td>
<td class="text-left" rowspan="1" colspan="1">RFC 9176</td>
</tr>
</tbody>
</table>
</section>
</div>
</section>
</div>
<div id="examples">
<section id="section-10">
<h2 id="name-examples">
<a href="#section-10" class="section-number selfRef">10. </a><a href="#name-examples" class="section-name selfRef">Examples</a>
</h2>
<p id="section-10-1">Two examples are presented: a lighting installation example in <a href="#lt-ex" class="xref">Section 10.1</a> and a Lightweight M2M (LwM2M) example in <a href="#lwm2m-ex" class="xref">Section 10.2</a>.<a href="#section-10-1" class="pilcrow">¶</a></p>
<div id="lt-ex">
<section id="section-10.1">
<h3 id="name-lighting-installation">
<a href="#section-10.1" class="section-number selfRef">10.1. </a><a href="#name-lighting-installation" class="section-name selfRef">Lighting Installation</a>
</h3>
<p id="section-10.1-1">This example shows a simplified lighting installation that makes use of
the RD with a CoAP interface to facilitate the installation and startup of
the application code in the lights and sensors. In particular, the example
leads to the definition of a group and the enabling of the corresponding
multicast address, as described in <a href="#groups" class="xref">Appendix A</a>. No conclusions must be drawn on the realization of actual
installation or naming procedures, because the example only emphasizes some of the issues
that may influence the use of the RD and does not pretend to be normative.<a href="#section-10.1-1" class="pilcrow">¶</a></p>
<div id="lt-in-ch">
<section id="section-10.1.1">
<h4 id="name-installation-characteristic">
<a href="#section-10.1.1" class="section-number selfRef">10.1.1. </a><a href="#name-installation-characteristic" class="section-name selfRef">Installation Characteristics</a>
</h4>
<p id="section-10.1.1-1">The example assumes that the installation is managed. That means that a Commissioning
Tool (CT) is used to authorize the addition of nodes, name them, and name
their services. The CT can be connected to the installation in many ways:
the CT can be part of the installation network, connected by Wi-Fi to the
installation network, connected via GPRS link, or connected by another method.<a href="#section-10.1.1-1" class="pilcrow">¶</a></p>
<p id="section-10.1.1-2">It is assumed that there are two naming authorities for the installation:
(1) the network manager that is responsible for the correct operation of
the network and the connected interfaces and (2) the lighting manager that
is responsible for the correct functioning of networked lights and sensors.
The result is the existence of two naming schemes coming from the two managing
entities.<a href="#section-10.1.1-2" class="pilcrow">¶</a></p>
<p id="section-10.1.1-3">The example installation consists of one presence sensor and two luminaries,
luminary1 and luminary2, each with their own wireless interface. Each luminary
contains three lamps: left, right, and middle. Each luminary is accessible
through one endpoint. For each lamp, a resource exists to modify the settings
of a lamp in a luminary. The purpose of the installation is that the presence
sensor notifies the presence of persons to a group of lamps. The group of
lamps consists of the middle and left lamps of luminary1 and the right lamp of luminary2.<a href="#section-10.1.1-3" class="pilcrow">¶</a></p>
<p id="section-10.1.1-4">Before commissioning by the lighting manager, the network is installed, and
access to the interfaces is proven to work by the network manager.<a href="#section-10.1.1-4" class="pilcrow">¶</a></p>
<p id="section-10.1.1-5">At the moment of installation, the network under installation is not necessarily
connected to the DNS infrastructure. Therefore, Stateless Address Autoconfiguration (SLAAC) IPv6 addresses are
assigned to CT, RD, luminaries, and the sensor.
The addresses shown in <a href="#interface-S" class="xref">Table 8</a> below stand in for these in the following examples.<a href="#section-10.1.1-5" class="pilcrow">¶</a></p>
<span id="name-addresses-used-in-the-examp"></span><div id="interface-S">
<table class="center" id="table-8">
<caption>
<a href="#table-8" class="selfRef">Table 8</a>:
<a href="#name-addresses-used-in-the-examp" class="selfRef">Addresses Used in the Examples</a>
</caption>
<thead>
<tr>
<th class="text-left" rowspan="1" colspan="1">Name</th>
<th class="text-left" rowspan="1" colspan="1">IPv6 address</th>
</tr>
</thead>
<tbody>
<tr>
<td class="text-left" rowspan="1" colspan="1">luminary1</td>
<td class="text-left" rowspan="1" colspan="1">2001:db8:4::1</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">luminary2</td>
<td class="text-left" rowspan="1" colspan="1">2001:db8:4::2</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">Presence sensor</td>
<td class="text-left" rowspan="1" colspan="1">2001:db8:4::3</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">RD</td>
<td class="text-left" rowspan="1" colspan="1">2001:db8:4::ff</td>
</tr>
</tbody>
</table>
</div>
<p id="section-10.1.1-7">In <a href="#rd-en" class="xref">Section 10.1.2</a>, the use of RD during installation is
presented.<a href="#section-10.1.1-7" class="pilcrow">¶</a></p>
</section>
</div>
<div id="rd-en">
<section id="section-10.1.2">
<h4 id="name-rd-entries">
<a href="#section-10.1.2" class="section-number selfRef">10.1.2. </a><a href="#name-rd-entries" class="section-name selfRef">RD Entries</a>
</h4>
<p id="section-10.1.2-1">It is assumed that access to the DNS infrastructure is not always possible
during installation. Therefore, the SLAAC addresses are used in this section.<a href="#section-10.1.2-1" class="pilcrow">¶</a></p>
<p id="section-10.1.2-2">For discovery, the resource types (rt) of the devices are important. The
lamps in the luminaries have rt=tag:example.com,2020:light, and the presence sensor has rt=tag:example.com,2020:p-sensor.
The endpoints have names that are relevant to the light installation manager.
In this case, luminary1, luminary2, and the presence sensor are located in
room 2-4-015, where luminary1 is located at the window and luminary2 and
the presence sensor are located at the door. The endpoint names reflect
this physical location. The middle, left, and right lamps are accessed via
path /light/middle, /light/left, and /light/right, respectively. The identifiers
relevant to the RD are shown in <a href="#endpoint" class="xref">Table 9</a>.<a href="#section-10.1.2-2" class="pilcrow">¶</a></p>
<span id="name-rd-identifiers"></span><div id="endpoint">
<table class="center" id="table-9">
<caption>
<a href="#table-9" class="selfRef">Table 9</a>:
<a href="#name-rd-identifiers" class="selfRef">RD Identifiers</a>
</caption>
<thead>
<tr>
<th class="text-left" rowspan="1" colspan="1">Name</th>
<th class="text-left" rowspan="1" colspan="1">Endpoint</th>
<th class="text-left" rowspan="1" colspan="1">Resource Path</th>
<th class="text-left" rowspan="1" colspan="1">Resource Type</th>
</tr>
</thead>
<tbody>
<tr>
<td class="text-left" rowspan="1" colspan="1">luminary1</td>
<td class="text-left" rowspan="1" colspan="1">lm_R2-4-015_wndw</td>
<td class="text-left" rowspan="1" colspan="1">/light/left</td>
<td class="text-left" rowspan="1" colspan="1">tag:example.com,2020:light</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">luminary1</td>
<td class="text-left" rowspan="1" colspan="1">lm_R2-4-015_wndw</td>
<td class="text-left" rowspan="1" colspan="1">/light/middle</td>
<td class="text-left" rowspan="1" colspan="1">tag:example.com,2020:light</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">luminary1</td>
<td class="text-left" rowspan="1" colspan="1">lm_R2-4-015_wndw</td>
<td class="text-left" rowspan="1" colspan="1">/light/right</td>
<td class="text-left" rowspan="1" colspan="1">tag:example.com,2020:light</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">luminary2</td>
<td class="text-left" rowspan="1" colspan="1">lm_R2-4-015_door</td>
<td class="text-left" rowspan="1" colspan="1">/light/left</td>
<td class="text-left" rowspan="1" colspan="1">tag:example.com,2020:light</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">luminary2</td>
<td class="text-left" rowspan="1" colspan="1">lm_R2-4-015_door</td>
<td class="text-left" rowspan="1" colspan="1">/light/middle</td>
<td class="text-left" rowspan="1" colspan="1">tag:example.com,2020:light</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">luminary2</td>
<td class="text-left" rowspan="1" colspan="1">lm_R2-4-015_door</td>
<td class="text-left" rowspan="1" colspan="1">/light/right</td>
<td class="text-left" rowspan="1" colspan="1">tag:example.com,2020:light</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">Presence sensor</td>
<td class="text-left" rowspan="1" colspan="1">ps_R2-4-015_door</td>
<td class="text-left" rowspan="1" colspan="1">/ps</td>
<td class="text-left" rowspan="1" colspan="1">tag:example.com,2020:p-sensor</td>
</tr>
</tbody>
</table>
</div>
<p id="section-10.1.2-4">It is assumed that the CT has performed RD discovery and has received a response like the one in the example in <a href="#discovery" class="xref">Section 4.3</a>.<a href="#section-10.1.2-4" class="pilcrow">¶</a></p>
<p id="section-10.1.2-5">The CT inserts the endpoints of the luminaries and the sensor in the RD
using the registration base URI parameter (base) to specify the interface address:<a href="#section-10.1.2-5" class="pilcrow">¶</a></p>
<span id="name-example-of-registrations-a-"></span><div id="example-lighting-1">
<figure id="figure-24">
<div id="section-10.1.2-6.1">
<pre class="sourcecode">
Req: POST coap://[2001:db8:4::ff]/rd
?ep=lm_R2-4-015_wndw&base=coap://[2001:db8:4::1]&d=R2-4-015
Payload:
</light/left>;rt="tag:example.com,2020:light",
</light/middle>;rt="tag:example.com,2020:light",
</light/right>;rt="tag:example.com,2020:light"
Res: 2.01 Created
Location-Path: /rd/4521
Req: POST coap://[2001:db8:4::ff]/rd
?ep=lm_R2-4-015_door&base=coap://[2001:db8:4::2]&d=R2-4-015
Payload:
</light/left>;rt="tag:example.com,2020:light",
</light/middle>;rt="tag:example.com,2020:light",
</light/right>;rt="tag:example.com,2020:light"
Res: 2.01 Created
Location-Path: /rd/4522
Req: POST coap://[2001:db8:4::ff]/rd
?ep=ps_R2-4-015_door&base=coap://[2001:db8:4::3]&d=R2-4-015
Payload:
</ps>;rt="tag:example.com,2020:p-sensor"
Res: 2.01 Created
Location-Path: /rd/4523
</pre>
</div>
<figcaption><a href="#figure-24" class="selfRef">Figure 24</a>:
<a href="#name-example-of-registrations-a-" class="selfRef">Example of Registrations a CT Enters into an RD</a>
</figcaption></figure>
</div>
<p id="section-10.1.2-7">The sector name d=R2-4-015 has been added for an efficient lookup because
filtering on the "ep" name is more awkward. The same sector name is communicated to
the two luminaries and the presence sensor by the CT.<a href="#section-10.1.2-7" class="pilcrow">¶</a></p>
<p id="section-10.1.2-8">The group is specified in the RD. The base parameter is set to the site-local
multicast address allocated to the group.
In the POST in the example below, the resources supported by all group members are published.<a href="#section-10.1.2-8" class="pilcrow">¶</a></p>
<span id="name-example-of-a-multicast-grou"></span><div id="example-lighting-2">
<figure id="figure-25">
<div id="section-10.1.2-9.1">
<pre class="sourcecode">
Req: POST coap://[2001:db8:4::ff]/rd
?ep=grp_R2-4-015&et=core.rd-group&base=coap://[ff05::1]
Payload:
</light/left>;rt="tag:example.com,2020:light",
</light/middle>;rt="tag:example.com,2020:light",
</light/right>;rt="tag:example.com,2020:light"
Res: 2.01 Created
Location-Path: /rd/501
</pre>
</div>
<figcaption><a href="#figure-25" class="selfRef">Figure 25</a>:
<a href="#name-example-of-a-multicast-grou" class="selfRef">Example of a Multicast Group a CT Enters into an RD</a>
</figcaption></figure>
</div>
<p id="section-10.1.2-10">After the filling of the RD by the CT, the application in the luminaries
can learn to which groups they belong and enable their interface for the
multicast address.<a href="#section-10.1.2-10" class="pilcrow">¶</a></p>
<p id="section-10.1.2-11">The luminary, knowing its sector and being configured to join any group
containing lights, searches for candidate groups and joins them:<a href="#section-10.1.2-11" class="pilcrow">¶</a></p>
<span id="name-example-of-a-lookup-exchang"></span><div id="example-lighting-3">
<figure id="figure-26">
<div id="section-10.1.2-12.1">
<pre class="sourcecode">
Req: GET coap://[2001:db8:4::ff]/rd-lookup/ep
?d=R2-4-015&et=core.rd-group&rt=light
Res: 2.05 Content
Payload:
</rd/501>;ep=grp_R2-4-015;et=core.rd-group;
base="coap://[ff05::1]";rt=core.rd-ep
</pre>
</div>
<figcaption><a href="#figure-26" class="selfRef">Figure 26</a>:
<a href="#name-example-of-a-lookup-exchang" class="selfRef">Example of a Lookup Exchange to Find Suitable Multicast Addresses</a>
</figcaption></figure>
</div>
<p id="section-10.1.2-13">From the returned base parameter value, the luminary learns the multicast address
of the multicast group.<a href="#section-10.1.2-13" class="pilcrow">¶</a></p>
<p id="section-10.1.2-14">The presence sensor can learn the presence of groups that support resources with rt=tag:example.com,2020:light in its own sector by sending the same request, as used by the luminary. The presence sensor learns the multicast address to use for sending messages to the luminaries.<a href="#section-10.1.2-14" class="pilcrow">¶</a></p>
</section>
</div>
</section>
</div>
<div id="lwm2m-ex">
<section id="section-10.2">
<h3 id="name-oma-lightweight-m2m-lwm2m">
<a href="#section-10.2" class="section-number selfRef">10.2. </a><a href="#name-oma-lightweight-m2m-lwm2m" class="section-name selfRef">OMA Lightweight M2M (LwM2M)</a>
</h3>
<p id="section-10.2-1">OMA LwM2M is a profile for device services based on CoAP, providing interfaces and operations for device management and device service enablement.<a href="#section-10.2-1" class="pilcrow">¶</a></p>
<p id="section-10.2-2">An LwM2M server is an instance of an LwM2M middleware service layer, containing an RD (<span>[<a href="#LwM2M" class="xref">LwM2M</a>]</span>, starting at page 36).<a href="#section-10.2-2" class="pilcrow">¶</a></p>
<p id="section-10.2-3">That RD only implements the registration interface, and no lookup is implemented.
Instead, the LwM2M server provides access to the registered resources in a similar way to a reverse proxy.<a href="#section-10.2-3" class="pilcrow">¶</a></p>
<p id="section-10.2-4">The location of the LwM2M server and RD URI path is provided by the LwM2M bootstrap process, so no dynamic discovery of the RD is used. LwM2M servers and endpoints are not required to implement the <code>/.well-known/core</code> resource.<a href="#section-10.2-4" class="pilcrow">¶</a></p>
</section>
</div>
</section>
</div>
<section id="section-11">
<h2 id="name-references">
<a href="#section-11" class="section-number selfRef">11. </a><a href="#name-references" class="section-name selfRef">References</a>
</h2>
<section id="section-11.1">
<h3 id="name-normative-references">
<a href="#section-11.1" class="section-number selfRef">11.1. </a><a href="#name-normative-references" class="section-name selfRef">Normative References</a>
</h3>
<dl class="references">
<dt id="RFC2119">[RFC2119]</dt>
<dd>
<span class="refAuthor">Bradner, S.</span>, <span class="refTitle">"Key words for use in RFCs to Indicate Requirement Levels"</span>, <span class="seriesInfo">BCP 14</span>, <span class="seriesInfo">RFC 2119</span>, <span class="seriesInfo">DOI 10.17487/RFC2119</span>, <time datetime="1997-03" class="refDate">March 1997</time>, <span><<a href="https://www.rfc-editor.org/info/rfc2119">https://www.rfc-editor.org/info/rfc2119</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC3986">[RFC3986]</dt>
<dd>
<span class="refAuthor">Berners-Lee, T.</span>, <span class="refAuthor">Fielding, R.</span>, and <span class="refAuthor">L. Masinter</span>, <span class="refTitle">"Uniform Resource Identifier (URI): Generic Syntax"</span>, <span class="seriesInfo">STD 66</span>, <span class="seriesInfo">RFC 3986</span>, <span class="seriesInfo">DOI 10.17487/RFC3986</span>, <time datetime="2005-01" class="refDate">January 2005</time>, <span><<a href="https://www.rfc-editor.org/info/rfc3986">https://www.rfc-editor.org/info/rfc3986</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC6570">[RFC6570]</dt>
<dd>
<span class="refAuthor">Gregorio, J.</span>, <span class="refAuthor">Fielding, R.</span>, <span class="refAuthor">Hadley, M.</span>, <span class="refAuthor">Nottingham, M.</span>, and <span class="refAuthor">D. Orchard</span>, <span class="refTitle">"URI Template"</span>, <span class="seriesInfo">RFC 6570</span>, <span class="seriesInfo">DOI 10.17487/RFC6570</span>, <time datetime="2012-03" class="refDate">March 2012</time>, <span><<a href="https://www.rfc-editor.org/info/rfc6570">https://www.rfc-editor.org/info/rfc6570</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC6690">[RFC6690]</dt>
<dd>
<span class="refAuthor">Shelby, Z.</span>, <span class="refTitle">"Constrained RESTful Environments (CoRE) Link Format"</span>, <span class="seriesInfo">RFC 6690</span>, <span class="seriesInfo">DOI 10.17487/RFC6690</span>, <time datetime="2012-08" class="refDate">August 2012</time>, <span><<a href="https://www.rfc-editor.org/info/rfc6690">https://www.rfc-editor.org/info/rfc6690</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC6763">[RFC6763]</dt>
<dd>
<span class="refAuthor">Cheshire, S.</span> and <span class="refAuthor">M. Krochmal</span>, <span class="refTitle">"DNS-Based Service Discovery"</span>, <span class="seriesInfo">RFC 6763</span>, <span class="seriesInfo">DOI 10.17487/RFC6763</span>, <time datetime="2013-02" class="refDate">February 2013</time>, <span><<a href="https://www.rfc-editor.org/info/rfc6763">https://www.rfc-editor.org/info/rfc6763</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC7230">[RFC7230]</dt>
<dd>
<span class="refAuthor">Fielding, R., Ed.</span> and <span class="refAuthor">J. Reschke, Ed.</span>, <span class="refTitle">"Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing"</span>, <span class="seriesInfo">RFC 7230</span>, <span class="seriesInfo">DOI 10.17487/RFC7230</span>, <time datetime="2014-06" class="refDate">June 2014</time>, <span><<a href="https://www.rfc-editor.org/info/rfc7230">https://www.rfc-editor.org/info/rfc7230</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC7252">[RFC7252]</dt>
<dd>
<span class="refAuthor">Shelby, Z.</span>, <span class="refAuthor">Hartke, K.</span>, and <span class="refAuthor">C. Bormann</span>, <span class="refTitle">"The Constrained Application Protocol (CoAP)"</span>, <span class="seriesInfo">RFC 7252</span>, <span class="seriesInfo">DOI 10.17487/RFC7252</span>, <time datetime="2014-06" class="refDate">June 2014</time>, <span><<a href="https://www.rfc-editor.org/info/rfc7252">https://www.rfc-editor.org/info/rfc7252</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC8126">[RFC8126]</dt>
<dd>
<span class="refAuthor">Cotton, M.</span>, <span class="refAuthor">Leiba, B.</span>, and <span class="refAuthor">T. Narten</span>, <span class="refTitle">"Guidelines for Writing an IANA Considerations Section in RFCs"</span>, <span class="seriesInfo">BCP 26</span>, <span class="seriesInfo">RFC 8126</span>, <span class="seriesInfo">DOI 10.17487/RFC8126</span>, <time datetime="2017-06" class="refDate">June 2017</time>, <span><<a href="https://www.rfc-editor.org/info/rfc8126">https://www.rfc-editor.org/info/rfc8126</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC8174">[RFC8174]</dt>
<dd>
<span class="refAuthor">Leiba, B.</span>, <span class="refTitle">"Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words"</span>, <span class="seriesInfo">BCP 14</span>, <span class="seriesInfo">RFC 8174</span>, <span class="seriesInfo">DOI 10.17487/RFC8174</span>, <time datetime="2017-05" class="refDate">May 2017</time>, <span><<a href="https://www.rfc-editor.org/info/rfc8174">https://www.rfc-editor.org/info/rfc8174</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC8288">[RFC8288]</dt>
<dd>
<span class="refAuthor">Nottingham, M.</span>, <span class="refTitle">"Web Linking"</span>, <span class="seriesInfo">RFC 8288</span>, <span class="seriesInfo">DOI 10.17487/RFC8288</span>, <time datetime="2017-10" class="refDate">October 2017</time>, <span><<a href="https://www.rfc-editor.org/info/rfc8288">https://www.rfc-editor.org/info/rfc8288</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC9175">[RFC9175]</dt>
<dd>
<span class="refAuthor">Amsüss, C.</span>, <span class="refAuthor">Preuß Mattsson, J.</span>, and <span class="refAuthor">G. Selander</span>, <span class="refTitle">"Constrained Application Protocol (CoAP): Echo, Request-Tag, and Token Processing"</span>, <span class="seriesInfo">RFC 9175</span>, <span class="seriesInfo">DOI 10.17487/RFC9175</span>, <time datetime="2022-02" class="refDate">February 2022</time>, <span><<a href="https://www.rfc-editor.org/info/rfc9175">https://www.rfc-editor.org/info/rfc9175</a>></span>. </dd>
<dd class="break"></dd>
</dl>
</section>
<section id="section-11.2">
<h3 id="name-informative-references">
<a href="#section-11.2" class="section-number selfRef">11.2. </a><a href="#name-informative-references" class="section-name selfRef">Informative References</a>
</h3>
<dl class="references">
<dt id="I-D.ietf-ace-oauth-authz">[ACE-OAUTH-AUTHZ]</dt>
<dd>
<span class="refAuthor">Seitz, L.</span>, <span class="refAuthor">Selander, G.</span>, <span class="refAuthor">Wahlstroem, E.</span>, <span class="refAuthor">Erdtman, S.</span>, and <span class="refAuthor">H. Tschofenig</span>, <span class="refTitle">"Authentication and Authorization for Constrained Environments (ACE) using the OAuth 2.0 Framework (ACE-OAuth)"</span>, <span class="refContent">Work in Progress</span>, <span class="seriesInfo">Internet-Draft, draft-ietf-ace-oauth-authz-46</span>, <time datetime="2021-11-08" class="refDate">8 November 2021</time>, <span><<a href="https://datatracker.ietf.org/doc/html/draft-ietf-ace-oauth-authz-46">https://datatracker.ietf.org/doc/html/draft-ietf-ace-oauth-authz-46</a>></span>. </dd>
<dd class="break"></dd>
<dt id="I-D.silverajan-core-coap-protocol-negotiation">[COAP-PROT-NEG]</dt>
<dd>
<span class="refAuthor">Silverajan, B.</span> and <span class="refAuthor">M. Ocak</span>, <span class="refTitle">"CoAP Protocol Negotiation"</span>, <span class="refContent">Work in Progress</span>, <span class="seriesInfo">Internet-Draft, draft-silverajan-core-coap-protocol-negotiation-09</span>, <time datetime="2018-07-02" class="refDate">2 July 2018</time>, <span><<a href="https://datatracker.ietf.org/doc/html/draft-silverajan-core-coap-protocol-negotiation-09">https://datatracker.ietf.org/doc/html/draft-silverajan-core-coap-protocol-negotiation-09</a>></span>. </dd>
<dd class="break"></dd>
<dt id="I-D.ietf-core-coral">[CORE-CORAL]</dt>
<dd>
<span class="refAuthor">Amsüss, C.</span> and <span class="refAuthor">T. Fossati</span>, <span class="refTitle">"The Constrained RESTful Application Language (CoRAL)"</span>, <span class="refContent">Work in Progress</span>, <span class="seriesInfo">Internet-Draft, draft-ietf-core-coral-05</span>, <time datetime="2022-03-07" class="refDate">7 March 2022</time>, <span><<a href="https://datatracker.ietf.org/doc/html/draft-ietf-core-coral-05">https://datatracker.ietf.org/doc/html/draft-ietf-core-coral-05</a>></span>. </dd>
<dd class="break"></dd>
<dt id="I-D.ietf-core-links-json">[CORE-LINKS-JSON]</dt>
<dd>
<span class="refAuthor">Li, K.</span>, <span class="refAuthor">Rahman, A.</span>, and <span class="refAuthor">C. Bormann, Ed.</span>, <span class="refTitle">"Representing Constrained RESTful Environments (CoRE) Link Format in JSON and CBOR"</span>, <span class="refContent">Work in Progress</span>, <span class="seriesInfo">Internet-Draft, draft-ietf-core-links-json-10</span>, <time datetime="2018-02-26" class="refDate">26 February 2018</time>, <span><<a href="https://datatracker.ietf.org/doc/html/draft-ietf-core-links-json-10">https://datatracker.ietf.org/doc/html/draft-ietf-core-links-json-10</a>></span>. </dd>
<dd class="break"></dd>
<dt id="I-D.ietf-core-rd-dns-sd">[CORE-RD-DNS-SD]</dt>
<dd>
<span class="refAuthor">van der Stok, P.</span>, <span class="refAuthor">Koster, M.</span>, and <span class="refAuthor">C. Amsuess</span>, <span class="refTitle">"CoRE Resource Directory: DNS-SD mapping"</span>, <span class="refContent">Work in Progress</span>, <span class="seriesInfo">Internet-Draft, draft-ietf-core-rd-dns-sd-05</span>, <time datetime="2019-07-07" class="refDate">7 July 2019</time>, <span><<a href="https://datatracker.ietf.org/doc/html/draft-ietf-core-rd-dns-sd-05">https://datatracker.ietf.org/doc/html/draft-ietf-core-rd-dns-sd-05</a>></span>. </dd>
<dd class="break"></dd>
<dt id="ER">[ER]</dt>
<dd>
<span class="refAuthor">Chen, P.</span>, <span class="refTitle">"The entity-relationship model--toward a unified view of data"</span>, <span class="refContent">ACM Transactions on Database Systems, Vol. 1, pp. 9-36</span>, <span class="seriesInfo">DOI 10.1145/320434.320440</span>, <time datetime="1976-03" class="refDate">March 1976</time>, <span><<a href="https://doi.org/10.1145/320434.320440">https://doi.org/10.1145/320434.320440</a>></span>. </dd>
<dd class="break"></dd>
<dt id="LwM2M">[LwM2M]</dt>
<dd>
<span class="refAuthor">Open Mobile Alliance</span>, <span class="refTitle">"Lightweight Machine to Machine Technical Specification: Transport Bindings (Candidate Version 1.1)"</span>, <time datetime="2018-06" class="refDate">June 2018</time>, <span><<a href="https://openmobilealliance.org/RELEASE/LightweightM2M/V1_1-20180612-C/OMA-TS-LightweightM2M_Transport-V1_1-20180612-C.pdf">https://openmobilealliance.org/RELEASE/LightweightM2M/V1_1-20180612-C/OMA-TS-LightweightM2M_Transport-V1_1-20180612-C.pdf</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC3306">[RFC3306]</dt>
<dd>
<span class="refAuthor">Haberman, B.</span> and <span class="refAuthor">D. Thaler</span>, <span class="refTitle">"Unicast-Prefix-based IPv6 Multicast Addresses"</span>, <span class="seriesInfo">RFC 3306</span>, <span class="seriesInfo">DOI 10.17487/RFC3306</span>, <time datetime="2002-08" class="refDate">August 2002</time>, <span><<a href="https://www.rfc-editor.org/info/rfc3306">https://www.rfc-editor.org/info/rfc3306</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC3307">[RFC3307]</dt>
<dd>
<span class="refAuthor">Haberman, B.</span>, <span class="refTitle">"Allocation Guidelines for IPv6 Multicast Addresses"</span>, <span class="seriesInfo">RFC 3307</span>, <span class="seriesInfo">DOI 10.17487/RFC3307</span>, <time datetime="2002-08" class="refDate">August 2002</time>, <span><<a href="https://www.rfc-editor.org/info/rfc3307">https://www.rfc-editor.org/info/rfc3307</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC3849">[RFC3849]</dt>
<dd>
<span class="refAuthor">Huston, G.</span>, <span class="refAuthor">Lord, A.</span>, and <span class="refAuthor">P. Smith</span>, <span class="refTitle">"IPv6 Address Prefix Reserved for Documentation"</span>, <span class="seriesInfo">RFC 3849</span>, <span class="seriesInfo">DOI 10.17487/RFC3849</span>, <time datetime="2004-07" class="refDate">July 2004</time>, <span><<a href="https://www.rfc-editor.org/info/rfc3849">https://www.rfc-editor.org/info/rfc3849</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC4122">[RFC4122]</dt>
<dd>
<span class="refAuthor">Leach, P.</span>, <span class="refAuthor">Mealling, M.</span>, and <span class="refAuthor">R. Salz</span>, <span class="refTitle">"A Universally Unique IDentifier (UUID) URN Namespace"</span>, <span class="seriesInfo">RFC 4122</span>, <span class="seriesInfo">DOI 10.17487/RFC4122</span>, <time datetime="2005-07" class="refDate">July 2005</time>, <span><<a href="https://www.rfc-editor.org/info/rfc4122">https://www.rfc-editor.org/info/rfc4122</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC4944">[RFC4944]</dt>
<dd>
<span class="refAuthor">Montenegro, G.</span>, <span class="refAuthor">Kushalnagar, N.</span>, <span class="refAuthor">Hui, J.</span>, and <span class="refAuthor">D. Culler</span>, <span class="refTitle">"Transmission of IPv6 Packets over IEEE 802.15.4 Networks"</span>, <span class="seriesInfo">RFC 4944</span>, <span class="seriesInfo">DOI 10.17487/RFC4944</span>, <time datetime="2007-09" class="refDate">September 2007</time>, <span><<a href="https://www.rfc-editor.org/info/rfc4944">https://www.rfc-editor.org/info/rfc4944</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC5771">[RFC5771]</dt>
<dd>
<span class="refAuthor">Cotton, M.</span>, <span class="refAuthor">Vegoda, L.</span>, and <span class="refAuthor">D. Meyer</span>, <span class="refTitle">"IANA Guidelines for IPv4 Multicast Address Assignments"</span>, <span class="seriesInfo">BCP 51</span>, <span class="seriesInfo">RFC 5771</span>, <span class="seriesInfo">DOI 10.17487/RFC5771</span>, <time datetime="2010-03" class="refDate">March 2010</time>, <span><<a href="https://www.rfc-editor.org/info/rfc5771">https://www.rfc-editor.org/info/rfc5771</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC6724">[RFC6724]</dt>
<dd>
<span class="refAuthor">Thaler, D., Ed.</span>, <span class="refAuthor">Draves, R.</span>, <span class="refAuthor">Matsumoto, A.</span>, and <span class="refAuthor">T. Chown</span>, <span class="refTitle">"Default Address Selection for Internet Protocol Version 6 (IPv6)"</span>, <span class="seriesInfo">RFC 6724</span>, <span class="seriesInfo">DOI 10.17487/RFC6724</span>, <time datetime="2012-09" class="refDate">September 2012</time>, <span><<a href="https://www.rfc-editor.org/info/rfc6724">https://www.rfc-editor.org/info/rfc6724</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC6775">[RFC6775]</dt>
<dd>
<span class="refAuthor">Shelby, Z., Ed.</span>, <span class="refAuthor">Chakrabarti, S.</span>, <span class="refAuthor">Nordmark, E.</span>, and <span class="refAuthor">C. Bormann</span>, <span class="refTitle">"Neighbor Discovery Optimization for IPv6 over Low-Power Wireless Personal Area Networks (6LoWPANs)"</span>, <span class="seriesInfo">RFC 6775</span>, <span class="seriesInfo">DOI 10.17487/RFC6775</span>, <time datetime="2012-11" class="refDate">November 2012</time>, <span><<a href="https://www.rfc-editor.org/info/rfc6775">https://www.rfc-editor.org/info/rfc6775</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC6874">[RFC6874]</dt>
<dd>
<span class="refAuthor">Carpenter, B.</span>, <span class="refAuthor">Cheshire, S.</span>, and <span class="refAuthor">R. Hinden</span>, <span class="refTitle">"Representing IPv6 Zone Identifiers in Address Literals and Uniform Resource Identifiers"</span>, <span class="seriesInfo">RFC 6874</span>, <span class="seriesInfo">DOI 10.17487/RFC6874</span>, <time datetime="2013-02" class="refDate">February 2013</time>, <span><<a href="https://www.rfc-editor.org/info/rfc6874">https://www.rfc-editor.org/info/rfc6874</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC7228">[RFC7228]</dt>
<dd>
<span class="refAuthor">Bormann, C.</span>, <span class="refAuthor">Ersue, M.</span>, and <span class="refAuthor">A. Keranen</span>, <span class="refTitle">"Terminology for Constrained-Node Networks"</span>, <span class="seriesInfo">RFC 7228</span>, <span class="seriesInfo">DOI 10.17487/RFC7228</span>, <time datetime="2014-05" class="refDate">May 2014</time>, <span><<a href="https://www.rfc-editor.org/info/rfc7228">https://www.rfc-editor.org/info/rfc7228</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC7641">[RFC7641]</dt>
<dd>
<span class="refAuthor">Hartke, K.</span>, <span class="refTitle">"Observing Resources in the Constrained Application Protocol (CoAP)"</span>, <span class="seriesInfo">RFC 7641</span>, <span class="seriesInfo">DOI 10.17487/RFC7641</span>, <time datetime="2015-09" class="refDate">September 2015</time>, <span><<a href="https://www.rfc-editor.org/info/rfc7641">https://www.rfc-editor.org/info/rfc7641</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC8106">[RFC8106]</dt>
<dd>
<span class="refAuthor">Jeong, J.</span>, <span class="refAuthor">Park, S.</span>, <span class="refAuthor">Beloeil, L.</span>, and <span class="refAuthor">S. Madanapalli</span>, <span class="refTitle">"IPv6 Router Advertisement Options for DNS Configuration"</span>, <span class="seriesInfo">RFC 8106</span>, <span class="seriesInfo">DOI 10.17487/RFC8106</span>, <time datetime="2017-03" class="refDate">March 2017</time>, <span><<a href="https://www.rfc-editor.org/info/rfc8106">https://www.rfc-editor.org/info/rfc8106</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC8132">[RFC8132]</dt>
<dd>
<span class="refAuthor">van der Stok, P.</span>, <span class="refAuthor">Bormann, C.</span>, and <span class="refAuthor">A. Sehgal</span>, <span class="refTitle">"PATCH and FETCH Methods for the Constrained Application Protocol (CoAP)"</span>, <span class="seriesInfo">RFC 8132</span>, <span class="seriesInfo">DOI 10.17487/RFC8132</span>, <time datetime="2017-04" class="refDate">April 2017</time>, <span><<a href="https://www.rfc-editor.org/info/rfc8132">https://www.rfc-editor.org/info/rfc8132</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC8141">[RFC8141]</dt>
<dd>
<span class="refAuthor">Saint-Andre, P.</span> and <span class="refAuthor">J. Klensin</span>, <span class="refTitle">"Uniform Resource Names (URNs)"</span>, <span class="seriesInfo">RFC 8141</span>, <span class="seriesInfo">DOI 10.17487/RFC8141</span>, <time datetime="2017-04" class="refDate">April 2017</time>, <span><<a href="https://www.rfc-editor.org/info/rfc8141">https://www.rfc-editor.org/info/rfc8141</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC8613">[RFC8613]</dt>
<dd>
<span class="refAuthor">Selander, G.</span>, <span class="refAuthor">Mattsson, J.</span>, <span class="refAuthor">Palombini, F.</span>, and <span class="refAuthor">L. Seitz</span>, <span class="refTitle">"Object Security for Constrained RESTful Environments (OSCORE)"</span>, <span class="seriesInfo">RFC 8613</span>, <span class="seriesInfo">DOI 10.17487/RFC8613</span>, <time datetime="2019-07" class="refDate">July 2019</time>, <span><<a href="https://www.rfc-editor.org/info/rfc8613">https://www.rfc-editor.org/info/rfc8613</a>></span>. </dd>
<dd class="break"></dd>
<dt id="I-D.bormann-t2trg-rel-impl">[T2TRG-REL-IMPL]</dt>
<dd>
<span class="refAuthor">Bormann, C.</span>, <span class="refTitle">"impl-info: A link relation type for disclosing implementation information"</span>, <span class="refContent">Work in Progress</span>, <span class="seriesInfo">Internet-Draft, draft-bormann-t2trg-rel-impl-02</span>, <time datetime="2020-09-27" class="refDate">27 September 2020</time>, <span><<a href="https://datatracker.ietf.org/doc/html/draft-bormann-t2trg-rel-impl-02">https://datatracker.ietf.org/doc/html/draft-bormann-t2trg-rel-impl-02</a>></span>. </dd>
<dd class="break"></dd>
</dl>
</section>
</section>
<div id="groups">
<section id="appendix-A">
<h2 id="name-groups-registration-and-loo">
<a href="#appendix-A" class="section-number selfRef">Appendix A. </a><a href="#name-groups-registration-and-loo" class="section-name selfRef">Groups Registration and Lookup</a>
</h2>
<p id="appendix-A-1">The RD-Group's usage pattern allows announcing application groups inside an RD.<a href="#appendix-A-1" class="pilcrow">¶</a></p>
<p id="appendix-A-2">Groups are represented by endpoint registrations.
Their base address is a multicast address,
and they <span class="bcp14">SHOULD</span> be entered with the endpoint type <code>core.rd-group</code>.
The endpoint name can also be referred to as a group name in this context.<a href="#appendix-A-2" class="pilcrow">¶</a></p>
<p id="appendix-A-3">The registration is inserted into the RD by a Commissioning Tool,
which might also be known as a group manager here.
It performs third-party registration and registration updates.<a href="#appendix-A-3" class="pilcrow">¶</a></p>
<p id="appendix-A-4">The links it registers <span class="bcp14">SHOULD</span> be available on all members that join the group.
Depending on the application, members that lack some resources
<span class="bcp14">MAY</span> be permissible if requests to them fail gracefully.<a href="#appendix-A-4" class="pilcrow">¶</a></p>
<p id="appendix-A-5">The following example shows a CT registering a group with the name "lights", which provides two resources.
The directory resource path /rd
is an example RD location discovered in a request similar to <a href="#example-discovery" class="xref">Figure 5</a>.
The group address in the example is constructed from the reserved 2001:db8:: prefix in <span>[<a href="#RFC3849" class="xref">RFC3849</a>]</span> as a unicast-prefix-based site-local address (see <span>[<a href="#RFC3306" class="xref">RFC3306</a>]</span>).<a href="#appendix-A-5" class="pilcrow">¶</a></p>
<span id="name-example-registration-of-a-g"></span><div id="example-group-registration">
<figure id="figure-27">
<div id="appendix-A-6.1">
<pre class="sourcecode">
Req: POST coap://rd.example.com/rd?ep=lights&et=core.rd-group
&base=coap://[ff35:30:2001:db8:f1::8000:1]
Content-Format: 40
Payload:
</light>;rt="tag:example.com,2020:light";
if="tag:example.net,2020:actuator",
</color-temperature>;if="tag:example.net,2020:parameter";u=K
Res: 2.01 Created
Location-Path: /rd/12
</pre>
</div>
<figcaption><a href="#figure-27" class="selfRef">Figure 27</a>:
<a href="#name-example-registration-of-a-g" class="selfRef">Example Registration of a Group</a>
</figcaption></figure>
</div>
<p id="appendix-A-7">In this example, the group manager can easily permit devices that have no
writable color-temperature to join, as they would still respond to brightness-changing commands. Had the group instead contained a single resource that sets
brightness and color-temperature atomically, endpoints would need to support
both properties.<a href="#appendix-A-7" class="pilcrow">¶</a></p>
<p id="appendix-A-8">The resources of a group can be looked up like any other resource,
and the group registrations (along with any additional registration parameters)
can be looked up using the endpoint lookup interface.<a href="#appendix-A-8" class="pilcrow">¶</a></p>
<p id="appendix-A-9">The following example shows a client performing an endpoint lookup for all groups:<a href="#appendix-A-9" class="pilcrow">¶</a></p>
<span id="name-example-lookup-of-groups"></span><div id="example-group-lookup">
<figure id="figure-28">
<div id="appendix-A-10.1">
<pre class="sourcecode">
Req: GET /rd-lookup/ep?et=core.rd-group
Res: 2.05 Content
Payload:
</rd/12>;ep=lights&et=core.rd-group;
base="coap://[ff35:30:2001:f1:db8::8000:1]";rt=core.rd-ep
</pre>
</div>
<figcaption><a href="#figure-28" class="selfRef">Figure 28</a>:
<a href="#name-example-lookup-of-groups" class="selfRef">Example Lookup of Groups</a>
</figcaption></figure>
</div>
<p id="appendix-A-11">The following example shows a client performing a lookup of all resources of all endpoints (groups) with et=core.rd-group:<a href="#appendix-A-11" class="pilcrow">¶</a></p>
<span id="name-example-lookup-of-resources"></span><div id="example-group-lookup-res">
<figure id="figure-29">
<div id="appendix-A-12.1">
<pre class="sourcecode">
Req: GET /rd-lookup/res?et=core.rd-group
Res: 2.05 Content
Payload:
<coap://[ff35:30:2001:db8:f1::8000:1]/light>;
rt="tag:example.com,2020:light";
if="tag:example.net,2020:actuator",
<coap://[ff35:30:2001:db8:f1::8000:1]/color-temperature>;
if="tag:example.net,2020:parameter";u=K,
</pre>
</div>
<figcaption><a href="#figure-29" class="selfRef">Figure 29</a>:
<a href="#name-example-lookup-of-resources" class="selfRef">Example Lookup of Resources Inside Groups</a>
</figcaption></figure>
</div>
</section>
</div>
<div id="weblink">
<section id="appendix-B">
<h2 id="name-web-links-and-the-resource-">
<a href="#appendix-B" class="section-number selfRef">Appendix B. </a><a href="#name-web-links-and-the-resource-" class="section-name selfRef">Web Links and the Resource Directory</a>
</h2>
<p id="appendix-B-1">Understanding the semantics of a link-format document and its URI references is
a journey through different documents (<span>[<a href="#RFC3986" class="xref">RFC3986</a>]</span> defining URIs, <span>[<a href="#RFC6690" class="xref">RFC6690</a>]</span>
defining link-format documents based on <span>[<a href="#RFC8288" class="xref">RFC8288</a>]</span>, which defines Link header fields,
and <span>[<a href="#RFC7252" class="xref">RFC7252</a>]</span> providing the transport). This appendix summarizes
the mechanisms and semantics at play from an entry in <code>/.well-known/core</code> to a
resource lookup.<a href="#appendix-B-1" class="pilcrow">¶</a></p>
<p id="appendix-B-2">This text is primarily aimed at people entering the field of Constrained
Restful Environments from applications that previously did not use web
mechanisms.<a href="#appendix-B-2" class="pilcrow">¶</a></p>
<div id="a-simple-example">
<section id="appendix-B.1">
<h3 id="name-a-simple-example">
<a href="#appendix-B.1" class="section-number selfRef">B.1. </a><a href="#name-a-simple-example" class="section-name selfRef">A Simple Example</a>
</h3>
<p id="appendix-B.1-1">Let's start this example with a very simple host, <code>2001:db8:f0::1</code>. A client
that follows classical CoAP discovery (<span>[<a href="#RFC7252" class="xref">RFC7252</a>], <a href="https://www.rfc-editor.org/rfc/rfc7252#section-7" class="relref">Section 7</a></span>) sends the
following multicast request to learn about neighbors supporting resources with
resource-type "temperature".<a href="#appendix-B.1-1" class="pilcrow">¶</a></p>
<p id="appendix-B.1-2">The client sends a link-local multicast:<a href="#appendix-B.1-2" class="pilcrow">¶</a></p>
<span id="name-example-of-direct-resource-"></span><div id="example-weblink-wkc">
<figure id="figure-30">
<div id="appendix-B.1-3.1">
<pre class="sourcecode">
Req: GET coap://[ff02::fd]:5683/.well-known/core?rt=temperature
Res: 2.05 Content
Payload:
</sensors/temp>;rt=temperature;ct=0
</pre>
</div>
<figcaption><a href="#figure-30" class="selfRef">Figure 30</a>:
<a href="#name-example-of-direct-resource-" class="selfRef">Example of Direct Resource Discovery</a>
</figcaption></figure>
</div>
<p id="appendix-B.1-4">where the response is sent by the server, <code>[2001:db8:f0::1]:5683</code>.<a href="#appendix-B.1-4" class="pilcrow">¶</a></p>
<p id="appendix-B.1-5">While a practical client side implementation might just go
ahead and create a new request to <code>[2001:db8:f0::1]:5683</code> with Uri-Path
<code>sensors</code> and <code>temp</code>, the full resolution steps for insertion into and retrieval from the RD without any shortcuts are as follows.<a href="#appendix-B.1-5" class="pilcrow">¶</a></p>
<div id="resolveURI">
<section id="appendix-B.1.1">
<h4 id="name-resolving-the-uris">
<a href="#appendix-B.1.1" class="section-number selfRef">B.1.1. </a><a href="#name-resolving-the-uris" class="section-name selfRef">Resolving the URIs</a>
</h4>
<p id="appendix-B.1.1-1">The client parses the single returned link. Its target (sometimes
called "href") is <code>/sensors/temp</code>, which is a relative URI that needs resolving.
The base
URI <code>coap://[ff02::fd]:5683/.well-known/core</code> is used to resolve the
reference against <code>/sensors/temp</code>.<a href="#appendix-B.1.1-1" class="pilcrow">¶</a></p>
<p id="appendix-B.1.1-2">The base URI of the requested resource can be composed from the options of the CoAP GET request by following the steps of
<span>[<a href="#RFC7252" class="xref">RFC7252</a>], <a href="https://www.rfc-editor.org/rfc/rfc7252#section-6.5" class="relref">Section 6.5</a></span> (with an addition at the end of Section <a href="https://www.rfc-editor.org/rfc/rfc7252#section-8.2" class="relref">8.2</a>) into
<code>coap://[2001:db8:f0::1]/.well-known/core</code>.<a href="#appendix-B.1.1-2" class="pilcrow">¶</a></p>
<p id="appendix-B.1.1-3">Because <code>/sensors/temp</code> starts with a single slash,
the link's target is resolved by replacing the path <code>/.well-known/core</code>
from the base URI (<span>[<a href="#RFC3986" class="xref">RFC3986</a>], <a href="https://www.rfc-editor.org/rfc/rfc3986#section-5.2" class="relref">Section 5.2</a></span>) with the relative target URI <code>/sensors/temp</code> into
<code>coap://[2001:db8:f0::1]/sensors/temp</code>.<a href="#appendix-B.1.1-3" class="pilcrow">¶</a></p>
</section>
</div>
<div id="interpreting-attributes-and-relations">
<section id="appendix-B.1.2">
<h4 id="name-interpreting-attributes-and">
<a href="#appendix-B.1.2" class="section-number selfRef">B.1.2. </a><a href="#name-interpreting-attributes-and" class="section-name selfRef">Interpreting Attributes and Relations</a>
</h4>
<p id="appendix-B.1.2-1">Some more information about the link's target can be obtained from the payload:
the resource type of the target is "temperature", and its content format is
text/plain (ct=0).<a href="#appendix-B.1.2-1" class="pilcrow">¶</a></p>
<p id="appendix-B.1.2-2">A relation in a web link is a three-part statement that specifies a named relation between the so-called "context resource"
and the target resource, like "<em>This page</em> has <em>its table
of contents</em> at <em>/toc.html</em>". In link-format documents,
there is an implicit "host relation" specified with default parameter rel="hosts".<a href="#appendix-B.1.2-2" class="pilcrow">¶</a></p>
<p id="appendix-B.1.2-3">In our example, the context resource of the link is implied to be <code>coap:://[2001:db8:f0::1]</code>
by the default value of the anchor (see <a href="#resolution-rules" class="xref">Appendix B.4</a>).
A full English expression of the "host relation" is:<a href="#appendix-B.1.2-3" class="pilcrow">¶</a></p>
<p style="margin-left: 1.5em" id="appendix-B.1.2-4"><code>coap://[2001:db8:f0::1]</code> is hosting the resource
<code>coap://[2001:db8:f0::1]/sensors/temp</code>, which is of the resource type "temperature" and
can be read in the text/plain content format.<a href="#appendix-B.1.2-4" class="pilcrow">¶</a></p>
</section>
</div>
</section>
</div>
<div id="a-slightly-more-complex-example">
<section id="appendix-B.2">
<h3 id="name-a-slightly-more-complex-exa">
<a href="#appendix-B.2" class="section-number selfRef">B.2. </a><a href="#name-a-slightly-more-complex-exa" class="section-name selfRef">A Slightly More Complex Example</a>
</h3>
<p id="appendix-B.2-1">Omitting the <code>rt=temperature</code> filter, the discovery query would
have given some more links in the payload:<a href="#appendix-B.2-1" class="pilcrow">¶</a></p>
<span id="name-extended-example-of-direct-"></span><div id="example-weblink-wkc-extended">
<figure id="figure-31">
<div id="appendix-B.2-2.1">
<pre class="sourcecode">
Req: GET coap://[ff02::fd]:5683/.well-known/core
Res: 2.05 Content
Payload:
</sensors/temp>;rt=temperature;ct=0,
</sensors/light>;rt=light-lux;ct=0,
</t>;anchor="/sensors/temp";rel=alternate,
<http://www.example.com/sensors/t123>;anchor="/sensors/temp";
rel=describedby
</pre>
</div>
<figcaption><a href="#figure-31" class="selfRef">Figure 31</a>:
<a href="#name-extended-example-of-direct-" class="selfRef">Extended Example of Direct Resource Discovery</a>
</figcaption></figure>
</div>
<p id="appendix-B.2-3">Parsing the third link, the client encounters the "anchor" parameter. It is
a URI relative to the base URI of the request and is thus resolved to
<code>coap://[2001:db8:f0::1]/sensors/temp</code>.
That is the context resource of the link, so the "rel" statement is not about
the target and the base URI any more but about the target and the resolved
URI. Thus, the third link could be read as:<a href="#appendix-B.2-3" class="pilcrow">¶</a></p>
<p style="margin-left: 1.5em" id="appendix-B.2-4"><code>coap://[2001:db8:f0::1]/sensors/temp</code> has an alternate representation at
<code>coap://[2001:db8:f0::1]/t</code>.<a href="#appendix-B.2-4" class="pilcrow">¶</a></p>
<p id="appendix-B.2-5">Following the same resolution steps, the fourth link can be read as <code>coap://[2001:db8:f0::1]/sensors/temp</code> is
described by <code>http://www.example.com/sensors/t123</code>.<a href="#appendix-B.2-5" class="pilcrow">¶</a></p>
</section>
</div>
<div id="enter-the-resource-directory">
<section id="appendix-B.3">
<h3 id="name-enter-the-resource-director">
<a href="#appendix-B.3" class="section-number selfRef">B.3. </a><a href="#name-enter-the-resource-director" class="section-name selfRef">Enter the Resource Directory</a>
</h3>
<p id="appendix-B.3-1">The RD tries to carry the semantics obtainable by classical
CoAP discovery over to the resource lookup interface as faithfully as possible.<a href="#appendix-B.3-1" class="pilcrow">¶</a></p>
<p id="appendix-B.3-2">For the following queries, we will assume that the simple host has used simple
registration to register at the RD that was announced to it,
sending this request from its UDP port <code>[2001:db8:f0::1]:6553</code>:<a href="#appendix-B.3-2" class="pilcrow">¶</a></p>
<span id="name-example-of-a-simple-registr"></span><div id="example-weblink-simple">
<figure id="figure-32">
<div id="appendix-B.3-3.1">
<pre class="sourcecode">
Req: POST coap://[2001:db8:f0::ff]/.well-known/rd?ep=simple-host1
Res: 2.04 Changed
</pre>
</div>
<figcaption><a href="#figure-32" class="selfRef">Figure 32</a>:
<a href="#name-example-of-a-simple-registr" class="selfRef">Example of a Simple Registration</a>
</figcaption></figure>
</div>
<p id="appendix-B.3-4">The RD would have accepted the registration and queried the
simple host's <code>/.well-known/core</code> by itself. As a result, the host is registered
as an endpoint in the RD with the name "simple-host1". The registration is
active for 90000 seconds, and the endpoint registration base URI is
<code>coap://[2001:db8:f0::1]</code>, following the resolution steps described in <a href="#resolveURI" class="xref">Appendix B.1.1</a>. It should be remarked that the base URI constructed that way always yields a URI of the form scheme://authority without path suffix.<a href="#appendix-B.3-4" class="pilcrow">¶</a></p>
<p id="appendix-B.3-5">If the client now queries the RD as it would previously have issued a multicast
request, it would go through the RD discovery steps by fetching
<code>coap://[2001:db8:f0::ff]/.well-known/core?rt=core.rd-lookup-res</code>, obtain
<code>coap://[2001:db8:f0::ff]/rd-lookup/res</code> as the resource lookup endpoint, and
ask it for all temperature resources:<a href="#appendix-B.3-5" class="pilcrow">¶</a></p>
<span id="name-example-exchange-performing"></span><div id="example-weblink-lookup-result">
<figure id="figure-33">
<div id="appendix-B.3-6.1">
<pre class="sourcecode">
Req: GET coap://[2001:db8:f0::ff]/rd-lookup/res?rt=temperature
Res: 2.05 Content
Payload:
<coap://[2001:db8:f0::1]/sensors/temp>;rt=temperature;ct=0
</pre>
</div>
<figcaption><a href="#figure-33" class="selfRef">Figure 33</a>:
<a href="#name-example-exchange-performing" class="selfRef">Example Exchange Performing Resource Lookup</a>
</figcaption></figure>
</div>
<p id="appendix-B.3-7">This is not <em>literally</em> the same response that it would have received from a
multicast request, but it contains the equivalent statement:<a href="#appendix-B.3-7" class="pilcrow">¶</a></p>
<p style="margin-left: 1.5em" id="appendix-B.3-8"><code>coap://[2001:db8:f0::1]</code> is hosting the resource
<code>coap://[2001:db8:f0::1]/sensors/temp</code>, which is of the resource type "temperature" and
can be accessed using the text/plain content format.<a href="#appendix-B.3-8" class="pilcrow">¶</a></p>
<p id="appendix-B.3-9">To complete the examples, the client could also query all resources hosted at
the endpoint with the known endpoint name "simple-host1":<a href="#appendix-B.3-9" class="pilcrow">¶</a></p>
<span id="name-extended-example-exchange-p"></span><div id="example-weblink-lookup-result-extended">
<figure id="figure-34">
<div id="appendix-B.3-10.1">
<pre class="sourcecode">
Req: GET coap://[2001:db8:f0::ff]/rd-lookup/res?ep=simple-host1
Res: 2.05 Content
Payload:
<coap://[2001:db8:f0::1]/sensors/temp>;rt=temperature;ct=0,
<coap://[2001:db8:f0::1]/sensors/light>;rt=light-lux;ct=0,
<coap://[2001:db8:f0::1]/t>;
anchor="coap://[2001:db8:f0::1]/sensors/temp";rel=alternate,
<http://www.example.com/sensors/t123>;
anchor="coap://[2001:db8:f0::1]/sensors/temp";rel=describedby
</pre>
</div>
<figcaption><a href="#figure-34" class="selfRef">Figure 34</a>:
<a href="#name-extended-example-exchange-p" class="selfRef">Extended Example Exchange Performing Resource Lookup</a>
</figcaption></figure>
</div>
<p id="appendix-B.3-11">All the target and anchor references are already in absolute form there, which
don't need to be resolved any further.<a href="#appendix-B.3-11" class="pilcrow">¶</a></p>
<p id="appendix-B.3-12">Had the simple host done an equivalent full registration with a base= parameter (e.g.,
<code>?ep=simple-host1&base=coap+tcp://sh1.example.com</code>), that context would
have been used to resolve the relative anchor values instead, giving the following and analogous links:<a href="#appendix-B.3-12" class="pilcrow">¶</a></p>
<span id="name-example-payload-of-a-respon"></span><div id="example-weblink-lookup-result-base">
<figure id="figure-35">
<div id="appendix-B.3-13.1">
<pre class="sourcecode">
<coap+tcp://sh1.example.com/sensors/temp>;rt=temperature;ct=0
</pre>
</div>
<figcaption><a href="#figure-35" class="selfRef">Figure 35</a>:
<a href="#name-example-payload-of-a-respon" class="selfRef">Example Payload of a Response to a Resource Lookup with a Dedicated Base URI</a>
</figcaption></figure>
</div>
</section>
</div>
<div id="resolution-rules">
<section id="appendix-B.4">
<h3 id="name-a-note-on-differences-betwe">
<a href="#appendix-B.4" class="section-number selfRef">B.4. </a><a href="#name-a-note-on-differences-betwe" class="section-name selfRef">A Note on Differences between Link-Format and Link Header Fields</a>
</h3>
<p id="appendix-B.4-1">While link-format and Link header fields look very similar and are based on the same
model of typed links, there are some differences between <span>[<a href="#RFC6690" class="xref">RFC6690</a>]</span> and
<span>[<a href="#RFC8288" class="xref">RFC8288</a>]</span>.
When implementing an RD or interacting with an RD,
care must be taken to follow the behavior described in <span>[<a href="#RFC6690" class="xref">RFC6690</a>]</span>
whenever <code>application/link-format</code> representations are used.<a href="#appendix-B.4-1" class="pilcrow">¶</a></p>
<ul class="normal">
<li class="normal" id="appendix-B.4-2.1">
<p id="appendix-B.4-2.1.1">"Default value of anchor":
Under both <span>[<a href="#RFC6690" class="xref">RFC6690</a>]</span> and <span>[<a href="#RFC8288" class="xref">RFC8288</a>]</span>,
relative references in the term inside the angle brackets (the target)
and the anchor attribute are resolved against the relevant base URI
(which usually is the URI used to retrieve the entity)
and independent of each other.<a href="#appendix-B.4-2.1.1" class="pilcrow">¶</a></p>
<p id="appendix-B.4-2.1.2">
When, in a Link header <span>[<a href="#RFC8288" class="xref">RFC8288</a>]</span>, the anchor attribute is absent,
the link's context is the URI of the selected representation
(and usually equal to the base URI).<a href="#appendix-B.4-2.1.2" class="pilcrow">¶</a></p>
<p id="appendix-B.4-2.1.3">
In links per <span>[<a href="#RFC6690" class="xref">RFC6690</a>]</span>, if the anchor attribute is absent,
the default value is the Origin of
(for all relevant cases, the URI reference <code>/</code> resolved against)
the link's target.<a href="#appendix-B.4-2.1.3" class="pilcrow">¶</a></p>
</li>
<li class="normal" id="appendix-B.4-2.2">
<p id="appendix-B.4-2.2.1">There is no percent encoding in link-format documents.<a href="#appendix-B.4-2.2.1" class="pilcrow">¶</a></p>
<p id="appendix-B.4-2.2.2">A link-format document is a UTF-8-encoded string of Unicode characters and
does not have percent encoding, while Link header fields are practically ASCII
strings that use percent encoding for non-ASCII characters, stating the
encoding explicitly when required.<a href="#appendix-B.4-2.2.2" class="pilcrow">¶</a></p>
<p id="appendix-B.4-2.2.3">For example, while a Link header field in a page about a Swedish city might
read:<a href="#appendix-B.4-2.2.3" class="pilcrow">¶</a></p>
<div id="appendix-B.4-2.2.4">
<pre class="lang-http-message sourcecode">
Link: </temperature/Malm%C3%B6>;rel=live-environment-data
</pre><a href="#appendix-B.4-2.2.4" class="pilcrow">¶</a>
</div>
<p id="appendix-B.4-2.2.5">
a link-format document from the same source might describe the link as:<a href="#appendix-B.4-2.2.5" class="pilcrow">¶</a></p>
<div id="appendix-B.4-2.2.6">
<pre class="sourcecode">
</temperature/Malmö>;rel=live-environment-data
</pre><a href="#appendix-B.4-2.2.6" class="pilcrow">¶</a>
</div>
</li>
</ul>
</section>
</div>
</section>
</div>
<div id="limitedlinkformat">
<section id="appendix-C">
<h2 id="name-limited-link-format">
<a href="#appendix-C" class="section-number selfRef">Appendix C. </a><a href="#name-limited-link-format" class="section-name selfRef">Limited Link Format</a>
</h2>
<p id="appendix-C-1">The CoRE Link Format, as described in <span>[<a href="#RFC6690" class="xref">RFC6690</a>]</span>,
has been interpreted differently by implementers,
and a strict implementation
rules out some use cases of an RD
(e.g., base values with path components in combination with absent anchors).<a href="#appendix-C-1" class="pilcrow">¶</a></p>
<p id="appendix-C-2">This appendix describes
a subset of link format documents called the Limited Link Format.
The one rule herein is not very limiting in practice --
all examples in <span>[<a href="#RFC6690" class="xref">RFC6690</a>]</span> and all deployments the authors are aware of already stick to them --
but eases the implementation of RD servers.<a href="#appendix-C-2" class="pilcrow">¶</a></p>
<p id="appendix-C-3">It is applicable to representations in the <code>application/link-format</code> media type
and any other media types that inherit <span>[<a href="#RFC6690" class="xref">RFC6690</a>], <a href="https://www.rfc-editor.org/rfc/rfc6690#section-2.1" class="relref">Section 2.1</a></span>.<a href="#appendix-C-3" class="pilcrow">¶</a></p>
<p id="appendix-C-4">A link format representation is in the Limited Link Format if,
for each link in it,
the following applies:<a href="#appendix-C-4" class="pilcrow">¶</a></p>
<p id="appendix-C-5">All URI references either follow the URI or the path-absolute ABNF rule of
<span>[<a href="#RFC3986" class="xref">RFC3986</a>]</span> (i.e., the target and anchor each either start with a scheme or with a
single slash).<a href="#appendix-C-5" class="pilcrow">¶</a></p>
</section>
</div>
<div id="acknowledgments">
<section id="appendix-D">
<h2 id="name-acknowledgments">
<a href="#name-acknowledgments" class="section-name selfRef">Acknowledgments</a>
</h2>
<p id="appendix-D-1"> <span class="contact-name">Oscar Novo</span>, <span class="contact-name">Srdjan Krco</span>, <span class="contact-name">Szymon Sasin</span>, <span class="contact-name">Kerry Lynn</span>, <span class="contact-name">Esko Dijk</span>, <span class="contact-name">Anders Brandt</span>, <span class="contact-name">Matthieu Vial</span>, <span class="contact-name">Jim Schaad</span>, <span class="contact-name">Mohit Sethi</span>, <span class="contact-name">Hauke Petersen</span>, <span class="contact-name">Hannes Tschofenig</span>, <span class="contact-name">Sampo Ukkola</span>, <span class="contact-name">Linyi Tian</span>, <span class="contact-name">Jan Newmarch</span>, <span class="contact-name">Matthias Kovatsch</span>, <span class="contact-name">Jaime Jimenez</span>, and <span class="contact-name">Ted Lemon</span> have provided helpful comments, discussions, and ideas to improve and shape this document. Zach would also like to thank his colleagues from the EU FP7 SENSEI project, where many of the RD concepts were originally developed.<a href="#appendix-D-1" class="pilcrow">¶</a></p>
</section>
</div>
<div id="authors-addresses">
<section id="appendix-E">
<h2 id="name-authors-addresses">
<a href="#name-authors-addresses" class="section-name selfRef">Authors' Addresses</a>
</h2>
<address class="vcard">
<div dir="auto" class="left"><span class="fn nameRole">Christian Amsüss (<span class="role">editor</span>)</span></div>
<div class="email">
<span>Email:</span>
<a href="mailto:christian@amsuess.com" class="email">christian@amsuess.com</a>
</div>
</address>
<address class="vcard">
<div dir="auto" class="left"><span class="fn nameRole">Zach Shelby</span></div>
<div dir="auto" class="left"><span class="org">Edge Impulse</span></div>
<div dir="auto" class="left"><span class="street-address">3031 Tisch Way</span></div>
<div dir="auto" class="left">
<span class="locality">San Jose</span>, <span class="postal-code">95128</span>
</div>
<div dir="auto" class="left"><span class="country-name">United States of America</span></div>
<div class="email">
<span>Email:</span>
<a href="mailto:zach@edgeimpulse.com" class="email">zach@edgeimpulse.com</a>
</div>
</address>
<address class="vcard">
<div dir="auto" class="left"><span class="fn nameRole">Michael Koster</span></div>
<div dir="auto" class="left"><span class="org">PassiveLogic</span></div>
<div dir="auto" class="left"><span class="street-address">524 H Street</span></div>
<div dir="auto" class="left">
<span class="locality">Antioch</span>, <span class="region">CA</span> <span class="postal-code">94509</span>
</div>
<div dir="auto" class="left"><span class="country-name">United States of America</span></div>
<div class="tel">
<span>Phone:</span>
<a href="tel:+1-707-502-5136" class="tel">+1-707-502-5136</a>
</div>
<div class="email">
<span>Email:</span>
<a href="mailto:michaeljohnkoster@gmail.com" class="email">michaeljohnkoster@gmail.com</a>
</div>
</address>
<address class="vcard">
<div dir="auto" class="left"><span class="fn nameRole">Carsten Bormann</span></div>
<div dir="auto" class="left"><span class="org">Universität Bremen TZI</span></div>
<div dir="auto" class="left"><span class="street-address">Postfach 330440</span></div>
<div dir="auto" class="left">
<span class="postal-code">D-28359</span> <span class="locality">Bremen</span>
</div>
<div dir="auto" class="left"><span class="country-name">Germany</span></div>
<div class="tel">
<span>Phone:</span>
<a href="tel:+49-421-218-63921" class="tel">+49-421-218-63921</a>
</div>
<div class="email">
<span>Email:</span>
<a href="mailto:cabo@tzi.org" class="email">cabo@tzi.org</a>
</div>
</address>
<address class="vcard">
<div dir="auto" class="left"><span class="fn nameRole">Peter van der Stok</span></div>
<div dir="auto" class="left"><span class="org">vanderstok consultancy</span></div>
<div class="email">
<span>Email:</span>
<a href="mailto:stokcons@bbhmail.nl" class="email">stokcons@bbhmail.nl</a>
</div>
</address>
</section>
</div>
<script>const toc = document.getElementById("toc");
toc.querySelector("h2").addEventListener("click", e => {
toc.classList.toggle("active");
});
toc.querySelector("nav").addEventListener("click", e => {
toc.classList.remove("active");
});
</script>
</body>
</html>
|