idnits 2.17.1 draft-birkholz-sacm-yang-content-01.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- == The page length should not exceed 58 lines per page, but there was 1 longer page, the longest (page 1) being 59 lines Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** There are 76 instances of too long lines in the document, the longest one being 66 characters in excess of 72. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (January 18, 2018) is 2284 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Outdated reference: A later version (-11) exists of draft-ietf-mile-xmpp-grid-04 == Outdated reference: A later version (-08) exists of draft-ietf-netconf-notification-messages-02 == Outdated reference: A later version (-26) exists of draft-ietf-netconf-subscribed-notifications-08 == Outdated reference: A later version (-25) exists of draft-ietf-netconf-yang-push-12 Summary: 1 error (**), 0 flaws (~~), 6 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 SACM Working Group H. Birkholz 3 Internet-Draft Fraunhofer SIT 4 Intended status: Standards Track N. Cam-Winget 5 Expires: July 22, 2018 Cisco Systems 6 January 18, 2018 8 YANG subscribed notifications via SACM Statements 9 draft-birkholz-sacm-yang-content-01 11 Abstract 13 This document summarizes a subset of the emerging generic SACM Data 14 Model for inter-component distribution of SACM Content in and between 15 SACM Domains. The subset defined in this document is covering every 16 information element that can be acquired using YANG based protocols, 17 i.e. NETCONF, RESTCONF, COMI or derived mechanisms that transfer YANG 18 modeled data, such as MUD. As subscriptions to data origins in a 19 SACM domain are one of the architectural corner-stones of the SACM 20 architecture, this document recommends the use of YANG Push, YANG 21 subscribed Notifications and corresponding Notification Headers and 22 Bundles. Analogously, a mapping of Notification Header content to 23 SACM Metadata is provided in this document. 25 Status of This Memo 27 This Internet-Draft is submitted in full conformance with the 28 provisions of BCP 78 and BCP 79. 30 Internet-Drafts are working documents of the Internet Engineering 31 Task Force (IETF). Note that other groups may also distribute 32 working documents as Internet-Drafts. The list of current Internet- 33 Drafts is at https://datatracker.ietf.org/drafts/current/. 35 Internet-Drafts are draft documents valid for a maximum of six months 36 and may be updated, replaced, or obsoleted by other documents at any 37 time. It is inappropriate to use Internet-Drafts as reference 38 material or to cite them other than as "work in progress." 40 This Internet-Draft will expire on July 22, 2018. 42 Copyright Notice 44 Copyright (c) 2018 IETF Trust and the persons identified as the 45 document authors. All rights reserved. 47 This document is subject to BCP 78 and the IETF Trust's Legal 48 Provisions Relating to IETF Documents 49 (https://trustee.ietf.org/license-info) in effect on the date of 50 publication of this document. Please review these documents 51 carefully, as they describe your rights and restrictions with 52 respect to this document. 54 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 56 (https://trustee.ietf.org/license-info) in effect on the date of 57 publication of this document. Please review these documents 58 carefully, as they describe your rights and restrictions with respect 59 to this document. Code Components extracted from this document must 60 include Simplified BSD License text as described in Section 4.e of 61 the Trust Legal Provisions and are provided without warranty as 62 described in the Simplified BSD License. 64 Table of Contents 66 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 67 2. Requirements notation . . . . . . . . . . . . . . . . . . . . 3 68 3. Brokering of YANG Push Telemetry via SACM Statements . . . . 3 69 4. Encapsulation of YANG notifications in SACM content-elements 4 70 4.1. Enumeration definition for content-type . . . . . . . . . 4 71 4.2. Element definition for content-metadata . . . . . . . . . 5 72 4.3. Definition of the yang-output-metadata element included 73 in content-metadata . . . . . . . . . . . . . . . . . . . 5 74 5. Mapping of YANG Bundled Notifications to SACM Metadata . . . 7 75 6. SACM Component Composition . . . . . . . . . . . . . . . . . 8 76 7. IANA considerations . . . . . . . . . . . . . . . . . . . . . 8 77 8. Security Considerations . . . . . . . . . . . . . . . . . . . 8 78 9. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 8 79 10. Change Log . . . . . . . . . . . . . . . . . . . . . . . . . 8 80 11. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 9 81 12. Normative References . . . . . . . . . . . . . . . . . . . . 9 82 Appendix A. Minimal SACM Statement Definition for YANG Output . 9 83 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 29 85 1. Introduction 87 This document defines an XML encoding of SACM Statements that contain 88 SACM Content composed of YANG modeled data (i.e. NETCONF messages). 89 Correspondingly, this documents provides a standardized mapping to 90 derive SACM Metadata from YANG Subscribed Notifications 91 [I-D.ietf-netconf-subscribed-notifications] using Notification 92 Message Headers and Bundles [I-D.ietf-netconf-notification-messages] 93 content. 95 Every message defined in the generic SACM Data Model is a SACM 96 Statement. The SACM Statement structure is provided by the SACM 97 Information Model. In consequence, a SACM Statement is an 98 Information Element not acquired by, but created by SACM Components 99 for inter-component distribution of SACM Content (Information 100 Elements on the Data Plane that represent information about Target 101 Endpoints (TE) or Guidance. Examples include: software identifiers, 102 assessment guidance/results, ECA Policy rules, or VDD). 104 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 106 YANG modules are a powerful established tool to provide Information 107 Elements about Target Endpoints with well-defined semantics. YANG 108 Push [I-D.ietf-netconf-yang-push] and the corresponding YANG 109 Subscribed Notifications [I-D.ietf-netconf-subscribed-notifications] 110 drafts make use of these modules to create streams of notifications 111 (YANG telemetry). Subscriptions to YANG data stores or YANG streams 112 are Data Sources that provide Information Elements that can be 113 acquired by SACM Collectors to provide SACM Content on the Data 114 Plane. 116 Analogously, filter expressions used in the context of YANG 117 subscriptions constitute SACM Content that is Imperative Guidance 118 consumed by SACM Components on the Management Plane in order to 119 create YANG telemetry. 121 In this document (not including the abstract, of course), terms that 122 are Capitalized or prefixed with SACM are defined in the SACM 123 Terminology document. 125 2. Requirements notation 127 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 128 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 129 "OPTIONAL" in this document are to be interpreted as described in RFC 130 2119, BCP 14 [RFC2119]. 132 3. Brokering of YANG Push Telemetry via SACM Statements 134 Every SACM Content is published into a SACM Domain using a statement 135 envelope/encapsulation. The general structure of a SACM Statement is 136 based on the Information Element definition found in 137 [I-D.ietf-sacm-information-model] and can be summarized as follows: 139 o a sacm-statement encapsulates statement-metadata and content- 140 elements 142 o a content-element encapsulates content-metadata and SACM Content 144 In the scope of this document, only one type of SACM Content is 145 covered: YANG modeled data. Correspondingly, the minimal required 146 structure of statements, statement-metadata, content-elements, and 147 content-metadata are defined. A complete XML schema definition of 148 this subset of the generic SACM Data Model can be found in 149 Appendix A. 151 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 153 4. Encapsulation of YANG notifications in SACM content-elements 155 A YANG notification is associated with a set of YANG specific 156 metadata as defined in [I-D.ietf-netconf-notification-messages]. 157 Hence, SACM Content that is derived from a YANG notification 158 published to a SACM Domain MUST be encapsulated with its 159 corresponding Metadata in a content-element as defined below. 161 YANG output that is SACM Content MUST be represented according to the 162 XSD definition included in the content choice of the content-element. 164 165 166 167 168 169 170 172 173 174 175 177 4.1. Enumeration definition for content-type 179 An occurrence of the yang-output element MUST be instantiated in the 180 content-metadata element, if YANG Push output is to be transferred. 181 Also, the content-type MUST be set to the enumeration value "yang- 182 output", respectively. 184 In general, the list of content-type enumerations is including every 185 subject as defined in the SACM Information Model. Regarding the 186 definition of the subset of the generic SACM Data Model provided by 187 this document, the list of potential content-types is reduced to 188 "yang-output". Please note, that the complete generic SACM Data 189 Model includes additional content-type enumerations next to the 190 definition provided by this document. 192 193 194 195 196 198 199 200 201 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 203 4.2. Element definition for content-metadata 205 The list of optional elements included in content-metadata will 206 incorporate any every potential metadata type. For the scope of this 207 document, the list of elements is also limited to the minimal 208 required set of metadata elements and the yang-output metadata 209 element to support the encapsulation of NETCONF encoded subscribed 210 notifications or YANG query result. As defined above, one occurrence 211 of the yang-output element has to be included in the content-metadata 212 element. 214 A more complete content-metadata element definition is illustrated in 215 the Appendix A. 217 218 219 220 221 222 223 224 225 226 227 228 229 230 232 4.3. Definition of the yang-output-metadata element included in 233 content-metadata 235 The composition of metadata that can be associated with a XML NETCONF 236 result depends on multiple factors: 238 o acquisition method: query / subscription 240 o encoding: XML # more content encodings will be supported as 241 indicated by the definition 243 o subscription interval: periodic / on-change 245 o filter-type: xpath / subtree 247 Additionally, the actual filter expression (or in future iterations 248 of this work, a referencing Label, such as a URI, UUID or other 249 composed identifier) has to be included in the content-metadata. 251 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 253 254 255 256 257 258 259 260 261 262 263 264 266 267 268 269 270 271 272 273 274 275 277 278 279 281 282 283 285 286 287 288 289 290 291 293 294 295 296 297 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 299 5. Mapping of YANG Bundled Notifications to SACM Metadata 301 [I-D.ietf-netconf-notification-messages] includes the following 302 definition: 304 yang-data bundled-message 305 +-- bundled-message-header 306 | +-- message-time yang:date-and-time 307 | +-- message-id? uint32 308 | +-- previous-message-id? uint32 309 | +-- message-generator-id? string 310 | +-- signature? string 311 | +-- notification-count? uint16 312 +-- notifications* 313 +-- notification-header 314 | +-- notification-time yang:date-and-time 315 | +-- subscription-id* uint32 316 | +-- notification-id? uint32 317 | +-- module? yang-identifier 318 | +-- notification-type? notification 319 | +-- observation-domain-id? string 320 +-- receiver-record-contents? 322 The corresponding mapping MUST be used when deriving SACM Content 323 Metadata for content-metadata items from YANG modeled data 324 corresponding to YANG Notification Message Headers and Bundles: 326 notification-time -> content-creation-timestamp 327 subscription-id + (observation-domain-id OR "SACM Component Label") -> content-element-guid 328 module -> module-names 329 notification-type -> yang-subscribtion-type 330 receiver-record-contents -> content-elements 332 If there are more than one receiver-record-contents instanced 333 included in the received Notification Message Bundle, multiple 334 content-elements MUST be instanciated, accordingly. 336 The following mapping MUST be used when deriving SACM Statement 337 Metadata (see Appendix A) statement-metadata items representing 338 NETCONF instances adhering to the definition of YANG Notification 339 Message Headers and Bundles: 341 message-id -> statement-guid 342 "SACM Component Label" -> data-origin 343 message-time -> statement-creation-timestamp 344 "SACM Component Publictation Time" -> statement-publish-timestamp 345 statement-type -> "Observation" 347 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 349 "SACM Component Publicatation Time" can only be inferred by the SACM 350 Component using its "most trustworthy source of time". 352 If there is not receiver-record-contents included in the YANG 353 notification, a SACM Component MUST NOT publish a corresponding SACM 354 Statement to the SACM Domain. 356 6. SACM Component Composition 358 A SACM Component able to process YANG subscribed notifications 359 requires at least two functions: 361 o a SACM Function supporting YANG Push and YANG Notification Headers 362 and 364 o Bundles function [I-D.ietf-netconf-yang-push], 365 [I-D.ietf-netconf-subscribed-notifications], and 367 o an xmpp-grid provider function [I-D.ietf-mile-xmpp-grid] 369 Orchestration of functions inside a component, their discovery as 370 capabilities and the internal distribution of SACM Content inside a 371 SACM Component is out of scope of this document. # for now 373 7. IANA considerations 375 This document includes requests to IANA. 377 8. Security Considerations 379 TBD 381 9. Acknowledgements 383 Christoph Vigano, Guangying Zheng, Eric Voit, Alexander Clemm 385 10. Change Log 387 First version -00 389 Second version -01 * generalized the content of the document, 390 detaching it from the implementation created at the Hackaton of IETF 391 99 * included a mapping of the -03 version of the YANG Notification 392 Headers and Bundles draft to this draft 394 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 396 11. Contributors 398 Eric Voit 400 12. Normative References 402 [I-D.ietf-mile-xmpp-grid] 403 Cam-Winget, N., Appala, S., Pope, S., and P. Saint-Andre, 404 "Using XMPP for Security Information Exchange", draft- 405 ietf-mile-xmpp-grid-04 (work in progress), October 2017. 407 [I-D.ietf-netconf-notification-messages] 408 Voit, E., Bierman, A., Clemm, A., and T. Jenkins, 409 "Notification Message Headers and Bundles", draft-ietf- 410 netconf-notification-messages-02 (work in progress), 411 October 2017. 413 [I-D.ietf-netconf-subscribed-notifications] 414 Voit, E., Clemm, A., Prieto, A., Nilsen-Nygaard, E., and 415 A. Tripathy, "Custom Subscription to Event Streams", 416 draft-ietf-netconf-subscribed-notifications-08 (work in 417 progress), December 2017. 419 [I-D.ietf-netconf-yang-push] 420 Clemm, A., Voit, E., Prieto, A., Tripathy, A., Nilsen- 421 Nygaard, E., Bierman, A., and B. Lengyel, "YANG Datastore 422 Subscription", draft-ietf-netconf-yang-push-12 (work in 423 progress), December 2017. 425 [I-D.ietf-sacm-information-model] 426 Waltermire, D., Watson, K., Kahn, C., Lorenzin, L., Cokus, 427 M., Haynes, D., and H. Birkholz, "SACM Information Model", 428 draft-ietf-sacm-information-model-10 (work in progress), 429 April 2017. 431 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 432 Requirement Levels", BCP 14, RFC 2119, 433 DOI 10.17487/RFC2119, March 1997, 434 . 436 Appendix A. Minimal SACM Statement Definition for YANG Output 438 The definitions of statements, statement-metadata, content-element, 439 and content-metadata are provided by the SACM Information Model 440 [I-D.ietf-sacm-information-model]. 442 Due to the stripping down of content-elements to YANG output, the 443 enumerations still included in the relationship-type are not able to 445 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 447 point to other types of content in the scope of this document, but 448 are able to reference other content-types in the scope of the generic 449 SACM Data Model. 451 452 453 457 458 459 460 461 462 463 464 465 466 468 469 470 471 472 473 475 476 478 479 480 482 483 484 486 487 488 490 491 492 494 496 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 498 499 500 501 502 504 505 506 507 508 509 511 512 513 514 515 516 517 518 519 521 522 523 524 525 526 527 528 529 530 532 533 534 535 536 537 538 539 540 541 543 544 545 547 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 549 550 551 552 553 554 555 556 557 558 560 561 562 563 564 565 566 567 568 569 571 572 573 575 576 577 579 580 581 582 583 584 585 587 588 589 591 592 593 594 595 596 598 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 600 601 602 604 605 606 608 609 610 612 613 614 616 617 618 620 621 622 624 625 626 628 629 630 632 633 634 636 637 638 640 641 642 643 644 645 646 647 649 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 651 652 653 654 655 656 658 659 660 661 662 663 664 665 666 668 669 670 671 672 673 674 675 676 677 678 679 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 698 700 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 702 703 704 705 706 707 708 709 710 711 712 713 715 716 717 719 720 721 722 723 724 726 727 728 730 731 732 734 735 736 737 738 739 741 742 743 745 746 747 749 751 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 753 754 756 757 758 760 761 762 763 765 766 767 769 770 771 772 773 774 775 776 777 778 780 781 782 783 784 785 787 788 789 790 791 792 793 795 796 797 798 800 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 802 803 804 806 807 808 809 810 811 812 813 814 816 817 818 819 820 821 823 824 825 827 828 829 831 832 833 835 836 837 838 839 840 841 842 844 845 846 847 848 849 851 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 853 854 855 856 857 858 860 861 862 864 865 866 868 869 870 872 873 874 876 877 878 879 880 881 882 883 885 886 887 888 889 890 891 893 894 895 896 897 898 899 900 902 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 904 905 907 908 909 911 912 913 915 916 917 918 919 920 921 922 924 925 926 928 929 930 932 933 934 936 937 938 939 940 941 942 943 944 945 947 948 949 951 953 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 955 956 958 959 960 961 962 963 964 965 967 968 969 970 971 972 974 975 976 978 979 980 982 983 984 986 987 988 990 991 992 993 994 995 996 998 999 1000 1001 1002 1004 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 1006 1007 1008 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1023 1024 1025 1026 1027 1028 1029 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1045 1046 1047 1048 1049 1050 1051 1053 1055 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 1057 1058 1059 1060 1061 1063 1064 1065 1067 1068 1069 1071 1072 1073 1075 1076 1077 1079 1080 1081 1083 1084 1085 1087 1088 1089 1091 1092 1093 1095 1096 1097 1098 1099 1100 1101 1102 1104 1106 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 1108 1109 1110 1111 1112 1113 1114 1115 1117 1118 1119 1121 1122 1123 1125 1126 1127 1129 1130 1131 1133 1134 1135 1136 1137 1138 1140 1141 1142 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1157 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 1159 1161 1162 1163 1164 1165 1166 1168 1169 1170 1172 1173 1174 1176 1177 1178 1179 1180 1181 1182 1184 1185 1186 1188 1189 1190 1192 1193 1194 1196 1197 1198 1200 1201 1202 1204 1205 1206 1208 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 1210 1211 1212 1213 1215 1216 1217 1218 1219 1220 1222 1223 1224 1225 1226 1227 1228 1229 1231 1232 1233 1234 1235 1236 1237 1239 1240 1241 1243 1244 1245 1247 1248 1249 1250 1251 1253 1254 1255 1257 1259 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 1261 1262 1264 1265 1266 1267 1268 1269 1270 1272 1273 1274 1275 1276 1277 1279 1280 1281 1282 1283 1284 1285 1287 1288 1289 1291 1292 1293 1295 1296 1297 1299 1300 1301 1303 1304 1305 1307 1308 1310 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 1312 1314 1315 1316 1318 1319 1320 1322 1323 1324 1325 1326 1327 1329 1330 1331 1333 1334 1335 1337 1338 1339 1340 1342 1343 1344 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1357 1358 1359 1361 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 1363 1364 1365 1366 1367 1368 1369 1371 1372 1373 1375 1376 1377 1379 1380 1381 1383 1384 1385 1386 1387 1388 1390 1391 1392 1393 1394 1395 1396 1397 1399 1400 1401 1402 1403 1404 1405 1407 1408 1409 1410 1412 Internet-DrafYANG subscribed notifications via SACM Stateme January 2018 1414 1416 1417 1418 1419 1420 1421 1422 1423 1424 1426 1427 1428 1429 1430 1431 1432 1434 Authors' Addresses 1436 Henk Birkholz 1437 Fraunhofer SIT 1438 Rheinstrasse 75 1439 Darmstadt 64295 1440 Germany 1442 Email: henk.birkholz@sit.fraunhofer.de 1444 Nancy Cam-Winget 1445 Cisco Systems 1446 3550 Cisco Way 1447 San Jose, CA 95134 1448 USA 1450 Email: ncamwing@cisco.com