--- 1/draft-ietf-drinks-spprov-10.txt 2011-10-31 23:14:07.443005210 +0100 +++ 2/draft-ietf-drinks-spprov-11.txt 2011-10-31 23:14:07.535004444 +0100 @@ -1,143 +1,105 @@ DRINKS J-F. Mule Internet-Draft CableLabs Intended status: Standards Track K. Cartwright -Expires: March 12, 2012 TNS +Expires: May 3, 2012 TNS S. Ali NeuStar A. Mayrhofer enum.at GmbH - September 9, 2011 + October 31, 2011 - Session Peering Provisioning Protocol - draft-ietf-drinks-spprov-10 + Session Peering Provisioning Protocol Data Model + draft-ietf-drinks-spprov-11 Abstract - This document defines a protocol for provisioning session - establishment data into Session Data Registries and SIP Service - Provider data stores. The provisioned data is typically used by - various network elements for session peering. - - This document describes the Session Peering Provisioning Protocol - used by clients to provision registries. The document provides a set - of guiding principles for the design of this protocol including - extensibility and independent transport definitions, a basic data - model and an XML Schema Document. + 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. Status of this Memo This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79. 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 March 12, 2012. + This Internet-Draft will expire on May 3, 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 . . . . . . . . . . . . . . . . . . . . . . . . . 4 - 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 7 - 3. Protocol High Level Design . . . . . . . . . . . . . . . . . . 9 - 3.1. Protocol Layering . . . . . . . . . . . . . . . . . . . . 9 - 3.2. Protocol Data Model . . . . . . . . . . . . . . . . . . . 10 - 3.3. Time Value . . . . . . . . . . . . . . . . . . . . . . . . 13 - 4. Transport Protocol Requirements . . . . . . . . . . . . . . . 14 - 4.1. Connection Oriented . . . . . . . . . . . . . . . . . . . 14 - 4.2. Request and Response Model . . . . . . . . . . . . . . . . 14 - 4.3. Connection Lifetime . . . . . . . . . . . . . . . . . . . 14 - 4.4. Authentication . . . . . . . . . . . . . . . . . . . . . . 14 - 4.5. Authorization . . . . . . . . . . . . . . . . . . . . . . 15 - 4.6. Confidentiality and Integrity . . . . . . . . . . . . . . 15 - 4.7. Near Real Time . . . . . . . . . . . . . . . . . . . . . . 15 - 4.8. Request and Response Sizes . . . . . . . . . . . . . . . . 15 - 4.9. Request and Response Correlation . . . . . . . . . . . . . 15 - 4.10. Request Acknowledgement . . . . . . . . . . . . . . . . . 15 - 4.11. Mandatory Transport . . . . . . . . . . . . . . . . . . . 16 - 5. Base Protocol Data Structures . . . . . . . . . . . . . . . . 17 - 5.1. Request and Response Structures . . . . . . . . . . . . . 17 - 5.1.1. Update Request and Response Structures . . . . . . . . 17 - 5.1.2. Query Request and Response Structures . . . . . . . . 20 - 5.2. Response Codes and Messages . . . . . . . . . . . . . . . 23 - 5.3. Basic Object Type and Organization Identifiers . . . . . . 25 - 6. Protocol Commands . . . . . . . . . . . . . . . . . . . . . . 26 - 6.1. Add Destination Group Operation . . . . . . . . . . . . . 26 - 6.2. Get Destination Groups Operation . . . . . . . . . . . . . 27 - 6.3. Add Public Identifier Operation . . . . . . . . . . . . . 28 - 6.4. Get Public Identifiers Operation . . . . . . . . . . . . . 33 - 6.5. Add Route Group Operation . . . . . . . . . . . . . . . . 33 - 6.6. Get Route Groups Operation . . . . . . . . . . . . . . . . 38 - 6.7. Add Route Record Operation . . . . . . . . . . . . . . . . 39 - 6.8. Get Route Records Operation . . . . . . . . . . . . . . . 43 - 6.9. Add Route Group Offer Operation . . . . . . . . . . . . . 44 - 6.10. Accept Route Group Offer Operation . . . . . . . . . . . . 46 - 6.11. Reject Route Group Offer Operation . . . . . . . . . . . . 47 - 6.12. Get Route Group Offers Operation . . . . . . . . . . . . . 48 - 6.13. Egress Route Operations . . . . . . . . . . . . . . . . . 50 - 6.14. Delete Operation . . . . . . . . . . . . . . . . . . . . . 52 - 7. SPPP Examples . . . . . . . . . . . . . . . . . . . . . . . . 54 - 7.1. Add Destination Group . . . . . . . . . . . . . . . . . . 54 - 7.2. Add Route Records . . . . . . . . . . . . . . . . . . . . 55 - 7.3. Add Route Records -- URIType . . . . . . . . . . . . . . . 56 - 7.4. Add Route Group . . . . . . . . . . . . . . . . . . . . . 57 - 7.5. Add Public Identity -- Successful COR claim . . . . . . . 58 - 7.6. Add LRN . . . . . . . . . . . . . . . . . . . . . . . . . 60 - 7.7. Add TN Range . . . . . . . . . . . . . . . . . . . . . . . 61 - 7.8. Add TN Prefix . . . . . . . . . . . . . . . . . . . . . . 62 - 7.9. Enable Peering -- Route Group Offer . . . . . . . . . . . 63 - 7.10. Enable Peering -- Route Group Offer Accept . . . . . . . . 64 - 7.11. Add Egress Route . . . . . . . . . . . . . . . . . . . . . 65 - 7.12. Get Destination Group . . . . . . . . . . . . . . . . . . 66 - 7.13. Get Public Identity . . . . . . . . . . . . . . . . . . . 67 - 7.14. Get Route Group Request . . . . . . . . . . . . . . . . . 68 - 7.15. Get Route Group Offers Request . . . . . . . . . . . . . . 70 - 7.16. Get Egress Route . . . . . . . . . . . . . . . . . . . . . 71 - 7.17. Delete Destination Group . . . . . . . . . . . . . . . . . 72 - 7.18. Delete Public Identity . . . . . . . . . . . . . . . . . . 73 - 7.19. Delete Route Group Request . . . . . . . . . . . . . . . . 74 - 7.20. Delete Route Group Offers Request . . . . . . . . . . . . 75 - 7.21. Delete Egress Route . . . . . . . . . . . . . . . . . . . 75 - 8. XML Considerations . . . . . . . . . . . . . . . . . . . . . . 77 - 8.1. Namespaces . . . . . . . . . . . . . . . . . . . . . . . . 77 - 8.2. Versioning and Character Encoding . . . . . . . . . . . . 77 - 9. Security Considerations . . . . . . . . . . . . . . . . . . . 78 - 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 80 - 11. Formal Specification . . . . . . . . . . . . . . . . . . . . . 81 - 12. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 94 - 13. References . . . . . . . . . . . . . . . . . . . . . . . . . . 95 - 13.1. Normative References . . . . . . . . . . . . . . . . . . . 95 - 13.2. Informative References . . . . . . . . . . . . . . . . . . 95 - Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 97 + 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 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 @@ -208,51 +170,52 @@ comprises of the target domain to assist in call routing (as described in [RFC5486]). In this case, the querying entity may 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 description of the data model and the means to - enable protocol operations within a request and response structure. + 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 + 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 the SPPP, including the - layering approach, functional entities and data model; + 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 including - the request and response elements (Section 5.1), the response - codes and messages (Section 5.2) and the basic object type most - first class objects extend from; + 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; - o Section 6 and Section 7 describe the main protocol commands and - examples; + o Section 6 detailed descriptoins of the data model object + specifications; - o Section 8 defines XML considerations that XML parsers must meet + o Section 7 defines XML considerations that XML parsers must meet to conform to this specification; - o Section 11 normatively defines the SPPP protocol using its XML + o Section 10 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] @@ -302,90 +265,23 @@ of SPPP. 3. Protocol High Level Design This section introduces the structure of the data model and provides the information framework for the SPPP. An overview of the protocol operations is first provided with a typical deployment scenario. The data model is then defined along with all the objects manipulated by the protocol and their relationships. -3.1. Protocol Layering - - SPPP is a simple request/reply protocol that allows a client - application to submit provisioning data and query requests to a - server. The SPPP data structures are designed to be protocol - agnostic. Concerns regarding encryption, non-repudiation, and - authentication are beyond the scope of this document. For more - details, please refer to the Transport Protocol Requirements section. - - Layer Example - +-------------+ +-----------------------------+ - (5) |Data Objects | | RteGrpType, etc. | - +-------------+ +-----------------------------+ - | | - +-------------+ +-----------------------------+ - (4) | Operations | | AddRteGrpRqstType, etc. | - +-------------+ +-----------------------------+ - | | - +-------------+ +-----------------------------+ - (3) | Message | | spppUpdateRequest, | - | | | spppUpdateResponse, | - | | | spppQueryRequest, | - | | | spppQueryResponse | - +-------------+ +-----------------------------+ - | | - +-------------+ +-----------------------------+ - (2) | Message | | HTTP, SOAP, None, etc. | - | Envelope | | | - +-------------+ +-----------------------------+ - | | - +-------------+ +-----------------------------+ - (1) | Transport | | TCP, TLS, BEEP, etc. | - | Protocol | | | - +-------------+ +-----------------------------+ - - SPPP Layering - - Figure 2 - - SPPP can be viewed as a set of layers that collectively define the - structure of an SPPP request and response. Layers 1 and 2, as - detailed below, are left to separate specifications to allow for - potentially multiple SPPP transport, envelope, and authentication - technologies. This document defines layers 3, 4, and 5 below. - - 1. The transport protocol layer provides a communication mechanism - between the client and server. SPPP can be layered over any - transport protocol that provides a set of basic requirements - defined in the Transport Protocol Requirements section. - - 2. The message envelope layer is optional, but can provide features - that are above the transport technology layer but below the - application messaging layer. Technologies such as HTTP and SOAP - are examples of messaging envelope technologies. - - 3. The message layer provides a simple, envelope-independent and - transport-independent, SPPP wrapper for SPPP request and response - messages. - - 4. The operation layer defines the set of base SPPP actions that can - be invoked for a given object data type using an SPPP message. - Operations are encoded using XML encoded actions and objects. - - 5. The data object layer defines the base set of SPPP data objects - that can be included in update operations or returned in - operation responses. - -3.2. Protocol Data Model +3.1. Protocol Data Model - The data model illustrated and described in Figure 3 defines the + The data model illustrated and described in Figure 2 defines the logical objects and the relationships between these objects that the SPPP protocol supports. SPPP defines the protocol operations through which an SPPP client populates a registry with these logical objects. Various clients belonging to different registrars may use the protocol for populating the registry's data. The logical structure presented below is consistent with the terminology and requirements defined in [I-D.ietf-drinks-usecases-requirements]. @@ -428,21 +324,21 @@ |of Public |Identifiers... +---------+-------+------------... | | | | +------+ +-----+ +-----+ +-----+ | TN | | TNP | | TNR | | RN | +------+ +-----+ +-----+ +-----+ SPPP Data Model - Figure 3 + Figure 2 The objects and attributes that comprise the data model can be described as follows (objects listed from the bottom up): o Public Identifier: From a broad perspective a public identifier is a well-known attribute that is used as the key to perform resolution lookups. Within the context of SPPP, a public identifier object can be a telephone number, a range of telephone numbers, a PSTN Routing Number (RN), or a TN prefix. @@ -504,21 +400,21 @@ 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. -3.3. Time Value +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. "2010-05-30T09:30:10Z" is an example of an acceptable time value for use in SPPP messages. "2010-05-30T06:30:10+3:00" is a valid UTC time, @@ -633,442 +529,95 @@ 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 - SPPP uses a common model and a common set of data structures for most - of the supported operations and object types. This section describes - these common data structures. - -5.1. Request and Response Structures - - An SPPP client interacts with an SPPP server by using one of the - supported transport mechanisms to send one or more requests to the - server and receive corresponding replies from the server. There are - two generalized types of operations that an SPPP client can submit to - an SPPP server, updates and queries. The following two sub-sections - describe the generalized data structures that are used for each of - these two types of operations. - -5.1.1. Update Request and Response Structures - - An SPPP update request is wrapped within the - element while an SPPP update response is wrapped within an - element. The following two sub-sections - describe these two elements. - -5.1.1.1. Update Request - - An SPPP update request object is contained within the generic - element. - - - - - - - - - - - - - - - - - - - The data elements within the element are - described as follows: - - o clientTransId: Zero or one client-generated transaction ID that, - within the context of the SPPP client, identifies this request. - This value can be used at the discretion of the SPPP client to - track, log or correlate requests and their responses. SPPP - server MUST echo back this value to the client in the - corresponding response to the incoming request. SPPP server - will not check this value for uniqueness. - - o minorVer: Zero or one minor version identifier, indicating the - minor version of the SPPP API that the client is attempting to - use. This is used in conjunction with the major version - identifier in the XML namespace to identify the version of SPPP - that the client is using. If the element is not present, the - server assumes that the client is using the latest minor version - supported by the SPPP server for the given major version. The - versions supported by a given SPPP server can be retrieved by - the client using the SPPP server menu operation described later - in the document. - - o rqst: One or more BasicUpdateRqstType objects. These are the - actions that the client is requesting the SPPP server perform. - They are processed by the SPPP server in the order in which they - are included in the request. And with respect to handling error - conditions, it is a matter of policy whether the objects are - processed in a "stop and rollback" fashion or in a "stop and - commit" fashion. In the "stop and rollback" scenario, the SPPP - server would stop processing BasicUpdateRqstType object - instances in the request at the first error and roll back any - BasicUpdateRqstType object instances that had already been - processed for that update request. In the "stop and commit" - scenario the SPPP server would stop processing - BasicUpdateRqstType object instances in the request at the first - error but commit any BasicUpdateRqstType object instances that - had already been processed for that update request. - - All update request objects extend the base type BasicUpdateRqstType. - This base type is defined as follows: - - - - - - - - The BasicUpdateRqstType object primarily acts as an abstract base - type, and its only data element is described as follows: - - o ext: This is the standard extension element for this object. - Refer to the Extensibility section of this document for more - details. - -5.1.1.2. Update Response - - An SPPP update response object is contained within the generic - element. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - An contains the elements necessary for the SPPP - client to precisely determine the overall result of the request, and - if an error occurred, it provides information about the specific - object, data element, or condition caused the error. - - The data elements within the SPPP update response are described as - follows: - - o clientTransId: Zero or one client transaction ID. This value is - simply an echo of the client transaction ID that SPPP client - passed into the SPPP update request. When included in the - request, the SPPP server MUST return it in the corresponding - response message. - - o serverTransId: Exactly one server transaction ID that identifies - this request for tracking purposes. This value MUST be unique - for a given SPPP server. - - o overallResult: Exactly one response code and message pair that - explicitly identifies the result of the request. See the - Response Code section for further details. - - o rqstObjResult: An optional response code, response message, and - BasicRqstObject triplet. This element will be present only if - an object level error has occurred. It indicates the error - condition and the exact request object that contributed to the - error. The response code will reflect the exact error. See the - Response Code section for further details. - - o ext: This is the standard extension element for this object. - Refer to the Extensibility section for more details. - -5.1.2. Query Request and Response Structures - - At times, on behalf of the registrant, the registrar may need to have - access to SPPP objects that were previously provisioned in the - registry. A few examples include logging, auditing, and pre- - provisioning dependency checking. This query mechanism is limited to - aid provisioning scenarios and should not be confused with query - protocols provided as part of the resolution system (e.g. ENUM and - SIP). - - An SPPP query request is wrapped within the - element while an SPPP query response is wrapped within an - element. The following two sub-sections describe - these two element structures. - -5.1.2.1. Query Request - - An SPPP query request object is contained within the generic - element. - - - - - - - - - - - The data elements within the element are described - as follows: - - o minorVer: Zero or one minor version identifier, indicating the - minor version of the SPPP API that the client is attempting to - use. This is used in conjunction with the major version - identifier in the XML namespace to identify the version of SPPP - that the client is using. If the element is not present, the - server assumes that the client is using the latest minor version - supported by the SPPP server for the given major version. The - versions supported by a given SPPP server can be retrieved by - the client using the SPPP server menu operation described later - in the document. - - o rqst: One BasicQueryRqstType objects. This is the query that - the client is requesting the SPPP server perform. - - All query request objects extend the base type BasicQueryRqstType. - This base type is defined as follows: - - - - - - - - - The BasicQueryRqstType object primarily acts as an abstract base - type, and its only data element is described as follows: - - o ext: This is the standard extension element for this object. - Refer to the Extensibility section of this document for more - details. - -5.1.2.2. Query Response - - An SPPP query response object is contained within the generic - element. - - - - - - - - - - - An contains the elements necessary for the SPPP - client to precisely determine the overall result of the query, and if - an error occurred, exactly what condition caused the error. - - The data elements within the SPPP query response are described as - follows: - - o overallResult: Exactly one response code and message pair that - explicitly identifies the result of the request. See the - Response Code section for further details. - - o resultSet: The set of zero or more objects that matched the - query criteria. If no objects matched the query criteria then - this result set MUST be empty and the overallResult value MUST - indicate success (if no matches are found for the query - criteria, the response is considered a success). - -5.2. Response Codes and Messages - - This section contains the listing of response codes and their - corresponding human-readable text. - - The response code numbering scheme generally adheres to the theory - formalized in section 4.2.1 of [RFC5321]: - - o The first digit of the response code can only be 1 or 2: 1 = a - positive result, 2 = a negative result. - - o The second digit of the response code indicates the category: 0 - = Protocol Syntax, 1 = Implementation Specific Business Rule, 2 - = Security, 3 = Server System. - - o The third and fourth digits of the response code indicate the - individual message event within the category defines by the - first two digits. - - The response codes are also categorized as to whether they are - overall response codes that may only be returned in the - "overallResult" data element in SPPP responses, of object level - response codes that may only be returned in the "rqstObjResult" - element of the SPPP responses. - - +--------+--------------------------+-------------------------------+ - | Result | Result Message | Overall or Object Level | - | Code | | | - +--------+--------------------------+-------------------------------+ - | 1000 | Request Succeeded. | Overall Response Code | - | | | | - | 2001 | Request syntax invalid. | Overall Response Code | - | | | | - | 2002 | Request too large. | Overall Response Code | - | | | | - | 2003 | Version not supported. | Overall Response Code | - | | | | - | 2103 | Command invalid. | Overall Response Code | - | | | | - | 2301 | System temporarily | Overall Response Code | - | | unavailable. | | - | | | | - | 2302 | Unexpected internal | Overall Response Code | - | | system or server error. | | - | | | | - | 2104 | Attribute value invalid. | Object Level Response Code | - | | | | - | | AttrName:[AttributeName] | | - | | AttrVal:[AttributeValue] | | - | | | | - | 2105 | Object does not exist. | Object Level Response Code | - | | AttrName:[AttributeName] | | - | | AttrVal:[AttributeValue] | | - | | | | - | 2106 | Object status or | Object Level Response Code | - | | ownership does not allow | | - | | for operation. | | - | | AttrName:[AttributeName] | | - | | AttrVal:[AttributeValue] | | - +--------+--------------------------+-------------------------------+ - - Table 1: Response Codes Numbering Scheme and Messages - - Each of the object level response messages are "parameterized" with - the following parameters: "AttributeName" and "AttributeValue". - - The use of these parameters MUST adhere to the following rules: - - o All parameters within a response message are mandatory and MUST - be present. - - o Any value provided for the "AttributeName" 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 "AttributeValue" MUST be the value of the data - element to which the preceding "AttributeName" refers. - - o Result code 2104 SHOULD be used whenever an element value does - not adhere to data validation rules. - - o Result codes 2104 and 2105 MUST NOT be used interchangeably. - Response code 2105 SHOULD be returned by an update 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 code - 2104 SHOULD be returned. + SPPP contains some common data structures for most of the supported + object types. This section describes these common data structures. -5.3. Basic Object Type and Organization Identifiers +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 that contains the identifier 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. + this object, the identifier of the registrar organization that + created 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. - - - + + + + - The identifiers used for registrants (rant) 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. + 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. -6. Protocol Commands +5.2. Object Key Type - This section provides a description of each supported protocol - command. + 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. -6.1. Add Destination Group Operation + + + + -- Generic type that represents the + key for various objects in SPPP. -- + + + - As described in the introductory sections, a Destination Group - represents a set of Public Identifiers with common routing - information. +6. Protocol Data Model Objects - The AddDestGrpRqstType operation creates or overwrites a Destination - Group object. If a Destination Group with the given name and - registrant ID (which together comprise the unique key for a - Destination Group) does not exist, then the server MUST create the - Destination Group. If a Destination Group with the given name and - registrant ID does exist, then the server MUST replace the current - properties of the Destination Group with the properties passed into - the AddDestGrpsRqstType operation. The XSD declarations of the - operation request object are as follows: + 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. - - - - - - - - - +6.1. Destination Group - The element passed into the spppUpdateRequest element for this - operation is an element of type AddDestGrpRqsttype, which extends - BasicUpdateRqstType and contains a DestGrpType object. The - DestGrpType object structure is defined as follows: + 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: - 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 @@ -1076,134 +625,96 @@ 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). 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 - AddDestGrpRqstType 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.2. Get Destination Groups Operation - - The getDestGrpsRqst operation allows an SPPP client to get the - properties of Destination Group objects that a registrar is - authorized to view on behalf of the registrant. The server will - attempt to find a Destination Group object that has the registrant ID - and destination group name pair contained in each ObjKeyType object - instance. If there are no matching Destination Groups found then an - empty result set will be returned. If no ObjKeyType objects are - found in the request then the server will return the list of all - Destination Group objects in the registry. If no matching records - can be located then an empty result set will be returned. - - The element passed into the spppQueryRequest element for this - operation is an instance of type GetDestGrpsRqstType, which extends - BasicQueryRqstType and contains zero or more ObjKeyType objects. Any - limitation on the maximum number of objects that may be passed into - or returned by this operation is a policy decision and not limited by - the protocol. The XSD declaration of the operation is as follows: - - - - - - - - - - - - As described in an earlier section of this document, the result of - any spppQueryRequest operation is an spppQueryResponse element that - contains the overall response code and the query result set, if any. - Refer to that section of the document for a detailed description of - the spppQueryResponse element. - -6.3. Add Public Identifier Operation +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. + 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. 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: - + - A registrant can add a Public Identifier using the AddPubIdRqstType - operation. To complete the add request, AddPubIdRqstType XML - instance is populated into the element. 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 + 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. If a Public - Identifier being added already exists then that Public Identifier - will be replaced with the newly provisioned Public Identifier. + 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: - + + + + + + + + TNType consists of the following attributes: o tn: Telephone number to be added to the registry. o rrRef: Optional reference to route records that are directly associated with the TN Public Identifier. Following the SPPP data model, the route record could be a protocol agnostic URIType or another type. o corInfo: corInfo is an optional parameter of type CORInfoType @@ -1233,31 +744,31 @@ 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: - + RNType has the following attributes: - o rn: Routing Number used as the search key + o rn: Routing Number used as the search key. o corInfo: Optional element of type CORInfoType. 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 @@ -1267,28 +778,27 @@ 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: - - + + - 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 @@ -1301,136 +811,80 @@ 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: - + TNPType consists of the following attributes: o tnPrefix: The telephone number prefix o corInfo: Optional element of type CORInfoType. - The object structure of AddPubIdRqstType is used to add Public - Identifiers is as follows - - - - - - - - - - -6.4. Get Public Identifiers Operation - - The SPPP client can use the GetPubIdsRqstType in the - structure to obtain information about one or more - objects. If no matching Public Identifiers are found, then an - empty result set is returned. - - GetPubIdsRqstType object structure is as follows: - - - - - - - - - - - - As described earlier in the document, the result of any - spppQueryRequest operation is a spppQueryResponse that contains the - response code and the query result set, if any. - -6.5. Add Route Group Operation +6.3. Route Group As described in the introductory sections, a Route Group represents a combined grouping of Route Records that define route information, 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 AddRteGrpRqstType operation creates or overwrites a Route Group - object. If a Route Group with the given name and registrant ID - (which together comprise the unique key or a Route Group) does not - exist, then the server MUST create the Route Group. If a Route Group - with the given name and registrant ID does exist, then the server - MUST replace the current properties of the Route Group with the - properties passed into the AddRteGrpRqstType operation. The XSD - declarations of the AddRteGrpRqstType operation request object are as - follows: - - - - - - - - - - - - The element passed into the spppUpdateRequest element for this - operation is an instance of AddRteGrpRqstType, which extends - BasicUpdateRqstType and contains one RteGrpType object. The - RteGrpType object structure is defined as follows: + data. The transport protocol MUST support the ability to Create, + Modify, Get, and Delete Route Groups. The RteGrpType object + structure is defined as follows: - + - - + - + The RteGrpType 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 passes in either the created date or the modification date, the @@ -1511,24 +965,25 @@ compares these criteria against the source identity criteria associated with the Route Groups. The routing information contained in Route Groups that have source based routing criteria will only be included in the resolution response if one or more of the criteria matches the source criteria from the resolution request. The Source Identity data element is of type SourceIdentType, whose structure is defined as follows: - + - + @@ -1546,105 +1001,45 @@ 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.6. Get Route Groups Operation - - The getRteGrpsRqst operation allows an SPPP client to get the - properties of Route Group objects that the registrar is authorized to - view on behalf of the registrant. The server will attempt to find a - Route Group object that has the registrant ID and route group name - pair contained in each ObjKeyType object instance. If no ObjKeyType - objects are found in the request then the server will return the list - of all Route Group objects that belongs to the registrant. If there - are no matching Route Groups found then an empty result set will be - returned. - - The element passed into the spppQueryRequest element for this - operation is an instance of type GetRteGrpsRqstType, which extends - BasicUpdateRqstType and contains zero or more ObjKeyType objects. - Any limitation on the maximum number of objects that may be passed - into or returned by this operation is a policy decision and not - limited by the protocol. The XSD declaration of the operation is as - follows: - - - - - - - - - - - - As described in an earlier section of this document, the result of - any spppQueryRequest operation is an spppQueryResponse element that - contains the overall response code and the query result set, if any. - Refer to that section of the document for a detailed description of - the spppQueryResponse element. - -6.7. Add Route Record Operation +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 AddRteRecRqstType operation creates or overwrites a Route Record - object. If a Route Record with the given name and registrant ID - (which together comprise the unique key or a Route Record) does not - exist, then the server MUST create the Route Record. If a Route - Record with the given name and registrant ID does exist, then the - server MUST replace the current properties of the Route Record with - the properties passed into the AddRteRecRqstType operation. The XSD - declarations of the AddRteRecRqstType operation request object are as - follows: - - - - - - - - - - - - The element passed into the spppUpdateRequest element for this - operation is an instance of AddRteRecRqstType, which extends - BasicUpdateRqstType and contains one RteRecType object. The - RteRecType object structure is defined as follows: + 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: - + - The RteRecType 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 passes in either the created date or the modification date, the server will ignore them. The server sets these two date/time values. @@ -1681,74 +1076,90 @@ substituting any back reference(s) in the to arrive at the final URI that is returned in the SIP Contact header. For an ENUM query, the resolution server will simply return the value of the and members of the URIType in the NAPTR REGEX parameter. - - + + - - - + + + - - - - + + + + - - - + + - + - - - + + + + + + + + + + The NAPTRType object is composed of the following elements: o order: Order value in an ENUM NAPTR, relative to other NAPTRType objects in the same Route Group. o svcs: ENUM service(s) that are served by the SBE. This field's value must be of the form specified in [RFC6116] (e.g., E2U+ pstn:sip+sip). The allowable values are a matter of policy and not limited by this protocol. @@ -1779,128 +1190,73 @@ The URIType object is composed of the following elements: o ere: The POSIX Extended Regular Expression (ere) as defined in [RFC3986]. o uri: the URI as defined in [RFC3986]. In some cases, this will serve as the replacement string and it will be left to the resolution server to arrive at the final usable URI. - As with the responses to all update operations, the result of the - AddRteRecRqstType 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.8. Get Route Records Operation - - The getRteRecsRqst operation allows an SPPP client to get the - properties of Route Record objects that a registrar is authorized to - view on behalf of the registrant. The server will attempt to find a - Route Record object that has the registrant ID and route record name - pair contained in each ObjKeyType object instance. If no ObjKeyType - objects are found in the request then the server will return the list - of all Route Record that belongs to the registrant. If there are no - matching Route Record found then an empty result set will be - returned. - - The element passed into the spppQueryRequest element for this - operation is an instance of type GetRteRecsRqstType, which extends - BasicUpdateRqstType and contains zero or more ObjKeyType objects. - Any limitation on the maximum number of objects that may be passed - into or returned by this operation is a policy decision and not - limited by the protocol. The XSD declaration of the operation is as - follows: - - - - - - - - - - - - As described in an earlier section of this document, the result of - any spppQueryRequest operation is an spppQueryResponse element that - contains the overall response code and the query result set, if any. - Refer to that section of the document for a detailed description of - the spppQueryResponse element. - -6.9. Add Route Group Offer Operation +6.5. Route Group Offer The list of peer organizations whose resolution responses can include the routing information contained in a given Route Group is controlled by the organization to which a Route Group object belongs (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 - AddRteGrpOffersRqstType operation creates or overwrites one or more - Route Group Offer objects. If a Route Group Offer for the given - Route Group object key and the Org ID does not exist, - then the server creates the Route Group Offer object. If a such a - Route Group Offer does exist, then the server replaces the current - object with the new object. The XSD declarations of the operation - request object are as follows: - - - - - - - - - - - - The element passed into the spppUpdateRequest element for this - operation is an instance of AddRteGrpOfferRqstType, which extends - BasicUpdateRqstType and contains a RteGrpOfferType object. The XSD - declaration of the RteGrpOfferType is as follows: + 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: - + - - + + - - - - - + + + + -- Generic type that represents the key for a route + route group offer. Must be defined in concrete form + in the transport specificaiton. -- + + + The RteGrpOfferType 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 will ignore them. The server sets these two date/time values. o rteGrpOfferKey: The object that identifies the route that is or @@ -1898,217 +1254,91 @@ 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 will ignore them. The server sets these two date/time values. o rteGrpOfferKey: The object that identifies the route that is or has been offered and the organization that it is or has been - offered to. The combination of these three data elements - uniquely identify a Route Group Offer. + offered to. o status: The status of the offer, offered or accepted. The server controls the status. It is automatically set to "offered" when ever a new Route Group Offer is added, and is 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. - As with the responses to all update operations, the result of the - AddRteGrpOfferRqstType 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.10. Accept Route Group Offer Operation - - Not until access to a Route Group has been offered and accepted will - the data recipient's organization ID will it 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 data recipient. The - AcceptRteGrpOffersRqstType operation is called by, or on behalf of, - the data recipient to accept a Route Group Offer that is pending in - the "offered" status for the data recipient's organization ID. If a - Route Group Offer for the given Route Group Offer key (route name, - route registrant ID, data recipient's organization ID) exists, then - the server moves the Route Group Offer to the "accepted" status and - adds that data recipient's organization ID into the list of - peerOrgIds for that Route Group. If a such a Route Group Offer does - not exist, then the server returns the appropriate error code, 2105. - The XSD declarations for the operation request object are as follows: - - - - - - - - - - - - The element passed into the spppUpdateRequest element for this - operation is an instance of AcceptRteGrpOffersRqstType, which extends - BasicUpdateRqstType and contains a RteGrpOfferKeyType object. - - As with the responses to all update operations, the result of the - AcceptRteGrpOfferRqstType 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.11. Reject Route Group Offer Operation - - The data recipient 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. The RejectRteGrpOffersRqstType operation is used for these - purposes and is called by, or on behalf of, the data recipient to - accept a Route Group Offer that is pending in the "offered" status or - is in the "accepted" status for the data recipient's organization ID. - If a Route Group Offer for the given Route Group Offer key (route - name, route registrant ID, data recipient's organization ID) exists - in either the offered or accepted status, then the server deletes - that Route Group Offer object, and, if appropriate, removes the data - recipient's organization ID from the list of peeringOrg IDs for that - Route Group. If the Route Group Offer does not exist, then the - server returns the appropriate error code, 2105. The XSD - declarations for the operation request object are as follows: - - - - - - - - - - - - The element passed into the spppUpdateRequest element for this - operation is an instance of RejectRteGrpOffersRqstType, which extends - BasicUpdateRqstType and contains a RteGrpOfferKeyType object. - - As with the responses to all update operations, the result of the - RejectRteGrpOfferRqstType 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.12. Get Route Group Offers Operation - - The getRteGrpOffersRqst operation allows an SPPP client to get the - properties of zero or more Route Group Offer objects that registrar - is authorized to view on behalf of the registrant. The server will - attempt to find Route Group Offer objects that have all the - properties specified in the criteria passed into the operation. If - no criteria is passed in then the server will return the list of - Route Group Offer objects that belongs to the registrant. If there - are no matching Route Group Offers found then an empty result set - will be returned. - - The element passed into the spppQueryRequest element for this - operation is an instance of GetRteGrpOffersRqstType, which extends - BasicQueryRqstType and contains the criteria that the returned Route - Group Offer objects must match. Any limitation on the maximum number - of objects that may be returned by this operation is a policy - decision and not limited by the protocol. The XSD declaration of the - operation is as follows: - - - - - - - - - - - - - - - The GetRteGrpOffersRqstType object is composed of the following - elements: - - o offeredBy: Zero or more organization IDs. Only offers that are - offered to the organization IDs in this list should be included - in the result set. The result set is also subject to other - query criteria in the request. - - o offeredTo: Zero or more organization IDs. Only offers that are - offered by the organization IDs in this list should be included - in the result set. The result set is also subject to other - query criteria in the request. - - o status: The status of the offer, offered or accepted. Only - offers in the specified status should be included in the result - set. If this element is not present then the status of the - offer should not be considered in the query. The result set is - also subject to other query criteria in the request. - - o rteGrpOfferKey: Zero or more Route Group Offer Keys. Only - offers having one of these keys should be included in the result - set. The result set is also subject to other query criteria in - the request. + 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. - As described in an earlier section of this document, the result of - any spppQueryRequest operation is an spppQueryResponse element that - contains the overall response code and the query result set, if any. - Refer to that section of the document for a detailed description of - the spppQueryResponse element. + 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.13. Egress Route Operations +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. 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. - An egress route is identified by type EgrRteType and its object - structure is shown below: + The transport protocol MUST support the ability to Create, Modify, + Get, and Delete Egress Routes. The EgrRteType object structure is + defined as follows: - + - + The EgrRteType 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 @@ -2126,1013 +1356,41 @@ o regxRewriteRule: The regular expression re-write rule that should be applied to the regular expression of the ingress NAPTR(s) that belong to the ingress route. o ingrRteRec: The ingress route records that the egress route should be used for. o ext: Point of extensibility described in a previous section of this document. - The AddEgrRteRqstType request is used to create or overwrite an - egress route. - - - - - - - - - - - - An instance of AddEgrRtesRqstType is added in the spppUpdateRequest - element in order to send a valid request to the server. Any - limitation on the maximum number of AddEgrRteRqstType instances is a - matter of policy and is not limited by the specification. - - The response from the server is returned in addEgrRteRspns element, - which is defined as the element of type BasicRspnsType. - - The GetEgrRtesRqstType is used by an authorized entity to fetch the - well-known egress route data. - - - - - - - - - - - -6.14. Delete Operation - - In order to remove an object from the registry, an authorized entity - can send the to the registry with a corresponding - delete BasicUpdateRqstType object. Each 'Add' operation in SPPP has - a corresponding 'Del' operation, which is used to delete the - respective object type from the registry. If the entity that issued - the command is not authorized to perform this operation an - appropriate error code will be returned in the - message. - - As an example, DelPubIdRqstType is used to delete Public Identifiers - The DelPubIdsRqstType object definition is shown below: - - - - - - - - - - - - When an object is deleted, any references to that object must of - course also be removed as the SPPP server implementation fulfills the - deletion request. Furthermore, the deletion of a composite object - must also result in the deletion of the objects it contains. As a - result, the following rules apply to the deletion of SPPP object - types: - - o Destination Groups: When a destination group is deleted all - public identifiers within that destination group must also be - automatically deleted by the SPPP implementation as part of - fulfilling the deletion request. And any references between - that destination group and any route group must be automatically - removed by the SPPP implementation as part of fulfilling the - deletion request. - - o Route Groups: When a route group is deleted any references - between that route group and any destination group must be - automatically removed by the SPPP implementation as part of - fulfilling the deletion request. Similarly any references - between that route group and any route records must be removed - by the SPPP implementation as part of fulfilling the deletion - request. Furthermore, route group offers relating that route - group must also be deleted as part of fulfilling the deletion - request. - - o Route Records: When a route record is deleted any references - between that route record and any route group must be removed by - the SPPP implementation as part of fulfilling the deletion - request. - - o Public Identifiers: When a public identifier is deleted any - references between that public identifier and its containing - destination group must be removed by the SPPP implementation as - part of fulfilling the deletion request. And any route records - contained directly within that Public Identifier must be deleted - by the SPPP implementation as part of fulfilling the deletion - request. - -7. SPPP Examples - - This section shows XML message exchange between two SIP Service - Providers (SSP) and a registry. For the sake of simplicity, the - transport wrapper for the SPPP is left out. The SPPP messages in - this section are valid XML instances that conform to the SPPP schema - version within this document. - - In this sample use case scenario, SSP1 and SSP2 provision resource - data in the registry and use SPPP constructs to selectively share the - route groups. In the figure below, SSP2 has two ingress SBE - instances that are associated with the public identities that SSP2 - has the retail relationship with. Also, the two SBE instances for - SSP1 are used to show how to use SPPP to associate route preferences - for the destination ingress routes and exercise greater control on - outbound traffic to the peer's ingress SBEs. - - ---------------+ +------------------ - | | - +------+ +------+ - | sbe1 | | sbe2 | - +------+ +------+ - SSP1 | | SSP2 - +------+ +------+ - | sbe3 | | sbe4 | - +------+ +------+ - iana-en:111 | | iana-en:222 - ---------------+ +------------------ - | | - | | - | SPPP +------------------+ SPPP | - +------->| Registry |<--------+ - +------------------+ - -7.1. Add Destination Group - - SSP2 adds a destination group to the registry for use later. The - SSP2 SPPP client sets a unique transaction identifier 'tx_7777' for - tracking purposes. The name of the destination group is set to - DEST_GRP_SSP2_1 - - - txid-5555 - - - iana-en:222 - DEST_GRP_SSP2_1 - - - - - The registry processes the request and return a favorable response - confirming successful creation of the named destination group. Also, - besides returning a unique transaction identifier, Registry also - returns the matching client transaction identifier from the request - message back to the SPPP client. - - - - tx_5555 - tx_id_12346 - - 1000 - success - - - -7.2. Add Route Records - - SSP2 adds an ingress routes in the registry. - - - - - - iana-en:222 - RTE_SSP2_SBE2 - 10 - u - E2U+sip - - ^(.*)$ - sip:\1@sbe2.ssp2.example.com - - - - - - The registry returns a success response. - - - - tx_id_11145 - - 1000 - Request successful - - - -7.3. Add Route Records -- URIType - - SSP2 adds another ingress routes in the registry and makes use of - URIType - - - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="urn:ietf:params:xml:ns:sppp:base:1 sppp.xsd" - xmlns="urn:ietf:params:xml:ns:sppp:base:1"> - - - iana-en:222 - RTE_SSP2_SBE4 - ^(.*)$ - sip:\1;npdi@sbe4.ssp2.example.com - - - - - The registry returns a success response. - - - - tx_id_11145 - - 1000 - Request successful - - - -7.4. Add Route Group - - SSP2 creates the grouping of the ingress routes and choses higher - precedence for RTE_SSP2_SBE2 by setting a lower number for the - "priority" attribute, a protocol agnostic precedence indicator. - - - - - - iana-en:222 - RTE_GRP_SSP2_1 - - - iana-en:222 - RTE_SSP2_SBE2 - - 100 - - DEST_GRP_SSP2_1 - true - 10 - - - - - To confirm successful processing of this request, registry returns a - well-known resolution code '1000' to the SSP2 client. - - - - tx_id_12345 - - 1000 - Request successful - - - -7.5. Add Public Identity -- Successful COR claim - - SSP2 activates a TN public identity by associating it with a valid - destination group. Further, SSP2 puts forth a claim that it is the - carrier-of-record for the TN. - - - - txid-5577 - - - iana-en:222 - 2010-05-30T09:30:10Z - DEST_GRP_SSP2_1 - +12025556666 - - true - - - - - - Assuming that the registry has access to TN authority data and it - performs the required checks to verify that SSP2 is in fact the - service provider of record for the given TN, the request is processed - successfully. In the response message, the registry sets the value - of to "true" in order to confirm SSP2 claim as the carrier of - record and the reflects the time when the carrier of record - claim is processed. - - - - txid-5577 - tx_id_12345 - - 1000 - success - - - 1000 - success - - - iana-en:222 - 2010-05-30T09:30:10Z - DEST_GRP_SSP2_1 - +12025556666 - - true - true - 2010-05-30T09:30:11Z - - - - - - -7.6. Add LRN - - If another entity that SSP2 shares the routes with has access to - Number Portability data, it may choose to perform route lookups by - routing number. Therefore, SSP2 associates a routing number to a - destination group in order to facilitate ingress route discovery. - - - - - - iana-en:222 - DEST_GRP_SSP2_1 - 2025550000 - - - - - Registry completes the request successfully and returns a favorable - response to the SPPP client. - - - - tx_id_12345 - - 1000 - Request successful - - - -7.7. Add TN Range - - Next, SSP2 activates a block of ten thousand TNs and associate it to - a destination group. - - - - - - iana-en:222 - DEST_GRP_SSP2_1 - +12026660000 - +12026669999 - - - - - Registry completes the request successfully and returns a favorable - response. - - - - tx_id_12244498 - - 1000 - Request successful - - - -7.8. Add TN Prefix - - Next, SSP2 activates a block of ten thousand TNs using the TNPType - structure and identifying a TN prefix. - - - - - - iana-en:222 - DEST_GRP_SSP2_1 - +1202777 - - - - - Registry completes the request successfully and returns a favorable - response. - - - - tx_id_12387698 - - 1000 - Request successful - - - -7.9. Enable Peering -- Route Group Offer - - In order for SSP1 to complete session establishment for a destination - TN where the target subscriber has a retail relationship with SSP2, - it first requires an asynchronous bi-directional handshake to show - mutual consent. To start the process, SSP2 initiates the peering - handshake by offering SSP1 access to its route group. - - - - - - iana-en:222 - - - iana-en:222 - RTE_GRP_SSP2_1 - - iana-en:111 - - offered - 2006-05-04T18:13:51.0Z - - - - - Registry completes the request successfully and confirms that the - SSP1 will now have the opportunity to weigh in on the offer and - either accept or reject it. The registry may employ out-of-band - notification mechanisms for quicker updates to SSP1 so they can act - faster, though this topic is beyond the scope of this document. - - - - tx_id_12277798 - - 1000 - Request successful - - - -7.10. Enable Peering -- Route Group Offer Accept - - SSP1 responds to the offer from SSP2 and agrees to have visibility to - SSP2 ingress routes. - - - - - - - iana-en:222 - RTE_GRP_SSP2_1 - - iana-en:111 - - - - - Registry confirms that the request has been processed successfully. - From this point forward, if SSP1 looks up a public identity through - the query resolution server, where the public identity is part of the - destination group by way of "RTE_GRP_SSP2_1" route association, SSP2 - ingress SBE information will be shared with SSP1. - - - - tx_id_12333798 - - 1000 - success - - - -7.11. Add Egress Route - - SSP1 wants to prioritize all outbound traffic to routes associated - with "RTE_GRP_SSP2_1" route group through "sbe1.ssp1.example.com". - - - - tx_9000 - - - iana-en:111 - EGR_RTE_01 - 50 - - ^(.*@)(.*)$ - \1\2?route=sbe1.ssp1.example.com - - - iana-en:222 - SSP2_RTE_REC_3 - - - - - - Since peering has already been established, the request to add the - egress route has been successfully completed. - - - - tx_9000 - tx_id_12388898 - - 1000 - Request successful - - - -7.12. Get Destination Group - - SSP2 uses the 'GetDestGrpsRqstType' operation to tally the last - provisioned record for destination group DEST_GRP_SSP2_1. - - - - - - iana-en:222 - DEST_GRP_SSP2_1 - - - - - Registry completes the request successfully and returns a favorable - response. - - - - - 1000 - success - - - iana-en:222 - DEST_GRP_SSP2_1 - - - -7.13. Get Public Identity - - SSP2 obtains the last provisioned record associated with a given TN. - - - - - - iana-en:222 - +12025556666 - - - - - Registry completes the request successfully and returns a favorable - response. - - - - - 1000 - success - - - iana-en:222 - DEST_GRP_1 - +12025556666 - - true - true - 2010-05-30T09:30:10Z - - - - -7.14. Get Route Group Request - - SSP2 obtains the last provisioned record for the route group - RTE_GRP_SSP2_1. - - - - - - iana-en:222 - RTE_GRP_SSP2_1 - - - - - Registry completes the request successfully and returns a favorable - response. - - - - - 1000 - success - - - iana-en:222 - RTE_GRP_SSP2_1 - - - iana-en:222 - RTE_SSP2_SBE2 - - 100 - - - - iana-en:222 - RTE_SSP2_SBE4 - - 101 - - DEST_GRP_SSP2_1 - true - 10 - - - - -7.15. Get Route Group Offers Request - - SSP2 fetches the last provisioned route group offer to the - SSP1. - - - - - iana-en:111 - - - - Registry processes the request successfully and returns a favorable - response. - - - - - 1000 - success - - - iana-en:222 - - - iana-en:222 - RTE_GRP_SSP2_1 - - iana-en:111 - - offered - 2006-05-04T18:13:51.0Z - - - - -7.16. Get Egress Route - - SSP1 wants to verify the last provisioned record for the egress route - called EGR_RTE_01. - - - - - - iana-en:111 - EGR_RTE_01 - - - - - Registry completes the request successfully and returns a favorable - response. - - - - - 1000 - success - - - iana-en:111 - EGR_RTE_01 - 50 - E2U+sip - - ^(.*)$ - sip:\1@sbe1.ssp1.example.com - - - iana-en:222 - RTE_GRP_SSP2_1 - - - - -7.17. Delete Destination Group - - SSP2 initiates a request to delete the destination group - DEST_GRP_SSP2_1. - - - - - - iana-en:222 - DEST_GRP_SSP2_1 - - - - - Registry completes the request successfully and returns a favorable - response. - - - - txid-982543123 - - 1000 - Success - - - -7.18. Delete Public Identity - - SSP2 choses to de-activate the TN and remove it from the registry. - - - - - - iana-en:222 - +12025556666 - - - - - Registry completes the request successfully and returns a favorable - response. - - - - txid-98298273123 - - 1000 - success - - - -7.19. Delete Route Group Request - - SSP2 removes the route group called RTE_GRP_SSP2_1. - - - - - - iana-en:222 - RTE_GRP_SSP2_1 - - - - - Registry completes the request successfully and returns a favorable - response. - - - - txid-982543123 - - 1000 - msg - - - -7.20. Delete Route Group Offers Request - - SSP2 no longer wants to share route group RTE_GRP_SSP2_1 with SSP1. - - - - - - - iana-en:222 - RTE_GRP_SSP2_1 - - iana-en:111 - - - - - Registry completes the request successfully and returns a favorable - response. Restoring this resource sharing will require a new route - group offer from SSP2 to SSP1 followed by a successful route group - accept request from SSP1. - - - - txid-982543123 - - 1000 - Success - - - -7.21. Delete Egress Route - - SSP1 decides to remove the egress route with the label EGR_RTE_01. - - - - - - iana-en:111 - EGR_RTE_01 - - - - - Registry completes the request successfully and returns a favorable - response. - - - - txid-982543123 - - 1000 - Success - - - -8. XML Considerations +7. XML Considerations XML serves as the encoding format for SPPP, allowing complex hierarchical data to be expressed in a text format that can be read, saved, and manipulated with both traditional text tools and tools specific to XML. XML is case sensitive. Unless stated otherwise, XML specifications and examples provided in this document MUST be interpreted in the character case presented to develop a conforming implementation. This section discusses a small number of XML-related considerations pertaining to SPPP. -8.1. Namespaces +7.1. Namespaces All SPPP elements are defined in the namespaces in the IANA Considerations section and in the Formal Protocol Specification section of this document. -8.2. Versioning and Character Encoding +7.2. Versioning and Character Encoding All XML instances SHOULD begin with an 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. @@ -3141,21 +1399,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: -9. Security Considerations +8. 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 @@ -3203,647 +1461,439 @@ 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. -10. IANA Considerations +9. 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 11). + (Section 10). 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 -11. Formal Specification +10. Formal Specification This section provides the draft XML Schema Definition for SPPP. - ------------------ Object Type Definitions -------------- + ---- 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 + objects in SPPP. ---- + + + + + + + ---- Generic type that represents the key for a route + group offer. ---- + + + + + + ---- Object Type Definitions ---- - - - + + - + - + - - - + + + + - - + + - + - + - + - - + + - - - + + + - - - - + + + + - - - + + + - - + + - - + + - + - - + - + - ------------------ Abstract Object and Element - Type Definitions -------------- + + -- Abstract Object and Element Type Defs -- + - - - + + + + - - - - - - - - - - - - - - - - - - - - + + - - - + + + - - - - - - - + - + - - + - - - - - - - - - + + - - - + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - -------------- Operation Request and Response - Object Type Definitions ------------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------- Generic Request and Response Definitions - --------------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + -12. Acknowledgments + +11. 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. -13. References +12. References -13.1. Normative References +12.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. [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 @@ -3858,21 +1908,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. -13.2. Informative References +12.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.