rfc9409xml2.original.xml   rfc9409.xml 
<?xml version='1.0' encoding='utf-8'?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
<!ENTITY RFC3261 SYSTEM "https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RF <!DOCTYPE rfc [
C.3261.xml"> <!ENTITY nbsp "&#160;">
<!ENTITY RFC8288 SYSTEM "https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RF <!ENTITY zwsp "&#8203;">
C.8288.xml"> <!ENTITY nbhy "&#8209;">
<!ENTITY RFC3986 SYSTEM "https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RF <!ENTITY wj "&#8288;">
C.3986.xml">
<!ENTITY RFC7033 SYSTEM "https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RF
C.7033.xml">
<!ENTITY RFC6749 SYSTEM "https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RF
C.6749.xml">
]> ]>
<?xml-stylesheet type='text/xsl' href='rfc2629.xslt' ?> <rfc xmlns:xi="http://www.w3.org/2001/XInclude" submissionType="IETF" category="
<!-- Generated by id2xml 1.5.0 on 2022-03-02T22:35:34Z --> info" consensus="true" docName="draft-ietf-asap-siptrunkingcapability-link-05" n
<?rfc strict="yes" ?> umber="9409" ipr="trust200902" xml:lang="en" obsoletes="" updates="" tocInclude=
<!-- give errors regarding ID-nits and DTD validation --> "true" tocDepth="4" symRefs="true" sortRefs="true" version="3">
<!-- 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 category="info" docName="draft-ietf-asap-siptrunkingcapability-link-05" ipr
="trust200902" xml:lang="en">
<front> <!-- xml2rfc v2v3 conversion 3.17.1 -->
<title abbrev="&quot;sip-trunking-capability&quot; Link Type"> <front>
<title abbrev="&quot;sip-trunking-capability&quot; Link Type">
The 'sip-trunking-capability' Link Relation Type The 'sip-trunking-capability' Link Relation Type
</title> </title>
<seriesInfo name="RFC" value="9409"/>
<author initials="K." surname="Inamdar" fullname="Kaustubh Inamdar"> <author initials="K." surname="Inamdar" fullname="Kaustubh Inamdar">
<organization>Unaffiliated</organization> <organization>Unaffiliated</organization>
<address> <address>
<email>kaustubh.ietf@gmail.com</email> <email>kaustubh.ietf@gmail.com</email>
<uri></uri> <uri/>
</address> </address>
</author> </author>
<author initials="S." surname="Narayanan" fullname="Sreekanth Narayanan">
<author initials="S." surname="Narayanan" fullname="Sreekanth Narayanan">
<organization>Cisco</organization> <organization>Cisco</organization>
<address> <address>
<email>sreenara@cisco.com</email> <email>sreenara@cisco.com</email>
<uri></uri> <uri/>
</address> </address>
</author> </author>
<author initials="D." surname="Engi" fullname="Derek Engi">
<author initials="D." surname="Engi" fullname="Derek Engi">
<organization>Cisco</organization> <organization>Cisco</organization>
<address><postal> <address>
<street>Ann Arbor, MI</street> <postal>
<street>US</street> <city>Ann Arbor</city>
</postal> <region>MI</region>
<phone>+1 919 392 7966</phone> <country>United States of America</country>
<email>deengi@cisco.com</email> </postal>
<uri></uri> <phone>+1 919 392 7966</phone>
<email>deengi@cisco.com</email>
<uri/>
</address> </address>
</author> </author>
<author initials="G." surname="Salgueiro" fullname="Gonzalo Salgueiro">
<author initials="G." surname="Salgueiro" fullname="Gonzalo Salgueiro">
<organization>Cisco</organization> <organization>Cisco</organization>
<address><postal><street>7200-12 Kit Creek Rd.</street> <address>
<street>Research Triangle Park, NC 27709</street> <postal>
<street>US</street> <street>7200-12 Kit Creek Rd.</street>
</postal> <city>Research Triangle Park</city>
<phone>+1 919 392 3266</phone> <region>NC</region>
<email>gsalguei@cisco.com</email> <code>27709</code>
<uri></uri> <country>United States of America</country>
</postal>
<phone>+1 919 392 3266</phone>
<email>gsalguei@cisco.com</email>
<uri/>
</address> </address>
</author> </author>
<date year="2023" month="July"/>
<date year="2023" month="May" day="8"/> <area>art</area>
<abstract><t> <workgroup>asap</workgroup>
This informational document defines the 'sip-trunking-capability' link rel
ation type that may be used by an enterprise telephony Session Initiation Protoc
ol (SIP) network to retrieve a SIP trunking capability set document, which conta
ins the capabilities and configuration requirements of an Internet Telephony Ser
vice Provider (ITSP). These technical requirements allow for seamless peering be
tween SIP-based enterprise telephony networks and the ITSP.</t>
</abstract>
</front>
<middle> <keyword>SIP</keyword>
<section title="Introduction" anchor="introduction"> <keyword>Session Initiation Protocol</keyword>
<keyword>automatic peering</keyword>
<keyword>WebFinger</keyword>
<keyword>capability set</keyword>
<abstract>
<t> <t>
RFC 8288 <xref target="RFC8288"/> defines a way of indicating relationship This Informational document defines the 'sip-trunking-capability' link rel
s between ation type that may be used by an enterprise telephony Session Initiation Protoc
ol (SIP) network to retrieve a SIP trunking capability set document, which conta
ins the capabilities and configuration requirements of an Internet Telephony Ser
vice Provider (ITSP). These technical requirements allow for seamless peering be
tween SIP-based enterprise telephony networks and the ITSP.</t>
</abstract>
</front>
<middle>
<section anchor="introduction" numbered="true" toc="default">
<name>Introduction</name>
<t>
RFC 8288 <xref target="RFC8288" format="default"/> defines a way to indica
te relationships between
resources on the Web. This document specifies the 'sip-trunking-capability' l ink resources on the Web. This document specifies the 'sip-trunking-capability' l ink
relation type according to the rules of RFC 8288. Links with this relationsh ip type can be used to exchange capability information between potential peer de vices. In the event that systems require additional parameters and configuration to negotiate communication, a well-known URI can be utilized to deliver informa tion to potential peers including machine-readable instructions and parameters n eeded for peering. relation type according to the rules of RFC 8288. Links with this relationsh ip type can be used to exchange capability information between potential peer de vices. In the event that systems require additional parameters and configuration to negotiate communication, a well-known URI can be utilized to deliver informa tion to potential peers, including machine-readable instructions and parameters needed for peering.
</t> </t>
<t>
<t> The 'sip-trunking-capability' link relation type may be used on web resour
The 'sip-trunking-capability' link relation type may be used on web resour ces hosted by ITSPs to provide a structured and detailed capability set document
ces 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" format
. The capability set document <xref target="I-D.ietf-asap-sip-auto-peer"/> enca ="default"/> encapsulates a set of characteristics of an ITSP, which when retrie
psulates a set of characteristics of an ITSP, which when retrieved by enterprise ved by enterprise telephony network devices allows for automated establishment o
telephony network devices allows for automated establishment of SIP <xref targe f SIP <xref target="RFC3261" format="default"/> trunking between the two telepho
t="RFC3261"/> trunking between the two telephony networks. ny networks.
</t> </t>
</section>
<section anchor="link-type" numbered="true" toc="default">
<name>The 'sip-trunking-capability' Link Relation Type</name>
<t>
A capability set document is hosted via web resources by the ITSP. A u
nique 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 genera
tes the capability set document based on one or more Uniform Resource Identifier
s (URIs) <xref target="RFC3986" format="default"/> determined by the peering dev
ice. The capability set document describes the configuration parameters require
d to successfully establish SIP trunking between an enterprise and an ITSP netwo
rk. The capability set document is composed of structured and machine-readable
parameters that can be converted into configuration data to meet the communicati
on requirements of the ITSP. The need for an enterprise telephony network to ob
tain a capability set document from an ITSP is documented in "Automatic Peering
for SIP Trunks" <xref target="I-D.ietf-asap-sip-auto-peer" format="default"/>.
</t>
</section>
<section anchor="examples" numbered="true" toc="default">
<name>Example Usage</name>
<t>
This section provides an example of possible use of the 'sip-trunkin
g-capability' relation type. The enterprise network device solicits the locatio
n of the capability set document from the well-known URI hosted by the ITSP usin
g the WebFinger protocol <xref target="RFC7033" format="default"/>. The followin
g examples include line breaks and indentation for clarity.
</t>
<artwork name="" type="" align="left" alt=""><![CDATA[
</section>
<section title="The 'sip-trunking-capability' Link Relation Type" anchor=
"link-type">
<t>
A capability set document is hosted via web resources by the ITSP. A u
nique 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 genera
tes the capability set document based on Uniform Resource Identifier(s) <xref ta
rget="RFC3986"/> determined by the peering device. The capability set document
describes the configuration parameters required to successfully establish SIP tr
unking between an enterprise and an ITSP network. The capability set document i
s composed of structured and machine-readable parameters that can be converted i
nto configuration data to meet the communication requirements of the ITSP. The
need for an enterprise telephony network to obtain a capability set document fro
m an ITSP is documented in Automatic Peering for SIP Trunks <xref target="I-D.ie
tf-asap-sip-auto-peer"/>.
</t>
</section>
<section title="Example Usage" anchor="examples">
<t>
This section provides an example of possible use of the 'sip-trunkin
g-capability' relation type. The enterprise network device solicits the locatio
n of the capability set document from the well-known URI hosted by the ITSP usin
g the WebFinger protocol <xref target="RFC7033"/>. The following examples includ
e line-breaks and indentation for clarity.
</t>
<figure>
<artwork>
<![CDATA[
GET /.well-known/webfinger? GET /.well-known/webfinger?
resource=acct%3Atrunkent1456%40example.com& resource=acct%3Atrunkent1456%40example.com&
rel=sip-trunking-capability rel=sip-trunking-capability
HTTP/1.1 HTTP/1.1
Host: ssp1.example.com Host: ssp1.example.com
]]>
</artwork> ]]></artwork>
</figure> <t>
<t> The location of the capability set document is returned to the netwo
The capability set document location is returned to the network devi rk device in the "href" attribute.
ce in the "href" attribute. </t>
</t> <artwork name="" type="" align="left" alt=""><![CDATA[
<figure>
<artwork>
<![CDATA[
HTTP/1.1 200 OK HTTP/1.1 200 OK
Access-Control-Allow-Origin: * Access-Control-Allow-Origin: *
Content-Type: application/jrd+json Content-Type: application/jrd+json
{ {
"subject" : "acct:trunkent1456@example.com", "subject" : "acct:trunkent1456@example.com",
"links" : "links" :
[ [
{ {
"rel" : "sip-trunking-capability", "rel" : "sip-trunking-capability",
"href" :"https://capserver.ssp1.example.com/capserver/capdoc.json" "href" : "https://capserver.ssp1.example.com/capdoc.json"
} }
] ]
} }
]]>
</artwork>
</figure>
<t> ]]></artwork>
The ITSP may use an authentication framework such as OAuth 2.0 <xref ta <t>
rget="RFC6749"/> to determine the identity of the enterprise telephony network i The ITSP may use an authentication framework such as OAuth 2.0 <xref ta
n order to provide the appropriate capability set document. rget="RFC6749" format="default"/> to determine the identity of the enterprise te
</t> lephony network to provide the appropriate capability set document.
</t>
</section> </section>
<section anchor="iana" numbered="true" toc="default">
<section title="IANA Considerations" anchor="iana"> <name>IANA Considerations</name>
<t>IANA has registered the 'sip-trunking-capability' link relation under <t>IANA has registered the 'sip-trunking-capability' link relation under t
the "Link Relation Types" registry, with a reference to this document, using th he "Link Relation Types" registry as follows:</t>
e following template:</t> <dl newline="false" spacing="normal">
<t><list style="hanging"> <dt>Relation Name:</dt>
<t hangText="Relation Name:">sip-trunking-capability</t> <dd>sip-trunking-capability</dd>
<dt>Description:</dt>
<dd>Refers to a capability set document that defines parameters or confi
guration requirements for automated peering and communication-channel negotiatio
n of the Session Initiation Protocol (SIP).</dd>
<dt>Reference:</dt>
<dd>RFC 9409</dd>
</dl>
</section>
<section anchor="security" numbered="true" toc="default">
<name>Security Considerations</name>
<t>
The 'sip-trunking-capability' relation type is not known to introduc
e any new security issues not already discussed in RFC 8288 for generic use of w
eb-linking mechanisms. However, it is recommended to exercise caution when publ
ishing potentially sensitive capability information over unencrypted or unauthen
ticated channels. Additional security recommendations are outlined in the capabi
lity set document definition. See the <xref target="I-D.ietf-asap-sip-auto-peer"
sectionFormat="bare" section="Security Considerations" relative="#name-security
-considerations" format="default"/> section in "Automatic Peering for SIP Trunks
" <xref target="I-D.ietf-asap-sip-auto-peer" format="default"/>.
</t>
</section>
</middle>
<back>
<t hangText="Description:">Refers to a capability set document that <displayreference target="I-D.ietf-asap-sip-auto-peer" to="SIP-AUTO-PEER"/>
defines parameters or configuration requirements for automated peering and commu
nication 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 as
signed to this specification, and remove this paragraph on publication.]]</t>
</list></t>
</section> <references>
<name>References</name>
<references>
<name>Normative References</name>
<xi:include href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.8
288.xml"/>
</references>
<references>
<name>Informative References</name>
<section title="Security Considerations" anchor="security"> <!-- [I-D.ietf-asap-sip-auto-peer] IESG state I-D Exists -->
<t>
The 'sip-trunking-capability' relation type is not known to introduc
e any new security issues not already discussed in RFC 8288 for generic use of w
eb linking mechanisms. However, it is recommended to exercise caution when publ
ishing potentially sensitive capability information over unencrypted or unauthen
ticated channels. Additional security recommendations are outlined in the capabi
lity set document definition. See <xref target="I-D.ietf-asap-sip-auto-peer" sec
tionFormat="bare" section="Security Considerations" relative="https://datatracke
r.ietf.org/doc/html/draft-ietf-asap-sip-auto-peer#name-security-considerations"
/> section in Automatic Peering for SIP Trunks <xref target="I-D.ietf-asap-sip-a
uto-peer"/>.
</t>
</section> <xi:include href="https://bib.ietf.org/public/rfc/bibxml3/reference.I-D.ietf-asa p-sip-auto-peer.xml"/>
<section title="Acknowledgements" anchor="acknowledgements"> <xi:include href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.3
<t> 261.xml"/>
This document resulted from the discussions in the ASAP working grou <xi:include href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.3
p, especially the detailed and thoughtful comments of Paul Jones, Marc Petit-Hug 986.xml"/>
uenin, Mark Nottingham, Cullen Jennings, Jonathan Rosenberg, Jon Peterson, Chris <xi:include href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.6
Wendt, Jean Mahoney, and Murray Kucherawy. Additional thanks to Joe Clarke, Tim 749.xml"/>
Bray, Christopher Wood, Dan Romascanu, David Dong, Eric Vyncke, Robert Wilton, <xi:include href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.7
and Lars Eggert for their reviews and feedback. 033.xml"/>
</t> </references>
</section> </references>
</middle> <section anchor="acknowledgements" numbered="false" toc="default">
<back> <name>Acknowledgements</name>
<references title="Normative References"> <t>
&RFC8288; This document resulted from the discussions in the ASAP Working Grou
</references> p, especially the detailed and thoughtful comments of <contact fullname="Paul Jo
<references title="Informative References"> nes"/>, <contact fullname="Marc Petit-Huguenin"/>, <contact fullname="Mark Notti
<reference anchor="I-D.ietf-asap-sip-auto-peer" target="https://datatracke ngham"/>, <contact fullname="Cullen Jennings"/>, <contact fullname="Jonathan Ros
r.ietf.org/doc/html/draft-ietf-asap-sip-auto-peer"> enberg"/>, <contact fullname="Jon Peterson"/>, <contact fullname="Chris Wendt"/>
<front> , <contact fullname="Jean Mahoney"/>, and <contact fullname="Murray Kucherawy"/>
<title>Automatic Peering for SIP Trunks</title> . Additional thanks to <contact fullname="Joe Clarke"/>, <contact fullname="Tim
<author initials="K." surname="Inamdar" fullname="K. Inamdar"> Bray"/>, <contact fullname="Christopher Wood"/>, <contact fullname="Dan Romascan
<organization/> u"/>, <contact fullname="David Dong"/>, <contact fullname="Éric Vyncke"/>, <cont
</author> act fullname="Robert Wilton"/>, and <contact fullname="Lars Eggert"/> for their
<author initials="S." surname="Narayanan" fullname="S. Narayanan"> reviews and feedback.
<organization/> </t>
</author> </section>
<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 enterpris
e SIP networks to solicit the capability set document of an ITSP network. The c
apability set document can subsequently be used to configure features and servic
es 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> </back>
</rfc> </rfc>
 End of changes. 29 change blocks. 
222 lines changed or deleted 193 lines changed or added

This html diff was produced by rfcdiff 1.48.