<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE rfc [
  <!ENTITY nbsp    "&#160;">
  <!ENTITY zwsp   "&#8203;">
  <!ENTITY nbhy   "&#8209;">
  <!ENTITY wj     "&#8288;">
]>
<?xml-stylesheet type="text/xsl" href="rfc2629.xslt" ?>
<!-- generated by https://github.com/cabo/kramdown-rfc2629 version 1.5.12 -->
<?rfc toc="yes"?>
<?rfc sortrefs="yes"?>
<?rfc symrefs="yes"?>
<rfc xmlns:xi="http://www.w3.org/2001/XInclude" ipr="trust200902" docName="draft-ietf-opsawg-ol-00" category="std" consensus="true" updates="8520" obsoletes="" submissionType="IETF" xml:lang="en" tocInclude="true" sortRefs="true" symRefs="true" version="3">
  <!-- xml2rfc v2v3 conversion 3.9.1 -->
  <front>
    <title abbrev="Owner and Licensing Statements">Ownership and licensing statements in YANG</title>
    <seriesInfo name="Internet-Draft" value="draft-ietf-opsawg-ol-00"/>
    <author initials="E." surname="Lear" fullname="Eliot Lear">
      <organization>Cisco Systems</organization>
      <address>
        <postal>
          <street>Richtistrasse 7</street>
          <city>Wallisellen</city>
          <code>8304</code>
          <country>Switzerland</country>
        </postal>
        <phone>+41 44 878 9200</phone>
        <email>lear@cisco.com</email>
      </address>
    </author>
    <author initials="C." surname="Bormann" fullname="Carsten Bormann">
      <organization>Universität Bremen TZI</organization>
      <address>
        <postal>
          <street>Postfach 330440</street>
          <city>Bremen</city>
          <code>D-28359</code>
          <country>Germany</country>
        </postal>
        <email>cabo@tzi.org</email>
      </address>
    </author>
    <date year="2021" month="October" day="20"/>
    <keyword>Internet-Draft</keyword>
    <abstract>
      <t>This memo provides for an extension to RFC 8520 that allows
MUD file authors to specify ownership and licensing of MUD
files themselves.  This memo updates RFC 8520.  However, it
can also be used for purposes outside of MUD, and the grouping
is structured as such.</t>
    </abstract>
  </front>
  <middle>
    <section anchor="introduction" numbered="true" toc="default">
      <name>Introduction</name>
      <t><xref target="RFC8520" format="default"/> Manufacturer Usage Descriptions (MUD) can be used to
describe devices and their requirements to the network infrastructure.
The original version of the specification does not provide for a
means to specify ownership and licensing of the MUD file itself.  This
can hinder those wishing to use, modify, or adapt MUD files for the
purpose of offering them, when the manufacturer is not involved.</t>
      <ul spacing="normal">
        <li>
          <strong>Issue</strong>: Should this be an owner or an originator?</li>
      </ul>
      <t>To avoid any confusion, we define an extension that allows for
specifying of owners and licensing terms for MUD files.</t>
      <t>Those generating MUD files <bcp14>SHOULD</bcp14> use this extension, and
thus this extension updates RFC 8520.</t>
      <t>There are two ways to specify a license: a URL pointing to the license
itself or an SPDX tag <xref target="SPDX" format="default"/>.  If an SPDX tag is supplied consumers
<bcp14>MUST</bcp14> interpret that tag through its meaning as specified by <xref target="SPDX" format="default"/>.</t>
      <ul spacing="normal">
        <li>
          <strong>Issue</strong>: Should we simply say that a URI contains a colon and SPDX
license identifier doesn't?</li>
      </ul>
      <t>This grouping may be used for other YANG models that reside as
static objects.</t>
      <t>The key words "<bcp14>MUST</bcp14>", "<bcp14>MUST NOT</bcp14>", "<bcp14>REQUIRED</bcp14>", "<bcp14>SHALL</bcp14>", "<bcp14>SHALL</bcp14>
