idnits 2.17.1
draft-ietf-drinks-spp-framework-00.txt:
Checking boilerplate required by RFC 5378 and the IETF Trust (see
https://trustee.ietf.org/license-info):
----------------------------------------------------------------------------
No issues found here.
Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt:
----------------------------------------------------------------------------
No issues found here.
Checking nits according to https://www.ietf.org/id-info/checklist :
----------------------------------------------------------------------------
No issues found here.
Miscellaneous warnings:
----------------------------------------------------------------------------
== The copyright year in the IETF Trust and authors Copyright Line does not
match the current year
== The document seems to use 'NOT RECOMMENDED' as an RFC 2119 keyword, but
does not include the phrase in its RFC 2119 key words list.
-- The exact meaning of the all-uppercase expression 'MAY NOT' is not
defined in RFC 2119. If it is intended as a requirements expression, it
should be rewritten using one of the combinations defined in RFC 2119;
otherwise it should not be all-uppercase.
== The expression 'MAY NOT', while looking like RFC 2119 requirements text,
is not defined in RFC 2119, and should not be used. Consider using 'MUST
NOT' instead (if that is what you mean).
Found 'MAY NOT' in this paragraph:
In some deployments, the SPPF objects that an SPPF registry manages
can be private in nature. As a result it MAY NOT be appropriate to for
transmission in plain text over a connection to the SPPF registry.
Therefore, the transport protocol SHOULD provide means for end-to-end
encryption between the SPPF client and server.
-- The document date (January 30, 2012) is 4470 days in the past. Is this
intentional?
Checking references for intended status: Proposed Standard
----------------------------------------------------------------------------
(See RFCs 3967 and 4897 for information about using normative references
to lower-maturity documents in RFCs)
== Unused Reference: 'RFC5321' is defined on line 2336, but no explicit
reference was found in the text
** Downref: Normative reference to an Informational RFC: RFC 4949
** Downref: Normative reference to an Informational RFC: RFC 5067
Summary: 2 errors (**), 0 flaws (~~), 4 warnings (==), 2 comments (--).
Run idnits with the --verbose option for more detailed information about
the items above.
--------------------------------------------------------------------------------
2 DRINKS J-F. Mule
3 Internet-Draft CableLabs
4 Intended status: Standards Track K. Cartwright
5 Expires: August 2, 2012 TNS
6 S. Ali
7 NeuStar
8 A. Mayrhofer
9 enum.at GmbH
10 V. Bhatia
11 TNS
12 January 30, 2012
14 Session Peering Provisioning Framework (SPPF)
15 draft-ietf-drinks-spp-framework-00
17 Abstract
19 This document specifies the data model and the overall structure for
20 a framework to provision session establishment data into Session Data
21 Registries and SIP Service Provider data stores. The framework is
22 called the Session Peering Provisioning Framework (SPPF). The
23 provisioned data is typically used by network elements for session
24 peering.
26 Status of this Memo
28 This Internet-Draft is submitted in full conformance with the
29 provisions of BCP 78 and BCP 79.
31 Internet-Drafts are working documents of the Internet Engineering
32 Task Force (IETF). Note that other groups may also distribute
33 working documents as Internet-Drafts. The list of current Internet-
34 Drafts is at http://datatracker.ietf.org/drafts/current/.
36 Internet-Drafts are draft documents valid for a maximum of six months
37 and may be updated, replaced, or obsoleted by other documents at any
38 time. It is inappropriate to use Internet-Drafts as reference
39 material or to cite them other than as "work in progress."
41 This Internet-Draft will expire on August 2, 2012.
43 Copyright Notice
45 Copyright (c) 2012 IETF Trust and the persons identified as the
46 document authors. All rights reserved.
48 This document is subject to BCP 78 and the IETF Trust's Legal
49 Provisions Relating to IETF Documents
50 (http://trustee.ietf.org/license-info) in effect on the date of
51 publication of this document. Please review these documents
52 carefully, as they describe your rights and restrictions with respect
53 to this document. Code Components extracted from this document must
54 include Simplified BSD License text as described in Section 4.e of
55 the Trust Legal Provisions and are provided without warranty as
56 described in the Simplified BSD License.
58 Table of Contents
60 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4
61 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 7
62 3. Framework High Level Design . . . . . . . . . . . . . . . . . 9
63 3.1. Framework Data Model . . . . . . . . . . . . . . . . . . . 9
64 3.2. Time Value . . . . . . . . . . . . . . . . . . . . . . . . 12
65 4. Transport Protocol Requirements . . . . . . . . . . . . . . . 13
66 4.1. Connection Oriented . . . . . . . . . . . . . . . . . . . 13
67 4.2. Request and Response Model . . . . . . . . . . . . . . . . 13
68 4.3. Connection Lifetime . . . . . . . . . . . . . . . . . . . 13
69 4.4. Authentication . . . . . . . . . . . . . . . . . . . . . . 13
70 4.5. Authorization . . . . . . . . . . . . . . . . . . . . . . 14
71 4.6. Confidentiality and Integrity . . . . . . . . . . . . . . 14
72 4.7. Near Real Time . . . . . . . . . . . . . . . . . . . . . . 14
73 4.8. Request and Response Sizes . . . . . . . . . . . . . . . . 14
74 4.9. Request and Response Correlation . . . . . . . . . . . . . 14
75 4.10. Request Acknowledgement . . . . . . . . . . . . . . . . . 14
76 4.11. Mandatory Transport . . . . . . . . . . . . . . . . . . . 15
77 5. Base Framework Data Structures and Response Codes . . . . . . 16
78 5.1. Basic Object Type and Organization Identifiers . . . . . . 16
79 5.2. Various Object Key Types . . . . . . . . . . . . . . . . . 16
80 5.2.1. Generic Object Key Type . . . . . . . . . . . . . . . 16
81 5.2.2. Derived Object Key Types . . . . . . . . . . . . . . . 17
82 5.3. Response Message Types . . . . . . . . . . . . . . . . . . 19
83 6. Framework Data Model Objects . . . . . . . . . . . . . . . . . 22
84 6.1. Destination Group . . . . . . . . . . . . . . . . . . . . 22
85 6.2. Public Identifier . . . . . . . . . . . . . . . . . . . . 23
86 6.3. Route Group . . . . . . . . . . . . . . . . . . . . . . . 27
87 6.4. Route Record . . . . . . . . . . . . . . . . . . . . . . . 31
88 6.5. Route Group Offer . . . . . . . . . . . . . . . . . . . . 35
89 6.6. Egress Route . . . . . . . . . . . . . . . . . . . . . . . 38
90 7. Framework Operations . . . . . . . . . . . . . . . . . . . . . 40
91 7.1. Add Operation . . . . . . . . . . . . . . . . . . . . . . 40
92 7.2. Delete Operation . . . . . . . . . . . . . . . . . . . . . 40
93 7.3. Get Operations . . . . . . . . . . . . . . . . . . . . . . 41
94 7.4. Accept Operations . . . . . . . . . . . . . . . . . . . . 41
95 7.5. Reject Operations . . . . . . . . . . . . . . . . . . . . 42
96 7.6. Get Server Details Operation . . . . . . . . . . . . . . . 42
97 8. XML Considerations . . . . . . . . . . . . . . . . . . . . . . 43
98 8.1. Namespaces . . . . . . . . . . . . . . . . . . . . . . . . 43
99 8.2. Versioning and Character Encoding . . . . . . . . . . . . 43
100 9. Security Considerations . . . . . . . . . . . . . . . . . . . 44
101 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 46
102 11. Formal Specification . . . . . . . . . . . . . . . . . . . . . 47
103 12. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 56
104 13. References . . . . . . . . . . . . . . . . . . . . . . . . . . 57
105 13.1. Normative References . . . . . . . . . . . . . . . . . . . 57
106 13.2. Informative References . . . . . . . . . . . . . . . . . . 57
107 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 59
109 1. Introduction
111 Service providers and enterprises use registries to make session
112 routing decisions for Voice over IP, SMS and MMS traffic exchanges.
113 This document is narrowly focused on the provisioning framework for
114 these registries. This framework prescribes a way for an entity to
115 provision session-related data into a registry. The data being
116 provisioned can be optionally shared with other participating peering
117 entities. The requirements and use cases driving this framework have
118 been documented in [RFC6461]. The reader is expected to be familiar
119 with the terminology defined in the previously mentioned document.
121 Three types of provisioning flows have been described in the use case
122 document: client to registry provisioning, registry to local data
123 repository and registry to registry. This document addresses client
124 to registry aspect to fulfill the need to provision Session
125 Establishment Data (SED). The framework that supports flow of
126 messages to facilitate client to registry provisioning is referred to
127 as Session Peering Provisioning Framework (SPPF).
129 Please note that the role of the "client" and the "server" only
130 applies to the connection, and those roles are not related in any way
131 to the type of entity that participates in a protocol exchange. For
132 example, a registry might also include a "client" when such a
133 registry initiates a connection (for example, for data distribution
134 to SSP).
136 *--------* *------------* *------------*
137 | | (1). Client | | (3).Registry | |
138 | Client | ------------> | Registry |<------------->| Registry |
139 | | to Registry | | to Registry | |
140 *--------* *------------* *------------*
141 / \ \
142 / \ \
143 / \ \
144 / \ v
145 / \ ...
146 / \
147 / (2). Distrib \
148 / Registry data \
149 / to local data \
150 V store V
151 +----------+ +----------+
152 |Local Data| |Local Data|
153 |Repository| |Repository|
154 +----------+ +----------+
156 Three Registry Provisioning Flows
158 Figure 1
160 The data provisioned for session establishment is typically used by
161 various downstream SIP signaling systems to route a call to the next
162 hop associated with the called domain. These systems typically use a
163 local data store ("Local Data Repository") as their source of session
164 routing information. More specifically, the SED data is the set of
165 parameters that the outgoing signaling path border elements (SBEs)
166 need to initiate the session. See [RFC5486] for more details.
168 A "terminating" SIP Service Provider (SSP) provisions SED into the
169 registry to be selectively shared with other peer SSPs.
170 Subsequently, a registry may distribute the provisioned data into
171 local data repositories used for look-up queries (identifier -> URI)
172 or for lookup and location resolution (identifier -> URI -> ingress
173 SBE of terminating SSP). In some cases, the registry may
174 additionally offer a central query resolution service (not shown in
175 the above figure).
177 A key requirement for the SPPF is to be able to accommodate two basic
178 deployment scenarios:
180 1. A resolution system returns a Look-Up Function (LUF) that
181 comprises of the target domain to assist in call routing (as
182 described in [RFC5486]). In this case, the querying entity may
183 use other means to perform the Location Routing Function (LRF)
184 which in turn helps determine the actual location of the
185 Signaling Function in that domain.
187 2. A resolution system returns both a Look-Up function (LUF) and
188 Location Routing Function (LRF) to locate the SED data fully.
190 In terms of framework design, SPPF is agnostic to the transport
191 protocol. This document includes the specification of the data model
192 and identifies, but does not specify, the means to enable protocol
193 operations within a request and response structure. That aspect of
194 the specification has been delegated to the "transport" specification
195 for the protocol. To encourage interoperability, the framework
196 supports extensibility aspects.
198 Transport requirements are provided in this document to help with the
199 selection of the optimum transport mechanism. The SPP Protocol over
200 SOAP document identifies a protocol for SPPF that uses SOAP/HTTP as
201 the transport mechanism.
203 This document is organized as follows:
205 o Section 2 provides the terminology;
207 o Section 3 provides an overview of SPPF, including the functional
208 entities and data model;
210 o Section 4 specifies requirements for SPPF transport protocols;
212 o Section 5 describes the base framework data structures, the
213 generic response types that MUST be supported by a conforming
214 "transport" specification, and the basic object type most first
215 class objects extend from;
217 o Section 6 detailed descriptoins of the data model object
218 specifications;
220 o Section 8 defines XML considerations that XML parsers must meet
221 to conform to this specification;
223 o Section 11 normatively defines the SPPF using its XML Schema
224 Definition.
226 2. Terminology
228 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
229 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
230 document are to be interpreted as described in [RFC2119].
232 This document reuses terms from [RFC3261], [RFC5486], use cases and
233 requirements documented in [RFC6461] and the ENUM Validation
234 Architecture [RFC4725].
236 In addition, this document specifies the following additional terms:
238 SPPF: Session Peering Provisioning Framework, the framework used by
239 a transport protocol to provision data into a Registry (see arrow
240 labeled "1." in Figure 1 of [RFC6461]). It is the primary scope
241 of this document.
243 SPDP: Session Peering Distribution Protocol, the protocol used to
244 distribute data to Local Data Repository (see arrow labeled "2."
245 in Figure 1 of [RFC6461]).
247 Client: An application that supports an SPPF client; it is
248 sometimes referred to as a "registry client".
250 Registry: The Registry operates a master database of Session
251 Establishment Data for one or more Registrants.
253 A Registry acts as an SPPF server.
255 Registrant: In this document we extend the definition of a
256 Registrant based on [RFC4725]. The Registrant is the end-user,
257 the person or organization that is the "holder" of the Session
258 Establishment Data being provisioned into the Registry by a
259 Registrar. For example, in [RFC6461], a Registrant is pictured as
260 a SIP Service Provider in Figure 2.
262 Within the confines of a Registry, a Registrant is uniquely
263 identified by a well-known ID.
265 Registrar: In this document we extend the definition of a Registrar
266 from [RFC4725]. A Registrar is an entity that performs
267 provisioning operations on behalf of a Registrant by interacting
268 with the Registry via SPPF operations. In other words the
269 Registrar is the SPPF Client. The Registrar and Registrant roles
270 are logically separate to allow, but not require, a single
271 Registrar to perform provisioning operations on behalf of more
272 than one Registrant.
274 Peering Organization: A Peering Organization is an entity to which
275 a Registrant's Route Groups are made visible using the operations
276 of SPPP.
278 3. Framework High Level Design
280 This section introduces the structure of the data model and provides
281 the information framework for the SPPF. An overview of the protocol
282 operations is first provided with a typical deployment scenario. The
283 data model is then defined along with all the objects manipulated by
284 the protocol and their relationships.
286 3.1. Framework Data Model
288 The data model illustrated and described in Figure 2 defines the
289 logical objects and the relationships between these objects that the
290 SPPF protocol supports. SPPF defines the protocol operations through
291 which an SPPF client populates a registry with these logical objects.
292 Various clients belonging to different registrars may use the
293 protocol for populating the registry's data.
295 The logical structure presented below is consistent with the
296 terminology and requirements defined in [RFC6461].
298 +-------------+ +------------------+
299 | all object | |Organization: |
300 | types |----->|orgId |
301 +------+------+ | |
302 All objects are +------------------+
303 associated with an ^
304 organization to |A Route Group is
305 identify the |associated with +-----[abstract]-+
306 object's registrant |zero or more Peering | Route Record: |
307 |Organizations | rrName, |
308 | | priority, |
309 +--------+--------------+ | extension |
310 |Route Group: |------->| |
311 | rant, | +----------------+
312 | rgName, | ^
313 | destGrpRef, | |
314 | isInSvc, | |Various types
315 | rrRef, | |of Route
316 | peeringOrg, | |Records...
317 | sourceIdent, | +-----+------------+
318 | priority, | | | |
319 | extension | +----+ +-------+ +----+
320 +-----------------------+ | URI| | NAPTR | | NS |
321 | +----+ +-------+ +----+
322 |
323 | +----------[abstract]-+
324 | |Public Identifier: |
325 | | |
326 | | rant, |
327 v | publicIdentifier, |
328 +----------------------+ | destGrpRef, |
329 | Dest Group: |<----| rrRef, |
330 | rant, | | extension |
331 | dgName, | +---------------------+
332 | extension | ^
333 +----------------------+ |Various types
334 |of Public
335 |Identifiers...
336 +---------+-------+------------...
337 | | | |
338 +------+ +-----+ +-----+ +-----+
339 | TN | | TNP | | TNR | | RN |
340 +------+ +-----+ +-----+ +-----+
342 SPPF Data Model
344 Figure 2
346 The objects and attributes that comprise the data model can be
347 described as follows (objects listed from the bottom up):
349 o Public Identifier:
350 From a broad perspective a public identifier is a well-known
351 attribute that is used as the key to perform resolution lookups.
352 Within the context of SPPF, a public identifier object can be a
353 telephone number, a range of telephone numbers, a PSTN Routing
354 Number (RN), or a TN prefix.
356 An SPPF Public Identifier is associated with a Destination Group
357 to create a logical grouping of Public Identifiers that share a
358 common set of Routes.
360 A TN Public Identifier may optionally be associated with zero or
361 more individual Route Records. This ability for a Public
362 Identifier to be directly associated with a set of Route Records
363 (e.g. target URI), as opposed to being associated with a
364 Destination Group, supports the use cases where the target URI
365 contains data specifically tailored to an individual TN Public
366 Identifier.
368 o Destination Group:
369 A named collection of zero or more Public Identifiers that can be
370 associated with one or more Route Groups for the purpose of
371 facilitating the management of their common routing information.
373 o Route Group:
374 A Route Group contains a set of Route Record references, a set of
375 Destination Group references, and a set of peering organization
376 identifiers. This is used to establish a three part relationships
377 between a set of Public Identifiers, the routing information (SED)
378 shared across the Public Identifiers, and the list of peering
379 organizations whose query responses from the resolution system may
380 include the routing information from a given route group. In
381 addition, the sourceIdent element within a Route Group, in concert
382 with the set of peering organization identifiers, enables fine-
383 grained source based routing. For further details about the Route
384 Group and source based routing, refer to the definitions and
385 descriptions of the Route Group operations found later in this
386 document.
388 o Route Record:
389 A Route Record contains the data that a resolution system returns
390 in response to a successful query for a Public Identifier. Route
391 Records are generally associated with a Route Group when the SED
392 within is not specific to a Public Identifier.
393 To support the use cases defined in [RFC6461], SPPF framework
394 defines three type of Route Records: URIType, NAPTRType, and
395 NSType. These Route Records extend the abstract type RteRecType
396 and inherit the common attribute 'priority' that is meant for
397 setting precedence across the route records defined within a Route
398 Group in a protocol agnostic fashion.
400 o Organization:
401 An Organization is an entity that may fulfill any combination of
402 three roles: Registrant, Registrar, and Peering Organization. All
403 objects in SPPF framework are associated with two organization
404 identifiers to identify each object's registrant and registrar. A
405 Route Group object is also associated with a set of zero or more
406 organization identifiers that identify the peering organization(s)
407 whose resolution query responses may include the routing
408 information (SED) defined in the Route Records within that Route
409 Group. A peering organization is an entity that the registrant
410 intends to share the SED data with.
412 3.2. Time Value
414 Some request and response messages in SPPF framework include time
415 value(s) defined as type xs:dateTime, a built-in W3C XML Schema
416 Datatype. Use of unqualified local time value is discouraged as it
417 can lead to interoperability issues. The value of time attribute
418 MUST BE expressed in Coordinated Universal Time (UTC) format without
419 the timezone digits.
421 "2010-05-30T09:30:10Z" is an example of an acceptable time value for
422 use in SPPF messages. "2010-05-30T06:30:10+3:00" is a valid UTC time,
423 but it is not approved for use in SPPF messages.
425 4. Transport Protocol Requirements
427 This section provides requirements for transport protocols suitable
428 for SPPF framework. More specifically, this section specifies the
429 services, features, and assumptions that SPPF framework delegates to
430 the chosen transport and envelope technologies.
432 4.1. Connection Oriented
434 The SPPF follows a model where a client establishes a connection to a
435 server in order to further exchange SPPF messages over such point-to-
436 point connection. A transport protocol for SPPF MUST therefore be
437 connection oriented.
439 4.2. Request and Response Model
441 Provisioning operations in SPPF follow the request-response model,
442 where a client sends a request message to initiate a transaction and
443 the server responds with a response. Multiple subsequent request-
444 response exchanges MAY be performed over a single persistent
445 connection.
447 Therefore, a transport protocol for SPPF MUST follow the request-
448 response model by allowing a response to be sent to the request
449 initiator.
451 4.3. Connection Lifetime
453 Some use cases involve provisioning a single request to a network
454 element. Connections supporting such provisioning requests might be
455 short-lived, and may be established only on demand. Other use cases
456 involve either provisioning a large dataset, or a constant stream of
457 small updates, either of which would likely require long-lived
458 connections.
460 Therefore, a protocol suitable for SPPF SHOULD be able to support
461 both short-lived as well as long-lived connections.
463 4.4. Authentication
465 All SPPF objects are associated with a registrant identifier. SPPF
466 Clients provisions SPPF objects on behalf of registrants. An
467 authenticated SPP Client is a registrar. Therefore, the SPPF
468 transport protocol MUST provide means for an SPPF server to
469 authenticate an SPPF Client.
471 4.5. Authorization
473 After successful authentication of the SPPF client as a registrar the
474 registry performs authorization checks to determine if the registrar
475 is authorized to act on behalf of the Registrant whose identifier is
476 included in the SPPF request. Refer to the Security Considerations
477 section for further guidance.
479 4.6. Confidentiality and Integrity
481 In some deployments, the SPPF objects that an SPPF registry manages
482 can be private in nature. As a result it MAY NOT be appropriate to
483 for transmission in plain text over a connection to the SPPF
484 registry. Therefore, the transport protocol SHOULD provide means for
485 end-to-end encryption between the SPPF client and server.
487 For some SPPF implementations, it may be acceptable for the data to
488 be transmitted in plain text, but the failure to detect a change in
489 data after it leaves the SPPF client and before it is received at the
490 server, either by accident or with a malicious intent, will adversely
491 affect the stability and integrity of the registry. Therefore, the
492 transport protocol SHOULD provide means for data integrity
493 protection.
495 4.7. Near Real Time
497 Many use cases require near real-time responses from the server.
498 Therefore, a DRINKS transport protocol MUST support near real-time
499 response to requests submitted by the client.
501 4.8. Request and Response Sizes
503 Use of SPPF may involve simple updates that may consist of small
504 number of bytes, such as, update of a single public identifier.
505 Other provisioning operations may constitute large number of datasets
506 as in adding millions records to a registry. As a result, a suitable
507 transport protocol for SPPF SHOULD accommodate datasets of various
508 sizes.
510 4.9. Request and Response Correlation
512 A transport protocol suitable for SPPF MUST allow responses to be
513 correlated with requests.
515 4.10. Request Acknowledgement
517 Data transported in the SPPF is likely crucial for the operation of
518 the communication network that is being provisioned. A SPPF client
519 responsible for provisioning SED to the registry has a need to know
520 if the submitted requests have been processed correctly.
522 Failed transactions can lead to situations where a subset of public
523 identifiers or even SSPs might not be reachable, or the provisioning
524 state of the network is inconsistent.
526 Therefore, a transport protocol for SPPF MUST provide a response for
527 each request, so that a client can identify whether a request
528 succeeded or failed.
530 4.11. Mandatory Transport
532 At the time of this writing, a choice of transport protocol has been
533 provided in SPP Protocol over SOAP document. To encourage
534 interoperability, the SPPF server MUST provide support for this
535 transport protocol. With time, it is possible that other transport
536 layer choices may surface that agree with the requirements discussed
537 above.
539 5. Base Framework Data Structures and Response Codes
541 SPPF contains some common data structures for most of the supported
542 object types. This section describes these common data structures.
544 5.1. Basic Object Type and Organization Identifiers
546 This section introduces the basic object type that most first class
547 objects derive from.
549 All first class objects extend the basic object type BasicObjType
550 that contains the identifier of the registrant organization that owns
551 this object, the identifier of the registrar organization that
552 created this object, the date and time that the object was created by
553 the server, and the date and time that the object was last modified.
555
556
557
558
559
561
563
565
566
568 The identifiers used for registrants (rant), registrars (rar), and
569 peering organizations (peeringOrg) are instances of OrgIdType. The
570 OrgIdType is defined as a string and all OrgIdType instances SHOULD
571 follow the textual convention: "namespace:value" (for example "iana-
572 en:32473"). See the IANA Consideration section for more details.
574 5.2. Various Object Key Types
576 5.2.1. Generic Object Key Type
578 The SPPF data model contains some object relationships. In some
579 cases these object relationships are established by embedding the
580 unique identity of the related object inside the relating object. In
581 addition, an object's unique identity is required to Delete or Get
582 the details of an object. The abstract type called ObjKeyType is
583 where this unique identity is housed. Because this object key type
584 is abstract, it MUST be specified in a concrete form in any
585 conforming SPPF transport protocol specification.
587 Most objects in SPPF are uniquely identified by an object key that
588 has the object's name, object's type and its registrant's
589 organization ID as its attributes. Consequently, any concrete
590 representation of the ObjKeyType MUST contain the following:
592 Object Name: The name of the object.
594 Registrant Id: The unique organization ID that identifies the
595 Registrant.
597 Type: The enumeration value that represents the type of SPPF
598 object that. This is required as different types of objects in
599 SPPF, that belong to the same registrant, can have the same name.
601 The structure of abstract ObjKeyType is as follows:
603
604
605
606 ---- Generic type that represents the
607 key for various objects in SPPP. ----
608
609
610
612 The object types in SPPF that MUST adhere to this definition of
613 generic object key are defined as an enumeration in the XML data
614 structure. The structure of the the enumeration is as follows:
616
617
618
619
620
621
622
623
625 5.2.2. Derived Object Key Types
627 The SPPF data model contains certain objects that are uniquely
628 identified by attributes, different from or in addition to, the
629 attributes in the generic object key described in previous section.
630 These kind of object keys are derived from the abstract ObjKeyType
631 and defined in there own abstract key types. Because these object
632 key types are abstract, these MUST be specified in a concrete form in
633 any conforming SPPF "transport" specification. These are used in
634 Delete and Get operations, and may also be used in Accept and Reject
635 operations.
637 Following are the derived object keys in SPPF data model:
639 o RteGrpOfferKeyType: This uniquely identifies a Route Group
640 object offer. This key type extends from ObjKeyType and MUST
641 also have the organization ID of the Registrant to whom the
642 object is being offered, as one of its attributes. In addition
643 to the Delete and Get operations, these key types are used in
644 Accept and Reject operations on a Route Group Offer object. The
645 structure of abstract RteGrpOfferKeyType is as follows:
647
649
650
651
652
653 ---- Generic type that represents the
654 key for a object offer. ----
655
656
657
658
659
661 A Route Group Offer object MUST use RteGrpOfferKeyType. Refer
662 the "Framework Data Model Objects" section of this document for
663 description of Route Group Offer object.
665 o PubIdKeyType: This uniquely identifies a Public Identity object.
666 This key type extends from abstract ObjKeyType. Any concrete
667 defintion of PubIdKeyType MUST contain the elements that
668 identify the value and type of Public Identity and also contain
669 the organization ID of the Registrant that is the owner of the
670 Public Identity object. A Public Identity object key in SPPF is
671 uniquely identified by the the registrant's organization ID, the
672 value of the public identity, and, optionally, the Destination
673 Group name the public identiy belongs to. Consequently, any
674 concrete representation of the PubIdKeyType MUST contain the
675 following attributes:
677 * Registrant Id: The unique organization ID that identifies
678 the Registrant.
680 * Destination Group name: The name of the Destination Group
681 the Public Identity is associated with. This is an
682 optional attribute.
684 * Type: The type of Public Identity.
686 * Value: The value of the Public Identity.
688 The .PubIdKeyType is used in Delete and Get operations on a
689 Public Identifier object.
691 o The structure of abstract PubIdKeyType is as follows:
693
694
695
696
697
698 ---- Generic type that represents
699 the key for a Pub Id. ----
700
701
702
703
704
706 A Public Identity object MUST use attributes of PubIdKeyType for its
707 unique identification . Refer the "Framework Data Model Objects"
708 section of this document for a description of Public Identity object.
710 5.3. Response Message Types
712 This section contains the listing of response types that MUST be
713 defined by the conforming "transport" specification and implemented
714 by a conforming SPPF server.
716 +---------------------+---------------------------------------------+
717 | Response Type | Description |
718 +---------------------+---------------------------------------------+
719 | Request Succeeded | Any conforming specification MUST define a |
720 | | response to indicate that a given request |
721 | | succeeded. |
722 | | |
723 | Request syntax | Any conforming specification MUST define a |
724 | invalid | response to indicate that a syntax of a |
725 | | given request was found invalid. |
726 | | |
727 | Request too large | Any conforming specification MUST define a |
728 | | response to indicate that the count of |
729 | | entities in the request is larger than the |
730 | | server is willing or able to process. |
731 | | |
732 | Version not | Any conforming specification MUST define a |
733 | supported | response to indicate that the server does |
734 | | not support the version of the SPPF |
735 | | protocol specified in the request. |
736 | | |
737 | Command invalid | Any conforming specification MUST define a |
738 | | response to indicate that the operation |
739 | | and/or command being requested by the |
740 | | client is invalid and/or not supported by |
741 | | the server. |
742 | | |
743 | System temporarily | Any conforming specification MUST define a |
744 | unavailable | response to indicate that the SPPF server |
745 | | is temporarily not available to serve |
746 | | client request. |
747 | | |
748 | Unexpected internal | Any conforming specification MUST define a |
749 | system or server | response to indicate that the SPPF server |
750 | error. | encountered an unexpected error that |
751 | | prevented the server from fulfilling the |
752 | | request. |
753 | | |
754 | Attribute value | Any conforming specification MUST define a |
755 | invalid | response to indicate that the SPPF server |
756 | | encountered an attribute or property in the |
757 | | request that had an invalid/bad value. |
758 | | Optionally, the specification MAY provide a |
759 | | way to indicate the Attribute Name and the |
760 | | Attribute Value to identify the object that |
761 | | was found to be invalid. |
762 | | |
763 | Object does not | Any conforming specification MUST define a |
764 | exist | response to indicate that an object present |
765 | | in the request does not exist on the SPPF |
766 | | server. Optionally, the specification MAY |
767 | | provide a way to indicate the Attribute |
768 | | Name and the Attribute Value that |
769 | | identifies the non-existent object. |
770 | | |
771 | Object status or | Any conforming specification MUST define a |
772 | ownership does not | response to indicate that the operation |
773 | allow for | requested on an object present in the |
774 | operation. | request cannot be performed because the |
775 | | object is in a status that does not allow |
776 | | the said operation or the user requesting |
777 | | the operation is not authorized to perform |
778 | | the said operation on the object. |
779 | | Optionally, the specification MAY provide a |
780 | | way to indicate the Attribute Name and the |
781 | | Attribute Value that identifies the object. |
782 +---------------------+---------------------------------------------+
784 Table 1: Response Types
786 When the response messages are "parameterized" with the Attribute
787 Name and Attribute Value, then the use of these parameters MUST
788 adhere to the following rules:
790 o Any value provided for the Attribute Name parameter MUST be an
791 exact XSD element name of the protocol data element that the
792 response message is referring to. For example, valid values for
793 "attribute name" are "dgName", "rgName", "rteRec", etc.
795 o The value for Attribute Value MUST be the value of the data
796 element to which the preceding Attribute Name refers.
798 o Response type "Attribute value invalid" SHOULD be used whenever
799 an element value does not adhere to data validation rules.
801 o Response types "Attribute value invalid" and "Object does not
802 exist" MUST NOT be used interchangeably. Response type "Object
803 does not exist" SHOULD be returned by an Add/Del/Accept/Reject
804 operation when the data element(s) used to uniquely identify a
805 pre-existing object do not exist. If the data elements used to
806 uniquely identify an object are malformed, then response type
807 "Attribute value invalid" SHOULD be returned.
809 6. Framework Data Model Objects
811 This section provides a description of the specification of each
812 supported data model object (the nouns) and identifies the commands
813 (the verbs) that MUST be supported for each data model object.
814 However, the specification of the data structures necessary to
815 support each command is delegated to the "transport" specification.
817 6.1. Destination Group
819 As described in the introductory sections, a Destination Group
820 represents a set of Public Identifiers with common routing
821 information. The transport protocol MUST support the ability to
822 Create, Modify, Get, and Delete Destination Groups (refer the
823 "Framework Operations" section of this document for a generic
824 description of various operations).
826 A Destination Group object MUST be uniquely identified by attributes
827 as defined in the description of "ObjKeyType" in the section "Generic
828 Object Key Type" of this document.
830 The DestGrpType object structure is defined as follows:
832
833
834
835
836
837
838
839
840
842 The DestGrpType object is composed of the following elements:
844 o base: All first class objects extend BasicObjType that contains
845 the ID of the registrant organization that owns this object,
846 registrar organization that provisioned this object on behalf of
847 the registrant, the date and time that the object was created by
848 the server, and the date and time that the object was last
849 modified. If the client passed in either the created date or
850 the modification date, the server will ignore them. The server
851 sets these two date/time values.
853 o dgName: The character string that contains the name of the
854 Destination Group.
856 o ext: Point of extensibility described in a previous section of
857 this document.
859 6.2. Public Identifier
861 A Public Identifier is the search key used for locating the session
862 establishment data (SED). In many cases, a Public Identifier is
863 attributed to the end user who has a retail relationship with the
864 service provider or registrant organization. SPPF supports the
865 notion of the carrier-of-record as defined in [RFC5067]. Therefore,
866 the registrant under whom the Public Identity is being created can
867 optionally claim to be a carrier-of-record.
869 SPPF identifies two types of Public Identifiers: telephone numbers
870 (TN), and the routing numbers (RN). SPPF provides structures to
871 manage a single TN, a contiguous range of TNs, and a TN prefix. The
872 transport protocol MUST support the ability to Create, Modify, Get,
873 and Delete Public Identifiers (refer the "Framework Operations"
874 section of this document for a generic description of various
875 operations).
877 A Public Identity object MUST be uniquely identified by attributes as
878 defined in the description of "PubIdKeyType" in the section "Derived
879 Object Key Types" of this document.
881 The abstract XML schema type definition PubIDType is a generalization
882 for the concrete the Public Identifier schema types. PubIDType
883 element 'dgName' represents the name of the destination group that a
884 given Public Identifier MAY be a member of. The PubIDType object
885 structure is defined as follows:
887
888
889
890
891
893
894
895
896
898 A Public Identifier may be provisioned as a member of a Destination
899 Group or provisioned outside of a Destination Group. A Public
900 Identifier that is provisioned as a member of a Destination Group is
901 intended to be associated with its SED through the Route Group(s)
902 that are associated with its containing Destination Group. A Public
903 Identifier that is not provisioned as a member of a Destination Group
904 is intended to be associated with its SED through the Route Records
905 that are directly associated with the Public Identifier.
907 A telephone number is provisioned using the TNType, an extension of
908 PubIDType. When a Public Identifier is provisioned as a member of a
909 Destination Group, each TNType object is uniquely identified by the
910 combination of its value contained within element, and the
911 unique key of its parent Destination Group (dgName and rantId). In
912 other words a given telephone number string may exist within one or
913 more Destination Groups, but must not exist more than once within a
914 Destination Group. A Public Identifier that is not provisioned as a
915 member of a Destination Group is uniquely identified by the
916 combination of its value, and its registrant ID. TNType is defined
917 as follows:
919
920
921
922
923
925
927
930
931
932
933
935
936
937
938
939
940
942 TNType consists of the following attributes:
944 o tn: Telephone number to be added to the registry.
946 o rrRef: Optional reference to route records that are directly
947 associated with the TN Public Identifier. Following the SPPF
948 data model, the route record could be a protocol agnostic
949 URIType or another type.
951 o corInfo: corInfo is an optional parameter of type CORInfoType
952 that allows the registrant organization to set forth a claim to
953 be the carrier-of-record (see [RFC5067]). This is done by
954 setting the value of element of the CORInfoType
955 object structure to "true". The other two parameters of the
956 CORInfoType, and are set by the registry to
957 describe the outcome of the carrier-of-record claim by the
958 registrant. In general, inclusion of parameter is
959 useful if the registry has the authority information, such as,
960 the number portability data, etc., in order to qualify whether
961 the registrant claim can be satisfied. If the carrier-of-record
962 claim disagrees with the authority data in the registry, whether
963 the TN add operation fails or not is a matter of policy and it
964 is beyond the scope of this document.
966 A routing number is provisioned using the RNType, an extension of
967 PubIDType. SSPs that possess the number portability data may be able
968 to leverage the RN search key to discover the ingress routes for
969 session establishment. Therefore, the registrant organization can
970 add the RN and associate it with the appropriate destination group to
971 share the route information. Each RNType object is uniquely
972 identified by the combination of its value inside the element,
973 and the unique key of its parent Destination Group (dgName and
974 rantId). In other words a given routing number string may exist
975 within one or more Destination Groups, but must not exist more than
976 once within a Destination Group. RNType is defined as follows:
978
979
980
981
982
984
986
987
988
989
991 RNType has the following attributes:
993 o rn: Routing Number used as the search key.
995 o corInfo: Optional element of type CORInfoType.
997 TNRType structure is used to provision a contiguous range of
998 telephone numbers. The object definition requires a starting TN and
999 an ending TN that together define the span of the TN range. Use of
1000 TNRType is particularly useful when expressing a TN range that does
1001 not include all the TNs within a TN block or prefix. The TNRType
1002 definition accommodates the open number plan as well such that the
1003 TNs that fall between the start and end TN range may include TNs with
1004 different length variance. Whether the registry can accommodate the
1005 open number plan semantics is a matter of policy and is beyond the
1006 scope of this document. Each TNRType object is uniquely identified
1007 by the combination of its value that in turn is a combination of the
1008 and elements, and the unique key of its parent
1009 Destination Group (dgName and rantId). In other words a given TN
1010 Range may exist within one or more Destination Groups, but must not
1011 exist more than once within a Destination Group. TNRType object
1012 structure definition is as follows:
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1025
1026
1027
1028
1029
1030
1032 TNRType has the following attributes:
1034 o startTn: Starting TN in the TN range
1036 o endTn: The last TN in the TN range
1038 o corInfo: Optional element of type CORInfoType
1040 In some cases, it is useful to describe a set of TNs with the help of
1041 the first few digits of the telephone number, also referred to as the
1042 telephone number prefix or a block. A given TN prefix may include
1043 TNs with different length variance in support of open number plan.
1044 Once again, whether the registry supports the open number plan
1045 semantics is a matter of policy and it is beyond the scope of this
1046 document. The TNPType data structure is used to provision a TN
1047 prefix. Each TNPType object is uniquely identified by the
1048 combination of its value in the element, and the unique
1049 key of its parent Destination Group (dgName and rantId). TNPType is
1050 defined as follows:
1052
1053
1054
1055
1056
1058
1060
1061
1062
1063
1065 TNPType consists of the following attributes:
1067 o tnPrefix: The telephone number prefix
1069 o corInfo: Optional element of type CORInfoType.
1071 6.3. Route Group
1073 As described in the introductory sections, a Route Group represents a
1074 combined grouping of Route Records that define route information,
1075 Destination Groups that contain a set of Public Identifiers with
1076 common routing information, and the list of peer organizations that
1077 have access to these public identifiers using this route information.
1078 It is this indirect linking of public identifiers to their route
1079 information that significantly improves the scalability and
1080 manageability of the peering data. Additions and changes to routing
1081 information are reduced to a single operation on a Route Group or
1082 Route Record , rather than millions of data updates to individual
1083 public identifier records that individually contain their peering
1084 data. The transport protocol MUST support the ability to Create,
1085 Modify, Get, and Delete Route Groups (refer the "Framework
1086 Operations" section of this document for a generic description of
1087 various operations).
1089 A Route Group object MUST be uniquely identified by attributes as
1090 defined in the description of "ObjKeyType" in the section "Generic
1091 Object Key Type" of this document.
1093 The RteGrpType object structure is defined as follows:
1095
1096
1097
1098
1099
1100
1102
1104
1106
1109
1110
1111
1113
1114
1115
1116
1118
1119
1120
1121
1122
1124
1125
1127 The RteGrpType object is composed of the following elements:
1129 o base: All first class objects extend BasicObjType that contains
1130 the ID of the registrant organization that owns this object, the
1131 date and time that the object was created by the server, and the
1132 date and time that the object was last modified. If the client
1133 passes in either the created date or the modification date, the
1134 server will ignore them. The server sets these two date/time
1135 values.
1137 o rgName: The character string that contains the name of the Route
1138 Group. It uniquely identifies this object within the context of
1139 the registrant ID (a child element of the base element as
1140 described above).
1142 o rrRef: Set of zero or more objects of type RteRecRefType that
1143 house the unique keys of the Route Records that the RteGrpType
1144 object refers to and their relative priority within the context
1145 of a given route group. The associated Route Records contain
1146 the routing information, sometimes called SED, associated with
1147 this Route Group.
1149 o dgName: Set of zero or more names of DestGrpType object
1150 instances. Each dgName name, in association with this Route
1151 Group's registrant ID, uniquely identifies a DestGrpType object
1152 instance whose public identifiers are reachable using the
1153 routing information housed in this Route Group. An intended
1154 side affect of this is that a Route Group cannot provide routing
1155 information for a Destination Group belonging to another
1156 registrant.
1158 o peeringOrg: Set of zero or more peering organization IDs that
1159 have accepted an offer to receive this Route Group's
1160 information. The set of peering organizations in this list is
1161 not directly settable or modifiable using the addRteGrpsRqst
1162 operation. This set is instead controlled using the route offer
1163 and accept operations.
1165 o sourceIdent: Set of zero or more SourceIdentType object
1166 instances. These objects, described further below, house the
1167 source identification schemes and identifiers that are applied
1168 at resolution time as part of source based routing algorithms
1169 for the Route Group.
1171 o isInSvc: A boolean element that defines whether this Route Group
1172 is in service. The routing information contained in a Route
1173 Group that is in service is a candidate for inclusion in
1174 resolution responses for public identities residing in the
1175 Destination Group associated with this Route Group. The routing
1176 information contained in a Route Group that is not in service is
1177 not a candidate for inclusion in resolution responses.
1179 o priority: Zero or one priority value that can be used to provide
1180 a relative value weighting of one Route Group over another. The
1181 manner in which this value is used, perhaps in conjunction with
1182 other factors, is a matter of policy.
1184 o ext: Point of extensibility described in a previous section of
1185 this document.
1187 As described above, the Route Group contains a set of references to
1188 route record objects. A route record object is based on an abstract
1189 type: RteRecType. The concrete types that use RteRecType as an
1190 extension base are NAPTRType, NSType, and URIType. The definitions
1191 of these types are included the Route Record section of this
1192 document.
1194 The RteGrpType object provides support for source-based routing via
1195 the peeringOrg data element and more granular source base routing via
1196 the source identity element. The source identity element provides
1197 the ability to specify zero or more of the following in association
1198 with a given Route Group: a regular expression that is matched
1199 against the resolution client IP address, a regular expression that
1200 is matched against the root domain name(s), and/or a regular
1201 expression that is matched against the calling party URI(s). The
1202 result will be that, after identifying the visible Route Groups whose
1203 associated Destination Group(s) contain the lookup key being queried
1204 and whose peeringOrg list contains the querying organizations
1205 organization ID, the resolution server will evaluate the
1206 characteristics of the Source URI, and Source IP address, and root
1207 domain of the lookup key being queried. The resolution server then
1208 compares these criteria against the source identity criteria
1209 associated with the Route Groups. The routing information contained
1210 in Route Groups that have source based routing criteria will only be
1211 included in the resolution response if one or more of the criteria
1212 matches the source criteria from the resolution request. The Source
1213 Identity data element is of type SourceIdentType, whose structure is
1214 defined as follows:
1216
1217
1218
1219
1221
1223
1224
1226
1227
1228
1229
1230
1231
1232
1234 The SourceIdentType object is composed of the following data
1235 elements:
1237 o sourceIdentScheme: The source identification scheme that this
1238 source identification criteria applies to and that the
1239 associated sourceIdentRegex should be matched against.
1241 o sourceIdentRegex: The regular expression that should be used to
1242 test for a match against the portion of the resolution request
1243 that is dictated by the associated sourceIdentScheme.
1245 o ext: Point of extensibility described in a previous section of
1246 this document.
1248 6.4. Route Record
1250 As described in the introductory sections, a Route Group represents a
1251 combined grouping of Route Records that define route information.
1252 However, Route Records need not be created to just serve a single
1253 Route Group. Route Records can be created and managed to serve
1254 multiple Route Groups. As a result, a change to the properties of a
1255 network node used for multiple routes, would necessitate just a
1256 single update operation to change the properties of that node. The
1257 change would then be reflected in all the Route Groups whose route
1258 record set contains a reference to that node. The transport protocol
1259 MUST support the ability to Create, Modify, Get, and Delete Route
1260 Records (refer the "Framework Operations" section of this document
1261 for a generic description of various operations).
1263 A Route Record object MUST be uniquely identified by attributes as
1264 defined in the description of "ObjKeyType" in the section "Generic
1265 Object Key Type" of this document.
1267 The RteRecType object structure is defined as follows:
1269
1270
1271
1272
1273
1274
1276
1277
1278
1279
1281 The RteRecType object is composed of the following elements:
1283 o base: All first class objects extend BasicObjType that contains
1284 the ID of the registrant organization that owns this object, the
1285 date and time that the object was created by the server, and the
1286 date and time that the object was last modified. If the client
1287 passes in either the created date or the modification date, the
1288 server will ignore them. The server sets these two date/time
1289 values.
1291 o rrName: The character string that contains the name of the Route
1292 Record. It uniquely identifies this object within the context
1293 of the registrant ID (a child element of the base element as
1294 described above).
1296 o priority: Zero or one priority value that can be used to provide
1297 a relative value weighting of one Route Record over another.
1298 The manner in which this value is used, perhaps in conjunction
1299 with other factors, is a matter of policy.
1301 As described above, route records are based on an abstract type:
1302 RteRecType. The concrete types that use RteRecType as an extension
1303 base are NAPTRType, NSType, and URIType. The definitions of these
1304 types are included below. The NAPTRType object is comprised of the
1305 data elements necessary for a NAPTR that contains routing information
1306 for a Route Group. The NSType object is comprised of the data
1307 elements necessary for a DNS name server that points to another DNS
1308 server that contains the desired routing information. The NSType is
1309 relevant only when the resolution protocol is ENUM. The URIType
1310 object is comprised of the data elements necessary to house a URI.
1312 The data provisioned in a registry can be leveraged for many purposes
1313 and queried using various protocols including SIP, ENUM and others.
1314 It is for this reason that a route record type offers a choice of URI
1315 and DNS resource record types. URIType fulfills the need for both
1316 SIP and ENUM protocols. When a given URIType is associated to a
1317 destination group, the user part of the replacement string that
1318 may require the Public Identifier cannot be preset. As a SIP
1319 Redirect, the resolution server will apply pattern on the input
1320 Public Identifier in the query and process the replacement string by
1321 substituting any back reference(s) in the to arrive at the
1322 final URI that is returned in the SIP Contact header. For an ENUM
1323 query, the resolution server will simply return the value of the
1324 and members of the URIType in the NAPTR REGEX parameter.
1326
1327
1328
1329
1330
1331
1333
1334
1336
1338
1340
1342
1343
1344
1345
1347
1348
1349
1350
1351
1352
1354
1356
1358
1360
1361
1362
1364
1365
1366
1367
1369
1370
1372
1374
1375
1376
1377
1378
1379
1381
1382
1383
1384
1385
1387
1388
1390
1391
1392
1393
1395
1396
1397
1398
1399
1400
1402 The NAPTRType object is composed of the following elements:
1404 o order: Order value in an ENUM NAPTR, relative to other NAPTRType
1405 objects in the same Route Group.
1407 o svcs: ENUM service(s) that are served by the SBE. This field's
1408 value must be of the form specified in [RFC6116] (e.g., E2U+
1409 pstn:sip+sip). The allowable values are a matter of policy and
1410 not limited by this protocol.
1412 o regx: NAPTR's regular expression field. If this is not included
1413 then the Repl field must be included.
1415 o repl: NAPTR replacement field, should only be provided if the
1416 Regex field is not provided, otherwise the server will ignore it
1418 o ttl: Number of seconds that an addressing server may cache this
1419 NAPTR.
1421 o ext: Point of extensibility described in a previous section of
1422 this document.
1424 The NSType object is composed of the following elements:
1426 o hostName: Fully qualified host name of the name server.
1428 o ipAddr: Zero or more objects of type IpAddrType. Each object
1429 holds an IP Address and the IP Address type, IPv4 or IP v6.
1431 o ttl: Number of seconds that an addressing server may cache this
1432 DNS name server.
1434 o ext: Point of extensibility described in a previous section of
1435 this document.
1437 The URIType object is composed of the following elements:
1439 o ere: The POSIX Extended Regular Expression (ere) as defined in
1440 [RFC3986].
1442 o uri: the URI as defined in [RFC3986]. In some cases, this will
1443 serve as the replacement string and it will be left to the
1444 resolution server to arrive at the final usable URI.
1446 6.5. Route Group Offer
1448 The list of peer organizations whose resolution responses can include
1449 the routing information contained in a given Route Group is
1450 controlled by the organization to which a Route Group object belongs
1451 (its registrant), and the peer organization that submits resolution
1452 requests (a data recipient, also know as a peering organization).
1453 The registrant offers access to a Route Group by submitting a Route
1454 Group Offer. The data recipient can then accept or reject that
1455 offer. Not until access to a Route Group has been offered and
1456 accepted will the data recipient's organization ID be included in the
1457 peeringOrg list in a Route Group object, and that Route Group's
1458 peering information become a candidate for inclusion in the responses
1459 to the resolution requests submitted by that data recipient. The
1460 transport protocol MUST support the ability to Create, Modify, Get,
1461 Delete, Accept and Reject Route Group Offers (refer the "Framework
1462 Operations" section of this document for a generic description of
1463 various operations).
1465 A Route Group Offer object MUST be uniquely identified by attributes
1466 as defined in the description of "RteGrpOfferKeyType" in the section
1467 "Derived Object Key Types" of this document.
1469 The RteGrpOfferType object structure is defined as follows:
1471
1472
1473
1474
1475
1477
1479
1480
1482
1484
1485
1486
1487
1489
1490
1491
1492 -- Generic type that represents the key for a route
1493 route group offer. Must be defined in concrete form
1494 in the transport specificaiton. --
1495
1496
1497
1499
1500
1501
1502
1503
1504
1506 The RteGrpOfferType object is composed of the following elements:
1508 o base: All first class objects extend BasicObjType that contains
1509 the ID of the registrant organization that owns this object, the
1510 date and time that the object was created by the server, and the
1511 date and time that the object was last modified. If the client
1512 passed in either the created date or the modification date, the
1513 will ignore them. The server sets these two date/time values.
1515 o rteGrpOfferKey: The object that identifies the route that is or
1516 has been offered and the organization that it is or has been
1517 offered to.
1519 o status: The status of the offer, offered or accepted. The
1520 server controls the status. It is automatically set to
1521 "offered" when ever a new Route Group Offer is added, and is
1522 automatically set to "accepted" if and when that offer is
1523 accepted. The value of the element is ignored when passed in by
1524 the client.
1526 o offerDateTime: Date and time in UTC when the Route Group Offer
1527 was added.
1529 o acceptDateTime: Date and time in UTC when the Route Group Offer
1530 was accepted.
1532 6.6. Egress Route
1534 In a high-availability environment, the originating SSP likely has
1535 more than one egress paths to the ingress SBE of the target SSP. If
1536 the originating SSP wants to exercise greater control and choose a
1537 specific egress SBE to be associated to the target ingress SBE, it
1538 can do so using the EgrRteType object.
1540 A Egress Route object MUST be uniquely identified by attributes as
1541 defined in the description of "ObjKeyType" in the section "Generic
1542 Object Key Type" of this document.
1544 Lets assume that the target SSP has offered to share one or more
1545 ingress route information and that the originating SSP has accepted
1546 the offer. In order to add the egress route to the registry, the
1547 originating SSP uses a valid regular expression to rewrite ingress
1548 route in order to include the egress SBE information. Also, more
1549 than one egress route can be associated with a given ingress route in
1550 support of fault-tolerant configurations. The supporting SPPF
1551 structure provides a way to include route precedence information to
1552 help manage traffic to more than one outbound egress SBE.
1554 The transport protocol MUST support the ability to Add, Modify, Get,
1555 and Delete Egress Routes (refer the "Framework Operations" section of
1556 this document for a generic description of various operations). The
1557 EgrRteType object structure is defined as follows:
1559
1560
1561
1562
1563
1564
1565
1567
1569
1571
1572
1573
1574
1576 The EgrRteType object is composed of the following elements:
1578 o base: All first class objects extend BasicObjType that contains
1579 the ID of the registrant organization that owns this object, the
1580 date and time that the object was created by the server, and the
1581 date and time that the object was last modified. If the client
1582 passes in either the created date or the modification date, the
1583 server will ignore them. The server sets these two date/time
1584 values.
1586 o egrRteName: The name of the egress route.
1588 o pref: The preference of this egress route relative to other
1589 egress routes that may get selected when responding to a
1590 resolution request.
1592 o regxRewriteRule: The regular expression re-write rule that
1593 should be applied to the regular expression of the ingress
1594 NAPTR(s) that belong to the ingress route.
1596 o ingrRteRec: The ingress route records that the egress route
1597 should be used for.
1599 o ext: Point of extensibility described in a previous section of
1600 this document.
1602 7. Framework Operations
1604 7.1. Add Operation
1606 Any conforming "transport" specification MUST provide a definition
1607 for the operation that adds one or more SPPF objects into the
1608 registry. If the object, as identified by the request attributes
1609 that form part of the object's key, does not exist, then the registry
1610 MUST create the object. If the object does exist, then the registry
1611 MUST replace the current properties of the object with the properties
1612 passed in as part of the Add operation.
1614 If the entity that issued the command is not authorized to perform
1615 this operation an appropriate error message MUST be returned from
1616 amongst the response messages defined in "Response Message Types"
1617 section of the document.
1619 7.2. Delete Operation
1621 Any conforming "transport" specification MUST provide a definition
1622 for the operation that deletes one or more SPPF objects from the
1623 registry using the object's key.
1625 If the entity that issued the command is not authorized to perform
1626 this operation an appropriate error message MUST be returned from
1627 amongst the response messages defined in "Response Message Types"
1628 section of the document.
1630 When an object is deleted, any references to that object must of
1631 course also be removed as the SPPF server implementation fulfills the
1632 deletion request. Furthermore, the deletion of a composite object
1633 must also result in the deletion of the objects it contains. As a
1634 result, the following rules apply to the deletion of SPPF object
1635 types:
1637 o Destination Groups: When a destination group is deleted all
1638 public identifiers within that destination group must also be
1639 automatically deleted by the SPPF implementation as part of
1640 fulfilling the deletion request. And any references between
1641 that destination group and any route group must be automatically
1642 removed by the SPPF implementation as part of fulfilling the
1643 deletion request.
1645 o Route Groups: When a route group is deleted any references
1646 between that route group and any destination group must be
1647 automatically removed by the SPPF implementation as part of
1648 fulfilling the deletion request. Similarly any references
1649 between that route group and any route records must be removed
1650 by the SPPF implementation as part of fulfilling the deletion
1651 request. Furthermore, route group offers relating that route
1652 group must also be deleted as part of fulfilling the deletion
1653 request.
1655 o Route Records: When a route record is deleted any references
1656 between that route record and any route group must be removed by
1657 the SPPF implementation as part of fulfilling the deletion
1658 request.
1660 o Public Identifiers: When a public identifier is deleted any
1661 references between that public identifier and its containing
1662 destination group must be removed by the SPPF implementation as
1663 part of fulfilling the deletion request. And any route records
1664 contained directly within that Public Identifier must be deleted
1665 by the SPPF implementation as part of fulfilling the deletion
1666 request.
1668 7.3. Get Operations
1670 At times, on behalf of the registrant, the registrar may need to have
1671 access to SPPF objects that were previously provisioned in the
1672 registry. A few examples include logging, auditing, and pre-
1673 provisioning dependency checking. This query mechanism is limited to
1674 aid provisioning scenarios and should not be confused with query
1675 protocols provided as part of the resolution system (e.g. ENUM and
1676 SIP). Any conforming "transport" specification MUST provide a
1677 definition for the operation that queries the details of one or more
1678 SPPF objects from the registry using the object's key. If the entity
1679 that issued the command is not authorized to perform this operation
1680 an appropriate error message MUST be returned from amongst the
1681 response messages defined in "Response Message Types" section of the
1682 document.
1684 7.4. Accept Operations
1686 In SPPF, a Route Group Offer can be accepted or rejected by, or on
1687 behalf of, the registrant to whom the Route Group has been offered
1688 (refer "Framework Data Model Objects" section of this document for a
1689 description of the Route Group Offer object). The Accept operation
1690 is used to accept the Route Group Offers. Any conforming "transport"
1691 specification MUST provide a definition for the operation to accept
1692 Route Group Offers by, or on behalf of the Registrant, using the
1693 Route Group Offer object key.
1695 Not until access to a Route Group has been offered and accepted will
1696 the registrant's organization ID be included in the peeringOrg list
1697 in that Route Group object, and that Route Group's peering
1698 information become a candidate for inclusion in the responses to the
1699 resolution requests submitted by that registrant. A Route Group
1700 Offer that is in the "offered" status is accepted by, or on behalf
1701 of, the registrant to which it has been offered. When the Route
1702 Group Offer is accepted the the Route Group Offer is moved to the
1703 "accepted" status and adds that data recipient's organization ID into
1704 the list of peerOrgIds for that Route Group.
1706 If the entity that issued the command is not authorized to perform
1707 this operation an appropriate error message MUST be returned from
1708 amongst the response messages defined in "Response Message Types"
1709 section of the document.
1711 7.5. Reject Operations
1713 In SPPF, a Route Group Offer object can be accepted or rejected by,
1714 or on behalf of, the registrant to whom the Route Group has been
1715 offered (refer "Framework Data Model Objects" section of this
1716 document for a description of the Route Group Offer object).
1717 Furthermore, that offer may be rejected, regardless of whether or not
1718 it has been previously accepted. The Reject operation is used to
1719 reject the Route Group Offers. When the Route Group Offer is
1720 rejected that Route Group Offer is deleted, and, if appropriate, the
1721 data recipient's organization ID is removed from the list of
1722 peeringOrg IDs for that Route Group. Any conforming "transport"
1723 specification MUST provide a definition for the operation to reject
1724 Route Group Offers by, or on behalf of the Registrant, using the
1725 Route Group Offer object key.
1727 If the entity that issued the command is not authorized to perform
1728 this operation an appropriate error message MUST be returned from
1729 amongst the response messages defined in "Response Message Types"
1730 section of the document.
1732 7.6. Get Server Details Operation
1734 In SPPF, Get Server Details operation can be used to request certain
1735 details about the SPPF server that include the SPPF server's current
1736 status, the major/minor version of the SPPF protocol supported by the
1737 SPPF server.
1739 Any conforming "transport" specification MUST provide a definition
1740 for the operation to request such details from the SPPF server. If
1741 the entity that issued the command is not authorized to perform this
1742 operation an appropriate error message MUST be returned from amongst
1743 the response messages defined in "Response Message Types" section of
1744 the document.
1746 8. XML Considerations
1748 XML serves as the encoding format for SPPF, allowing complex
1749 hierarchical data to be expressed in a text format that can be read,
1750 saved, and manipulated with both traditional text tools and tools
1751 specific to XML.
1753 XML is case sensitive. Unless stated otherwise, XML specifications
1754 and examples provided in this document MUST be interpreted in the
1755 character case presented to develop a conforming implementation.
1757 This section discusses a small number of XML-related considerations
1758 pertaining to SPPP.
1760 8.1. Namespaces
1762 All SPPF elements are defined in the namespaces in the IANA
1763 Considerations section and in the Formal Framework Specification
1764 section of this document.
1766 8.2. Versioning and Character Encoding
1768 All XML instances SHOULD begin with an declaration to
1769 identify the version of XML that is being used, optionally identify
1770 use of the character encoding used, and optionally provide a hint to
1771 an XML parser that an external schema file is needed to validate the
1772 XML instance.
1774 Conformant XML parsers recognize both UTF-8 (defined in [RFC3629])
1775 and UTF-16 (defined in [RFC2781]); per [RFC2277] UTF-8 is the
1776 RECOMMENDED character encoding for use with SPPP.
1778 Character encodings other than UTF-8 and UTF-16 are allowed by XML.
1779 UTF-8 is the default encoding assumed by XML in the absence of an
1780 "encoding" attribute or a byte order mark (BOM); thus, the "encoding"
1781 attribute in the XML declaration is OPTIONAL if UTF-8 encoding is
1782 used. SPPF clients and servers MUST accept a UTF-8 BOM if present,
1783 though emitting a UTF-8 BOM is NOT RECOMMENDED.
1785 Example XML declarations:
1787
1789 9. Security Considerations
1791 Many SPPF implementations manage data that is considered confidential
1792 and critical. Furthermore, SPPF implementations can support
1793 provisioning activities for multiple registrars and registrants. As
1794 a result any SPPF implementation must address the requirements for
1795 confidentiality, authentication, and authorization.
1797 With respect to confidentiality and authentication, the transport
1798 protocol requirements section of this document contains security
1799 properties that the transport protocol must provide so that
1800 authenticated endpoints can exchange data confidentially and with
1801 integrity protection. Refer to that section and the resulting
1802 transport protocol specification document for the specific solutions
1803 to authentication and confidentiality.
1805 With respect to authorization, the SPPF server implementation must
1806 define and implement a set of authorization rules that precisely
1807 address (1) which registrars will be authorized to create/modify/
1808 delete each SPPF object type for given registrant(s) and (2) which
1809 registrars will be authorized to view/get each SPPF object type for
1810 given registrant(s). These authorization rules are a matter of
1811 policy and are not specified within the context of SPPP. However,
1812 any SPPF implementation must specify these authorization rules in
1813 order to function in a reliable and safe manner.
1815 In some situations, it may be required to protect against denial of
1816 involvement (see [RFC4949]) and tackle non-repudiation concerns in
1817 regards to SPPF messages. This type of protection is useful to
1818 satisfy authenticity concerns related to SPPF messages beyond the
1819 end-to-end connection integrity, confidentiality, and authentication
1820 protection that the transport layer provides. This is an optional
1821 feature and some SPPF implementations MAY provide support for it.
1823 It is not uncommon for the logging systems to document on-the-wire
1824 messages for various purposes, such as, debug, audit, and tracking.
1825 At the minimum, the various support and administration staff will
1826 have access to these logs. Also, if an unprivileged user gains
1827 access to the SPPF deployments and/or support systems, it will have
1828 access to the information that is potentially deemed confidential.
1829 To manage information disclosure concerns beyond the transport level,
1830 SPPF implementations MAY provide support for encryption at the SPPF
1831 object level.
1833 Anti-replay protection ensures that a given SPPF object replayed at a
1834 later time doesn't affect the integrity of the system. SPPF provides
1835 at least one mechanism to fight against replay attacks. Use of the
1836 optional client transaction identifier allows the SPPF client to
1837 correlate the request message with the response and to be sure that
1838 it is not a replay of a server response from earlier exchanges. Use
1839 of unique values for the client transaction identifier is highly
1840 encouraged to avoid chance matches to a potential replay message.
1842 The SPPF client or registrar can be a separate entity acting on
1843 behalf of the registrant in facilitating provisioning transactions to
1844 the registry. Further, the transport layer provides end-to-end
1845 connection protection between SPPF client and the SPPF server.
1846 Therefore, man-in-the-middle attack is a possibility that may affect
1847 the integrity of the data that belongs to the registrant and/or
1848 expose peer data to unintended actors in case well-established
1849 peering relationships already exist.
1851 10. IANA Considerations
1853 This document uses URNs to describe XML namespaces and XML schemas
1854 conforming to a registry mechanism described in [RFC3688].
1856 Two URI assignments are requested.
1858 Registration request for the SPPF XML namespace:
1859 urn:ietf:params:xml:ns:sppf:base:1
1860 Registrant Contact: IESG
1861 XML: None. Namespace URIs do not represent an XML specification.
1863 Registration request for the XML schema:
1864 URI: urn:ietf:params:xml:schema:sppf:1
1865 Registrant Contact: IESG
1866 XML: See the "Formal Specification" section of this document
1867 (Section 11).
1869 IANA is requested to create a new SPPF registry for Organization
1870 Identifiers that will indicate valid strings to be used for well-
1871 known enterprise namespaces.
1872 This document makes the following assignments for the OrgIdType
1873 namespaces:
1875 Namespace OrgIdType namespace string
1876 ---- ----------------------------
1877 IANA Enterprise Numbers iana-en
1879 11. Formal Specification
1881 This section provides the draft XML Schema Definition for SPPF
1882 Protocol.
1884
1885
1889
1890
1891 ---- Generic Object key
1892 types to be defined by specific
1893 Transport/Architecture.
1894 The types defined here can
1895 be extended by the
1896 specific architecture to
1897 define the Object Identifiers ----
1898
1899
1900
1902
1903
1904 ---- Generic type that
1905 represents the key for various
1906 objects in SPPP. ----
1907
1908
1909
1910
1911
1912
1913
1914
1915 ---- Generic type
1916 that represents
1917 the key for a route
1918 group offer. ----
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929 ----Generic type that
1930 represents the key
1931 for a Pub Id. ----
1932
1933
1934
1935
1936
1937
1938 ---- Object Type Definitions ----
1939
1940
1941
1942
1943
1944
1946
1949
1952
1955
1958
1959
1960
1962
1963
1964
1965
1966
1967
1968
1969
1970
1973
1974
1975
1976
1977
1978
1979
1980
1981
1983
1984
1985
1986
1987
1988
1989
1990
1991
1993
1995
1998
1999
2000
2001
2002
2003
2004
2005
2006
2008
2010
2011
2012
2013
2014
2015
2016
2017
2018
2020
2022
2023
2024
2025
2026
2027
2028
2029
2030
2032
2034
2035
2036
2037
2038
2039
2040
2041
2042
2044
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2111
2112
2113
2114
2115
2116
2117
2118 ---- Abstract Object and
2119 Element Type
2120 Definitions ----
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2157
2158
2159
2160
2161
2162
2163
2164
2166
2167
2168
2169
2170
2171
2172
2173
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2288 12. Acknowledgments
2290 This document is a result of various discussions held in the DRINKS
2291 working group and within the DRINKS protocol design team, which is
2292 comprised of the following individuals, in alphabetical order:
2293 Alexander Mayrhofer, David Schwartz, Deborah A Guyton, Lisa
2294 Dusseault, Manjul Maharishi, Mickael Marrache, Otmar Lendl, Richard
2295 Shockey, Samuel Melloul, and Sumanth Channabasappa.
2297 13. References
2299 13.1. Normative References
2301 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
2302 Requirement Levels", BCP 14, RFC 2119, March 1997.
2304 [RFC2277] Alvestrand, H., "IETF Policy on Character Sets and
2305 Languages", BCP 18, RFC 2277, January 1998.
2307 [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO
2308 10646", STD 63, RFC 3629, November 2003.
2310 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
2311 January 2004.
2313 [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
2314 Resource Identifier (URI): Generic Syntax", STD 66,
2315 RFC 3986, January 2005.
2317 [RFC4949] Shirey, R., "Internet Security Glossary, Version 2",
2318 RFC 4949, August 2007.
2320 [RFC5067] Lind, S. and P. Pfautz, "Infrastructure ENUM
2321 Requirements", RFC 5067, November 2007.
2323 13.2. Informative References
2325 [RFC2781] Hoffman, P. and F. Yergeau, "UTF-16, an encoding of ISO
2326 10646", RFC 2781, February 2000.
2328 [RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston,
2329 A., Peterson, J., Sparks, R., Handley, M., and E.
2330 Schooler, "SIP: Session Initiation Protocol", RFC 3261,
2331 June 2002.
2333 [RFC4725] Mayrhofer, A. and B. Hoeneisen, "ENUM Validation
2334 Architecture", RFC 4725, November 2006.
2336 [RFC5321] Klensin, J., "Simple Mail Transfer Protocol", RFC 5321,
2337 October 2008.
2339 [RFC5486] Malas, D. and D. Meyer, "Session Peering for Multimedia
2340 Interconnect (SPEERMINT) Terminology", RFC 5486,
2341 March 2009.
2343 [RFC6116] Bradner, S., Conroy, L., and K. Fujiwara, "The E.164 to
2344 Uniform Resource Identifiers (URI) Dynamic Delegation
2345 Discovery System (DDDS) Application (ENUM)", RFC 6116,
2346 March 2011.
2348 [RFC6461] Channabasappa, S., "Data for Reachability of Inter-/
2349 Intra-NetworK SIP (DRINKS) Use Cases and Protocol
2350 Requirements", RFC 6461, January 2012.
2352 Authors' Addresses
2354 Jean-Francois Mule
2355 CableLabs
2356 858 Coal Creek Circle
2357 Louisville, CO 80027
2358 USA
2360 Email: jfm@cablelabs.com
2362 Kenneth Cartwright
2363 TNS
2364 1939 Roland Clarke Place
2365 Reston, VA 20191
2366 USA
2368 Email: kcartwright@tnsi.com
2370 Syed Wasim Ali
2371 NeuStar
2372 46000 Center Oak Plaza
2373 Sterling, VA 20166
2374 USA
2376 Email: syed.ali@neustar.biz
2378 Alexander Mayrhofer
2379 enum.at GmbH
2380 Karlsplatz 1/9
2381 Wien, A-1010
2382 Austria
2384 Email: alexander.mayrhofer@enum.at
2386 Vikas Bhatia
2387 TNS
2388 1939 Roland Clarke Place
2389 Reston, VA 20191
2390 USA
2392 Email: vbhatia@tnsi.com