--- 1/draft-ietf-drinks-spprov-01.txt 2010-10-13 00:15:37.000000000 +0200 +++ 2/draft-ietf-drinks-spprov-02.txt 2010-10-13 00:15:37.000000000 +0200 @@ -1,23 +1,23 @@ DRINKS J-F. Mule Internet-Draft CableLabs Intended status: Standards Track K. Cartwright -Expires: January 13, 2011 TNS +Expires: April 15, 2011 TNS S. Ali NeuStar A. Mayrhofer enum.at GmbH - July 12, 2010 + October 12, 2010 Session Peering Provisioning Protocol - draft-ietf-drinks-spprov-01 + draft-ietf-drinks-spprov-02 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 @@ -33,115 +33,132 @@ 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 January 13, 2011. + This Internet-Draft will expire on April 15, 2011. Copyright Notice Copyright (c) 2010 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 Definition . . . . . . . . . . . . . . . . . . . . . 9 - 3.1. Protocol Overview and Layering . . . . . . . . . . . . . . 9 - 3.2. Data Model . . . . . . . . . . . . . . . . . . . . . . . . 10 - 3.2.1. Structure of the SPPP Data Model . . . . . . . . . . . 10 - 3.2.2. Data Model Objects and Attributes . . . . . . . . . . 12 - 3.2.3. Applicability for LUF-only Data Provisioning . . . . . 13 - 3.2.4. Applicability for LUF+LRF data Provisioning . . . . . 15 - 3.3. Common Attributes . . . . . . . . . . . . . . . . . . . . 17 - 3.4. Known Issues and Current Limitations of the Data Model . . 17 - 4. Transport Protocol Requirements . . . . . . . . . . . . . . . 18 - 4.1. Connection Oriented . . . . . . . . . . . . . . . . . . . 19 - 4.2. Request & Response Model . . . . . . . . . . . . . . . . . 19 - 4.3. Connection Lifetime . . . . . . . . . . . . . . . . . . . 19 - 4.4. Authentication . . . . . . . . . . . . . . . . . . . . . . 19 - 4.5. Confidentiality & Integrity . . . . . . . . . . . . . . . 20 - 4.6. Near Real Time . . . . . . . . . . . . . . . . . . . . . . 20 - 4.7. Request & Response Sizes . . . . . . . . . . . . . . . . . 20 - 4.8. Request and Response Correlation . . . . . . . . . . . . . 20 - 4.9. Request Acknowledgement . . . . . . . . . . . . . . . . . 20 - 4.10. Mandatory Transport . . . . . . . . . . . . . . . . . . . 21 - 5. XML Considerations . . . . . . . . . . . . . . . . . . . . . . 22 - 5.1. Namespaces . . . . . . . . . . . . . . . . . . . . . . . . 22 - 5.2. Versioning . . . . . . . . . . . . . . . . . . . . . . . . 22 - 6. Request and Reply Model . . . . . . . . . . . . . . . . . . . 23 - 6.1. Request . . . . . . . . . . . . . . . . . . . . . . . . . 23 - 6.2. Reply . . . . . . . . . . . . . . . . . . . . . . . . . . 25 - 7. Response Codes and Messages . . . . . . . . . . . . . . . . . 27 - 8. Protocol Commands . . . . . . . . . . . . . . . . . . . . . . 29 - 8.1. Add Route Group Operation . . . . . . . . . . . . . . . . 29 - 8.2. Get Route Groups Operation . . . . . . . . . . . . . . . . 36 - 8.3. Add Route Group Offers Operation . . . . . . . . . . . . . 38 - 8.4. Accept Route Group Offers Operation . . . . . . . . . . . 41 - 8.5. Reject Route Group Offers Operation . . . . . . . . . . . 42 - 8.6. Get Route Group Offers Operation . . . . . . . . . . . . . 44 - 8.7. Public Identifier Operations . . . . . . . . . . . . . . . 47 - 8.7.1. Add Public Identifier . . . . . . . . . . . . . . . . 47 - 8.7.2. Get Public Identifier . . . . . . . . . . . . . . . . 50 - 8.7.3. Delete Public Identifier . . . . . . . . . . . . . . . 51 - 8.8. Egress Route Operations . . . . . . . . . . . . . . . . . 52 - 8.8.1. Add Egress Route . . . . . . . . . . . . . . . . . . . 53 - 8.8.2. Get Egress Route . . . . . . . . . . . . . . . . . . . 54 - 8.8.3. Delete Egress Route . . . . . . . . . . . . . . . . . 55 - 9. Security Considerations . . . . . . . . . . . . . . . . . . . 56 - 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 57 - 11. Formal Specification . . . . . . . . . . . . . . . . . . . . . 58 - 12. Specification Extensibility . . . . . . . . . . . . . . . . . 71 - 13. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 72 - 14. References . . . . . . . . . . . . . . . . . . . . . . . . . . 73 - 14.1. Normative References . . . . . . . . . . . . . . . . . . . 73 - 14.2. Informative References . . . . . . . . . . . . . . . . . . 73 - Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 75 + 3. Protocol High Level Design . . . . . . . . . . . . . . . . . . 9 + 3.1. Protocol Layering . . . . . . . . . . . . . . . . . . . . 9 + 3.2. Protocol Data Model . . . . . . . . . . . . . . . . . . . 10 + 4. Transport Protocol Requirements . . . . . . . . . . . . . . . 14 + 4.1. Connection Oriented . . . . . . . . . . . . . . . . . . . 15 + 4.2. Request and Response Model . . . . . . . . . . . . . . . . 15 + 4.3. Connection Lifetime . . . . . . . . . . . . . . . . . . . 15 + 4.4. Authentication . . . . . . . . . . . . . . . . . . . . . . 15 + 4.5. Confidentiality and Integrity . . . . . . . . . . . . . . 16 + 4.6. Near Real Time . . . . . . . . . . . . . . . . . . . . . . 16 + 4.7. Request and Response Sizes . . . . . . . . . . . . . . . . 16 + 4.8. Request and Response Correlation . . . . . . . . . . . . . 16 + 4.9. Request Acknowledgement . . . . . . . . . . . . . . . . . 16 + 4.10. Mandatory Transport . . . . . . . . . . . . . . . . . . . 17 + 5. Base Protocol Data Structures . . . . . . . . . . . . . . . . 18 + 5.1. Request and Response Structures . . . . . . . . . . . . . 18 + 5.1.1. Update Request and Response Structures . . . . . . . . 18 + 5.1.2. Query Request and Response Structures . . . . . . . . 21 + 5.2. Response Codes and Messages . . . . . . . . . . . . . . . 23 + 5.3. Basic Object Type and Organization Identifiers . . . . . . 25 + 6. Protocol Commands . . . . . . . . . . . . . . . . . . . . . . 27 + 6.1. Add Route Group Operation . . . . . . . . . . . . . . . . 27 + 6.2. Get Route Groups Operation . . . . . . . . . . . . . . . . 31 + 6.3. Add Destination Group Operation . . . . . . . . . . . . . 32 + 6.4. Get Destination Groups Operation . . . . . . . . . . . . . 33 + 6.5. Add Route Group Offer Operation . . . . . . . . . . . . . 34 + 6.6. Accept Route Group Offer Operation . . . . . . . . . . . . 36 + 6.7. Reject Route Group Offer Operation . . . . . . . . . . . . 37 + 6.8. Get Route Group Offers Operation . . . . . . . . . . . . . 38 + 6.9. Public Identifier Operations . . . . . . . . . . . . . . . 40 + 6.10. Egress Route Operations . . . . . . . . . . . . . . . . . 44 + 6.11. Add Route Record Operation . . . . . . . . . . . . . . . . 46 + 6.12. Get Route Records Operation . . . . . . . . . . . . . . . 51 + 6.13. Delete Operation . . . . . . . . . . . . . . . . . . . . . 52 + 7. SPPP Examples . . . . . . . . . . . . . . . . . . . . . . . . 53 + 7.1. Add Destination Group . . . . . . . . . . . . . . . . . . 53 + 7.2. Add Route Records . . . . . . . . . . . . . . . . . . . . 54 + 7.3. Add Route Records -- URIType . . . . . . . . . . . . . . . 55 + 7.4. Add Route Group . . . . . . . . . . . . . . . . . . . . . 56 + 7.5. Add Public Identity -- Successful COR claim . . . . . . . 58 + 7.6. Add LRN . . . . . . . . . . . . . . . . . . . . . . . . . 59 + 7.7. Add TN Range . . . . . . . . . . . . . . . . . . . . . . . 60 + 7.8. Add TN Range with Open Number Plan support . . . . . . . . 61 + 7.9. Enable Peering -- Route Group Offer . . . . . . . . . . . 62 + 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 . . . . . . . . . . . . . . 69 + 7.16. Get Egree Route . . . . . . . . . . . . . . . . . . . . . 70 + 7.17. Delete Destination Group . . . . . . . . . . . . . . . . . 72 + 7.18. Delete Public Identity . . . . . . . . . . . . . . . . . . 72 + 7.19. Delete Route Group Request . . . . . . . . . . . . . . . . 73 + 7.20. Delete Route Group Offers Request . . . . . . . . . . . . 74 + 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 . . . . . . . . . . . . . . . . . . . . . 79 + 11. Formal Specification . . . . . . . . . . . . . . . . . . . . . 80 + 12. Specification Extensibility . . . . . . . . . . . . . . . . . 93 + 13. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 94 + 14. References . . . . . . . . . . . . . . . . . . . . . . . . . . 95 + 14.1. Normative References . . . . . . . . . . . . . . . . . . . 95 + 14.2. Informative References . . . . . . . . . . . . . . . . . . 95 + Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 97 1. Introduction Service providers and enterprises use registries to make call or 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 been documented in [I-D.ietf-drinks-usecases-requirements]. The reader is expected to be familiar with the terminology defined in the previously mentioned document. Three types of provisioning flows have been described in the use case document: client to registry provisioning, registry to local data repository and registry-to-registry. This document addresses a subset (client-to-registry provisioning) by defining a Session Peering Provisioning Protocol (SPPP) for provisioning Session - Establishment Data (SED) into a Registry (arrow numbered one in the - figure below). While the other "provisioning flows" are shown below - as separate message flows, no determination has been made for whether + Establishment Data (SED) into a Registry (arrow "1" in the figure + below). While the other "provisioning flows" are shown below as + separate message flows, no determination has been made for whether one common baseline protocol could be used for all three, or whether distinct protocols are required. *------------* *------------* (1). Provisioning SED | | (3).Registry | | -----------------------> | Registry |<------------->| Registry | data into Registries| | to Registry | | *------------* exchanges *------------* / \ \ / \ \ @@ -175,54 +192,63 @@ Subsequently, a Registry may distribute the provisioned data into local Data Repositories used for look-up queries (identifier -> URI) or for lookup and location resolution (identifier -> URI -> ingress SBE of terminating SSP). In some cases, the Registry may additionally offer a central query resolution service (not shown in the above figure). A key requirement for the SPPP protocol is to be able to accommodate two basic deployment scenarios: - 1. A Look-Up Function (LUF) to determine 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. + 1. A Local Data Repository serves a Look-Up Function (LUF) to + determine 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. Both Look-Up function (LUF) and Location Routing Function (LRF) - to locate the SED data fully. + 2. A Local Data Repository serves both a Look-Up function (LUF) and + Location Routing Function (LRF) to locate the SED data fully. In terms of protocol design, SPPP protocol 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. 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 protocol, including the layering approach, functional entities and data model; - o Section 4 defines requirements for SPPP transport protocols; + o Section 4 specifies requirements for SPPP transport protocols; - o Section 5 defines XML considerations that XML parsers must meet - to conform to this specification. + 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 6 describes the protocol request-reply model; + o Section 6 and Section 7 describe the main protocol commands and + examples; - o Section 8 defines the protocol commands for this version of - SPPP, and how to extend them; + o Section 8 defines XML considerations that XML parsers must meet + to conform to this specification; + + 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] and the ENUM Validation Architecture [RFC4725]. @@ -246,58 +272,63 @@ A Registry acts as an SPPP Server. Registrant: In this document, we extend the definition of a Registrant based on [RFC4725]. The Registrant is the end-user, the person or organization who is the "holder" of the Session Establishment Data being provisioned into the Registry. For example, in [I-D.ietf-drinks-usecases-requirements], a Registrant is pictured as a SIP Service Provider in Figure 2. - A Registrant is identified by its name in the data model. + A Registrant is identified by its name and an identifier in the + data model. Registrar: In this document, we also extend the definition of a Registrar from [RFC4725]. A Registrar performs provisioning operations on behalf of a Registrant by interacting with the Registry, in our case via the SPPP protocol defined in this document. - A Registrar is identified by its name in the data model. + A Registrar is identified by its name and an identifier in the + data model. -3. Protocol Definition +3. Protocol High Level Design This section introduces the structure of the data model and provides the information framework for the SPPP protocol. 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 Overview and Layering +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 | | addRteGrpsRqst, etc. | + (4) | Operations | | AddRteGrpRqstType, etc. | +-------------+ +-----------------------------+ | | +-------------+ +-----------------------------+ - (3) | Message | | spppRequest, spppResponse | + (3) | Message | | spppUpdateRequest, | + | | | spppUpdateResponse, | + | | | spppQueryRequest, | + | | | spppQueryResponse | +-------------+ +-----------------------------+ | | +-------------+ +-----------------------------+ (2) | Message | | HTTP, SOAP, None, etc. | | Envelope | | | +-------------+ +-----------------------------+ | | +-------------+ +-----------------------------+ (1) | Transport | | TCP, TLS, BEEP, etc. | | Protocol | | | @@ -321,336 +352,171 @@ 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 using an SPPP message. Operations are encoded using - XML encoded actions and objects. + 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. Data Model +3.2. Protocol Data Model The data model illustrated and described in Figure 3 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 Registrants and distinct - Registrars may use the protocol for populating the Registry's data. - -3.2.1. Structure of the SPPP Data Model + 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]. Note that the current - version of this data model does not yet address the notion of Data - Recipient Groups (left for a future revision of this document). + [I-D.ietf-drinks-usecases-requirements]. +-------------+ +------------------+ | all object | |Organization: | | types | |orgId, | +------+------+ |orgName, | - +------------>| | - |extension | + +------------>|extension | + | | + All objects are | | associated with 2 | | Organizations to +------------------+ identify the ^ registrant and |A Route Group is the registrar |associated with - |zero or more + |zero or more Peering |Organizations | +--------+--------------+ |Route Group: | +-----[abstract]-+ - | rantId*, | | | + | rantId, | | Route Record: | | rarId, | | | - | rteGrpName*, | | Route Record: | - | dgName*, +------->| priority, | + | rteGrpName, | | rrName, | + | destGrpRef, +------->| priority, | | isInSvc, | | extension | - | rteRec*, | | | + | rteRecRef, | | | | peeringOrg, | +----------------+ | sourceIdent, | ^ + | priority, | | | extension | |Various types +-----------------------+ |of Route ^ |Records... | +------+------------... | | | | | +----+ +-------+ +----+ | | URI| | NAPTR | | NS | +----------------+-----+ +----+ +-------+ +----+ |Destination | |Group: | +----------[abstract]-+ - | rantId*, | |Public | - | rarId, | |Identifier: | - | dgName*, | | rantId*, | + | rantId, | |Public Identifier: | + | rarId, | | | + | dgName, | | rantId, | | extension |<----+ rarId, | - +----------------------+ | publicIdentifier*, | - | dgName*, | + +----------------------+ | publicIdentifier, | + | destGrpRef, | + | rteRec, | | extension | +---------------------+ ^ |Various types |of Public |Identifiers... +------+------------... | | | +-----+ +----+ +-----+ - |Email| | TN | | TNR | + | TN | |TNR | | RN | +-----+ +----+ +-----+ ... SPPP Data Model Figure 3 - Note that the attributes whose names end with the character * are - mandatory attributes. - -3.2.2. Data Model Objects and Attributes - The objects and attributes that comprise the data model can be described as follows (objects listed from the bottom up): - o Public Identifier (publicIdentifier): - A public identifier is a well known attribute that is often used - to perform lookup functions. For the purposes of this document, a - Public Identifier can be an email address, a telephone number, a - range of telephone numbers or a PSTN Routing Number (RN). + o Public Identifier: + A public identifier is a well known attribute that is used as the + key to perform lookup functions. For the purposes of this + document, a Public Identifier can be a telephone number, a range + of telephone numbers, a PSTN Routing Number (RN), or perhaps + another type of lookup key. - A Destination Group may be associated with a Public Identifier to - create a logical grouping and share a common set of Routes. + A Public Identifier may be associated with a Destination Group to + create a logical grouping of Public Identifiers that share a + common set of Routes. A Public Identifier may optionally be associated with zero or more - individual route records. This ability for a Public Identifier to - be directly associated with a set of routes (e.g. target URI), as - opposed to being associated with a Destination Group, supports the - use cases where the target URI contains data specifically tailored - to an individual Public Identifier. + individual Route Records. This ability for a Public Identifier to + be directly associated with a set of Route Records (e.g. target + URI), as opposed to being associated with a Destination Group, + supports the use cases where the target URI contains data + specifically tailored to an individual Public Identifier. - o Telephone Number Range (TNRType, tn, endTn): + o Telephone Number Range: A public identifier may represent an inclusive range of telephone numbers. The TN range is defined by the first and last telephone - number of the inclusive range. For example, a TN range of - (tn=12125550000, endTn=12125560000) means all the TNs from - 12125550000 to 12125560000 are included. - - o Destination Group (dgName): - A collection of zero or more Public Identifiers that are related - to one or more Route Group relationships. + number of the inclusive range. For example, a TN range defined by + tn=12125550000 and endTn=12125560000 means all the TNs from + 12125550000 to 12125560000 inclusive are included. - o Route Group (rteGrpName): - A Route Group contains a set of route records (RteRecs) that are - associated with Public Identifiers. To support the use cases - defined in [I-D.ietf-drinks-usecases-requirements], this document - defines the following types of RteRecs: NAPTRType, NSType, and - URIType. To support the Look-Up Function resolution, it is - assumed that the administrative domain will be defined as a URI - and it can be expressed as a URIType or a NAPTRType. - A Route Group can be either in or out of service (as indicated by - 'isInService' attribute). It also contains a list of - organizations that can query the object (peeringOrg) and have - access to its content (sourceIdent). + o Destination Group: + A name collection of zero or more Public Identifiers that can be + associated with one or more Route Groups for the purpose of + facilitating the management of thier common routing information. - o Source Identity (SourceIdentType, sourceIdentLabels, - sourceIdentScheme): - In some scenarios, it is important to identify the source of a - query. The source identity label is a character string that - identifies the source of a resolution lookup and can be used for - source-based routing. We define several ways of identifying the - source: by IP address, by the source URI or a domain name. + o Route Group: + A Route Group contains a set of references to Route Records, a set + of Destination Group references, and a set of peering organization + identifiers. This is used to establishe a three part + relationships between a set of Public Identifiers and their common + routing information (SED), and the list of peering organizations + whose query responses may include that routing information in + their query responses. To support the use cases defined in + [I-D.ietf-drinks-usecases-requirements], this document defines the + following types of Route Records: NAPTRType, NSType, and URIType. + The sourceIdent element within a Route Group, in concert with the + set of peering organization identifiers enables fine grained + source based routing. Further details about the Route Group and + source based routing refer to the definitions and descriptions of + the Route Group operations found later in this document. - o Route Record (RteRecType): - A Route Record is the data that the resolution systems return in - response to a successful query with the Public Identifier as the - query string. It is associated with a Route Group for routes that - are not specific to a Public Identifier. + o Route Record: + A Route Record contains the data that a resolution system returns + in response to a successful query for a Public Identifier. Route + Recoords are associated with a Route Group for SED that is not + specific to a Public Identifier. To support the use cases defined in [I-D.ietf-drinks-usecases-requirements], SPPP protocol 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 (OrgIdType): - An Organization represents an entity that is authorized to access - given data elements. All objects are associated with two - organizations to identify the registrant and the registrar. An - entity authorized to view a Route Group (typically a SSP peering - partner) is identified a peering Organization (peeringOrg). - -3.2.3. Applicability for LUF-only Data Provisioning - - This section describes the data model for SPPP clients that only - provision data for LUF resolution. - - The purpose of LUF data provisioning is to provide the administrative - domain given a destination group. As such, a client provisioning - LUF-only data only needs to provide one or more route groups that - contain a route group name and a URI for the target domain. - - Note that source-based routing is supported: depending on what entity - requests the look-up resolution (sourceIdent), a different URI may be - returned by using different Route Groups. - - Certain protocol operations could be added in future revisions of - this document as "short-cuts" for LUF related data provisioning. - - +-----------------------+ - |Route Group: | - | rteGrpName*, | - | isInService, | - | URI , | - | extension | - | | - +-----------------------+ - ^ - | - +---------+------------+ - |Destination | - |Group: | - | dgName*, |<----+ - | extension | | - +----------------------+ | - | - +-------------+---------+ - |Public | - |Identifier: | - | publicIdentifier*, | - | dgName*, | - | extension | - +-----------------------+ - - LUF-only Data Model Example for SPPP - - Figure 4 - - As an example, a request to add a route group where public - identifiers resolve into the URI sip:ssp1.example.com during look-up - resolution would be: - - - - id-12317123 - 20 - - - registrantID123 - registrarId0 - - route_grp_1 - - ^(.*)$ - urn:ssp1.example.com - - true - - - - Figure 5 - -3.2.4. Applicability for LUF+LRF data Provisioning - - This section provides a read-out of the data model for SPPP clients - that provision data for both LUF and LRF resolution. - - The purpose of LUF+LRF data provisioning is to provide a URI given a - destination group as well as the location routing for that target - domain. As such, a client provisioning LUF+LRF data provides one or - more route groups that contain a route group name and a URI for the - target domain and each route group is associated with a Route Record - which can be in the form of a URI, NAPTR or NS resource record. - - +-----------------------+ - |Route Group: | +-----[abstract]-+ - | rteGrpName*, | | | - | isInSvc, | | Route Record: | - | rteRec, +------->| NAPTR | - | extension | | priority, | - | | | extension | - +-----------------------+ | | - ^ +----------------+ - | - +---------+------------+ - |Destination | - |Group: | - | dgName*, |<----+ - | extension | | - +----------------------+ | - | - +-------------+-[abstract]-+ - |Public | - |Identifier: | - | publicIdentifier*, | - | dgName*, | - | extension | - +--------------------------+ - - LUF+LRF Data Model Example for SPPP - - Figure 6 - - As an example, a request to add a route group where public - identifiers resolve into the URI ssp1.example.com and NAPTR - associated with that domain based on the source Organization would - be: - - - - id-12317123 - 20 - - - registrantID123 - registrarId0 - - route_grp_1 - true - - ^(.*)$ - urn:ssp1.example.com - - true - - - - Figure 7 - -3.3. Common Attributes - - This section defines common object attributes. The protocol - exchanges and operations in SPPP take various parameters. Some of - these are common to several objects. - - Two organization roles have been identified in the use cases and in - this protocol. A registrant is the organization or business entity - that "owns" the object while a registrar is an entity that can - provision an object. - -3.4. Known Issues and Current Limitations of the Data Model - - The data model described in Figure 3 does not yet address all of the - requirements and use cases defined in - [I-D.ietf-drinks-usecases-requirements]. - - This section will list known protocol issues to be addressed in - future revisions. + o Organization: + 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 the registrar. A Route + Group object is also associated with a set of zero or more + organization identifiers that identify the peering organizations + whose query responses may include the routing information (SED) + defined in the Route Records within that Route Group. 4. Transport Protocol Requirements This section provides requirements for transport protocols suitable for SPPP. More specifically, this section specifies the services, features, and assumptions that SPPP delegates to the chosen transport and envelope technologies. Two different groups of use cases are specified in [I-D.ietf-drinks-usecases-requirements]. One group of use cases @@ -696,21 +562,21 @@ transactions over such point-to-point connection. A transport protocol for SPPP MUST therefore be connection oriented. Note that the role of the "Client" and the "Server" only applies to the connection, and those roles are not related in any way to the type of entity that participates in a protocol exchange. For example, a Registry might also include a "Client" when such a Registry initiates a connection (for example, for data distribution to SSP). -4.2. Request & Response Model +4.2. Request and Response Model Provisioning operations in SPPP follow the request - response model, where a transaction is initiated by a Client using a Request command, and the Server responds to the Client by means of a Response. Multiple subsequent request-response exchanges MAY be performed over a single connection. Therefore, a transport protocol for SPPP MUST follow the request- response model by allowing a response to be sent to the request @@ -738,38 +604,38 @@ Client by the Server is expected to be used to identify and further authorize the Client to certain resources on the Server. Therefore, an SPPP transport protocol MUST provide means for a Server to authenticate and authorize a Client, and MAY provide means for Clients to authenticate a Server. However, SPPP transport SHOULD also allow for unauthenticated connections. -4.5. Confidentiality & Integrity +4.5. Confidentiality and Integrity Data that is transported over the protocol is deemed confidential. Therefore, a transport protocol suitable for SPPP MUST ensure confidentiality and integrity protection by providing encryption capabilities. Additionally, a DRINKS protocol MUST NOT use an unreliable lower- layer transport protocol that does not provide confidentiality and integrity protection. 4.6. Near Real Time Many use cases require near real-time responses from the Server. Therefore, a DRINKS transport protocol MUST support near-real-time response to requests submitted by the Client. -4.7. Request & Response Sizes +4.7. Request and Response Sizes SPPP covers a range of use cases - from cases where provisioning a single public identifier will create very small request and response sizes to cases where millions of data records are submitted or retrieved in one transaction. Therefore, a transport protocol suitable for SPPP MUST support a great variety of request and response sizes. A transport protocol MAY allow splitting large chunks of data into several smaller chunks. @@ -793,568 +659,565 @@ succeeded or failed. 4.10. Mandatory Transport As of this writing of this revision, one transport protocol proposal has been provided in [I-D.ietf-drinks-sppp-over-soap]. This section will define a mandatory transport protocol to be compliant with this RFC. -5. 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. +5. Base Protocol Data Structures - This section discusses a small number of XML-related considerations - pertaining to SPPP. + 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. Namespaces +5.1. Request and Response Structures - All SPPP protocol elements are defined in the following namespace: - urn:ietf:params:xml:ns:sppp:base:1 + 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. - Namespace and schema definitions are used to identify both the base - protocol schema and the schemas for managed objects. +5.1.1. Update Request and Response Structures -5.2. Versioning + 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. - 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. +5.1.1.1. Update Request - 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. + An SPPP update request object is contained within the generic + element. - Character encodings other than UTF-8 and UTF-16 are allowed by XML. - 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: + + + + + + - version="1.0" encoding="UTF-8" standalone="no"?> + The data elements within the element are + described as follows: -6. Request and Reply Model + 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. This + value is also echoed back to the client in the SPPP update + response. An SPPP server will not check this value for + uniqueness. - 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. An SPPP - request is wrapped within the element while an SPPP - reply is wrapped within an element. Furthermore, fully - formed SPPP requests and replies are comprised of constructs required - by the chosen transport technology, and the chosen envelope - technology. The supported transport technology and envelope - technology specifications will be defined in separate documents, and - are not discussed here. + 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. -6.1. Request + o rqst: One or more BasicRqstType 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 BasicRqstType object instances in + the request at the first error and roll back any BasicRqstType + object instances that had already been processed for that update + request. In the "stop and commit" scenario the SPPP server + would stop processing BasicRqstType object instances in the + request at the first error but commit any BasicRqstType object + instances that had already been processed for that update + request. - An SPPP request object, common to any transport and envelope - technology, is contained within the generic element. + All update request objects extend the base type BasicRqstType. This + base type is defined as follows: - - + - + - - Within any element is the request object specific to - the type of object(s) being operated on and the action(s) being - performed on that object. For example, the addRteGroupRqst object, - used to create Route Groups, that would be passed within an - is defined as follows: + The BasicRqstType 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. + + - - + + + + - All update requests contain a BasicRqstType object. This object is - defined as follows: + + + + + + - + + + - - - + + + + - - - + An contains the elements necessary for the SPPP + client to precisely determine the overal 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: - The data elements within the BasicRqstType object are primarily - "house keeping" data elements. They 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. - o clientTransId: The client generated transaction ID that - identifies this request for tracking purposes. This value is - also echoed back to the client in the response. This value will - not be checked for uniqueness. + o serverTransId: Exactly one server transaction ID that identifies + this request for tracking purposes. This value is guaranteed to + be unique for a given SPPP server. - o minorVer: This identifies 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. Refer - to the Versioning section of this document for more detail. + 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 condition occurs, and indicates exactly + which error condition occurred and exactly which request object + that was passed in caused the error condition. The contained + BasicRqstObject is simply an echo of the request object instance + that caused the error, while the response code and message + indicate the error condition for this object. See the Response + Code section for further details. o ext: This is the standard extension element for this object. - Refer to the Extensibility section of this document for more - details. + Refer to the Extensibility section for more details. -6.2. Reply +5.1.2. Query Request and Response Structures - An SPPP reply object, common to any transport and envelope - technology, is contained within the generic element. + 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. + + - + + - Within any element is the reply object containing the - result of the request. All create, update, and delete operations - result in a common response object structure, defined as follows: + 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. + + + - - - - - + + + - The data elements within the BasicRspnseType object are described as - follows: - - o clientTransId: The echoed back client transaction ID that - explicitly identifies this request for tracking purposes. This - value is not guaranteed to be unique. - - o serverTransId: The server transaction ID that identifies this - request for tracking purposes. This value is guaranteed to be - unique. + An contains the elements necessary for the SPPP + client to precisely determine the overal result of the query, and if + an error occurred, exactly what condition caused the error. - o resCode: The response code that explicitly identifies the result - of the request. See the Response Code section for further - details. + The data elements within the SPPP query response are described as + follows: - o resMsg: The human readable response message that accompanies the - response code. See the Response Code section for further - details. + 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 ext: This is the standard extension element for this object. - Refer to the Extensibility section for more 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). -7. Response Codes and Messages +5.2. Response Codes and Messages - This section contains an initial listing of response codes and their - corresponding human readable text. + 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 [RFC2821]: 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. - +--------+----------------------------------------------------------+ - | Result | Text | - | Code | | - +--------+----------------------------------------------------------+ - | 1000 | Request Succeeded. | - | | | - | 2001 | Request syntax invalid. | - | | | - | 2002 | Request too large. | - | | | - | 2003 | Version not supported. | - | | | - | 2103 | Command invalid. | - | | | - | 2104 | Attribute value invalid: [ObjecTypeName]:[Object's | - | | rantId]:[Object's name]:{[Embedded | - | | ObjecTypeName]}:[attribute name]:[attribute value]. | - | | | - | 2105 | Object does not exist: [ObjecTypeName]:[Object's | - | | rantId]:[Object's name]. | - | | | - | 2106 | Object status or ownership does not allow for operation: | - | | [OperationName]:[ObjecTypeName]:[Object's | - | | rantId]:[Object's name]. | - | | | - | 2301 | System temporarily unavailable. | - | | | - | 2302 | Unexpected internal system or server error. | - +--------+----------------------------------------------------------+ + 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 | Text | 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 - Some response messages are "parameterized" with one or more of the - following parameters: "attribute name", "attribute value", - "objectType-objectId", and "operation name". + 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. Parameters within a response message MUST NOT be - left empty. + be present. - o Any value provided for the "attribute name" parameter MUST be an - exact element name of the protocol data element that the + 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 "destGrpName", "rteGrpName", etc. - - o A value provided for the "command/request type" parameter MUST - be an exact request object name that the response message is - referring to. For example, a valid value for "request object - name" is "delRteGrpsRqst". + "attribute name" are "dgName", "rteGrpName", "rteRec", etc. - o The value for "attribute value" MUST be the value of the data - element to which the preceding "attribute name" refers. + 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 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. + 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. -8. Protocol Commands +5.3. Basic Object Type and Organization Identifiers - This section provides a preliminary list of SPPP protocol commands. - At this early stage of the protocol development, the commands are - only listed with a brief description. + This section introduces the basic object type that most first class + objects derive from. -8.1. Add Route Group Operation + All first class objects extend the basic object type BasicObjType + which contains the identifier of the registrant organization that + owns this object, the identifier of the registrar organization that + provisioned 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 (rantId), registrars (rarId) 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 + + This section provides a description of each supported protocol + command. + +6.1. Add Route Group Operation 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 identities to 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, rather than millions - of data updates to individual public identity records that - individually contain their peering point data. + 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 addRteGrpsRqst operation creates or overwrites one or more Route - Group objects. If a Route Group with the given name and registrant - ID does not exist, then the server MUST create the Route Group. If a - Route Group with the given name and registrant does exist, then the - server MUST replace the current properties of the Route Group with - the properties passed into the addRteGrpsRqst operation. The XSD - declarations of the operation request object are as follows: + 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 spppRequest element for this operation is - the addRteGrpsRqst element. This element is of type - AddRteGrpsRqstType, which extends BasicRqstType and contains one or - more RteGrpType objects. Any limitation on the maximum number of - RteGrpType objects that may be passed into this operation is a policy - decision and is not limited by the protocol. The RteGrpType object - structure is defined as follows: + The element passed into the spppUpdateRequest element for this + operation is an instance of AddRteGrpRqstType, which extends + BasicRqstType and contains one RteGrpType object. The RteGrpType + object structure is defined as follows: + + - - - + - + + + + + + + + + + + + The RteGrpType object is composed of the following elements: - o base: As described in previous sections, most objects contain - exactly one instance of BasicObjType which contains the ID of - the registrant organization that owns this object and the ID of - the registrar organization that provisioned this object. + o base: All first class objects extend BasicObjType which contains + the ID of the registrant organization that owns this object, the + ID of the registrar organization that provisioned 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. o rteGrpName: The character string that contains the name of the Route Group. It uniquely identifies this object within the context of the registrant ID (a child element of the base element as described above). - o rteRec: Set of zero or more objects of type RteRecType that - house the routing information, sometimes referred to as SED, - that the RteGrpType object contains. + o rteRecRef: Set of zero or more objects of type RteRecRefType + that house the unique keys of the Route Records that the the + RteGrpType object refers to and their relative priority within + the context of a given route group. The associated Route + Records contain the routing information, sometimes called SED, + associated with this Roue Group. o dgName: Set of zero or more names of DestGrpType object instances. Each dgName name, in association with this Route Group's registrant ID, uniquely identifies a DestGrpType object - instance whose public identities are reachable using the routing - information housed in this Route Group. + instance whose public identifiers are reachable using the + routing information housed in this Route Group. An intended + side affect of this is that a Route Group cannot provide routing + information for a Destination Group belonging to another + registrant. o peeringOrg: Set of zero or more peering organization IDs that have accepted an offer to receive this Route Group's information. The set of peering organizations in this list is not directly settable or modifiable using the addRteGrpsRqst operation. This set is instead controlled using the route offer and accept operations. o sourceIdent: Set of zero or more SourceIdentType object instances. These objects, described further below, house the source identification schemes and identifiers that are applied at resolution time as part of source based routing algorithms for the Route Group. o isInSvc: A boolean element that defines whether this Route Group is in service. The routing information contained in a Route Group that is in service is a candidate for inclusion in resolution responses for public identities residing in the Destination Group associated with this Route Group. The routing information contained in a Route Group that is not in service is - not a candidate for inclusion is resolution responses. - - o ext: Point of extensibility described in a previous section of - this document. - - As described above, the Route Group contains a set of route record - objects. A route record object is based on an abstract type: - RteRecType. The concrete types that use RteRecType as an extension - base are NAPTRType, NSType, and URIType. The definitions of these - types are included below. The NAPTRType object is comprised of the - data elements necessary for a NAPTR that contains routing information - the Route Group. The NSType object is comprised of the data elements - necessary for a Name Server that points to another DNS server that - contains the desired routing information. The URIType object is - comprised of the data elements necessary to house a URI. - - The data provisioned in a Registry can be leveraged for many purposes - and queried using various protocols including SIP, ENUM and others. - It is for this reason that a route record type offers a choice of - URI, and DNS resource record types. The URIType is commonly used to - provision data related to the SIP route in registries. The use of - DNS resource record types is also relevant to the scenario where the - data provisioned in the registry is used to answer ENUM queries but - the provisioning protocol should be agnostic to a particular - resolution protocol. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 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 pref: Preference value in an ENUM NAPTR. - - o svcs: ENUM service(s) that are served by the SBE. This field's - value must be of the form specified in RFC 3761 (e.g., E2U+ - pstn:sip+sip). The allowable values are a matter of policy and - not limited by this protocol. - - o regx: NAPTR's regular expression field. If this is not included - then the Repl field must be included. - - o repl: NAPTR replacement field, should only be provided if the - Regex field is not provided, otherwise it will be ignored by the - server. - - o ttl: Number of seconds that an addressing server may cache this - NAPTR. - - o ext: Point of extensibility described in a previous section of - this document. - - The NSType object is composed of the following elements: - - o hostName: Fully qualified host name of the name server. - - o ipAddr: Zero or more objects of type IpAddrType. Each object - holds an IP Address and the IP Address type, IPv4 or IP v6. + not a candidate for inclusion in resolution responses. - o ttl: Number of seconds that an addressing server may cache this - Name Server. + o priority: Zero or one priority value that can be used to provide + a relative value weighting of one Route Group over another. The + manner in which this value is used, perhaps in conjunction with + other factors, is a matter of policy. o ext: Point of extensibility described in a previous section of this document. - 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] + As described above, the Route Group contains a set of references to + route record objects. A route record object is based on an abstract + type: RteRecType. The concrete types that use RteRecType as an + extension base are NAPTRType, NSType, and URIType. The definitions + of these types are included the Route Record section of this + document. The RteGrpType object provides support for source-based routing via - the source identity element. The source-based routing criteria - provides the ability to specify zero or more of the following in - association with a given Route Group: a regular expression that is - matched against the resolution client IP address, a regular - expression that is matched against the root domain name(s), and/or a - regular expression that is matched against the calling party URI(s). - The result will be that, after identifying the visible Route Groups - whose associated Destination Group(s) contain the lookup key being - queried, the resolution server will evaluate the characteristics of - the Source URI, and Source IP address, and root domain of the lookup - key being queried. The resolution server compares these criteria - against source based routing 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 peeringOrg data element and more granular source base routing via + the source identity element. The source identity element provides + the ability to specify zero or more of the following in association + with a given Route Group: a regular expression that is matched + against the resolution client IP address, a regular expression that + is matched against the root domain name(s), and/or a regular + expression that is matched against the calling party URI(s). The + result will be that, after identifying the visible Route Groups whose + associated Destination Group(s) contain the lookup key being queried + and whose peeringOrg list contains the querying organizations + organization ID, the resolution server will evaluate the + characteristics of the Source URI, and Source IP address, and root + domain of the lookup key being queried. The resolution server then + 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: - + - + @@ -1366,176 +1229,216 @@ 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. - The result of the addRteGrpsRqst operation is the addRteGrpsRspns - element defined below. As with all SPPP requests, the result is all- - or-nothing. If more than one RteRecType is passed into this request, - then they will either all succeed or all fail. In the case of - failure, the failure response code(s) and message(s) will indicate - the reason for the failure and the object(s) that caused the failure. - - - - The response codes that the addRteGrpsRqst operation can return are - as follows: - - o 1000: Request Succeeded. - - o 2001: Request syntax invalid. - - o 2002: Request too large. - - o 2003: Version not supported. - - o 2103: Command invalid. - - o 2104: Attribute value invalid. - - o 2105: Object does not exist. - - o 2106: Object status or ownership does not allow for request. - - o 2301: System temporarily unavailable. - - o 2302: Unexpected internal system or server error. + 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. -8.2. Get Route Groups Operation +6.2. Get Route Groups Operation The getRteGrpsRqst operation allows a client to get the properties of Route Group objects that a registrar organization is authorized to view. 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 the set of ObjKeyType objects is empty then the server will return the list of Route Group objects that the querying client has the authority to view. If there are no matching Route Groups found then an empty result set will be returned. - The element passed into the spppRequest element for this operation is - the getRteGrpsRqst element. This element is of type - GetRteGrpsRqstType, which extends BasicRqstType 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: - - + The element passed into the spppQueryRequest element for this + operation is an instance of type GetRteGrpsRqstType, which extends + BasicRqstType 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: - + - - The result of the getRteGrpsRqst operation returned in the - spppResponse element is the getRteGrpsRspns element defined below. - This object contains the resulting set of RteGrpType objects, or an - empty set if there were no matches. + 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 Destination Group Operation - + As described in the introductory sections, a Destination Group + represents a set of Public Identifiers with common routing + information. + + 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: + + - + - + - The response codes that the getRteGrpsRqst operation can return are - as follows: + The element passed into the spppUpdateRequest element for this + operation is an element of type AddDestGrpRqsttype, which extends + BasicRqstType and contains a DestGrpType object. The DestGrpType + object structure is defined as follows: - o 1000: Request Succeeded. + + + + + + + + + - o 2001: Request syntax invalid. + The DestGrpType object is composed of the following elements: - o 2002: Request too large. + o base: All first class objects extend BasicObjType which contains + the ID of the registrant organization that owns this object, the + ID of the registrar organization that provisioned 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. - o 2003: Version not supported. + 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 2103: Command invalid. + o ext: Point of extensibility described in a previous section of + this document. - o 2104: Attribute value invalid. + 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. - o 2301: System temporarily unavailable. +6.4. Get Destination Groups Operation - o 2302: Unexpected internal system or server error. + The getDestGrpsRqst operation allows a client to get the properties + of Destination Group objects that a registrar organization is + authorized to view. 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 the set of ObjKeyType objects passed in is empty then + the server will return the list of Destination Group objects that the + querying registrar has the authority to view. -8.3. Add Route Group Offers Operation + 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.5. Add Route Group Offer Operation 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 or peering organization. The registrant - offers access to a Route Group by submitting a Route Group Offer and - 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 addRteGrpOffersRqst operation - creates or overwrites one or more Route Group Offer objects. If a - Route Group Offer for the given Route key (route name and registrant - ID) and offeredToOrg 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: - - + 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 offeredToOrg 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 spppRequest element for this operation is - the addRteGrpOffersRqst element. This element is of type - AddRteGrpOffersRqstType, which extends BasicRqstType and contains one - or more RteGrpOfferType 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: + The element passed into the spppUpdateRequest element for this + operation is an instance of AddRteGrpOfferRqstType, which extends + BasicRqstType and contains a RteGrpOfferType object. The XSD + declaration of the RteGrpOfferType is as follows: + + - - + + + + @@ -1535,265 +1438,163 @@ - The RteGrpOfferType object is composed of the following elements: - o base: As described in previous sections, most objects contain - exactly one instance of BasicObjType which contains the ID of - the registrant organization that owns this object and the ID of - the registrar organization that provisioned this object. + o base: All first class objects extend BasicObjType which contains + the ID of the registrant organization that owns this object, the + ID of the registrar organization that provisioned 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. o status: The status of the offer, offered or accepted. This status is controlled by the server. 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 GMT when the Route Group Offer was added. o acceptDateTime: Date and time in GMT when the Route Group Offer was accepted. - The result of addRteGrpOffersRqst is the addRteGrpOffersRspns element - defined below. As with all SPPP requests, the result is all-or- - nothing. If more than one RteGrpOfferType is passed into this - request, then they will either all succeed or all fail. In the case - of failure, the failure response code(s) and message(s) will indicate - the reason for the failure and the object(s) that caused the failure. - - - - The response codes that the addRteGrpOffersRqst operation can return - are as follows: - - o 1000: Request Succeeded. - - o 2001: Request syntax invalid. - - o 2002: Request too large. - - o 2003: Version not supported. - - o 2103: Command invalid. - - o 2104: Attribute value invalid. - - o 2105: Object does not exist. - - o 2106: Object status or ownership does not allow for request. - - o 2301: System temporarily unavailable. - - o 2302: Unexpected internal system or server error. + 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. -8.4. Accept Route Group Offers Operation +6.6. Accept Route Group Offer Operation 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 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 - acceptRteGrpOffersRqst operation is called by, or on behalf of, the - data recipient to accept one or more Route Group Offers that are - 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 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 spppRequest element for this operation is - the acceptRteGrpOffersRqst element. This element is of type - AcceptRteGrpOffersRqstType, which extends BasicRqstType and contains - one or more RteGrpOfferKeyType 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 result of acceptRteGrpOffersRqst is the acceptRteGrpOffersRspns - element defined below. As with all SPPP requests, the result is all- - or-nothing. If more than one RteGrpOfferKeyType is passed into this - request, then they will either all succeed or all fail. In the case - of failure, the failure response code(s) and message(s) will indicate - the reason for the failure and the object(s) that caused the failure. - - - - The response codes that the acceptRteGrpOffersRspns operation can - return are as follows: - - o 1000: Request Succeeded. - - o 2001: Request syntax invalid. - - o 2002: Request too large. - - o 2003: Version not supported. - - o 2103: Command invalid. - - o 2104: Attribute value invalid. - - o 2105: Object does not exist. - - o 2106: Object status or ownership does not allow for request. - - o 2301: System temporarily unavailable. - - o 2302: Unexpected internal system or server error. + The element passed into the spppUpdateRequest element for this + operation is an instance of AcceptRteGrpOffersRqstType, which extends + BasicRqstType and contains a RteGrpOfferKeyType object. -8.5. Reject Route Group Offers Operation + 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. - 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 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. However, the - data recipient that the Route Group has been offered to has the - option of rejecting a Route Group Offer that has been offered but not - accepted or that has been offered and accepted. The - rejectRteGrpOffersRqst operation is used for these purposes and is - called by, or on behalf of, the data recipient to accept one or more - Route Group Offers that are pending in the "offered" status or 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 - recipients organization ID from the list of peerOrgIds 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: +6.7. 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 + recipients 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 spppRequest element for this operation is - the rejectRteGrpOffersRqst element. This element is of type - RejectRteGrpOffersRqstType, which extends BasicRqstType and contains - one or more RteGrpOfferKeyType 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 result of rejectRteGrpOffersRqst is the rejectRteGrpOffersRspns - element defined below. As with all SPPP requests, the result is all- - or-nothing. If more than one RteGrpOfferKeyType is passed into this - request, then they will either all succeed or all fail. In the case - of failure, the failure response code(s) and message(s) will indicate - the reason for the failure and the object(s) that caused the failure. - - - - The response codes that the rejectRteGrpOffersRspns operation can - return are as follows: - - o 1000: Request Succeeded. - - o 2001: Request syntax invalid. - - o 2002: Request too large. - - o 2003: Version not supported. - - o 2103: Command invalid. - - o 2104: Attribute value invalid. - - o 2105: Object does not exist. - - o 2106: Object status or ownership does not allow for request. - - o 2301: System temporarily unavailable. + The element passed into the spppUpdateRequest element for this + operation is an instance of RejectRteGrpOffersRqstType, which extends + BasicRqstType and contains a RteGrpOfferKeyType object. - o 2302: Unexpected internal system or server error. + 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. -8.6. Get Route Group Offers Operation +6.8. Get Route Group Offers Operation The getRteGrpOffersRqst operation allows a client to get the - properties of zero or more Route Group Offer objects that that - registrar is authorized to view. The server will attempt to find - Route Group Offer objects that has 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 the querying client has the authority to view. If there are no - matching Route Group Offers found then an empty result set will be - returned. - - The element passed into the spppRequest element for this operation is - the getRteGrpOffersRqst element. This element is of type - GetRteGrpOffersRqstType, which extends BasicRqstType and contains the - criteria that the returnedRoute Group Offer objects must match. 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: + properties of zero or more Route Group Offer objects that registrar + is authorized to view. 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 the + querying client has the authority to view. 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: - + - - + + + type="spppb:RteGrpOfferKeyType" minOccurs="0" + maxOccurs="unbounded"/> The GetRteGrpOffersRqstType object is composed of the following elements: o offeredByPeers: Zero or one boolean value that, if true, indicates that only offers that are offered by peering @@ -1820,408 +1621,1534 @@ o peeringOrg: Zero or more organization IDs. Only offers that are offered to or 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 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. - The result of the getRteGrpOffersRqst operation returned in the - spppResponse element is the getRteGrpOffersRspns element defined - below. This object contains the resulting set of RteGrpOfferType - objects, or an empty set if there were no matches. + 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. Public Identifier Operations - + 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. In SPPP, SED can be + provisioned by the registrant, or by the registrar on behalf of the + registrant. Also, SPPP supports the notion of the carrier-of-record + as defined in RFC 5067. Therefore, the entity adding the Public + Identity in the Registry can optionally claim to be a carrier-of- + record. + + SPPP identifies three types of Public Identifiers: telephone number + (TN), email address, and the routing number (RN). SPPP also supports + the requirement of adding a contiguous range of TNs including the + length variance associated to the Open Number Plan. + + The XML schema type definition PubIDType is the generalization of the + Public Identifier. PubIDType is an abstract type. In agreement with + the data model, PubIDType member 'dgName' represents the name of the + destination group that a given Public Identifier is associated to. + The PubIDType object structure is defined as follows: + + - + - + - The response codes that the getRteGrpOffersRqst operation can return - are as follows: - - o 1000: Request Succeeded. - - o 2001: Request syntax invalid. + A registrant can add a Public Identifier with the help of a + BasicRqstType called AddPubIdRqstType. To complete the add request, + AddPubIdRqstType XML instance is added to root + element. If there is a conflict and a Public Identifier already + exists in the Registry, the old entry will be replaced with the newly + provisioned entry. For the add or update operation, the destination + group name is a mandatory parameter. Not including a valid + destination group name in the update request will cause the Registry + to return an appropriate error. - o 2002: Request too large. + Telephone number is identified by TNType, an extension of PubIDType. + TNType is composed of the following attributes: - o 2003: Version not supported. + o tn: Telephone number to be added to the Registry. - o 2103: Command invalid. + o rteRecRef: Optional reference to the route record that is + 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 2104: Attribute value invalid. + o corInfo: corInfo is an optional parameter of type CORInfoType + that allows the registrant organization to set forth a claim to + be the carrier-of-record [see RFC 5067]. This is done by + setting the element of the CORInfoType object + structure to true. The other two parameters of the CORInfoType, + and are meant to be set by the Registry to + relay 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, etc., in order to qualify whether the + registrant claim can be satisfied. If the carrier-of-record + claim disagrees with the authority data of 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. - o 2301: System temporarily unavailable. + TNType object definition is as follows: - o 2302: Unexpected internal system or server error. + + + + + + + + + + + -8.7. Public Identifier Operations + Routing number is identified by RNType. 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. - Public Identifier is a well-known attribute that is used as the - search key to find the routes associated with it. There are three - types of public identifiers defined in this document: TNType for the - telephone number, EmailType for the email address, and RNType for - PSTN routing number. Further, TNRangeType is used to add a range of - telephone numbers. + RNType is composed of the following attributes: -8.7.1. Add Public Identifier + o rn: Routing Number used as the search key - addPubIdsRqst operation is used to create or overwrite one or more - public identifier(s). When activating a new public identifier that - can be reached using a common set of routes, it is often associated - with a well-known destination group. In some cases, such as the - email public identifier, the routing information is unique, and - therefore, addPubIdsRqst allows the public identifier to be directly - associated with a route record. + o corInfo: Optional element of type CORInfoType. - PubIdType in the schema represents the public identifier and it is - defined as an abstract type. TNType, EmailType, and RNType, the - concrete types of PubIdType, are inputs to 'addPubIdRqst' operation. - The declaration of 'addPubIdsRqst' is as follows: + RNType object information is as follows: - - + - + - + + - For the 'addPubIdsRqst' operation to succeed, each public identifier - should be associated with at least a valid destination group or a - valid route type as defined within the PubIdType definition. If not, - the provisioning server will deem the request a failure and return an - appropriate failure code in the response. + A contiguous range of TNs is added with the help of TNRType. This + object type includes an optional "prefix" attribute to indicate that + a given TN range qualifies for the Open Number Plan (ONP). In order + to correctly expand the number range that qualifies for Open Number + Plan, the Registry must have the required data about the national + significant number length for the TN prefix included in the TN range + object. If the Registry encounters an error in adding even a single + TN that is part of the TN range, the whole request will be deemed a + failure. In other words, the TNRType add request is transactional in + nature, and the partial success case is not supported. - TNType is a concrete public identifier that extends PubIdType - definition. If the entity provisioning the telephone number is the - carrier of record [see RFC 5067], then it SHOULD include the - 'corClaim' element with a value 'true'. If the SPPP server records - disagree with the COR claim of the provisioning entity, an - appropriate failure response MUST be returned. + TNRType is composed of the following attributes: - - - - - - - - + o endTn: The last number in the TN range + + o corInfo: Optional element of type CORInfoType. + + o prefix: Optional attribute, when set to "true", indicates that + the included TN Range falls under the Open Number Plan. + + TNRange object structure is as follows: + + - + - - + + - For added flexibility, there is support to add a range of telephone - numbers and associate them with a destination group. TNRType extends - TNType and adds the 'endTn' attribute to mark the end of the range. - In the TNRType context, the extended 'tn' attribute is used for the - starting TN of a given telephone number range. + The object structure of AddPubIdRqstType used to add Public + Identifiers is as follows - + - + - + - The element passed into the spppRequest element for this operation is - the addPubIdsRqst element. This element is of type - AddPubIdsRqstType, which extends BasicRqstType and contians one or - more PubIdType objects. Any limitation on the maximum number of - PubIdType objects that may be passed into this operatoin is a policy - decision and is not limited by the protocol. + The client can set the GetPubIdsRqstType in the + structure to obtain information about one or more objects that + were successfully provisioned earlier and that the calling entity is + privileged to see. If the GetPubIdsRqstType object does not include + data, then all authorized Public Identity data will be returned + by the Registry in the response. If no matching Public Identifiers + are found, then an empty result set will be returned. - The response from the server is returned in addPubIdsRspns element. - If more than one public identifiers are passed in the addPubIdsRqst, - then a failure to add one will result in the failure of addPubIdsRqst - operation. If the 'transactional' attribute is set to 'true' in the - root element spppRequest and more than one operation request elements - are included, then a failure of any one operation will result in the - overall failure of spppRequest. In the case of a failure, the - response code(s) and message(s) will indicate the reason of failure. + GetPubIdsRqstType object structure is as follows: - + + + + + + + + + - The response codes that the addRteGrpsRqst operation can return are - as follows: + As described in an earlier section of this document, the result of + any spppQueryRequest operation is a spppQueryResponse that contains + the response code and the query result set, if any. - o 1000: Request Succeeded. +6.10. Egress Route Operations - o 2001: Request syntax invalid. + The egress route add operation allows a call originating SSP to + define a preferred egress route in an attempt to reach the ingress + SBE of the target SSP. The need arises when there is a choice of + egress SBE and an SSP wants to exercise greater control in deciding + how to route the outbound session establishment request. - o 2002: Request too large. + As a first step, it is assumed that the target SSP has offered to + share the route group that consists of the ingress route information + to the SBE(s) and the originating SSP has accepted the offer. Next, + the originating SSP can add the egress route in the Registry, with + appropriate regular expression, to rewrite ingress route information + from the target SSP and include the egress SBE information. In high- + availability configurations, the originating SSP will likely add a + secondary egress route object re-writing the same ingress route from + the target SSP with a secondary choice of egress SBE as a backup. In + this case, the backup egress route definition will carry the higher + integer value for the "pref" parameter to indicate a lower priority. - o 2003: Version not supported. + An egress route is identified by type EgrRteType and its object + structure is shown below: - o 2103: Command invalid. + + + + + + + + + + + + + - o 2104: Attribute value invalid. + The EgrRteType object is composed of the following elements: - o 2105: Object does not exist. + o base: All first class objects extend BasicObjType which contains + the ID of the registrant organization that owns this object, the + ID of the registrar organization that provisioned 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. - o 2106: Object status or ownership does not allow for request. + o egrRteName: The name of the egress route. - o 2301: System temporarily unavailable. + o pref: The preference of this egress route relative to other + egress routes that may get selected when responding to a + resolution request. - o 2302: Unexpected internal system or server error. + 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. -8.7.2. Get Public Identifier + o ingrRteRec: The ingress route records that the egress route + should be used for. - The getPubIdsRqst can be used by an authorized entity to obtain the - properties of one or more public identifiers. In case of an - authorization failure or if no matching public identifiers are found, - an appropriate failure code will be returned. + o ext: Point of extensibility described in a previous section of + this document. - To make a successful query, getPubIdsRqst element is set within the - spppRequest root element. getPubIdsRqst is of type GetPubIdsRqstType, - which extends from the common BasicRqstType. + The AddEgrRteRqstType request is used to create or overwrite an + egress route. - - + - + - The result of the getPubIdsRqst operation returned in the - spppResponse element is the getPubIdsRspns element of type - GetPubIdsRspnsType. If the matching record is found, getPubIdsRspns - element will include one or more pi elements with destination group - name and/or the route record associations. + 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. + + - + - + - The response codes that the addRteGrpsRqst operation can return are - as follows: +6.11. Add Route Record Operation - o 1000: Request Succeeded. + 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 server 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, for example, that is 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. - o 2001: Request syntax invalid. + 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: - o 2002: Request too large. + + + + + + + + + - o 2003: Version not supported. + The element passed into the spppUpdateRequest element for this + operation is an instance of AddRteRecRqstType, which extends + BasicRqstType and contains one RteRecType object. The RteRecType + object structure is defined as follows: - o 2103: Command invalid. + + + + + + + + + + - o 2104: Attribute value invalid. + The RteRecType object is composed of the following elements: - o 2105: Object does not exist. + o base: All first class objects extend BasicObjType which contains + the ID of the registrant organization that owns this object, the + ID of the registrar organization that provisioned 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. - o 2106: Object status or ownership does not allow for request. + o rrName: The character string that contains the name of the Route + Record. It uniquely identifies this object within the context + of the registrant ID (a child element of the base element as + described above). - o 2301: System temporarily unavailable. + o priority: Zero or one priority value that can be used to provide + a relative value weighting of one Route Record over another. + The manner in which this value is used, perhaps in conjunction + with other factors, is a matter of policy. - o 2302: Unexpected internal system or server error. + o ext: Point of extensibility described in a previous section of + this document. -8.7.3. Delete Public Identifier + As described above, route records are based on an abstract type: + RteRecType. The concrete types that use RteRecType as an extension + base are NAPTRType, NSType, and URIType. The definitions of these + types are included below. The NAPTRType object is comprised of the + data elements necessary for a NAPTR that contains routing information + for a Route Group. The NSType object is comprised of the data + elements necessary for a Name Server that points to another DNS + server that contains the desired routing information. The URIType + object is comprised of the data elements necessary to house a URI. - In order to remove the public identifier, an authorized entity can - use the delPubIdsRqst operation. If the entity that issued the - command is not authorized to perform this operation or if the public - identifier doesn't exist, an appropriate error code will be returned - in the response. + The data provisioned in a Registry can be leveraged for many purposes + and queried using various protocols including SIP, ENUM and others. + It is for this reason that a route record type offers a choice of URI + and DNS resource record types. URIType fulfills the need for both + SIP and ENUM protocols. When a given URIType is associated to a + destination group, the user part of the replacement string that + may require the Public Identifier cannot be preset. As a SIP + Redirect, the resolution server will apply pattern on the input + Public Identifier in the query and process the replacement string by + 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. - delPubIdsRqst element is set in the root spppRequest element. - delPubIdsRqst element is of type DelPubIdsRqstType as shown below: + + + + + + + + + + + + + + + + + + + + + - - + - + - + + + - The result of the delPubIdsRqst operation returned in the - spppResponse element is the getPubIdsRspns element of type - GetPubIdsRspnsType. - - - -8.8. Egress Route Operations + + + + + + + + + + + + + + + + + + - This section describes the operations related to egress routes. In - this version, egress routes are only defined for route records of - NAPTR type (future versions may expand this notion to URI types). + + + + + + - The egress route functionality allows a call originating SSP to - define its egress route in an attempt to reach the ingress SBE of the - target SSP. In some cases, the call originating SSP has more than - one choice of egress SBEs and intends to selectively use one of these - route elements for call termination to the target SSP. + The NAPTRType object is composed of the following elements: - An egress route simply allows an organization to re-write the route - records provided by a peer in a given Route Group. If a terminating - SSP has provided a route group with at least one route record in the - form of an ingress DNS NAPTR record, then the egress route allows the - originating SSP to re-write the regular expression of the matching - ingress NAPTR. The SPPP protocol allows a client to add, get and - delete egress route objects based on a given peer's ingress route - group. + o order: Order value in an ENUM NAPTR, relative to other NAPTRType + objects in the same Route Group. - An egress route is of type EgrRteType as shown below: + o svcs: ENUM service(s) that are served by the SBE. This field's + value must be of the form specified in RFC 3761 (e.g., E2U+ + pstn:sip+sip). The allowable values are a matter of policy and + not limited by this protocol. - - - - - - - - - - - + o regx: NAPTR's regular expression field. If this is not included + then the Repl field must be included. - The EgrRteType object is composed of the following elements: + o repl: NAPTR replacement field, should only be provided if the + Regex field is not provided, otherwise it will be ignored by the + server. - o base: As described in previous sections, most objects contain - exactly one instance of BasicObjType which contains the ID of - the registrant organization that owns this object and the ID of - the registrar organization that provisioned this object. + o ttl: Number of seconds that an addressing server may cache this + NAPTR. - o egrRteName: The name of the egress route. + o ext: Point of extensibility described in a previous section of + this document. - o pref: + The NSType object is composed of the following elements: - o svcs: The ENUM services that the egress route should be used for - if the route record is a NAPTR. + o hostName: Fully qualified host name of the name server. - 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 and that have the - given ENUM service (ere + repl). + o ipAddr: Zero or more objects of type IpAddrType. Each object + holds an IP Address and the IP Address type, IPv4 or IP v6. - o ingressRte: The ingress route group name that the egress route - should be used for. + o ttl: Number of seconds that an addressing server may cache this + Name Server. o ext: Point of extensibility described in a previous section of this document. -8.8.1. Add Egress Route + The URIType object is composed of the following elements: - addEgrRtesRqst operation is used to create or overwrite one or more - egress routes. + 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. - addEgrRtesRqst is added in the spppRequest root element in order to - send a valid request to the server. A limitation on the maximum - number of EgrRteType is enforced by the registry and will vary from - one implementation to the next. + 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. - The response from the server is returned in addEgrRtesRspns element, - which is defined as the element of type BasicRspnsType. +6.12. Get Route Records Operation -8.8.2. Get Egress Route + The getRteRecsRqst operation allows a client to get the properties of + Route Record objects that a registrar organization is authorized to + view. 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 the set of ObjKeyType objects is + empty then the server will return the list of Route Record objects + that the querying client has the authority to view. If there are no + matching Route Record found then an empty result set will be + returned. - The getEgrRtesRqst is used by an authorized entity to fetch the well- - known egress route data. + The element passed into the spppQueryRequest element for this + operation is an instance of type GetRteRecsRqstType, which extends + BasicRqstType 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: - - + - + - - -8.8.3. Delete Egress Route + 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. - delEgressRte is used by authorized entities to remove a well-know - route. +6.13. Delete Operation - - + In order to remove an object from the Registry, an authorized entity + can send the to the Registry with a corresponding + delete BasicRqstType object. If the entity that issued the command + is not authorized to perform this operation or if the public + identifier doesn't exist, an appropriate error code will be returned + in the message. + + As an example, DelPubIdRqstType aids in identifying the Public + Identifier that is used to delete a Public Identifier from the + Registry. DelPubIdsRqstType object definition is shown below: + + - + + Similarly, each 'Add' operation in the SP protocol has a + corresponding 'Del' operation used to delete the respective object + type from the Registry. + +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 protocol is left out. The SPPP + protocol 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 protocol to associate route + preferences for the destination ingress routes and exercise greater + control on outbound traffic to the peer's ingress SBEs. + + ---------------+ +------------------ + | | + +---------------+ +---------------+ + | sbe1.ssp1.com | | sbe2.ssp2.com | + +---------------+ +---------------+ + SSP1 | | SSP2 + +---------------+ +---------------+ + | sbe3.ssp1.com | | sbe4.ssp2.com | + +---------------+ +---------------+ + 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 + 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_7777 + tx_id_12346 + + 1000 + success + + + +7.2. Add Route Records + + SSP2 adds an ingress routes in the Registry. + + + + + + iana-en:222 + iana-en:222 + RTE_SSP2_SBE2 + 10 + u + E2U+sip + + ^(.*)$ + sip:\1@sbe2.ssp2.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 + + + + + iana-en:222 + iana-en:222 + RTE_SSP2_SBE4 + ^(.*)$ + sip:\1;npdi@sbe4.ssp2.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 + 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 + 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 was + processed successfully. element confirms SSP2 claim to be the + carrier of record has been accepted and the processing time is + reflected by data element. + + + + txid-5577 + tx_id_12345 + + 1000 + success + + + 1000 + success + + + iana-en:222 + iana-en:222 + 2010-05-30T09:30:10Z + DEST_GRP_SSP2_1 + +12025556666 + + true + true + 2006-05-04T18:13:51.0Z + + + + + + + +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. + + + + + + rantId0 + rarId0 + 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. Since the 'prefix' public identity attribute is + not set to 'true', this means that the TNs belong to a closed number + plan. + + + + + + iana-en:222 + 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 Range with Open Number Plan support + + In this case, open number plan refers to TN length variance. + Inclusion of "prefix" attribute of TNRType with its value set to true + indicates that the start TN range identified by the element is + not necessarily a subscriber number and the Registry will have to + consult the number plan data for the respective country to know how + to expand the number range. attribute marks the end of the TN + range. + + + + + + iana-en:222 + iana-en:222 + DEST_GRP_SSP2_1 + +4312315566 + +4312315567 + + + + + Registry completes the request successfully and returns a favorable + response. + + + + tx_id_12255598 + + 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 + + + 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.com". + + + + tx_9000 + + + iana-en:111 + + EGR_RTE_01 + 50 + + ^(.*@)(.*)$ + \1\2?route=sbe1.ssp1.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 + 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 + iana-en:222 + +12025556666 + + + + + Registry completes the request successfully and returns a favorable + response. + + + + + 1000 + success + + + iana-en:222 + 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 + 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 choses to fetch the last provisioned route group sharing offer + to the SSP1. + + + + + true + ssp1 + + + + Registry completes the request successfully and returns a favorable + response. + + + + + 1000 + success + + + iana-en:222 + iana-en:222 + + + iana-en:222 + RTE_GRP_SSP2_1 + + iana-en:111 + + offered + 2006-05-04T18:13:51.0Z + + + +7.16. Get Egree 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 + iana-en:111 + EGR_RTE_01 + 50 + E2U+sip + + ^(.*)$ + sip:\1@sbe1.ssp1.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 + 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 + + 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 + + All SPPP protocol elements are defined in the namespaces in te IANA + Considerations section and in the Formal Protocol Specification + section of this document. + +8.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. + + Character encodings other than UTF-8 and UTF-16 are allowed by XML. + 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: + + version="1.0" encoding="UTF-8" standalone="no"?> + 9. Security Considerations The transport protocol section contains some security properties that the transport protocol must provide so that authenticated endpoints can exchange data confidentially and with integrity protection. More details will be provided in a future revision of this document. 10. IANA Considerations @@ -2234,110 +3161,143 @@ 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). + 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 This section provides the draft XML Schema Definition for the SPPP - protocol. Please read Section 3.4 for known issues. + protocol. - ------------------ Object Type Definitions - -------------- + + ------------------ Object Type Definitions -------------- + + + - - + + + + + + - + + + + - - + + - + - + + + + + + + + + + + + - @@ -2360,56 +3320,60 @@ + + - - + + + + + - - - + + + ------------------ Abstract Object and Element Type Definitions -------------- - + + + - - - - - @@ -2420,64 +3384,46 @@ - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + @@ -2477,383 +3423,352 @@ - + + + + + + + + -------------- Operation Request and Response Object Type Definitions ------------ - + + + + + + + - + - + - - + + + + + + + + + + + + + - + - + - + + - + - + - + - + - + - + - + - + - + - - + + - + - + + - + - + - + + + + + + + + + + - + - + - + - + - + + - + - + - + + type="spppb:RteGrpOfferKeyType" /> - + + type="spppb:RteGrpOfferKeyType"/> - + + type="spppb:RteGrpOfferKeyType"/> - + - - + + + - - - - - - - - - - + - + - + - + - + - - - - + + -------- Generic Request and Response Definitions + --------------- + + + - + + - - - - - - + + + + + + + + + - - - + + + - + + - - - - -------------- Operation Request and Response - Element Definitions ------------ - - - -------------- Manage Route Groups - - - - - - - - - - -------------- Manage Destination Groups - - - - - - - - - - -------------- Manage Public Identifiers - - - - - - - - - - -------------- Manage Route Group Offers - - - - - - - - - - - - - - -------------- Manage Egress Routes - - - - - - - - - - -------------- Misc Operations - - - - - -------- Generic Request and Response Definitions - --------------- - - + + - + + - - + - + + + + + + + + + 12. Specification Extensibility The protocol defined in this specification is extensible. This section explains how to extend the protocol and what procedures are necessary to follow in order to ensure proper extensions.