idnits 2.17.1
draft-ietf-drinks-spp-framework-01.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 (March 12, 2012) is 4427 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 2353, 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: September 13, 2012 TNS
6 S. Ali
7 NeuStar
8 A. Mayrhofer
9 enum.at GmbH
10 V. Bhatia
11 TNS
12 March 12, 2012
14 Session Peering Provisioning Framework (SPPF)
15 draft-ietf-drinks-spp-framework-01
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 September 13, 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 . . . . . . . . . . . . . . . 17
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 . . . . . . . . . . . . . . . . . . . . . . . 28
87 6.4. Route Record . . . . . . . . . . . . . . . . . . . . . . . 32
88 6.5. Route Group Offer . . . . . . . . . . . . . . . . . . . . 36
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 "protocol" specification
195 for the framework. 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 "protocol" specification, and the basic object type most first
215 class objects extend from;
217 o Section 6 detailed description 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 SPPF.
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. The data model is defined
282 along with all the objects manipulated by the protocol and their
283 relationships.
285 3.1. Framework Data Model
287 The data model illustrated and described in Figure 2 defines the
288 logical objects and the relationships between these objects that the
289 SPPF protocol supports. SPPF defines the protocol operations through
290 which an SPPF client populates a registry with these logical objects.
291 Various clients belonging to different registrars may use the
292 protocol for populating the registry's data.
294 The logical structure presented below is consistent with the
295 terminology and requirements defined in [RFC6461].
297 +-------------+ +----------------+
298 | all object | |Egress Route: |
299 | types | | rant, |
300 +-------------+ | egrRteName, |
301 0..n | | regxRewriteRule|
302 | 2 | ingrRteRec |
303 +----------------------+ | |
304 |Organization: | +----------------+
305 | orgId | | 0..n
306 +----------------------+ |
307 |0..n |
308 | |
309 |A Route Group is | 0..n
310 |associated with +-----[abstract]-+
311 |zero or more Peering | |
312 |Organizations | Route Record: |
313 | | rant, |
314 | | rrName, |0..n
315 0..n| | isInSvc |--------|
316 +--------+--------------+0..n 0..n| | |
317 |Route Group: |-----------------| | |
318 | rant, | +----------------+ |
319 | rgName, | ^ |
320 | isInSvc, | |Various types |
321 | rrRef, | |of Route |
322 | peeringOrg, | |Records |
323 | sourceIdent, | +-----+------------+ |
324 | priority, | | | | |
325 | dgName | +----+ +-------+ +----+ |
326 +-----------------------+ | URI| | NAPTR | | NS | |
327 |0..n +----+ +-------+ +----+ |
328 | |
329 | +----------[abstract]-+ |
330 | |Public Identifier: | |
331 | | rant, | |
332 |0..n | publicIdentifier, | |
333 +----------------------+0..n 0..n| destGrpRef, | |
334 | Dest Group: |--------------| rrRef | |
335 | rant, | | | |
336 | dgName | +---------------------+ |
337 +----------------------+ ^Various types |
338 |of Public |
339 |Identifiers |
340 +---------+-------+------+----------+ |
341 | | | | | |
342 +------+ +-----+ +-----+ +-----+ +------+ |
343 | URI | | TNP | | TNR | | RN | |TN |-----------
344 +------+ +-----+ +-----+ +-----+ +------+ 0..n
345 Figure 2
347 The objects and attributes that comprise the data model can be
348 described as follows (objects listed from the bottom up):
350 o Public Identifier:
351 From a broad perspective a public identifier is a well-known
352 attribute that is used as the key to perform resolution lookups.
353 Within the context of SPPF, a public identifier object can be a
354 Telephone Number (TN), a range of Telephone Numbers, a PSTN
355 Routing Number (RN), a TN prefix, or a URI.
357 An SPPF Public Identifier is associated with a Destination Group
358 to create a logical grouping of Public Identifiers that share a
359 common set of Routes.
361 A TN Public Identifier may optionally be associated with zero or
362 more individual Route Records. This ability for a Public
363 Identifier to be directly associated with a set of Route Records
364 (e.g. target URI), as opposed to being associated with a
365 Destination Group, supports the use cases where the target URI
366 contains data specifically tailored to an individual TN Public
367 Identifier.
369 o Destination Group:
370 A named collection of zero or more Public Identifiers that can be
371 associated with one or more Route Groups for the purpose of
372 facilitating the management of their common routing information.
374 o Route Group:
375 A Route Group contains a set of Route Record references, a set of
376 Destination Group references, and a set of peering organization
377 identifiers. This is used to establish a three part relationships
378 between a set of Public Identifiers, the routing information (SED)
379 shared across the Public Identifiers, and the list of peering
380 organizations whose query responses from the resolution system may
381 include the routing information from a given route group. In
382 addition, the sourceIdent element within a Route Group, in concert
383 with the set of peering organization identifiers, enables fine-
384 grained source based routing. For further details about the Route
385 Group and source based routing, refer to the definitions and
386 descriptions of the Route Group operations found later in this
387 document.
389 o Route Record:
390 A Route Record contains the data that a resolution system returns
391 in response to a successful query for a Public Identifier. Route
392 Records are generally associated with a Route Group when the SED
393 within is not specific to a Public Identifier.
394 To support the use cases defined in [RFC6461], SPPF framework
395 defines three type of Route Records: URIRteRecType, NAPTRType, and
396 NSType. These Route Records extend the abstract type RteRecType
397 and inherit the common attribute 'priority' that is meant for
398 setting precedence across the route records defined within a Route
399 Group in a protocol agnostic fashion.
401 o Organization:
402 An Organization is an entity that may fulfill any combination of
403 three roles: Registrant, Registrar, and Peering Organization. All
404 objects in SPPF framework are associated with two organization
405 identifiers to identify each object's registrant and registrar. A
406 Route Group object is also associated with a set of zero or more
407 organization identifiers that identify the peering organization(s)
408 whose resolution query responses may include the routing
409 information (SED) defined in the Route Records within that Route
410 Group. A peering organization is an entity that the registrant
411 intends to share the SED data with.
413 3.2. Time Value
415 Some request and response messages in SPPF framework include time
416 value(s) defined as type xs:dateTime, a built-in W3C XML Schema
417 Datatype. Use of unqualified local time value is discouraged as it
418 can lead to interoperability issues. The value of time attribute
419 MUST BE expressed in Coordinated Universal Time (UTC) format without
420 the timezone digits.
422 "2010-05-30T09:30:10Z" is an example of an acceptable time value for
423 use in SPPF messages. "2010-05-30T06:30:10+3:00" is a valid UTC time,
424 but it is not approved for use in SPPF messages.
426 4. Transport Protocol Requirements
428 This section provides requirements for transport protocols suitable
429 for SPPF framework. More specifically, this section specifies the
430 services, features, and assumptions that SPPF framework delegates to
431 the chosen transport and envelope technologies.
433 4.1. Connection Oriented
435 The SPPF follows a model where a client establishes a connection to a
436 server in order to further exchange SPPF messages over such point-to-
437 point connection. A transport protocol for SPPF MUST therefore be
438 connection oriented.
440 4.2. Request and Response Model
442 Provisioning operations in SPPF follow the request-response model,
443 where a client sends a request message to initiate a transaction and
444 the server responds with a response. Multiple subsequent request-
445 response exchanges MAY be performed over a single persistent
446 connection.
448 Therefore, a transport protocol for SPPF MUST follow the request-
449 response model by allowing a response to be sent to the request
450 initiator.
452 4.3. Connection Lifetime
454 Some use cases involve provisioning a single request to a network
455 element. Connections supporting such provisioning requests might be
456 short-lived, and may be established only on demand. Other use cases
457 involve either provisioning a large dataset, or a constant stream of
458 small updates, either of which would likely require long-lived
459 connections.
461 Therefore, a protocol suitable for SPPF SHOULD be able to support
462 both short-lived as well as long-lived connections.
464 4.4. Authentication
466 All SPPF objects are associated with a registrant identifier. SPPF
467 Clients provisions SPPF objects on behalf of registrants. An
468 authenticated SPP Client is a registrar. Therefore, the SPPF
469 transport protocol MUST provide means for an SPPF server to
470 authenticate an SPPF Client.
472 4.5. Authorization
474 After successful authentication of the SPPF client as a registrar the
475 registry performs authorization checks to determine if the registrar
476 is authorized to act on behalf of the Registrant whose identifier is
477 included in the SPPF request. Refer to the Security Considerations
478 section for further guidance.
480 4.6. Confidentiality and Integrity
482 In some deployments, the SPPF objects that an SPPF registry manages
483 can be private in nature. As a result it MAY NOT be appropriate to
484 for transmission in plain text over a connection to the SPPF
485 registry. Therefore, the transport protocol SHOULD provide means for
486 end-to-end encryption between the SPPF client and server.
488 For some SPPF implementations, it may be acceptable for the data to
489 be transmitted in plain text, but the failure to detect a change in
490 data after it leaves the SPPF client and before it is received at the
491 server, either by accident or with a malicious intent, will adversely
492 affect the stability and integrity of the registry. Therefore, the
493 transport protocol SHOULD provide means for data integrity
494 protection.
496 4.7. Near Real Time
498 Many use cases require near real-time responses from the server.
499 Therefore, a DRINKS transport protocol MUST support near real-time
500 response to requests submitted by the client.
502 4.8. Request and Response Sizes
504 Use of SPPF may involve simple updates that may consist of small
505 number of bytes, such as, update of a single public identifier.
506 Other provisioning operations may constitute large number of dataset
507 as in adding millions records to a registry. As a result, a suitable
508 transport protocol for SPPF SHOULD accommodate dataset of various
509 sizes.
511 4.9. Request and Response Correlation
513 A transport protocol suitable for SPPF MUST allow responses to be
514 correlated with requests.
516 4.10. Request Acknowledgement
518 Data transported in the SPPF is likely crucial for the operation of
519 the communication network that is being provisioned. A SPPF client
520 responsible for provisioning SED to the registry has a need to know
521 if the submitted requests have been processed correctly.
523 Failed transactions can lead to situations where a subset of public
524 identifiers or even SSPs might not be reachable, or the provisioning
525 state of the network is inconsistent.
527 Therefore, a transport protocol for SPPF MUST provide a response for
528 each request, so that a client can identify whether a request
529 succeeded or failed.
531 4.11. Mandatory Transport
533 At the time of this writing, a choice of transport protocol has been
534 provided in SPP Protocol over SOAP document. To encourage
535 interoperability, the SPPF server MUST provide support for this
536 transport protocol. With time, it is possible that other transport
537 layer choices may surface that agree with the requirements discussed
538 above.
540 5. Base Framework Data Structures and Response Codes
542 SPPF contains some common data structures for most of the supported
543 object types. This section describes these common data structures.
545 5.1. Basic Object Type and Organization Identifiers
547 This section introduces the basic object type that most first class
548 objects derive from.
550 All first class objects extend the basic object type BasicObjType
551 that contains the identifier of the registrant organization that owns
552 this object, the identifier of the registrar organization that
553 created this object, the date and time that the object was created by
554 the server, and the date and time that the object was last modified.
556
557
558
559
560
562
564
566
567
569 The identifiers used for registrants (rant), registrars (rar), and
570 peering organizations (peeringOrg) are instances of OrgIdType. The
571 OrgIdType is defined as a string and all OrgIdType instances SHOULD
572 follow the textual convention: "namespace:value" (for example "iana-
573 en:32473"). See the IANA Consideration section for more details.
575 5.2. Various Object Key Types
577 The SPPF data model contains various object relationships. In some
578 cases, these object relationships are established by embedding the
579 unique identity of the related object inside the relating object. In
580 addition, an object's unique identity is required to Delete or Get
581 the details of an object. The following sub-sections normatively
582 define the various object keys in SPPF and the attributes of those
583 keys .
585 5.2.1. Generic Object Key Type
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. The abstract type called
590 ObjKeyType is where this unique identity is housed. Any concrete
591 representation of the ObjKeyType MUST contain the following:
593 Object Name: The name of the object.
595 Registrant Id: The unique organization ID that identifies the
596 Registrant.
598 Type: The value that represents the type of SPPF object that.
599 This is required as different types of objects in SPPF, that
600 belong to the same registrant, can have the same name.
602 The structure of abstract ObjKeyType is as follows:
604
605
606
607 ---- Generic type that represents the
608 key for various objects in SPPF. ----
609
610
611
613 5.2.2. Derived Object Key Types
615 The SPPF data model contains certain objects that are uniquely
616 identified by attributes, different from or in addition to, the
617 attributes in the generic object key described in previous section.
618 These kind of object keys are derived from the abstract ObjKeyType
619 and defined in there own abstract key types. Because these object
620 key types are abstract, these MUST be specified in a concrete form in
621 any conforming SPPF "protocol" specification. These are used in
622 Delete and Get operations, and may also be used in Accept and Reject
623 operations.
625 Following are the derived object keys in SPPF data model:
627 o RteGrpOfferKeyType: This uniquely identifies a Route Group
628 object offer. This key type extends from ObjKeyType and MUST
629 also have the organization ID of the Registrant to whom the
630 object is being offered, as one of its attributes. In addition
631 to the Delete and Get operations, these key types are used in
632 Accept and Reject operations on a Route Group Offer object. The
633 structure of abstract RteGrpOfferKeyType is as follows:
635
637
638
639
640
641 ---- Generic type that represents the
642 key for a object offer. ----
643
644
645
646
647
649 A Route Group Offer object MUST use RteGrpOfferKeyType. Refer
650 the "Framework Data Model Objects" section of this document for
651 description of Route Group Offer object.
653 o PubIdKeyType: This uniquely identifies a Public Identity object.
654 This key type extends from abstract ObjKeyType. Any concrete
655 defintion of PubIdKeyType MUST contain the elements that
656 identify the value and type of Public Identity and also contain
657 the organization ID of the Registrant that is the owner of the
658 Public Identity object. A Public Identity object key in SPPF is
659 uniquely identified by the the registrant's organization ID, the
660 value of the public identity, and, optionally, the Destination
661 Group name the public identiy belongs to. Consequently, any
662 concrete representation of the PubIdKeyType MUST contain the
663 following attributes:
665 * Registrant Id: The unique organization ID that identifies
666 the Registrant.
668 * Destination Group name: The name of the Destination Group
669 the Public Identity is associated with. This is an
670 optional attribute.
672 * Type: The type of Public Identity.
674 * Value: The value of the Public Identity.
676 The .PubIdKeyType is used in Delete and Get operations on a
677 Public Identifier object.
679 o The structure of abstract PubIdKeyType is as follows:
681
682
683
684
685
686 ---- Generic type that represents
687 the key for a Pub Id. ----
688
689
690
691
692
694 A Public Identity object MUST use attributes of PubIdKeyType for its
695 unique identification . Refer the "Framework Data Model Objects"
696 section of this document for a description of Public Identity object.
698 5.3. Response Message Types
700 This section contains the listing of response types that MUST be
701 defined by the conforming "protocol" specification and implemented by
702 a conforming SPPF server.
704 +---------------------+---------------------------------------------+
705 | Response Type | Description |
706 +---------------------+---------------------------------------------+
707 | Request Succeeded | Any conforming specification MUST define a |
708 | | response to indicate that a given request |
709 | | succeeded. |
710 | | |
711 | Request syntax | Any conforming specification MUST define a |
712 | invalid | response to indicate that a syntax of a |
713 | | given request was found invalid. |
714 | | |
715 | Request too large | Any conforming specification MUST define a |
716 | | response to indicate that the count of |
717 | | entities in the request is larger than the |
718 | | server is willing or able to process. |
719 | | |
720 | Version not | Any conforming specification MUST define a |
721 | supported | response to indicate that the server does |
722 | | not support the version of the SPPF |
723 | | protocol specified in the request. |
724 | | |
725 | Command invalid | Any conforming specification MUST define a |
726 | | response to indicate that the operation |
727 | | and/or command being requested by the |
728 | | client is invalid and/or not supported by |
729 | | the server. |
730 | | |
731 | System temporarily | Any conforming specification MUST define a |
732 | unavailable | response to indicate that the SPPF server |
733 | | is temporarily not available to serve |
734 | | client request. |
735 | | |
736 | Unexpected internal | Any conforming specification MUST define a |
737 | system or server | response to indicate that the SPPF server |
738 | error. | encountered an unexpected error that |
739 | | prevented the server from fulfilling the |
740 | | request. |
741 | | |
742 | Attribute value | Any conforming specification MUST define a |
743 | invalid | response to indicate that the SPPF server |
744 | | encountered an attribute or property in the |
745 | | request that had an invalid/bad value. |
746 | | Optionally, the specification MAY provide a |
747 | | way to indicate the Attribute Name and the |
748 | | Attribute Value to identify the object that |
749 | | was found to be invalid. |
750 | | |
751 | Object does not | Any conforming specification MUST define a |
752 | exist | response to indicate that an object present |
753 | | in the request does not exist on the SPPF |
754 | | server. Optionally, the specification MAY |
755 | | provide a way to indicate the Attribute |
756 | | Name and the Attribute Value that |
757 | | identifies the non-existent object. |
758 | | |
759 | Object status or | Any conforming specification MUST define a |
760 | ownership does not | response to indicate that the operation |
761 | allow for | requested on an object present in the |
762 | operation. | request cannot be performed because the |
763 | | object is in a status that does not allow |
764 | | the said operation or the user requesting |
765 | | the operation is not authorized to perform |
766 | | the said operation on the object. |
767 | | Optionally, the specification MAY provide a |
768 | | way to indicate the Attribute Name and the |
769 | | Attribute Value that identifies the object. |
770 +---------------------+---------------------------------------------+
772 Table 1: Response Types
774 When the response messages are "parameterized" with the Attribute
775 Name and Attribute Value, then the use of these parameters MUST
776 adhere to the following rules:
778 o Any value provided for the Attribute Name parameter MUST be an
779 exact XSD element name of the protocol data element that the
780 response message is referring to. For example, valid values for
781 "attribute name" are "dgName", "rgName", "rteRec", etc.
783 o The value for Attribute Value MUST be the value of the data
784 element to which the preceding Attribute Name refers.
786 o Response type "Attribute value invalid" SHOULD be used whenever
787 an element value does not adhere to data validation rules.
789 o Response types "Attribute value invalid" and "Object does not
790 exist" MUST NOT be used interchangeably. Response type "Object
791 does not exist" SHOULD be returned by an Add/Del/Accept/Reject
792 operation when the data element(s) used to uniquely identify a
793 pre-existing object do not exist. If the data elements used to
794 uniquely identify an object are malformed, then response type
795 "Attribute value invalid" SHOULD be returned.
797 6. Framework Data Model Objects
799 This section provides a description of the specification of each
800 supported data model object (the nouns) and identifies the commands
801 (the verbs) that MUST be supported for each data model object.
802 However, the specification of the data structures necessary to
803 support each command is delegated to the "protocol" specification.
805 6.1. Destination Group
807 As described in the introductory sections, a Destination Group
808 represents a set of Public Identifiers with common routing
809 information. The transport protocol MUST support the ability to
810 Create, Modify, Get, and Delete Destination Groups (refer the
811 "Framework Operations" section of this document for a generic
812 description of various operations).
814 A Destination Group object MUST be uniquely identified by attributes
815 as defined in the description of "ObjKeyType" in the section "Generic
816 Object Key Type" of this document.
818 The DestGrpType object structure is defined as follows:
820
821
822
823
824
825
826
827
828
830 The DestGrpType object is composed of the following elements:
832 o base: All first class objects extend BasicObjType that contains
833 the ID of the registrant organization that owns this object,
834 registrar organization that provisioned this object on behalf of
835 the registrant, the date and time that the object was created by
836 the server, and the date and time that the object was last
837 modified. If the client passed in either the created date or
838 the modification date, the server will ignore them. The server
839 sets these two date/time values.
841 o dgName: The character string that contains the name of the
842 Destination Group.
844 o ext: Point of extensibility described in a previous section of
845 this document.
847 6.2. Public Identifier
849 A Public Identifier is the search key used for locating the session
850 establishment data (SED). In many cases, a Public Identifier is
851 attributed to the end user who has a retail relationship with the
852 service provider or registrant organization. SPPF supports the
853 notion of the carrier-of-record as defined in [RFC5067]. Therefore,
854 the registrant under whom the Public Identity is being created can
855 optionally claim to be a carrier-of-record.
857 SPPF identifies three types of Public Identifiers: telephone numbers
858 (TN), routing numbers (RN), and URI type of Public Identifiers (like
859 an email address). SPPF provides structures to manage a single TN, a
860 contiguous range of TNs, and a TN prefix. The transport protocol
861 MUST support the ability to Create, Modify, Get, and Delete Public
862 Identifiers (refer the "Framework Operations" section of this
863 document for a generic description of various operations).
865 A Public Identity object MUST be uniquely identified by attributes as
866 defined in the description of "PubIdKeyType" in the section "Derived
867 Object Key Types" of this document.
869 The abstract XML schema type definition PubIDType is a generalization
870 for the concrete Public Identifier schema types. PubIDType element
871 'dgName' represents the name of the destination group that a given
872 Public Identifier MAY be a member of. The PubIDType object structure
873 is defined as follows:
875
876
877
878
879
881
882
883
884
886 A Public Identifier may be provisioned as a member of a Destination
887 Group or provisioned outside of a Destination Group. A Public
888 Identifier that is provisioned as a member of a Destination Group is
889 intended to be associated with its SED through the Route Group(s)
890 that are associated with its containing Destination Group. A Public
891 Identifier that is not provisioned as a member of a Destination Group
892 is intended to be associated with its SED through the Route Records
893 that are directly associated with the Public Identifier.
895 A telephone number is provisioned using the TNType, an extension of
896 PubIDType. When a Public Identifier is provisioned as a member of a
897 Destination Group, each TNType object is uniquely identified by the
898 combination of its value contained within element, and the
899 unique key of its parent Destination Group (dgName and rantId). In
900 other words a given telephone number string may exist within one or
901 more Destination Groups, but must not exist more than once within a
902 Destination Group. A Public Identifier that is not provisioned as a
903 member of a Destination Group is uniquely identified by the
904 combination of its value, and its registrant ID. TNType is defined
905 as follows:
907
908
909
910
911
913
915
918
919
920
921
923
924
925
926
927
928
930 TNType consists of the following attributes:
932 o tn: Telephone number to be added to the registry.
934 o rrRef: Optional reference to route records that are directly
935 associated with the TN Public Identifier. Following the SPPF
936 data model, the route record could be a protocol agnostic
937 URIRteRecType or another type.
939 o corInfo: corInfo is an optional parameter of type CORInfoType
940 that allows the registrant organization to set forth a claim to
941 be the carrier-of-record (see [RFC5067]). This is done by
942 setting the value of element of the CORInfoType
943 object structure to "true". The other two parameters of the
944 CORInfoType, and are set by the registry to
945 describe the outcome of the carrier-of-record claim by the
946 registrant. In general, inclusion of parameter is
947 useful if the registry has the authority information, such as,
948 the number portability data, etc., in order to qualify whether
949 the registrant claim can be satisfied. If the carrier-of-record
950 claim disagrees with the authority data in the registry, whether
951 the TN add operation fails or not is a matter of policy and it
952 is beyond the scope of this document.
954 A routing number is provisioned using the RNType, an extension of
955 PubIDType. SSPs that possess the number portability data may be able
956 to leverage the RN search key to discover the ingress routes for
957 session establishment. Therefore, the registrant organization can
958 add the RN and associate it with the appropriate destination group to
959 share the route information. Each RNType object is uniquely
960 identified by the combination of its value inside the element,
961 and the unique key of its parent Destination Group (dgName and
962 rantId). In other words a given routing number string may exist
963 within one or more Destination Groups, but must not exist more than
964 once within a Destination Group. RNType is defined as follows:
966
967
968
969
970
972
974
975
976
977
979 RNType has the following attributes:
981 o rn: Routing Number used as the search key.
983 o corInfo: Optional element of type CORInfoType.
985 TNRType structure is used to provision a contiguous range of
986 telephone numbers. The object definition requires a starting TN and
987 an ending TN that together define the span of the TN range. Use of
988 TNRType is particularly useful when expressing a TN range that does
989 not include all the TNs within a TN block or prefix. The TNRType
990 definition accommodates the open number plan as well such that the
991 TNs that fall between the start and end TN range may include TNs with
992 different length variance. Whether the registry can accommodate the
993 open number plan semantics is a matter of policy and is beyond the
994 scope of this document. Each TNRType object is uniquely identified
995 by the combination of its value that in turn is a combination of the
996 and elements, and the unique key of its parent
997 Destination Group (dgName and rantId). In other words a given TN
998 Range may exist within one or more Destination Groups, but must not
999 exist more than once within a Destination Group. TNRType object
1000 structure definition is as follows:
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1013
1014
1015
1016
1017
1018
1020 TNRType has the following attributes:
1022 o startTn: Starting TN in the TN range
1024 o endTn: The last TN in the TN range
1026 o corInfo: Optional element of type CORInfoType
1028 In some cases, it is useful to describe a set of TNs with the help of
1029 the first few digits of the telephone number, also referred to as the
1030 telephone number prefix or a block. A given TN prefix may include
1031 TNs with different length variance in support of open number plan.
1032 Once again, whether the registry supports the open number plan
1033 semantics is a matter of policy and it is beyond the scope of this
1034 document. The TNPType data structure is used to provision a TN
1035 prefix. Each TNPType object is uniquely identified by the
1036 combination of its value in the element, and the unique
1037 key of its parent Destination Group (dgName and rantId). TNPType is
1038 defined as follows:
1040
1041
1042
1043
1044
1046
1048
1049
1050
1051
1053 TNPType consists of the following attributes:
1055 o tnPrefix: The telephone number prefix
1057 o corInfo: Optional element of type CORInfoType.
1059 In some cases, a Public Identifier may be a URI, such as an email
1060 address. The URIPubIdType object is comprised of the data element
1061 necessary to house such Public Identifiers. Each URIPubIdType object
1062 is uniquely identified by the combination of its value in the
1063 element, and the unique key of its parent Destination Group (dgName
1064 and rantId). URIPubIdType is defined as follows:
1066
1067
1068
1069
1070
1072
1074
1075
1076
1077
1079 URIPubIdType consists of the following attributes:
1081 o uri: The value that acts a Public Identifier.
1083 o ext: Point of extensibility.
1085 6.3. Route Group
1087 As described in the introductory sections, a Route Group represents a
1088 combined grouping of Route Records that define route information,
1089 Destination Groups that contain a set of Public Identifiers with
1090 common routing information, and the list of peer organizations that
1091 have access to these public identifiers using this route information.
1092 It is this indirect linking of public identifiers to their route
1093 information that significantly improves the scalability and
1094 manageability of the peering data. Additions and changes to routing
1095 information are reduced to a single operation on a Route Group or
1096 Route Record , rather than millions of data updates to individual
1097 public identifier records that individually contain their peering
1098 data. The transport protocol MUST support the ability to Create,
1099 Modify, Get, and Delete Route Groups (refer the "Framework
1100 Operations" section of this document for a generic description of
1101 various operations).
1103 A Route Group object MUST be uniquely identified by attributes as
1104 defined in the description of "ObjKeyType" in the section "Generic
1105 Object Key Type" of this document.
1107 The RteGrpType object structure is defined as follows:
1109
1110
1111
1112
1113
1114
1116
1118
1120
1123
1124
1125
1127
1128
1129
1130
1132
1133
1134
1135
1136
1138
1139
1141 The RteGrpType object is composed of the following elements:
1143 o base: All first class objects extend BasicObjType that contains
1144 the ID of the registrant organization that owns this object, the
1145 date and time that the object was created by the server, and the
1146 date and time that the object was last modified. If the client
1147 passes in either the created date or the modification date, the
1148 server will ignore them. The server sets these two date/time
1149 values.
1151 o rgName: The character string that contains the name of the Route
1152 Group. It uniquely identifies this object within the context of
1153 the registrant ID (a child element of the base element as
1154 described above).
1156 o rrRef: Set of zero or more objects of type RteRecRefType that
1157 house the unique keys of the Route Records that the RteGrpType
1158 object refers to and their relative priority within the context
1159 of a given route group. The associated Route Records contain
1160 the routing information, sometimes called SED, associated with
1161 this Route Group.
1163 o dgName: Set of zero or more names of DestGrpType object
1164 instances. Each dgName name, in association with this Route
1165 Group's registrant ID, uniquely identifies a DestGrpType object
1166 instance whose public identifiers are reachable using the
1167 routing information housed in this Route Group. An intended
1168 side affect of this is that a Route Group cannot provide routing
1169 information for a Destination Group belonging to another
1170 registrant.
1172 o peeringOrg: Set of zero or more peering organization IDs that
1173 have accepted an offer to receive this Route Group's
1174 information. The set of peering organizations in this list is
1175 not directly settable or modifiable using the addRteGrpsRqst
1176 operation. This set is instead controlled using the route offer
1177 and accept operations.
1179 o sourceIdent: Set of zero or more SourceIdentType object
1180 instances. These objects, described further below, house the
1181 source identification schemes and identifiers that are applied
1182 at resolution time as part of source based routing algorithms
1183 for the Route Group.
1185 o isInSvc: A boolean element that defines whether this Route Group
1186 is in service. The routing information contained in a Route
1187 Group that is in service is a candidate for inclusion in
1188 resolution responses for public identities residing in the
1189 Destination Group associated with this Route Group. The routing
1190 information contained in a Route Group that is not in service is
1191 not a candidate for inclusion in resolution responses.
1193 o priority: Zero or one priority value that can be used to provide
1194 a relative value weighting of one Route Group over another. The
1195 manner in which this value is used, perhaps in conjunction with
1196 other factors, is a matter of policy.
1198 o ext: Point of extensibility described in a previous section of
1199 this document.
1201 As described above, the Route Group contains a set of references to
1202 route record objects. A route record object is based on an abstract
1203 type: RteRecType. The concrete types that use RteRecType as an
1204 extension base are NAPTRType, NSType, and URIType. The definitions
1205 of these types are included the Route Record section of this
1206 document.
1208 The RteGrpType object provides support for source-based routing via
1209 the peeringOrg data element and more granular source base routing via
1210 the source identity element. The source identity element provides
1211 the ability to specify zero or more of the following in association
1212 with a given Route Group: a regular expression that is matched
1213 against the resolution client IP address, a regular expression that
1214 is matched against the root domain name(s), and/or a regular
1215 expression that is matched against the calling party URI(s). The
1216 result will be that, after identifying the visible Route Groups whose
1217 associated Destination Group(s) contain the lookup key being queried
1218 and whose peeringOrg list contains the querying organizations
1219 organization ID, the resolution server will evaluate the
1220 characteristics of the Source URI, and Source IP address, and root
1221 domain of the lookup key being queried. The resolution server then
1222 compares these criteria against the source identity criteria
1223 associated with the Route Groups. The routing information contained
1224 in Route Groups that have source based routing criteria will only be
1225 included in the resolution response if one or more of the criteria
1226 matches the source criteria from the resolution request. The Source
1227 Identity data element is of type SourceIdentType, whose structure is
1228 defined as follows:
1230
1231
1232
1233
1235
1237
1238
1240
1241
1242
1243
1244
1245
1246
1248 The SourceIdentType object is composed of the following data
1249 elements:
1251 o sourceIdentScheme: The source identification scheme that this
1252 source identification criteria applies to and that the
1253 associated sourceIdentRegex should be matched against.
1255 o sourceIdentRegex: The regular expression that should be used to
1256 test for a match against the portion of the resolution request
1257 that is dictated by the associated sourceIdentScheme.
1259 o ext: Point of extensibility described in a previous section of
1260 this document.
1262 6.4. Route Record
1264 As described in the introductory sections, a Route Group represents a
1265 combined grouping of Route Records that define route information.
1266 However, Route Records need not be created to just serve a single
1267 Route Group. Route Records can be created and managed to serve
1268 multiple Route Groups. As a result, a change to the properties of a
1269 network node used for multiple routes, would necessitate just a
1270 single update operation to change the properties of that node. The
1271 change would then be reflected in all the Route Groups whose route
1272 record set contains a reference to that node. The transport protocol
1273 MUST support the ability to Create, Modify, Get, and Delete Route
1274 Records (refer the "Framework Operations" section of this document
1275 for a generic description of various operations).
1277 A Route Record object MUST be uniquely identified by attributes as
1278 defined in the description of "ObjKeyType" in the section "Generic
1279 Object Key Type" of this document.
1281 The RteRecType object structure is defined as follows:
1283
1284
1285
1286
1287
1289
1290
1292
1293
1294
1295
1297 The RteRecType object is composed of the following elements:
1299 o base: All first class objects extend BasicObjType that contains
1300 the ID of the registrant organization that owns this object, the
1301 date and time that the object was created by the server, and the
1302 date and time that the object was last modified. If the client
1303 passes in either the created date or the modification date, the
1304 server will ignore them. The server sets these two date/time
1305 values.
1307 o rrName: The character string that contains the name of the Route
1308 Record. It uniquely identifies this object within the context
1309 of the registrant ID (a child element of the base element as
1310 described above).
1312 o isInSvc: A boolean element that defines whether this Route
1313 Record is in service or not. The routing information contained
1314 in a Route Record which is in service is a candidate for
1315 inclusion in resolution responses for Telephone Numbers that are
1316 either directly associated to this Route Record, or for Public
1317 Identities residing in a Destination Group that is associated to
1318 a Route Group which in turn has an association to this Route
1319 Record.
1321 o ttl: Number of seconds that an addressing server may cache a
1322 particular Route Record.
1324 As described above, route records are based on an abstract type:
1325 RteRecType. The concrete types that use RteRecType as an extension
1326 base are NAPTRType, NSType, and URIType. The definitions of these
1327 types are included below. The NAPTRType object is comprised of the
1328 data elements necessary for a NAPTR that contains routing information
1329 for a Route Group. The NSType object is comprised of the data
1330 elements necessary for a DNS name server that points to another DNS
1331 server that contains the desired routing information. The NSType is
1332 relevant only when the resolution protocol is ENUM. The
1333 URIRteRecType object is comprised of the data elements necessary to
1334 house a URI.
1336 The data provisioned in a registry can be leveraged for many purposes
1337 and queried using various protocols including SIP, ENUM and others.
1338 It is for this reason that a route record type offers a choice of URI
1339 and DNS resource record types. URIRteRecType fulfills the need for
1340 both SIP and ENUM protocols. When a given URIRteRecType is
1341 associated to a destination group, the user part of the replacement
1342 string that may require the Public Identifier cannot be preset.
1343 As a SIP Redirect, the resolution server will apply pattern on
1344 the input Public Identifier in the query and process the replacement
1345 string by substituting any back reference(s) in the to arrive
1346 at the final URI that is returned in the SIP Contact header. For an
1347 ENUM query, the resolution server will simply return the value of the
1348 and members of the URIRteRecType in the NAPTR REGEX
1349 parameter.
1351
1352
1353
1354
1355
1356
1358
1359
1361
1363
1365
1366
1367
1368
1370
1371
1372
1373
1374
1375
1377
1379
1380
1381
1382
1384
1385
1386
1387
1389
1390
1392
1393
1394
1395
1396
1397
1398
1400
1401
1402
1403
1404
1406
1407
1409
1410
1411
1412
1414
1415
1416
1417
1418
1419
1421 The NAPTRType object is composed of the following elements:
1423 o order: Order value in an ENUM NAPTR, relative to other NAPTRType
1424 objects in the same Route Group.
1426 o svcs: ENUM service(s) that are served by the SBE. This field's
1427 value must be of the form specified in [RFC6116] (e.g., E2U+
1428 pstn:sip+sip). The allowable values are a matter of policy and
1429 not limited by this protocol.
1431 o regx: NAPTR's regular expression field. If this is not included
1432 then the Repl field must be included.
1434 o repl: NAPTR replacement field, should only be provided if the
1435 Regex field is not provided, otherwise the server will ignore it
1437 o ext: Point of extensibility described in a previous section of
1438 this document.
1440 The NSType object is composed of the following elements:
1442 o hostName: Fully qualified host name of the name server.
1444 o ipAddr: Zero or more objects of type IpAddrType. Each object
1445 holds an IP Address and the IP Address type, IPv4 or IP v6.
1447 o ext: Point of extensibility described in a previous section of
1448 this document.
1450 The URIRteRecType object is composed of the following elements:
1452 o ere: The POSIX Extended Regular Expression (ere) as defined in
1453 [RFC3986].
1455 o uri: the URI as defined in [RFC3986]. In some cases, this will
1456 serve as the replacement string and it will be left to the
1457 resolution server to arrive at the final usable URI.
1459 6.5. Route Group Offer
1461 The list of peer organizations whose resolution responses can include
1462 the routing information contained in a given Route Group is
1463 controlled by the organization to which a Route Group object belongs
1464 (its registrant), and the peer organization that submits resolution
1465 requests (a data recipient, also know as a peering organization).
1466 The registrant offers access to a Route Group by submitting a Route
1467 Group Offer. The data recipient can then accept or reject that
1468 offer. Not until access to a Route Group has been offered and
1469 accepted will the data recipient's organization ID be included in the
1470 peeringOrg list in a Route Group object, and that Route Group's
1471 peering information become a candidate for inclusion in the responses
1472 to the resolution requests submitted by that data recipient. The
1473 transport protocol MUST support the ability to Create, Modify, Get,
1474 Delete, Accept and Reject Route Group Offers (refer the "Framework
1475 Operations" section of this document for a generic description of
1476 various operations).
1478 A Route Group Offer object MUST be uniquely identified by attributes
1479 as defined in the description of "RteGrpOfferKeyType" in the section
1480 "Derived Object Key Types" of this document.
1482 The RteGrpOfferType object structure is defined as follows:
1484
1485
1486
1487
1488
1490
1492
1493
1495
1497
1498
1499
1500
1502
1503
1504
1505 -- Generic type that represents the key for a route
1506 route group offer. Must be defined in concrete form
1507 in the transport specificaiton. --
1508
1509
1510
1512
1513
1514
1515
1516
1517
1519 The RteGrpOfferType object is composed of the following elements:
1521 o base: All first class objects extend BasicObjType that contains
1522 the ID of the registrant organization that owns this object, the
1523 date and time that the object was created by the server, and the
1524 date and time that the object was last modified. If the client
1525 passed in either the created date or the modification date, the
1526 will ignore them. The server sets these two date/time values.
1528 o rteGrpOfferKey: The object that identifies the route that is or
1529 has been offered and the organization that it is or has been
1530 offered to.
1532 o status: The status of the offer, offered or accepted. The
1533 server controls the status. It is automatically set to
1534 "offered" when ever a new Route Group Offer is added, and is
1535 automatically set to "accepted" if and when that offer is
1536 accepted. The value of the element is ignored when passed in by
1537 the client.
1539 o offerDateTime: Date and time in UTC when the Route Group Offer
1540 was added.
1542 o acceptDateTime: Date and time in UTC when the Route Group Offer
1543 was accepted.
1545 6.6. Egress Route
1547 In a high-availability environment, the originating SSP likely has
1548 more than one egress paths to the ingress SBE of the target SSP. If
1549 the originating SSP wants to exercise greater control and choose a
1550 specific egress SBE to be associated to the target ingress SBE, it
1551 can do so using the EgrRteType object.
1553 A Egress Route object MUST be uniquely identified by attributes as
1554 defined in the description of "ObjKeyType" in the section "Generic
1555 Object Key Type" of this document.
1557 Lets assume that the target SSP has offered to share one or more
1558 ingress route information and that the originating SSP has accepted
1559 the offer. In order to add the egress route to the registry, the
1560 originating SSP uses a valid regular expression to rewrite ingress
1561 route in order to include the egress SBE information. Also, more
1562 than one egress route can be associated with a given ingress route in
1563 support of fault-tolerant configurations. The supporting SPPF
1564 structure provides a way to include route precedence information to
1565 help manage traffic to more than one outbound egress SBE.
1567 The transport protocol MUST support the ability to Add, Modify, Get,
1568 and Delete Egress Routes (refer the "Framework Operations" section of
1569 this document for a generic description of various operations). The
1570 EgrRteType object structure is defined as follows:
1572
1573
1574
1575
1576
1577
1578
1580
1582
1584
1585
1586
1587
1589 The EgrRteType object is composed of the following elements:
1591 o base: All first class objects extend BasicObjType that contains
1592 the ID of the registrant organization that owns this object, the
1593 date and time that the object was created by the server, and the
1594 date and time that the object was last modified. If the client
1595 passes in either the created date or the modification date, the
1596 server will ignore them. The server sets these two date/time
1597 values.
1599 o egrRteName: The name of the egress route.
1601 o pref: The preference of this egress route relative to other
1602 egress routes that may get selected when responding to a
1603 resolution request.
1605 o regxRewriteRule: The regular expression re-write rule that
1606 should be applied to the regular expression of the ingress
1607 NAPTR(s) that belong to the ingress route.
1609 o ingrRteRec: The ingress route records that the egress route
1610 should be used for.
1612 o ext: Point of extensibility described in a previous section of
1613 this document.
1615 7. Framework Operations
1617 7.1. Add Operation
1619 Any conforming "protocol" specification MUST provide a definition for
1620 the operation that adds one or more SPPF objects into the registry.
1621 If the object, as identified by the request attributes that form part
1622 of the object's key, does not exist, then the registry MUST create
1623 the object. If the object does exist, then the registry MUST replace
1624 the current properties of the object with the properties passed in as
1625 part of the Add operation.
1627 If the entity that issued the command is not authorized to perform
1628 this operation an appropriate error message MUST be returned from
1629 amongst the response messages defined in "Response Message Types"
1630 section of the document.
1632 7.2. Delete Operation
1634 Any conforming "protocol" specification MUST provide a definition for
1635 the operation that deletes one or more SPPF objects from the registry
1636 using the object's key.
1638 If the entity that issued the command is not authorized to perform
1639 this operation an appropriate error message MUST be returned from
1640 amongst the response messages defined in "Response Message Types"
1641 section of the document.
1643 When an object is deleted, any references to that object must of
1644 course also be removed as the SPPF server implementation fulfills the
1645 deletion request. Furthermore, the deletion of a composite object
1646 must also result in the deletion of the objects it contains. As a
1647 result, the following rules apply to the deletion of SPPF object
1648 types:
1650 o Destination Groups: When a destination group is deleted all
1651 public identifiers within that destination group must also be
1652 automatically deleted by the SPPF implementation as part of
1653 fulfilling the deletion request. And any references between
1654 that destination group and any route group must be automatically
1655 removed by the SPPF implementation as part of fulfilling the
1656 deletion request.
1658 o Route Groups: When a route group is deleted any references
1659 between that route group and any destination group must be
1660 automatically removed by the SPPF implementation as part of
1661 fulfilling the deletion request. Similarly any references
1662 between that route group and any route records must be removed
1663 by the SPPF implementation as part of fulfilling the deletion
1664 request. Furthermore, route group offers relating that route
1665 group must also be deleted as part of fulfilling the deletion
1666 request.
1668 o Route Records: When a route record is deleted any references
1669 between that route record and any route group must be removed by
1670 the SPPF implementation as part of fulfilling the deletion
1671 request.
1673 o Public Identifiers: When a public identifier is deleted any
1674 references between that public identifier and its containing
1675 destination group must be removed by the SPPF implementation as
1676 part of fulfilling the deletion request. And any route records
1677 contained directly within that Public Identifier must be deleted
1678 by the SPPF implementation as part of fulfilling the deletion
1679 request.
1681 7.3. Get Operations
1683 At times, on behalf of the registrant, the registrar may need to have
1684 access to SPPF objects that were previously provisioned in the
1685 registry. A few examples include logging, auditing, and pre-
1686 provisioning dependency checking. This query mechanism is limited to
1687 aid provisioning scenarios and should not be confused with query
1688 protocols provided as part of the resolution system (e.g. ENUM and
1689 SIP). Any conforming "protocol" specification MUST provide a
1690 definition for the operation that queries the details of one or more
1691 SPPF objects from the registry using the object's key. If the entity
1692 that issued the command is not authorized to perform this operation
1693 an appropriate error message MUST be returned from amongst the
1694 response messages defined in "Response Message Types" section of the
1695 document.
1697 7.4. Accept Operations
1699 In SPPF, a Route Group Offer can be accepted or rejected by, or on
1700 behalf of, the registrant to whom the Route Group has been offered
1701 (refer "Framework Data Model Objects" section of this document for a
1702 description of the Route Group Offer object). The Accept operation
1703 is used to accept the Route Group Offers. Any conforming "protocol"
1704 specification MUST provide a definition for the operation to accept
1705 Route Group Offers by, or on behalf of the Registrant, using the
1706 Route Group Offer object key.
1708 Not until access to a Route Group has been offered and accepted will
1709 the registrant's organization ID be included in the peeringOrg list
1710 in that Route Group object, and that Route Group's peering
1711 information become a candidate for inclusion in the responses to the
1712 resolution requests submitted by that registrant. A Route Group
1713 Offer that is in the "offered" status is accepted by, or on behalf
1714 of, the registrant to which it has been offered. When the Route
1715 Group Offer is accepted the the Route Group Offer is moved to the
1716 "accepted" status and adds that data recipient's organization ID into
1717 the list of peerOrgIds for that Route Group.
1719 If the entity that issued the command is not authorized to perform
1720 this operation an appropriate error message MUST be returned from
1721 amongst the response messages defined in "Response Message Types"
1722 section of the document.
1724 7.5. Reject Operations
1726 In SPPF, a Route Group Offer object can be accepted or rejected by,
1727 or on behalf of, the registrant to whom the Route Group has been
1728 offered (refer "Framework Data Model Objects" section of this
1729 document for a description of the Route Group Offer object).
1730 Furthermore, that offer may be rejected, regardless of whether or not
1731 it has been previously accepted. The Reject operation is used to
1732 reject the Route Group Offers. When the Route Group Offer is
1733 rejected that Route Group Offer is deleted, and, if appropriate, the
1734 data recipient's organization ID is removed from the list of
1735 peeringOrg IDs for that Route Group. Any conforming "protocol"
1736 specification MUST provide a definition for the operation to reject
1737 Route Group Offers by, or on behalf of the Registrant, using the
1738 Route Group Offer object key.
1740 If the entity that issued the command is not authorized to perform
1741 this operation an appropriate error message MUST be returned from
1742 amongst the response messages defined in "Response Message Types"
1743 section of the document.
1745 7.6. Get Server Details Operation
1747 In SPPF, Get Server Details operation can be used to request certain
1748 details about the SPPF server that include the SPPF server's current
1749 status, the major/minor version of the SPPF protocol supported by the
1750 SPPF server.
1752 Any conforming "protocol" specification MUST provide a definition for
1753 the operation to request such details from the SPPF server. If the
1754 entity that issued the command is not authorized to perform this
1755 operation an appropriate error message MUST be returned from amongst
1756 the response messages defined in "Response Message Types" section of
1757 the document.
1759 8. XML Considerations
1761 XML serves as the encoding format for SPPF, allowing complex
1762 hierarchical data to be expressed in a text format that can be read,
1763 saved, and manipulated with both traditional text tools and tools
1764 specific to XML.
1766 XML is case sensitive. Unless stated otherwise, XML specifications
1767 and examples provided in this document MUST be interpreted in the
1768 character case presented to develop a conforming implementation.
1770 This section discusses a small number of XML-related considerations
1771 pertaining to SPPF.
1773 8.1. Namespaces
1775 All SPPF elements are defined in the namespaces in the IANA
1776 Considerations section and in the Formal Framework Specification
1777 section of this document.
1779 8.2. Versioning and Character Encoding
1781 All XML instances SHOULD begin with an declaration to
1782 identify the version of XML that is being used, optionally identify
1783 use of the character encoding used, and optionally provide a hint to
1784 an XML parser that an external schema file is needed to validate the
1785 XML instance.
1787 Conformant XML parsers recognize both UTF-8 (defined in [RFC3629])
1788 and UTF-16 (defined in [RFC2781]); per [RFC2277] UTF-8 is the
1789 RECOMMENDED character encoding for use with SPPF.
1791 Character encodings other than UTF-8 and UTF-16 are allowed by XML.
1792 UTF-8 is the default encoding assumed by XML in the absence of an
1793 "encoding" attribute or a byte order mark (BOM); thus, the "encoding"
1794 attribute in the XML declaration is OPTIONAL if UTF-8 encoding is
1795 used. SPPF clients and servers MUST accept a UTF-8 BOM if present,
1796 though emitting a UTF-8 BOM is NOT RECOMMENDED.
1798 Example XML declarations:
1800
1802 9. Security Considerations
1804 Many SPPF implementations manage data that is considered confidential
1805 and critical. Furthermore, SPPF implementations can support
1806 provisioning activities for multiple registrars and registrants. As
1807 a result any SPPF implementation must address the requirements for
1808 confidentiality, authentication, and authorization.
1810 With respect to confidentiality and authentication, the transport
1811 protocol requirements section of this document contains security
1812 properties that the transport protocol must provide so that
1813 authenticated endpoints can exchange data confidentially and with
1814 integrity protection. Refer to that section and the resulting
1815 transport protocol specification document for the specific solutions
1816 to authentication and confidentiality.
1818 With respect to authorization, the SPPF server implementation must
1819 define and implement a set of authorization rules that precisely
1820 address (1) which registrars will be authorized to create/modify/
1821 delete each SPPF object type for given registrant(s) and (2) which
1822 registrars will be authorized to view/get each SPPF object type for
1823 given registrant(s). These authorization rules are a matter of
1824 policy and are not specified within the context of SPPF. However,
1825 any SPPF implementation must specify these authorization rules in
1826 order to function in a reliable and safe manner.
1828 In some situations, it may be required to protect against denial of
1829 involvement (see [RFC4949]) and tackle non-repudiation concerns in
1830 regards to SPPF messages. This type of protection is useful to
1831 satisfy authenticity concerns related to SPPF messages beyond the
1832 end-to-end connection integrity, confidentiality, and authentication
1833 protection that the transport layer provides. This is an optional
1834 feature and some SPPF implementations MAY provide support for it.
1836 It is not uncommon for the logging systems to document on-the-wire
1837 messages for various purposes, such as, debug, audit, and tracking.
1838 At the minimum, the various support and administration staff will
1839 have access to these logs. Also, if an unprivileged user gains
1840 access to the SPPF deployments and/or support systems, it will have
1841 access to the information that is potentially deemed confidential.
1842 To manage information disclosure concerns beyond the transport level,
1843 SPPF implementations MAY provide support for encryption at the SPPF
1844 object level.
1846 Anti-replay protection ensures that a given SPPF object replayed at a
1847 later time doesn't affect the integrity of the system. SPPF provides
1848 at least one mechanism to fight against replay attacks. Use of the
1849 optional client transaction identifier allows the SPPF client to
1850 correlate the request message with the response and to be sure that
1851 it is not a replay of a server response from earlier exchanges. Use
1852 of unique values for the client transaction identifier is highly
1853 encouraged to avoid chance matches to a potential replay message.
1855 The SPPF client or registrar can be a separate entity acting on
1856 behalf of the registrant in facilitating provisioning transactions to
1857 the registry. Further, the transport layer provides end-to-end
1858 connection protection between SPPF client and the SPPF server.
1859 Therefore, man-in-the-middle attack is a possibility that may affect
1860 the integrity of the data that belongs to the registrant and/or
1861 expose peer data to unintended actors in case well-established
1862 peering relationships already exist.
1864 10. IANA Considerations
1866 This document uses URNs to describe XML namespaces and XML schemas
1867 conforming to a registry mechanism described in [RFC3688].
1869 Two URI assignments are requested.
1871 Registration request for the SPPF XML namespace:
1872 urn:ietf:params:xml:ns:sppf:base:1
1873 Registrant Contact: IESG
1874 XML: None. Namespace URIs do not represent an XML specification.
1876 Registration request for the XML schema:
1877 URI: urn:ietf:params:xml:schema:sppf:1
1878 Registrant Contact: IESG
1879 XML: See the "Formal Specification" section of this document
1880 (Section 11).
1882 IANA is requested to create a new SPPF registry for Organization
1883 Identifiers that will indicate valid strings to be used for well-
1884 known enterprise namespaces.
1885 This document makes the following assignments for the OrgIdType
1886 namespaces:
1888 Namespace OrgIdType namespace string
1889 ---- ----------------------------
1890 IANA Enterprise Numbers iana-en
1892 11. Formal Specification
1894 This section provides the draft XML Schema Definition for SPPF
1895 Protocol.
1897
1898
1902
1903
1904 ---- Generic Object key
1905 types to be defined by specific
1906 Transport/Architecture.
1907 The types defined here can
1908 be extended by the
1909 specific architecture to
1910 define the Object Identifiers ----
1911
1912
1913
1915
1916
1917 ---- Generic type that
1918 represents the key for various
1919 objects in SPPF. ----
1920
1921
1922
1924
1925
1926
1927
1928
1929 ---- Generic type
1930 that represents
1931 the key for a route
1932 group offer. ----
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943 ----Generic type that
1944 represents the key
1945 for a Pub Id. ----
1946
1947
1948
1949
1950
1952
1953 ---- Object Type Definitions ----
1954
1956
1957
1958
1959
1960
1962
1965
1968
1971
1974
1975
1976
1978
1979
1980
1981
1982
1983
1984
1985
1986
1988
1989
1990
1991
1992
1993
1994
1995
1996
1998
1999
2000
2001
2002
2003
2004
2005
2006
2008
2010
2013
2014
2015
2016
2017
2018
2019
2020
2021
2023
2025
2026
2027
2028
2029
2030
2031
2032
2033
2035
2037
2038
2039
2040
2041
2042
2043
2044
2045
2047
2049
2050
2051
2052
2053
2054
2055
2056
2057
2059
2061
2062
2063
2064
2065
2066
2067
2068
2069
2071
2072
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2137
2138
2139
2140
2141
2142
2143
2144 ---- Abstract Object and
2145 Element Type
2146 Definitions ----
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2305 12. Acknowledgments
2307 This document is a result of various discussions held in the DRINKS
2308 working group and within the DRINKS protocol design team, which is
2309 comprised of the following individuals, in alphabetical order:
2310 Alexander Mayrhofer, David Schwartz, Deborah A Guyton, Lisa
2311 Dusseault, Manjul Maharishi, Mickael Marrache, Otmar Lendl, Richard
2312 Shockey, Samuel Melloul, and Sumanth Channabasappa.
2314 13. References
2316 13.1. Normative References
2318 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
2319 Requirement Levels", BCP 14, RFC 2119, March 1997.
2321 [RFC2277] Alvestrand, H., "IETF Policy on Character Sets and
2322 Languages", BCP 18, RFC 2277, January 1998.
2324 [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO
2325 10646", STD 63, RFC 3629, November 2003.
2327 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
2328 January 2004.
2330 [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
2331 Resource Identifier (URI): Generic Syntax", STD 66,
2332 RFC 3986, January 2005.
2334 [RFC4949] Shirey, R., "Internet Security Glossary, Version 2",
2335 RFC 4949, August 2007.
2337 [RFC5067] Lind, S. and P. Pfautz, "Infrastructure ENUM
2338 Requirements", RFC 5067, November 2007.
2340 13.2. Informative References
2342 [RFC2781] Hoffman, P. and F. Yergeau, "UTF-16, an encoding of ISO
2343 10646", RFC 2781, February 2000.
2345 [RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston,
2346 A., Peterson, J., Sparks, R., Handley, M., and E.
2347 Schooler, "SIP: Session Initiation Protocol", RFC 3261,
2348 June 2002.
2350 [RFC4725] Mayrhofer, A. and B. Hoeneisen, "ENUM Validation
2351 Architecture", RFC 4725, November 2006.
2353 [RFC5321] Klensin, J., "Simple Mail Transfer Protocol", RFC 5321,
2354 October 2008.
2356 [RFC5486] Malas, D. and D. Meyer, "Session Peering for Multimedia
2357 Interconnect (SPEERMINT) Terminology", RFC 5486,
2358 March 2009.
2360 [RFC6116] Bradner, S., Conroy, L., and K. Fujiwara, "The E.164 to
2361 Uniform Resource Identifiers (URI) Dynamic Delegation
2362 Discovery System (DDDS) Application (ENUM)", RFC 6116,
2363 March 2011.
2365 [RFC6461] Channabasappa, S., "Data for Reachability of Inter-/
2366 Intra-NetworK SIP (DRINKS) Use Cases and Protocol
2367 Requirements", RFC 6461, January 2012.
2369 Authors' Addresses
2371 Jean-Francois Mule
2372 CableLabs
2373 858 Coal Creek Circle
2374 Louisville, CO 80027
2375 USA
2377 Email: jfm@cablelabs.com
2379 Kenneth Cartwright
2380 TNS
2381 1939 Roland Clarke Place
2382 Reston, VA 20191
2383 USA
2385 Email: kcartwright@tnsi.com
2387 Syed Wasim Ali
2388 NeuStar
2389 46000 Center Oak Plaza
2390 Sterling, VA 20166
2391 USA
2393 Email: syed.ali@neustar.biz
2395 Alexander Mayrhofer
2396 enum.at GmbH
2397 Karlsplatz 1/9
2398 Wien, A-1010
2399 Austria
2401 Email: alexander.mayrhofer@enum.at
2403 Vikas Bhatia
2404 TNS
2405 1939 Roland Clarke Place
2406 Reston, VA 20191
2407 USA
2409 Email: vbhatia@tnsi.com