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
|
<pre>Internet Engineering Task Force (IETF) A. Bierman
Request for Comments: 7317 YumaWorks
Category: Standards Track M. Bjorklund
ISSN: 2070-1721 Tail-f Systems
August 2014
<span class="h1">A YANG Data Model for System Management</span>
Abstract
This document defines a YANG data model for the configuration and
identification of some common system properties within a device
containing a Network Configuration Protocol (NETCONF) server. This
document also includes data node definitions for system
identification, time-of-day management, user management, DNS resolver
configuration, and some protocol operations for system management.
Status of This Memo
This is an Internet Standards Track document.
This document is a product of the Internet Engineering Task Force
(IETF). It represents the consensus of the IETF community. It has
received public review and has been approved for publication by the
Internet Engineering Steering Group (IESG). Further information on
Internet Standards is available in <a href="./rfc5741#section-2">Section 2 of RFC 5741</a>.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
<a href="http://www.rfc-editor.org/info/rfc7317">http://www.rfc-editor.org/info/rfc7317</a>.
Copyright Notice
Copyright (c) 2014 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal
Provisions Relating to IETF Documents
(<a href="http://trustee.ietf.org/license-info">http://trustee.ietf.org/license-info</a>) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
<span class="grey">Bierman & Bjorklund Standards Track [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
Table of Contents
<a href="#section-1">1</a>. Introduction ....................................................<a href="#page-2">2</a>
<a href="#section-1.1">1.1</a>. Terminology ................................................<a href="#page-3">3</a>
<a href="#section-1.2">1.2</a>. Tree Diagrams ..............................................<a href="#page-3">3</a>
<a href="#section-2">2</a>. Objectives ......................................................<a href="#page-4">4</a>
<a href="#section-2.1">2.1</a>. System Identification ......................................<a href="#page-4">4</a>
<a href="#section-2.2">2.2</a>. System Time Management .....................................<a href="#page-4">4</a>
<a href="#section-2.3">2.3</a>. User Authentication ........................................<a href="#page-4">4</a>
<a href="#section-2.4">2.4</a>. DNS Resolver ...............................................<a href="#page-5">5</a>
<a href="#section-2.5">2.5</a>. System Control .............................................<a href="#page-5">5</a>
<a href="#section-3">3</a>. System Data Model ...............................................<a href="#page-5">5</a>
<a href="#section-3.1">3.1</a>. System Identification ......................................<a href="#page-5">5</a>
<a href="#section-3.2">3.2</a>. System Time Management .....................................<a href="#page-6">6</a>
<a href="#section-3.3">3.3</a>. DNS Resolver Model .........................................<a href="#page-7">7</a>
<a href="#section-3.4">3.4</a>. RADIUS Client Model ........................................<a href="#page-7">7</a>
<a href="#section-3.5">3.5</a>. User Authentication Model ..................................<a href="#page-8">8</a>
<a href="#section-3.5.1">3.5.1</a>. SSH Public Key Authentication .......................<a href="#page-8">8</a>
<a href="#section-3.5.2">3.5.2</a>. Local User Password Authentication ..................<a href="#page-9">9</a>
<a href="#section-3.5.3">3.5.3</a>. RADIUS Password Authentication ......................<a href="#page-9">9</a>
<a href="#section-3.6">3.6</a>. System Control .............................................<a href="#page-9">9</a>
<a href="#section-4">4</a>. Relationship to the SNMPv2-MIB .................................<a href="#page-10">10</a>
<a href="#section-5">5</a>. IANA Crypt Hash YANG Module ....................................<a href="#page-10">10</a>
<a href="#section-6">6</a>. System YANG Module .............................................<a href="#page-13">13</a>
<a href="#section-7">7</a>. IANA Considerations ............................................<a href="#page-31">31</a>
<a href="#section-8">8</a>. Security Considerations ........................................<a href="#page-31">31</a>
<a href="#section-9">9</a>. References .....................................................<a href="#page-33">33</a>
<a href="#section-9.1">9.1</a>. Normative References ......................................<a href="#page-33">33</a>
<a href="#section-9.2">9.2</a>. Informative References ....................................<a href="#page-35">35</a>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
This document defines a YANG [<a href="./rfc6020" title=""YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)"">RFC6020</a>] data model for the
configuration and identification of some common properties within a
device containing a Network Configuration Protocol (NETCONF) server.
Devices that are managed by NETCONF and perhaps other mechanisms have
common properties that need to be configured and monitored in a
standard way.
The "ietf-system" YANG module defined in this document provides the
following features:
o configuration and monitoring of system identification
o configuration and monitoring of system time-of-day
o configuration of user authentication
<span class="grey">Bierman & Bjorklund Standards Track [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
o configuration of local users
o configuration of the DNS resolver
o system control operations (shutdown, restart, setting time)
<span class="h3"><a class="selflink" id="section-1.1" href="#section-1.1">1.1</a>. Terminology</span>
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in
<a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, [<a href="./rfc2119" title=""Key words for use in RFCs to Indicate Requirement Levels"">RFC2119</a>].
The following terms are defined in [<a href="./rfc6241" title=""Network Configuration Protocol (NETCONF)"">RFC6241</a>] and are not redefined
here:
o client
o configuration data
o server
o state data
The following terms are defined in [<a href="./rfc6020" title=""YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)"">RFC6020</a>] and are not redefined
here:
o augment
o data model
<span class="h3"><a class="selflink" id="section-1.2" href="#section-1.2">1.2</a>. Tree Diagrams</span>
A simplified graphical representation of the data model is used in
this document. The meaning of the symbols in these diagrams is as
follows:
o Brackets "[" and "]" enclose list keys.
o Abbreviations before data node names: "rw" means configuration
(read-write), and "ro" means state data (read-only).
o Symbols after data node names: "?" means an optional node, "!"
means a presence container, and "*" denotes a list and leaf-list.
<span class="grey">Bierman & Bjorklund Standards Track [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
o Parentheses enclose choice and case nodes, and case nodes are also
marked with a colon (":").
o Ellipsis ("...") stands for contents of subtrees that are not
shown.
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Objectives</span>
<span class="h3"><a class="selflink" id="section-2.1" href="#section-2.1">2.1</a>. System Identification</span>
There are many common properties used to identify devices, operating
systems, software versions, etc. that need to be supported in the
system data module. These objects are defined as operational state
data, and the information returned by the server is intended to be
specific to the device vendor.
Some user-configurable administrative strings are also provided, such
as the system location and description.
<span class="h3"><a class="selflink" id="section-2.2" href="#section-2.2">2.2</a>. System Time Management</span>
Management of the date and time used by the system needs to be
supported. The use of one or more NTP servers to automatically set
the system date and time needs to be possible. Utilization of the
Time Zone Database [<a href="./rfc6557" title=""Procedures for Maintaining the Time Zone Database"">RFC6557</a>] also needs to be supported. It should
be possible to configure the system to use NTP.
<span class="h3"><a class="selflink" id="section-2.3" href="#section-2.3">2.3</a>. User Authentication</span>
The authentication mechanism needs to support password authentication
over RADIUS in order to support deployment scenarios with centralized
authentication servers. Additionally, for scenarios when no
centralized authentication server exists or for situations where the
centralized authentication server cannot be reached from the device,
local users need to be supported.
Since the mandatory transport protocol for NETCONF is Secure Shell
(SSH) [<a href="./rfc6242" title=""Using the NETCONF Protocol over Secure Shell (SSH)"">RFC6242</a>], the authentication model needs to support SSH's
"publickey" and "password" authentication methods [<a href="./rfc4252" title=""The Secure Shell (SSH) Authentication Protocol"">RFC4252</a>].
The model for authentication configuration should be flexible enough
to support authentication methods defined by other standards
documents or by vendors. It should be possible to configure the
system authentication properties.
<span class="grey">Bierman & Bjorklund Standards Track [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
<span class="h3"><a class="selflink" id="section-2.4" href="#section-2.4">2.4</a>. DNS Resolver</span>
The configuration of the DNS resolver within the system containing
the NETCONF server is required in order to control how domain names
are resolved.
<span class="h3"><a class="selflink" id="section-2.5" href="#section-2.5">2.5</a>. System Control</span>
A few operations are needed to support common tasks such as
restarting the device or setting the system date and time.
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. System Data Model</span>
<span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>. System Identification</span>
The data model for system identification has the following structure:
+--rw system
| +--rw contact? string
| +--rw hostname? inet:domain-name
| +--rw location? string
+--ro system-state
+--ro platform
+--ro os-name? string
+--ro os-release? string
+--ro os-version? string
+--ro machine? string
<span class="grey">Bierman & Bjorklund Standards Track [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
<span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a>. System Time Management</span>
The data model for system time management has the following
structure:
+--rw system
| +--rw clock
| | +--rw (timezone)?
| | +--:(timezone-name)
| | | +--rw timezone-name? timezone-name
| | +--:(timezone-utc-offset)
| | +--rw timezone-utc-offset? int16
| +--rw ntp!
| +--rw enabled? boolean
| +--rw server* [name]
| +--rw name string
| +--rw (transport)
| | +--:(udp)
| | +--rw udp
| | +--rw address inet:host
| | +--rw port? inet:port-number
| +--rw association-type? enumeration
| +--rw iburst? boolean
| +--rw prefer? boolean
+--ro system-state
+--ro clock
+--ro current-datetime? yang:date-and-time
+--ro boot-datetime? yang:date-and-time
New "case" statements can be added in future revisions of this data
model, or through augmentation by some other data model.
<span class="grey">Bierman & Bjorklund Standards Track [Page 6]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
<span class="h3"><a class="selflink" id="section-3.3" href="#section-3.3">3.3</a>. DNS Resolver Model</span>
The data model for configuration of the DNS resolver has the
following structure:
+--rw system
+--rw dns-resolver
+--rw search* inet:domain-name
+--rw server* [name]
| +--rw name string
| +--rw (transport)
| +--:(udp-and-tcp)
| +--udp-and-tcp
| +--rw address inet:ip-address
| +--rw port? inet:port-number
+--rw options
+--rw timeout? uint8
+--rw attempts? uint8
New "case" statements can be added in future revisions of this data
model, or through augmentation by some other data model.
<span class="h3"><a class="selflink" id="section-3.4" href="#section-3.4">3.4</a>. RADIUS Client Model</span>
The data model for configuration of the RADIUS client has the
following structure:
+--rw system
+--rw radius
+--rw server* [name]
| +--rw name string
| +--rw (transport)
| | +--:(udp)
| | +--rw udp
| | +--rw address inet:host
| | +--rw authentication-port? inet:port-number
| | +--rw shared-secret string
| +--rw authentication-type? identityref
+--rw options
+--rw timeout? uint8
+--rw attempts? uint8
New "case" statements can be added in future revisions of this data
model, or through augmentation by some other data model.
<span class="grey">Bierman & Bjorklund Standards Track [Page 7]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
<span class="h3"><a class="selflink" id="section-3.5" href="#section-3.5">3.5</a>. User Authentication Model</span>
This document defines three authentication methods for use with
NETCONF:
o publickey for local users over SSH
o password for local users over any secure transport
o password for RADIUS users over any secure transport
Additional methods can be defined by other standards documents or by
vendors.
This document defines two optional YANG features: "local-users" and
"radius-authentication", which the server advertises to indicate
support for configuring local users on the device and support for
using RADIUS for authentication, respectively.
The authentication parameters defined in this document are primarily
used to configure authentication of NETCONF users but MAY also be
used by other interfaces, e.g., a command line interface or a web-
based user interface.
The data model for user authentication has the following structure:
+--rw system
+--rw authentication
+--rw user-authentication-order* identityref
+--rw user* [name]
+--rw name string
+--rw password? ianach:crypt-hash
+--rw authorized-key* [name]
+--rw name string
+--rw algorithm string
+--rw key-data binary
<span class="h4"><a class="selflink" id="section-3.5.1" href="#section-3.5.1">3.5.1</a>. SSH Public Key Authentication</span>
If the NETCONF server advertises the "local-users" feature,
configuration of local users and their SSH public keys is supported
in the /system/authentication/user list.
Public key authentication is requested by the SSH client. If the
"local-users" feature is supported, then when a NETCONF client starts
an SSH session towards the server using the "publickey"
authentication "method name" [<a href="./rfc4252" title=""The Secure Shell (SSH) Authentication Protocol"">RFC4252</a>], the SSH server looks up the
<span class="grey">Bierman & Bjorklund Standards Track [Page 8]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
user name given in the SSH authentication request in the
/system/authentication/user list and verifies the key as described in
[<a href="./rfc4253" title=""The Secure Shell (SSH) Transport Layer Protocol"">RFC4253</a>].
<span class="h4"><a class="selflink" id="section-3.5.2" href="#section-3.5.2">3.5.2</a>. Local User Password Authentication</span>
If the NETCONF server advertises the "local-users" feature,
configuration of local users and their passwords is supported in the
/system/authentication/user list.
For NETCONF transport protocols that support password authentication,
the leaf-list "user-authentication-order" is used to control whether
or not local user password authentication should be used.
In SSH, password authentication is requested by the client. Other
NETCONF transport protocols MAY also support password authentication.
When local user password authentication is requested, the NETCONF
transport looks up the user name provided by the client in the
/system/authentication/user list and verifies the password.
<span class="h4"><a class="selflink" id="section-3.5.3" href="#section-3.5.3">3.5.3</a>. RADIUS Password Authentication</span>
If the NETCONF server advertises the "radius-authentication" feature,
the device supports user authentication using RADIUS.
For NETCONF transport protocols that support password authentication,
the leaf-list "user-authentication-order" is used to control whether
or not RADIUS password authentication should be used.
In SSH, password authentication is requested by the client. Other
NETCONF transport protocols MAY also support password authentication.
<span class="h3"><a class="selflink" id="section-3.6" href="#section-3.6">3.6</a>. System Control</span>
The following operations are defined:
set-current-datetime
system-restart
system-shutdown
Two protocol operations are included to restart or shut down the
system. The 'system-restart' operation can be used to restart the
entire system (not just the NETCONF server). The 'system-shutdown'
operation can be used to power off the entire system.
<span class="grey">Bierman & Bjorklund Standards Track [Page 9]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Relationship to the SNMPv2-MIB</span>
If a device implements the SNMPv2-MIB [<a href="./rfc3418" title=""Management Information Base (MIB) for the Simple Network Management Protocol (SNMP)"">RFC3418</a>], there are two
objects that MAY be mapped by the implementation. See the YANG
module definition in <a href="#section-6">Section 6</a> for details. The following table
lists the YANG data nodes with corresponding objects in the
SNMPv2-MIB.
+----------------+-------------------+
| YANG data node | SNMPv2-MIB object |
+----------------+-------------------+
| contact | sysContact |
| location | sysLocation |
+----------------+-------------------+
YANG Interface Configuration Data Nodes and
Related SNMPv2-MIB Objects
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. IANA Crypt Hash YANG Module</span>
This YANG module references [<a href="./rfc1321" title=""The MD5 Message-Digest Algorithm"">RFC1321</a>], [<a href="#ref-IEEE-1003.1-2008">IEEE-1003.1-2008</a>], and
[<a href="#ref-FIPS.180-4.2012">FIPS.180-4.2012</a>].
<CODE BEGINS> file "iana-crypt-hash@2014-08-06.yang"
module iana-crypt-hash {
namespace "urn:ietf:params:xml:ns:yang:iana-crypt-hash";
prefix ianach;
organization "IANA";
contact
" Internet Assigned Numbers Authority
Postal: ICANN
12025 Waterfront Drive, Suite 300
Los Angeles, CA 90094-2536
United States
Tel: +1 310 301 5800
E-Mail: iana@iana.org>";
description
"This YANG module defines a type for storing passwords
using a hash function and features to indicate which hash
functions are supported by an implementation.
The latest revision of this YANG module can be obtained from
the IANA web site.
<span class="grey">Bierman & Bjorklund Standards Track [Page 10]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
Requests for new values should be made to IANA via
email (iana@iana.org).
Copyright (c) 2014 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License
set forth in <a href="#section-4">Section 4</a>.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(<a href="http://trustee.ietf.org/license-info">http://trustee.ietf.org/license-info</a>).
The initial version of this YANG module is part of <a href="./rfc7317">RFC 7317</a>;
see the RFC itself for full legal notices.";
revision 2014-08-06 {
description
"Initial revision.";
reference
"<a href="./rfc7317">RFC 7317</a>: A YANG Data Model for System Management";
}
typedef crypt-hash {
type string {
pattern
'$0$.*'
+ '|$1$[a-zA-Z0-9./]{1,8}$[a-zA-Z0-9./]{22}'
+ '|$5$(rounds=\d+$)?[a-zA-Z0-9./]{1,16}$[a-zA-Z0-9./]{43}'
+ '|$6$(rounds=\d+$)?[a-zA-Z0-9./]{1,16}$[a-zA-Z0-9./]{86}';
}
description
"The crypt-hash type is used to store passwords using
a hash function. The algorithms for applying the hash
function and encoding the result are implemented in
various UNIX systems as the function crypt(3).
A value of this type matches one of the forms:
$0$<clear text password>
$<id>$<salt>$<password hash>
$<id>$<parameter>$<salt>$<password hash>
The '$0$' prefix signals that the value is clear text. When
such a value is received by the server, a hash value is
calculated, and the string '$<id>$<salt>$' or
$<id>$<parameter>$<salt>$ is prepended to the result. This
value is stored in the configuration data store.
<span class="grey">Bierman & Bjorklund Standards Track [Page 11]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
If a value starting with '$<id>$', where <id> is not '0', is
received, the server knows that the value already represents a
hashed value and stores it 'as is' in the data store.
When a server needs to verify a password given by a user, it
finds the stored password hash string for that user, extracts
the salt, and calculates the hash with the salt and given
password as input. If the calculated hash value is the same
as the stored value, the password given by the client is
accepted.
This type defines the following hash functions:
id | hash function | feature
---+---------------+-------------------
1 | MD5 | crypt-hash-md5
5 | SHA-256 | crypt-hash-sha-256
6 | SHA-512 | crypt-hash-sha-512
The server indicates support for the different hash functions
by advertising the corresponding feature.";
reference
"IEEE Std 1003.1-2008 - crypt() function
<a href="./rfc1321">RFC 1321</a>: The MD5 Message-Digest Algorithm
FIPS.180-4.2012: Secure Hash Standard (SHS)";
}
feature crypt-hash-md5 {
description
"Indicates that the device supports the MD5
hash function in 'crypt-hash' values.";
reference "<a href="./rfc1321">RFC 1321</a>: The MD5 Message-Digest Algorithm";
}
feature crypt-hash-sha-256 {
description
"Indicates that the device supports the SHA-256
hash function in 'crypt-hash' values.";
reference "FIPS.180-4.2012: Secure Hash Standard (SHS)";
}
<span class="grey">Bierman & Bjorklund Standards Track [Page 12]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
feature crypt-hash-sha-512 {
description
"Indicates that the device supports the SHA-512
hash function in 'crypt-hash' values.";
reference "FIPS.180-4.2012: Secure Hash Standard (SHS)";
}
}
<CODE ENDS>
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. System YANG Module</span>
This YANG module imports YANG extensions from [<a href="./rfc6536" title=""Network Configuration Protocol (NETCONF) Access Control Model"">RFC6536</a>] and imports
YANG types from [<a href="./rfc6991" title=""Common YANG Data Types"">RFC6991</a>]. It also references [<a href="./rfc1035" title=""Domain names - implementation and specification"">RFC1035</a>], [<a href="./rfc2865" title=""Remote Authentication Dial In User Service (RADIUS)"">RFC2865</a>],
[<a href="./rfc3418" title=""Management Information Base (MIB) for the Simple Network Management Protocol (SNMP)"">RFC3418</a>], [<a href="./rfc5607" title=""Remote Authentication Dial-In User Service (RADIUS) Authorization for Network Access Server (NAS) Management"">RFC5607</a>], [<a href="./rfc5966" title=""DNS Transport over TCP - Implementation Requirements"">RFC5966</a>], and [<a href="./rfc6557" title=""Procedures for Maintaining the Time Zone Database"">RFC6557</a>].
<CODE BEGINS> file "ietf-system@2014-08-06.yang"
module ietf-system {
namespace "urn:ietf:params:xml:ns:yang:ietf-system";
prefix "sys";
import ietf-yang-types {
prefix yang;
}
import ietf-inet-types {
prefix inet;
}
import ietf-netconf-acm {
prefix nacm;
}
import iana-crypt-hash {
prefix ianach;
}
organization
"IETF NETMOD (NETCONF Data Modeling Language) Working Group";
<span class="grey">Bierman & Bjorklund Standards Track [Page 13]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
contact
"WG Web: <<a href="http://tools.ietf.org/wg/netmod/">http://tools.ietf.org/wg/netmod/</a>>
WG List: <mailto:netmod@ietf.org>
WG Chair: Thomas Nadeau
<mailto:tnadeau@lucidvision.com>
WG Chair: Juergen Schoenwaelder
<mailto:j.schoenwaelder@jacobs-university.de>
Editor: Andy Bierman
<mailto:andy@yumaworks.com>
Editor: Martin Bjorklund
<mailto:mbj@tail-f.com>";
description
"This module contains a collection of YANG definitions for the
configuration and identification of some common system
properties within a device containing a NETCONF server. This
includes data node definitions for system identification,
time-of-day management, user management, DNS resolver
configuration, and some protocol operations for system
management.
Copyright (c) 2014 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License
set forth in <a href="#section-4">Section 4</a>.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(<a href="http://trustee.ietf.org/license-info">http://trustee.ietf.org/license-info</a>).
This version of this YANG module is part of <a href="./rfc7317">RFC 7317</a>; see
the RFC itself for full legal notices.";
revision 2014-08-06 {
description
"Initial revision.";
reference
"<a href="./rfc7317">RFC 7317</a>: A YANG Data Model for System Management";
}
<span class="grey">Bierman & Bjorklund Standards Track [Page 14]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
/*
* Typedefs
*/
typedef timezone-name {
type string;
description
"A time zone name as used by the Time Zone Database,
sometimes referred to as the 'Olson Database'.
The exact set of valid values is an implementation-specific
matter. Client discovery of the exact set of time zone names
for a particular server is out of scope.";
reference
"<a href="./rfc6557">RFC 6557</a>: Procedures for Maintaining the Time Zone Database";
}
/*
* Features
*/
feature radius {
description
"Indicates that the device can be configured as a RADIUS
client.";
reference
"<a href="./rfc2865">RFC 2865</a>: Remote Authentication Dial In User Service (RADIUS)";
}
feature authentication {
description
"Indicates that the device supports configuration of
user authentication.";
}
feature local-users {
if-feature authentication;
description
"Indicates that the device supports configuration of
local user authentication.";
}
<span class="grey">Bierman & Bjorklund Standards Track [Page 15]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
feature radius-authentication {
if-feature radius;
if-feature authentication;
description
"Indicates that the device supports configuration of user
authentication over RADIUS.";
reference
"<a href="./rfc2865">RFC 2865</a>: Remote Authentication Dial In User Service (RADIUS)
<a href="./rfc5607">RFC 5607</a>: Remote Authentication Dial-In User Service (RADIUS)
Authorization for Network Access Server (NAS)
Management";
}
feature ntp {
description
"Indicates that the device can be configured to use one or
more NTP servers to set the system date and time.";
}
feature ntp-udp-port {
if-feature ntp;
description
"Indicates that the device supports the configuration of
the UDP port for NTP servers.
This is a 'feature', since many implementations do not support
any port other than the default port.";
}
feature timezone-name {
description
"Indicates that the local time zone on the device
can be configured to use the TZ database
to set the time zone and manage daylight saving time.";
reference
"<a href="./rfc6557">RFC 6557</a>: Procedures for Maintaining the Time Zone Database";
}
feature dns-udp-tcp-port {
description
"Indicates that the device supports the configuration of
the UDP and TCP port for DNS servers.
This is a 'feature', since many implementations do not support
any port other than the default port.";
}
<span class="grey">Bierman & Bjorklund Standards Track [Page 16]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
/*
* Identities
*/
identity authentication-method {
description
"Base identity for user authentication methods.";
}
identity radius {
base authentication-method;
description
"Indicates user authentication using RADIUS.";
reference
"<a href="./rfc2865">RFC 2865</a>: Remote Authentication Dial In User Service (RADIUS)
<a href="./rfc5607">RFC 5607</a>: Remote Authentication Dial-In User Service (RADIUS)
Authorization for Network Access Server (NAS)
Management";
}
identity local-users {
base authentication-method;
description
"Indicates password-based authentication of locally
configured users.";
}
identity radius-authentication-type {
description
"Base identity for RADIUS authentication types.";
}
identity radius-pap {
base radius-authentication-type;
description
"The device requests Password Authentication Protocol (PAP)
authentication from the RADIUS server.";
reference
"<a href="./rfc2865">RFC 2865</a>: Remote Authentication Dial In User Service (RADIUS)";
}
<span class="grey">Bierman & Bjorklund Standards Track [Page 17]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
identity radius-chap {
base radius-authentication-type;
description
"The device requests Challenge Handshake Authentication
Protocol (CHAP) authentication from the RADIUS server.";
reference
"<a href="./rfc2865">RFC 2865</a>: Remote Authentication Dial In User Service (RADIUS)";
}
/*
* Configuration data nodes
*/
container system {
description
"System group configuration.";
leaf contact {
type string;
description
"The administrator contact information for the system.
A server implementation MAY map this leaf to the sysContact
MIB object. Such an implementation needs to use some
mechanism to handle the differences in size and characters
allowed between this leaf and sysContact. The definition of
such a mechanism is outside the scope of this document.";
reference
"<a href="./rfc3418">RFC 3418</a>: Management Information Base (MIB) for the
Simple Network Management Protocol (SNMP)
SNMPv2-MIB.sysContact";
}
leaf hostname {
type inet:domain-name;
description
"The name of the host. This name can be a single domain
label or the fully qualified domain name of the host.";
}
leaf location {
type string;
description
"The system location.
A server implementation MAY map this leaf to the sysLocation
MIB object. Such an implementation needs to use some
mechanism to handle the differences in size and characters
allowed between this leaf and sysLocation. The definition
of such a mechanism is outside the scope of this document.";
<span class="grey">Bierman & Bjorklund Standards Track [Page 18]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
reference
"<a href="./rfc3418">RFC 3418</a>: Management Information Base (MIB) for the
Simple Network Management Protocol (SNMP)
SNMPv2-MIB.sysLocation";
}
container clock {
description
"Configuration of the system date and time properties.";
choice timezone {
description
"The system time zone information.";
case timezone-name {
if-feature timezone-name;
leaf timezone-name {
type timezone-name;
description
"The TZ database name to use for the system, such
as 'Europe/Stockholm'.";
}
}
case timezone-utc-offset {
leaf timezone-utc-offset {
type int16 {
range "-1500 .. 1500";
}
units "minutes";
description
"The number of minutes to add to UTC time to
identify the time zone for this system. For example,
'UTC - 8:00 hours' would be represented as '-480'.
Note that automatic daylight saving time adjustment
is not provided if this object is used.";
}
}
}
}
container ntp {
if-feature ntp;
presence
"Enables the NTP client unless the 'enabled' leaf
(which defaults to 'true') is set to 'false'";
description
"Configuration of the NTP client.";
<span class="grey">Bierman & Bjorklund Standards Track [Page 19]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
leaf enabled {
type boolean;
default true;
description
"Indicates that the system should attempt to
synchronize the system clock with an NTP server
from the 'ntp/server' list.";
}
list server {
key name;
description
"List of NTP servers to use for system clock
synchronization. If '/system/ntp/enabled'
is 'true', then the system will attempt to
contact and utilize the specified NTP servers.";
leaf name {
type string;
description
"An arbitrary name for the NTP server.";
}
choice transport {
mandatory true;
description
"The transport-protocol-specific parameters for this
server.";
case udp {
container udp {
description
"Contains UDP-specific configuration parameters
for NTP.";
leaf address {
type inet:host;
mandatory true;
description
"The address of the NTP server.";
}
leaf port {
if-feature ntp-udp-port;
type inet:port-number;
default 123;
description
"The port number of the NTP server.";
}
}
}
}
<span class="grey">Bierman & Bjorklund Standards Track [Page 20]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
leaf association-type {
type enumeration {
enum server {
description
"Use client association mode. This device
will not provide synchronization to the
configured NTP server.";
}
enum peer {
description
"Use symmetric active association mode.
This device may provide synchronization
to the configured NTP server.";
}
enum pool {
description
"Use client association mode with one or
more of the NTP servers found by DNS
resolution of the domain name given by
the 'address' leaf. This device will not
provide synchronization to the servers.";
}
}
default server;
description
"The desired association type for this NTP server.";
}
leaf iburst {
type boolean;
default false;
description
"Indicates whether this server should enable burst
synchronization or not.";
}
leaf prefer {
type boolean;
default false;
description
"Indicates whether this server should be preferred
or not.";
}
}
}
container dns-resolver {
description
"Configuration of the DNS resolver.";
<span class="grey">Bierman & Bjorklund Standards Track [Page 21]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
leaf-list search {
type inet:domain-name;
ordered-by user;
description
"An ordered list of domains to search when resolving
a host name.";
}
list server {
key name;
ordered-by user;
description
"List of the DNS servers that the resolver should query.
When the resolver is invoked by a calling application, it
sends the query to the first name server in this list. If
no response has been received within 'timeout' seconds,
the resolver continues with the next server in the list.
If no response is received from any server, the resolver
continues with the first server again. When the resolver
has traversed the list 'attempts' times without receiving
any response, it gives up and returns an error to the
calling application.
Implementations MAY limit the number of entries in this
list.";
leaf name {
type string;
description
"An arbitrary name for the DNS server.";
}
choice transport {
mandatory true;
description
"The transport-protocol-specific parameters for this
server.";
case udp-and-tcp {
container udp-and-tcp {
description
"Contains UDP- and TCP-specific configuration
parameters for DNS.";
reference
"<a href="./rfc1035">RFC 1035</a>: Domain Names - Implementation and
Specification
<a href="./rfc5966">RFC 5966</a>: DNS Transport over TCP - Implementation
Requirements";
<span class="grey">Bierman & Bjorklund Standards Track [Page 22]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
leaf address {
type inet:ip-address;
mandatory true;
description
"The address of the DNS server.";
}
leaf port {
if-feature dns-udp-tcp-port;
type inet:port-number;
default 53;
description
"The UDP and TCP port number of the DNS server.";
}
}
}
}
}
container options {
description
"Resolver options. The set of available options has been
limited to those that are generally available across
different resolver implementations and generally useful.";
leaf timeout {
type uint8 {
range "1..max";
}
units "seconds";
default "5";
description
"The amount of time the resolver will wait for a
response from each remote name server before
retrying the query via a different name server.";
}
leaf attempts {
type uint8 {
range "1..max";
}
default "2";
description
"The number of times the resolver will send a query to
all of its name servers before giving up and returning
an error to the calling application.";
}
}
}
<span class="grey">Bierman & Bjorklund Standards Track [Page 23]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
container radius {
if-feature radius;
description
"Configuration of the RADIUS client.";
list server {
key name;
ordered-by user;
description
"List of RADIUS servers used by the device.
When the RADIUS client is invoked by a calling
application, it sends the query to the first server in
this list. If no response has been received within
'timeout' seconds, the client continues with the next
server in the list. If no response is received from any
server, the client continues with the first server again.
When the client has traversed the list 'attempts' times
without receiving any response, it gives up and returns an
error to the calling application.";
leaf name {
type string;
description
"An arbitrary name for the RADIUS server.";
}
choice transport {
mandatory true;
description
"The transport-protocol-specific parameters for this
server.";
case udp {
container udp {
description
"Contains UDP-specific configuration parameters
for RADIUS.";
leaf address {
type inet:host;
mandatory true;
description
"The address of the RADIUS server.";
}
<span class="grey">Bierman & Bjorklund Standards Track [Page 24]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
leaf authentication-port {
type inet:port-number;
default "1812";
description
"The port number of the RADIUS server.";
}
leaf shared-secret {
type string;
mandatory true;
nacm:default-deny-all;
description
"The shared secret, which is known to both the
RADIUS client and server.";
reference
"<a href="./rfc2865">RFC 2865</a>: Remote Authentication Dial In User
Service (RADIUS)";
}
}
}
}
leaf authentication-type {
type identityref {
base radius-authentication-type;
}
default radius-pap;
description
"The authentication type requested from the RADIUS
server.";
}
}
container options {
description
"RADIUS client options.";
leaf timeout {
type uint8 {
range "1..max";
}
units "seconds";
default "5";
description
"The number of seconds the device will wait for a
response from each RADIUS server before trying with a
different server.";
}
<span class="grey">Bierman & Bjorklund Standards Track [Page 25]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
leaf attempts {
type uint8 {
range "1..max";
}
default "2";
description
"The number of times the device will send a query to
all of its RADIUS servers before giving up.";
}
}
}
container authentication {
nacm:default-deny-write;
if-feature authentication;
description
"The authentication configuration subtree.";
leaf-list user-authentication-order {
type identityref {
base authentication-method;
}
must '(. != "sys:radius" or ../../radius/server)' {
error-message
"When 'radius' is used, a RADIUS server"
+ " must be configured.";
description
"When 'radius' is used as an authentication method,
a RADIUS server must be configured.";
}
ordered-by user;
description
"When the device authenticates a user with a password,
it tries the authentication methods in this leaf-list in
order. If authentication with one method fails, the next
method is used. If no method succeeds, the user is
denied access.
An empty user-authentication-order leaf-list still allows
authentication of users using mechanisms that do not
involve a password.
If the 'radius-authentication' feature is advertised by
the NETCONF server, the 'radius' identity can be added to
this list.
<span class="grey">Bierman & Bjorklund Standards Track [Page 26]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
If the 'local-users' feature is advertised by the
NETCONF server, the 'local-users' identity can be
added to this list.";
}
list user {
if-feature local-users;
key name;
description
"The list of local users configured on this device.";
leaf name {
type string;
description
"The user name string identifying this entry.";
}
leaf password {
type ianach:crypt-hash;
description
"The password for this entry.";
}
list authorized-key {
key name;
description
"A list of public SSH keys for this user. These keys
are allowed for SSH authentication, as described in
<a href="./rfc4253">RFC 4253</a>.";
reference
"<a href="./rfc4253">RFC 4253</a>: The Secure Shell (SSH) Transport Layer
Protocol";
leaf name {
type string;
description
"An arbitrary name for the SSH key.";
}
<span class="grey">Bierman & Bjorklund Standards Track [Page 27]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
leaf algorithm {
type string;
mandatory true;
description
"The public key algorithm name for this SSH key.
Valid values are the values in the IANA 'Secure Shell
(SSH) Protocol Parameters' registry, Public Key
Algorithm Names.";
reference
"IANA 'Secure Shell (SSH) Protocol Parameters'
registry, Public Key Algorithm Names";
}
leaf key-data {
type binary;
mandatory true;
description
"The binary public key data for this SSH key, as
specified by <a href="./rfc4253#section-6.6">RFC 4253, Section 6.6</a>, i.e.:
string certificate or public key format
identifier
byte[n] key/certificate data.";
reference
"<a href="./rfc4253">RFC 4253</a>: The Secure Shell (SSH) Transport Layer
Protocol";
}
}
}
}
}
/*
* Operational state data nodes
*/
container system-state {
config false;
description
"System group operational state.";
container platform {
description
"Contains vendor-specific information for
identifying the system platform and operating system.";
reference
"IEEE Std 1003.1-2008 - sys/utsname.h";
<span class="grey">Bierman & Bjorklund Standards Track [Page 28]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
leaf os-name {
type string;
description
"The name of the operating system in use -
for example, 'Linux'.";
reference
"IEEE Std 1003.1-2008 - utsname.sysname";
}
leaf os-release {
type string;
description
"The current release level of the operating
system in use. This string MAY indicate
the OS source code revision.";
reference
"IEEE Std 1003.1-2008 - utsname.release";
}
leaf os-version {
type string;
description
"The current version level of the operating
system in use. This string MAY indicate
the specific OS build date and target variant
information.";
reference
"IEEE Std 1003.1-2008 - utsname.version";
}
leaf machine {
type string;
description
"A vendor-specific identifier string representing
the hardware in use.";
reference
"IEEE Std 1003.1-2008 - utsname.machine";
}
}
container clock {
description
"Monitoring of the system date and time properties.";
leaf current-datetime {
type yang:date-and-time;
description
"The current system date and time.";
}
<span class="grey">Bierman & Bjorklund Standards Track [Page 29]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
leaf boot-datetime {
type yang:date-and-time;
description
"The system date and time when the system last restarted.";
}
}
}
rpc set-current-datetime {
nacm:default-deny-all;
description
"Set the /system-state/clock/current-datetime leaf
to the specified value.
If the system is using NTP (i.e., /system/ntp/enabled
is set to 'true'), then this operation will fail with
error-tag 'operation-failed' and error-app-tag value of
'ntp-active'.";
input {
leaf current-datetime {
type yang:date-and-time;
mandatory true;
description
"The current system date and time.";
}
}
}
rpc system-restart {
nacm:default-deny-all;
description
"Request that the entire system be restarted immediately.
A server SHOULD send an rpc reply to the client before
restarting the system.";
}
rpc system-shutdown {
nacm:default-deny-all;
description
"Request that the entire system be shut down immediately.
A server SHOULD send an rpc reply to the client before
shutting down the system.";
}
}
<CODE ENDS>
<span class="grey">Bierman & Bjorklund Standards Track [Page 30]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-31" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. IANA Considerations</span>
IANA has created an IANA-maintained YANG module called
"iana-crypt-hash", based on the contents of <a href="#section-5">Section 5</a>, which will
allow for new hash algorithms to be added to the type "crypt-hash".
The registration procedure will be Expert Review, as defined by
[<a href="./rfc5226" title="">RFC5226</a>].
This document registers two URIs in the "IETF XML Registry"
[<a href="./rfc3688" title=""The IETF XML Registry"">RFC3688</a>]. Following the format in <a href="./rfc3688">RFC 3688</a>, the following
registrations have been made.
URI: urn:ietf:params:xml:ns:yang:iana-crypt-hash
Registrant Contact: The IESG.
XML: N/A; the requested URI is an XML namespace.
URI: urn:ietf:params:xml:ns:yang:ietf-system
Registrant Contact: The IESG.
XML: N/A; the requested URI is an XML namespace.
This document registers two YANG modules in the "YANG Module Names"
registry [<a href="./rfc6020" title=""YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)"">RFC6020</a>].
name: iana-crypt-hash
namespace: urn:ietf:params:xml:ns:yang:iana-crypt-hash
prefix: ianach
reference: <a href="./rfc7317">RFC 7317</a>
name: ietf-system
namespace: urn:ietf:params:xml:ns:yang:ietf-system
prefix: sys
reference: <a href="./rfc7317">RFC 7317</a>
<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. Security Considerations</span>
The YANG modules defined in this memo are designed to be accessed via
the NETCONF protocol [<a href="./rfc6241" title=""Network Configuration Protocol (NETCONF)"">RFC6241</a>]. The lowest NETCONF layer is the
secure transport layer and the mandatory to implement secure
transport is SSH [<a href="./rfc6242" title=""Using the NETCONF Protocol over Secure Shell (SSH)"">RFC6242</a>]. The NETCONF access control model
[<a href="./rfc6536" title=""Network Configuration Protocol (NETCONF) Access Control Model"">RFC6536</a>] provides the means to restrict access for particular
NETCONF users to a pre-configured subset of all available NETCONF
protocol operations and content.
There are a number of data nodes defined in the "ietf-system" YANG
module which are writable/creatable/deletable (i.e., config true,
which is the default). These data nodes may be considered sensitive
or vulnerable in some network environments. Write operations (e.g.,
<span class="grey">Bierman & Bjorklund Standards Track [Page 31]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-32" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
edit-config) to these data nodes without proper protection can have a
negative effect on network operations. These are the subtrees and
data nodes and their sensitivity/vulnerability:
o /system/clock/timezone: This choice contains the objects used to
control the time zone used by the device.
o /system/ntp: This container contains the objects used to control
the Network Time Protocol servers used by the device.
o /system/dns-resolver: This container contains the objects used to
control the Domain Name System servers used by the device.
o /system/radius: This container contains the objects used to
control the Remote Authentication Dial-In User Service servers
used by the device.
o /system/authentication/user-authentication-order: This leaf
controls how user login attempts are authenticated by the device.
o /system/authentication/user: This list contains the local users
enabled on the system.
Some of the readable data nodes in the "ietf-system" YANG module may
be considered sensitive or vulnerable in some network environments.
It is thus important to control read access (e.g., via get,
get-config or notification) to these data nodes. These are the
subtrees and data nodes and their sensitivity/vulnerability:
o /system/platform: This container has objects that may help
identify the specific NETCONF server and/or operating system
implementation used on the device.
o /system/authentication/user: This list has objects that may help
identify the specific user names and password information in use
on the device.
Some of the RPC operations in the "ietf-system" YANG module may be
considered sensitive or vulnerable in some network environments. It
is thus important to control access to these operations. These are
the operations and their sensitivity/vulnerability:
o set-current-datetime: Changes the current date and time on the
device.
o system-restart: Reboots the device.
o system-shutdown: Shuts down the device.
<span class="grey">Bierman & Bjorklund Standards Track [Page 32]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-33" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
Since this document describes the use of RADIUS for purposes of
authentication, it is vulnerable to all of the threats that are
present in other RADIUS applications. For a discussion of such
threats, see [<a href="./rfc2865" title=""Remote Authentication Dial In User Service (RADIUS)"">RFC2865</a>] and [<a href="./rfc3162" title=""RADIUS and IPv6"">RFC3162</a>], and <a href="./rfc3579#section-4">Section 4 of [RFC3579]</a>.
This document provides configuration parameters for SSH's "publickey"
and "password" authentication mechanisms. <a href="./rfc4251#section-9.4">Section 9.4 of [RFC4251]</a>
and <a href="./rfc4252#section-11">Section 11 of [RFC4252]</a> discuss security considerations for these
mechanisms.
The "iana-crypt-hash" YANG module defines a type "crypt-hash" that
can be used to store MD5 hashes. [<a href="./rfc6151" title=""Updated Security Considerations for the MD5 Message-Digest and the HMAC-MD5 Algorithms"">RFC6151</a>] discusses security
considerations for MD5. The usage of MD5 is NOT RECOMMENDED.
<span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. References</span>
<span class="h3"><a class="selflink" id="section-9.1" href="#section-9.1">9.1</a>. Normative References</span>
[<a id="ref-FIPS.180-4.2012">FIPS.180-4.2012</a>]
National Institute of Standards and Technology, "Secure
Hash Standard (SHS)", FIPS PUB 180-4, March 2012,
<<a href="http://csrc.nist.gov/publications/fips/fips180-4/fips-180-4.pdf">http://csrc.nist.gov/publications/fips/fips180-4/</a>
<a href="http://csrc.nist.gov/publications/fips/fips180-4/fips-180-4.pdf">fips-180-4.pdf</a>>.
[<a id="ref-IEEE-1003.1-2008">IEEE-1003.1-2008</a>]
Institute of Electrical and Electronics Engineers,
"POSIX.1-2008", IEEE Standard 1003.1, March 2008.
[<a id="ref-RFC1035">RFC1035</a>] Mockapetris, P., "Domain names - implementation and
specification", STD 13, <a href="./rfc1035">RFC 1035</a>, November 1987.
[<a id="ref-RFC1321">RFC1321</a>] Rivest, R., "The MD5 Message-Digest Algorithm", <a href="./rfc1321">RFC 1321</a>,
April 1992.
[<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>, March 1997.
[<a id="ref-RFC2865">RFC2865</a>] Rigney, C., Willens, S., Rubens, A., and W. Simpson,
"Remote Authentication Dial In User Service (RADIUS)",
<a href="./rfc2865">RFC 2865</a>, June 2000.
[<a id="ref-RFC3162">RFC3162</a>] Aboba, B., Zorn, G., and D. Mitton, "RADIUS and IPv6",
<a href="./rfc3162">RFC 3162</a>, August 2001.
[<a id="ref-RFC3418">RFC3418</a>] Presuhn, R., "Management Information Base (MIB) for the
Simple Network Management Protocol (SNMP)", STD 62,
<a href="./rfc3418">RFC 3418</a>, December 2002.
<span class="grey">Bierman & Bjorklund Standards Track [Page 33]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-34" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
[<a id="ref-RFC4251">RFC4251</a>] Ylonen, T. and C. Lonvick, "The Secure Shell (SSH)
Protocol Architecture", <a href="./rfc4251">RFC 4251</a>, January 2006.
[<a id="ref-RFC4252">RFC4252</a>] Ylonen, T. and C. Lonvick, "The Secure Shell (SSH)
Authentication Protocol", <a href="./rfc4252">RFC 4252</a>, January 2006.
[<a id="ref-RFC4253">RFC4253</a>] Ylonen, T. and C. Lonvick, "The Secure Shell (SSH)
Transport Layer Protocol", <a href="./rfc4253">RFC 4253</a>, January 2006.
[<a id="ref-RFC5226">RFC5226</a>] Narten, T. and H. Alvestrand, "Guidelines for Writing an
IANA Considerations Section in RFCs", <a href="https://www.rfc-editor.org/bcp/bcp26">BCP 26</a>, <a href="./rfc5226">RFC 5226</a>,
May 2008.
[<a id="ref-RFC5607">RFC5607</a>] Nelson, D. and G. Weber, "Remote Authentication Dial-In
User Service (RADIUS) Authorization for Network Access
Server (NAS) Management", <a href="./rfc5607">RFC 5607</a>, July 2009.
[<a id="ref-RFC5966">RFC5966</a>] Bellis, R., "DNS Transport over TCP - Implementation
Requirements", <a href="./rfc5966">RFC 5966</a>, August 2010.
[<a id="ref-RFC6020">RFC6020</a>] Bjorklund, M., "YANG - A Data Modeling Language for the
Network Configuration Protocol (NETCONF)", <a href="./rfc6020">RFC 6020</a>,
October 2010.
[<a id="ref-RFC6151">RFC6151</a>] Turner, S. and L. Chen, "Updated Security Considerations
for the MD5 Message-Digest and the HMAC-MD5 Algorithms",
<a href="./rfc6151">RFC 6151</a>, March 2011.
[<a id="ref-RFC6241">RFC6241</a>] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", <a href="./rfc6241">RFC 6241</a>, June 2011.
[<a id="ref-RFC6242">RFC6242</a>] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", <a href="./rfc6242">RFC 6242</a>, June 2011.
[<a id="ref-RFC6536">RFC6536</a>] Bierman, A. and M. Bjorklund, "Network Configuration
Protocol (NETCONF) Access Control Model", <a href="./rfc6536">RFC 6536</a>,
March 2012.
[<a id="ref-RFC6991">RFC6991</a>] Schoenwaelder, J., "Common YANG Data Types", <a href="./rfc6991">RFC 6991</a>,
July 2013.
<span class="grey">Bierman & Bjorklund Standards Track [Page 34]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-35" ></span>
<span class="grey"><a href="./rfc7317">RFC 7317</a> YANG System Management August 2014</span>
<span class="h3"><a class="selflink" id="section-9.2" href="#section-9.2">9.2</a>. Informative References</span>
[<a id="ref-RFC3579">RFC3579</a>] Aboba, B. and P. Calhoun, "RADIUS (Remote Authentication
Dial In User Service) Support For Extensible
Authentication Protocol (EAP)", <a href="./rfc3579">RFC 3579</a>, September 2003.
[<a id="ref-RFC3688">RFC3688</a>] Mealling, M., "The IETF XML Registry", <a href="https://www.rfc-editor.org/bcp/bcp81">BCP 81</a>, <a href="./rfc3688">RFC 3688</a>,
January 2004.
[<a id="ref-RFC6557">RFC6557</a>] Lear, E. and P. Eggert, "Procedures for Maintaining the
Time Zone Database", <a href="https://www.rfc-editor.org/bcp/bcp175">BCP 175</a>, <a href="./rfc6557">RFC 6557</a>, February 2012.
Authors' Addresses
Andy Bierman
YumaWorks
EMail: andy@yumaworks.com
Martin Bjorklund
Tail-f Systems
EMail: mbj@tail-f.com
Bierman & Bjorklund Standards Track [Page 35]
</pre>
|