idnits 2.17.1 draft-ietf-drinks-spprov-12.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. -- The exact meaning of the all-uppercase expression 'MAY NOT' is not defined in RFC 2119. If it is intended as a requirements expression, it should be rewritten using one of the combinations defined in RFC 2119; otherwise it should not be all-uppercase. == The expression 'MAY NOT', while looking like RFC 2119 requirements text, is not defined in RFC 2119, and should not be used. Consider using 'MUST NOT' instead (if that is what you mean). Found 'MAY NOT' in this paragraph: In some deployments, the SPPP objects that an SPPP registry manages can be private in nature. As a result it MAY NOT be appropriate to for transmission in plain text over a connection to the SPPP registry. Therefore, the transport protocol SHOULD provide means for end-to-end encryption between the SPPP client and server. -- The document date (November 15, 2011) is 4538 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: 'RFC5321' is defined on line 2352, but no explicit reference was found in the text == Outdated reference: A later version (-07) exists of draft-ietf-drinks-sppp-over-soap-06 ** Downref: Normative reference to an Informational RFC: RFC 4949 ** Downref: Normative reference to an Informational RFC: RFC 5067 Summary: 2 errors (**), 0 flaws (~~), 5 warnings (==), 2 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 DRINKS J-F. Mule 3 Internet-Draft CableLabs 4 Intended status: Standards Track K. Cartwright 5 Expires: May 18, 2012 TNS 6 S. Ali 7 NeuStar 8 A. Mayrhofer 9 enum.at GmbH 10 V. Bhatia 11 TNS 12 November 15, 2011 14 Session Peering Provisioning Protocol Data Model 15 draft-ietf-drinks-spprov-12 17 Abstract 19 This document specifies the data model and the overall structure for 20 a protocol to provision session establishment data into Session Data 21 Registries and SIP Service Provider data stores. The protocol is 22 called the Session Peering Provisioning Protocol (SPPP). The 23 provisioned data is typically used by network elements for session 24 peering. 26 Status of this Memo 28 This Internet-Draft is submitted in full conformance with the 29 provisions of BCP 78 and BCP 79. 31 Internet-Drafts are working documents of the Internet Engineering 32 Task Force (IETF). Note that other groups may also distribute 33 working documents as Internet-Drafts. The list of current Internet- 34 Drafts is at http://datatracker.ietf.org/drafts/current/. 36 Internet-Drafts are draft documents valid for a maximum of six months 37 and may be updated, replaced, or obsoleted by other documents at any 38 time. It is inappropriate to use Internet-Drafts as reference 39 material or to cite them other than as "work in progress." 41 This Internet-Draft will expire on May 18, 2012. 43 Copyright Notice 45 Copyright (c) 2011 IETF Trust and the persons identified as the 46 document authors. All rights reserved. 48 This document is subject to BCP 78 and the IETF Trust's Legal 49 Provisions Relating to IETF Documents 50 (http://trustee.ietf.org/license-info) in effect on the date of 51 publication of this document. Please review these documents 52 carefully, as they describe your rights and restrictions with respect 53 to this document. Code Components extracted from this document must 54 include Simplified BSD License text as described in Section 4.e of 55 the Trust Legal Provisions and are provided without warranty as 56 described in the Simplified BSD License. 58 Table of Contents 60 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4 61 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 7 62 3. Protocol High Level Design . . . . . . . . . . . . . . . . . . 9 63 3.1. Protocol Data Model . . . . . . . . . . . . . . . . . . . 9 64 3.2. Time Value . . . . . . . . . . . . . . . . . . . . . . . . 12 65 4. Transport Protocol Requirements . . . . . . . . . . . . . . . 13 66 4.1. Connection Oriented . . . . . . . . . . . . . . . . . . . 13 67 4.2. Request and Response Model . . . . . . . . . . . . . . . . 13 68 4.3. Connection Lifetime . . . . . . . . . . . . . . . . . . . 13 69 4.4. Authentication . . . . . . . . . . . . . . . . . . . . . . 13 70 4.5. Authorization . . . . . . . . . . . . . . . . . . . . . . 14 71 4.6. Confidentiality and Integrity . . . . . . . . . . . . . . 14 72 4.7. Near Real Time . . . . . . . . . . . . . . . . . . . . . . 14 73 4.8. Request and Response Sizes . . . . . . . . . . . . . . . . 14 74 4.9. Request and Response Correlation . . . . . . . . . . . . . 14 75 4.10. Request Acknowledgement . . . . . . . . . . . . . . . . . 14 76 4.11. Mandatory Transport . . . . . . . . . . . . . . . . . . . 15 77 5. Base Protocol Data Structures and Response Codes . . . . . . . 16 78 5.1. Basic Object Type and Organization Identifiers . . . . . . 16 79 5.2. Various Object Key Types . . . . . . . . . . . . . . . . . 16 80 5.2.1. Generic Object Key Type . . . . . . . . . . . . . . . 16 81 5.2.2. Derived Object Key Types . . . . . . . . . . . . . . . 17 82 5.3. Response Message Types . . . . . . . . . . . . . . . . . . 19 83 6. Protocol Data Model Objects . . . . . . . . . . . . . . . . . 22 84 6.1. Destination Group . . . . . . . . . . . . . . . . . . . . 22 85 6.2. Public Identifier . . . . . . . . . . . . . . . . . . . . 23 86 6.3. Route Group . . . . . . . . . . . . . . . . . . . . . . . 27 87 6.4. Route Record . . . . . . . . . . . . . . . . . . . . . . . 31 88 6.5. Route Group Offer . . . . . . . . . . . . . . . . . . . . 35 89 6.6. Egress Route . . . . . . . . . . . . . . . . . . . . . . . 38 90 7. Protocol Operations . . . . . . . . . . . . . . . . . . . . . 40 91 7.1. Add Operation . . . . . . . . . . . . . . . . . . . . . . 40 92 7.2. Delete Operation . . . . . . . . . . . . . . . . . . . . . 40 93 7.3. Get Operations . . . . . . . . . . . . . . . . . . . . . . 41 94 7.4. Accept Operations . . . . . . . . . . . . . . . . . . . . 41 95 7.5. Reject Operations . . . . . . . . . . . . . . . . . . . . 42 96 7.6. Get Server Details Operation . . . . . . . . . . . . . . . 42 97 8. XML Considerations . . . . . . . . . . . . . . . . . . . . . . 43 98 8.1. Namespaces . . . . . . . . . . . . . . . . . . . . . . . . 43 99 8.2. Versioning and Character Encoding . . . . . . . . . . . . 43 100 9. Security Considerations . . . . . . . . . . . . . . . . . . . 44 101 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 46 102 11. Formal Specification . . . . . . . . . . . . . . . . . . . . . 47 103 12. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 56 104 13. References . . . . . . . . . . . . . . . . . . . . . . . . . . 57 105 13.1. Normative References . . . . . . . . . . . . . . . . . . . 57 106 13.2. Informative References . . . . . . . . . . . . . . . . . . 57 107 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 59 109 1. Introduction 111 Service providers and enterprises use registries to make session 112 routing decisions for Voice over IP, SMS and MMS traffic exchanges. 113 This document is narrowly focused on the provisioning protocol for 114 these registries. This protocol prescribes a way for an entity to 115 provision session-related data into a registry. The data being 116 provisioned can be optionally shared with other participating peering 117 entities. The requirements and use cases driving this protocol have 118 been documented in [I-D.ietf-drinks-usecases-requirements]. The 119 reader is expected to be familiar with the terminology defined in the 120 previously mentioned document. 122 Three types of provisioning flows have been described in the use case 123 document: client to registry provisioning, registry to local data 124 repository and registry to registry. This document addresses client 125 to registry aspect to fulfill the need to provision Session 126 Establishment Data (SED). The protocol that supports flow of 127 messages to facilitate client to registry provisioning is referred to 128 as Session Peering Provisioning Protocol (SPPP). 130 Please note that the role of the "client" and the "server" only 131 applies to the connection, and those roles are not related in any way 132 to the type of entity that participates in a protocol exchange. For 133 example, a registry might also include a "client" when such a 134 registry initiates a connection (for example, for data distribution 135 to SSP). 137 *--------* *------------* *------------* 138 | | (1). Client | | (3).Registry | | 139 | Client | ------------> | Registry |<------------->| Registry | 140 | | to Registry | | to Registry | | 141 *--------* *------------* *------------* 142 / \ \ 143 / \ \ 144 / \ \ 145 / \ v 146 / \ ... 147 / \ 148 / (2). Distrib \ 149 / Registry data \ 150 / to local data \ 151 V store V 152 +----------+ +----------+ 153 |Local Data| |Local Data| 154 |Repository| |Repository| 155 +----------+ +----------+ 157 Three Registry Provisioning Flows 159 Figure 1 161 The data provisioned for session establishment is typically used by 162 various downstream SIP signaling systems to route a call to the next 163 hop associated with the called domain. These systems typically use a 164 local data store ("Local Data Repository") as their source of session 165 routing information. More specifically, the SED data is the set of 166 parameters that the outgoing signaling path border elements (SBEs) 167 need to initiate the session. See [RFC5486] for more details. 169 A "terminating" SIP Service Provider (SSP) provisions SED into the 170 registry to be selectively shared with other peer SSPs. 171 Subsequently, a registry may distribute the provisioned data into 172 local data repositories used for look-up queries (identifier -> URI) 173 or for lookup and location resolution (identifier -> URI -> ingress 174 SBE of terminating SSP). In some cases, the registry may 175 additionally offer a central query resolution service (not shown in 176 the above figure). 178 A key requirement for the SPPP protocol is to be able to accommodate 179 two basic deployment scenarios: 181 1. A resolution system returns a Look-Up Function (LUF) that 182 comprises of the target domain to assist in call routing (as 183 described in [RFC5486]). In this case, the querying entity may 184 use other means to perform the Location Routing Function (LRF) 185 which in turn helps determine the actual location of the 186 Signaling Function in that domain. 188 2. A resolution system returns both a Look-Up function (LUF) and 189 Location Routing Function (LRF) to locate the SED data fully. 191 In terms of protocol design, SPPP is agnostic to the transport. This 192 document includes the specification of the data model and identifies, 193 but does not specify, the means to enable protocol operations within 194 a request and response structure. That aspect of the specification 195 has been delegated to the "transport" specification for the protocol. 196 To encourage interoperability, the protocol supports extensibility 197 aspects. 199 Transport requirements are provided in this document to help with the 200 selection of the optimum transport mechanism. 201 ([I-D.ietf-drinks-sppp-over-soap]) identifies a SOAP transport 202 mechanism for SPPP. 204 This document is organized as follows: 206 o Section 2 provides the terminology; 208 o Section 3 provides an overview of SPPP, including the functional 209 entities and data model; 211 o Section 4 specifies requirements for SPPP transport protocols; 213 o Section 5 describes the base protocol data structures, the 214 generic response types that MUST be supported by a conforming 215 "transport" specification, and the basic object type most first 216 class objects extend from; 218 o Section 6 detailed descriptoins of the data model object 219 specifications; 221 o Section 8 defines XML considerations that XML parsers must meet 222 to conform to this specification; 224 o Section 11 normatively defines the SPPP protocol using its XML 225 Schema Definition. 227 2. Terminology 229 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 230 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 231 document are to be interpreted as described in [RFC2119]. 233 This document reuses terms from [RFC3261], [RFC5486], use cases and 234 requirements documented in [I-D.ietf-drinks-usecases-requirements] 235 and the ENUM Validation Architecture [RFC4725]. 237 In addition, this document specifies the following additional terms: 239 SPPP: Session Peering Provisioning Protocol, the protocol used to 240 provision data into a Registry (see arrow labeled "1." in Figure 1 241 of [I-D.ietf-drinks-usecases-requirements]). It is the primary 242 scope of this document. 244 SPDP: Session Peering Distribution Protocol, the protocol used to 245 distribute data to Local Data Repository (see arrow labeled "2." 246 in Figure 1 of [I-D.ietf-drinks-usecases-requirements]). 248 Client: An application that supports an SPPP client; it is 249 sometimes referred to as a "registry client". 251 Registry: The Registry operates a master database of Session 252 Establishment Data for one or more Registrants. 254 A Registry acts as an SPPP server. 256 Registrant: In this document we extend the definition of a 257 Registrant based on [RFC4725]. The Registrant is the end-user, 258 the person or organization that is the "holder" of the Session 259 Establishment Data being provisioned into the Registry by a 260 Registrar. For example, in 261 [I-D.ietf-drinks-usecases-requirements], a Registrant is pictured 262 as a SIP Service Provider in Figure 2. 264 Within the confines of a Registry, a Registrant is uniquely 265 identified by a well-known ID. 267 Registrar: In this document we extend the definition of a Registrar 268 from [RFC4725]. A Registrar is an entity that performs 269 provisioning operations on behalf of a Registrant by interacting 270 with the Registry via SPPP operations. In other words the 271 Registrar is the SPPP Client. The Registrar and Registrant roles 272 are logically separate to allow, but not require, a single 273 Registrar to perform provisioning operations on behalf of more 274 than one Registrant. 276 Peering Organization: A Peering Organization is an entity to which 277 a Registrant's Route Groups are made visible using the operations 278 of SPPP. 280 3. Protocol High Level Design 282 This section introduces the structure of the data model and provides 283 the information framework for the SPPP. An overview of the protocol 284 operations is first provided with a typical deployment scenario. The 285 data model is then defined along with all the objects manipulated by 286 the protocol and their relationships. 288 3.1. Protocol Data Model 290 The data model illustrated and described in Figure 2 defines the 291 logical objects and the relationships between these objects that the 292 SPPP protocol supports. SPPP defines the protocol operations through 293 which an SPPP client populates a registry with these logical objects. 294 Various clients belonging to different registrars may use the 295 protocol for populating the registry's data. 297 The logical structure presented below is consistent with the 298 terminology and requirements defined in 299 [I-D.ietf-drinks-usecases-requirements]. 301 +-------------+ +------------------+ 302 | all object | |Organization: | 303 | types |----->|orgId | 304 +------+------+ | | 305 All objects are +------------------+ 306 associated with an ^ 307 organization to |A Route Group is 308 identify the |associated with +-----[abstract]-+ 309 object's registrant |zero or more Peering | Route Record: | 310 |Organizations | rrName, | 311 | | priority, | 312 +--------+--------------+ | extension | 313 |Route Group: |------->| | 314 | rant, | +----------------+ 315 | rgName, | ^ 316 | destGrpRef, | | 317 | isInSvc, | |Various types 318 | rrRef, | |of Route 319 | peeringOrg, | |Records... 320 | sourceIdent, | +-----+------------+ 321 | priority, | | | | 322 | extension | +----+ +-------+ +----+ 323 +-----------------------+ | URI| | NAPTR | | NS | 324 | +----+ +-------+ +----+ 325 | 326 | +----------[abstract]-+ 327 | |Public Identifier: | 328 | | | 329 | | rant, | 330 v | publicIdentifier, | 331 +----------------------+ | destGrpRef, | 332 | Dest Group: |<----| rrRef, | 333 | rant, | | extension | 334 | dgName, | +---------------------+ 335 | extension | ^ 336 +----------------------+ |Various types 337 |of Public 338 |Identifiers... 339 +---------+-------+------------... 340 | | | | 341 +------+ +-----+ +-----+ +-----+ 342 | TN | | TNP | | TNR | | RN | 343 +------+ +-----+ +-----+ +-----+ 345 SPPP Data Model 347 Figure 2 349 The objects and attributes that comprise the data model can be 350 described as follows (objects listed from the bottom up): 352 o Public Identifier: 353 From a broad perspective a public identifier is a well-known 354 attribute that is used as the key to perform resolution lookups. 355 Within the context of SPPP, a public identifier object can be a 356 telephone number, a range of telephone numbers, a PSTN Routing 357 Number (RN), or a TN prefix. 359 An SPPP Public Identifier is associated with a Destination Group 360 to create a logical grouping of Public Identifiers that share a 361 common set of Routes. 363 A TN Public Identifier may optionally be associated with zero or 364 more individual Route Records. This ability for a Public 365 Identifier to be directly associated with a set of Route Records 366 (e.g. target URI), as opposed to being associated with a 367 Destination Group, supports the use cases where the target URI 368 contains data specifically tailored to an individual TN Public 369 Identifier. 371 o Destination Group: 372 A named collection of zero or more Public Identifiers that can be 373 associated with one or more Route Groups for the purpose of 374 facilitating the management of their common routing information. 376 o Route Group: 377 A Route Group contains a set of Route Record references, a set of 378 Destination Group references, and a set of peering organization 379 identifiers. This is used to establish a three part relationships 380 between a set of Public Identifiers, the routing information (SED) 381 shared across the Public Identifiers, and the list of peering 382 organizations whose query responses from the resolution system may 383 include the routing information from a given route group. In 384 addition, the sourceIdent element within a Route Group, in concert 385 with the set of peering organization identifiers, enables fine- 386 grained source based routing. For further details about the Route 387 Group and source based routing, refer to the definitions and 388 descriptions of the Route Group operations found later in this 389 document. 391 o Route Record: 392 A Route Record contains the data that a resolution system returns 393 in response to a successful query for a Public Identifier. Route 394 Records are generally associated with a Route Group when the SED 395 within is not specific to a Public Identifier. 396 To support the use cases defined in 398 [I-D.ietf-drinks-usecases-requirements], SPPP defines three type 399 of Route Records: URIType, NAPTRType, and NSType. These Route 400 Records extend the abstract type RteRecType and inherit the common 401 attribute 'priority' that is meant for setting precedence across 402 the route records defined within a Route Group in a protocol 403 agnostic fashion. 405 o Organization: 406 An An Organization is an entity that may fulfill any combination 407 of three roles: Registrant, Registrar, and Peering Organization. 408 All SPPP objects are associated with two organization identifiers 409 to identify each object's registrant and registrar. A Route Group 410 object is also associated with a set of zero or more organization 411 identifiers that identify the peering organization(s) whose 412 resolution query responses may include the routing information 413 (SED) defined in the Route Records within that Route Group. A 414 peering organization is an entity that the registrant intends to 415 share the SED data with. 417 3.2. Time Value 419 Some SPPP request and response messages include time value(s) defined 420 as type xs:dateTime, a built-in W3C XML Schema Datatype. Use of 421 unqualified local time value is discouraged as it can lead to 422 interoperability issues. The value of time attribute MUST BE 423 expressed in Coordinated Universal Time (UTC) format without the 424 timezone digits. 426 "2010-05-30T09:30:10Z" is an example of an acceptable time value for 427 use in SPPP messages. "2010-05-30T06:30:10+3:00" is a valid UTC time, 428 but it is not approved for use in SPPP messages. 430 4. Transport Protocol Requirements 432 This section provides requirements for transport protocols suitable 433 for SPPP. More specifically, this section specifies the services, 434 features, and assumptions that SPPP delegates to the chosen transport 435 and envelope technologies. 437 4.1. Connection Oriented 439 The SPPP follows a model where a client establishes a connection to a 440 server in order to further exchange SPPP messages over such point-to- 441 point connection. A transport protocol for SPPP MUST therefore be 442 connection oriented. 444 4.2. Request and Response Model 446 Provisioning operations in SPPP follow the request-response model, 447 where a client sends a request message to initiate a transaction and 448 the server responds with a response. Multiple subsequent request- 449 response exchanges MAY be performed over a single persistent 450 connection. 452 Therefore, a transport protocol for SPPP MUST follow the request- 453 response model by allowing a response to be sent to the request 454 initiator. 456 4.3. Connection Lifetime 458 Some use cases involve provisioning a single request to a network 459 element. Connections supporting such provisioning requests might be 460 short-lived, and may be established only on demand. Other use cases 461 involve either provisioning a large dataset, or a constant stream of 462 small updates, either of which would likely require long-lived 463 connections. 465 Therefore, a protocol suitable for SPPP SHOULD be able to support 466 both short-lived as well as long-lived connections. 468 4.4. Authentication 470 All SPPP objects are associated with a registrant identifier. SPPP 471 Clients provisions SPPP objects on behalf of registrants. An 472 authenticated SPP Client is a registrar. Therefore, the SPPP 473 transport protocol MUST provide means for an SPPP server to 474 authenticate an SPPP Client. 476 4.5. Authorization 478 After successful authentication of the SPPP client as a registrar the 479 registry performs authorization checks to determine if the registrar 480 is authorized to act on behalf of the Registrant whose identifier is 481 included in the SPPP request. Refer to the Security Considerations 482 section for further guidance. 484 4.6. Confidentiality and Integrity 486 In some deployments, the SPPP objects that an SPPP registry manages 487 can be private in nature. As a result it MAY NOT be appropriate to 488 for transmission in plain text over a connection to the SPPP 489 registry. Therefore, the transport protocol SHOULD provide means for 490 end-to-end encryption between the SPPP client and server. 492 For some SPPP implementations, it may be acceptable for the data to 493 be transmitted in plain text, but the failure to detect a change in 494 data after it leaves the SPPP client and before it is received at the 495 server, either by accident or with a malicious intent, will adversely 496 affect the stability and integrity of the registry. Therefore, the 497 transport protocol SHOULD provide means for data integrity 498 protection. 500 4.7. Near Real Time 502 Many use cases require near real-time responses from the server. 503 Therefore, a DRINKS transport protocol MUST support near real-time 504 response to requests submitted by the client. 506 4.8. Request and Response Sizes 508 Use of SPPP may involve simple updates that may consist of small 509 number of bytes, such as, update of a single public identifier. 510 Other provisioning operations may constitute large number of datasets 511 as in adding millions records to a registry. As a result, a suitable 512 transport protocol for SPPP SHOULD accommodate datasets of various 513 sizes. 515 4.9. Request and Response Correlation 517 A transport protocol suitable for SPPP MUST allow responses to be 518 correlated with requests. 520 4.10. Request Acknowledgement 522 Data transported in the SPPP is likely crucial for the operation of 523 the communication network that is being provisioned. A SPPP client 524 responsible for provisioning SED to the registry has a need to know 525 if the submitted requests have been processed correctly. 527 Failed transactions can lead to situations where a subset of public 528 identifiers or even SSPs might not be reachable, or the provisioning 529 state of the network is inconsistent. 531 Therefore, a transport protocol for SPPP MUST provide a response for 532 each request, so that a client can identify whether a request 533 succeeded or failed. 535 4.11. Mandatory Transport 537 At the time of this writing, a choice of transport protocol has been 538 provided in [I-D.ietf-drinks-sppp-over-soap]. To encourage 539 interoperability, the SPPP server MUST provide support for this 540 transport protocol. With time, it is possible that other transport 541 layer choices may surface that agree with the requirements discussed 542 above. 544 5. Base Protocol Data Structures and Response Codes 546 SPPP contains some common data structures for most of the supported 547 object types. This section describes these common data structures. 549 5.1. Basic Object Type and Organization Identifiers 551 This section introduces the basic object type that most first class 552 objects derive from. 554 All first class objects extend the basic object type BasicObjType 555 that contains the identifier of the registrant organization that owns 556 this object, the identifier of the registrar organization that 557 created this object, the date and time that the object was created by 558 the server, and the date and time that the object was last modified. 560 561 562 563 564 566 568 570 571 573 The identifiers used for registrants (rant), registrars (rar), and 574 peering organizations (peeringOrg) are instances of OrgIdType. The 575 OrgIdType is defined as a string and all OrgIdType instances SHOULD 576 follow the textual convention: "namespace:value" (for example "iana- 577 en:32473"). See the IANA Consideration section for more details. 579 5.2. Various Object Key Types 581 5.2.1. Generic Object Key Type 583 The SPPP data model contains some object relationships. In some 584 cases these object relationships are established by embedding the 585 unique identity of the related object inside the relating object. In 586 addition, an object's unique identity is required to Delete or Get 587 the details of an object. The abstract type called ObjKeyType is 588 where this unique identity is housed. Because this object key type 589 is abstract, it MUST be specified in a concrete form in any 590 conforming SPPP "transport" specification. 592 Most objects in SPPP are uniquely identified by an object key that 593 has the object's name, object's type and its registrant's 594 organization ID as its attributes. Consequently, any concrete 595 representation of the ObjKeyType MUST contain the following: 597 Object Name: The name of the object. 599 Registrant Id: The unique organization ID that identifies the 600 Registrant. 602 Type: The enumeration vaue that represents the type of SPPP object 603 that. This is required as different types of objects in SPPP, 604 that belong to the same registrant, can have the same name. 606 The structure of abstract ObjKeyType is as follows: 608 609 610 611 ---- Generic type that represents the 612 key for various objects in SPPP. ---- 613 614 615 617 The object types in SPPP that MUST adhere to this definition of 618 generic object key are defined as an enumeration in the XML data 619 structure. The structure of the the enumeration is as follows: 621 622 623 624 625 626 627 628 630 5.2.2. Derived Object Key Types 632 The SPPP data model contains certain objects that are uniquely 633 identified by attributes, different from or in addition to, the 634 attributes in the generic object key described in previous section. 635 These kind of object keys are derived from the abstract ObjKeyType 636 and defined in there own abstract key types. Because these object 637 key types are abstract, these MUST be specified in a concrete form in 638 any conforming SPPP "transport" specification. These are used in 639 Delete and Get operations, and may also be used in Accept and Reject 640 operations. 642 Following are the derived object keys in SPPP data model: 644 o RteGrpOfferKeyType: This uniquely identifies a Route Group 645 object offer. This key type extends from ObjKeyType and MUST 646 also have the organization ID of the Registrant to whom the 647 object is being offered, as one of its attributes. In addition 648 to the Delete and Get operations, these key types are used in 649 Accept and Reject operations on a Route Group Offer object. The 650 structure of abstract RteGrpOfferKeyType is as follows: 652 654 655 656 657 658 ---- Generic type that represents the 659 key for a object offer. ---- 660 661 662 663 664 666 A Route Group Offer object MUST use RteGrpOfferKeyType. Refer 667 the "Protocol Data Model Objects" section of this document for 668 description of Route Group Offer object. 670 o PubIdKeyType: This uniquely identifies a Public Identity object. 671 This key type extends from abstract ObjKeyType. Any concrete 672 defintion of PubIdKeyType MUST contain the elements that 673 identify the value and type of Public Identity and also contain 674 the organization ID of the Registrant that is the owner of the 675 Public Identity object. A Public Identity object key in SPPP is 676 uniquely identified by the the registrant's organization ID, the 677 value of the public identity, and, optionally, the Destination 678 Group name the public identiy belongs to. Consequently, any 679 concrete representation of the ObjKeyType MUST contain the 680 following attributes: 682 * Registrant Id: The unique organization ID that identifies 683 the Registrant. 685 * Destination Group name: The name of the Destination Group 686 the Public Identity is associated with. This is an 687 optional attribute. 689 * Type: The type of Public Identity. 691 * Value: The value of the Public Identity. 693 The .PubIdKeyType is used in Delete and Get operations on a 694 Public Identifier object. 696 o The structure of abstract PubIdKeyType is as follows: 698 699 700 701 702 703 ---- Generic type that represents 704 the key for a Pub Id. ---- 705 706 707 708 709 711 A Public Identity object MUST use attributes of PubIdKeyType for its 712 unique identification . Refer the "Protocol Data Model Objects" 713 section of this document for a description of Public Identity object. 715 5.3. Response Message Types 717 This section contains the listing of response types that MUST be 718 defined by the conforming "transport" specification and implemented 719 by a conforming SPPP server. 721 +---------------------+---------------------------------------------+ 722 | Response Type | Description | 723 +---------------------+---------------------------------------------+ 724 | Request Succeeded | Any conforming specification MUST define a | 725 | | response to indicate that a given request | 726 | | succeeded. | 727 | | | 728 | Request syntax | Any conforming specification MUST define a | 729 | invalid | response to indicate that a syntax of a | 730 | | given request was found invalid. | 731 | | | 732 | Request too large | Any conforming specification MUST define a | 733 | | response to indicate that the count of | 734 | | entities in the request is larger than the | 735 | | server is willing or able to process. | 736 | | | 737 | Version not | Any conforming specification MUST define a | 738 | supported | response to indicate that the server does | 739 | | not support the version of the SPPP | 740 | | protocol specified in the request. | 741 | | | 742 | Command invalid | Any conforming specification MUST define a | 743 | | response to indicate that the operation | 744 | | and/or command being requested by the | 745 | | client is invalid and/or not supported by | 746 | | the server. | 747 | | | 748 | System temporarily | Any conforming specification MUST define a | 749 | unavailable | response to indicate that the SPPP server | 750 | | is temporarily not available to serve | 751 | | client request. | 752 | | | 753 | Unexpected internal | Any conforming specification MUST define a | 754 | system or server | response to indicate that the SPPP server | 755 | error. | encountered an unexpected error that | 756 | | prevented the server from fulfilling the | 757 | | request. | 758 | | | 759 | Attribute value | Any conforming specification MUST define a | 760 | invalid | response to indicate that the SPPP server | 761 | | encountered an attribute or property in the | 762 | | request that had an invalid/bad value. | 763 | | Optionally, the specification MAY provide a | 764 | | way to indicate the Attribute Name and the | 765 | | Attribute Value to identify the object that | 766 | | was found to be invalid. | 767 | | | 768 | Object does not | Any conforming specification MUST define a | 769 | exist | response to indicate that an object present | 770 | | in the request does not exist on the SPPP | 771 | | server. Optionally, the specification MAY | 772 | | provide a way to indicate the Attribute | 773 | | Name and the Attribute Value that | 774 | | identifies the non-existent object. | 775 | | | 776 | Object status or | Any conforming specification MUST define a | 777 | ownership does not | response to indicate that the operation | 778 | allow for | requested on an object present in the | 779 | operation. | request cannot be performed because the | 780 | | object is in a status that does not allow | 781 | | the said operation or the user requesting | 782 | | the operation is not authorized to perform | 783 | | the said operation on the object. | 784 | | Optionally, the specification MAY provide a | 785 | | way to indicate the Attribute Name and the | 786 | | Attribute Value that identifies the object. | 787 +---------------------+---------------------------------------------+ 789 Table 1: Response Types 791 When the response messages are "parameterized" with the Attribute 792 Name and Attribute Value, then the use of these parameters MUST 793 adhere to the following rules: 795 o Any value provided for the Attribute Name parameter MUST be an 796 exact XSD element name of the protocol data element that the 797 response message is referring to. For example, valid values for 798 "attribute name" are "dgName", "rgName", "rteRec", etc. 800 o The value for Attribute Value MUST be the value of the data 801 element to which the preceding Attribute Name refers. 803 o Response type "Attribute value invalid" SHOULD be used whenever 804 an element value does not adhere to data validation rules. 806 o Response types "Attribute value invalid" and "Object does not 807 exist" MUST NOT be used interchangeably. Response type "Object 808 does not exist" SHOULD be returned by an Add/Del/Accept/Reject 809 operation when the data element(s) used to uniquely identify a 810 pre-existing object do not exist. If the data elements used to 811 uniquely identify an object are malformed, then response type 812 "Attribute value invalid" SHOULD be returned. 814 6. Protocol Data Model Objects 816 This section provides a description of the specification of each 817 supported data model object (the nouns) and identifies the commands 818 (the verbs) that MUST be supported for each data model object. 819 However, the specification of the data structures necessary to 820 support each command is delegated to the "transport" specification. 822 6.1. Destination Group 824 As described in the introductory sections, a Destination Group 825 represents a set of Public Identifiers with common routing 826 information. The transport protocol MUST support the ability to 827 Create, Modify, Get, and Delete Destination Groups (refer the 828 "Protocol Operations" section of this document for a generic 829 description of various operations). 831 A Destination Group object MUST be uniquely identified by attributes 832 as defined in the description of "ObjKeyType" in the section "Generic 833 Object Key Type" of this document. 835 The DestGrpType object structure is defined as follows: 837 838 839 840 841 842 843 844 845 847 The DestGrpType object is composed of the following elements: 849 o base: All first class objects extend BasicObjType that contains 850 the ID of the registrant organization that owns this object, 851 registrar organization that provisioned this object on behalf of 852 the registrant, the date and time that the object was created by 853 the server, and the date and time that the object was last 854 modified. If the client passed in either the created date or 855 the modification date, the server will ignore them. The server 856 sets these two date/time values. 858 o dgName: The character string that contains the name of the 859 Destination Group. 861 o ext: Point of extensibility described in a previous section of 862 this document. 864 6.2. Public Identifier 866 A Public Identifier is the search key used for locating the session 867 establishment data (SED). In many cases, a Public Identifier is 868 attributed to the end user who has a retail relationship with the 869 service provider or registrant organization. SPPP supports the 870 notion of the carrier-of-record as defined in [RFC5067]. Therefore, 871 the registrant under whom the Public Identity is being created can 872 optionally claim to be a carrier-of-record. 874 SPPP identifies two types of Public Identifiers: telephone numbers 875 (TN), and the routing numbers (RN). SPPP provides structures to 876 manage a single TN, a contiguous range of TNs, and a TN prefix. The 877 transport protocol MUST support the ability to Create, Modify, Get, 878 and Delete Public Identifiers (refer the "Protocol Operations" 879 section of this document for a generic description of various 880 operations). 882 A Public Identity object MUST be uniquely identified by attributes as 883 defined in the description of "PubIdKeyType" in the section "Derived 884 Object Key Types" of this document. 886 The abstract XML schema type definition PubIDType is a generalization 887 for the concrete the Public Identifier schema types. PubIDType 888 element 'dgName' represents the name of the destination group that a 889 given Public Identifier MAY be a member of. The PubIDType object 890 structure is defined as follows: 892 893 894 895 896 898 899 900 901 903 A Public Identifier may be provisioned as a member of a Destination 904 Group or provisioned outside of a Destination Group. A Public 905 Identifier that is provisioned as a member of a Destination Group is 906 intended to be associated with its SED through the Route Group(s) 907 that are associated with its containing Destination Group. A Public 908 Identifier that is not provisioned as a member of a Destination Group 909 is intended to be associated with its SED through the Route Records 910 that are directly associated with the Public Identifier. 912 A telephone number is provisioned using the TNType, an extension of 913 PubIDType. When a Public Identifier is provisioned as a member of a 914 Destination Group, each TNType object is uniquely identified by the 915 combination of its value contained within element, and the 916 unique key of its parent Destination Group (dgName and rantId). In 917 other words a given telephone number string may exist within one or 918 more Destination Groups, but must not exist more than once within a 919 Destination Group. A Public Identifier that is not provisioned as a 920 member of a Destination Group is uniquely identified by the 921 combination of its value, and its registrant ID. TNType is defined 922 as follows: 924 925 926 927 928 930 932 935 936 937 938 940 941 942 943 944 945 947 TNType consists of the following attributes: 949 o tn: Telephone number to be added to the registry. 951 o rrRef: Optional reference to route records that are directly 952 associated with the TN Public Identifier. Following the SPPP 953 data model, the route record could be a protocol agnostic 954 URIType or another type. 956 o corInfo: corInfo is an optional parameter of type CORInfoType 957 that allows the registrant organization to set forth a claim to 958 be the carrier-of-record (see [RFC5067]). This is done by 959 setting the value of element of the CORInfoType 960 object structure to "true". The other two parameters of the 961 CORInfoType, and are set by the registry to 962 describe the outcome of the carrier-of-record claim by the 963 registrant. In general, inclusion of parameter is 964 useful if the registry has the authority information, such as, 965 the number portability data, etc., in order to qualify whether 966 the registrant claim can be satisfied. If the carrier-of-record 967 claim disagrees with the authority data in the registry, whether 968 the TN add operation fails or not is a matter of policy and it 969 is beyond the scope of this document. 971 A routing number is provisioned using the RNType, an extension of 972 PubIDType. SSPs that possess the number portability data may be able 973 to leverage the RN search key to discover the ingress routes for 974 session establishment. Therefore, the registrant organization can 975 add the RN and associate it with the appropriate destination group to 976 share the route information. Each RNType object is uniquely 977 identified by the combination of its value inside the element, 978 and the unique key of its parent Destination Group (dgName and 979 rantId). In other words a given routing number string may exist 980 within one or more Destination Groups, but must not exist more than 981 once within a Destination Group. RNType is defined as follows: 983 984 985 986 987 989 991 992 993 994 996 RNType has the following attributes: 998 o rn: Routing Number used as the search key. 1000 o corInfo: Optional element of type CORInfoType. 1002 TNRType structure is used to provision a contiguous range of 1003 telephone numbers. The object definition requires a starting TN and 1004 an ending TN that together define the span of the TN range. Use of 1005 TNRType is particularly useful when expressing a TN range that does 1006 not include all the TNs within a TN block or prefix. The TNRType 1007 definition accommodates the open number plan as well such that the 1008 TNs that fall between the start and end TN range may include TNs with 1009 different length variance. Whether the registry can accommodate the 1010 open number plan semantics is a matter of policy and is beyond the 1011 scope of this document. Each TNRType object is uniquely identified 1012 by the combination of its value that in turn is a combination of the 1013 and elements, and the unique key of its parent 1014 Destination Group (dgName and rantId). In other words a given TN 1015 Range may exist within one or more Destination Groups, but must not 1016 exist more than once within a Destination Group. TNRType object 1017 structure definition is as follows: 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1030 1031 1032 1033 1034 1035 1037 TNRType has the following attributes: 1039 o startTn: Starting TN in the TN range 1041 o endTn: The last TN in the TN range 1043 o corInfo: Optional element of type CORInfoType 1045 In some cases, it is useful to describe a set of TNs with the help of 1046 the first few digits of the telephone number, also referred to as the 1047 telephone number prefix or a block. A given TN prefix may include 1048 TNs with different length variance in support of open number plan. 1049 Once again, whether the registry supports the open number plan 1050 semantics is a matter of policy and it is beyond the scope of this 1051 document. The TNPType data structure is used to provision a TN 1052 prefix. Each TNPType object is uniquely identified by the 1053 combination of its value in the element, and the unique 1054 key of its parent Destination Group (dgName and rantId). TNPType is 1055 defined as follows: 1057 1058 1059 1060 1061 1063 1065 1066 1067 1068 1070 TNPType consists of the following attributes: 1072 o tnPrefix: The telephone number prefix 1074 o corInfo: Optional element of type CORInfoType. 1076 6.3. Route Group 1078 As described in the introductory sections, a Route Group represents a 1079 combined grouping of Route Records that define route information, 1080 Destination Groups that contain a set of Public Identifiers with 1081 common routing information, and the list of peer organizations that 1082 have access to these public identifiers using this route information. 1083 It is this indirect linking of public identifiers to their route 1084 information that significantly improves the scalability and 1085 manageability of the peering data. Additions and changes to routing 1086 information are reduced to a single operation on a Route Group or 1087 Route Record , rather than millions of data updates to individual 1088 public identifier records that individually contain their peering 1089 data. The transport protocol MUST support the ability to Create, 1090 Modify, Get, and Delete Route Groups (refer the "Protocol Operations" 1091 section of this document for a generic description of various 1092 operations). 1094 A Route Group object MUST be uniquely identified by attributes as 1095 defined in the description of "ObjKeyType" in the section "Generic 1096 Object Key Type" of this document. 1098 The RteGrpType object structure is defined as follows: 1100 1101 1102 1103 1104 1105 1107 1109 1111 1114 1115 1116 1118 1119 1120 1121 1123 1124 1125 1126 1127 1129 1130 1132 The RteGrpType object is composed of the following elements: 1134 o base: All first class objects extend BasicObjType that contains 1135 the ID of the registrant organization that owns this object, the 1136 date and time that the object was created by the server, and the 1137 date and time that the object was last modified. If the client 1138 passes in either the created date or the modification date, the 1139 server will ignore them. The server sets these two date/time 1140 values. 1142 o rgName: The character string that contains the name of the Route 1143 Group. It uniquely identifies this object within the context of 1144 the registrant ID (a child element of the base element as 1145 described above). 1147 o rrRef: Set of zero or more objects of type RteRecRefType that 1148 house the unique keys of the Route Records that the RteGrpType 1149 object refers to and their relative priority within the context 1150 of a given route group. The associated Route Records contain 1151 the routing information, sometimes called SED, associated with 1152 this Route Group. 1154 o dgName: Set of zero or more names of DestGrpType object 1155 instances. Each dgName name, in association with this Route 1156 Group's registrant ID, uniquely identifies a DestGrpType object 1157 instance whose public identifiers are reachable using the 1158 routing information housed in this Route Group. An intended 1159 side affect of this is that a Route Group cannot provide routing 1160 information for a Destination Group belonging to another 1161 registrant. 1163 o peeringOrg: Set of zero or more peering organization IDs that 1164 have accepted an offer to receive this Route Group's 1165 information. The set of peering organizations in this list is 1166 not directly settable or modifiable using the addRteGrpsRqst 1167 operation. This set is instead controlled using the route offer 1168 and accept operations. 1170 o sourceIdent: Set of zero or more SourceIdentType object 1171 instances. These objects, described further below, house the 1172 source identification schemes and identifiers that are applied 1173 at resolution time as part of source based routing algorithms 1174 for the Route Group. 1176 o isInSvc: A boolean element that defines whether this Route Group 1177 is in service. The routing information contained in a Route 1178 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 Route Group. The routing 1181 information contained in a Route Group that is not in service is 1182 not a candidate for inclusion in resolution responses. 1184 o priority: Zero or one priority value that can be used to provide 1185 a relative value weighting of one Route Group over another. The 1186 manner in which this value is used, perhaps in conjunction with 1187 other factors, is a matter of policy. 1189 o ext: Point of extensibility described in a previous section of 1190 this document. 1192 As described above, the Route Group contains a set of references to 1193 route record objects. A route record object is based on an abstract 1194 type: RteRecType. The concrete types that use RteRecType as an 1195 extension base are NAPTRType, NSType, and URIType. The definitions 1196 of these types are included the Route Record section of this 1197 document. 1199 The RteGrpType object provides support for source-based routing via 1200 the peeringOrg data element and more granular source base routing via 1201 the source identity element. The source identity element provides 1202 the ability to specify zero or more of the following in association 1203 with a given Route Group: a regular expression that is matched 1204 against the resolution client IP address, a regular expression that 1205 is matched against the root domain name(s), and/or a regular 1206 expression that is matched against the calling party URI(s). The 1207 result will be that, after identifying the visible Route Groups whose 1208 associated Destination Group(s) contain the lookup key being queried 1209 and whose peeringOrg list contains the querying organizations 1210 organization ID, the resolution server will evaluate the 1211 characteristics of the Source URI, and Source IP address, and root 1212 domain of the lookup key being queried. The resolution server then 1213 compares these criteria against the source identity criteria 1214 associated with the Route Groups. The routing information contained 1215 in Route Groups that have source based routing criteria will only be 1216 included in the resolution response if one or more of the criteria 1217 matches the source criteria from the resolution request. The Source 1218 Identity data element is of type SourceIdentType, whose structure is 1219 defined as follows: 1221 1222 1223 1224 1226 1228 1229 1231 1232 1233 1234 1235 1236 1237 1239 The SourceIdentType object is composed of the following data 1240 elements: 1242 o sourceIdentScheme: The source identification scheme that this 1243 source identification criteria applies to and that the 1244 associated sourceIdentRegex should be matched against. 1246 o sourceIdentRegex: The regular expression that should be used to 1247 test for a match against the portion of the resolution request 1248 that is dictated by the associated sourceIdentScheme. 1250 o ext: Point of extensibility described in a previous section of 1251 this document. 1253 6.4. Route Record 1255 As described in the introductory sections, a Route Group represents a 1256 combined grouping of Route Records that define route information. 1257 However, Route Records need not be created to just serve a single 1258 Route Group. Route Records can be created and managed to serve 1259 multiple Route Groups. As a result, a change to the properties of a 1260 network node used for multiple routes, would necessitate just a 1261 single update operation to change the properties of that node. The 1262 change would then be reflected in all the Route Groups whose route 1263 record set contains a reference to that node. The transport protocol 1264 MUST support the ability to Create, Modify, Get, and Delete Route 1265 Records (refer the "Protocol Operations" section of this document for 1266 a generic description of various operations). 1268 A Route Record object MUST be uniquely identified by attributes as 1269 defined in the description of "ObjKeyType" in the section "Generic 1270 Object Key Type" of this document. 1272 The RteRecType object structure is defined as follows: 1274 1275 1276 1277 1278 1279 1281 1282 1283 1284 1286 The RteRecType object is composed of the following elements: 1288 o base: All first class objects extend BasicObjType that contains 1289 the ID of the registrant organization that owns this object, the 1290 date and time that the object was created by the server, and the 1291 date and time that the object was last modified. If the client 1292 passes in either the created date or the modification date, the 1293 server will ignore them. The server sets these two date/time 1294 values. 1296 o rrName: The character string that contains the name of the Route 1297 Record. It uniquely identifies this object within the context 1298 of the registrant ID (a child element of the base element as 1299 described above). 1301 o priority: Zero or one priority value that can be used to provide 1302 a relative value weighting of one Route Record over another. 1303 The manner in which this value is used, perhaps in conjunction 1304 with other factors, is a matter of policy. 1306 As described above, route records are based on an abstract type: 1307 RteRecType. The concrete types that use RteRecType as an extension 1308 base are NAPTRType, NSType, and URIType. The definitions of these 1309 types are included below. The NAPTRType object is comprised of the 1310 data elements necessary for a NAPTR that contains routing information 1311 for a Route Group. The NSType object is comprised of the data 1312 elements necessary for a DNS name server that points to another DNS 1313 server that contains the desired routing information. The NSType is 1314 relevant only when the resolution protocol is ENUM. The URIType 1315 object is comprised of the data elements necessary to house a URI. 1317 The data provisioned in a registry can be leveraged for many purposes 1318 and queried using various protocols including SIP, ENUM and others. 1319 It is for this reason that a route record type offers a choice of URI 1320 and DNS resource record types. URIType fulfills the need for both 1321 SIP and ENUM protocols. When a given URIType is associated to a 1322 destination group, the user part of the replacement string that 1323 may require the Public Identifier cannot be preset. As a SIP 1324 Redirect, the resolution server will apply pattern on the input 1325 Public Identifier in the query and process the replacement string by 1326 substituting any back reference(s) in the to arrive at the 1327 final URI that is returned in the SIP Contact header. For an ENUM 1328 query, the resolution server will simply return the value of the 1329 and members of the URIType in the NAPTR REGEX parameter. 1331 1332 1333 1334 1335 1336 1338 1339 1341 1343 1345 1347 1348 1349 1350 1352 1353 1354 1355 1356 1357 1359 1361 1363 1365 1366 1367 1369 1370 1371 1372 1374 1375 1377 1379 1380 1381 1382 1383 1384 1386 1387 1388 1389 1390 1392 1393 1395 1396 1397 1398 1400 1401 1402 1403 1404 1405 1407 The NAPTRType object is composed of the following elements: 1409 o order: Order value in an ENUM NAPTR, relative to other NAPTRType 1410 objects in the same Route Group. 1412 o svcs: ENUM service(s) that are served by the SBE. This field's 1413 value must be of the form specified in [RFC6116] (e.g., E2U+ 1414 pstn:sip+sip). The allowable values are a matter of policy and 1415 not limited by this protocol. 1417 o regx: NAPTR's regular expression field. If this is not included 1418 then the Repl field must be included. 1420 o repl: NAPTR replacement field, should only be provided if the 1421 Regex field is not provided, otherwise the server will ignore it 1423 o ttl: Number of seconds that an addressing server may cache this 1424 NAPTR. 1426 o ext: Point of extensibility described in a previous section of 1427 this document. 1429 The NSType object is composed of the following elements: 1431 o hostName: Fully qualified host name of the name server. 1433 o ipAddr: Zero or more objects of type IpAddrType. Each object 1434 holds an IP Address and the IP Address type, IPv4 or IP v6. 1436 o ttl: Number of seconds that an addressing server may cache this 1437 DNS name server. 1439 o ext: Point of extensibility described in a previous section of 1440 this document. 1442 The URIType object is composed of the following elements: 1444 o ere: The POSIX Extended Regular Expression (ere) as defined in 1445 [RFC3986]. 1447 o uri: the URI as defined in [RFC3986]. In some cases, this will 1448 serve as the replacement string and it will be left to the 1449 resolution server to arrive at the final usable URI. 1451 6.5. Route Group Offer 1453 The list of peer organizations whose resolution responses can include 1454 the routing information contained in a given Route Group is 1455 controlled by the organization to which a Route Group object belongs 1456 (its registrant), and the peer organization that submits resolution 1457 requests (a data recipient, also know as a peering organization). 1458 The registrant offers access to a Route Group by submitting a Route 1459 Group Offer. The data recipient can then accept or reject that 1460 offer. Not until access to a Route Group has been offered and 1461 accepted will the data recipient's organization ID be included in the 1462 peeringOrg list in a Route Group object, and that Route Group's 1463 peering information become a candidate for inclusion in the responses 1464 to the resolution requests submitted by that data recipient. The 1465 transport protocol MUST support the ability to Create, Modify, Get, 1466 Delete, Accept and Reject Route Group Offers (refer the "Protocol 1467 Operations" section of this document for a generic description of 1468 various operations). 1470 A Route Group Offer object MUST be uniquely identified by attributes 1471 as defined in the description of "RteGrpOfferKeyType" in the section 1472 "Derived Object Key Types" of this document. 1474 The RteGrpOfferType object structure is defined as follows: 1476 1477 1478 1479 1480 1482 1484 1485 1487 1489 1490 1491 1492 1494 1495 1496 1497 -- Generic type that represents the key for a route 1498 route group offer. Must be defined in concrete form 1499 in the transport specificaiton. -- 1500 1501 1502 1504 1505 1506 1507 1508 1509 1511 The RteGrpOfferType object is composed of the following elements: 1513 o base: All first class objects extend BasicObjType that contains 1514 the ID of the registrant organization that owns this object, the 1515 date and time that the object was created by the server, and the 1516 date and time that the object was last modified. If the client 1517 passed in either the created date or the modification date, the 1518 will ignore them. The server sets these two date/time values. 1520 o rteGrpOfferKey: The object that identifies the route that is or 1521 has been offered and the organization that it is or has been 1522 offered to. 1524 o status: The status of the offer, offered or accepted. The 1525 server controls the status. It is automatically set to 1526 "offered" when ever a new Route Group Offer is added, and is 1527 automatically set to "accepted" if and when that offer is 1528 accepted. The value of the element is ignored when passed in by 1529 the client. 1531 o offerDateTime: Date and time in UTC when the Route Group Offer 1532 was added. 1534 o acceptDateTime: Date and time in UTC when the Route Group Offer 1535 was accepted. 1537 6.6. Egress Route 1539 In a high-availability environment, the originating SSP likely has 1540 more than one egress paths to the ingress SBE of the target SSP. If 1541 the originating SSP wants to exercise greater control and choose a 1542 specific egress SBE to be associated to the target ingress SBE, it 1543 can do so using the EgrRteType object. 1545 A Egress Route object MUST be uniquely identified by attributes as 1546 defined in the description of "ObjKeyType" in the section "Generic 1547 Object Key Type" of this document. 1549 Lets assume that the target SSP has offered to share one or more 1550 ingress route information and that the originating SSP has accepted 1551 the offer. In order to add the egress route to the registry, the 1552 originating SSP uses a valid regular expression to rewrite ingress 1553 route in order to include the egress SBE information. Also, more 1554 than one egress route can be associated with a given ingress route in 1555 support of fault-tolerant configurations. The supporting SPPP 1556 structure provides a way to include route precedence information to 1557 help manage traffic to more than one outbound egress SBE. 1559 The transport protocol MUST support the ability to Add, Modify, Get, 1560 and Delete Egress Routes (refer the "Protocol Operations" section of 1561 this document for a generic description of various operations). The 1562 EgrRteType object structure is defined as follows: 1564 1565 1566 1567 1568 1569 1570 1572 1574 1576 1577 1578 1579 1581 The EgrRteType object is composed of the following elements: 1583 o base: All first class objects extend BasicObjType that contains 1584 the ID of the registrant organization that owns this object, the 1585 date and time that the object was created by the server, and the 1586 date and time that the object was last modified. If the client 1587 passes in either the created date or the modification date, the 1588 server will ignore them. The server sets these two date/time 1589 values. 1591 o egrRteName: The name of the egress route. 1593 o pref: The preference of this egress route relative to other 1594 egress routes that may get selected when responding to a 1595 resolution request. 1597 o regxRewriteRule: The regular expression re-write rule that 1598 should be applied to the regular expression of the ingress 1599 NAPTR(s) that belong to the ingress route. 1601 o ingrRteRec: The ingress route records that the egress route 1602 should be used for. 1604 o ext: Point of extensibility described in a previous section of 1605 this document. 1607 7. Protocol Operations 1609 7.1. Add Operation 1611 Any conforming "transport" specification MUST provide a definition 1612 for the operation that adds one or more SPPP objects into the 1613 registry. If the object, as identified by the request attributes 1614 that form part of the object's key, does not exist, then the registry 1615 MUST create the object. If the object does exist, then the registry 1616 MUST replace the current properties of the object with the properties 1617 passed in as part of the Add operation. 1619 If the entity that issued the command is not authorized to perform 1620 this operation an appropriate error message MUST be returned from 1621 amongst the response messages defined in "Response Message Types" 1622 section of the document. 1624 7.2. Delete Operation 1626 Any conforming "transport" specification MUST provide a definition 1627 for the operation that deletes one or more SPPP objects from the 1628 registry using the object's key. 1630 If the entity that issued the command is not authorized to perform 1631 this operation an appropriate error message MUST be returned from 1632 amongst the response messages defined in "Response Message Types" 1633 section of the document. 1635 When an object is deleted, any references to that object must of 1636 course also be removed as the SPPP server implementation fulfills the 1637 deletion request. Furthermore, the deletion of a composite object 1638 must also result in the deletion of the objects it contains. As a 1639 result, the following rules apply to the deletion of SPPP object 1640 types: 1642 o Destination Groups: When a destination group is deleted all 1643 public identifiers within that destination group must also be 1644 automatically deleted by the SPPP implementation as part of 1645 fulfilling the deletion request. And any references between 1646 that destination group and any route group must be automatically 1647 removed by the SPPP implementation as part of fulfilling the 1648 deletion request. 1650 o Route Groups: When a route group is deleted any references 1651 between that route group and any destination group must be 1652 automatically removed by the SPPP implementation as part of 1653 fulfilling the deletion request. Similarly any references 1654 between that route group and any route records must be removed 1655 by the SPPP implementation as part of fulfilling the deletion 1656 request. Furthermore, route group offers relating that route 1657 group must also be deleted as part of fulfilling the deletion 1658 request. 1660 o Route Records: When a route record is deleted any references 1661 between that route record and any route group must be removed by 1662 the SPPP implementation as part of fulfilling the deletion 1663 request. 1665 o Public Identifiers: When a public identifier is deleted any 1666 references between that public identifier and its containing 1667 destination group must be removed by the SPPP implementation as 1668 part of fulfilling the deletion request. And any route records 1669 contained directly within that Public Identifier must be deleted 1670 by the SPPP implementation as part of fulfilling the deletion 1671 request. 1673 7.3. Get Operations 1675 At times, on behalf of the registrant, the registrar may need to have 1676 access to SPPP objects that were previously provisioned in the 1677 registry. A few examples include logging, auditing, and pre- 1678 provisioning dependency checking. This query mechanism is limited to 1679 aid provisioning scenarios and should not be confused with query 1680 protocols provided as part of the resolution system (e.g. ENUM and 1681 SIP). Any conforming "transport" specification MUST provide a 1682 definition for the operation that queries the details of one or more 1683 SPPP objects from the registry using the object's key. If the entity 1684 that issued the command is not authorized to perform this operation 1685 an appropriate error message MUST be returned from amongst the 1686 response messages defined in "Response Message Types" section of the 1687 document. 1689 7.4. Accept Operations 1691 In SPPP, a Route Group Offer can be accepted or rejected by, or on 1692 behalf of, the registrant to whom the Route Group has been offered 1693 (refer "Protocol Data Model Objects" section of this document for a 1694 description of the Route Group Offer object). The Accept operation 1695 is used to accept the Route Group Offers. Any conforming "transport" 1696 specification MUST provide a definition for the operation to accept 1697 Route Group Offers by, or on behalf of the Registrant, using the 1698 Route Group Offer object key. 1700 Not until access to a Route Group has been offered and accepted will 1701 the registrant's organization ID be included in the peeringOrg list 1702 in that Route Group object, and that Route Group's peering 1703 information become a candidate for inclusion in the responses to the 1704 resolution requests submitted by that registrant. A Route Group 1705 Offer that is in the "offered" status is accepted by, or on behalf 1706 of, the registrant to which it has been offered. When the Route 1707 Group Offer is accepted the the Route Group Offer is moved to the 1708 "accepted" status and adds that data recipient's organization ID into 1709 the list of peerOrgIds for that Route Group. 1711 If the entity that issued the command is not authorized to perform 1712 this operation an appropriate error message MUST be returned from 1713 amongst the response messages defined in "Response Message Types" 1714 section of the document. 1716 7.5. Reject Operations 1718 In SPPP, a Route Group Offer object can be accepted or rejected by, 1719 or on behalf of, the registrant to whom the Route Group has been 1720 offered (refer "Protocol Data Model Objects" section of this document 1721 for a description of the Route Group Offer object). Furthermore, 1722 that offer may be rejected, regardless of whether or not it has been 1723 previously accepted. The Reject operation is used to reject the 1724 Route Group Offers. When the Route Group Offer is rejected that 1725 Route Group Offer is deleted, and, if appropriate, the data 1726 recipient's organization ID is removed from the list of peeringOrg 1727 IDs for that Route Group. Any conforming "transport" specification 1728 MUST provide a definition for the operation to reject Route Group 1729 Offers by, or on behalf of the Registrant, using the Route Group 1730 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 SPPP, Get Server Details operation can be used to request certain 1740 details about the SPPP server that include the SPPP server's current 1741 status, the major/minor version of the SPPP protocol supported by the 1742 SPPP server.. 1744 Any conforming "transport" specification MUST provide a definition 1745 for the operation to request such details from the SPPP server. If 1746 the entity that issued the command is not authorized to perform this 1747 operation an appropriate error message MUST be returned from amongst 1748 the response messages defined in "Response Message Types" section of 1749 the document. 1751 8. XML Considerations 1753 XML serves as the encoding format for SPPP, 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 SPPP. 1765 8.1. Namespaces 1767 All SPPP elements are defined in the namespaces in the IANA 1768 Considerations section and in the Formal Protocol Specification 1769 section of this document. 1771 8.2. Versioning and Character Encoding 1773 All XML instances SHOULD begin with an declaration to 1774 identify the version of XML that is being used, optionally identify 1775 use of the character encoding used, and optionally provide a hint to 1776 an XML parser that an external schema file is needed to validate the 1777 XML instance. 1779 Conformant XML parsers recognize both UTF-8 (defined in [RFC3629]) 1780 and UTF-16 (defined in [RFC2781]); per [RFC2277] UTF-8 is the 1781 RECOMMENDED character encoding for use with SPPP. 1783 Character encodings other than UTF-8 and UTF-16 are allowed by XML. 1784 UTF-8 is the default encoding assumed by XML in the absence of an 1785 "encoding" attribute or a byte order mark (BOM); thus, the "encoding" 1786 attribute in the XML declaration is OPTIONAL if UTF-8 encoding is 1787 used. SPPP clients and servers MUST accept a UTF-8 BOM if present, 1788 though emitting a UTF-8 BOM is NOT RECOMMENDED. 1790 Example XML declarations: 1792 1794 9. Security Considerations 1796 Many SPPP implementations manage data that is considered confidential 1797 and critical. Furthermore, SPPP implementations can support 1798 provisioning activities for multiple registrars and registrants. As 1799 a result any SPPP implementation must address the requirements for 1800 confidentiality, authentication, and authorization. 1802 With respect to confidentiality and authentication, the transport 1803 protocol requirements section of this document contains security 1804 properties that the transport protocol must provide so that 1805 authenticated endpoints can exchange data confidentially and with 1806 integrity protection. Refer to that section and the resulting 1807 transport protocol specification document for the specific solutions 1808 to authentication and confidentiality. 1810 With respect to authorization, the SPPP server implementation must 1811 define and implement a set of authorization rules that precisely 1812 address (1) which registrars will be authorized to create/modify/ 1813 delete each SPPP object type for given registrant(s) and (2) which 1814 registrars will be authorized to view/get each SPPP object type for 1815 given registrant(s). These authorization rules are a matter of 1816 policy and are not specified within the context of SPPP. However, 1817 any SPPP implementation must specify these authorization rules in 1818 order to function in a reliable and safe manner. 1820 In some situations, it may be required to protect against denial of 1821 involvement (see [RFC4949]) and tackle non-repudiation concerns in 1822 regards to SPPP messages. This type of protection is useful to 1823 satisfy authenticity concerns related to SPPP messages beyond the 1824 end-to-end connection integrity, confidentiality, and authentication 1825 protection that the transport layer provides. This is an optional 1826 feature and some SPPP implementations MAY provide support for it. 1828 It is not uncommon for the logging systems to document on-the-wire 1829 messages for various purposes, such as, debug, audit, and tracking. 1830 At the minimum, the various support and administration staff will 1831 have access to these logs. Also, if an unprivileged user gains 1832 access to the SPPP deployments and/or support systems, it will have 1833 access to the information that is potentially deemed confidential. 1834 To manage information disclosure concerns beyond the transport level, 1835 SPPP implementations MAY provide support for encryption at the SPPP 1836 object level. 1838 Anti-replay protection ensures that a given SPPP object replayed at a 1839 later time doesn't affect the integrity of the system. SPPP provides 1840 at least one mechanism to fight against replay attacks. Use of the 1841 optional client transaction identifier allows the SPPP client to 1842 correlate the request message with the response and to be sure that 1843 it is not a replay of a server response from earlier exchanges. Use 1844 of unique values for the client transaction identifier is highly 1845 encouraged to avoid chance matches to a potential replay message. 1847 The SPPP client or registrar can be a separate entity acting on 1848 behalf of the registrant in facilitating provisioning transactions to 1849 the registry. Further, the transport layer provides end-to-end 1850 connection protection between SPPP client and the SPPP server. 1851 Therefore, man-in-the-middle attack is a possibility that may affect 1852 the integrity of the data that belongs to the registrant and/or 1853 expose peer data to unintended actors in case well-established 1854 peering relationships already exist. 1856 10. IANA Considerations 1858 This document uses URNs to describe XML namespaces and XML schemas 1859 conforming to a registry mechanism described in [RFC3688]. 1861 Two URI assignments are requested. 1863 Registration request for the SPPP XML namespace: 1864 urn:ietf:params:xml:ns:sppp:base:1 1865 Registrant Contact: IESG 1866 XML: None. Namespace URIs do not represent an XML specification. 1868 Registration request for the XML schema: 1869 URI: urn:ietf:params:xml:schema:sppp:1 1870 Registrant Contact: IESG 1871 XML: See the "Formal Specification" section of this document 1872 (Section 11). 1874 IANA is requested to create a new SPPP registry for Organization 1875 Identifiers that will indicate valid strings to be used for well- 1876 known enterprise namespaces. 1877 This document makes the following assignments for the OrgIdType 1878 namespaces: 1880 Namespace OrgIdType namespace string 1881 ---- ---------------------------- 1882 IANA Enterprise Numbers iana-en 1884 11. Formal Specification 1886 This section provides the draft XML Schema Definition for SPPP 1887 Protocol. 1889 1890 1894 1895 1896 ---- Generic Object key 1897 types to be defined by specific 1898 Transport/Architecture. 1899 The types defined here can 1900 be extended by the 1901 specific architecture to 1902 define the Object Identifiers ---- 1903 1904 1905 1907 1908 1909 ---- Generic type that 1910 represents the key for various 1911 objects in SPPP. ---- 1912 1913 1914 1915 1916 1917 1918 1919 1920 ---- Generic type 1921 that represents 1922 the key for a route 1923 group offer. ---- 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 ----Generic type that 1935 represents the key 1936 for a Pub Id. ---- 1937 1938 1939 1940 1941 1942 1943 ---- Object Type Definitions ---- 1944 1945 1946 1947 1948 1949 1951 1954 1957 1960 1963 1964 1965 1967 1968 1969 1970 1971 1972 1973 1974 1975 1978 1979 1980 1981 1982 1983 1984 1985 1986 1988 1989 1990 1991 1992 1993 1994 1995 1996 1998 2000 2003 2004 2005 2006 2007 2008 2009 2010 2011 2013 2015 2016 2017 2018 2019 2020 2021 2022 2023 2025 2027 2028 2029 2030 2031 2032 2033 2034 2035 2037 2039 2040 2041 2042 2043 2044 2045 2046 2047 2049 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2116 2117 2118 2119 2120 2121 2122 2123 ---- Abstract Object and 2124 Element Type 2125 Definitions ---- 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2162 2163 2164 2165 2166 2167 2168 2169 2171 2172 2173 2174 2175 2176 2177 2178 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 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 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 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2293 12. Acknowledgments 2295 This document is a result of various discussions held in the DRINKS 2296 working group and within the DRINKS protocol design team, which is 2297 comprised of the following individuals, in alphabetical order: 2298 Alexander Mayrhofer, Deborah A Guyton, David Schwartz, Lisa 2299 Dusseault, Manjul Maharishi, Mickael Marrache, Otmar Lendl, Richard 2300 Shockey, Samuel Melloul, and Sumanth Channabasappa. 2302 13. References 2304 13.1. Normative References 2306 [I-D.ietf-drinks-sppp-over-soap] 2307 Cartwright, K., "SPPP Over SOAP and HTTP", 2308 draft-ietf-drinks-sppp-over-soap-06 (work in progress), 2309 October 2011. 2311 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 2312 Requirement Levels", BCP 14, RFC 2119, March 1997. 2314 [RFC2277] Alvestrand, H., "IETF Policy on Character Sets and 2315 Languages", BCP 18, RFC 2277, January 1998. 2317 [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO 2318 10646", STD 63, RFC 3629, November 2003. 2320 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 2321 January 2004. 2323 [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform 2324 Resource Identifier (URI): Generic Syntax", STD 66, 2325 RFC 3986, January 2005. 2327 [RFC4949] Shirey, R., "Internet Security Glossary, Version 2", 2328 RFC 4949, August 2007. 2330 [RFC5067] Lind, S. and P. Pfautz, "Infrastructure ENUM 2331 Requirements", RFC 5067, November 2007. 2333 13.2. Informative References 2335 [I-D.ietf-drinks-usecases-requirements] 2336 Channabasappa, S., "Data for Reachability of Inter/ 2337 tra-NetworK SIP (DRINKS) Use cases and Protocol 2338 Requirements", draft-ietf-drinks-usecases-requirements-06 2339 (work in progress), August 2011. 2341 [RFC2781] Hoffman, P. and F. Yergeau, "UTF-16, an encoding of ISO 2342 10646", RFC 2781, February 2000. 2344 [RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, 2345 A., Peterson, J., Sparks, R., Handley, M., and E. 2346 Schooler, "SIP: Session Initiation Protocol", RFC 3261, 2347 June 2002. 2349 [RFC4725] Mayrhofer, A. and B. Hoeneisen, "ENUM Validation 2350 Architecture", RFC 4725, November 2006. 2352 [RFC5321] Klensin, J., "Simple Mail Transfer Protocol", RFC 5321, 2353 October 2008. 2355 [RFC5486] Malas, D. and D. Meyer, "Session Peering for Multimedia 2356 Interconnect (SPEERMINT) Terminology", RFC 5486, 2357 March 2009. 2359 [RFC6116] Bradner, S., Conroy, L., and K. Fujiwara, "The E.164 to 2360 Uniform Resource Identifiers (URI) Dynamic Delegation 2361 Discovery System (DDDS) Application (ENUM)", RFC 6116, 2362 March 2011. 2364 Authors' Addresses 2366 Jean-Francois Mule 2367 CableLabs 2368 858 Coal Creek Circle 2369 Louisville, CO 80027 2370 USA 2372 Email: jfm@cablelabs.com 2374 Kenneth Cartwright 2375 TNS 2376 1939 Roland Clarke Place 2377 Reston, VA 20191 2378 USA 2380 Email: kcartwright@tnsi.com 2382 Syed Wasim Ali 2383 NeuStar 2384 46000 Center Oak Plaza 2385 Sterling, VA 20166 2386 USA 2388 Email: syed.ali@neustar.biz 2390 Alexander Mayrhofer 2391 enum.at GmbH 2392 Karlsplatz 1/9 2393 Wien, A-1010 2394 Austria 2396 Email: alexander.mayrhofer@enum.at 2398 Vikas Bhatia 2399 TNS 2400 1939 Roland Clarke Place 2401 Reston, VA 20191 2402 USA 2404 Email: vbhatia@tnsi.com