idnits 2.17.1 draft-ietf-drinks-spp-framework-06.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 copyright year in the IETF Trust and authors Copyright Line does not match the current year == The document seems to use 'NOT RECOMMENDED' as an RFC 2119 keyword, but does not include the phrase in its RFC 2119 key words list. == Using lowercase 'not' together with uppercase 'MUST', 'SHALL', 'SHOULD', or 'RECOMMENDED' is not an accepted usage according to RFC 2119. Please use uppercase 'NOT' together with RFC 2119 keywords (if that is what you mean). Found 'MUST not' in this paragraph: o Response types "Attribute value invalid" and "Object does not exist" MUST not be used interchangeably. Response type "Object does not exist" MUST be returned by an Update/Del/Accept/Reject operation when the data element(s) used to uniquely identify a pre-existing object do not exist. If the data elements used to uniquely identify an object are malformed, then response type "Attribute value invalid" MUST be returned. -- The document date (October 21, 2013) is 3833 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) == Unused Reference: 'RFC3403' is defined on line 2449, but no explicit reference was found in the text == Unused Reference: 'RFC5321' is defined on line 2466, but no explicit reference was found in the text ** Downref: Normative reference to an Informational RFC: RFC 4949 ** Downref: Normative reference to an Informational RFC: RFC 5067 ** Obsolete normative reference: RFC 5226 (Obsoleted by RFC 8126) -- Obsolete informational reference (is this intentional?): RFC 2616 (Obsoleted by RFC 7230, RFC 7231, RFC 7232, RFC 7233, RFC 7234, RFC 7235) -- Obsolete informational reference (is this intentional?): RFC 3761 (Obsoleted by RFC 6116, RFC 6117) -- Obsolete informational reference (is this intentional?): RFC 5246 (Obsoleted by RFC 8446) Summary: 3 errors (**), 0 flaws (~~), 5 warnings (==), 4 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 DRINKS K. Cartwright 3 Internet-Draft V. Bhatia 4 Intended status: Standards Track TNS 5 Expires: April 24, 2014 S. Ali 6 NeuStar 7 D. Schwartz 8 XConnect 9 October 21, 2013 11 Session Peering Provisioning Framework (SPPF) 12 draft-ietf-drinks-spp-framework-06 14 Abstract 16 This document specifies the data model and the overall structure for 17 a framework to provision session establishment data into Session Data 18 Registries and SIP Service Provider data stores. The framework is 19 called the Session Peering Provisioning Framework (SPPF). The 20 provisioned data is typically used by network elements for session 21 establishment. 23 Status of This Memo 25 This Internet-Draft is submitted in full conformance with the 26 provisions of BCP 78 and BCP 79. 28 Internet-Drafts are working documents of the Internet Engineering 29 Task Force (IETF). Note that other groups may also distribute 30 working documents as Internet-Drafts. The list of current Internet- 31 Drafts is at http://datatracker.ietf.org/drafts/current/. 33 Internet-Drafts are draft documents valid for a maximum of six months 34 and may be updated, replaced, or obsoleted by other documents at any 35 time. It is inappropriate to use Internet-Drafts as reference 36 material or to cite them other than as "work in progress." 38 This Internet-Draft will expire on April 24, 2014. 40 Copyright Notice 42 Copyright (c) 2013 IETF Trust and the persons identified as the 43 document authors. All rights reserved. 45 This document is subject to BCP 78 and the IETF Trust's Legal 46 Provisions Relating to IETF Documents 47 (http://trustee.ietf.org/license-info) in effect on the date of 48 publication of this document. Please review these documents 49 carefully, as they describe your rights and restrictions with respect 50 to this document. Code Components extracted from this document must 51 include Simplified BSD License text as described in Section 4.e of 52 the Trust Legal Provisions and are provided without warranty as 53 described in the Simplified BSD License. 55 Table of Contents 57 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 58 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 6 59 3. Framework High Level Design . . . . . . . . . . . . . . . . . 7 60 3.1. Framework Data Model . . . . . . . . . . . . . . . . . . 7 61 3.2. Time Value . . . . . . . . . . . . . . . . . . . . . . . 10 62 3.3. Extensibility . . . . . . . . . . . . . . . . . . . . . . 10 63 4. Transport Protocol Requirements . . . . . . . . . . . . . . . 11 64 4.1. Connection Oriented . . . . . . . . . . . . . . . . . . . 11 65 4.2. Request and Response Model . . . . . . . . . . . . . . . 11 66 4.3. Connection Lifetime . . . . . . . . . . . . . . . . . . . 11 67 4.4. Authentication . . . . . . . . . . . . . . . . . . . . . 11 68 4.5. Authorization . . . . . . . . . . . . . . . . . . . . . . 11 69 4.6. Confidentiality and Integrity . . . . . . . . . . . . . . 12 70 4.7. Near Real Time . . . . . . . . . . . . . . . . . . . . . 12 71 4.8. Request and Response Sizes . . . . . . . . . . . . . . . 12 72 4.9. Request and Response Correlation . . . . . . . . . . . . 12 73 4.10. Request Acknowledgement . . . . . . . . . . . . . . . . . 12 74 4.11. Mandatory Transport . . . . . . . . . . . . . . . . . . . 13 75 5. Base Framework Data Structures and Response Codes . . . . . . 13 76 5.1. Basic Object Type and Organization Identifiers . . . . . 13 77 5.2. Various Object Key Types . . . . . . . . . . . . . . . . 13 78 5.2.1. Generic Object Key Type . . . . . . . . . . . . . . . 14 79 5.2.2. Derived Object Key Types . . . . . . . . . . . . . . 15 80 5.3. Response Message Types . . . . . . . . . . . . . . . . . 16 81 6. Framework Data Model Objects . . . . . . . . . . . . . . . . 18 82 6.1. Destination Group . . . . . . . . . . . . . . . . . . . . 19 83 6.2. Public Identifier . . . . . . . . . . . . . . . . . . . . 19 84 6.3. SED Group . . . . . . . . . . . . . . . . . . . . . . . . 24 85 6.4. SED Record . . . . . . . . . . . . . . . . . . . . . . . 28 86 6.5. SED Group Offer . . . . . . . . . . . . . . . . . . . . . 32 87 6.6. Egress Route . . . . . . . . . . . . . . . . . . . . . . 33 88 7. Framework Operations . . . . . . . . . . . . . . . . . . . . 35 89 7.1. Add Operation . . . . . . . . . . . . . . . . . . . . . . 35 90 7.2. Delete Operation . . . . . . . . . . . . . . . . . . . . 35 91 7.3. Get Operations . . . . . . . . . . . . . . . . . . . . . 36 92 7.4. Accept Operations . . . . . . . . . . . . . . . . . . . . 37 93 7.5. Reject Operations . . . . . . . . . . . . . . . . . . . . 37 94 7.6. Get Server Details Operation . . . . . . . . . . . . . . 38 95 8. XML Considerations . . . . . . . . . . . . . . . . . . . . . 38 96 8.1. Namespaces . . . . . . . . . . . . . . . . . . . . . . . 38 97 8.2. Versioning and Character Encoding . . . . . . . . . . . . 39 98 9. Security Considerations . . . . . . . . . . . . . . . . . . . 39 99 9.1. Confidentiality and Authentication . . . . . . . . . . . 39 100 9.2. Authorization . . . . . . . . . . . . . . . . . . . . . . 39 101 9.3. Denial of Service . . . . . . . . . . . . . . . . . . . . 40 102 9.3.1. DoS Issues Inherited from Transport Mechanism . . . . 40 103 9.3.2. DoS Issues Specific to SPPF . . . . . . . . . . . . . 41 104 9.4. Information Disclosure . . . . . . . . . . . . . . . . . 41 105 9.5. Non Repudiation . . . . . . . . . . . . . . . . . . . . . 42 106 9.6. Replay Attacks . . . . . . . . . . . . . . . . . . . . . 42 107 9.7. Man in the Middle . . . . . . . . . . . . . . . . . . . . 42 108 10. Internationalization Considerations . . . . . . . . . . . . . 42 109 11. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 43 110 11.1. URN Assignments . . . . . . . . . . . . . . . . . . . . 43 111 11.2. Organization Identifier Namespace Registry . . . . . . . 43 112 12. Formal Specification . . . . . . . . . . . . . . . . . . . . 43 113 13. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 52 114 14. References . . . . . . . . . . . . . . . . . . . . . . . . . 52 115 14.1. Normative References . . . . . . . . . . . . . . . . . . 52 116 14.2. Informative References . . . . . . . . . . . . . . . . . 53 117 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 54 119 1. Introduction 121 Service providers and enterprises use routing databases known as 122 registries to make session routing decisions for Voice over IP, SMS 123 and MMS traffic exchanges. This document is narrowly focused on the 124 provisioning framework for these registries. This framework 125 prescribes a way for an entity to provision session-related data into 126 a Registry. The data being provisioned can be optionally shared with 127 other participating peering entities. The requirements and use cases 128 driving this framework have been documented in [RFC6461]. 130 Three types of provisioning flows have been described in the use case 131 document: client to Registry, Registry to local data repository and 132 Registry to Registry. This document addresses client to Registry 133 flow enabling the need to provision Session Establishment Data (SED). 134 The framework that supports flow of messages to facilitate client to 135 Registry provisioning is referred to as Session Peering Provisioning 136 Framework (SPPF). 138 The role of the "client" and the "server" only applies to the 139 connection, and those roles are not related in any way to the type of 140 entity that participates in a protocol exchange. For example, a 141 Registry might also include a "client" when such a Registry initiates 142 a connection (for example, for data distribution to SSP). 144 *--------* *------------* *------------* 145 | | (1). Client | | (3).Registry | | 146 | Client | ------------> | Registry |<------------->| Registry | 147 | | to Registry | | to Registry | | 148 *--------* *------------* *------------* 149 / \ \ 150 / \ \ 151 / \ \ 152 / \ v 153 / \ ... 154 / \ 155 / (2). Distrib \ 156 / Registry data \ 157 / to local data \ 158 V store V 159 +----------+ +----------+ 160 |Local Data| |Local Data| 161 |Repository| |Repository| 162 +----------+ +----------+ 164 Three Registry Provisioning Flows 166 Figure 1 168 A "terminating" SIP Service Provider (SSP) provisions Session 169 Establishment Data or SED into the Registry to be selectively shared 170 with other peer SSPs. 172 SED is typically used by various downstream SIP signaling systems to 173 route a call to the next hop associated with the called domain. 174 These systems typically use a local data store ("Local Data 175 Repository") as their source of session routing information. More 176 specifically, the SED data is the set of parameters that the outgoing 177 signaling path border elements (SBEs) need to initiate the session. 178 See [RFC5486] for more details. 180 A Registry may distribute the provisioned data into local data 181 repositories or may additionally offer a central query resolution 182 service (not shown in the above figure) for query purposes. 184 A key requirement for the SPPF is to be able to accommodate two basic 185 deployment scenarios: 187 1. A resolution system returns a Look-Up Function (LUF) that 188 comprises the target domain to assist in call routing (as 189 described in [RFC5486]). In this case, the querying entity may 190 use other means to perform the Location Routing Function (LRF) 191 which in turn helps determine the actual location of the 192 Signaling Function in that domain. 194 2. A resolution system returns a Location Routing Function (LRF) 195 that comprises the location (address) of the signaling function 196 in the target domain (as described in [RFC5486]). 198 In terms of framework design, SPPF is agnostic to the transport 199 protocol. This document includes the specification of the data model 200 and identifies, but does not specify, the means to enable protocol 201 operations within a request and response structure. That aspect of 202 the specification has been delegated to the "protocol" specification 203 for the framework. To encourage interoperability, the framework 204 supports extensibility aspects. 206 In this document, XML schema is used to describe the building blocks 207 of the SPPF and to express the data types, the semantic relationships 208 between the various data types, and the various constraints as a 209 binding construct. However, the "protocol" specification is free to 210 choose any data representation format as long as it meets the 211 requirements laid out in the SPPF XML schema definition. As an 212 example, XML and JSON are two widely used data representation 213 formats. 215 This document is organized as follows: 217 o Section 2 provides the terminology 219 o Section 3 provides an overview of SPPF, including functional 220 entities and data model 222 o Section 4 specifies requirements for SPPF transport protocols 224 o Section 5 describes the base framework data structures, the 225 generic response types that MUST be supported by a conforming 226 transport "protocol" specification, and the basic object type most 227 first class objects extend from 229 o Section 6 provides a detailed description of the data model object 230 specifications 232 o Section 7 describes the operations that are supported by the data 233 model 235 o Section 8 defines XML considerations XML parsers must meet to 236 conform to this specification 238 o Sections 9 - 11 discuss security, internationalization and IANA 239 considerations 241 o Section 12 normatively defines the SPPF using its XML Schema 242 Definition. 244 2. Terminology 246 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 247 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 248 document are to be interpreted as described in [RFC2119]. 250 This document reuses terms from [RFC3261], [RFC5486], use cases and 251 requirements documented in [RFC6461] and the ENUM Validation 252 Architecture [RFC4725]. 254 In addition, this document specifies the following additional terms: 256 SPPF: Session Peering Provisioning Framework, the framework used by 257 a transport protocol to provision data into a Registry (see arrow 258 labeled "1." in Figure 1 of [RFC6461]). It is the primary scope 259 of this document. 261 Client: In the context of SPPF, this is an application that 262 initiates a provisioning request. It is sometimes referred to as 263 a "Registry client". 265 Server: In the context of SPPF, this is an application that 266 receives a provisioning request and responds accordingly. It is 267 sometimes referred to as a Registry. 269 Registry: The Registry operates a master database of Session 270 Establishment Data for one or more Registrants. 272 Registrant: The definition of a Registrant is based on [RFC4725]. 273 It is the end-user, the person or organization that is the 274 "holder" of the Session Establishment Data being provisioned into 275 the Registry by a Registrar. For example, in [RFC6461], a 276 Registrant is pictured as a SIP Service Provider in Figure 2. 278 Within the confines of a Registry, a Registrant is uniquely 279 identified by a well-known ID. 281 Registrar: The definition of a Registrar is based on [RFC4725]. It 282 is an entity that performs provisioning operations on behalf of a 283 Registrant by interacting with the Registry via SPPF operations. 284 In other words the Registrar is the SPPF Client. The Registrar 285 and Registrant roles are logically separate to allow, but not 286 require, a single Registrar to perform provisioning operations on 287 behalf of more than one Registrant. 289 Peering Organization: A Peering Organization is an entity to which 290 a Registrant's SED Groups are made visible using the operations of 291 SPPF. 293 3. Framework High Level Design 295 This section introduces the structure of the data model and provides 296 the information framework for the SPPF. The data model is defined 297 along with all the objects manipulated by a conforming transport 298 protocol and their relationships. 300 3.1. Framework Data Model 302 The data model illustrated and described in Figure 2 defines the 303 logical objects and the relationships between these objects supported 304 by SPPF. SPPF defines protocol operations through which an SPPF 305 client populates a Registry with these logical objects. SPPF clients 306 belonging to different Registrars may provision data into the 307 Registry using a conforming transport protocol that implements these 308 operations 310 The logical structure presented below is consistent with the 311 terminology and requirements defined in [RFC6461]. 313 +-------------+ +-----------------+ 314 | all object | |Egress Route: | 315 | types | 0..n | rant, | 316 +-------------+ +--| egrRteName, | 317 |0..n / | pref, | 318 | / | regxRewriteRule,| 319 |2 / | ingrSedGrp, | 320 +----------------------+ / | svcs | 321 |Organization: | / +-----------------+ 322 | orgId | / 323 +----------------------+ / 324 |0..n / 325 | / 326 |A SED Group is / 327 |associated with / 328 |zero or more / +---[abstract]----+ 329 |Peering / | SED Record: | 330 |Organizations / | rant, | 331 | / | sedName, |0..n 332 |0..n / | sedFunction, |------| 333 +--------+--------------+0..n 0..n| isInSvc, | | 334 |SED Group: |------------------| ttl | | 335 | rant, | +-----------------+ | 336 | sedGrpName, | ^ Various types | 337 | isInSvc, | | of SED Records | 338 | sedRecRef, | | | 339 | peeringOrg, | +-----+------------+ | 340 | sourceIdent, | | | | | 341 | priority, | +----+ +-------+ +----+ | 342 | dgName | | URI| | NAPTR | | NS | | 343 +-----------------------+ +----+ +-------+ +----+ | 344 |0..n | 345 | +-----[abstract]------+ | 346 |0..n |Public Identifier: | | 347 +----------------------+0..n 0..n| rant, | | 348 | Dest Group: |--------------| publicIdentifier, | | 349 | rant, | | dgName | | 350 | dgName | | | | 351 +----------------------+ +---------------------+ | 352 ^ Various types | 353 +---------+-------+------+----------+ of Public | 354 | | | | | Identifiers | 355 +------+ +-----+ +-----+ +-----+ +------+ | 356 | URI | | TNP | | TNR | | RN | | TN |-------------| 357 +------+ +-----+ +-----+ +-----+ +------+ 0..n 359 Figure 2 361 The objects and attributes that comprise the data model can be 362 described as follows (objects listed from the bottom up): 364 o Public Identifier: 365 From a broad perspective a public identifier is a well-known 366 attribute that is used as the key to perform resolution lookups. 367 Within the context of SPPF, a public identifier object can be a 368 Telephone Number (TN), a range of Telephone Numbers, a PSTN 369 Routing Number (RN), a TN prefix, or a URI. 371 An SPPF Public Identifier may be a member of zero or more 372 Destination Groups to create logical groupings of Public 373 Identifiers that share a common set of Session Establishment Data 374 (e.g. routes). 376 A TN Public Identifier may optionally be associated with zero or 377 more individual SED Records. This ability for a Public Identifier 378 to be directly associated with a SED Record, as opposed to forcing 379 membership in one or more Destination Groups, supports use cases 380 where the SED Record contains data specifically tailored to an 381 individual TN Public Identifier. 383 o Destination Group: 384 A named logical grouping of zero or more Public Identifiers that 385 can be associated with one or more SED Groups for the purpose of 386 facilitating the management of their common session establishment 387 information. 389 o SED Group: 390 A SED Group contains a set of SED Record references, a set of 391 Destination Group references, and a set of peering organization 392 identifiers. This is used to establish a three part relationships 393 between a set of Public Identifiers, the session establishment 394 information (SED) shared across these Public Identifiers, and the 395 list of peering organizations whose query responses from the 396 resolution system may include the session establishment 397 information contained in a given SED group. In addition, the 398 sourceIdent element within a SED Group, in concert with the set of 399 peering organization identifiers, enables fine-grained source 400 based routing. For further details about the SED Group and source 401 based routing, refer to the definitions and descriptions in 402 Section 6.1. 404 o SED Record: 405 A SED Record contains the data that a resolution system returns in 406 response to a successful query for a Public Identifier. SED 407 Records are generally associated with a SED Group when the SED 408 within is not specific to a Public Identifier. 410 To support the use cases defined in [RFC6461], SPPF framework 411 defines three type of SED Records: URIType, NAPTRType, and NSType. 412 These SED Records extend the abstract type SedRecType and inherit 413 the common attribute 'priority' that is meant for setting 414 precedence across the SED records defined within a SED Group in a 415 protocol agnostic fashion. 417 o Egress Route: 418 In a high-availability environment, the originating SSP likely has 419 more than one egress paths to the ingress SBE of the target SSP. 420 The Egress Route allows the originating SSP to choose a specific 421 egress SBE to be associated with the target ingress SBE. the 422 'svcs' element specifies ENUM services ((e.g.,E2U+pstn:sip+sip) 423 that are used to identify the SED records associated with the SED 424 Group that will be modified by the originating SSP. 426 o Organization: 427 An Organization is an entity that may fulfill any combination of 428 three roles: Registrant, Registrar, and Peering Organization. All 429 objects in SPPF are associated with two organization identifiers 430 to identify each object's Registrant and Registrar. A SED Group 431 object is also associated with a set of zero or more organization 432 identifiers that identify the peering organization(s) whose 433 resolution query responses may include the session establishment 434 information (SED) defined in the SED Records within that SED 435 Group. A peering organization is an entity that the Registrant 436 intends to share the SED data with. 438 3.2. Time Value 440 Some request and response messages in SPPF include time value(s) 441 defined as type xs:dateTime, a built-in W3C XML Schema Datatype. Use 442 of unqualified local time value is disallowed as it can lead to 443 interoperability issues. The value of time attribute MUST be 444 expressed in Coordinated Universal Time (UTC) format without the 445 timezone digits. 447 "2010-05-30T09:30:10Z" is an example of an acceptable time value for 448 use in SPPF messages. "2010-05-30T06:30:10+3:00" is a valid UTC 449 time, but it is not approved for use in SPPF messages. 451 3.3. Extensibility 453 The framework contains various points of extensibility in form of the 454 "ext" elements. Extensions used beyond the scope of private SPPF 455 installations MUST be documented in an RFC level document, and the 456 first such extension SHOULD define an IANA registry, holding a list 457 of documented extensions. 459 4. Transport Protocol Requirements 461 This section provides requirements for transport protocols suitable 462 for SPPF. More specifically, this section specifies the services, 463 features, and assumptions that SPPF framework delegates to the chosen 464 transport and envelope technologies. 466 4.1. Connection Oriented 468 The SPPF follows a model where a client establishes a connection to a 469 server in order to further exchange SPPF messages over such point-to- 470 point connection. A transport protocol for SPPF MUST therefore be 471 connection oriented. 473 4.2. Request and Response Model 475 Provisioning operations in SPPF follow the request-response model, 476 where a client sends a request message to initiate a transaction and 477 the server responds with a response. Multiple subsequent request- 478 response exchanges MAY be performed over a single persistent 479 connection. 481 Therefore, a transport protocol for SPPF MUST follow the request- 482 response model by allowing a response to be sent to the request 483 initiator. 485 4.3. Connection Lifetime 487 Some use cases involve provisioning a single request to a network 488 element. Connections supporting such provisioning requests might be 489 short-lived, and may be established only on demand. Other use cases 490 involve either provisioning a large dataset, or a constant stream of 491 small updates, either of which would likely require long-lived 492 connections. 494 Therefore, a protocol suitable for SPPF SHOULD be able to support 495 both short-lived as well as long-lived connections. 497 4.4. Authentication 499 All SPPF objects are associated with a Registrant identifier. An 500 SPPF Client provisions SPPF objects on behalf of Registrants. An 501 authenticated SPP Client is a Registrar. Therefore, the SPPF 502 transport protocol MUST provide means for an SPPF server to 503 authenticate an SPPF Client. 505 4.5. Authorization 506 After successful authentication of the SPPF client as a Registrar the 507 Registry performs authorization checks to determine if the Registrar 508 is authorized to act on behalf of the Registrant whose identifier is 509 included in the SPPF request. Refer to the Security Considerations 510 section for further guidance. 512 4.6. Confidentiality and Integrity 514 SPPF objects that the Registry manages can be private in nature. 515 Therefore, the transport protocol MUST provide means for end-to-end 516 encryption between the SPPF client and Registry. 518 If the data is compromised in-flight between the SPPF client and 519 Registry, it will seriously affect the stability and integrity of the 520 system. Therefore, the transport protocol MUST provide means for 521 data integrity protection. 523 4.7. Near Real Time 525 Many use cases require near real-time responses from the server. 526 Therefore, a DRINKS transport protocol MUST support near real-time 527 response to requests submitted by the client. 529 4.8. Request and Response Sizes 531 Use of SPPF may involve simple updates that may consist of small 532 number of bytes, such as, update of a single public identifier. 533 Other provisioning operations may constitute large number of dataset 534 as in adding millions records to a Registry. As a result, a suitable 535 transport protocol for SPPF SHOULD accommodate dataset of various 536 sizes. 538 4.9. Request and Response Correlation 540 A transport protocol suitable for SPPF MUST allow responses to be 541 correlated with requests. 543 4.10. Request Acknowledgement 545 Data transported in the SPPF is likely crucial for the operation of 546 the communication network that is being provisioned. A SPPF client 547 responsible for provisioning SED to the Registry has a need to know 548 if the submitted requests have been processed correctly. 550 Failed transactions can lead to situations where a subset of public 551 identifiers or even SSPs might not be reachable, or the provisioning 552 state of the network is inconsistent. 554 Therefore, a transport protocol for SPPF MUST provide a response for 555 each request, so that a client can identify whether a request 556 succeeded or failed. 558 4.11. Mandatory Transport 560 At the time of this writing, a choice of transport protocol has been 561 provided in SPP Protocol over SOAP document. To encourage 562 interoperability, the SPPF server MUST provide support for this 563 transport protocol. With time, it is possible that other transport 564 layer choices may surface that agree with the requirements discussed 565 above. 567 5. Base Framework Data Structures and Response Codes 569 SPPF contains some common data structures for most of the supported 570 object types. This section describes these common data structures. 572 5.1. Basic Object Type and Organization Identifiers 574 All first class objects extend the type BasicObjType. It consists of 575 the Registrant organization, the Registrar organization, the date and 576 time of object creation, and the last date and time the object was 577 updated. The Registry MUST store the date and time of the object 578 creation and update, if applicable, for all Get operations (see 579 Section 7). If the client passed in either date and time values, the 580 Registry MUST ignore it. The Registrar performs the SPPF operations 581 on behalf of the Registrant, the organization that owns the object. 583 584 585 586 587 588 589 590 591 593 The identifiers used for Registrants (rant) and Registrars (rar) are 594 instances of OrgIdType. The OrgIdType is defined as a string and all 595 OrgIdType instances MUST follow the textual convention: 596 "namespace:value" (for example "iana-en:32473"). See the IANA 597 Consideration section for more details. 599 5.2. Various Object Key Types 600 The SPPF data model contains various object relationships. In some 601 cases, these object relationships are established by embedding the 602 unique identity of the related object inside the relating object. 603 Note that an object's unique identity is required to Delete or Get 604 the details of an object. The following sub-sections normatively 605 define the various object keys in SPPF and the attributes of those 606 keys. 608 "Name" attributes that are used as components of object key types 609 MUST be treated case insensitive, more specifically, comparison 610 operations MUST use the toCasefold() function, as specified in 611 Section 3.13 of [Unicode6.1]. 613 5.2.1. Generic Object Key Type 615 Most objects in SPPF are uniquely identified by an object key that 616 has the object's name, object's type and its Registrant's 617 organization ID as its attributes. The abstract type called 618 ObjKeyType is where this unique identity is housed. Any concrete 619 representation of the ObjKeyType MUST contain the following: 621 Object Name: The name of the object. 623 Registrant Id: The unique organization ID that identifies the 624 Registrant. 626 Type: The value that represents the type of SPPF object that. 627 This is required as different types of objects in SPPF, that 628 belong to the same Registrant, can have the same name. 630 The structure of abstract ObjKeyType is as follows: 632 633 634 635 ---- Generic type that represents the 636 key for various objects in SPPF. ---- 637 638 639 641 5.2.2. Derived Object Key Types 643 The SPPF data model contains certain objects that are uniquely 644 identified by attributes, different from or in addition to, the 645 attributes in the generic object key described in previous section. 646 These kind of object keys are derived from the abstract ObjKeyType 647 and defined in their own abstract key types. Because these object 648 key types are abstract, they MUST be specified in a concrete form in 649 any SPPF conforming transport protocol specification. These are used 650 in Delete and Get operations, and may also be used in Accept and 651 Reject operations. 653 Following are the derived object keys in SPPF data model: 655 o SedGrpOfferKeyType: This uniquely identifies a SED Group object 656 offer. This key type extends from ObjKeyType and MUST also have 657 the organization ID of the Registrant to whom the object is being 658 offered, as one of its attributes. In addition to the Delete and 659 Get operations, these key types are used in Accept and Reject 660 operations on a SED Group Offer object. The structure of abstract 661 SedGrpOfferKeyType is as follows: 663 665 666 667 668 669 ---- Generic type that represents 670 the key for a object offer. ---- 671 672 673 674 675 677 A SED Group Offer object MUST use SedGrpOfferKeyType. Refer the 678 "Framework Data Model Objects" section of this document for 679 description of SED Group Offer object. 681 o PubIdKeyType: This uniquely identifies a Public Identity object. 682 This key type extends from abstract ObjKeyType. Any concrete 683 definition of PubIdKeyType MUST contain the elements that identify 684 the value and type of Public Identity and also contain the 685 organization ID of the Registrant that is the owner of the Public 686 Identity object. A Public Identity object in SPPF is uniquely 687 identified by the Registrant's organization ID, the value of the 688 public identity, and the type of the public identity object. 689 Consequently, any concrete representation of the PubIdKeyType MUST 690 contain the following attributes: 692 Registrant Id: The unique organization ID that identifies the 693 Registrant. 695 Value: The value of the Public Identity. 697 Type: The type of the Public Identity Object. 699 The PubIdKeyType is used in Delete and Get operations on a Public 700 Identifier object. 702 o The structure of abstract PubIdKeyType is as follows: 704 705 706 707 708 709 ---- Generic type that represents the key for a Pub Id. ---- 710 711 712 713 714 716 A Public Identity object MUST use attributes of PubIdKeyType for its 717 unique identification . Refer to Section 6 for a description of 718 Public Identity object. 720 5.3. Response Message Types 722 This section contains the listing of response types that MUST be 723 defined by the SPPF conforming transport protocol specification and 724 implemented by a conforming SPPF server. 726 +-----------------+-------------------------------------------------+ 727 | Response Type | Description | 728 +-----------------+-------------------------------------------------+ 729 | Request | Any conforming specification MUST define a | 730 | Succeeded | response to indicate that a given request | 731 | | succeeded. | 732 | | | 733 | Request syntax | Any conforming specification MUST define a | 734 | invalid | response to indicate that a syntax of a given | 735 | | request was found invalid. | 736 | | | 737 | Request too | Any conforming specification MUST define a | 738 | large | response to indicate that the count of entities | 739 | | in the request is larger than the server is | 740 | | willing or able to process. | 741 | | | 742 | Version not | Any conforming specification MUST define a | 743 | supported | response to indicate that the server does not | 744 | | support the version of the SPPF protocol | 745 | | specified in the request. | 746 | | | 747 | Command invalid | Any conforming specification MUST define a | 748 | | response to indicate that the operation and/or | 749 | | command being requested by the client is | 750 | | invalid and/or not supported by the server. | 751 | | | 752 | System | Any conforming specification MUST define a | 753 | temporarily | response to indicate that the SPPF server is | 754 | unavailable | temporarily not available to serve client | 755 | | request. | 756 | | | 757 | Unexpected | Any conforming specification MUST define a | 758 | internal system | response to indicate that the SPPF server | 759 | or server | encountered an unexpected error that prevented | 760 | error. | the server from fulfilling the request. | 761 | | | 762 | Attribute value | Any conforming specification MUST define a | 763 | invalid | response to indicate that the SPPF server | 764 | | encountered an attribute or property in the | 765 | | request that had an invalid/bad value. | 766 | | Optionally, the specification MAY provide a way | 767 | | to indicate the Attribute Name and the | 768 | | Attribute Value to identify the object that was | 769 | | found to be invalid. | 770 | | | 771 | Object does not | Any conforming specification MUST define a | 772 | exist | response to indicate that an object present in | 773 | | the request does not exist on the SPPF server. | 774 | | Optionally, the specification MAY provide a way | 775 | | to indicate the Attribute Name and the | 776 | | Attribute Value that identifies the non- | 777 | | existent object. | 778 | | | 779 | Object status | Any conforming specification MUST define a | 780 | or ownership | response to indicate that the operation | 781 | does not allow | requested on an object present in the request | 782 | for operation. | cannot be performed because the object is in a | 783 | | status that does not allow the said operation | 784 | | or the user requesting the operation is not | 785 | | authorized to perform the said operation on the | 786 | | object. Optionally, the specification MAY | 787 | | provide a way to indicate the Attribute Name | 788 | | and the Attribute Value that identifies the | 789 | | object. | 790 +-----------------+-------------------------------------------------+ 792 Table 1: Response Types 794 When the response messages are "parameterized" with the Attribute 795 Name and Attribute Value, then the use of these parameters MUST 796 adhere to the following rules: 798 o Any value provided for the Attribute Name parameter MUST be an 799 exact XSD element name of the protocol data element that the 800 response message is referring to. For example, valid values for 801 "attribute name" are "dgName", "sedGrpName", "sedRec", etc. 803 o The value for Attribute Value MUST be the value of the data 804 element to which the preceding Attribute Name refers. 806 o Response type "Attribute value invalid" MUST be used whenever an 807 element value does not adhere to data validation rules. 809 o Response types "Attribute value invalid" and "Object does not 810 exist" MUST not be used interchangeably. Response type "Object 811 does not exist" MUST be returned by an Update/Del/Accept/Reject 812 operation when the data element(s) used to uniquely identify a 813 pre-existing object do not exist. If the data elements used to 814 uniquely identify an object are malformed, then response type 815 "Attribute value invalid" MUST be returned. 817 6. Framework Data Model Objects 819 This section provides a description of the specification of each 820 supported data model object (the nouns) and identifies the commands 821 (the verbs) that MUST be supported for each data model object. 822 However, the specification of the data structures necessary to 823 support each command is delegated to an SPPF conforming transport 824 protocol specification. 826 6.1. Destination Group 828 Destination Group represents a logical grouping of Public Identifiers 829 with common session establishment information. The transport 830 protocol MUST support the ability to Create, Modify, Get, and Delete 831 Destination Groups (refer the "Framework Operations" section of this 832 document for a generic description of various operations). 834 A Destination Group object MUST be uniquely identified by attributes 835 as defined in the description of "ObjKeyType" in the section "Generic 836 Object Key Type" of this document. 838 The DestGrpType object structure is defined as follows: 840 841 842 843 844 845 846 847 848 850 The DestGrpType object is composed of the following elements: 852 o base: All first class objects extend BasicObjType (see 853 Section 5.1). 855 o dgName: The character string that contains the name of the 856 Destination Group. 858 o ext: Point of extensibility described in Section 3.3. 860 6.2. Public Identifier 862 A Public Identifier is the search key used for locating the session 863 establishment data (SED). In many cases, a Public Identifier is 864 attributed to the end user who has a retail relationship with the 865 service provider or Registrant organization. SPPF supports the 866 notion of the carrier-of-record as defined in [RFC5067]. Therefore, 867 the Registrant under whom the Public Identity is being created can 868 optionally claim to be a carrier-of-record. 870 SPPF identifies three types of Public Identifiers: telephone numbers 871 (TN), routing numbers (RN), and URI. SPPF provides structures to 872 manage a single TN, a contiguous range of TNs, and a TN prefix. The 873 transport protocol MUST support the ability to Create, Modify, Get, 874 and Delete Public Identifiers (refer the "Framework Operations" 875 section of this document for a generic description of various 876 operations). 878 A Public Identity object MUST be uniquely identified by attributes as 879 defined in the description of "PubIdKeyType" in the section 880 Section 5.2.2. 882 The abstract XML schema type definition PubIdType is a generalization 883 for the concrete Public Identifier schema types. PubIdType element 884 'dgName' represents the name of a destination group that a given 885 Public Identifier may be a member of. Note that this element may be 886 present multiple times so that a given Public Identifier may be a 887 member of multiple destination groups. The PubIdType object 888 structure is defined as follows: 890 891 892 893 894 896 897 898 899 901 A Public Identifier may be a member of zero or more Destination 902 Groups. When a Public Identifier is member of a Destination Group, 903 it is intended to be associated with SED(s) through the SED Group(s) 904 that are associated with the Destination Group. When a Public 905 Identifier is not member of any Destination Group, it is intended to 906 be associated with SED through the SED Records that are directly 907 associated with the Public Identifier. 909 A telephone number is provisioned using the TNType, an extension of 910 PubIdType. Each TNType object is uniquely identified by the 911 combination of its value contained within element, and its 912 Registrant ID. TNType is defined as follows: 914 915 916 917 918 919 920 922 923 924 925 927 928 929 930 931 932 933 935 936 937 938 939 940 942 TNType consists of the following attributes: 944 o tn: Telephone number to be added to the Registry. 946 o sedRecRef: Optional reference to SED records that are directly 947 associated with the TN Public Identifier. Following the SPPF data 948 model, the SED record could be a protocol agnostic URIType or 949 another type. 951 o corInfo: corInfo is an optional parameter of type CORInfoType that 952 allows the Registrant organization to set forth a claim to be the 953 carrier-of-record (see [RFC5067]). This is done by setting the 954 value of element of the CORInfoType object structure to 955 "true". The other two parameters of the CORInfoType, and 956 are set by the Registry to describe the outcome of the 957 carrier-of-record claim by the Registrant. In general, inclusion 958 of parameter is useful if the Registry has the authority 959 information, such as, the number portability data, etc., in order 960 to qualify whether the Registrant claim can be satisfied. If the 961 carrier-of-record claim disagrees with the authority data in the 962 Registry, whether the TN add operation fails or not is a matter of 963 policy and it is beyond the scope of this document. 965 A routing number is provisioned using the RNType, an extension of 966 PubIDType. The Registrant organization can add the RN and associate 967 it with the appropriate destination group(s) to share the route 968 information. This allows SSPs to use the RN search key to derive the 969 ingress routes for session establishment at the runtime resolution 970 process (see [RFC3761]. Each RNType object is uniquely identified by 971 the combination of its value inside the element, and its 972 Registrant ID. RNType is defined as follows: 974 975 976 977 978 979 980 981 982 983 985 RNType has the following attributes: 987 o rn: Routing Number used as the search key. 989 o corInfo: corInfo is an optional parameter of type CORInfoType that 990 allows the Registrant organization to set forth a claim to be the 991 carrier-of-record (see [RFC5067]) 993 TNRType structure is used to provision a contiguous range of 994 telephone numbers. The object definition requires a starting TN and 995 an ending TN that together define the span of the TN range. Use of 996 TNRType is particularly useful when expressing a TN range that does 997 not include all the TNs within a TN block or prefix. The TNRType 998 definition accommodates the open number plan as well such that the 999 TNs that fall between the start and end TN range may include TNs with 1000 different length variance. Whether the Registry can accommodate the 1001 open number plan semantics is a matter of policy and is beyond the 1002 scope of this document. Each TNRType object is uniquely identified 1003 by the combination of its value that in turn is a combination of the 1004 and elements, and its Registrant ID. TNRType 1005 object structure definition is as follows: 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1018 1019 1020 1021 1022 1023 1025 TNRType has the following attributes: 1027 o startTn: Starting TN in the TN range 1029 o endTn: The last TN in the TN range 1031 o corInfo: corInfo is an optional parameter of type CORInfoType that 1032 allows the Registrant organization to set forth a claim to be the 1033 carrier-of-record (see [RFC5067]) 1035 In some cases, it is useful to describe a set of TNs with the help of 1036 the first few digits of the telephone number, also referred to as the 1037 telephone number prefix or a block. A given TN prefix may include 1038 TNs with different length variance in support of open number plan. 1039 Once again, whether the Registry supports the open number plan 1040 semantics is a matter of policy and it is beyond the scope of this 1041 document. The TNPType data structure is used to provision a TN 1042 prefix. Each TNPType object is uniquely identified by the 1043 combination of its value in the element, and its 1044 Registrant ID. TNPType is defined as follows: 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1057 TNPType consists of the following attributes: 1059 o tnPrefix: The telephone number prefix 1061 o corInfo: corInfo is an optional parameter of type CORInfoType that 1062 allows the Registrant organization to set forth a claim to be the 1063 carrier-of-record (see [RFC5067]) 1065 In some cases, a Public Identifier may be a URI, such as an email 1066 address. The URIPubIdType object is comprised of the data element 1067 necessary to house such Public Identifiers. Each URIPubIdType object 1068 is uniquely identified by the combination of its value in the 1069 element, and its Registrant ID. URIPubIdType is defined as follows: 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1082 URIPubIdType consists of the following attributes: 1084 o uri: The value that acts a Public Identifier. 1086 o ext: Point of extensibility described in Section 3.3. 1088 6.3. SED Group 1090 SED Group is a grouping of one or more Destination Group, the common 1091 SED Records, and the list of peer organizations with access to the 1092 SED Records associated with a given SED Group. It is this indirect 1093 linking of public identifiers to their Session Establishment Data 1094 that significantly improves the scalability and manageability of the 1095 peering data. Additions and changes to SED information are reduced 1096 to a single operation on a SED Group or SED Record , rather than 1097 millions of data updates to individual public identifier records that 1098 individually contain their peering data. The transport protocol MUST 1099 support the ability to Create, Modify, Get, and Delete SED Groups 1100 (refer the "Framework Operations" section of this document for a 1101 generic description of various operations). 1103 A SED Group object MUST be uniquely identified by attributes as 1104 defined in the description of "ObjKeyType" in the section "Generic 1105 Object Key Type" of this document. 1107 The SedGrpType object structure is defined as follows: 1109 1110 1111 1112 1113 1114 1116 1118 1120 1122 1123 1124 1125 1126 1127 1128 1130 1131 1132 1133 1134 1135 1136 1138 The SedGrpType object is composed of the following elements: 1140 o base: All first class objects extend BasicObjType (see 1141 Section 5.1). 1143 o sedGrpName: The character string that contains the name of the SED 1144 Group. It uniquely identifies this object within the context of 1145 the Registrant ID (a child element of the base element as 1146 described above). 1148 o sedRecRef: Set of zero or more objects of type SedRecRefType that 1149 house the unique keys of the SED Records (containing the session 1150 establishment data) that the SedGrpType object refers to and their 1151 relative priority within the context of this SED Group. 1153 o dgName: Set of zero or more names of DestGrpType object instances. 1154 Each dgName name, in association with this SED Group's Registrant 1155 ID, uniquely identifies a DestGrpType object instance whose 1156 associated public identifiers are reachable using the session 1157 establishment information housed in this SED Group. An intended 1158 side affect of this is that a SED Group cannot provide session 1159 establishment information for a Destination Group belonging to 1160 another Registrant. 1162 o peeringOrg: Set of zero or more peering organization IDs that have 1163 accepted an offer to receive this SED Group's information. Note 1164 that this identifier "peeringOrg" is an instance of OrgIdType. 1165 The set of peering organizations in this list is not directly 1166 settable or modifiable using the addSedGrpsRqst operation. This 1167 set is instead controlled using the SED offer and accept 1168 operations. 1170 o sourceIdent: Set of zero or more SourceIdentType object instances. 1171 These objects, described further below, house the source 1172 identification schemes and identifiers that are applied at 1173 resolution time as part of source based routing algorithms for the 1174 SED Group. 1176 o isInSvc: A boolean element that defines whether this SED Group is 1177 in service. The session establishment information contained in a 1178 SED Group that is in service is a candidate for inclusion in 1179 resolution responses for public identities residing in the 1180 Destination Group associated with this SED Group. The session 1181 establishment information contained in a SED Group that is not in 1182 service is not a candidate for inclusion in resolution responses. 1184 o priority: Priority value that can be used to provide a relative 1185 value weighting of one SED Group over another. The manner in 1186 which this value is used, perhaps in conjunction with other 1187 factors, is a matter of policy. 1189 o ext: Point of extensibility described in Section 3.3. 1191 As described above, the SED Group contains a set of references to SED 1192 record objects. A SED record object is based on an abstract type: 1193 SedRecType. The concrete types that use SedRecType as an extension 1194 base are NAPTRType, NSType, and URIType. The definitions of these 1195 types are included the SED Record section of this document. 1197 The SedGrpType object provides support for source-based routing via 1198 the peeringOrg data element and more granular source base routing via 1199 the source identity element. The source identity element provides 1200 the ability to specify zero or more of the following in association 1201 with a given SED Group: a regular expression that is matched against 1202 the resolution client IP address, a regular expression that is 1203 matched against the root domain name(s), and/or a regular expression 1204 that is matched against the calling party URI(s). The result will be 1205 that, after identifying the visible SED Groups whose associated 1206 Destination Group(s) contain the lookup key being queried and whose 1207 peeringOrg list contains the querying organizations organization ID, 1208 the resolution server will evaluate the characteristics of the Source 1209 URI, and Source IP address, and root domain of the lookup key being 1210 queried. The resolution server then compares these criteria against 1211 the source identity criteria associated with the SED Groups. The 1212 session establishment information contained in SED Groups that have 1213 source based routing criteria will only be included in the resolution 1214 response if one or more of the criteria matches the source criteria 1215 from the resolution request. The Source Identity data element is of 1216 type SourceIdentType, whose structure is defined as follows: 1218 1219 1220 1221 1223 1224 1225 1227 1228 1229 1230 1231 1232 1233 1235 The SourceIdentType object is composed of the following data 1236 elements: 1238 o sourceIdentScheme: The source identification scheme that this 1239 source identification criteria applies to and that the associated 1240 sourceIdentRegex should be matched against. 1242 o sourceIdentRegex: The regular expression that should be used to 1243 test for a match against the portion of the resolution request 1244 that is dictated by the associated sourceIdentScheme. 1246 o ext: Point of extensibility described in Section 3.3. 1248 6.4. SED Record 1250 SED Group represents a combined grouping of SED Records that define 1251 session establishment information. However, SED Records need not be 1252 created to just serve a single SED Group. SED Records can be created 1253 and managed to serve multiple SED Groups. As a result, a change for 1254 example to the properties of a network node used for multiple routes, 1255 would necessitate just a single update operation to change the 1256 properties of that node. The change would then be reflected in all 1257 the SED Groups whose SED record set contains a reference to that 1258 node. The transport protocol MUST support the ability to Create, 1259 Modify, Get, and Delete SED Records (refer the "Framework Operations" 1260 section of this document for a generic description of various 1261 operations). 1263 A SED Record object MUST be uniquely identified by attributes as 1264 defined in the description of "ObjKeyType" in the section "Generic 1265 Object Key Type" of this document. 1267 The SedRecType object structure is defined as follows: 1269 1270 1271 1272 1273 1274 1276 1277 1278 1279 1280 1281 1283 1284 1285 1286 1287 1288 1290 The SedRecType object is composed of the following elements: 1292 o base: All first class objects extend BasicObjType (see 1293 Section 5.1). 1295 o sedName: The character string that contains the name of the SED 1296 Record. It uniquely identifies this object within the context of 1297 the Registrant ID (a child element of the base element as 1298 described above). 1300 o sedFunction: As described in [RFC6461], SED or Session 1301 Establishment Data falls primarily into one of two categories or 1302 functions, LUF and LRF. To remove any ambiguity as to the 1303 function a SED record is intended to provide, this optional 1304 element allows the provisioning party to make his or her 1305 intentions explicit. 1307 o isInSvc: A boolean element that defines whether this SED Record is 1308 in service or not. The session establishment information 1309 contained in a SED Record which is in service is a candidate for 1310 inclusion in resolution responses for Telephone Numbers that are 1311 either directly associated to this SED Record, or for Public 1312 Identities residing in a Destination Group that is associated to a 1313 SED Group which in turn has an association to this SED Record. 1315 o ttl: Number of seconds that an addressing server may cache a 1316 particular SED Record. 1318 As described above, SED records are based on an abstract type: 1319 SedRecType. The concrete types that use SedRecType as an extension 1320 base are NAPTRType, NSType, and URIType. The definitions of these 1321 types are included below. The NAPTRType object is comprised of the 1322 data elements necessary for a NAPTR (see [RFC3403]that contains 1323 routing information for a SED Group. The NSType object is comprised 1324 of the data elements necessary for a DNS name server that points to 1325 another DNS server that contains the desired routing information. 1326 The NSType is relevant only when the resolution protocol is ENUM (see 1327 [RFC3761]). The URIType object is comprised of the data elements 1328 necessary to house a URI. 1330 The data provisioned in a Registry can be leveraged for many purposes 1331 and queried using various protocols including SIP, ENUM and others. 1332 As such, the resolution data represented by the SED records must be 1333 in a form suitable for transport using one of these protocols. In 1334 the NAPTRType for example, if the URI is associated with a 1335 destination group, the user part of the replacement string that 1336 may require the Public Identifier cannot be preset. As a SIP 1337 Redirect, the resolution server will apply pattern on the input 1338 Public Identifier in the query and process the replacement string by 1339 substituting any back reference(s) in the to arrive at the 1340 final URI that is returned in the SIP Contact header. For an ENUM 1341 query, the resolution server will simply return the values of the 1342 and members of the URI. 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1359 1360 1361 1362 1363 1364 1366 1367 1368 1369 1370 1372 1373 1374 1375 1376 1377 1378 1380 1381 1382 1383 1384 1385 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1399 1400 1401 1402 1403 1404 1406 The NAPTRType object is composed of the following elements: 1408 o order: Order value in an ENUM NAPTR, relative to other NAPTRType 1409 objects in the same SED Group. 1411 o svcs: ENUM service(s) that are served by the SBE. This field's 1412 value must be of the form specified in [RFC6116] (e.g., 1413 E2U+pstn:sip+sip). The allowable values are a matter of policy 1414 and not limited by this protocol. 1416 o regx: NAPTR's regular expression field. If this is not included 1417 then the Repl field must be included. 1419 o repl: NAPTR replacement field, should only be provided if the 1420 Regex field is not provided, otherwise the server will ignore it 1422 o ext: Point of extensibility described in Section 3.3. 1424 The NSType object is composed of the following elements: 1426 o hostName: Root-relative host name of the name server. 1428 o ipAddr: Zero or more objects of type IpAddrType. Each object 1429 holds an IP Address and the IP Address type, IPv4 or IP v6. 1431 o ext: Point of extensibility described in Section 3.3. 1433 The URIType object is composed of the following elements: 1435 o ere: The POSIX Extended Regular Expression (ere) as defined in 1436 [RFC3986]. 1438 o uri: the URI as defined in [RFC3986]. In some cases, this will 1439 serve as the replacement string and it will be left to the 1440 resolution server to arrive at the final usable URI. 1442 6.5. SED Group Offer 1444 The list of peer organizations whose resolution responses can include 1445 the session establishment information contained in a given SED Group 1446 is controlled by the organization to which a SED Group object belongs 1447 (its Registrant), and the peer organization that submits resolution 1448 requests (a data recipient, also know as a peering organization). 1449 The Registrant offers access to a SED Group by submitting a SED Group 1450 Offer. The data recipient can then accept or reject that offer. Not 1451 until access to a SED Group has been offered and accepted will the 1452 data recipient's organization ID be included in the peeringOrg list 1453 in a SED Group object, and that SED Group's peering information 1454 become a candidate for inclusion in the responses to the resolution 1455 requests submitted by that data recipient. The transport protocol 1456 MUST support the ability to Create, Modify, Get, Delete, Accept and 1457 Reject SED Group Offers (refer the "Framework Operations" section of 1458 this document for a generic description of various operations). 1460 A SED Group Offer object MUST be uniquely identified by attributes as 1461 defined in the description of "SedGrpOfferKeyType" in the section 1462 "Derived Object Key Types" of this document. 1464 The SedGrpOfferType object structure is defined as follows: 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1480 1481 1482 1483 -- Generic type that represents the key for a SED group offer. Must 1484 be defined in concrete form in the transport specification. -- 1485 1487 1488 1490 1491 1492 1493 1494 1495 1497 The SedGrpOfferType object is composed of the following elements: 1499 o base: All first class objects extend BasicObjType (see 1500 Section 5.1). 1502 o sedGrpOfferKey: The object that identifies the SED that is or has 1503 been offered and the organization that it is or has been offered 1504 to. 1506 o status: The status of the offer, offered or accepted. The server 1507 controls the status. It is automatically set to "offered" when 1508 ever a new SED Group Offer is added, and is automatically set to 1509 "accepted" if and when that offer is accepted. The value of the 1510 element is ignored when passed in by the client. 1512 o offerDateTime: Date and time in UTC when the SED Group Offer was 1513 added. 1515 o acceptDateTime: Date and time in UTC when the SED Group Offer was 1516 accepted. 1518 6.6. Egress Route 1520 In a high-availability environment, the originating SSP likely has 1521 more than one egress path to the ingress SBE of the target SSP. If 1522 the originating SSP wants to exercise greater control and choose a 1523 specific egress SBE to be associated to the target ingress SBE, it 1524 can do so using the EgrRteType object. 1526 An Egress Route object MUST be uniquely identified by attributes as 1527 defined in the description of "ObjKeyType" in the section "Generic 1528 Object Key Type" of this document. 1530 Lets assume that the target SSP has offered as part of his session 1531 establishment data, to share one or more ingress routes and that the 1532 originating SSP has accepted the offer. In order to add the egress 1533 route to the Registry, the originating SSP uses a valid regular 1534 expression to rewrite ingress route in order to include the egress 1535 SBE information. Also, more than one egress route can be associated 1536 with a given ingress route in support of fault-tolerant 1537 configurations. The supporting SPPF structure provides a way to 1538 include route precedence information to help manage traffic to more 1539 than one outbound egress SBE. 1541 The transport protocol MUST support the ability to Add, Modify, Get, 1542 and Delete Egress Routes (refer the "Framework Operations" section of 1543 this document for a generic description of various operations). The 1544 EgrRteType object structure is defined as follows: 1546 1547 1548 1549 1550 1551 1552 1553 1555 1556 1557 1558 1559 1560 1562 The EgrRteType object is composed of the following elements: 1564 o base: All first class objects extend BasicObjType (see 1565 Section 5.1). 1567 o egrRteName: The name of the egress route. 1569 o pref: The preference of this egress route relative to other egress 1570 routes that may get selected when responding to a resolution 1571 request. 1573 o regxRewriteRule: The regular expression re-write rule that should 1574 be applied to the regular expression of the ingress NAPTR(s) that 1575 belong to the ingress route. 1577 o ingrSedGrp: The ingress SED group that the egress route should be 1578 used for. 1580 o svcs: ENUM service(s) that are served by an Egress Route. This 1581 element is used to identify the ingress NAPTRs associated with the 1582 SED Group to which an Egress Route's regxRewriteRule should be 1583 applied. If no ENUM service(s) are associated with an Egress 1584 Route, then the Egress Route's regxRewriteRule should be applied 1585 to all the NAPTRs associated with the SED Group. This field's 1586 value must be of the form specified in [RFC6116] (e.g., 1587 E2U+pstn:sip+sip). The allowable values are a matter of policy 1588 and not limited by this protocol. 1590 o ext: Point of extensibility described in Section 3.3. 1592 7. Framework Operations 1594 In addition to the operation specific object types, all operations 1595 MAY specify the minor version of the protocol that when used in 1596 conjunction with the major version (that can be for instance 1597 specified in the protocol namespace) can serve to identify the 1598 version of the SPPF protocol that the client is using. If the minor 1599 version is not specified, the latest minor version supported by the 1600 SPPF server for the given major version will be used. Additionally, 1601 operations that may potentially modify persistent protocol objects 1602 SHOULD include a transaction ID as well. 1604 7.1. Add Operation 1606 Any conforming transport protocol specification MUST provide a 1607 definition for the operation that adds one or more SPPF objects into 1608 the Registry. If the object, as identified by the request attributes 1609 that form part of the object's key, does not exist, then the Registry 1610 MUST create the object. If the object does exist, then the Registry 1611 MUST replace the current properties of the object with the properties 1612 passed in as part of the Add operation. 1614 If the entity that issued the command is not authorized to perform 1615 this operation an appropriate error message MUST be returned from 1616 amongst the response messages defined in "Response Message Types" 1617 section of the document. 1619 7.2. Delete Operation 1621 Any conforming transport protocol specification MUST provide a 1622 definition for the operation that deletes one or more SPPF objects 1623 from the Registry using the object's key. 1625 If the entity that issued the command is not authorized to perform 1626 this operation an appropriate error message MUST be returned from 1627 amongst the response messages defined in "Response Message Types" 1628 section of the document. 1630 When an object is deleted, any references to that object must of 1631 course also be removed as the SPPF server implementation fulfills the 1632 deletion request. Furthermore, the deletion of a composite object 1633 must also result in the deletion of the objects it contains. As a 1634 result, the following rules apply to the deletion of SPPF object 1635 types: 1637 o Destination Groups: When a destination group is deleted any 1638 references between that destination group and any SED group must 1639 be automatically removed by the SPPF implementation as part of 1640 fulfilling the deletion request. Similarly, any references 1641 between that destination group and any Public Identifier must be 1642 removed by the SPPF implementation as part of fulfilling the 1643 deletion request. 1645 o SED Groups: When a SED group is deleted any references between 1646 that SED group and any destination group must be automatically 1647 removed by the SPPF implementation as part of fulfilling the 1648 deletion request. Similarly any references between that SED group 1649 and any SED records must be removed by the SPPF implementation as 1650 part of fulfilling the deletion request. Furthermore, SED group 1651 offers relating that SED group must also be deleted as part of 1652 fulfilling the deletion request. 1654 o SED Records: When a SED record is deleted any references between 1655 that SED record and any SED group must be removed by the SPPF 1656 implementation as part of fulfilling the deletion request. 1657 Similarly, any reference between that SED record and any Public 1658 Identifier must be removed by the SPPF implementation as part of 1659 fulfilling the deletion request. 1661 o Public Identifiers: When a public identifier is deleted any 1662 references between that public identifier and any referenced 1663 destination group must be removed by the SPPF implementation as 1664 part of fulfilling the deletion request. Any references to SED 1665 records associated directly to that Public Identifier must also be 1666 deleted by the SPPF implementation as part of fulfilling the 1667 deletion request. 1669 7.3. Get Operations 1671 At times, on behalf of the Registrant, the Registrar may need to get 1672 information about SPPF objects that were previously provisioned in 1673 the Registry. A few examples include logging, auditing, and pre- 1674 provisioning dependency checking. This query mechanism is limited to 1675 aid provisioning scenarios and should not be confused with query 1676 protocols provided as part of the resolution system (e.g. ENUM and 1677 SIP). 1679 Any conforming "protocol" specification MUST provide a definition for 1680 the operation that queries the details of one or more SPPF objects 1681 from the Registry using the object's key. If the entity that issued 1682 the command is not authorized to perform this operation an 1683 appropriate error message MUST be returned from amongst the response 1684 messages defined in Section 5.3. 1686 If the response to the Get operation includes object(s) that extend 1687 the BasicObjType, the Registry MUST include the 'cDate' and 'mDate', 1688 if applicable. 1690 7.4. Accept Operations 1692 In SPPF, a SED Group Offer can be accepted or rejected by, or on 1693 behalf of, the Registrant to whom the SED Group has been offered 1694 (refer "Framework Data Model Objects" section of this document for a 1695 description of the SED Group Offer object). The Accept operation is 1696 used to accept the SED Group Offers. Any conforming transport 1697 protocol specification MUST provide a definition for the operation to 1698 accept SED Group Offers by, or on behalf of the Registrant, using the 1699 SED Group Offer object key. 1701 Not until access to a SED Group has been offered and accepted will 1702 the Registrant's organization ID be included in the peeringOrg list 1703 in that SED Group object, and that SED Group's peering information 1704 become a candidate for inclusion in the responses to the resolution 1705 requests submitted by that Registrant. A SED Group Offer that is in 1706 the "offered" status is accepted by, or on behalf of, the Registrant 1707 to which it has been offered. When the SED Group Offer is accepted 1708 the the SED Group Offer is moved to the "accepted" status and adds 1709 that data recipient's organization ID into the list of peerOrgIds for 1710 that SED Group. 1712 If the entity that issued the command is not authorized to perform 1713 this operation an appropriate error message MUST be returned from 1714 amongst the response messages defined in "Response Message Types" 1715 section of the document. 1717 7.5. Reject Operations 1719 In SPPF, a SED Group Offer object can be accepted or rejected by, or 1720 on behalf of, the Registrant to whom the SED Group has been offered 1721 (refer "Framework Data Model Objects" section of this document for a 1722 description of the SED Group Offer object). Furthermore, that offer 1723 may be rejected, regardless of whether or not it has been previously 1724 accepted. The Reject operation is used to reject the SED Group 1725 Offers. When the SED Group Offer is rejected that SED Group Offer is 1726 deleted, and, if appropriate, the data recipient's organization ID is 1727 removed from the list of peeringOrg IDs for that SED Group. Any 1728 conforming transport protocol specification MUST provide a definition 1729 for the operation to reject SED Group Offers by, or on behalf of the 1730 Registrant, using the SED Group Offer object key. 1732 If the entity that issued the command is not authorized to perform 1733 this operation an appropriate error message MUST be returned from 1734 amongst the response messages defined in "Response Message Types" 1735 section of the document. 1737 7.6. Get Server Details Operation 1739 In SPPF, Get Server Details operation can be used to request certain 1740 details about the SPPF server that include the SPPF server's current 1741 status, the major/minor version of the SPPF protocol supported by the 1742 SPPF server. 1744 Any conforming transport protocol specification MUST provide a 1745 definition for the operation to request such details from the SPPF 1746 server. If the entity that issued the command is not authorized to 1747 perform this operation an appropriate error message MUST be returned 1748 from amongst the response messages defined in "Response Message 1749 Types" section of the document. 1751 8. XML Considerations 1753 XML serves as the encoding format for SPPF, allowing complex 1754 hierarchical data to be expressed in a text format that can be read, 1755 saved, and manipulated with both traditional text tools and tools 1756 specific to XML. 1758 XML is case sensitive. Unless stated otherwise, XML specifications 1759 and examples provided in this document MUST be interpreted in the 1760 character case presented to develop a conforming implementation. 1762 This section discusses a small number of XML-related considerations 1763 pertaining to SPPF. 1765 8.1. Namespaces 1766 All SPPF elements are defined in the namespaces in the IANA 1767 Considerations section and in the Formal Framework Specification 1768 section of this document. 1770 8.2. Versioning and Character Encoding 1772 All XML instances SHOULD begin with an declaration to 1773 identify the version of XML that is being used, optionally identify 1774 use of the character encoding used, and optionally provide a hint to 1775 an XML parser that an external schema file is needed to validate the 1776 XML instance. 1778 Conformant XML parsers recognize both UTF-8 (defined in [RFC3629]) 1779 and UTF-16 (defined in [RFC2781]); per [RFC2277] UTF-8 is the 1780 RECOMMENDED character encoding for use with SPPF. 1782 Character encodings other than UTF-8 and UTF-16 are allowed by XML. 1783 UTF-8 is the default encoding assumed by XML in the absence of an 1784 "encoding" attribute or a byte order mark (BOM); thus, the "encoding" 1785 attribute in the XML declaration is OPTIONAL if UTF-8 encoding is 1786 used. SPPF clients and servers MUST accept a UTF-8 BOM if present, 1787 though emitting a UTF-8 BOM is NOT RECOMMENDED. 1789 Example XML declarations: 1791 1793 9. Security Considerations 1795 Many SPPF implementations manage data that is considered confidential 1796 and critical. Furthermore, SPPF implementations can support 1797 provisioning activities for multiple Registrars and Registrants. As 1798 a result any SPPF implementation must address the requirements for 1799 confidentiality, authentication, and authorization. 1801 9.1. Confidentiality and Authentication 1803 With respect to confidentiality and authentication, the transport 1804 protocol requirements section of this document contains security 1805 properties that the transport protocol must provide so that 1806 authenticated endpoints can exchange data confidentially and with 1807 integrity protection. Refer to that section and the resulting 1808 transport protocol specification document for the specific solutions 1809 to authentication and confidentiality. 1811 9.2. Authorization 1812 With respect to authorization, the SPPF server implementation must 1813 define and implement a set of authorization rules that precisely 1814 address (1) which Registrars will be authorized to create/modify/ 1815 delete each SPPF object type for given Registrant(s) and (2) which 1816 Registrars will be authorized to view/get each SPPF object type for 1817 given Registrant(s). These authorization rules are a matter of 1818 policy and are not specified within the context of SPPF. However, 1819 any SPPF implementation must specify these authorization rules in 1820 order to function in a reliable and safe manner. 1822 9.3. Denial of Service 1824 Guidance on Denial-of-Service (DoS) issues in general is given in 1825 [RFC4732], "Internet Denial of Service Considerations", which also 1826 gives a general vocabulary for describing the DoS issue. 1828 SPPF is a high-level client-server protocol that can be implemented 1829 on lower-level mechanisms such as remote procedure call and web- 1830 service API protocols. As such, it inherits any Denial-of-Service 1831 issues inherent to the specific lower-level mechanism used for any 1832 implementation of SPPF. SPPF also has its own set of higher-level 1833 exposures that are likely to be independent of lower-layer mechanism 1834 choices. 1836 9.3.1. DoS Issues Inherited from Transport Mechanism 1838 SPPF implementation is in general dependent on the selection and 1839 implementation of a lower-level transport protocol and a binding 1840 between that protocol and SPPF. The archetypal SPPF implementation 1841 uses XML (http://www.w3.org/TR/xml/) representation in a SOAP (http:/ 1842 /www.w3.org/TR/soap/) request/response framework over HTTP 1843 ([RFC2616]), and probably also uses TLS ([RFC5246]) for on-the wire 1844 data integrity and participant authentication, and might use HTTP 1845 Digest authentication ([RFC2609]). 1847 The typical deployment scenario for SPPF is to have servers in a 1848 managed facility, and therefore techniques such as Network Ingress 1849 Filtering ([RFC2609]) are generally applicable. In short, any DoS 1850 mechanism affecting a typical HTTP implementation would affect such 1851 an SPPF implementation, and the mitigation tools for HTTP in general 1852 also therefore apply to SPPF. 1854 SPPF does not directly specify an authentication mechanism, instead 1855 relying on the lower-level transport protocol to provide for 1856 authentication. In general, authentication is an expensive 1857 operation, and one apparent attack vector is to flood an SPPF server 1858 with repeated requests for authentication, thereby exhausting its 1859 resources. SPPF implementations SHOULD therefore be prepared to 1860 handle authentication floods, perhaps by noting repeated failed login 1861 requests from a given source address and blocking that source 1862 address. 1864 9.3.2. DoS Issues Specific to SPPF 1866 The primary defense mechanism against DoS within SPPF is 1867 authentication. Implementations MUST tightly control access to the 1868 SPPF service, SHOULD implement DoS and other policy control 1869 screening, and MAY employ a variety of policy violation reporting and 1870 response measures such as automatic blocking of specific users and 1871 alerting of operations personnel. In short, the primary SPPF 1872 response to DoS-like activity by a user is to block that user or 1873 subject their actions to additional review. 1875 SPPF allows a client to submit multiple-element or "batch" requests 1876 that may insert or otherwise affect a large amount of data with a 1877 single request. In the simplest case, the server progresses 1878 sequentially through each element in a batch, completing one and 1879 before starting the next. Mid-batch failures are handled by stopping 1880 the batch and rolling-back the data store to its pre-request state. 1881 This "stop and roll-back" design provides a DoS opportunity. A 1882 hostile client could repeatedly issue large batch requests with one 1883 or more failing elements, causing the server to repeatedly stop and 1884 roll-back large transactions. The suggested response is to monitor 1885 clients for such failures, and take administrative action (such as 1886 blocking the user) when an excessive number of roll-backs is 1887 reported. 1889 An additional suggested response is for an implementer to set their 1890 maximum allowable XML message size, and their maximum allowable batch 1891 size at a level that they feel protects their operational instance, 1892 given the hardware sizing they have in place and the expected load 1893 and size needs that their users expect. 1895 9.4. Information Disclosure 1897 It is not uncommon for the logging systems to document on-the-wire 1898 messages for various purposes, such as, debug, audit, and tracking. 1899 At the minimum, the various support and administration staff will 1900 have access to these logs. Also, if an unprivileged user gains 1901 access to the SPPF deployments and/or support systems, it will have 1902 access to the information that is potentially deemed confidential. 1903 To manage information disclosure concerns beyond the transport level, 1904 SPPF implementations MAY provide support for encryption at the SPPF 1905 object level. 1907 9.5. Non Repudiation 1909 In some situations, it may be required to protect against denial of 1910 involvement (see [RFC4949]) and tackle non-repudiation concerns in 1911 regards to SPPF messages. This type of protection is useful to 1912 satisfy authenticity concerns related to SPPF messages beyond the 1913 end-to-end connection integrity, confidentiality, and authentication 1914 protection that the transport layer provides. This is an optional 1915 feature and some SPPF implementations MAY provide support for it. 1917 9.6. Replay Attacks 1919 Anti-replay protection ensures that a given SPPF object replayed at a 1920 later time doesn't affect the integrity of the system. SPPF provides 1921 at least one mechanism to fight against replay attacks. Use of the 1922 optional client transaction identifier allows the SPPF client to 1923 correlate the request message with the response and to be sure that 1924 it is not a replay of a server response from earlier exchanges. Use 1925 of unique values for the client transaction identifier is highly 1926 encouraged to avoid chance matches to a potential replay message. 1928 9.7. Man in the Middle 1930 The SPPF client or Registrar can be a separate entity acting on 1931 behalf of the Registrant in facilitating provisioning transactions to 1932 the Registry. Further, the transport layer provides end-to-end 1933 connection protection between SPPF client and the SPPF server. 1934 Therefore, man-in-the-middle attack is a possibility that may affect 1935 the integrity of the data that belongs to the Registrant and/or 1936 expose peer data to unintended actors in case well-established 1937 peering relationships already exist. 1939 10. Internationalization Considerations 1941 Character encodings to be used for SPPF elements are described in 1942 Section 8.2. The use of time elements in the protocol is specified 1943 in Section 3.2. Where human-readable languages are used in the 1944 protocol, those messages SHOULD be tagged according to [RFC5646], and 1945 the transport protocol MUST support a respective mechanism to 1946 transmit such tags together with those human-readable messages. If 1947 tags are absent, the language of the message defaults to "en" 1948 (English). 1950 11. IANA Considerations 1952 11.1. URN Assignments 1954 This document uses URNs to describe XML namespaces and XML schemas 1955 conforming to a Registry mechanism described in [RFC3688]. 1957 Two URI assignments are requested. 1959 Registration request for the SPPF XML namespace: 1960 urn:ietf:params:xml:ns:sppf:base:1 1961 Registrant Contact: IESG 1962 XML: None. Namespace URIs do not represent an XML specification. 1964 Registration request for the XML schema: 1965 URI: urn:ietf:params:xml:schema:sppf:1 1966 Registrant Contact: IESG 1967 XML: See the "Formal Specification" section of this document 1968 (Section 12). 1970 11.2. Organization Identifier Namespace Registry 1972 IANA is requested to create and maintain a Registry entitled "SPPF 1973 OrgIdType Namespaces". Strings used as OrgIdType Namespace 1974 identifiers MUST conform to the following syntax in the Augmented 1975 Backus-Naur Form (ABNF) [RFC5234] 1977 namespace = ALPHA * (ALPHA/DIGIT/"-") 1979 Assignments consist of the OrgIdType namespace string, and the 1980 definition of the associated namespace. This document makes the 1981 following initial assignment for the OrgIdType Namespaces: 1983 OrgIdType namespace string Namespace 1984 -------------------------- --------- 1985 IANA Enterprise Numbers iana-en 1987 Future assignments are to be made through the well known IANA Policy 1988 "RFC Required" (see section 4.1 of [RFC5226]) 1990 12. Formal Specification 1992 This section provides the draft XML Schema Definition for SPPF 1993 Protocol. 1995 1996 2000 2001 2002 ---- Generic Object key types to be defined by specific 2003 Transport/Architecture. The types defined here can 2004 be extended by the specific architecture to 2005 define the Object Identifiers ---- 2006 2007 2008 2010 2011 2012 ---- Generic type that represents the 2013 key for various objects in SPPF. ---- 2014 2015 2016 2018 2019 2020 2021 2022 2023 ---- Generic type that represents 2024 the key for a SED group offer. ---- 2025 2026 2027 2028 2029 2031 2032 2033 2034 2035 2036 ----Generic type that 2037 represents the key 2038 for a Pub Id. ---- 2039 2040 2041 2042 2043 2044 2045 2046 ---- Object Type Definitions ---- 2047 2048 2050 2051 2052 2053 2054 2055 2057 2059 2061 2063 2064 2065 2067 2068 2069 2070 2071 2072 2073 2074 2075 2077 2078 2079 2080 2081 2082 2083 2084 2085 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2141 2142 2143 2144 2145 2146 2147 2148 2149 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2216 2217 2218 2219 2220 2221 2222 2223 2224 ---- Abstract Object and Element Type Definitions ---- 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2389 13. Acknowledgments 2391 This document is a result of various discussions held in the DRINKS 2392 working group and within the DRINKS protocol design team, with 2393 contributions from the following individuals, in alphabetical order: 2394 Alexander Mayrhofer, David Schwartz, Deborah A Guyton, Lisa 2395 Dusseault, Manjul Maharishi, Mickael Marrache, Otmar Lendl, Richard 2396 Shockey, Samuel Melloul, Sumanth Channabasappa, Syed Ali, Vikas 2397 Bhatia, and Jeremy Barkan 2399 14. References 2401 14.1. Normative References 2403 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 2404 Requirement Levels", BCP 14, RFC 2119, March 1997. 2406 [RFC2277] Alvestrand, H., "IETF Policy on Character Sets and 2407 Languages", BCP 18, RFC 2277, January 1998. 2409 [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO 2410 10646", STD 63, RFC 3629, November 2003. 2412 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 2413 January 2004. 2415 [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform 2416 Resource Identifier (URI): Generic Syntax", STD 66, RFC 2417 3986, January 2005. 2419 [RFC4949] Shirey, R., "Internet Security Glossary, Version 2", RFC 2420 4949, August 2007. 2422 [RFC5067] Lind, S. and P. Pfautz, "Infrastructure ENUM 2423 Requirements", RFC 5067, November 2007. 2425 [RFC5226] Narten, T. and H. Alvestrand, "Guidelines for Writing an 2426 IANA Considerations Section in RFCs", BCP 26, RFC 5226, 2427 May 2008. 2429 [RFC5234] Crocker, D. and P. Overell, "Augmented BNF for Syntax 2430 Specifications: ABNF", STD 68, RFC 5234, January 2008. 2432 14.2. Informative References 2434 [RFC2609] Guttman, E., Perkins, C., and J. Kempf, "Service Templates 2435 and Service: Schemes", RFC 2609, June 1999. 2437 [RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H., 2438 Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext 2439 Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999. 2441 [RFC2781] Hoffman, P. and F. Yergeau, "UTF-16, an encoding of ISO 2442 10646", RFC 2781, February 2000. 2444 [RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, 2445 A., Peterson, J., Sparks, R., Handley, M., and E. 2446 Schooler, "SIP: Session Initiation Protocol", RFC 3261, 2447 June 2002. 2449 [RFC3403] Mealling, M., "Dynamic Delegation Discovery System (DDDS) 2450 Part Three: The Domain Name System (DNS) Database", RFC 2451 3403, October 2002. 2453 [RFC3761] Faltstrom, P. and M. Mealling, "The E.164 to Uniform 2454 Resource Identifiers (URI) Dynamic Delegation Discovery 2455 System (DDDS) Application (ENUM)", RFC 3761, April 2004. 2457 [RFC4725] Mayrhofer, A. and B. Hoeneisen, "ENUM Validation 2458 Architecture", RFC 4725, November 2006. 2460 [RFC4732] Handley, M., Rescorla, E., IAB, "Internet Denial-of- 2461 Service Considerations", RFC 4732, December 2006. 2463 [RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security 2464 (TLS) Protocol Version 1.2", RFC 5246, August 2008. 2466 [RFC5321] Klensin, J., "Simple Mail Transfer Protocol", RFC 5321, 2467 October 2008. 2469 [RFC5486] Malas, D. and D. Meyer, "Session Peering for Multimedia 2470 Interconnect (SPEERMINT) Terminology", RFC 5486, March 2471 2009. 2473 [RFC5646] Phillips, A. and M. Davis, "Tags for Identifying 2474 Languages", BCP 47, RFC 5646, September 2009. 2476 [RFC6116] Bradner, S., Conroy, L., and K. Fujiwara, "The E.164 to 2477 Uniform Resource Identifiers (URI) Dynamic Delegation 2478 Discovery System (DDDS) Application (ENUM)", RFC 6116, 2479 March 2011. 2481 [RFC6461] Channabasappa, S., "Data for Reachability of Inter-/Intra- 2482 NetworK SIP (DRINKS) Use Cases and Protocol Requirements", 2483 RFC 6461, January 2012. 2485 [Unicode6.1] 2486 The Unicode Consortium, "The Unicode Standard - Version 2487 6.1", Unicode 6.1, January 2012. 2489 Authors' Addresses 2491 Kenneth Cartwright 2492 TNS 2493 1939 Roland Clarke Place 2494 Reston, VA 20191 2495 USA 2497 Email: kcartwright@tnsi.com 2499 Vikas Bhatia 2500 TNS 2501 1939 Roland Clarke Place 2502 Reston, VA 20191 2503 USA 2505 Email: vbhatia@tnsi.com 2507 Syed Wasim Ali 2508 NeuStar 2509 46000 Center Oak Plaza 2510 Sterling, VA 20166 2511 USA 2513 Email: syed.ali@neustar.biz 2514 David Schwartz 2515 XConnect 2516 316 Regents Park Road 2517 London N3 2XJ 2518 United Kingdom 2520 Email: dschwartz@xconnect.net