wdiff rfc9409xml2.original.xml rfc9409.xml

<?xml version='1.0' encoding='utf-8'?> version="1.0" encoding="UTF-8"?>

<!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
  <!ENTITY RFC3261 SYSTEM "https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.3261.xml"> nbsp    "&#160;">
  <!ENTITY RFC8288 SYSTEM "https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.8288.xml"> zwsp   "&#8203;">
  <!ENTITY RFC3986 SYSTEM "https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.3986.xml"> nbhy   "&#8209;">
  <!ENTITY RFC7033 SYSTEM "https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.7033.xml">
<!ENTITY RFC6749 SYSTEM "https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.6749.xml"> wj     "&#8288;">
]>

<?xml-stylesheet type='text/xsl' href='rfc2629.xslt' ?>
<!-- Generated by id2xml 1.5.0 on 2022-03-02T22:35:34Z -->
<?rfc strict="yes" ?>
<!-- give errors regarding ID-nits and DTD validation -->
<!-- control the table of contents (ToC) -->
<?rfc toc="yes"?>
<!-- generate a ToC -->
<?rfc tocdepth="4"?>
<!-- the number of levels of subsections in ToC. default: 3 -->
<!-- control references -->
<?rfc symrefs="yes"?>
<!-- use symbolic references tags, i.e, [RFC2119] instead of [1] -->
<?rfc sortrefs="yes" ?>
<!-- sort the reference entries alphabetically -->
<!-- control vertical white space
     (using these PIs as follows is recommended by the RFC Editor) -->
<?rfc compact="yes" ?>
<!-- do not start each main section on a new page -->
<?rfc subcompact="no" ?>
<!-- keep one blank line between list items -->
<!-- end of list of popular I-D processing instructions -->
<?rfc tocappendix="yes" ?>

<rfc xmlns:xi="http://www.w3.org/2001/XInclude" submissionType="IETF" category="info" consensus="true" docName="draft-ietf-asap-siptrunkingcapability-link-05" number="9409" ipr="trust200902" xml:lang="en"> xml:lang="en" obsoletes="" updates="" tocInclude="true" tocDepth="4" symRefs="true" sortRefs="true" version="3">

  <!-- xml2rfc v2v3 conversion 3.17.1 -->
  <front>
    <title abbrev="&quot;sip-trunking-capability&quot; Link Type">
         The 'sip-trunking-capability' Link Relation Type
    </title>
    <seriesInfo name="RFC" value="9409"/>
    <author initials="K." surname="Inamdar" fullname="Kaustubh Inamdar">
      <organization>Unaffiliated</organization>
      <address>
        <email>kaustubh.ietf@gmail.com</email>
      <uri></uri>
        <uri/>
      </address>
    </author>
    <author initials="S." surname="Narayanan" fullname="Sreekanth Narayanan">
      <organization>Cisco</organization>
      <address>
        <email>sreenara@cisco.com</email>
      <uri></uri>
        <uri/>
      </address>
    </author>
    <author initials="D." surname="Engi" fullname="Derek Engi">
      <organization>Cisco</organization>
      <address><postal>
      <street>Ann Arbor, MI</street>
      <street>US</street>
      <address>
        <postal>
          <city>Ann Arbor</city>
	  <region>MI</region>
          <country>United States of America</country>
        </postal>
        <phone>+1 919 392 7966</phone>
        <email>deengi@cisco.com</email>
      <uri></uri>
        <uri/>
      </address>
    </author>
    <author initials="G." surname="Salgueiro" fullname="Gonzalo Salgueiro">
      <organization>Cisco</organization>
      <address><postal><street>7200-12
      <address>
        <postal>
          <street>7200-12 Kit Creek Rd.</street>
      <street>Research
          <city>Research Triangle Park, NC 27709</street>
      <street>US</street> Park</city>
	  <region>NC</region>
	  <code>27709</code>
          <country>United States of America</country>
        </postal>
        <phone>+1 919 392 3266</phone>
        <email>gsalguei@cisco.com</email>
      <uri></uri>
        <uri/>
      </address>
    </author>
    <date year="2023" month="May" day="8"/>
	  <abstract><t> month="July"/>
    <area>art</area>
    <workgroup>asap</workgroup>

