DRINKS K. Cartwright
Internet-Draft V. Bhatia
Intended status: Standards Track TNS
Expires: May 18, 2012 November 15, 2011
SPPP Over SOAP and HTTP
draft-ietf-drinks-sppp-over-soap-07
Abstract
The Session Peering Provisioning Protocol (SPPP) is an XML protocol
that exists to enable the provisioning of session establishment data
into Session Data Registries or SIP Service Provider data stores.
Sending XML data structures over Simple Object Access Protocol (SOAP)
and HTTP(s) is a widely used, de-facto standard for messaging between
elements of provisioning systems. Therefore the combination of SOAP
and HTTP(s) as a transport for SPPP is a natural fit. The obvious
benefits include leveraging existing industry expertise, leveraging
existing standards, and a higher probability that existing
provisioning systems can be more easily integrated with this
protocol. This document describes the specification for transporting
SPPP XML structures over SOAP and HTTP(s).
Status of this Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on May 18, 2012.
Copyright Notice
Copyright (c) 2011 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
Cartwright & Bhatia Expires May 18, 2012 [Page 1]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
(http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4
2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 5
3. SOAP Features and Protocol Layering . . . . . . . . . . . . . 6
4. HTTP(s) Features and SPPP . . . . . . . . . . . . . . . . . . 9
5. Authentication and Session Management . . . . . . . . . . . . 10
6. SPPP SOAP Data Structures . . . . . . . . . . . . . . . . . . 11
6.1. Concrete Object Key Types . . . . . . . . . . . . . . . . 11
6.1.1. Generic Object Key . . . . . . . . . . . . . . . . . . 11
6.1.2. Public Identity Object Key . . . . . . . . . . . . . . 12
6.1.3. Route Group Offer Key . . . . . . . . . . . . . . . . 13
6.2. Operation Request and Response Structures . . . . . . . . 13
6.2.1. Add Operation Structure . . . . . . . . . . . . . . . 13
6.2.2. Delete Operation Structure . . . . . . . . . . . . . . 17
6.2.3. Accept Operation Structure . . . . . . . . . . . . . . 20
6.2.4. Reject Operation Structure . . . . . . . . . . . . . . 23
6.2.5. Batch Operation Structure . . . . . . . . . . . . . . 26
6.2.6. Get Operation Structure . . . . . . . . . . . . . . . 29
6.2.7. Get Route Group Offers Operation Structure . . . . . . 31
6.2.8. Generic Query Response . . . . . . . . . . . . . . . . 32
6.2.9. Get Server Details Operation Structure . . . . . . . . 33
6.3. Response Codes and Messages . . . . . . . . . . . . . . . 35
7. Protocol Operations . . . . . . . . . . . . . . . . . . . . . 37
8. SPPP SOAP WSDL Definition . . . . . . . . . . . . . . . . . . 38
9. SPPP SOAP Examples . . . . . . . . . . . . . . . . . . . . . . 49
9.1. Add Destination Group . . . . . . . . . . . . . . . . . . 49
9.2. Add Route Records . . . . . . . . . . . . . . . . . . . . 51
9.3. Add Route Records -- URIType . . . . . . . . . . . . . . . 52
9.4. Add Route Group . . . . . . . . . . . . . . . . . . . . . 53
9.5. Add Public Identity -- Successful COR claim . . . . . . . 55
9.6. Add LRN . . . . . . . . . . . . . . . . . . . . . . . . . 57
9.7. Add TN Range . . . . . . . . . . . . . . . . . . . . . . . 58
9.8. Add TN Prefix . . . . . . . . . . . . . . . . . . . . . . 59
9.9. Enable Peering -- Route Group Offer . . . . . . . . . . . 60
9.10. Enable Peering -- Route Group Offer Accept . . . . . . . . 62
9.11. Add Egress Route . . . . . . . . . . . . . . . . . . . . . 63
9.12. Remove Peering -- Route Group Offer Reject . . . . . . . . 65
9.13. Get Destination Group . . . . . . . . . . . . . . . . . . 66
Cartwright & Bhatia Expires May 18, 2012 [Page 2]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
9.14. Get Public Identity . . . . . . . . . . . . . . . . . . . 68
9.15. Get Route Group Request . . . . . . . . . . . . . . . . . 69
9.16. Get Route Group Offers Request . . . . . . . . . . . . . . 71
9.17. Get Egress Route . . . . . . . . . . . . . . . . . . . . . 73
9.18. Delete Destination Group . . . . . . . . . . . . . . . . . 74
9.19. Delete Public Identity . . . . . . . . . . . . . . . . . . 75
9.20. Delete Route Group Request . . . . . . . . . . . . . . . . 77
9.21. Delete Route Group Offers Request . . . . . . . . . . . . 78
9.22. Delete Egress Route . . . . . . . . . . . . . . . . . . . 79
9.23. Batch Request . . . . . . . . . . . . . . . . . . . . . . 80
10. Security Considerations . . . . . . . . . . . . . . . . . . . 83
10.1. Integrity, Privacy, and Authentication . . . . . . . . . . 83
10.2. Vulnerabilities . . . . . . . . . . . . . . . . . . . . . 83
10.3. Deployment Environment Specifics . . . . . . . . . . . . . 83
11. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 84
12. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 85
13. References . . . . . . . . . . . . . . . . . . . . . . . . . . 86
13.1. Normative References . . . . . . . . . . . . . . . . . . . 86
13.2. Informative References . . . . . . . . . . . . . . . . . . 86
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 87
Cartwright & Bhatia Expires May 18, 2012 [Page 3]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
1. Introduction
SPPP, defined in [I-D.draft-ietf-drinks-spprov], is best supported by
a transport and messaging infrastructure that is connection oriented,
request-response oriented, easily secured, supports propagation
through firewalls in a standard fashion, and that is easily
integrated into back-office systems. This is due to the fact that
the client side of SPPP is likely to be integrated with
organizations' operational support systems that facilitate
transactional provisioning of user addresses and their associated
session establishment data. While the server side of SPPP is likely
to reside in a separate organization's network, resulting the SPPP
provisioning transactions traversing the Internet as they are
propagated from the SPPP client to the SPPP server. Given the
current state of industry practice and technologies, SOAP and HTTP(s)
are well suited for this type of environment. This document
describes the specification for transporting SPPP XML structures over
SOAP and HTTP(s).
The specification in this document for transporting SPPP XML
structures over SOAP and HTTP(s) is primarily comprised of five
subjects: (1) a description of any applicable SOAP features, (2) any
applicable HTTP features, (3) security considerations, and perhaps
most importantly, (4) the Web Services Description Language (WSDL)
definition for SPPP over SOAP, and (5) "transport" specific XML
schema type definitions
Cartwright & Bhatia Expires May 18, 2012 [Page 4]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
2. Terminology
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC2119].
Cartwright & Bhatia Expires May 18, 2012 [Page 5]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
3. SOAP Features and Protocol Layering
The list of SOAP features that are explicitly used and required for
SPPP are limited. Most SOAP features are not necessary for SPPP.
SPPP primarily uses SOAP simply as a standard message envelope
technology. The SOAP message envelope is comprised of the SOAP
header and body. As described in the SOAP specifications, the SOAP
header can contain optional, application specific, information about
the message. The SOAP body contains the SPPP message itself, whose
structure is defined by the combination of one of the WSDL operations
defined in this document and the SPPP XML data structures defined in
this document and the SPPP protocol document. SPPP does not rely on
any data elements in the SOAP header. All relevant data elements are
defined in the SPPP XML schema described in
[I-D.draft-ietf-drinks-spprov] and the SPPP WSDL types specification
described in this document.
WSDL is a widely standardized and adopted technology for defining the
top-level structures of the messages that are transported within the
body of a SOAP message. The WSDL definition for the SPPP SOAP
messages is defined later in this document, which imports by
reference the XML data types contained in the SPPP schema. The IANA
registry where the SPPP schema resides is described in The IETF XML
Registry [RFC3688].
There are multiple structural styles that SOAP WSDL allows. But the
best practice for this type of application is what is sometimes
referred to as the Document Literal Wrapped style of designing SOAP
WSDL. This style is generally regarded as an optimal approach that
enhances maintainability, comprehension, portability, and, to a
certain extent, performance. It is characterized by setting the
soapAction binding style as _document_, the soapAction encoding style
as _literal_, and then defining the SOAP messages to simply contain a
single data element that _wraps_ a data structure containing all the
required input or output data elements. The figure below illustrates
this high level technical structure as conceptual layers 3 through 6.
Cartwright & Bhatia Expires May 18, 2012 [Page 6]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
+-------------+
(1) | Transport |Example:
| Protocol | TCP, TLS, BEEP, etc.
+-------------+
|
V
+-------------+
(2) | Message |Example:
| Envelope | HTTP, SOAP, None, etc.
+-------------+
|
V
+--------------+
+------| SOAP |-----+
| (3) | Operation | |
Contains | +--------------+ | Contains
| Example: |
V submitAddRqst V
+--------------+ +-------------+
|SOAP Request | |SOAP Response|
Example:| Message | (4) | Message | Example:
spppAdd | (Operation | | (Operation | spppAdd
RequestMsg | Input) | | Output) | ResponseMsg
+--------------+ +-------------+
| |
Contains | | Contains
| |
V V
+---------------+ +---------------+
Example:| Wrapped | (5) | Wrapped | Example:
spppAdd |Request Object | |Response Object| spppAdd
Request +---------------+ +---------------+ Response
| |
Contains | | Contains
| |
V V
+-------------+ +---------------+
| SPPP | | SPPP |
|XML Types | (6) | XML Types |
+-------------+ +---------------+
Figure 1: Layering and Technical Structure of the SPPP SOAP Messages
The SOAP operations supported by SPPP are normatively defined later
in this document. Each SOAP operation defines a request/input
message and a response/output message. Each such request and
response message then contains a single object that wraps the SPPP
XML data types that comprise the inputs and the outputs,
Cartwright & Bhatia Expires May 18, 2012 [Page 7]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
respectively, of the SOAP operation.
SOAP faults are not used by the SPPP SOAP mapping. All SPPP success
and error responses are specified in the "Response Codes and
Messages" section of this document. However, if a SOAP fault were to
occur, perhaps due to failures in the SOAP message handling layer of
a SOAP library, the client application should capture and handle the
fault. Specifics on how to handle such SOAP faults, if they should
occur, will be specific to the chosen SOAP implementation.
SOAP 1.2 [SOAPREF] or higher and WSDL 1.1 [WSDLREF] or higher SHOULD
be used.
SPPP is a request/reply protocol that allows a client application to
submit provisioning data and query requests to a server. The SPPP
data structures are designed to be protocol agnostic. Concerns
regarding encryption, non-repudiation, and authentication are beyond
the scope of this document. For more details, please refer to the
"Transport Protocol Requirements" section in the protocol document.
As illustrated in the previous diagram, SPPP can be viewed as a set
of layers that collectively define the structure of an SPPP request
and response. Layers 1 and 2 represent the transport, envelope, and
authentication technologies. This document defines layers 3, 4, 5,
and 6 below.
1. Layer 1: The transport protocol layer represents the
communication mechanism between the client and server. SPPP can
be layered over any transport protocol that provides a set of
basic requirements defined in the Transport Protocol Requirements
section. But this document specifies the required mechanism.
2. Layer 2: The message envelope layer is optional, but can provide
features that are above the transport technology layer but below
the application messaging layer. Technologies such as HTTP and
SOAP are examples of messaging envelope technologies. This
document specifies the required envelope technology.
3. Layers 3,4,5,6: The operation and message layers provides an
envelope-independent and transport-independent wrapper for the
SPPP data model objects that are being acted on (created,
modified, queried).
Cartwright & Bhatia Expires May 18, 2012 [Page 8]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
4. HTTP(s) Features and SPPP
SOAP is not tied to HTTP(s), however, for reasons described in the
introduction, HTTP(s) is a good choice as the transport mechanism for
the SPPP SOAP messages. HTTP 1.1 includes the "persistent
connection" feature, which allows multiple HTTP request/response
pairs to be transported across a single HTTP connection. This is an
important performance optimization feature, particularly when the
connections is an HTTPS connection where the relatively time
consuming SSL handshake has occurred. Persistent connections SHOULD
be used for the SPPP HTTP connections.
HTTP 1.1 [RFC2616] or higher SHOULD be used.
Cartwright & Bhatia Expires May 18, 2012 [Page 9]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
5. Authentication and Session Management
To achieve integrity and privacy, conforming SPPP SOAP Clients and
Servers MUST support SOAP over HTTP over TLS [RFC5246] as the secure
transport mechanism. This combination of HTTP and TLS is referred to
as HTTPS. And to accomplish authentication, conforming SOAP SPPP
Clients and Servers MUST use HTTP Digest Authentication as defined in
[RFC2617]. As a result, the communication session is established
through the initial HTTP connection setup, the digest authentication,
and the TLS handshake. When the HTTP connection is broken down, the
communication session ends.
Cartwright & Bhatia Expires May 18, 2012 [Page 10]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
6. SPPP SOAP Data Structures
SPPP over SOAP uses a set of XML based data structures for all the
supported operations and any parameters that those operations are
applied to. As also mentioned earlier in this document, these XML
structures are envelope-independent and transport-independent. Refer
the "Protocol Operations" section of document for a description of
all the operations that MUST be supported.
The following sections describe the definition all the XML data
structures.
6.1. Concrete Object Key Types
Certain SPPP operations require an object key that uniquely
identifies the object on which a given operation needs to be
performed. The following sub-sections define the various types of
concrete object key types used in certain operations:
6.1.1. Generic Object Key
Most objects in SPPP are unqiuely identified by the attributes in the
concrete ObjKeyType. The definition of ObjKeyType is as below:
The ObjKeyType has the data elements as described below:
o rant: The identifier of the registrant organization that owns
the object.
o name: The character string that contains the name of the object.
Cartwright & Bhatia Expires May 18, 2012 [Page 11]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
o type: The enumeration vaue that represents the type of SPPP
object.
6.1.2. Public Identity Object Key
Public Identity type objects can further be of various sub-types like
a TN, RN, TN Prefix, or a TN Range and cannot be cleanly identified
with the attributes in the generic ObjKeyType. The definition of
PubIdKeyType is as below:
The PubIdKeyType has the data elements as described below:
o rant: The identifier of the registrant organization that owns
the object.
o dgName: The name of the Destination Group that a Public
Identifier is member of. Note that this is an optional
attribute of the key as Public Identifiers may or may not be
provisioned as members of a Destination Group.
o number: An element of type NumberType (refer protocol document)
that contains the value and type of a the number .
o range: An element of type NumberRangeType (refer protocol
document) that contains a rage of numbers.
Cartwright & Bhatia Expires May 18, 2012 [Page 12]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
It is MUST that only one of the "number" and "range" elements appears
in a PubIdKeyType instance.
6.1.3. Route Group Offer Key
In addition to the attributes in the generic ObjKeyType, a Route
Group Offer object is uniquely identified by the organization ID of
the organization to whom an Route Group has been offered. The
definition of RteGrpOfferKeyType is as below:
The RteGrpOfferKeyType has the data elements as described below:
o rteGrpKey: Identifies the Route Group that was offered.
o offeredTo: The organization ID of the organization that was
offered the Route Group object identified by the rteGrpKey.
6.2. Operation Request and Response Structures
An SPPP client interacts with an SPPP server by using one of the
supported transport mechanisms to send one or more requests to the
server and receive corresponding replies from the server. The basic
set of operations that an SPPP client can submit to an SPPP server
and the semantics of those operations are defined in the "Protocol
Operations" section of the protocol document. The following sub-
sections describe the XML data structures that are used for each of
those types of operations for a SOAP based SPPP implementation.
6.2.1. Add Operation Structure
In order to add (or modify) an object in the registry, an authorized
entity can send the spppAddRequest to the registry.
Cartwright & Bhatia Expires May 18, 2012 [Page 13]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
An SPPP Add request is wrapped within the element
while an SPPP Add response is wrapped within an
element. The following sub-sections describe the spppAddRequest and
spppAddResponse elements. Refer the "SPPP SOAP Examples" section of
this document for an example of Add operation on each type of SPPP
object.
6.2.1.1. Add Request
An SPPP Add request definition is contained within the generic
element.
The data elements within the element are described
as follows:
o clientTransId: Zero or one client-generated transaction ID that,
within the context of the SPPP client, identifies this request.
This value can be used at the discretion of the SPPP client to
track, log or correlate requests and their responses. SPPP
server MUST echo back this value to the client in the
corresponding response to the incoming request. SPPP server
will not check this value for uniqueness.
Cartwright & Bhatia Expires May 18, 2012 [Page 14]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
o minorVer: Zero or one minor version identifier, indicating the
minor version of the SPPP API that the client is attempting to
use. This is used in conjunction with the major version
identifier in the XML namespace to identify the version of SPPP
that the client is using. If the element is not present, the
server assumes that the client is using the latest minor version
supported by the SPPP server for the given major version. The
versions supported by a given SPPP server can be retrieved by
the client using the SPPP server menu operation described later
in the document.
o obj: One or more elements of abstract type BasicObjType (defined
in the protocol document). Each element contains all the
attributes of an SPPP object that that the client is requesting
the SPPP server to add. Refer the "Protocol Data Model Objects"
section of the protocol document for the XML structure of all
concrete types, for various SPPP objects, that extend from
abstract BasicObjType and hence are eligible to be passed into
this element. The elements are processed by the SPPP server in
the order in which they are included in the request. With
respect to handling of error conditions, it is a matter of
policy whether the objects are processed in a "stop and
rollback" fashion or in a "stop and commit" fashion. In the
"stop and rollback" scenario, the SPPP server would stop
processing BasicObjType elements in the request at the first
error and roll back any BasicObjType elements that had already
been processed for that add request. In the "stop and commit"
scenario the SPPP server would stop processing BasicObjType
elements in the request at the first error but commit any
BasicObjType elements that had already been processed for that
add request.
6.2.1.2. Add Response
An SPPP add response object is contained within the generic
element. This response structure is used for all
types of SPPP objects that are provisioned by the SPPP client.
Cartwright & Bhatia Expires May 18, 2012 [Page 15]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
An contains the elements necessary for the SPPP
client to precisely determine the overall result of the request, and
if an error occurred, it provides information about the specific
object(s) that caused the error.
The data elements within the SPPP Add response are described as
follows:
o clientTransId: Zero or one client transaction ID. This value is
simply an echo of the client transaction ID that SPPP client
passed into the SPPP update request. When included in the
request, the SPPP server MUST return it in the corresponding
response message.
o serverTransId: Exactly one server transaction ID that identifies
this request for tracking purposes. This value MUST be unique
Cartwright & Bhatia Expires May 18, 2012 [Page 16]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
for a given SPPP server.
o overallResult: Exactly one response code and message pair that
explicitly identifies the result of the request. See the
Response Code section for further details.
o dtlResult: An optional response code, response message, and
BasicObjType (as defined in the protocol document) triplet.
This element will be present only if an object level error has
occurred. It indicates the error condition and the exact
request object that contributed to the error. The response code
will reflect the exact error. See the Response Code section for
further details.
6.2.2. Delete Operation Structure
In order to remove an object from the registry, an authorized entity
can send the spppDelRequest into the registry. An SPPP Del request
is wrapped within the element while a SPPP Del
response is wrapped within the generic element.
The following sub-sections describe the spppDelRequest and
spppDelResponse elements. Refer the "SPPP SOAP Examples" section of
this document for an example of Delete operation on each type of SPPP
object.
6.2.2.1. Delete Request
An SPPP Del request definition is contained within the generic
element.
Cartwright & Bhatia Expires May 18, 2012 [Page 17]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
The data elements within the element are described
as follows:
o clientTransId: Zero or one client-generated transaction ID that,
within the context of the SPPP client, identifies this request.
This value can be used at the discretion of the SPPP client to
track, log or correlate requests and their responses. SPPP
server MUST echo back this value to the client in the
corresponding response to the incoming request. SPPP server
will not check this value for uniqueness.
o minorVer: Zero or one minor version identifier, indicating the
minor version of the SPPP API that the client is attempting to
use. This is used in conjunction with the major version
identifier in the XML namespace to identify the version of SPPP
that the client is using. If the element is not present, the
server assumes that the client is using the latest minor version
supported by the SPPP server for the given major version. The
versions supported by a given SPPP server can be retrieved by
the client using the SPPP server menu operation described later
in the document.
o objKey: One or more elements of abstract type ObjKeyType (as
defined in the protocol document). Each element contains
attributes that uniquely identify the object that the client is
requesting the server to delete. Refer the "Concrete Object
Keys" section of this document for a description of all concrete
object key types, for various SPPP objects, which are eligible
to be passed into this element. The elements are processed by
the SPPP server in the order in which they are included in the
request. With respect to handling of error conditions, it is a
matter of policy whether the objects are processed in a "stop
and rollback" fashion or in a "stop and commit" fashion. In the
"stop and rollback" scenario, the SPPP server would stop
processing ObjKeyType elements in the request at the first error
and roll back any ObjKeyType elements that had already been
processed for that delete request. In the "stop and commit"
scenario the SPPP server would stop processing ObjKeyType
elements in the request at the first error but commit any
KeyParamType elements that had already been processed for that
delete request.
6.2.2.2. Delete Response
An SPPP delete response object is contained within the generic
element. This response structure is used for a
delete request on all types of SPPP objects that are provisioned by
the SPPP client.
Cartwright & Bhatia Expires May 18, 2012 [Page 18]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
An contains the elements necessary for the SPPP
client to precisely determine the overall result of the request, and
if an error occurred, it provides information about the specific
object key(s) that caused the error.
The data elements within the SPPP Delete response are described as
follows:
o clientTransId: Zero or one client transaction ID. This value is
simply an echo of the client transaction ID that SPPP client
passed into the SPPP update request. When included in the
request, the SPPP server MUST return it in the corresponding
response message.
o serverTransId: Exactly one server transaction ID that identifies
this request for tracking purposes. This value MUST be unique
Cartwright & Bhatia Expires May 18, 2012 [Page 19]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
for a given SPPP server.
o overallResult: Exactly one response code and message pair that
explicitly identifies the result of the request. See the
Response Code section for further details.
o dtlResult: An optional response code, response message, and
ObjKeyType (as defined in the protocol document) triplet. This
element will be present only if an specific object key level
error has occurred. It indicates the error condition and the
exact request object key that contributed to the error. The
response code will reflect the exact error. See the Response
Code section for further details.
6.2.3. Accept Operation Structure
In SPPP, a Route Group Offer can be accepted or rejected by, or on
behalf of, the registrant to whom the Route Group has been offered
(refer "Protocol Data Model Objects" section of the protocol document
for a description of the Route Group Offer object). The Accept
operation is used to accept such Route Group Offers by, or on behalf
of, the Registrant. The request structure for an SPPP Accept
operation is wrapped within the element while an
SPPP Accept response is wrapped within the generic
element. The following sub-sections describe
the spppAcceptRequest and spppAcceptResponse elements. Refer the
"SPPP SOAP Examples" section of this document for an example of
Accept operation on a Route Group Offer.
6.2.3.1. Accept Request Structure
An SPPP Accept request definition is contained within the generic
element.
Cartwright & Bhatia Expires May 18, 2012 [Page 20]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
The data elements within the element are
described as follows:
o clientTransId: Zero or one client-generated transaction ID that,
within the context of the SPPP client, identifies this request.
This value can be used at the discretion of the SPPP client to
track, log or correlate requests and their responses. SPPP
server MUST echo back this value to the client in the
corresponding response to the incoming request. SPPP server
will not check this value for uniqueness.
o minorVer: Zero or one minor version identifier, indicating the
minor version of the SPPP API that the client is attempting to
use. This is used in conjunction with the major version
identifier in the XML namespace to identify the version of SPPP
that the client is using. If the element is not present, the
server assumes that the client is using the latest minor version
supported by the SPPP server for the given major version. The
versions supported by a given SPPP server can be retrieved by
the client using the SPPP server menu operation described later
in the document.
o rteGrpOfferKey: One or more elements of type RteGrpOfferKeyType
(as defined in this document). Each element contains attributes
that uniquely identify a Route Group Offer that the client is
requesting the server to accept. The elements are processed by
the SPPP server in the order in which they are included in the
request. With respect to handling of error conditions, it is a
matter of policy whether the objects are processed in a "stop
and rollback" fashion or in a "stop and commit" fashion. In the
"stop and rollback" scenario, the SPPP server would stop
processing RteGrpOfferKeyType elements in the request at the
first error and roll back any RteGrpOfferKeyType elements that
had already been processed for that accept request. In the
"stop and commit" scenario the SPPP server would stop processing
RteGrpOfferKeyType elements in the request at the first error
but commit any RteGrpOfferKeyType elements that had already been
processed for that accept request.
Cartwright & Bhatia Expires May 18, 2012 [Page 21]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
6.2.3.2. Accept Response
An SPPP accept response structure is contained within the generic
element. This response structure is used for an
Accept request on a Route Group Offer.
An contains the elements necessary for the SPPP
client to precisely determine the overall result of the request, and
if an error occurred, it provides information about the specific
Route Group Offer key(s) that caused the error.
The data elements within the SPPP Accept response are described as
follows:
Cartwright & Bhatia Expires May 18, 2012 [Page 22]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
o clientTransId: Zero or one client transaction ID. This value is
simply an echo of the client transaction ID that SPPP client
passed into the SPPP update request. When included in the
request, the SPPP server MUST return it in the corresponding
response message.
o serverTransId: Exactly one server transaction ID that identifies
this request for tracking purposes. This value MUST be unique
for a given SPPP server.
o overallResult: Exactly one response code and message pair that
explicitly identifies the result of the request. See the
Response Code section for further details.
o dtlResult: An optional response code, response message, and
RteGrpOfferKeyType (as defined in this document) triplet. This
element will be present only if any specific Route Group Offer
key level error has occurred. It indicates the error condition
and the exact request Route Group Offer key that contributed to
the error. The response code will reflect the exact error. See
the Response Code section for further details.
6.2.4. Reject Operation Structure
In SPPP, Route Group Offer can be accepted or rejected by, or on
behalf of, the registrant to whom the Route Group has been offered
(refer "Protocol Data Model Objects" section of this document for a
description of the Route Group Offer object). The Reject operation
is used to reject such Route Group Offers by, or on behalf of, the
Registrant. The request structure for an SPPP Reject operation is
wrapped within the element while an SPPP Reject
response is wrapped within the generic element.
The following sub-sections describe the spppRejectRequest and
spppRejecResponse elements. Refer the "SPPP SOAP Examples" section
of this document for an example of Reject operation on a Route Group
Offer.
6.2.4.1. Reject Request
An SPPP Reject request definition is contained within the generic
element.
Cartwright & Bhatia Expires May 18, 2012 [Page 23]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
The data elements within the element are
described as follows:
o clientTransId: Zero or one client-generated transaction ID that,
within the context of the SPPP client, identifies this request.
This value can be used at the discretion of the SPPP client to
track, log or correlate requests and their responses. SPPP
server MUST echo back this value to the client in the
corresponding response to the incoming request. SPPP server
will not check this value for uniqueness.
o minorVer: Zero or one minor version identifier, indicating the
minor version of the SPPP API that the client is attempting to
use. This is used in conjunction with the major version
identifier in the XML namespace to identify the version of SPPP
that the client is using. If the element is not present, the
server assumes that the client is using the latest minor version
supported by the SPPP server for the given major version. The
versions supported by a given SPPP server can be retrieved by
the client using the SPPP server menu operation described later
in the document.
o rteGrpOfferKey: One or more elements of type RteGrpOfferKeyType
(as defined in this document). Each element contains attributes
that uniquely identify a Route Group Offer that the client is
requesting the server to reject. The elements are processed by
the SPPP server in the order in which they are included in the
request. With respect to handling of error conditions, it is a
matter of policy whether the objects are processed in a "stop
and rollback" fashion or in a "stop and commit" fashion. In the
"stop and rollback" scenario, the SPPP server would stop
processing RteGrpOfferKeyType elements in the request at the
first error and roll back any RteGrpOfferKeyType elements that
Cartwright & Bhatia Expires May 18, 2012 [Page 24]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
had already been processed for that reject request. In the
"stop and commit" scenario the SPPP server would stop processing
RteGrpOfferKeyType elements in the request at the first error
but commit any RteGrpOfferKeyType elements that had already been
processed for that reject request.
6.2.4.2. Reject Response
An SPPP reject response structure is contained within the generic
element. This response structure is used for an
Reject request on a Route Group Offer.
An contains the elements necessary for the SPPP
Cartwright & Bhatia Expires May 18, 2012 [Page 25]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
client to precisely determine the overall result of the request, and
if an error occurred, it provides information about the specific
Route Group Offer key(s) that caused the error.
The data elements within the SPPP Reject response are described as
follows:
o clientTransId: Zero or one client transaction ID. This value is
simply an echo of the client transaction ID that SPPP client
passed into the SPPP update request. When included in the
request, the SPPP server MUST return it in the corresponding
response message.
o serverTransId: Exactly one server transaction ID that identifies
this request for tracking purposes. This value MUST be unique
for a given SPPP server.
o overallResult: Exactly one response code and message pair that
explicitly identifies the result of the request. See the
Response Code section for further details.
o dtlResult: An optional response code, response message, and
RteGrpOfferKeyType (as defined in this document) triplet. This
element will be present only if any specific Route Group Offer
key level error has occurred. It indicates the error condition
and the exact request Route Group Offer key that contributed to
the error. The response code will reflect the exact error. See
the Response Code section for further details.
6.2.5. Batch Operation Structure
An SPPP Batch request XML structure allows the SPPP client to send
any of of Add, Del, Accept or Reject operations together in one
single request. This gives an SPPP Client the flexibility to use one
single request structure to perform more than operations (verbs).
The batch request structure is wrapped within the
element while a SPPP Batch response is wrapped within the
element. This following sub-sections describe
the spppBatchRequest and spppBatchResponse elements. Refer the "SPPP
SOAP Examples" section of this document for an example of a batch
operation.
6.2.5.1. Batch Request Structure
An SPPP Batch request definition is contained within the generic
element.
Cartwright & Bhatia Expires May 18, 2012 [Page 26]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
The data elements within the element are described
as follows:
o clientTransId: Zero or one client-generated transaction ID that,
within the context of the SPPP client, identifies this request.
This value can be used at the discretion of the SPPP client to
track, log or correlate requests and their responses. SPPP
server MUST echo back this value to the client in the
corresponding response to the incoming request. SPPP server
will not check this value for uniqueness.
o minorVer: Zero or one minor version identifier, indicating the
minor version of the SPPP API that the client is attempting to
use. This is used in conjunction with the major version
identifier in the XML namespace to identify the version of SPPP
that the client is using. If the element is not present, the
server assumes that the client is using the latest minor version
supported by the SPPP server for the given major version. The
versions supported by a given SPPP server can be retrieved by
the client using the SPPP server menu operation described later
in the document.
o addObj: One or more elements of abstract type BasicObjType where
each element identifies an object that needs to be added.
o delObj: One or more elements of abstract type ObjKeyType where
each element identifies a key for the object that needs to be
deleted .
Cartwright & Bhatia Expires May 18, 2012 [Page 27]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
o acceptRteGrpOffer: One or more elements of type
RteGrpOfferKeyType where each element identifies a Route Group
Offer that needs to be accepted.
o rejectRteGrpOffer: One or more elements of type
RteGrpOfferKeyType where each element identifies a Route Group
Offer that needs to be rejected.
With respect to handling of error conditions, it is a matter of
policy whether the batch operation processed in a "stop and rollback"
fashion or in a "stop and commit" fashion. In the "stop and
rollback" scenario, the SPPP server would stop processing elements in
the request at the first error and roll back any elements that had
already been processed for that batch request. In the "stop and
commit" scenario the SPPP server would stop processing elements in
the request at the first error but commit any elements that had
already been processed for that batch request.
6.2.5.2. Batch Response
An SPPP batch response structure is contained within the generic
element. This response structure is used for an
Batch request that contains many different types of SPPP operations.
Cartwright & Bhatia Expires May 18, 2012 [Page 28]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
An contains the elements necessary for an SPPP
client to precisely determine the overall result of various
operations in the request, and if an error occurred, it provides
information about the specific objects or keys in the request that
caused the error.
The data elements within the SPPP Batch response are described as
follows:
o clientTransId: Zero or one client transaction ID. This value is
simply an echo of the client transaction ID that SPPP client
passed into the SPPP update request. When included in the
request, the SPPP server MUST return it in the corresponding
response message.
o serverTransId: Exactly one server transaction ID that identifies
this request for tracking purposes. This value MUST be unique
for a given SPPP server.
o overallResult: Exactly one response code and message pair that
explicitly identifies the result of the request. See the
Response Code section for further details.
o addResult: One or more elements of type ObjResultCodeType where
each element identifies the result code, result message and the
specific object that the result relates to.
o delResult: One or more elements of type ObjKeyResultCodeType
where each element identifies the result code, result message
and the specific object key that the result relates to.
o acceptResult: One or more elements of type
RteGrpOfferKeyResultCodeType where each element identifies the
result code, result message and the specific Route Group Offer
key that the result relates to.
o rejectResult: One or more elements of type
RteGrpOfferKeyResultCodeType where each element identifies the
result code, result message and the specific Route Group Offer
key that the result relates to.
6.2.6. Get Operation Structure
In order to query the details of an object from the Registry, an
authorized entity can send the spppGetRequest to the registry with a
GetRqstType XML data structure containing one or more object keys
that uniquely identify the object whose details are being queried.
The request strcuture for an SPPP Get operation is contained within
Cartwright & Bhatia Expires May 18, 2012 [Page 29]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
the generic element while an SPPP Get response is
wrapped within the generic element. The following
sub-sections describe the spppGetRequest and spppGetResponse element.
Refer the examples section for an example of Get operation on each
type of SPPP object
6.2.6.1. Get Request
The data elements within the element are described
as follows:
o minorVer: Zero or one minor version identifier, indicating the
minor version of the SPPP API that the client is attempting to
use. This is used in conjunction with the major version
identifier in the XML namespace to identify the version of SPPP
that the client is using. If the element is not present, the
server assumes that the client is using the latest minor version
supported by the SPPP server for the given major version. The
versions supported by a given SPPP server can be retrieved by
the client using the SPPP server menu operation described later
in the document.
o objKey: One or more elements of abstract type ObjKeyType (as
defined in the protocol document). Each element contains
attributes that uniquely identify the object that the client is
requesting the server to query. Refer the "Concrete Object
Keys" section of this document for a description of all concrete
object key types, for various SPPP objects, which are eligible
to be passed into this element.
Cartwright & Bhatia Expires May 18, 2012 [Page 30]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
6.2.6.2. Get Response
The spppGetResponse element is described later in section titled
"Generic Query Response".
6.2.7. Get Route Group Offers Operation Structure
In addition to the ability to query the details of one or more Route
Group offers using an a Route Group Offer key in the spppGetRequest,
this operation also provides an additonal, more flexible, structure
to query for Route Group Offer objects. This additional structure is
contained within the element while the
response is wrapped within the generic element.
The following sub-sections describe the getRteGrpOffersRequest and
spppGetResponse elements.
6.2.7.1. Get Route Group Offers Request
Using the details passed into this structure, the server will attempt
to find Route Group Offer objects that satisfy all the criteria
passed into the request. If no criteria is passed in then the server
will return the list of Route Group Offer objects that belongs to the
registrant. If there are no matching Route Group Offers found then
an empty result set will be returned.
The data elements within the element are
described as follows:
Cartwright & Bhatia Expires May 18, 2012 [Page 31]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
o minorVer: Zero or one minor version identifier, indicating the
minor version of the SPPP API that the client is attempting to
use. This is used in conjunction with the major version
identifier in the XML namespace to identify the version of SPPP
that the client is using. If the element is not present, the
server assumes that the client is using the latest minor version
supported by the SPPP server for the given major version. The
versions supported by a given SPPP server can be retrieved by
the client using the SPPP server menu operation described later
in the document.
o offeredBy: Zero or more organization IDs. Only offers that are
offered to the organization IDs in this list should be included
in the result set. The result set is also subject to other
query criteria in the request.
o offeredTo: Zero or more organization IDs. Only offers that are
offered by the organization IDs in this list should be included
in the result set. The result set is also subject to other
query criteria in the request.
o status: The status of the offer, offered or accepted. Only
offers in the specified status should be included in the result
set. If this element is not present then the status of the
offer should not be considered in the query. The result set is
also subject to other query criteria in the request.
o rteGrpOfferKey: Zero or more Route Group Offer Keys. Only
offers having one of these keys should be included in the result
set. The result set is also subject to other query criteria in
the request.
6.2.7.2. Get Route Group Offers Response
The spppGetResponse element is described later in section titled
"Generic Query Response".
6.2.8. Generic Query Response
An SPPP query response object is contained within the generic
element.
Cartwright & Bhatia Expires May 18, 2012 [Page 32]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
An contains the elements necessary for the SPPP
client to precisely determine the overall result of the query, and
details of any SPPP objects that matched the criteria in the request.
The data elements within the SPPP query response are described as
follows:
o overallResult: Exactly one response code and message pair that
explicitly identifies the result of the request. See the
Response Code section for further details.
o resultObj: The set of zero or more objects that matched the
query criteria. If no objects matched the query criteria then
the result object(s) MUST be empty and the overallResult value
MUST indicate success (if no matches are found for the query
criteria, the response is considered a success).
6.2.9. Get Server Details Operation Structure
In order to query certain details of the SPPP server, like the SPPP
server's status and the major/minor version supported by the server,
the Server Details operation structure SHOULD be used. This
structure is contained within the element
while a SPPP server status response is wrapped within the
element. This following sub-sections
describe the spppServerStatusRequest and spppServerStatusResponse
elements.
6.2.9.1. Get Server Details Request
Cartwright & Bhatia Expires May 18, 2012 [Page 33]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
The data elements within the element are
described as follows:
o minorVer: Zero or one minor version identifier, indicating the
minor version of the SPPP API that the client is attempting to
use. This is used in conjunction with the major version
identifier in the XML namespace to identify the version of SPPP
that the client is using. If the element is not present, the
server assumes that the client is using the latest minor version
supported by the SPPP server for the given major version. The
versions supported by a given SPPP server can be retrieved by
the client using this same spppServerStatusRequest without
passing in the minorVer element.
6.2.9.2. Get Server Details Response
An SPPP server details response structure is contained within the
generic element.
The data elements within the element are
described as follows:
o overallResult: Exactly one response code and message pair that
explicitly identifies the result of the request. See the
Response Code section for further details.
Cartwright & Bhatia Expires May 18, 2012 [Page 34]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
o svcMenu: Exactly one element of type SvcMenuType which in turn
contains the elements to return the server status and major/
minor version of the SPPP protocol supported by the SPPP server
(refer protocol document for definition of SvcMenuType) .
6.3. Response Codes and Messages
This section contains the listing of response codes and their
corresponding human-readable text. These response codes are in
conformance with the response types defined in the section "Response
Message Types" of the protocol document.
The response code numbering scheme generally adheres to the theory
formalized in section 4.2.1 of [RFC5321]:
o The first digit of the response code can only be 1 or 2: 1 = a
positive result, 2 = a negative result.
o The second digit of the response code indicates the category: 0
= Protocol Syntax, 1 = Implementation Specific Business Rule, 2
= Security, 3 = Server System.
o The third and fourth digits of the response code indicate the
individual message event within the category defines by the
first two digits.
The response codes are also categorized as to whether they are
overall response codes that may only be returned in the
"overallResult" data element in SPPP responses, or object level
response codes that may only be returned in the "dtlResult" element
of the SPPP responses.
Cartwright & Bhatia Expires May 18, 2012 [Page 35]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
+--------+--------------------------+-------------------------------+
| Result | Result Message | Overall or Object Level |
| Code | | |
+--------+--------------------------+-------------------------------+
| 1000 | Request Succeeded. | Overall Response Code |
| | | |
| 2001 | Request syntax invalid. | Overall Response Code |
| | | |
| 2002 | Request too large. | Overall Response Code |
| | | |
| 2003 | Version not supported. | Overall Response Code |
| | | |
| 2103 | Command invalid. | Overall Response Code |
| | | |
| 2301 | System temporarily | Overall Response Code |
| | unavailable. | |
| | | |
| 2302 | Unexpected internal | Overall Response Code |
| | system or server error. | |
| | | |
| 2104 | Attribute value invalid. | Object Level Response Code |
| | | |
| | AttrName:[AttributeName] | |
| | AttrVal:[AttributeValue] | |
| | | |
| 2105 | Object does not exist. | Object Level Response Code |
| | AttrName:[AttributeName] | |
| | AttrVal:[AttributeValue] | |
| | | |
| 2106 | Object status or | Object Level Response Code |
| | ownership does not allow | |
| | for operation. | |
| | AttrName:[AttributeName] | |
| | AttrVal:[AttributeValue] | |
+--------+--------------------------+-------------------------------+
Table 1: Response Codes Numbering Scheme and Messages
Each of the object level response messages are "parameterized" with
the following parameters: "AttributeName" and "AttributeValue".
The use of these parameters MUST adhere to the rules defined in
"Response Message Types" section of the protocol document.
Cartwright & Bhatia Expires May 18, 2012 [Page 36]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
7. Protocol Operations
Refer the "Protocol Operations" section of the protocol document for
a description of all SPPP operations, and any necessary semantics
that MUST be adhered to in order to conform with the SPPP protocol
specification.
Cartwright & Bhatia Expires May 18, 2012 [Page 37]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
8. SPPP SOAP WSDL Definition
The SPPP WSDL and data types are defined below. The WSDL design
approach is commonly referred to as _Generic WSDL_. It is generic in
the sense that there is not a specific WSDL operation defined for
each object type that is supported by the SPPP protocol. There is a
single WSDL structure for each type of SPPP operation. Each such
WSDL structure contains exactly one input structure and one output
structure that wraps any data elements that are part of the incoming
request and the outgoing response respectively. The spppSOAPBinding
in the WSDL defines the binding style as _document_ and the encoding
as _literal_. It is this combination of _wrapped_ input and output
data structures, _document_ binding style, and _literal_ encoding
that characterize the Document Literal Wrapped style of WSDL
specifications.
Note: The following WSDL has been formatted (e.g., tabs, spaces) to
meet I-D requirements.
---- Import base schema ----
---- Key type(s) extended
from base schema. ----
Cartwright & Bhatia Expires May 18, 2012 [Page 38]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
---- Generic Request and
Response Definitions ----
Cartwright & Bhatia Expires May 18, 2012 [Page 39]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
Cartwright & Bhatia Expires May 18, 2012 [Page 40]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
Cartwright & Bhatia Expires May 18, 2012 [Page 41]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
Cartwright & Bhatia Expires May 18, 2012 [Page 42]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
Cartwright & Bhatia Expires May 18, 2012 [Page 43]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
---- Operation Result Type
Definitions ----
Cartwright & Bhatia Expires May 18, 2012 [Page 45]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
Cartwright & Bhatia Expires May 18, 2012 [Page 46]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
Cartwright & Bhatia Expires May 18, 2012 [Page 47]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
Figure 2: WSDL
Cartwright & Bhatia Expires May 18, 2012 [Page 48]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
9. SPPP SOAP Examples
This section shows XML message exchange between two SIP Service
Providers (SSP) and a registry. The SPPP messages in this section
are valid XML instances that conform to the SOAP based SPPP schema
version within this document. This section relies on the XML data
structures defined in the base SPPP protocol specification
[I-D.draft-ietf-drinks-spprov]. So refer to that document to
understand XML object types embedded in these example messages.
In this sample use case scenario, SSP1 and SSP2 provision resource
data in the registry and use SPPP constructs to selectively share the
route groups. In the figure below, SSP2 has two ingress SBE
instances that are associated with the public identities that SSP2
has the retail relationship with. Also, the two SBE instances for
SSP1 are used to show how to use SPPP to associate route preferences
for the destination ingress routes and exercise greater control on
outbound traffic to the peer's ingress SBEs.
---------------+ +------------------
| |
+------+ +------+
| sbe1 | | sbe2 |
+------+ +------+
SSP1 | | SSP2
+------+ +------+
| sbe3 | | sbe4 |
+------+ +------+
iana-en:111 | | iana-en:222
---------------+ +------------------
| |
| |
| SPPP +------------------+ SPPP |
+------->| Registry |<--------+
+------------------+
9.1. Add Destination Group
SSP2 adds a destination group to the registry for use later. The
SSP2 SPPP client sets a unique transaction identifier 'txn_1479' for
tracking purposes. The name of the destination group is set to
DEST_GRP_SSP2_1
Cartwright & Bhatia Expires May 18, 2012 [Page 49]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
txn_1479
iana-en:222
iana-en:223
DEST_GRP_SSP2_1
The registry processes the request and return a favorable response
confirming successful creation of the named destination group. Also,
besides returning a unique server transaction identifier, Registry
also returns the matching client transaction identifier from the
request message back to the SPPP client.
txn_1479
tx_12345
1000
Request Succeeded.
Cartwright & Bhatia Expires May 18, 2012 [Page 50]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
9.2. Add Route Records
SSP2 adds an ingress routes in the registry.
txn_1479
iana-en:222
iana-en:223
RTE_SSP2_SBE2
10
u
E2U+sip
^(.*)$
sip:\1@sbe2.ssp2.example.com
The registry returns a success response.
Cartwright & Bhatia Expires May 18, 2012 [Page 51]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
txn_1479
tx_12345
1000
Request Succeeded.
9.3. Add Route Records -- URIType
SSP2 adds another ingress routes in the registry and makes use of
URIType
txn_1479
iana-en:222
iana-en:223
RTE_SSP2_SBE4
^(.*)$
sip:\1;npdi@sbe4.ssp2.example.com
Cartwright & Bhatia Expires May 18, 2012 [Page 52]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
The registry returns a success response.
txn_1479
tx_12345
1000
Request Succeeded.
9.4. Add Route Group
SSP2 creates the grouping of the ingress routes and choses higher
precedence for RTE_SSP2_SBE2 by setting a lower number for the
"priority" attribute, a protocol agnostic precedence indicator.
Cartwright & Bhatia Expires May 18, 2012 [Page 53]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
txn_1479
iana-en:222
iana-en:223
RTE_GRP_SSP2_1
iana-en:222
RTE_SSP2_SBE2
RteRec
100
DEST_GRP_SSP2_1
true
10
To confirm successful processing of this request, registry returns a
well-known result code '1000' to the SSP2 client.
Cartwright & Bhatia Expires May 18, 2012 [Page 54]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
txn_1479
tx_12345
1000
Request Succeeded.
9.5. Add Public Identity -- Successful COR claim
SSP2 activates a TN public identity by associating it with a valid
destination group. Further, SSP2 puts forth a claim that it is the
carrier-of-record for the TN.
txn_1479
iana-en:222
iana-en:223
DEST_GRP_SSP2_1
+12025556666
true
Cartwright & Bhatia Expires May 18, 2012 [Page 55]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
Assuming that the registry has access to TN authority data and it
performs the required checks to verify that SSP2 is in fact the
service provider of record for the given TN, the request is processed
successfully. In the response message, the registry sets the value
of to "true" in order to confirm SSP2 claim as the carrier of
record and the reflects the time when the carrier of record
claim is processed.
txn_1479
tx_12345
1000
Request Succeeded.
1000
Request Succeeded.
iana-en:222
iana-en:223
2010-05-30T09:30:10Z
DEST_GRP_SSP2_1
+12025556666
true
true
2010-05-30T09:30:11Z
Cartwright & Bhatia Expires May 18, 2012 [Page 56]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
9.6. Add LRN
If another entity that SSP2 shares the routes with has access to
Number Portability data, it may choose to perform route lookups by
routing number. Therefore, SSP2 associates a routing number to a
destination group in order to facilitate ingress route discovery.
txn_1479
iana-en:222
iana-en:223
DEST_GRP_SSP2_1
2025550000
Registry completes the request successfully and returns a favorable
response to the SPPP client.
Cartwright & Bhatia Expires May 18, 2012 [Page 57]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
txn_1479
tx_12345
1000
Request Succeeded.
9.7. Add TN Range
Next, SSP2 activates a block of ten thousand TNs and associate it to
a destination group.
txn_1479
iana-en:222
iana-en:223
DEST_GRP_SSP2_1
+12026660000
+12026669999
Cartwright & Bhatia Expires May 18, 2012 [Page 58]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
Registry completes the request successfully and returns a favorable
response.
txn_1479
tx_12345
1000
Request Succeeded.
9.8. Add TN Prefix
Next, SSP2 activates a block of ten thousand TNs using the TNPType
structure and identifying a TN prefix.
txn_1479
iana-en:222
iana-en:223
DEST_GRP_SSP2_1
+1202777
Cartwright & Bhatia Expires May 18, 2012 [Page 59]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
Registry completes the request successfully and returns a favorable
response.
txn_1479
tx_12345
1000
Request Succeeded.
9.9. Enable Peering -- Route Group Offer
In order for SSP1 to complete session establishment for a destination
TN where the target subscriber has a retail relationship with SSP2,
it first requires an asynchronous bi-directional handshake to show
mutual consent. To start the process, SSP2 initiates the peering
handshake by offering SSP1 access to its route group.
Cartwright & Bhatia Expires May 18, 2012 [Page 60]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
txn_1479
iana-en:222
iana-en:223
iana-en:222
RTE_GRP_SSP2_1
RteGrp
iana-en:111
offered
2006-05-04T18:13:51.0Z
Registry completes the request successfully and confirms that the
SSP1 will now have the opportunity to weigh in on the offer and
either accept or reject it. The registry may employ out-of-band
notification mechanisms for quicker updates to SSP1 so they can act
faster, though this topic is beyond the scope of this document.
Cartwright & Bhatia Expires May 18, 2012 [Page 61]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
txn_1479
tx_12345
1000
Request Succeeded.
9.10. Enable Peering -- Route Group Offer Accept
SSP1 responds to the offer from SSP2 and agrees to have visibility to
SSP2 ingress routes.
txn_1479
iana-en:222
RTE_GRP_SSP2_1
RteGrp
iana-en:111
Cartwright & Bhatia Expires May 18, 2012 [Page 62]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
Registry confirms that the request has been processed successfully.
From this point forward, if SSP1 looks up a public identity through
the query resolution server, where the public identity is part of the
destination group by way of "RTE_GRP_SSP2_1" route association, SSP2
ingress SBE information will be shared with SSP1.
txn_1479
tx_12350
1000
Request Succeeded.
9.11. Add Egress Route
SSP1 wants to prioritize all outbound traffic to routes associated
with "RTE_GRP_SSP2_1" route group through "sbe1.ssp1.example.com".
Cartwright & Bhatia Expires May 18, 2012 [Page 63]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
txn_1479
iana-en:222
iana-en:223
EGR_RTE_01
50
^(.*@)(.*)$
\1\2?route=sbe1.ssp1.example.com
iana-en:222
SSP2_RTE_REC_3
RteRec
Since peering has already been established, the request to add the
egress route has been successfully completed.
Cartwright & Bhatia Expires May 18, 2012 [Page 64]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
txn_1479
tx_12345
1000
Request Succeeded.
9.12. Remove Peering -- Route Group Offer Reject
SSP1 had earlier accepted to have visibility to SSP2 ingress routes.
SSP1 now decides to no more maintain this visiblity and hence rejects
the Route Group Offer.
txn_1479
iana-en:222
RTE_GRP_SSP2_1
RteGrp
iana-en:111
Cartwright & Bhatia Expires May 18, 2012 [Page 65]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
Registry confirms that the request has been processed successfully.
From this point forward, if SSP1 looks up a public identity through
the query resolution server, where the public identity is part of the
destination group by way of "RTE_GRP_SSP2_1" route association, SSP2
ingress SBE information will NOT be shared with SSP1 and hence SSP2
ingress SBE will NOT be returned in the query response.
txn_1479
tx_12350
1000
Request Succeeded.
9.13. Get Destination Group
SSP2 uses the 'spppGetRequest' operation to tally the last
provisioned record for destination group DEST_GRP_SSP2_1.
Cartwright & Bhatia Expires May 18, 2012 [Page 66]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
iana-en:222
DEST_GRP_SSP2_1
DestGrp
Registry completes the request successfully and returns a favorable
response.
1000
success
iana-en:222
iana-en:223
DEST_GRP_SSP2_1
Cartwright & Bhatia Expires May 18, 2012 [Page 67]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
9.14. Get Public Identity
SSP2 obtains the last provisioned record associated with a given TN.
iana-en:222
+12025556666
TN
Registry completes the request successfully and returns a favorable
response.
Cartwright & Bhatia Expires May 18, 2012 [Page 68]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
1000
success
iana-en:222
iana-en:223
DEST_GRP_SSP2_1
+12025556666
true
true
2010-05-30T09:30:10Z
9.15. Get Route Group Request
SSP2 obtains the last provisioned record for the route group
RTE_GRP_SSP2_1.
Cartwright & Bhatia Expires May 18, 2012 [Page 69]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
iana-en:222
RTE_GRP_SSP2_1
RteGrp
Registry completes the request successfully and returns a favorable
response.
Cartwright & Bhatia Expires May 18, 2012 [Page 70]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
1000
success
iana-en:222
iana-en:223
RTE_GRP_SSP2_1
iana-en:222
RTE_SSP2_SBE2
RteRec
100
iana-en:222
RTE_SSP2_SBE4
RteRec
101
DEST_GRP_SSP2_1
true
10
9.16. Get Route Group Offers Request
SSP2 fetches the last provisioned route group offer to the
SSP1.
Cartwright & Bhatia Expires May 18, 2012 [Page 71]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
iana-en:111
Registry processes the request successfully and returns a favorable
response.
1000
success
iana-en:222
iana-en:223
iana-en:222
RTE_GRP_SSP2_1
RteGrp
iana-en:111
offered
2006-05-04T18:13:51.0Z
Cartwright & Bhatia Expires May 18, 2012 [Page 72]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
9.17. Get Egress Route
SSP1 wants to verify the last provisioned record for the egress route
called EGR_RTE_01.
iana-en:111
EGR_RTE_01
EgrRte
Registry completes the request successfully and returns a favorable
response.
Cartwright & Bhatia Expires May 18, 2012 [Page 73]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
1000
success
iana-en:222
iana-en:223
EGR_RTE_01
50
^(.*)$
sip:\1@sbe1.ssp1.example.com
iana-en:222
RTE_GRP_SSP2_1
RteRec
9.18. Delete Destination Group
SSP2 initiates a request to delete the destination group
DEST_GRP_SSP2_1.
Cartwright & Bhatia Expires May 18, 2012 [Page 74]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
iana-en:222
DEST_GRP_SSP2_1
DestGrp
Registry completes the request successfully and returns a favorable
response.
tx_12354
1000
Request Succeeded.
9.19. Delete Public Identity
SSP2 choses to de-activate the TN and remove it from the registry.
Cartwright & Bhatia Expires May 18, 2012 [Page 75]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
iana-en:222
DEST_GRP_SSP2_1
+12025556666
TN
Registry completes the request successfully and returns a favorable
response.
tx_12354
1000
Request Succeeded.
Cartwright & Bhatia Expires May 18, 2012 [Page 76]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
9.20. Delete Route Group Request
SSP2 removes the route group called RTE_GRP_SSP2_1.
iana-en:222
RTE_GRP_SSP2_1
RteGrp
Registry completes the request successfully and returns a favorable
response.
tx_12354
1000
Request Succeeded.
Cartwright & Bhatia Expires May 18, 2012 [Page 77]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
9.21. Delete Route Group Offers Request
SSP2 no longer wants to share route group RTE_GRP_SSP2_1 with SSP1.
iana-en:222
RTE_GRP_SSP2_1
RteGrp
iana-en:111
Registry completes the request successfully and returns a favorable
response. Restoring this resource sharing will require a new route
group offer from SSP2 to SSP1 followed by a successful route group
accept request from SSP1.
tx_12354
1000
Request Succeeded.
Cartwright & Bhatia Expires May 18, 2012 [Page 78]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
9.22. Delete Egress Route
SSP1 decides to remove the egress route with the label EGR_RTE_01.
iana-en:111
EGR_RTE_01
EgrRte
Registry completes the request successfully and returns a favorable
response.
tx_12354
1000
Request Succeeded.
Cartwright & Bhatia Expires May 18, 2012 [Page 79]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
9.23. Batch Request
Following is an example of how some of the operations mentioned in
previous sections MAY be performed by an SPPP client as a batch in
one single SOAP based SPPP request.
In the sample request below SSP1 wants to accept a Route Group Offer
from SSP3, add a Destination Group, add a NAPTR Route Rec, add a
Route Group, add a Route Group Offer, delete a previously provisioned
TN type Public Identifier, delete a previously provisioned Route
Group, and reject a Route Group Offer from SSP4.
txn_1467
1
iana-en:225
RTE_SSP3_SBE1_Offered
RteGrp
iana-en:222
iana-en:222
iana-en:223
DEST_GRP_SSP2_1
iana-en:222
iana-en:223
RTE_SSP2_SBE2
Cartwright & Bhatia Expires May 18, 2012 [Page 80]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
10
u
E2U+sip
^(.*)$
sip:\1@sbe2.ssp2.example.com
iana-en:222
iana-en:223
RTE_GRP_SSP2_1
iana-en:222
RTE_SSP2_SBE2
RteRec
100
DEST_GRP_SSP2_1
true
10
iana-en:222
iana-en:223
iana-en:222
RTE_GRP_SSP2_1
RteGrp
iana-en:111
offered
2006-05-04T18:13:51.0Z
iana-en:222
DEST_GRP_SSP2_Previous
+12025556666
Cartwright & Bhatia Expires May 18, 2012 [Page 81]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
TN
iana-en:222
RTE_GRP_SSP2_Previous
RteGrp
iana-en:226
RTE_SSP4_SBE1_Offered
RteGrp
iana-en:222
Registry completes the request successfully and returns a favorable
response.
tx_12354
1000
Request Succeeded.
Cartwright & Bhatia Expires May 18, 2012 [Page 82]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
10. Security Considerations
SPPP is used to query and update session peering data and addresses,
so the ability to access this protocol should be limited to users and
systems that are authorized to query and update this data. Because
this data is sent in both directions, it may not be sufficient for
just the client or user to be authenticated with the server. The
identity of the server should also be authenticated by the client,
which is often accomplished using the TLS certificate exchange and
validation described in [RFC2818]. SPPP data may include sensitive
information, routing data, lists of resolvable addresses, etc. So
when used in a production setting and across non-secure networks,
SPPP should only be used over communications channels that provide
strong encryption for data privacy.
10.1. Integrity, Privacy, and Authentication
The SPPP SOAP binding relies on an underlying secure transport for
integrity and privacy. Such transports are expected to include TLS/
HTTPS. In addition to the application level authentication imposed
by an SPPP server, there are a number of options for authentication
within the transport layer and the messaging envelope. These include
TLS client certificates, HTTP Digest Access Authentication, and
digital signatures within SOAP headers.
At a miniumum, all conforming SPPP over SOAP implementations MUST
support HTTPS.
10.2. Vulnerabilities
The above protocols may have various vulnerabilities, and these may
be inherited by SPPP over SOAP. And SPPP itself may have
vulnerabilities because an authorization model is not explicitly
specified in the current specification.
It is important that SPPP implementations implement an authorization
model that considers the source of each SPPP query or update request
and determines whether it is reasonable to authorize that source to
perform that specific query or update.
10.3. Deployment Environment Specifics
Some deployments of SPPP over SOAP could choose to use transports
without encryption. This presents vulnerabilities but could be
selected for deployments involving closed networks or debugging
scenarios. However, the vulnerabilities of such a deployment could
be a lack of integrity and privacy of the data transported over SPPP
messages in this type of deployment.
Cartwright & Bhatia Expires May 18, 2012 [Page 83]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
11. IANA Considerations
This document uses URNs to describe XML namespaces and XML schemas
conforming to a registry mechanism described in [RFC3688].
URN assignments are requested: urn:ietf:params:xml:ns:sppp:soap
Cartwright & Bhatia Expires May 18, 2012 [Page 84]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
12. Acknowledgements
This document is a result of various discussions held by the DRINKS
design team, which is comprised of the following individuals, in no
specific order: Syed Ali (NeuStar), Sumanth Channabasappa (Cable
Labs), David Schwartz (XConnect), Jean-Francois Mule (CableLabs),
Kenneth Cartwright (TNS, Inc.), Manjul Maharishi (TNS, Inc.),
Alexander Mayrhofer (enum.at GmbH), Vikas Bhatia (TNS, Inc.).
Cartwright & Bhatia Expires May 18, 2012 [Page 85]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
13. References
13.1. Normative References
[I-D.draft-ietf-drinks-spprov]
Mule, J-F., Cartwright, K., Ali, S., Mayrhofer, A., and V.
Bhatia, "DRINKS Use cases and Protocol Requirements",
draft-ietf-drinks-spprov-12 (work in progress), June 2011.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H.,
Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext
Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999.
[RFC2617] Franks, J., Hallam-Baker, P., Hostetler, J., Lawrence, S.,
Leach, P., Luotonen, A., and L. Stewart, "HTTP
Authentication: Basic and Digest Access Authentication",
RFC 2617, June 1999.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
January 2004.
[RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security
(TLS) Protocol Version 1.2", RFC 5246, August 2008.
[SOAPREF] Gudgin, M., Hadley, M., Moreau, J., and H. Nielsen, "SOAP
Version 1.2 Part 1: Messaging Framework", W3C
Recommendation REC-SOAP12-part1-20030624, June 2002.
13.2. Informative References
[RFC2818] Rescorla, E., "HTTP Over TLS", RFC 2818, May 2000.
[RFC5321] Klensin, J., "Simple Mail Transfer Protocol", RFC 5321,
October 2008.
[WSDLREF] Christensen, E., Curbera, F., Meredith, G., and S.
Weerawarana, "Web Services Description Language (WSDL)
1.1", W3C Note NOTE-wsdl-20010315, March 2001.
Cartwright & Bhatia Expires May 18, 2012 [Page 86]
Internet-Draft draft-ietf-drinks-sppp-over-soap November 2011
Authors' Addresses
Kenneth Cartwright
TNS
1939 Roland Clarke Place
Reston, VA 20191
USA
Email: kcartwright@tnsi.com
Vikas Bhatia
TNS
1939 Roland Clarke Place
Reston, VA 20191
USA
Email: vbhatia@tnsi.com
Cartwright & Bhatia Expires May 18, 2012 [Page 87]