--- 1/draft-ietf-drinks-spprov-11.txt 2011-11-16 00:14:09.602672571 +0100 +++ 2/draft-ietf-drinks-spprov-12.txt 2011-11-16 00:14:09.726671319 +0100 @@ -1,23 +1,25 @@ DRINKS J-F. Mule Internet-Draft CableLabs Intended status: Standards Track K. Cartwright -Expires: May 3, 2012 TNS +Expires: May 18, 2012 TNS S. Ali NeuStar A. Mayrhofer enum.at GmbH - October 31, 2011 + V. Bhatia + TNS + November 15, 2011 Session Peering Provisioning Protocol Data Model - draft-ietf-drinks-spprov-11 + draft-ietf-drinks-spprov-12 Abstract This document specifies the data model and the overall structure for a protocol to provision session establishment data into Session Data Registries and SIP Service Provider data stores. The protocol is called the Session Peering Provisioning Protocol (SPPP). The provisioned data is typically used by network elements for session peering. @@ -29,77 +31,87 @@ Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet- Drafts is at http://datatracker.ietf.org/drafts/current/. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." - This Internet-Draft will expire on May 3, 2012. + This Internet-Draft will expire on May 18, 2012. Copyright Notice Copyright (c) 2011 IETF Trust and the persons identified as the document authors. All rights reserved. This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License. Table of Contents - 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 - 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 6 - 3. Protocol High Level Design . . . . . . . . . . . . . . . . . . 8 - 3.1. Protocol Data Model . . . . . . . . . . . . . . . . . . . 8 - 3.2. Time Value . . . . . . . . . . . . . . . . . . . . . . . . 11 - 4. Transport Protocol Requirements . . . . . . . . . . . . . . . 12 - 4.1. Connection Oriented . . . . . . . . . . . . . . . . . . . 12 - 4.2. Request and Response Model . . . . . . . . . . . . . . . . 12 - 4.3. Connection Lifetime . . . . . . . . . . . . . . . . . . . 12 - 4.4. Authentication . . . . . . . . . . . . . . . . . . . . . . 12 - 4.5. Authorization . . . . . . . . . . . . . . . . . . . . . . 13 - 4.6. Confidentiality and Integrity . . . . . . . . . . . . . . 13 - 4.7. Near Real Time . . . . . . . . . . . . . . . . . . . . . . 13 - 4.8. Request and Response Sizes . . . . . . . . . . . . . . . . 13 - 4.9. Request and Response Correlation . . . . . . . . . . . . . 13 - 4.10. Request Acknowledgement . . . . . . . . . . . . . . . . . 13 - 4.11. Mandatory Transport . . . . . . . . . . . . . . . . . . . 14 - 5. Base Protocol Data Structures . . . . . . . . . . . . . . . . 15 - 5.1. Basic Object Type and Organization Identifiers . . . . . . 15 - 5.2. Object Key Type . . . . . . . . . . . . . . . . . . . . . 15 - 6. Protocol Data Model Objects . . . . . . . . . . . . . . . . . 17 - 6.1. Destination Group . . . . . . . . . . . . . . . . . . . . 17 - 6.2. Public Identifier . . . . . . . . . . . . . . . . . . . . 18 - 6.3. Route Group . . . . . . . . . . . . . . . . . . . . . . . 22 - 6.4. Route Record . . . . . . . . . . . . . . . . . . . . . . . 26 - 6.5. Route Group Offer . . . . . . . . . . . . . . . . . . . . 30 - 6.6. Egress Route . . . . . . . . . . . . . . . . . . . . . . . 32 - 7. XML Considerations . . . . . . . . . . . . . . . . . . . . . . 35 - 7.1. Namespaces . . . . . . . . . . . . . . . . . . . . . . . . 35 - 7.2. Versioning and Character Encoding . . . . . . . . . . . . 35 - 8. Security Considerations . . . . . . . . . . . . . . . . . . . 36 - 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 38 - 10. Formal Specification . . . . . . . . . . . . . . . . . . . . . 39 - 11. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 47 - 12. References . . . . . . . . . . . . . . . . . . . . . . . . . . 48 - 12.1. Normative References . . . . . . . . . . . . . . . . . . . 48 - 12.2. Informative References . . . . . . . . . . . . . . . . . . 48 - Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 50 + 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4 + 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 7 + 3. Protocol High Level Design . . . . . . . . . . . . . . . . . . 9 + 3.1. Protocol Data Model . . . . . . . . . . . . . . . . . . . 9 + 3.2. Time Value . . . . . . . . . . . . . . . . . . . . . . . . 12 + 4. Transport Protocol Requirements . . . . . . . . . . . . . . . 13 + 4.1. Connection Oriented . . . . . . . . . . . . . . . . . . . 13 + 4.2. Request and Response Model . . . . . . . . . . . . . . . . 13 + 4.3. Connection Lifetime . . . . . . . . . . . . . . . . . . . 13 + 4.4. Authentication . . . . . . . . . . . . . . . . . . . . . . 13 + 4.5. Authorization . . . . . . . . . . . . . . . . . . . . . . 14 + 4.6. Confidentiality and Integrity . . . . . . . . . . . . . . 14 + 4.7. Near Real Time . . . . . . . . . . . . . . . . . . . . . . 14 + 4.8. Request and Response Sizes . . . . . . . . . . . . . . . . 14 + 4.9. Request and Response Correlation . . . . . . . . . . . . . 14 + 4.10. Request Acknowledgement . . . . . . . . . . . . . . . . . 14 + 4.11. Mandatory Transport . . . . . . . . . . . . . . . . . . . 15 + 5. Base Protocol Data Structures and Response Codes . . . . . . . 16 + 5.1. Basic Object Type and Organization Identifiers . . . . . . 16 + 5.2. Various Object Key Types . . . . . . . . . . . . . . . . . 16 + 5.2.1. Generic Object Key Type . . . . . . . . . . . . . . . 16 + 5.2.2. Derived Object Key Types . . . . . . . . . . . . . . . 17 + 5.3. Response Message Types . . . . . . . . . . . . . . . . . . 19 + 6. Protocol Data Model Objects . . . . . . . . . . . . . . . . . 22 + 6.1. Destination Group . . . . . . . . . . . . . . . . . . . . 22 + 6.2. Public Identifier . . . . . . . . . . . . . . . . . . . . 23 + 6.3. Route Group . . . . . . . . . . . . . . . . . . . . . . . 27 + 6.4. Route Record . . . . . . . . . . . . . . . . . . . . . . . 31 + 6.5. Route Group Offer . . . . . . . . . . . . . . . . . . . . 35 + 6.6. Egress Route . . . . . . . . . . . . . . . . . . . . . . . 38 + 7. Protocol Operations . . . . . . . . . . . . . . . . . . . . . 40 + 7.1. Add Operation . . . . . . . . . . . . . . . . . . . . . . 40 + 7.2. Delete Operation . . . . . . . . . . . . . . . . . . . . . 40 + 7.3. Get Operations . . . . . . . . . . . . . . . . . . . . . . 41 + 7.4. Accept Operations . . . . . . . . . . . . . . . . . . . . 41 + 7.5. Reject Operations . . . . . . . . . . . . . . . . . . . . 42 + 7.6. Get Server Details Operation . . . . . . . . . . . . . . . 42 + 8. XML Considerations . . . . . . . . . . . . . . . . . . . . . . 43 + 8.1. Namespaces . . . . . . . . . . . . . . . . . . . . . . . . 43 + 8.2. Versioning and Character Encoding . . . . . . . . . . . . 43 + 9. Security Considerations . . . . . . . . . . . . . . . . . . . 44 + 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 46 + 11. Formal Specification . . . . . . . . . . . . . . . . . . . . . 47 + 12. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 56 + 13. References . . . . . . . . . . . . . . . . . . . . . . . . . . 57 + 13.1. Normative References . . . . . . . . . . . . . . . . . . . 57 + 13.2. Informative References . . . . . . . . . . . . . . . . . . 57 + Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 59 1. Introduction Service providers and enterprises use registries to make session routing decisions for Voice over IP, SMS and MMS traffic exchanges. This document is narrowly focused on the provisioning protocol for these registries. This protocol prescribes a way for an entity to provision session-related data into a registry. The data being provisioned can be optionally shared with other participating peering entities. The requirements and use cases driving this protocol have @@ -172,50 +184,51 @@ use other means to perform the Location Routing Function (LRF) which in turn helps determine the actual location of the Signaling Function in that domain. 2. A resolution system returns both a Look-Up function (LUF) and Location Routing Function (LRF) to locate the SED data fully. In terms of protocol design, SPPP is agnostic to the transport. This document includes the specification of the data model and identifies, but does not specify, the means to enable protocol operations within - a request and response structure. That aspcect of the specificaiton + a request and response structure. That aspect of the specification has been delegated to the "transport" specification for the protocol. To encourage interoperability, the protocol supports extensibility aspects. Transport requirements are provided in this document to help with the selection of the optimum transport mechanism. ([I-D.ietf-drinks-sppp-over-soap]) identifies a SOAP transport mechanism for SPPP. This document is organized as follows: o Section 2 provides the terminology; o Section 3 provides an overview of SPPP, including the functional entities and data model; o Section 4 specifies requirements for SPPP transport protocols; o Section 5 describes the base protocol data structures, the - generic response codes and messages, and the basic object type - most first class objects extend from; + generic response types that MUST be supported by a conforming + "transport" specification, and the basic object type most first + class objects extend from; o Section 6 detailed descriptoins of the data model object specifications; - o Section 7 defines XML considerations that XML parsers must meet + o Section 8 defines XML considerations that XML parsers must meet to conform to this specification; - o Section 10 normatively defines the SPPP protocol using its XML + o Section 11 normatively defines the SPPP protocol using its XML Schema Definition. 2. Terminology The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC2119]. This document reuses terms from [RFC3261], [RFC5486], use cases and requirements documented in [I-D.ietf-drinks-usecases-requirements] @@ -383,36 +396,30 @@ To support the use cases defined in [I-D.ietf-drinks-usecases-requirements], SPPP defines three type of Route Records: URIType, NAPTRType, and NSType. These Route Records extend the abstract type RteRecType and inherit the common attribute 'priority' that is meant for setting precedence across the route records defined within a Route Group in a protocol agnostic fashion. o Organization: - An Organization is an entity that may fulfill the role of a - registrant or a peering organization. All SPPP objects are - associated with an organization identifier to identify each - object's registrant, while tracking the identity of the registrar - that provisioned each SPPP object is left as a matter of policy - for an SPPP implementation. A Route Group object is also - associated with a set of zero or more organization identifiers - that identify the peering organization(s) whose resolution query - responses may include the routing information (SED) defined in the - Route Records within that Route Group. A peering organization is - an entity that the registrant intends to share the SED data with. - A route group SPPP object is associated with a set of zero or more - organization identifiers that identify the peering organizations - whose resolution query responses may include the routing - information (SED) defined in the route records within that route - group. + An An Organization is an entity that may fulfill any combination + of three roles: Registrant, Registrar, and Peering Organization. + All SPPP objects are associated with two organization identifiers + to identify each object's registrant and registrar. A Route Group + object is also associated with a set of zero or more organization + identifiers that identify the peering organization(s) whose + resolution query responses may include the routing information + (SED) defined in the Route Records within that Route Group. A + peering organization is an entity that the registrant intends to + share the SED data with. 3.2. Time Value Some SPPP request and response messages include time value(s) defined as type xs:dateTime, a built-in W3C XML Schema Datatype. Use of unqualified local time value is discouraged as it can lead to interoperability issues. The value of time attribute MUST BE expressed in Coordinated Universal Time (UTC) format without the timezone digits. @@ -527,21 +534,21 @@ 4.11. Mandatory Transport At the time of this writing, a choice of transport protocol has been provided in [I-D.ietf-drinks-sppp-over-soap]. To encourage interoperability, the SPPP server MUST provide support for this transport protocol. With time, it is possible that other transport layer choices may surface that agree with the requirements discussed above. -5. Base Protocol Data Structures +5. Base Protocol Data Structures and Response Codes SPPP contains some common data structures for most of the supported object types. This section describes these common data structures. 5.1. Basic Object Type and Organization Identifiers This section introduces the basic object type that most first class objects derive from. All first class objects extend the basic object type BasicObjType @@ -562,109 +569,332 @@ minOccurs="0"/> The identifiers used for registrants (rant), registrars (rar), and peering organizations (peeringOrg) are instances of OrgIdType. The OrgIdType is defined as a string and all OrgIdType instances SHOULD follow the textual convention: "namespace:value" (for example "iana- en:32473"). See the IANA Consideration section for more details. -5.2. Object Key Type +5.2. Various Object Key Types + +5.2.1. Generic Object Key Type The SPPP data model contains some object relationships. In some cases these object relationships are established by embedding the - unique identity of the related object inside the relating object. - The abstract type called ObjKeyType is where this unique identity is - housed. Because this objec type is abstract, it MUST be specifid in - a concrete form in any conforming SPPP "transport specification". - This may also be used in query/getter operaitons. + unique identity of the related object inside the relating object. In + addition, an object's unique identity is required to Delete or Get + the details of an object. The abstract type called ObjKeyType is + where this unique identity is housed. Because this object key type + is abstract, it MUST be specified in a concrete form in any + conforming SPPP "transport" specification. + + Most objects in SPPP are uniquely identified by an object key that + has the object's name, object's type and its registrant's + organization ID as its attributes. Consequently, any concrete + representation of the ObjKeyType MUST contain the following: + + Object Name: The name of the object. + + Registrant Id: The unique organization ID that identifies the + Registrant. + + Type: The enumeration vaue that represents the type of SPPP object + that. This is required as different types of objects in SPPP, + that belong to the same registrant, can have the same name. + + The structure of abstract ObjKeyType is as follows: - -- Generic type that represents the - key for various objects in SPPP. -- + ---- Generic type that represents the + key for various objects in SPPP. ---- + + + + + The object types in SPPP that MUST adhere to this definition of + generic object key are defined as an enumeration in the XML data + structure. The structure of the the enumeration is as follows: + + + + + + + + + + +5.2.2. Derived Object Key Types + + The SPPP data model contains certain objects that are uniquely + identified by attributes, different from or in addition to, the + attributes in the generic object key described in previous section. + These kind of object keys are derived from the abstract ObjKeyType + and defined in there own abstract key types. Because these object + key types are abstract, these MUST be specified in a concrete form in + any conforming SPPP "transport" specification. These are used in + Delete and Get operations, and may also be used in Accept and Reject + operations. + + Following are the derived object keys in SPPP data model: + + o RteGrpOfferKeyType: This uniquely identifies a Route Group + object offer. This key type extends from ObjKeyType and MUST + also have the organization ID of the Registrant to whom the + object is being offered, as one of its attributes. In addition + to the Delete and Get operations, these key types are used in + Accept and Reject operations on a Route Group Offer object. The + structure of abstract RteGrpOfferKeyType is as follows: + + + + + + + ---- Generic type that represents the + key for a object offer. ---- + + + A Route Group Offer object MUST use RteGrpOfferKeyType. Refer + the "Protocol Data Model Objects" section of this document for + description of Route Group Offer object. + + o PubIdKeyType: This uniquely identifies a Public Identity object. + This key type extends from abstract ObjKeyType. Any concrete + defintion of PubIdKeyType MUST contain the elements that + identify the value and type of Public Identity and also contain + the organization ID of the Registrant that is the owner of the + Public Identity object. A Public Identity object key in SPPP is + uniquely identified by the the registrant's organization ID, the + value of the public identity, and, optionally, the Destination + Group name the public identiy belongs to. Consequently, any + concrete representation of the ObjKeyType MUST contain the + following attributes: + + * Registrant Id: The unique organization ID that identifies + the Registrant. + + * Destination Group name: The name of the Destination Group + the Public Identity is associated with. This is an + optional attribute. + + * Type: The type of Public Identity. + + * Value: The value of the Public Identity. + + The .PubIdKeyType is used in Delete and Get operations on a + Public Identifier object. + + o The structure of abstract PubIdKeyType is as follows: + + + + + + + ---- Generic type that represents + the key for a Pub Id. ---- + + + + + + + A Public Identity object MUST use attributes of PubIdKeyType for its + unique identification . Refer the "Protocol Data Model Objects" + section of this document for a description of Public Identity object. + +5.3. Response Message Types + + This section contains the listing of response types that MUST be + defined by the conforming "transport" specification and implemented + by a conforming SPPP server. + + +---------------------+---------------------------------------------+ + | Response Type | Description | + +---------------------+---------------------------------------------+ + | Request Succeeded | Any conforming specification MUST define a | + | | response to indicate that a given request | + | | succeeded. | + | | | + | Request syntax | Any conforming specification MUST define a | + | invalid | response to indicate that a syntax of a | + | | given request was found invalid. | + | | | + | Request too large | Any conforming specification MUST define a | + | | response to indicate that the count of | + | | entities in the request is larger than the | + | | server is willing or able to process. | + | | | + | Version not | Any conforming specification MUST define a | + | supported | response to indicate that the server does | + | | not support the version of the SPPP | + | | protocol specified in the request. | + | | | + | Command invalid | Any conforming specification MUST define a | + | | response to indicate that the operation | + | | and/or command being requested by the | + | | client is invalid and/or not supported by | + | | the server. | + | | | + | System temporarily | Any conforming specification MUST define a | + | unavailable | response to indicate that the SPPP server | + | | is temporarily not available to serve | + | | client request. | + | | | + | Unexpected internal | Any conforming specification MUST define a | + | system or server | response to indicate that the SPPP server | + | error. | encountered an unexpected error that | + | | prevented the server from fulfilling the | + | | request. | + | | | + | Attribute value | Any conforming specification MUST define a | + | invalid | response to indicate that the SPPP server | + | | encountered an attribute or property in the | + | | request that had an invalid/bad value. | + | | Optionally, the specification MAY provide a | + | | way to indicate the Attribute Name and the | + | | Attribute Value to identify the object that | + | | was found to be invalid. | + | | | + | Object does not | Any conforming specification MUST define a | + | exist | response to indicate that an object present | + | | in the request does not exist on the SPPP | + | | server. Optionally, the specification MAY | + | | provide a way to indicate the Attribute | + | | Name and the Attribute Value that | + | | identifies the non-existent object. | + | | | + | Object status or | Any conforming specification MUST define a | + | ownership does not | response to indicate that the operation | + | allow for | requested on an object present in the | + | operation. | request cannot be performed because the | + | | object is in a status that does not allow | + | | the said operation or the user requesting | + | | the operation is not authorized to perform | + | | the said operation on the object. | + | | Optionally, the specification MAY provide a | + | | way to indicate the Attribute Name and the | + | | Attribute Value that identifies the object. | + +---------------------+---------------------------------------------+ + + Table 1: Response Types + + When the response messages are "parameterized" with the Attribute + Name and Attribute Value, then the use of these parameters MUST + adhere to the following rules: + + o Any value provided for the Attribute Name parameter MUST be an + exact XSD element name of the protocol data element that the + response message is referring to. For example, valid values for + "attribute name" are "dgName", "rgName", "rteRec", etc. + + o The value for Attribute Value MUST be the value of the data + element to which the preceding Attribute Name refers. + + o Response type "Attribute value invalid" SHOULD be used whenever + an element value does not adhere to data validation rules. + + o Response types "Attribute value invalid" and "Object does not + exist" MUST NOT be used interchangeably. Response type "Object + does not exist" SHOULD be returned by an Add/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" SHOULD be returned. + 6. Protocol Data Model Objects This section provides a description of the specification of each supported data model object (the nouns) and identifies the commands (the verbs) that MUST be supported for each data model object. However, the specification of the data structures necessary to - support each command is delegated to the transport specification. + support each command is delegated to the "transport" specification. 6.1. Destination Group As described in the introductory sections, a Destination Group represents a set of Public Identifiers with common routing information. The transport protocol MUST support the ability to - Create, Modify, Get, and Delete Destination Groups. The DestGrpType - object structure is defined as follows: + Create, Modify, Get, and Delete Destination Groups (refer the + "Protocol Operations" section of this document for a generic + description of various operations). + + A Destination Group object MUST be uniquely identified by attributes + as defined in the description of "ObjKeyType" in the section "Generic + Object Key Type" of this document. + + The DestGrpType object structure is defined as follows: The DestGrpType object is composed of the following elements: o base: All first class objects extend BasicObjType that contains - the ID of the registrant organization that owns this object, the - date and time that the object was created by the server, and the - date and time that the object was last modified. If the client - passed in either the created date or the modification date, the - server will ignore them. The server sets these two date/time - values. + the ID of the registrant organization that owns this object, + registrar organization that provisioned this object on behalf of + the registrant, the date and time that the object was created by + the server, and the date and time that the object was last + modified. If the client passed in either the created date or + the modification date, the server will ignore them. The server + sets these two date/time values. o dgName: The character string that contains the name of the - Destination Group. This uniquely identifies this object within - the context of the registrant ID (a child element of the base - element as described above). + Destination Group. o ext: Point of extensibility described in a previous section of this document. 6.2. Public Identifier A Public Identifier is the search key used for locating the session establishment data (SED). In many cases, a Public Identifier is attributed to the end user who has a retail relationship with the service provider or registrant organization. SPPP supports the notion of the carrier-of-record as defined in [RFC5067]. Therefore, the registrant under whom the Public Identity is being created can optionally claim to be a carrier-of-record. SPPP identifies two types of Public Identifiers: telephone numbers (TN), and the routing numbers (RN). SPPP provides structures to manage a single TN, a contiguous range of TNs, and a TN prefix. The transport protocol MUST support the ability to Create, Modify, Get, - and Delete Public Identifiers. + and Delete Public Identifiers (refer the "Protocol Operations" + section of this document for a generic description of various + operations). + + A Public Identity object MUST be uniquely identified by attributes as + defined in the description of "PubIdKeyType" in the section "Derived + Object Key Types" of this document. The abstract XML schema type definition PubIDType is a generalization for the concrete the Public Identifier schema types. PubIDType element 'dgName' represents the name of the destination group that a - given Public Identifier is a member of. Because a Destination Group - is uniquely identified by its composite business key, which is - comprised of its registrant ID, rantId, and its name, dgName, the - Public Identity's containing Destination Group is identified by the - Public Identity's dgName element and the Public Identity's registrant - ID, rantId, element. The PubIDType object structure is defined as - follows: + given Public Identifier MAY be a member of. The PubIDType object + structure is defined as follows: @@ -673,42 +903,48 @@ A Public Identifier may be provisioned as a member of a Destination Group or provisioned outside of a Destination Group. A Public Identifier that is provisioned as a member of a Destination Group is intended to be associated with its SED through the Route Group(s) that are associated with its containing Destination Group. A Public Identifier that is not provisioned as a member of a Destination Group is intended to be associated with its SED through the Route Records that are directly associated with the Public Identifier. A telephone number is provisioned using the TNType, an extension of - PubIDType. Each TNType object is uniquely identified by the - combination of its element, and the unique key of its parent - Destination Group (dgName and rantId). In other words a given - telephone number string may exist within one or more Destination - Groups, but must not exist more than once within a Destination Group. - TNType is defined as follows: + PubIDType. When a Public Identifier is provisioned as a member of a + Destination Group, each TNType object is uniquely identified by the + combination of its value contained within element, and the + unique key of its parent Destination Group (dgName and rantId). In + other words a given telephone number string may exist within one or + more Destination Groups, but must not exist more than once within a + Destination Group. A Public Identifier that is not provisioned as a + member of a Destination Group is uniquely identified by the + combination of its value, and its registrant ID. TNType is defined + as follows: - - + + - - + TNType consists of the following attributes: o tn: Telephone number to be added to the registry. @@ -723,44 +959,42 @@ setting the value of element of the CORInfoType object structure to "true". The other two parameters of the CORInfoType, and are set by the registry to describe the outcome of the carrier-of-record claim by the registrant. In general, inclusion of parameter is useful if the registry has the authority information, such as, the number portability data, etc., in order to qualify whether the registrant claim can be satisfied. If the carrier-of-record claim disagrees with the authority data in the registry, whether the TN add operation fails or not is a matter of policy and it - is beyond the scope of this document. In the response message - , the SPPP server must include the - parameter of the element to let the registrant know - the outcome of the claim. + is beyond the scope of this document. A routing number is provisioned using the RNType, an extension of PubIDType. SSPs that possess the number portability data may be able to leverage the RN search key to discover the ingress routes for session establishment. Therefore, the registrant organization can add the RN and associate it with the appropriate destination group to share the route information. Each RNType object is uniquely - identified by the combination of its element, and the unique key - of its parent Destination Group (dgName and rantId). In other words - a given routing number string may exist within one or more - Destination Groups, but must not exist more than once within a - Destination Group. RNType is defined as follows: + identified by the combination of its value inside the element, + and the unique key of its parent Destination Group (dgName and + rantId). In other words a given routing number string may exist + within one or more Destination Groups, but must not exist more than + once within a Destination Group. RNType is defined as follows: - - + + RNType has the following attributes: o rn: Routing Number used as the search key. o corInfo: Optional element of type CORInfoType. @@ -768,66 +1002,73 @@ TNRType structure is used to provision a contiguous range of telephone numbers. The object definition requires a starting TN and an ending TN that together define the span of the TN range. Use of TNRType is particularly useful when expressing a TN range that does not include all the TNs within a TN block or prefix. The TNRType definition accommodates the open number plan as well such that the TNs that fall between the start and end TN range may include TNs with different length variance. Whether the registry can accommodate the open number plan semantics is a matter of policy and is beyond the scope of this document. Each TNRType object is uniquely identified - by the combination of its and elements, and the - unique key of its parent Destination Group (dgName and rantId). In - other words a given TN Range may exist within one or more Destination - Groups, but must not exist more than once within a Destination Group. - TNRType object structure definition is as follows: + by the combination of its value that in turn is a combination of the + and elements, and the unique key of its parent + Destination Group (dgName and rantId). In other words a given TN + Range may exist within one or more Destination Groups, but must not + exist more than once within a Destination Group. TNRType object + structure definition is as follows: - - - + + + + + + + + + TNRType has the following attributes: o startTn: Starting TN in the TN range o endTn: The last TN in the TN range o corInfo: Optional element of type CORInfoType In some cases, it is useful to describe a set of TNs with the help of the first few digits of the telephone number, also referred to as the telephone number prefix or a block. A given TN prefix may include TNs with different length variance in support of open number plan. Once again, whether the registry supports the open number plan semantics is a matter of policy and it is beyond the scope of this document. The TNPType data structure is used to provision a TN prefix. Each TNPType object is uniquely identified by the - combination of its element, and the unique key of its - parent Destination Group (dgName and rantId). TNPType is defined as - follows: + combination of its value in the element, and the unique + key of its parent Destination Group (dgName and rantId). TNPType is + defined as follows: - - + + TNPType consists of the following attributes: o tnPrefix: The telephone number prefix o corInfo: Optional element of type CORInfoType. @@ -839,22 +1080,29 @@ Destination Groups that contain a set of Public Identifiers with common routing information, and the list of peer organizations that have access to these public identifiers using this route information. It is this indirect linking of public identifiers to their route information that significantly improves the scalability and manageability of the peering data. Additions and changes to routing information are reduced to a single operation on a Route Group or Route Record , rather than millions of data updates to individual public identifier records that individually contain their peering data. The transport protocol MUST support the ability to Create, - Modify, Get, and Delete Route Groups. The RteGrpType object - structure is defined as follows: + Modify, Get, and Delete Route Groups (refer the "Protocol Operations" + section of this document for a generic description of various + operations). + + A Route Group object MUST be uniquely identified by attributes as + defined in the description of "ObjKeyType" in the section "Generic + Object Key Type" of this document. + + The RteGrpType object structure is defined as follows: @@ -995,39 +1243,40 @@ source identification criteria applies to and that the associated sourceIdentRegex should be matched against. o sourceIdentRegex: The regular expression that should be used to test for a match against the portion of the resolution request that is dictated by the associated sourceIdentScheme. o ext: Point of extensibility described in a previous section of this document. - As with the responses to all update operations, the result of the - AddRteGrpRqstType operation is contained in the generic - spppUpdateResponse data structure described in an earlier sections of - this document. For a detailed description of the spppUpdateResponse - data structure refer to that section of the document. - 6.4. Route Record As described in the introductory sections, a Route Group represents a combined grouping of Route Records that define route information. However, Route Records need not be created to just serve a single Route Group. Route Records can be created and managed to serve multiple Route Groups. As a result, a change to the properties of a network node used for multiple routes, would necessitate just a single update operation to change the properties of that node. The change would then be reflected in all the Route Groups whose route record set contains a reference to that node. The transport protocol MUST support the ability to Create, Modify, Get, and Delete Route - Records. The RteRecType object structure is defined as follows: + Records (refer the "Protocol Operations" section of this document for + a generic description of various operations). + + A Route Record object MUST be uniquely identified by attributes as + defined in the description of "ObjKeyType" in the section "Generic + Object Key Type" of this document. + + The RteRecType object structure is defined as follows: @@ -1205,22 +1456,29 @@ (its registrant), and the peer organization that submits resolution requests (a data recipient, also know as a peering organization). The registrant offers access to a Route Group by submitting a Route Group Offer. The data recipient can then accept or reject that offer. Not until access to a Route Group has been offered and accepted will the data recipient's organization ID be included in the peeringOrg list in a Route Group object, and that Route Group's peering information become a candidate for inclusion in the responses to the resolution requests submitted by that data recipient. The transport protocol MUST support the ability to Create, Modify, Get, - Delete, Accept and Reject Route Group Offers. The RteGrpOfferType - object structure is defined as follows: + Delete, Accept and Reject Route Group Offers (refer the "Protocol + Operations" section of this document for a generic description of + various operations). + + A Route Group Offer object MUST be uniquely identified by attributes + as defined in the description of "RteGrpOfferKeyType" in the section + "Derived Object Key Types" of this document. + + The RteGrpOfferType object structure is defined as follows: @@ -1269,63 +1527,46 @@ automatically set to "accepted" if and when that offer is accepted. The value of the element is ignored when passed in by the client. o offerDateTime: Date and time in UTC when the Route Group Offer was added. o acceptDateTime: Date and time in UTC when the Route Group Offer was accepted. - Accepting a Route Group Offer: Not until access to a Route Group has - been offered and accepted will the registrant's organization ID be - included in the peeringOrg list in that Route Group object, and that - Route Group's peering information become a candidate for inclusion in - the responses to the resolution requests submitted by that - registrant. A Route Group Offer that is in the "offered" status is - accepted by, or on behalf of, the registrant to which it has been - offered. When the Route Group Offer is accepted the the Route Group - Offer is moved to the "accepted" status and adds that data - recipient's organization ID into the list of peerOrgIds for that - Route Group. - - Rejecting a Route Group Offer: The registrant to which a Route Group - has been offered has the option of rejecting a Route Group Offer. - Furthermore, that offer may be rejected, regardless of whether or not - it has been previously accepted. A Route Group Offer that is in the - "offered" or "accepted" status is rejected by, or on behalf of, the - registrant to which it has been offered. When the Route Group Offer - is rejected that Route Group Offer is deleted, and, if appropriate, - the data recipient's organization ID is removed from the list of - peeringOrg IDs for that Route Group. - 6.6. Egress Route In a high-availability environment, the originating SSP likely has more than one egress paths to the ingress SBE of the target SSP. If the originating SSP wants to exercise greater control and choose a specific egress SBE to be associated to the target ingress SBE, it - can do so using the AddEgrRteRqstType object. + can do so using the EgrRteType object. + + A Egress Route object MUST be uniquely identified by attributes as + defined in the description of "ObjKeyType" in the section "Generic + Object Key Type" of this document. Lets assume that the target SSP has offered to share one or more ingress route information and that the originating SSP has accepted the offer. In order to add the egress route to the registry, the originating SSP uses a valid regular expression to rewrite ingress route in order to include the egress SBE information. Also, more than one egress route can be associated with a given ingress route in support of fault-tolerant configurations. The supporting SPPP structure provides a way to include route precedence information to help manage traffic to more than one outbound egress SBE. - The transport protocol MUST support the ability to Create, Modify, - Get, and Delete Egress Routes. The EgrRteType object structure is - defined as follows: + The transport protocol MUST support the ability to Add, Modify, Get, + and Delete Egress Routes (refer the "Protocol Operations" section of + this document for a generic description of various operations). The + EgrRteType object structure is defined as follows: declaration to identify the version of XML that is being used, optionally identify use of the character encoding used, and optionally provide a hint to an XML parser that an external schema file is needed to validate the XML instance. Conformant XML parsers recognize both UTF-8 (defined in [RFC3629]) and UTF-16 (defined in [RFC2781]); per [RFC2277] UTF-8 is the RECOMMENDED character encoding for use with SPPP. @@ -1399,21 +1784,21 @@ UTF-8 is the default encoding assumed by XML in the absence of an "encoding" attribute or a byte order mark (BOM); thus, the "encoding" attribute in the XML declaration is OPTIONAL if UTF-8 encoding is used. SPPP clients and servers MUST accept a UTF-8 BOM if present, though emitting a UTF-8 BOM is NOT RECOMMENDED. Example XML declarations: -8. Security Considerations +9. Security Considerations Many SPPP implementations manage data that is considered confidential and critical. Furthermore, SPPP implementations can support provisioning activities for multiple registrars and registrants. As a result any SPPP implementation must address the requirements for confidentiality, authentication, and authorization. With respect to confidentiality and authentication, the transport protocol requirements section of this document contains security properties that the transport protocol must provide so that @@ -1461,341 +1846,344 @@ The SPPP client or registrar can be a separate entity acting on behalf of the registrant in facilitating provisioning transactions to the registry. Further, the transport layer provides end-to-end connection protection between SPPP client and the SPPP server. Therefore, man-in-the-middle attack is a possibility that may affect the integrity of the data that belongs to the registrant and/or expose peer data to unintended actors in case well-established peering relationships already exist. -9. IANA Considerations +10. IANA Considerations This document uses URNs to describe XML namespaces and XML schemas conforming to a registry mechanism described in [RFC3688]. Two URI assignments are requested. Registration request for the SPPP XML namespace: urn:ietf:params:xml:ns:sppp:base:1 Registrant Contact: IESG XML: None. Namespace URIs do not represent an XML specification. Registration request for the XML schema: URI: urn:ietf:params:xml:schema:sppp:1 Registrant Contact: IESG XML: See the "Formal Specification" section of this document - (Section 10). + (Section 11). IANA is requested to create a new SPPP registry for Organization Identifiers that will indicate valid strings to be used for well- known enterprise namespaces. This document makes the following assignments for the OrgIdType namespaces: Namespace OrgIdType namespace string ---- ---------------------------- IANA Enterprise Numbers iana-en -10. Formal Specification +11. Formal Specification - This section provides the draft XML Schema Definition for SPPP. + This section provides the draft XML Schema Definition for SPPP + Protocol. - ---- Generic Object key types to be defined by - specific Transport/Architecture. The types - defined here can be extended by the - specific architecture to define the Object - Identifiers. ---- + ---- Generic Object key + types to be defined by specific + Transport/Architecture. + The types defined here can + be extended by the + specific architecture to + define the Object Identifiers ---- - + - ---- Generic type that represents the key for various + ---- Generic type that + represents the key for various objects in SPPP. ---- + + - ---- Generic type that represents the key for a route + ---- Generic type + that represents + the key for a route group offer. ---- + + + + + - ---- Object Type Definitions ---- + ----Generic type that + represents the key + for a Pub Id. ---- + + + + + ---- Object Type Definitions ---- + - - + - - - + - + + - + - - + + - - - - + + - - + + - - + + - - + + - + - - - - + + + + - - + + - + - + - - + + - - + + - + - - - + + + - -- Abstract Object and Element Type Defs -- + ---- Abstract Object and + Element Type + Definitions ---- - - - + + + - + - + - + - + - + - - - + + + + - - - + + + - @@ -1860,45 +2248,72 @@ - + + + + + + + + + + + + + + + + + + + + + + + + + + + + -11. Acknowledgments +12. Acknowledgments This document is a result of various discussions held in the DRINKS working group and within the DRINKS protocol design team, which is comprised of the following individuals, in alphabetical order: Alexander Mayrhofer, Deborah A Guyton, David Schwartz, Lisa Dusseault, Manjul Maharishi, Mickael Marrache, Otmar Lendl, Richard Shockey, Samuel Melloul, and Sumanth Channabasappa. -12. References +13. References -12.1. Normative References +13.1. Normative References [I-D.ietf-drinks-sppp-over-soap] Cartwright, K., "SPPP Over SOAP and HTTP", - draft-ietf-drinks-sppp-over-soap-05 (work in progress), - September 2011. + draft-ietf-drinks-sppp-over-soap-06 (work in progress), + October 2011. [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. [RFC2277] Alvestrand, H., "IETF Policy on Character Sets and Languages", BCP 18, RFC 2277, January 1998. [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO 10646", STD 63, RFC 3629, November 2003. @@ -1908,21 +2323,21 @@ [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform Resource Identifier (URI): Generic Syntax", STD 66, RFC 3986, January 2005. [RFC4949] Shirey, R., "Internet Security Glossary, Version 2", RFC 4949, August 2007. [RFC5067] Lind, S. and P. Pfautz, "Infrastructure ENUM Requirements", RFC 5067, November 2007. -12.2. Informative References +13.2. Informative References [I-D.ietf-drinks-usecases-requirements] Channabasappa, S., "Data for Reachability of Inter/ tra-NetworK SIP (DRINKS) Use cases and Protocol Requirements", draft-ietf-drinks-usecases-requirements-06 (work in progress), August 2011. [RFC2781] Hoffman, P. and F. Yergeau, "UTF-16, an encoding of ISO 10646", RFC 2781, February 2000. @@ -1972,10 +2387,18 @@ Email: syed.ali@neustar.biz Alexander Mayrhofer enum.at GmbH Karlsplatz 1/9 Wien, A-1010 Austria Email: alexander.mayrhofer@enum.at + + Vikas Bhatia + TNS + 1939 Roland Clarke Place + Reston, VA 20191 + USA + + Email: vbhatia@tnsi.com