<keyword>SIP</keyword>
<keyword>Session Initiation Protocol</keyword>
<keyword>automatic peering</keyword>
<keyword>WebFinger</keyword>
<keyword>capability set</keyword>

    <abstract>
      <t>
      This informational Informational document defines the 'sip-trunking-capability' link relation type that may be used by an enterprise telephony Session Initiation Protocol (SIP) network to retrieve a SIP trunking capability set document, which contains the capabilities and configuration requirements of an Internet Telephony Service Provider (ITSP). These technical requirements allow for seamless peering between SIP-based enterprise telephony networks and the ITSP.</t>
    </abstract>
  </front>
  <middle>
    <section title="Introduction" anchor="introduction"> anchor="introduction" numbered="true" toc="default">
      <name>Introduction</name>
      <t>
      RFC 8288 <xref target="RFC8288"/> target="RFC8288" format="default"/> defines a way of indicating to indicate relationships between
   resources on the Web. This document specifies the 'sip-trunking-capability' link
   relation type according to the rules of RFC 8288.  Links with this relationship type can be used to exchange capability information between potential peer devices. In the event that systems require additional parameters and configuration to negotiate communication, a well-known URI can be utilized to deliver information to potential peers peers, including machine-readable instructions and parameters needed for peering.
      </t>
      <t>
      The 'sip-trunking-capability' link relation type may be used on web resources hosted by ITSPs to provide a structured and detailed capability set document.  The capability set document <xref target="I-D.ietf-asap-sip-auto-peer"/> target="I-D.ietf-asap-sip-auto-peer" format="default"/> encapsulates a set of characteristics of an ITSP, which when retrieved by enterprise telephony network devices allows for automated establishment of SIP <xref target="RFC3261"/> target="RFC3261" format="default"/> trunking between the two telephony networks.
      </t>
    </section>
    <section title="The anchor="link-type" numbered="true" toc="default">
      <name>The 'sip-trunking-capability' Link Relation Type" anchor="link-type"> Type</name>
      <t>
         A capability set document is hosted via web resources by the ITSP.  A unique location of the document can be preconfigured and provided to each peer by the ITSP, or a centrally published resource can be used that dynamically generates the capability set document based on one or more Uniform Resource Identifier(s) Identifiers (URIs) <xref target="RFC3986"/> target="RFC3986" format="default"/> determined by the peering device.  The capability set document describes the configuration parameters required to successfully establish SIP trunking between an enterprise and an ITSP network.  The capability set document is composed of structured and machine-readable parameters that can be converted into configuration data to meet the communication requirements of the ITSP.  The need for an enterprise telephony network to obtain a capability set document from an ITSP is documented in Automatic "Automatic Peering for SIP Trunks Trunks" <xref target="I-D.ietf-asap-sip-auto-peer"/>. target="I-D.ietf-asap-sip-auto-peer" format="default"/>.
      </t>
    </section>
    <section title="Example Usage" anchor="examples"> anchor="examples" numbered="true" toc="default">
      <name>Example Usage</name>
      <t>
            This section provides an example of possible use of the 'sip-trunking-capability' relation type.  The enterprise network device solicits the location of the capability set document from the well-known URI hosted by the ITSP using the WebFinger protocol <xref target="RFC7033"/>. target="RFC7033" format="default"/>. The following examples include line-breaks line breaks and indentation for clarity.
      </t>

<figure>
<artwork>
<![CDATA[
      <artwork name="" type="" align="left" alt=""><![CDATA[

   GET /.well-known/webfinger?
      resource=acct%3Atrunkent1456%40example.com&
      rel=sip-trunking-capability
      HTTP/1.1
   Host: ssp1.example.com
]]>
</artwork>
</figure>

]]></artwork>
      <t>
            The location of the capability set document location is returned to the network device in the "href" attribute.
      </t>
<figure>
<artwork>
<![CDATA[
      <artwork name="" type="" align="left" alt=""><![CDATA[

   HTTP/1.1 200 OK
   Access-Control-Allow-Origin: *
   Content-Type: application/jrd+json
   {
      "subject" : "acct:trunkent1456@example.com",
      "links" :
      [
         {
            "rel" : "sip-trunking-capability",
            "href" :"https://capserver.ssp1.example.com/capserver/capdoc.json" : "https://capserver.ssp1.example.com/capdoc.json"
         }
      ]
   }
]]>
</artwork>
</figure>

]]></artwork>
      <t>
         The ITSP may use an authentication framework such as OAuth 2.0 <xref target="RFC6749"/> target="RFC6749" format="default"/> to determine the identity of the enterprise telephony network in order to provide the appropriate capability set document.
      </t>
    </section>
    <section title="IANA Considerations" anchor="iana"> anchor="iana" numbered="true" toc="default">
      <name>IANA Considerations</name>
      <t>IANA has registered the 'sip-trunking-capability' link relation under the "Link Relation Types" registry, with a reference to this document, using the following template:</t>
        <t><list style="hanging">
            <t hangText="Relation Name:">sip-trunking-capability</t>

            <t hangText="Description:">Refers registry as follows:</t>
      <dl newline="false" spacing="normal">
        <dt>Relation Name:</dt>
        <dd>sip-trunking-capability</dd>
        <dt>Description:</dt>
        <dd>Refers to a capability set document that defines parameters or configuration requirements for automated peering and communication channel communication-channel negotiation of the Session Initiation Protocol (SIP).</t>
            <t hangText="Reference:">RFC&rfc.number;</t>
            <t>[[NOTE TO RFC EDITOR: Please change &rfc.number; to the number assigned to this specification, and remove this paragraph on publication.]]</t>
          </list></t> (SIP).</dd>
        <dt>Reference:</dt>
        <dd>RFC 9409</dd>
      </dl>
    </section>
    <section title="Security Considerations" anchor="security"> anchor="security" numbered="true" toc="default">
      <name>Security Considerations</name>
      <t>
            The 'sip-trunking-capability' relation type is not known to introduce any new security issues not already discussed in RFC 8288 for generic use of web linking web-linking mechanisms.  However, it is recommended to exercise caution when publishing potentially sensitive capability information over unencrypted or unauthenticated channels. Additional security recommendations are outlined in the capability set document definition. See the <xref target="I-D.ietf-asap-sip-auto-peer" sectionFormat="bare" section="Security Considerations" relative="https://datatracker.ietf.org/doc/html/draft-ietf-asap-sip-auto-peer#name-security-considerations" /> relative="#name-security-considerations" format="default"/> section in Automatic "Automatic Peering for SIP Trunks Trunks" <xref target="I-D.ietf-asap-sip-auto-peer"/>. target="I-D.ietf-asap-sip-auto-peer" format="default"/>.
      </t>
    </section>
  </middle>
  <back>

