idnits 2.17.00 (12 Aug 2021) /tmp/idnits22255/draft-engi-siptrunkingcapability-link-00.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- -- The document date (March 2022) is 60 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Outdated reference: A later version (-05) exists of draft-ietf-asap-sip-auto-peer-04 Summary: 0 errors (**), 0 flaws (~~), 1 warning (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network Working Group K. Inamdar 3 Internet-Draft Unaffiliated 4 Intended status: Standards Track S. Narayanan 5 Expires: 28 September 2022 D. Engi 6 G. Salgueiro 7 Cisco 8 March 2022 10 The 'sipTrunkingCapability' Link Relation Type 11 draft-engi-siptrunkingcapability-link-00 13 Abstract 15 This specification defines the 'sipTrunkingCapabilities' link 16 relation type that may be used for the retrieval of capabilities and 17 configuration requirements from Internet Telephony Service Providers 18 (ITSPs). A Session Initiation Protocol (SIP) trunking capability set 19 is defined to allow the transfer of technical requirements needed for 20 seamless peering between SIP-based enterprise telephony networks and 21 ITSPs where an exchange of parameters and configuration information 22 is required. 24 Status of This Memo 26 This Internet-Draft is submitted in full conformance with the 27 provisions of BCP 78 and BCP 79. 29 Internet-Drafts are working documents of the Internet Engineering 30 Task Force (IETF). Note that other groups may also distribute 31 working documents as Internet-Drafts. The list of current Internet- 32 Drafts is at https://datatracker.ietf.org/drafts/current/. 34 Internet-Drafts are draft documents valid for a maximum of six months 35 and may be updated, replaced, or obsoleted by other documents at any 36 time. It is inappropriate to use Internet-Drafts as reference 37 material or to cite them other than as "work in progress." 39 This Internet-Draft will expire on 2 September 2022. 41 Copyright Notice 43 Copyright (c) 2022 IETF Trust and the persons identified as the 44 document authors. All rights reserved. 46 This document is subject to BCP 78 and the IETF Trust's Legal 47 Provisions Relating to IETF Documents (https://trustee.ietf.org/ 48 license-info) in effect on the date of publication of this document. 49 Please review these documents carefully, as they describe your rights 50 and restrictions with respect to this document. Code Components 51 extracted from this document must include Revised BSD License text as 52 described in Section 4.e of the Trust Legal Provisions and are 53 provided without warranty as described in the Revised BSD License. 55 Table of Contents 57 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 58 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 2 59 3. The 'sipTrunkingCapability' Link Relation Type . . . . . . . 3 60 4. Example Usage . . . . . . . . . . . . . . . . . . . . . . . . 3 61 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 4 62 6. Security Considerations . . . . . . . . . . . . . . . . . . . 4 63 7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 4 64 8. References . . . . . . . . . . . . . . . . . . . . . . . . . 4 65 8.1. Normative References . . . . . . . . . . . . . . . . . . 4 66 8.2. Informative Reference . . . . . . . . . . . . . . . . . . 5 67 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 5 69 1. Introduction 71 RFC 8288 [RFC8288] defined a way of indicating relationships between 72 resources on the Web. This document specifies the 73 'sipTrunkingCapability' link relation type according to the rules of 74 RFC 8288 [RFC8288]. Links with this relationship type can be used to 75 exchange capability information between potential peer devices. In 76 the event that systems require additional parameters and 77 configuration to negotiate communication, a well-known URI can be 78 utilized to deliver information to potential peers including machine- 79 readable instructions and parameters needed for peering. 81 The 'sipTrunkingCapability' link relation type may be used on web 82 resources hosted by Internet Telephony Service Providers (ITSPs) to 83 provide a structured and detailed capability set document. The 84 capability set document encapsulates a set of characteristics of an 85 ITSP, which when retrieved by enterprise telephony network devices 86 allows for automated establishment of Session Initiation Protocol 87 (SIP) trunking between the two telephony networks. 89 2. Terminology 91 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 92 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 93 document are to be interpreted as described in RFC 2119 [RFC2119]. 95 3. The 'sipTrunkingCapability' Link Relation Type 97 A capability set document is hosted via web resources by the ITSP. 98 The document describes the configuration parameters required to 99 successfully establish SIP trunking between an enterprise and service 100 provider SIP telephony network. The capability set document SHOULD 101 be comprised of structured and machine-readable parameters that could 102 be easily converted into configuration data to meet the communication 103 requirements of the service provider. 105 4. Example Usage 107 This section provides an example of possible use of the 108 'sipTrunkingCapability' relation type. The need for an enterprise 109 telephony network to obtain a capability set document from an 110 Internet Telephony Service Provider (ITSP) is documented in Automatic 111 Peering for SIP Trunks [I-D.ietf-asap-sip-auto-peer]. The 112 'sipTrunkingCapability' link relation type allows an enterprise 113 telephony network to specifically request the capability set document 114 from a web server hosted in the ITSP network. 116 The enterprise network device solicits the location of the capability 117 document from the well-known URI hosted by the SIP service provider 118 using the WebFinger protocol [RFC7033]. 120 GET /.well-known/webfinger? 121 resource=http%3A%2F%2Fssp1.example.com 122 rel=sipTrunkingCapability 123 HTTP/1.1 124 Host: ssp1.example.com 126 The capability set location is returned to the source device 127 referencing the URI that contains parameters for peering. 129 HTTP/1.1 200 OK 130 Access-Control-Allow-Origin: * 131 Content-Type: application/jrd+json 132 { 133 "subject" : "http://ssp1.example.com", 134 "links" : 135 [ 136 { 137 "rel" : "sipTrunkingCapability", 138 "href" :"https://capserver.ssp1.com/capserver/capdoc.json" 139 }, 140 ] 141 } 143 The ITSP may use an authentication framework such as Oauth2 to 144 determine the identity of the enterprise telephony network and 145 provide the appropriate capability set document. 147 5. IANA Considerations 149 IANA has registered the sipTrunkingCapability link relation under the 150 "Link Relation Types" Registry, with a reference to this document, 151 using the following template: 153 Relation Name: sipTrunkingCapability 155 Description: A capability document that defines parameters or 156 configuration requirements for automated peering and communication 157 channel negotiation of the Session Initiation Protocol (SIP). 159 Reference: RFCXXXX 161 [[NOTE TO RFC EDITOR: Please change XXXX to the number assigned to 162 this specification, and remove this paragraph on publication.]] 164 6. Security Considerations 166 The 'sipTrunkingCapability' relation type is not known to introduce 167 any new security issues not already discussed in RFC 8288 [RFC8288] 168 for generic use of web linking mechanisms. However, it is 169 recommended to exercise caution when publishing potentially sensitive 170 capability information over unencrypted or unauthenticated channels. 172 7. Acknowledgements 174 This document resulted from the discussions in the ASAP working 175 group, especially the detailed and thoughtful comments of Cullen 176 Jennings, Jonathan Rosenberg, Jon Peterson and Chris Wendt. 178 8. References 180 8.1. Normative References 182 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 183 Requirement Levels", BCP 14, RFC 2119, 184 DOI 10.17487/RFC2119, March 1997, 185 . 187 [RFC8288] Nottingham, M., "Web Linking", RFC 8288, 188 DOI 10.17487/RFC8288, October 2017, 189 . 191 8.2. Informative Reference 193 [I-D.ietf-asap-sip-auto-peer] 194 Inamdar, K., Narayanan, S., and C. Jennings, "Automatic 195 Peering for SIP Trunks", October 2021, 196 . 199 [RFC7033] Jones, P., Salgueiro, G., Jones, M., and J. Smarr, 200 "WebFinger", RFC 7033, DOI 10.17487/RFC7033, September 201 2013, . 203 Authors' Addresses 205 Kaustubh Inamdar 206 Unaffiliated 207 Email: kaustubh.ietf@gmail.com 209 Sreekanth Narayanan 210 Cisco 211 Email: sreenara@cisco.com 213 Derek Engi 214 Cisco 215 Ann Arbor, MI 216 US 217 Phone: +1 919 392 7966 218 Email: deengi@cisco.com 220 Gonzalo Salgueiro 221 Cisco 222 7200-12 Kit Creek Rd. 223 Research Triangle Park, NC 27709 224 US 225 Phone: +1 919 392 3266 226 Email: gsalguei@cisco.com