Telechat Review of draft-ietf-netmod-yang-tree-diagrams-05

Request Review of draft-ietf-netmod-yang-tree-diagrams
Requested rev. no specific revision (document currently at 06)
Type Telechat Review
Team Security Area Directorate (secdir)
Deadline 2018-02-06
Requested 2018-01-23
Authors Martin Björklund, Lou Berger
Draft last updated 2018-01-25
Completed reviews Secdir Telechat review of -05 by Phillip Hallam-Baker (diff)
Rtgdir Telechat review of -05 by Stig Venaas (diff)
Assignment Reviewer Phillip Hallam-Baker 
State Completed
Review review-ietf-netmod-yang-tree-diagrams-05-secdir-telechat-hallam-baker-2018-01-25
Reviewed rev. 05 (document currently at 06)
Review result Has Nits
Review completed: 2018-01-25


I have reviewed the document and it is generally free of security considerations as claimed. There are some areas of concern however, the significance of which may become more apparent as such tools find future use.

As described in the document, the tree diagram format is intended to serve as an output generated by a tool to aid human interpretation. Thus, a potential ambiguity can arise if the tool used to generate the format is buggy or if the document contains schema and presentation data compiled from different versions of the source. 

Specifications using this representation need to make clear which representation is canonical. Otherwise we end up in a situation in which a document that has an ambiguity being unfixable by means of issuing an errata because there is no agreement as to whether the change is breaking or not.

Another issue that is of concern is that even though the format is not intended to be an input format, there can be no guarantee it will not be used as such. Indeed it could be argued that a spec that makes use of this format should encourage this approach so as to detect possible ambiguities.