<displayreference target="I-D.ietf-asap-sip-auto-peer" to="SIP-AUTO-PEER"/>

    <references>
      <name>References</name>
      <references>
        <name>Normative References</name>
        <xi:include href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.8288.xml"/>
      </references>
      <references>
        <name>Informative References</name>

<!-- [I-D.ietf-asap-sip-auto-peer] IESG state I-D Exists -->

<xi:include href="https://bib.ietf.org/public/rfc/bibxml3/reference.I-D.ietf-asap-sip-auto-peer.xml"/>

        <xi:include href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.3261.xml"/>
        <xi:include href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.3986.xml"/>
        <xi:include href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.6749.xml"/>
        <xi:include href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.7033.xml"/>
      </references>
    </references>
    <section title="Acknowledgements" anchor="acknowledgements"> anchor="acknowledgements" numbered="false" toc="default">
      <name>Acknowledgements</name>
      <t>
            This document resulted from the discussions in the ASAP working group, Working Group, especially the detailed and thoughtful comments of Paul Jones, Marc Petit-Huguenin, Mark Nottingham, Cullen Jennings, Jonathan Rosenberg, Jon Peterson, Chris Wendt, Jean Mahoney, and Murray Kucherawy. <contact fullname="Paul Jones"/>, <contact fullname="Marc Petit-Huguenin"/>, <contact fullname="Mark Nottingham"/>, <contact fullname="Cullen Jennings"/>, <contact fullname="Jonathan Rosenberg"/>, <contact fullname="Jon Peterson"/>, <contact fullname="Chris Wendt"/>, <contact fullname="Jean Mahoney"/>, and <contact fullname="Murray Kucherawy"/>. Additional thanks to Joe Clarke, Tim Bray, Christopher Wood, Dan Romascanu, David Dong, Eric Vyncke, Robert Wilton, and Lars Eggert <contact fullname="Joe Clarke"/>, <contact fullname="Tim Bray"/>, <contact fullname="Christopher Wood"/>, <contact fullname="Dan Romascanu"/>, <contact fullname="David Dong"/>, <contact fullname="Éric Vyncke"/>, <contact fullname="Robert Wilton"/>, and <contact fullname="Lars Eggert"/> for their reviews and feedback.
      </t>
    </section>
	</middle>
	<back>
	<references title="Normative References">
   	&RFC8288;
   </references>
   <references title="Informative References">
      <reference anchor="I-D.ietf-asap-sip-auto-peer" target="https://datatracker.ietf.org/doc/html/draft-ietf-asap-sip-auto-peer">
         <front>
            <title>Automatic Peering for SIP Trunks</title>
            <author initials="K." surname="Inamdar" fullname="K. Inamdar">
              <organization/>
            </author>
            <author initials="S." surname="Narayanan" fullname="S. Narayanan">
              <organization/>
            </author>
            <author initials="C." surname="Jennings" fullname="C. Jennings">
              <organization/>
            </author>
            <date year="2021" month="October"/>
            <abstract>
              <t>
               This draft specifies a configuration workflow to enable enterprise SIP networks to solicit the capability set document of an ITSP network.  The capability set document can subsequently be used to configure features and services on the enterprise edge element, such as a Session Border Controller (SBC), to ensure smooth peering between enterprise and ITSP networks.
              </t>
            </abstract>
          </front>
        </reference>
        &RFC3261;
        &RFC3986;
        &RFC6749;
        &RFC7033;

   </references>

  </back>
</rfc>