rfc9409.original | rfc9409.txt | |||
---|---|---|---|---|
Network Working Group K. Inamdar | Internet Engineering Task Force (IETF) K. Inamdar | |||
Internet-Draft Unaffiliated | Request for Comments: 9409 Unaffiliated | |||
Intended status: Informational S. Narayanan | Category: Informational S. Narayanan | |||
Expires: 9 November 2023 D. Engi | ISSN: 2070-1721 D. Engi | |||
G. Salgueiro | G. Salgueiro | |||
Cisco | Cisco | |||
8 May 2023 | July 2023 | |||
The 'sip-trunking-capability' Link Relation Type | The 'sip-trunking-capability' Link Relation Type | |||
draft-ietf-asap-siptrunkingcapability-link-05 | ||||
Abstract | Abstract | |||
This informational document defines the 'sip-trunking-capability' | This Informational document defines the 'sip-trunking-capability' | |||
link relation type that may be used by an enterprise telephony | link relation type that may be used by an enterprise telephony | |||
Session Initiation Protocol (SIP) network to retrieve a SIP trunking | Session Initiation Protocol (SIP) network to retrieve a SIP trunking | |||
capability set document, which contains the capabilities and | capability set document, which contains the capabilities and | |||
configuration requirements of an Internet Telephony Service Provider | configuration requirements of an Internet Telephony Service Provider | |||
(ITSP). These technical requirements allow for seamless peering | (ITSP). These technical requirements allow for seamless peering | |||
between SIP-based enterprise telephony networks and the ITSP. | between SIP-based enterprise telephony networks and the ITSP. | |||
Status of This Memo | Status of This Memo | |||
This Internet-Draft is submitted in full conformance with the | This document is not an Internet Standards Track specification; it is | |||
provisions of BCP 78 and BCP 79. | published for informational purposes. | |||
Internet-Drafts are working documents of the Internet Engineering | ||||
Task Force (IETF). Note that other groups may also distribute | ||||
working documents as Internet-Drafts. The list of current Internet- | ||||
Drafts is at https://datatracker.ietf.org/drafts/current/. | ||||
Internet-Drafts are draft documents valid for a maximum of six months | This document is a product of the Internet Engineering Task Force | |||
and may be updated, replaced, or obsoleted by other documents at any | (IETF). It represents the consensus of the IETF community. It has | |||
time. It is inappropriate to use Internet-Drafts as reference | received public review and has been approved for publication by the | |||
material or to cite them other than as "work in progress." | Internet Engineering Steering Group (IESG). Not all documents | |||
approved by the IESG are candidates for any level of Internet | ||||
Standard; see Section 2 of RFC 7841. | ||||
This Internet-Draft will expire on 9 November 2023. | Information about the current status of this document, any errata, | |||
and how to provide feedback on it may be obtained at | ||||
https://www.rfc-editor.org/info/rfc9409. | ||||
Copyright Notice | Copyright Notice | |||
Copyright (c) 2023 IETF Trust and the persons identified as the | Copyright (c) 2023 IETF Trust and the persons identified as the | |||
document authors. All rights reserved. | document authors. All rights reserved. | |||
This document is subject to BCP 78 and the IETF Trust's Legal | This document is subject to BCP 78 and the IETF Trust's Legal | |||
Provisions Relating to IETF Documents (https://trustee.ietf.org/ | Provisions Relating to IETF Documents | |||
license-info) in effect on the date of publication of this document. | (https://trustee.ietf.org/license-info) in effect on the date of | |||
Please review these documents carefully, as they describe your rights | publication of this document. Please review these documents | |||
and restrictions with respect to this document. Code Components | carefully, as they describe your rights and restrictions with respect | |||
extracted from this document must include Revised BSD License text as | to this document. Code Components extracted from this document must | |||
described in Section 4.e of the Trust Legal Provisions and are | include Revised BSD License text as described in Section 4.e of the | |||
provided without warranty as described in the Revised BSD License. | Trust Legal Provisions and are provided without warranty as described | |||
in the Revised BSD License. | ||||
Table of Contents | Table of Contents | |||
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 | 1. Introduction | |||
2. The 'sip-trunking-capability' Link Relation Type . . . . . . 2 | 2. The 'sip-trunking-capability' Link Relation Type | |||
3. Example Usage . . . . . . . . . . . . . . . . . . . . . . . . 3 | 3. Example Usage | |||
4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 4 | 4. IANA Considerations | |||
5. Security Considerations . . . . . . . . . . . . . . . . . . . 4 | 5. Security Considerations | |||
6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 4 | 6. References | |||
7. References . . . . . . . . . . . . . . . . . . . . . . . . . 4 | 6.1. Normative References | |||
7.1. Normative References . . . . . . . . . . . . . . . . . . 4 | 6.2. Informative References | |||
7.2. Informative References . . . . . . . . . . . . . . . . . 4 | Acknowledgements | |||
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 5 | Authors' Addresses | |||
1. Introduction | 1. Introduction | |||
RFC 8288 [RFC8288] defines a way of indicating relationships between | RFC 8288 [RFC8288] defines a way to indicate relationships between | |||
resources on the Web. This document specifies the 'sip-trunking- | resources on the Web. This document specifies the 'sip-trunking- | |||
capability' link relation type according to the rules of RFC 8288. | capability' link relation type according to the rules of RFC 8288. | |||
Links with this relationship type can be used to exchange capability | Links with this relationship type can be used to exchange capability | |||
information between potential peer devices. In the event that | information between potential peer devices. In the event that | |||
systems require additional parameters and configuration to negotiate | systems require additional parameters and configuration to negotiate | |||
communication, a well-known URI can be utilized to deliver | communication, a well-known URI can be utilized to deliver | |||
information to potential peers including machine-readable | information to potential peers, including machine-readable | |||
instructions and parameters needed for peering. | instructions and parameters needed for peering. | |||
The 'sip-trunking-capability' link relation type may be used on web | The 'sip-trunking-capability' link relation type may be used on web | |||
resources hosted by ITSPs to provide a structured and detailed | resources hosted by ITSPs to provide a structured and detailed | |||
capability set document. The capability set document | capability set document. The capability set document [SIP-AUTO-PEER] | |||
[I-D.ietf-asap-sip-auto-peer] encapsulates a set of characteristics | encapsulates a set of characteristics of an ITSP, which when | |||
of an ITSP, which when retrieved by enterprise telephony network | retrieved by enterprise telephony network devices allows for | |||
devices allows for automated establishment of SIP [RFC3261] trunking | automated establishment of SIP [RFC3261] trunking between the two | |||
between the two telephony networks. | telephony networks. | |||
2. The 'sip-trunking-capability' Link Relation Type | 2. The 'sip-trunking-capability' Link Relation Type | |||
A capability set document is hosted via web resources by the ITSP. A | A capability set document is hosted via web resources by the ITSP. A | |||
unique location of the document can be preconfigured and provided to | unique location of the document can be preconfigured and provided to | |||
each peer by the ITSP, or a centrally published resource can be used | each peer by the ITSP, or a centrally published resource can be used | |||
that dynamically generates the capability set document based on | that dynamically generates the capability set document based on one | |||
Uniform Resource Identifier(s) [RFC3986] determined by the peering | or more Uniform Resource Identifiers (URIs) [RFC3986] determined by | |||
device. The capability set document describes the configuration | the peering device. The capability set document describes the | |||
parameters required to successfully establish SIP trunking between an | configuration parameters required to successfully establish SIP | |||
enterprise and an ITSP network. The capability set document is | trunking between an enterprise and an ITSP network. The capability | |||
composed of structured and machine-readable parameters that can be | set document is composed of structured and machine-readable | |||
converted into configuration data to meet the communication | parameters that can be converted into configuration data to meet the | |||
requirements of the ITSP. The need for an enterprise telephony | communication requirements of the ITSP. The need for an enterprise | |||
network to obtain a capability set document from an ITSP is | telephony network to obtain a capability set document from an ITSP is | |||
documented in Automatic Peering for SIP Trunks | documented in "Automatic Peering for SIP Trunks" [SIP-AUTO-PEER]. | |||
[I-D.ietf-asap-sip-auto-peer]. | ||||
3. Example Usage | 3. Example Usage | |||
This section provides an example of possible use of the 'sip- | This section provides an example of possible use of the 'sip- | |||
trunking-capability' relation type. The enterprise network device | trunking-capability' relation type. The enterprise network device | |||
solicits the location of the capability set document from the well- | solicits the location of the capability set document from the well- | |||
known URI hosted by the ITSP using the WebFinger protocol [RFC7033]. | known URI hosted by the ITSP using the WebFinger protocol [RFC7033]. | |||
The following examples include line-breaks and indentation for | The following examples include line breaks and indentation for | |||
clarity. | clarity. | |||
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 | |||
The capability set document location is returned to the network | The location of the capability set document is returned to the | |||
device in the "href" attribute. | network device in the "href" attribute. | |||
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" | |||
} | } | |||
] | ] | |||
} | } | |||
The ITSP may use an authentication framework such as OAuth 2.0 | The ITSP may use an authentication framework such as OAuth 2.0 | |||
[RFC6749] to determine the identity of the enterprise telephony | [RFC6749] to determine the identity of the enterprise telephony | |||
network in order to provide the appropriate capability set document. | network to provide the appropriate capability set document. | |||
4. IANA Considerations | 4. IANA Considerations | |||
IANA has registered the 'sip-trunking-capability' link relation under | IANA has registered the 'sip-trunking-capability' link relation under | |||
the "Link Relation Types" registry, with a reference to this | the "Link Relation Types" registry as follows: | |||
document, using the following template: | ||||
Relation Name: sip-trunking-capability | Relation Name: sip-trunking-capability | |||
Description: Refers to a capability set document that defines | Description: Refers to a capability set document that defines | |||
parameters or configuration requirements for automated peering and | parameters or configuration requirements for automated peering and | |||
communication channel negotiation of the Session Initiation | communication-channel negotiation of the Session Initiation | |||
Protocol (SIP). | Protocol (SIP). | |||
Reference: RFCXXXX | Reference: RFC 9409 | |||
[[NOTE TO RFC EDITOR: Please change XXXX to the number assigned to | ||||
this specification, and remove this paragraph on publication.]] | ||||
5. Security Considerations | 5. Security Considerations | |||
The 'sip-trunking-capability' relation type is not known to introduce | The 'sip-trunking-capability' relation type is not known to introduce | |||
any new security issues not already discussed in RFC 8288 for generic | any new security issues not already discussed in RFC 8288 for generic | |||
use of web linking mechanisms. However, it is recommended to | use of web-linking mechanisms. However, it is recommended to | |||
exercise caution when publishing potentially sensitive capability | exercise caution when publishing potentially sensitive capability | |||
information over unencrypted or unauthenticated channels. Additional | information over unencrypted or unauthenticated channels. Additional | |||
security recommendations are outlined in the capability set document | security recommendations are outlined in the capability set document | |||
definition. See Security Considerations section in Automatic Peering | definition. See the Security Considerations section in "Automatic | |||
for SIP Trunks [I-D.ietf-asap-sip-auto-peer]. | Peering for SIP Trunks" [SIP-AUTO-PEER]. | |||
6. Acknowledgements | ||||
This document resulted from the discussions in the ASAP 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. Additional thanks to Joe Clarke, Tim Bray, Christopher | ||||
Wood, Dan Romascanu, David Dong, Eric Vyncke, Robert Wilton, and Lars | ||||
Eggert for their reviews and feedback. | ||||
7. References | 6. References | |||
7.1. Normative References | 6.1. Normative References | |||
[RFC8288] Nottingham, M., "Web Linking", RFC 8288, | [RFC8288] Nottingham, M., "Web Linking", RFC 8288, | |||
DOI 10.17487/RFC8288, October 2017, | DOI 10.17487/RFC8288, October 2017, | |||
<https://www.rfc-editor.org/info/rfc8288>. | <https://www.rfc-editor.org/info/rfc8288>. | |||
7.2. Informative References | 6.2. Informative References | |||
[I-D.ietf-asap-sip-auto-peer] | ||||
Inamdar, K., Narayanan, S., and C. Jennings, "Automatic | ||||
Peering for SIP Trunks", October 2021, | ||||
<https://datatracker.ietf.org/doc/html/draft-ietf-asap- | ||||
sip-auto-peer>. | ||||
[RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, | [RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, | |||
A., Peterson, J., Sparks, R., Handley, M., and E. | A., Peterson, J., Sparks, R., Handley, M., and E. | |||
Schooler, "SIP: Session Initiation Protocol", RFC 3261, | Schooler, "SIP: Session Initiation Protocol", RFC 3261, | |||
DOI 10.17487/RFC3261, June 2002, | DOI 10.17487/RFC3261, June 2002, | |||
<https://www.rfc-editor.org/info/rfc3261>. | <https://www.rfc-editor.org/info/rfc3261>. | |||
[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform | [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform | |||
Resource Identifier (URI): Generic Syntax", STD 66, | Resource Identifier (URI): Generic Syntax", STD 66, | |||
RFC 3986, DOI 10.17487/RFC3986, January 2005, | RFC 3986, DOI 10.17487/RFC3986, January 2005, | |||
<https://www.rfc-editor.org/info/rfc3986>. | <https://www.rfc-editor.org/info/rfc3986>. | |||
[RFC6749] Hardt, D., Ed., "The OAuth 2.0 Authorization Framework", | [RFC6749] Hardt, D., Ed., "The OAuth 2.0 Authorization Framework", | |||
RFC 6749, DOI 10.17487/RFC6749, October 2012, | RFC 6749, DOI 10.17487/RFC6749, October 2012, | |||
<https://www.rfc-editor.org/info/rfc6749>. | <https://www.rfc-editor.org/info/rfc6749>. | |||
[RFC7033] Jones, P., Salgueiro, G., Jones, M., and J. Smarr, | [RFC7033] Jones, P., Salgueiro, G., Jones, M., and J. Smarr, | |||
"WebFinger", RFC 7033, DOI 10.17487/RFC7033, September | "WebFinger", RFC 7033, DOI 10.17487/RFC7033, September | |||
2013, <https://www.rfc-editor.org/info/rfc7033>. | 2013, <https://www.rfc-editor.org/info/rfc7033>. | |||
[SIP-AUTO-PEER] | ||||
Inamdar, K., Narayanan, S., and C. F. Jennings, "Automatic | ||||
Peering for SIP Trunks", Work in Progress, Internet-Draft, | ||||
draft-ietf-asap-sip-auto-peer-07, 13 January 2023, | ||||
<https://datatracker.ietf.org/doc/html/draft-ietf-asap- | ||||
sip-auto-peer-07>. | ||||
Acknowledgements | ||||
This document resulted from the discussions in the ASAP 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. Additional thanks to Joe Clarke, Tim Bray, Christopher | ||||
Wood, Dan Romascanu, David Dong, Éric Vyncke, Robert Wilton, and Lars | ||||
Eggert for their reviews and feedback. | ||||
Authors' Addresses | Authors' Addresses | |||
Kaustubh Inamdar | Kaustubh Inamdar | |||
Unaffiliated | Unaffiliated | |||
Email: kaustubh.ietf@gmail.com | Email: kaustubh.ietf@gmail.com | |||
Sreekanth Narayanan | Sreekanth Narayanan | |||
Cisco | Cisco | |||
Email: sreenara@cisco.com | Email: sreenara@cisco.com | |||
Derek Engi | Derek Engi | |||
Cisco | Cisco | |||
Ann Arbor, MI | Ann Arbor, MI | |||
US | United States of America | |||
Phone: +1 919 392 7966 | Phone: +1 919 392 7966 | |||
Email: deengi@cisco.com | Email: deengi@cisco.com | |||
Gonzalo Salgueiro | Gonzalo Salgueiro | |||
Cisco | Cisco | |||
7200-12 Kit Creek Rd. | 7200-12 Kit Creek Rd. | |||
Research Triangle Park, NC 27709 | Research Triangle Park, NC 27709 | |||
US | United States of America | |||
Phone: +1 919 392 3266 | Phone: +1 919 392 3266 | |||
Email: gsalguei@cisco.com | Email: gsalguei@cisco.com | |||
End of changes. 29 change blocks. | ||||
102 lines changed or deleted | 98 lines changed or added | |||
This html diff was produced by rfcdiff 1.48. |