NOT", "<bcp14>SHOULD</bcp14>", "<bcp14>SHOULD NOT</bcp14>", "<bcp14>RECOMMENDED</bcp14>", "<bcp14>NOT RECOMMENDED</bcp14>",
"<bcp14>MAY</bcp14>", and "<bcp14>OPTIONAL</bcp14>" in this document are to be interpreted as
described in BCP&nbsp;14 <xref target="RFC2119" format="default"/> <xref target="RFC8174" format="default"/> when, and only when, they
appear in all capitals, as shown here.</t>
    </section>
    <section anchor="the-owner-license-extension-and-model" numbered="true" toc="default">
      <name>The owner-license extension and model</name>
      <t>Because the model is primarily motivated by MUD, and based
on the way that YANG trees are formed, the model appears as
an augmentation for MUD.</t>
      <artwork name="" type="" align="left" alt=""><![CDATA[
module: ietf-ol

  augment /mud:mud:
    +--rw ol
       +--rw owners*               string
       +--rw (license-type)?
          +--:(spdx-lt)
          |  +--rw spdx-tag?       string
          +--:(url)
             +--rw license-info?   inet:uri

]]></artwork>
      <ul spacing="normal">
        <li>
          <strong>Issue</strong>: Should different owners possibly have their own license
types?  (Logical and, derived works.)</li>
        <li>
          <strong>Issue</strong>: Should a single owner possibly have multiple license
types?  (Logical or, multi-licensing.)</li>
      </ul>
    </section>
    <section anchor="the-yang-schema-for-ownership-and-licensing" numbered="true" toc="default">
      <name>The YANG schema for ownership and licensing</name>
      <t>The following grouping and augmentation are proposed.</t>
      <sourcecode name="" type="" markers="true"><![CDATA[file "ietf-ol@2021-05-21.yang"
module ietf-ol {
  yang-version 1.1;
  namespace "urn:ietf:params:xml:ns:yang:ietf-ol";
  prefix ol;

  import ietf-inet-types {
    prefix inet;
  }
  
  import ietf-mud {
    prefix mud;
  }


  organization
    "IETF OPSAWG (Ops Area) Working Group";
  contact
    "WG
     Web: http://tools.ietf.org/wg/opsawg/
     WG List: opsawg@ietf.org
     Author: Eliot Lear lear@cisco.com
     Author: Carsten Bormann <cabo@tzi.org>";
  description
    "This YANG module to indicate ownership and licensing.

     Copyright (c) 2021 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 Section 4.c of the IETF Trust's Legal Provisions
     Relating to IETF Documents
     (https://trustee.ietf.org/license-info).

     This version of this YANG module is part of RFC XXXX
     (https://www.rfc-editor.org/info/rfcXXXX);
     see the RFC itself for full legal notices.

     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 BCP 14 (RFC 2119) (RFC 8174) when, and only when,
     they appear in all capitals, as shown here.  ";

  revision 2021-05-21 {
    description
      "Initial proposed standard.";
    reference
      "RFC XXXX: Extension for ownership and licensing";
  }

  grouping ol-extension {
    description
      "OL extension grouping";
    container ol {
      description
        "container relating to ownership and licensing.";
      leaf-list owners {
      type string;
        description
          "A list of owners, may be in the form of a copyright
           Example: Copyright (c) Jane Smith.  All rights Reserved.";
        }
      choice license-type {
        description "Either choose a standard license type or point
                     to one of your own.";
        case spdx-lt {
          leaf spdx-tag {
            type string;
            description "SPDX License Identifier, as indicated at
                         https://spdx.org/licenses/";
          }
        }
        case url {
          leaf license-info {
            type inet:uri;
            description "A URL pointing to licensing information.";
          }
        }
      }
    }
  }

  augment "/mud:mud" {
    description
      "Add extension for Ownership and licensing.";
    uses ol-extension;
  }
}
]]></sourcecode>
    </section>
    <section anchor="extension-for-mud" numbered="true" toc="default">
      <name>Extension for MUD</name>
      <t>MUD files using this extension <bcp14>MUST</bcp14> include "ol" in the extensions
array, as specified by <xref target="RFC8520" format="default"/>.</t>
    </section>
    <section anchor="example" numbered="true" toc="default">
      <name>Example</name>
      <t>In this example, the Frobmaster company is using the 0BSD SPDX
tag to indicate a relatively open license.  The "ol" extension
and container are present.  There is a single owner listed.</t>
      <artwork name="" type="" align="left" alt=""><![CDATA[
{
  "ietf-mud:mud": {
    "mud-version": 1,
    "extensions": [
      "ol"
    ],
    "ol": {
      "owners": [
        "Copyright (c) FrobMaster 2021. All Rights Reserved"
      ],
      "spdx-tag": "0BSD"
    },
    "mud-url": "https://frobs.example.com/mud/Frob.json",
    "mud-signature": "https://frobs.example.com/mud/Frob.p7s",
    "last-update": "2021-05-24T11:26:04+00:00",
    "cache-validity": 48,
    "is-supported": true,
    "systeminfo": "This device helps produce frobs",
    "mfg-name": "FrobMaster",
    "documentation": "https://frobs.example.com/doc",
    "model-name": "Frobinator"
    }
}
]]></artwork>
      <ul spacing="normal">
        <li>
          <strong>Task</strong>: need Makefile for validating this against MUD.
(Probably put this into a separate file, too.)</li>
        <li>
          <strong>Issue</strong>: Should we give an example for usage outside yang?</li>
      </ul>
    </section>
    <section anchor="security-considerations" numbered="true" toc="default">
      <name>Security Considerations</name>
      <t>No security considerations have been identified.</t>
      <ul spacing="normal">
        <li>
          <strong>Issue</strong>: Should we maybe point out any specific seccons of 8520?</li>
      </ul>
    </section>
    <section anchor="iana-considerations" numbered="true" toc="default">
      <name>IANA Considerations</name>
      <section anchor="mud-extension" numbered="true" toc="default">
        <name>MUD Extension</name>
        <t>The IANA is requested to add "ol" to the MUD
extensions registry as follows:</t>
        <artwork name="" type="" align="left" alt=""><![CDATA[
  Extension Name: ol
  Standard reference: This document

]]></artwork>
      </section>
    </section>
  </middle>
  <back>
    <references>
      <name>Normative References</name>
      <reference anchor="RFC8520" target="https://www.rfc-editor.org/info/rfc8520">
        <front>
          <title>Manufacturer Usage Description Specification</title>
          <author fullname="E. Lear" initials="E." surname="Lear">
            <organization/>
          </author>
          <author fullname="R. Droms" initials="R." surname="Droms">
            <organization/>
          </author>
          <author fullname="D. Romascanu" initials="D." surname="Romascanu">
            <organization/>
          </author>
          <date month="March" year="2019"/>
          <abstract>
            <t>This memo specifies a component-based architecture for Manufacturer Usage Descriptions (MUDs).  The goal of MUD is to provide a means for end devices to signal to the network what sort of access and network functionality they require to properly function.  The initial focus is on access control.  Later work can delve into other aspects.</t>
            <t>This memo specifies two YANG modules, IPv4 and IPv6 DHCP options, a Link Layer Discovery Protocol (LLDP) TLV, a URL, an X.509 certificate extension, and a means to sign and verify the descriptions.</t>
          </abstract>
        </front>
        <seriesInfo name="RFC" value="8520"/>
        <seriesInfo name="DOI" value="10.17487/RFC8520"/>
      </reference>
      <reference anchor="SPDX">
        <front>
          <title>SPDX Specification 2.1</title>
          <author>
            <organization>The Linux Foundation</organization>
          </author>
          <date year="2016"/>
        </front>
      </reference>
      <reference anchor="RFC2119" target="https://www.rfc-editor.org/info/rfc2119">
        <front>
          <title>Key words for use in RFCs to Indicate Requirement Levels</title>
          <author fullname="S. Bradner" initials="S." surname="Bradner">
            <organization/>
          </author>
          <date month="March" year="1997"/>
          <abstract>
            <t>In many standards track documents several words are used to signify the requirements in the specification.  These words are often capitalized. This document defines these words as they should be interpreted in IETF documents.  This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.</t>
          </abstract>
        </front>
        <seriesInfo name="BCP" value="14"/>
        <seriesInfo name="RFC" value="2119"/>
        <seriesInfo name="DOI" value="10.17487/RFC2119"/>
      </reference>
      <reference anchor="RFC8174" target="https://www.rfc-editor.org/info/rfc8174">
        <front>
          <title>Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words</title>
          <author fullname="B. Leiba" initials="B." surname="Leiba">
            <organization/>
          </author>
          <date month="May" year="2017"/>
          <abstract>
            <t>RFC 2119 specifies common key words that may be used in protocol  specifications.  This document aims to reduce the ambiguity by clarifying that only UPPERCASE usage of the key words have the  defined special meanings.</t>
          </abstract>
        </front>
        <seriesInfo name="BCP" value="14"/>
        <seriesInfo name="RFC" value="8174"/>
        <seriesInfo name="DOI" value="10.17487/RFC8174"/>
      </reference>
    </references>
    <section anchor="changes-from-earlier-versions" numbered="true" toc="default">
      <name>Changes from Earlier Versions</name>
      <t>Draft -00:</t>
      <ul spacing="normal">
        <li>Resubmit unchanged</li>
      </ul>
      <t>Individual Draft -01:</t>
      <ul spacing="normal">
        <li>Add some issues</li>
        <li>correct spacing</li>
      </ul>
      <t>Individual Draft -00:</t>
      <ul spacing="normal">
        <li>Initial revision</li>
      </ul>
    </section>
  </back>
  <!-- ##markdown-source:
H4sIAA37b2EAA5VZ23IbuRF9n69A+CLJS1KkVru26Y29siTbSsmSI8rxbra2
UuAMSGI9HEwAjGiuo3xLHvIlyY/lNC5zkSiXwyqV5gKgG305fRozGAwSK20u
JuxyXQhtlrJkvMhYLlNRGFksmLHcipUorGGyYD8fXbxO+GymxU2Y4oaf18On
9fAkU2nBV1g603xuB1LY+UCVhq8XA5UPRqMkxdCF0psJhGRJqgqDRSozYVZX
IqnKDO9x9+S7g1GSyFK7F8YejEZPRwfJR7FZK51N2FlhhS6EHZyQnCSBxkX2
N56rArI3wiSlnLBfrEr7zChttZgbXG1WdPFrkvDKLpWeJGyQMPxkAZGnQ3Yu
uHYP/B5Oc6ls81DpxYQdS5MqNt0Y7Ni4xwarCzthVzJdWok7boxgj927VGVY
5/jN4Mm3o0P/RFrs/QPPc2lEnosijKsKS0aZrqX9Xegcu3EvyqXbUe+bwzE7
PGRPHj9hT2GLnnspVlzmE5ZDwR9T0muYqlVnT8dD9lLpFS+K1raOuYb2ReeN
29v7Qt4gHqT9778te6nJpez6r2edXb5Txs55umTfYkeHo9ae/ITWtk8GB0++
/e5pd4OvBQndtPVP+Uz9aH+XQyiRJAVpZaHIhMZcvTqmUHDX03cnP7kLxkL8
0hM2LUUq5xKBJVXBDoZjP6R2sf+5DV4vBcK2qD6xV9AnczP8AAq7CTsYjb9H
1BXzRodkMBgwPiO3poiz66U0bCVWipVa3chMGIbByAcmPllKB6hgFantQpjZ
JbcMzlZrk7x9f8LmMhdBNUMDjVN+w9QDmajmDNMSmobxS8ScyG+EGTLWaBKS
phaKl2/UWsCVfSYtMq6ABkaxmWCVEZlTuKx0qQwmqcoabCMI6jvxkMMWWlUl
NEggBZuvUltpzOW4q9Ll0NtlJbMsF0mCbNQqwxiy5x9bvyT5/Dm48PaWveVF
hdihlTR7b/hCsBNhUi1LmmjYLjTYY6RvVNWqJHMj8CATNzCLiRpKzbT4eyV1
ACoYk/QGJgAhPiL850jEqPgwIdcrLRey4DlzUQ5PYdM0x3QiKFMQUiDxg4e9
g5OV4MXXuowWrb0tLXw2Dx5z3ljKIoMFEAQAirXEGpiGlbHlPlupDKv3GQnN
eGnrhXykYekkOI8kqflcaDcdsdFn6yVSlqSv2qaWfj+yuFEIngzOe8QePToz
phKPHiGLlqrKyaYYBztDQbc15uM6GM0q/QLhrxi/URJxUGyQ08W8IjtCLrln
LgtxJxOa6Cflk2C6YCVvwDvWA6yv/E7rfQ8p7Wi/C4EJcBKGNUaZvrl8f35C
tvM7qKW7WE7ssjJ3XtxPGBIgNJTHH8KHrfmm42oeFAREcPb+6pyVShY2eI3M
HV4n3tfBcg6dLF+wz5/p8vYWMXA277yh5KrKMpeIdaqF1QoWAVBMr+EtmKLU
wnor0mi7RFIulhRRjMKRFKCE9OGLJWabRtZ2J8NRRq7KfMMM3wT/YEdnJN1y
1Azcpgpl1LmFlgI+ht0xJAN2DUnaJUmxY18ERIxogbjbdHBGwTraMQgKbJEb
L1MLBzrcUOG2MmVq9ptIrXe1YCjzjOq8YT2yRa/v/7OLS3d9dfrn92dXpyd0
PX1zdH5eXyRhhA+K5qqZeXz59u3pxYmfjKes8yjpvT36uedRsHf57vrs8uLo
vEckyIUQ2E1FaOMDxSFq7SYHjjVaZTTn5fG7//xrfAif/AGhdjAePwUI+psn
48eHuKF89dJUAZ/4W5hsk/CyRFmnVZA/wMRSWoB43/l7icxhFLDk5F/IMr9O
2A+ztBwfPg8PaMOdh9FmnYfOZvef3Jvsjbjl0RYxtTU7z+9Yuqvv0c+d+2j3
1kMfFg4wBjEam3wm+7no6tSeh39J8lKk3COG8DMpE0stV1xL+GGlUPy59RlV
l8UZR1QnygPsOqaPi20iR8ZFBVEHkfVbK3tPGooOqsTVgiLIl5oAc3DjP+Mv
waSKuI2nznmSsDiH7a+qbEJ/jrN8MxjoNcOIwHDCvQPVR6z7QyGkWt4ZuRsM
ObCbUuy9SJrReD/ZNWX2aZDbvdbzf8Sp7h0Q6cXW5eMKlc7bs2vBUS7xrBeO
qYJYVlq2rbAdvVAZUe7IFKF2oAwaOYPHlvxGBFZAyRHxGEwRmzOQsnuuFqjw
OXmyj2Klwe4yApmPZri3VRhnVJDyEHZ3RK2q3MoyF1+SpMC/3LhBXd4gyoey
ixqTomhzj5PbycQXA9qvNFdUXwl7axCmJTpxRoEJNkOkIYvBlvxwfHlyyl6e
vj67mD53TKUXYu7Hg9HBeDD6bnAwHm54seiFoIwxyT5ju/RiEInUeDh+lvj+
wpQ8xVKVLiY0fFJyzVdm8mmVT9CR0KxJWKZHUwCdc/kJYfyMIh2lCd2al0Nh
4WLTOHn1UHpOM2/xd2cKcqM7Fg/8UFocLQBq5u8N6++dnV6/YpfvpkcfXrPd
y9KwIy34HvuAqCA7viaDOi1ddQT/d7M+vPZR/UHMJmxpbTnZ37dK5WZISlAX
s79e7Puudz8MfY2+w6B98k9/jAP92yPfqrT6zXs9XXvYnf6N/dBuoJ47fbOG
VnudXZWOZZhcieoFFkqcVzwUfMPEyz1W5QYkcGnZbrrHKDaYM9w1NeZ1w1Bi
CSLxNUlw9bDVipnIjKk7BBU6Ql1zyxqiA0J7ZuomXImMGmk5q2zEd0JrFEOj
Kp0KD8dgpXrjABd1EX3zEh728+kGjY3n0oHX9x3Eg11KS8AODm0qDiSxyqO7
qRwFoZbDt5gNrQukNFAkV9s9wE+JSvm9vpyehBMRMCzhI4V0g1ZQeypcb8QO
h2m0QmPCHQOfLwAY76jhoHwy0Qw5jyzTDT8J/CO836XgMxR9tIwQTfy1IXYv
WtXFQKf1uRMTZCCOXMI7osY/4XdH0Hq9Hup5OoB/0BA4USRiH89o9N4zP94I
X1pplUCJCeTmFVyeu62iH6FmrlGtTfp2iMHs9P1/ohh0HQkMXTuWUl/4JcIw
z0uaq2Z6TT7o9g4f2en7RXbARXZ8POxEGrLzf9A/t8hdDshAAXfJFMQA9/wl
8b+9rfSvjr4N+zoOiOx22KmFDx7WoHcAw7toQMhXSCvhh1gVmDtA4zob9rwP
gZ9UaVMRZ8SIAEzVxOsLlasXcJc1ZUnlg4azPajZ5XmL2cW5QamYgZCahxW2
rYFVmpG6lUQPAV1YnhHszlGtTU0wohCqQ4HmPKulbJMM2UfMrxA73H7siqSn
joRY9JY6rYCsbZp0+okDVeicroO7f+LorqdAr2UXO68idvYaxW7DVbpU2CNr
E716Rx31We9Uuk4NM6jT5nU8NBhIk+nkiFrfLq2LP7Jw4Y4lNoBp2n1bqZQT
NHpW2dLCG72mlJ03D9j9nvKun47oe1Z3qS5TYpVDfj6gNv0iwJEabQQ1+722
3Nt7Jg77Ate9v6c2Cm/bVyS+X9jZ0b3jhuaopD6nVB07b9PS/7+NKRkbil7s
KHoP5+NRlrUSkjL+ga8GUYfKHSu2ct0jwW0gnMDb6fNAQZMulNBJ5xaW25z1
VP6IqHuaE05L0rzKwDtBK2Oe1UPQeGnNN/0thyX14eSQlHGJl9SCz4ooy73w
Nf+VVrMVR7lFsqhVSQdhstFMsBExAXdw4o5sWjSLByy6EcB6VYq6TRn6Auh0
r5VOyLgNjHkKj1wvrB+uXb2+06QQ8DQU35mYHNuL7Nj5ehKc3cNNZPB4OPal
p9eYDQ9/iWEA3dzlr2EU7id1TPc80LXG41kXvshsb73ZqD4NHYRddSGsFyYH
GVgjogJW7pFh/YjbfqM/Eo9exvydQ4wZBocRdaYI3yfhw99AT3utmUYuCk4H
pF85v3xs4vQcGxn4U0SaXBfcw+vxeHLw/WR0+M1oNBmN4viUo9Mb3PBcgjdt
MOXwSXgjzYAOAMETBTmGPoKFN8Z9YqIcJxGOu/kTcFT9vKTTCjpxRzUhjet9
zRcDasJoSmPx+DbyFwcZX941htZr0ilGZ1V/HBx8gcRugo366GtuPlIbXQgk
2Vv+UbjekvLbGSAUY9oPX9CJo/VHIGCZ4L8zTi12WVk/ArCnKMYFdZFIIVoK
aagUNdIPnG8ukGD+GNptx0mu3MeG+K2DmtAXSQJSDvC1GxTagp5rZxfzUM+d
JBcKmoQ5aWeOPxSYCeR00/88fAQLPgA64FCdlHKn6fEjBImgxamMEjRB0bOj
i6OvUNIjZQ2p9IWm+fnDAreSNO7LiSCoIIDiQHiHPeEwm2C4AQGMXVAztiH0
9IcNZlIDDFWTBsQv3PdFdyQ1jfyhJpIT34DEIGwt4b4lzXj6EZfHSziHvnVo
tWKnXOd02vwXD1IPuibu330MZgPkHun1iIClmoEysapI3boZgXomb2RWgfzG
4eMwnEqdUSsCVrjMuGep0praQjrWoAOZbfOjuEiqIxNP/gfdGtNbax8AAA==

-->

</rfc>
