Response Types

Response Type	Description
Request Succeeded	Any conforming specification MUST define a response to indicate that a given request succeeded.
Request syntax invalid	Any conforming specification MUST define a response to indicate that a syntax of a given request was found invalid.
Request too large	Any conforming specification MUST define a response to indicate that the count of entities in the request is larger than the server is willing or able to process.
Version not supported	Any conforming specification MUST define a response to indicate that the server does not support the version of the SPPF protocol specified in the request.
Command invalid	Any conforming specification MUST define a response to indicate that the operation and/or command being requested by the client is invalid and/or not supported by the server.
System temporarily unavailable	Any conforming specification MUST define a response to indicate that the SPPF server is temporarily not available to serve client request.
Unexpected internal system or server error.	Any conforming specification MUST define a response to indicate that the SPPF server encountered an unexpected error that prevented the server from fulfilling the request.
Attribute value invalid	Any conforming specification MUST define a response to indicate that the SPPF server encountered an attribute or property in the request that had an invalid/bad value. Optionally, the specification MAY provide a way to indicate the Attribute Name and the Attribute Value to identify the object that was found to be invalid.
Object does not exist	Any conforming specification MUST define a response to indicate that an object present in the request does not exist on the SPPF server. Optionally, the specification MAY provide a way to indicate the Attribute Name and the Attribute Value that identifies the non-existent object.
Object status or ownership does not allow for operation.	Any conforming specification MUST define a response to indicate that the operation requested on an object present in the request cannot be performed because the object is in a status that does not allow the said operation or the user requesting the operation is not authorized to perform the said operation on the object. Optionally, the specification MAY provide a way to indicate the Attribute Name and the Attribute Value that identifies the object.

When the response messages are "parameterized" with the Attribute Name and Attribute Value, then the use of these parameters MUST adhere to the following rules:

• Any value provided for the Attribute Name parameter MUST be an exact XSD element name of the protocol data element that the response message is referring to. For example, valid values for "attribute name" are "dgName", "sedGrpName", "sedRec", etc.
• The value for Attribute Value MUST be the value of the data element to which the preceding Attribute Name refers.
• Response type "Attribute value invalid" MUST be used whenever an element value does not adhere to data validation rules.
• Response types "Attribute value invalid" and "Object does not exist" MUST not be used interchangeably. Response type "Object does not exist" MUST be returned by an Update/Del/Accept/Reject operation when the data element(s) used to uniquely identify a pre-existing object do not exist. If the data elements used to uniquely identify an object are malformed, then response type "Attribute value invalid" MUST be returned.

6. Framework Data Model Objects

This section provides a description of the specification of each supported data model object (the nouns) and identifies the commands (the verbs) that MUST be supported for each data model object. However, the specification of the data structures necessary to support each command is delegated to an SPPF conforming transport protocol specification.

6.1. Destination Group

Destination Group represents a logical grouping of Public Identifiers with common session establishment information. The transport protocol MUST support the ability to Create, Modify, Get, and Delete Destination Groups (refer the "Framework Operations" section of this document for a generic description of various operations).

A Destination Group object MUST be uniquely identified by attributes as defined in the description of "ObjKeyType" in the section "Generic Object Key Type" of this document.

The DestGrpType object structure is defined as follows:

<complexType name="DestGrpType">
 <complexContent>
  <extension base="sppfb:BasicObjType">
   <sequence>
    <element name="dgName" type="sppfb:ObjNameType"/>
   </sequence>
  </extension>
 </complexContent>
</complexType>
                        

The DestGrpType object is composed of the following elements:

• base: All first class objects extend BasicObjType (see Section 5.1).
• dgName: The character string that contains the name of the Destination Group.
• ext: Point of extensibility described in Section 3.3.

6.2. Public Identifier

A Public Identifier is the search key used for locating the session establishment data (SED). In many cases, a Public Identifier is attributed to the end user who has a retail relationship with the service provider or Registrant organization. SPPF supports the notion of the carrier-of-record as defined in [RFC5067]. Therefore, the Registrant under whom the Public Identity is being created can optionally claim to be a carrier-of-record.

SPPF identifies three types of Public Identifiers: telephone numbers (TN), routing numbers (RN), and URI. SPPF provides structures to manage a single TN, a contiguous range of TNs, and a TN prefix. The transport protocol MUST support the ability to Create, Modify, Get, and Delete Public Identifiers (refer the "Framework Operations" section of this document for a generic description of various operations).

A Public Identity object MUST be uniquely identified by attributes as defined in the description of "PubIdKeyType" in the section Section 5.2.2.

The abstract XML schema type definition PubIdType is a generalization for the concrete Public Identifier schema types. PubIdType element 'dgName' represents the name of a destination group that a given Public Identifier may be a member of. Note that this element may be present multiple times so that a given Public Identifier may be a member of multiple destination groups. The PubIdType object structure is defined as follows:

<complexType name="PubIdType" abstract="true">
 <complexContent>
  <extension base="sppfb:BasicObjType">
   <sequence>
    <element name="dgName" type="sppfb:ObjNameType"
             minOccurs="0" maxOccurs="unbounded"/>
   </sequence>
  </extension>
 </complexContent>
</complexType>
              

A Public Identifier may be a member of zero or more Destination Groups. When a Public Identifier is member of a Destination Group, it is intended to be associated with SED(s) through the SED Group(s) that are associated with the Destination Group. When a Public Identifier is not member of any Destination Group, it is intended to be associated with SED through the SED Records that are directly associated with the Public Identifier.

A telephone number is provisioned using the TNType, an extension of PubIdType. Each TNType object is uniquely identified by the combination of its value contained within <tn> element, and its Registrant ID. TNType is defined as follows:

<complexType name="TNType">
 <complexContent>
  <extension base="sppfb:PubIdType">
   <sequence>
    <element name="tn" type="sppfb:NumberValType"/>
    <element name="corInfo" type="sppfb:CORInfoType" minOccurs="0"/>
    <element name="sedRecRef" type="sppfb:SedRecRefType" 
             minOccurs="0" maxOccurs="unbounded"/>
   </sequence>
  </extension>
 </complexContent>
</complexType>

<complexType name="CORInfoType">
 <sequence>
   <element name="corClaim" type="boolean" default="true"/>
   <element name="cor" type="boolean" default="false" minOccurs="0"/>
   <element name="corDate" type="dateTime" minOccurs="0"/>
 </sequence>
</complexType>
	
<simpleType name="NumberValType">
 <restriction base="token">
  <maxLength value="20"/>
  <pattern value="\+?\d\d*"/>
 </restriction>
</simpleType>

              

TNType consists of the following attributes:

• tn: Telephone number to be added to the Registry.
• sedRecRef: Optional reference to SED records that are directly associated with the TN Public Identifier. Following the SPPF data model, the SED record could be a protocol agnostic URIType or another type.
• corInfo: corInfo is an optional parameter of type CORInfoType that allows the Registrant organization to set forth a claim to be the carrier-of-record (see [RFC5067]). This is done by setting the value of <corClaim> element of the CORInfoType object structure to "true". The other two parameters of the CORInfoType, <cor> and <corDate> are set by the Registry to describe the outcome of the carrier-of-record claim by the Registrant. In general, inclusion of <corInfo> parameter is useful if the Registry has the authority information, such as, the number portability data, etc., in order to qualify whether the Registrant claim can be satisfied. If the carrier-of-record claim disagrees with the authority data in the Registry, whether the TN add operation fails or not is a matter of policy and it is beyond the scope of this document.

A routing number is provisioned using the RNType, an extension of PubIDType. The Registrant organization can add the RN and associate it with the appropriate destination group(s) to share the route information. This allows SSPs to use the RN search key to derive the ingress routes for session establishment at the runtime resolution process (see [RFC3761]. Each RNType object is uniquely identified by the combination of its value inside the <rn> element, and its Registrant ID. RNType is defined as follows:

<complexType name="RNType">
 <complexContent>
  <extension base="sppfb:PubIdType">
   <sequence>
    <element name="rn" type="sppfb:NumberValType"/>
    <element name="corInfo" type="sppfb:CORInfoType" minOccurs="0"/>
   </sequence>
  </extension>
 </complexContent>
</complexType>
                

RNType has the following attributes:

• rn: Routing Number used as the search key.
• corInfo: corInfo is an optional parameter of type CORInfoType that allows the Registrant organization to set forth a claim to be the carrier-of-record (see [RFC5067])

TNRType structure is used to provision a contiguous range of telephone numbers. The object definition requires a starting TN and an ending TN that together define the span of the TN range. Use of TNRType is particularly useful when expressing a TN range that does not include all the TNs within a TN block or prefix. The TNRType definition accommodates the open number plan as well such that the TNs that fall between the start and end TN range may include TNs with different length variance. Whether the Registry can accommodate the open number plan semantics is a matter of policy and is beyond the scope of this document. Each TNRType object is uniquely identified by the combination of its value that in turn is a combination of the <startTn> and <endTn> elements, and its Registrant ID. TNRType object structure definition is as follows:

<complexType name="TNRType">
 <complexContent>
  <extension base="sppfb:PubIdType">
   <sequence>
    <element name="range" type="sppfb:NumberRangeType"/>
    <element name="corInfo" type="sppfb:CORInfoType" minOccurs="0"/>
   </sequence>
  </extension>
 </complexContent>
</complexType>
 
<complexType name="NumberRangeType">
 <sequence>
  <element name="startTn" type="sppfb:NumberValType"/>
  <element name="endTn" type="sppfb:NumberValType"/>
 </sequence>
</complexType>
              

TNRType has the following attributes:

• startTn: Starting TN in the TN range
• endTn: The last TN in the TN range
• corInfo: corInfo is an optional parameter of type CORInfoType that allows the Registrant organization to set forth a claim to be the carrier-of-record (see [RFC5067])

In some cases, it is useful to describe a set of TNs with the help of the first few digits of the telephone number, also referred to as the telephone number prefix or a block. A given TN prefix may include TNs with different length variance in support of open number plan. Once again, whether the Registry supports the open number plan semantics is a matter of policy and it is beyond the scope of this document. The TNPType data structure is used to provision a TN prefix. Each TNPType object is uniquely identified by the combination of its value in the <tnPrefix> element, and its Registrant ID. TNPType is defined as follows:

<complexType name="TNPType">
 <complexContent>
  <extension base="sppfb:PubIdType">
   <sequence>
    <element name="tnPrefix" type="sppfb:NumberValType"/>
    <element name="corInfo" type="sppfb:CORInfoType" minOccurs="0"/>
   </sequence>
  </extension>
 </complexContent>
</complexType>
              

TNPType consists of the following attributes:

• tnPrefix: The telephone number prefix
• corInfo: corInfo is an optional parameter of type CORInfoType that allows the Registrant organization to set forth a claim to be the carrier-of-record (see [RFC5067])

In some cases, a Public Identifier may be a URI, such as an email address. The URIPubIdType object is comprised of the data element necessary to house such Public Identifiers. Each URIPubIdType object is uniquely identified by the combination of its value in the <uri> element, and its Registrant ID. URIPubIdType is defined as follows:

<complexType name="URIPubIdType">
 <complexContent>
  <extension base="sppfb:PubIdType">
   <sequence>
    <element name="uri" type="anyURI"/>
    <element name="ext" type="sppfb:ExtAnyType" minOccurs="0"/>
   </sequence>
  </extension>
 </complexContent>
</complexType>
              

URIPubIdType consists of the following attributes:

• uri: The value that acts a Public Identifier.
• ext: Point of extensibility described in Section 3.3.

6.3. SED Group

SED Group is a grouping of one or more Destination Group, the common SED Records, and the list of peer organizations with access to the SED Records associated with a given SED Group. It is this indirect linking of public identifiers to their Session Establishment Data that significantly improves the scalability and manageability of the peering data. Additions and changes to SED information are reduced to a single operation on a SED Group or SED Record , rather than millions of data updates to individual public identifier records that individually contain their peering data. The transport protocol MUST support the ability to Create, Modify, Get, and Delete SED Groups (refer the "Framework Operations" section of this document for a generic description of various operations).

A SED Group object MUST be uniquely identified by attributes as defined in the description of "ObjKeyType" in the section "Generic Object Key Type" of this document.

The SedGrpType object structure is defined as follows:

<complexType name="SedGrpType">
 <complexContent>
  <extension base="sppfb:BasicObjType">
   <sequence>
    <element name="sedGrpName" type="sppfb:ObjNameType"/>
    <element name="sedRecRef" type="sppfb:SedRecRefType" 
             minOccurs="0" maxOccurs="unbounded"/>
    <element name="dgName" type="sppfb:ObjNameType" 
             minOccurs="0" maxOccurs="unbounded"/>
    <element name="peeringOrg" type="sppfb:OrgIdType" 
             minOccurs="0" maxOccurs="unbounded"/>
    <element name="sourceIdent" type="sppfb:SourceIdentType" 
             minOccurs="0" maxOccurs="unbounded"/>
    <element name="isInSvc" type="boolean"/>
    <element name="priority" type="unsignedShort"/>
    <element name="ext" type="sppfb:ExtAnyType" minOccurs="0"/>
   </sequence>
  </extension>
 </complexContent>
</complexType>
  
<complexType name="SedRecRefType">
 <sequence>
  <element name="sedKey" type="sppfb:ObjKeyType"/>
  <element name="priority" type="unsignedShort"/>
  <element name="ext" type="sppfb:ExtAnyType" minOccurs="0"/>
 </sequence>
</complexType>
                        

The SedGrpType object is composed of the following elements:

• base: All first class objects extend BasicObjType (see Section 5.1).
• sedGrpName: The character string that contains the name of the SED Group. It uniquely identifies this object within the context of the Registrant ID (a child element of the base element as described above).
• sedRecRef: Set of zero or more objects of type SedRecRefType that house the unique keys of the SED Records (containing the session establishment data) that the SedGrpType object refers to and their relative priority within the context of this SED Group.
• dgName: Set of zero or more names of DestGrpType object instances. Each dgName name, in association with this SED Group's Registrant ID, uniquely identifies a DestGrpType object instance whose associated public identifiers are reachable using the session establishment information housed in this SED Group. An intended side affect of this is that a SED Group cannot provide session establishment information for a Destination Group belonging to another Registrant.
• peeringOrg: Set of zero or more peering organization IDs that have accepted an offer to receive this SED Group's information. Note that this identifier "peeringOrg" is an instance of OrgIdType. The set of peering organizations in this list is not directly settable or modifiable using the addSedGrpsRqst operation. This set is instead controlled using the SED offer and accept operations.
• sourceIdent: Set of zero or more SourceIdentType object instances. These objects, described further below, house the source identification schemes and identifiers that are applied at resolution time as part of source based routing algorithms for the SED Group.
• isInSvc: A boolean element that defines whether this SED Group is in service. The session establishment information contained in a SED Group that is in service is a candidate for inclusion in resolution responses for public identities residing in the Destination Group associated with this SED Group. The session establishment information contained in a SED Group that is not in service is not a candidate for inclusion in resolution responses.
• priority: Priority value that can be used to provide a relative value weighting of one SED Group over another. The manner in which this value is used, perhaps in conjunction with other factors, is a matter of policy.
• ext: Point of extensibility described in Section 3.3.

As described above, the SED Group contains a set of references to SED record objects. A SED record object is based on an abstract type: SedRecType. The concrete types that use SedRecType as an extension base are NAPTRType, NSType, and URIType. The definitions of these types are included the SED Record section of this document.

The SedGrpType object provides support for source-based routing via the peeringOrg data element and more granular source base routing via the source identity element. The source identity element provides the ability to specify zero or more of the following in association with a given SED Group: a regular expression that is matched against the resolution client IP address, a regular expression that is matched against the root domain name(s), and/or a regular expression that is matched against the calling party URI(s). The result will be that, after identifying the visible SED Groups whose associated Destination Group(s) contain the lookup key being queried and whose peeringOrg list contains the querying organizations organization ID, the resolution server will evaluate the characteristics of the Source URI, and Source IP address, and root domain of the lookup key being queried. The resolution server then compares these criteria against the source identity criteria associated with the SED Groups. The session establishment information contained in SED Groups that have source based routing criteria will only be included in the resolution response if one or more of the criteria matches the source criteria from the resolution request. The Source Identity data element is of type SourceIdentType, whose structure is defined as follows:

<complexType name="SourceIdentType">
 <sequence>
  <element name="sourceIdentRegex" type="sppfb:RegexType"/>
  <element name="sourceIdentScheme" 
           type="sppfb:SourceIdentSchemeType"/>
  <element name="ext" type="sppfb:ExtAnyType" minOccurs="0"/>
 </sequence>
</complexType>
  
<simpleType name="SourceIdentSchemeType">
 <restriction base="token">
  <enumeration value="uri"/>
  <enumeration value="ip"/>
  <enumeration value="rootDomain"/>
 </restriction>
</simpleType>
                        

The SourceIdentType object is composed of the following data elements:

• sourceIdentScheme: The source identification scheme that this source identification criteria applies to and that the associated sourceIdentRegex should be matched against.
• sourceIdentRegex: The regular expression that should be used to test for a match against the portion of the resolution request that is dictated by the associated sourceIdentScheme.
• ext: Point of extensibility described in Section 3.3.

6.4. SED Record

SED Group represents a combined grouping of SED Records that define session establishment information. However, SED Records need not be created to just serve a single SED Group. SED Records can be created and managed to serve multiple SED Groups. As a result, a change for example to the properties of a network node used for multiple routes, would necessitate just a single update operation to change the properties of that node. The change would then be reflected in all the SED Groups whose SED record set contains a reference to that node. The transport protocol MUST support the ability to Create, Modify, Get, and Delete SED Records (refer the "Framework Operations" section of this document for a generic description of various operations).

A SED Record object MUST be uniquely identified by attributes as defined in the description of "ObjKeyType" in the section "Generic Object Key Type" of this document.

The SedRecType object structure is defined as follows:

<complexType name="SedRecType" abstract="true">
 <complexContent>
  <extension base="sppfb:BasicObjType">
   <sequence>
    <element name="sedName" type="sppfb:ObjNameType"/>
    <element name="sedFunction" type="sppfb:SedFunctionType"
             minOccurs="0"/>
    <element name="isInSvc" type="boolean"/>
    <element name="ttl" type="positiveInteger" minOccurs="0"/>
   </sequence>
  </extension>
 </complexContent>
</complexType>
 
<simpleType name="SedFunctionType">
 <restriction base="token">
  <enumeration value="routing"/>
  <enumeration value="lookup"/>
 </restriction>
</simpleType>
                        

The SedRecType object is composed of the following elements:

• base: All first class objects extend BasicObjType (see Section 5.1).
• sedName: The character string that contains the name of the SED Record. It uniquely identifies this object within the context of the Registrant ID (a child element of the base element as described above).
• sedFunction: As described in [RFC6461], SED or Session Establishment Data falls primarily into one of two categories or functions, LUF and LRF. To remove any ambiguity as to the function a SED record is intended to provide, this optional element allows the provisioning party to make his or her intentions explicit.
• isInSvc: A boolean element that defines whether this SED Record is in service or not. The session establishment information contained in a SED Record which is in service is a candidate for inclusion in resolution responses for Telephone Numbers that are either directly associated to this SED Record, or for Public Identities residing in a Destination Group that is associated to a SED Group which in turn has an association to this SED Record.
• ttl: Number of seconds that an addressing server may cache a particular SED Record.

As described above, SED records are based on an abstract type: SedRecType. The concrete types that use SedRecType as an extension base are NAPTRType, NSType, and URIType. The definitions of these types are included below. The NAPTRType object is comprised of the data elements necessary for a NAPTR (see [RFC3403]that contains routing information for a SED Group. The NSType object is comprised of the data elements necessary for a DNS name server that points to another DNS server that contains the desired routing information. The NSType is relevant only when the resolution protocol is ENUM (see [RFC3761]). The URIType object is comprised of the data elements necessary to house a URI.

The data provisioned in a Registry can be leveraged for many purposes and queried using various protocols including SIP, ENUM and others. As such, the resolution data represented by the SED records must be in a form suitable for transport using one of these protocols. In the NAPTRType for example, if the URI is associated with a destination group, the user part of the replacement string <uri> that may require the Public Identifier cannot be preset. As a SIP Redirect, the resolution server will apply <ere> pattern on the input Public Identifier in the query and process the replacement string by substituting any back reference(s) in the <uri> to arrive at the final URI that is returned in the SIP Contact header. For an ENUM query, the resolution server will simply return the values of the <ere> and <uri> members of the URI.

<complexType name="NAPTRType">
 <complexContent>
  <extension base="sppfb:SedRecType">
   <sequence>
    <element name="order" type="unsignedShort"/>
    <element name="flags" type="sppfb:FlagsType" minOccurs="0"/>
    <element name="svcs" type="sppfb:SvcType"/>
    <element name="regx" type="sppfb:RegexParamType" minOccurs="0"/>
    <element name="repl" type="sppfb:ReplType" minOccurs="0"/>
    <element name="ext" type="sppfb:ExtAnyType" minOccurs="0"/>
   </sequence>
  </extension>
 </complexContent>
</complexType>
  
<complexType name="NSType">
 <complexContent>
  <extension base="sppfb:SedRecType">
   <sequence>
    <element name="hostName" type="token"/>
    <element name="ipAddr" type="sppfb:IPAddrType" 
             minOccurs="0" maxOccurs="unbounded"/>
    <element name="ext" type="sppfb:ExtAnyType" minOccurs="0"/>
   </sequence>
  </extension>
 </complexContent>
</complexType>

<complexType name="IPAddrType">
 <sequence>
  <element name="addr" type="sppfb:AddrStringType"/>
  <element name="ext" type="sppfb:ExtAnyType" minOccurs="0"/>
 </sequence>
 <attribute name="type" type="sppfb:IPType" default="v4"/>
</complexType>
  
<simpleType name="IPType">
 <restriction base="token">
  <enumeration value="IPv4"/>
  <enumeration value="IPv6"/>
 </restriction>
</simpleType>
  
<complexType name="URIType">
 <complexContent>
  <extension base="sppfb:SedRecType">
   <sequence>
    <element name="ere" type="token" default="^(.*)$"/>
    <element name="uri" type="anyURI"/>
    <element name="ext" type="sppfb:ExtAnyType" minOccurs="0"/>
   </sequence>
  </extension>
 </complexContent>
</complexType>
  
<simpleType name="flagsType">
 <restriction base="token">
  <length value="1"/>
  <pattern value="[A-Z]|[a-z]|[0-9]"/>
 </restriction>
</simpleType>

                        

The NAPTRType object is composed of the following elements:

• order: Order value in an ENUM NAPTR, relative to other NAPTRType objects in the same SED Group.
• svcs: ENUM service(s) that are served by the SBE. This field's value must be of the form specified in [RFC6116] (e.g., E2U+pstn:sip+sip). The allowable values are a matter of policy and not limited by this protocol.
• regx: NAPTR’s regular expression field. If this is not included then the Repl field must be included.
• repl: NAPTR replacement field, should only be provided if the Regex field is not provided, otherwise the server will ignore it
• ext: Point of extensibility described in Section 3.3.

The NSType object is composed of the following elements:

• hostName: Root-relative host name of the name server.
• ipAddr: Zero or more objects of type IpAddrType. Each object holds an IP Address and the IP Address type, IPv4 or IP v6.
• ext: Point of extensibility described in Section 3.3.

The URIType object is composed of the following elements:

• ere: The POSIX Extended Regular Expression (ere) as defined in [RFC3986].
• uri: the URI as defined in [RFC3986]. In some cases, this will serve as the replacement string and it will be left to the resolution server to arrive at the final usable URI.

6.5. SED Group Offer

The list of peer organizations whose resolution responses can include the session establishment information contained in a given SED Group is controlled by the organization to which a SED Group object belongs (its Registrant), and the peer organization that submits resolution requests (a data recipient, also know as a peering organization). The Registrant offers access to a SED Group by submitting a SED Group Offer. The data recipient can then accept or reject that offer. Not until access to a SED Group has been offered and accepted will the data recipient's organization ID be included in the peeringOrg list in a SED Group object, and that SED Group's peering information become a candidate for inclusion in the responses to the resolution requests submitted by that data recipient. The transport protocol MUST support the ability to Create, Modify, Get, Delete, Accept and Reject SED Group Offers (refer the "Framework Operations" section of this document for a generic description of various operations).

A SED Group Offer object MUST be uniquely identified by attributes as defined in the description of "SedGrpOfferKeyType" in the section "Derived Object Key Types" of this document.

The SedGrpOfferType object structure is defined as follows:

<complexType name="SedGrpOfferType">
 <complexContent>
  <extension base="sppfb:BasicObjType">
   <sequence>
    <element name="sedGrpOfferKey" type="sppfb:SedGrpOfferKeyType"/>
    <element name="status" type="sppfb:SedGrpOfferStatusType"/>
    <element name="offerDateTime" type="dateTime"/>
    <element name="acceptDateTime" type="dateTime" minOccurs="0"/>
    <element name="ext" type="sppfb:ExtAnyType" minOccurs="0"/>
   </sequence>
  </extension>
 </complexContent>
</complexType>
  
<complexType name="SedGrpOfferKeyType" abstract="true">
 <annotation>
  <documentation>
  -- Generic type that represents the key for a SED group offer. Must
     be defined in concrete form in the transport specification. --
  </documentation>
 </annotation>
</complexType>
  
<simpleType name="SedGrpOfferStatusType">
 <restriction base="token">
  <enumeration value="offered"/>
  <enumeration value="accepted"/>
 </restriction>
</simpleType>
                        

The SedGrpOfferType object is composed of the following elements:

• base: All first class objects extend BasicObjType (see Section 5.1).
• sedGrpOfferKey: The object that identifies the SED that is or has been offered and the organization that it is or has been offered to.
• status: The status of the offer, offered or accepted. The server controls the status. It is automatically set to "offered" when ever a new SED Group Offer is added, and is automatically set to "accepted" if and when that offer is accepted. The value of the element is ignored when passed in by the client.
• offerDateTime: Date and time in UTC when the SED Group Offer was added.
• acceptDateTime: Date and time in UTC when the SED Group Offer was accepted.

6.6. Egress Route

In a high-availability environment, the originating SSP likely has more than one egress path to the ingress SBE of the target SSP. If the originating SSP wants to exercise greater control and choose a specific egress SBE to be associated to the target ingress SBE, it can do so using the EgrRteType object.

An Egress Route object MUST be uniquely identified by attributes as defined in the description of "ObjKeyType" in the section "Generic Object Key Type" of this document.

Lets assume that the target SSP has offered as part of his session establishment data, to share one or more ingress routes and that the originating SSP has accepted the offer. In order to add the egress route to the Registry, the originating SSP uses a valid regular expression to rewrite ingress route in order to include the egress SBE information. Also, more than one egress route can be associated with a given ingress route in support of fault-tolerant configurations. The supporting SPPF structure provides a way to include route precedence information to help manage traffic to more than one outbound egress SBE.

The transport protocol MUST support the ability to Add, Modify, Get, and Delete Egress Routes (refer the "Framework Operations" section of this document for a generic description of various operations). The EgrRteType object structure is defined as follows:

<complexType name="EgrRteType">
 <complexContent>
  <extension base="sppfb:BasicObjType">
   <sequence>
    <element name="egrRteName" type="sppfb:ObjNameType"/>
    <element name="pref" type="unsignedShort"/>
    <element name="regxRewriteRule" type="sppfb:RegexParamType"/>
    <element name="ingrSedGrp" type="sppfb:ObjKeyType"
             minOccurs="0" maxOccurs="unbounded"/>
    <element name="svcs" type="sppfb:SvcType" minOccurs="0"/>
    <element name="ext" type="sppfb:ExtAnyType" minOccurs="0"/>
   </sequence>
  </extension>
 </complexContent>
</complexType>
         

The EgrRteType object is composed of the following elements:

• base: All first class objects extend BasicObjType (see Section 5.1).
• egrRteName: The name of the egress route.
• pref: The preference of this egress route relative to other egress routes that may get selected when responding to a resolution request.
• regxRewriteRule: The regular expression re-write rule that should be applied to the regular expression of the ingress NAPTR(s) that belong to the ingress route.
• ingrSedGrp: The ingress SED group that the egress route should be used for.
• svcs: ENUM service(s) that are served by an Egress Route. This element is used to identify the ingress NAPTRs associated with the SED Group to which an Egress Route's regxRewriteRule should be applied. If no ENUM service(s) are associated with an Egress Route, then the Egress Route's regxRewriteRule should be applied to all the NAPTRs associated with the SED Group. This field's value must be of the form specified in [RFC6116] (e.g., E2U+pstn:sip+sip). The allowable values are a matter of policy and not limited by this protocol.
• ext: Point of extensibility described in Section 3.3.

7. Framework Operations

In addition to the operation specific object types, all operations MAY specify the minor version of the protocol that when used in conjunction with the major version (that can be for instance specified in the protocol namespace) can serve to identify the version of the SPPF protocol that the client is using. If the minor version is not specified, the latest minor version supported by the SPPF server for the given major version will be used. Additionally, operations that may potentially modify persistent protocol objects SHOULD include a transaction ID as well.

7.1. Add Operation

Any conforming transport protocol specification MUST provide a definition for the operation that adds one or more SPPF objects into the Registry. If the object, as identified by the request attributes that form part of the object's key, does not exist, then the Registry MUST create the object. If the object does exist, then the Registry MUST replace the current properties of the object with the properties passed in as part of the Add operation.

If the entity that issued the command is not authorized to perform this operation an appropriate error message MUST be returned from amongst the response messages defined in "Response Message Types" section of the document.

7.2. Delete Operation

Any conforming transport protocol specification MUST provide a definition for the operation that deletes one or more SPPF objects from the Registry using the object's key.

If the entity that issued the command is not authorized to perform this operation an appropriate error message MUST be returned from amongst the response messages defined in "Response Message Types" section of the document.

When an object is deleted, any references to that object must of course also be removed as the SPPF server implementation fulfills the deletion request. Furthermore, the deletion of a composite object must also result in the deletion of the objects it contains. As a result, the following rules apply to the deletion of SPPF object types:

• Destination Groups: When a destination group is deleted any references between that destination group and any SED group must be automatically removed by the SPPF implementation as part of fulfilling the deletion request. Similarly, any references between that destination group and any Public Identifier must be removed by the SPPF implementation as part of fulfilling the deletion request.
• SED Groups: When a SED group is deleted any references between that SED group and any destination group must be automatically removed by the SPPF implementation as part of fulfilling the deletion request. Similarly any references between that SED group and any SED records must be removed by the SPPF implementation as part of fulfilling the deletion request. Furthermore, SED group offers relating that SED group must also be deleted as part of fulfilling the deletion request.
• SED Records: When a SED record is deleted any references between that SED record and any SED group must be removed by the SPPF implementation as part of fulfilling the deletion request. Similarly, any reference between that SED record and any Public Identifier must be removed by the SPPF implementation as part of fulfilling the deletion request.
• Public Identifiers: When a public identifier is deleted any references between that public identifier and any referenced destination group must be removed by the SPPF implementation as part of fulfilling the deletion request. Any references to SED records associated directly to that Public Identifier must also be deleted by the SPPF implementation as part of fulfilling the deletion request.

7.3. Get Operations

At times, on behalf of the Registrant, the Registrar may need to get information about SPPF objects that were previously provisioned in the Registry. A few examples include logging, auditing, and pre-provisioning dependency checking. This query mechanism is limited to aid provisioning scenarios and should not be confused with query protocols provided as part of the resolution system (e.g. ENUM and SIP).

Any conforming "protocol" specification MUST provide a definition for the operation that queries the details of one or more SPPF objects from the Registry using the object's key. If the entity that issued the command is not authorized to perform this operation an appropriate error message MUST be returned from amongst the response messages defined in Section 5.3.

If the response to the Get operation includes object(s) that extend the BasicObjType, the Registry MUST include the 'cDate' and 'mDate', if applicable.

7.4. Accept Operations

In SPPF, a SED Group Offer can be accepted or rejected by, or on behalf of, the Registrant to whom the SED Group has been offered (refer "Framework Data Model Objects" section of this document for a description of the SED Group Offer object). The Accept operation is used to accept the SED Group Offers. Any conforming transport protocol specification MUST provide a definition for the operation to accept SED Group Offers by, or on behalf of the Registrant, using the SED Group Offer object key.

Not until access to a SED Group has been offered and accepted will the Registrant's organization ID be included in the peeringOrg list in that SED Group object, and that SED Group's peering information become a candidate for inclusion in the responses to the resolution requests submitted by that Registrant. A SED Group Offer that is in the "offered" status is accepted by, or on behalf of, the Registrant to which it has been offered. When the SED Group Offer is accepted the the SED Group Offer is moved to the "accepted" status and adds that data recipient's organization ID into the list of peerOrgIds for that SED Group.

If the entity that issued the command is not authorized to perform this operation an appropriate error message MUST be returned from amongst the response messages defined in "Response Message Types" section of the document.

7.5. Reject Operations

In SPPF, a SED Group Offer object can be accepted or rejected by, or on behalf of, the Registrant to whom the SED Group has been offered (refer "Framework Data Model Objects" section of this document for a description of the SED Group Offer object). Furthermore, that offer may be rejected, regardless of whether or not it has been previously accepted. The Reject operation is used to reject the SED Group Offers. When the SED Group Offer is rejected that SED Group Offer is deleted, and, if appropriate, the data recipient's organization ID is removed from the list of peeringOrg IDs for that SED Group. Any conforming transport protocol specification MUST provide a definition for the operation to reject SED Group Offers by, or on behalf of the Registrant, using the SED Group Offer object key.

If the entity that issued the command is not authorized to perform this operation an appropriate error message MUST be returned from amongst the response messages defined in "Response Message Types" section of the document.

7.6. Get Server Details Operation

In SPPF, Get Server Details operation can be used to request certain details about the SPPF server that include the SPPF server's current status, the major/minor version of the SPPF protocol supported by the SPPF server.

Any conforming transport protocol specification MUST provide a definition for the operation to request such details from the SPPF server. If the entity that issued the command is not authorized to perform this operation an appropriate error message MUST be returned from amongst the response messages defined in "Response Message Types" section of the document.

8. XML Considerations

XML serves as the encoding format for SPPF, allowing complex hierarchical data to be expressed in a text format that can be read, saved, and manipulated with both traditional text tools and tools specific to XML.

XML is case sensitive. Unless stated otherwise, XML specifications and examples provided in this document MUST be interpreted in the character case presented to develop a conforming implementation.

This section discusses a small number of XML-related considerations pertaining to SPPF.

8.1. Namespaces

All SPPF elements are defined in the namespaces in the IANA Considerations section and in the Formal Framework Specification section of this document.

8.2. Versioning and Character Encoding

All XML instances SHOULD begin with an <?xml?> declaration to identify the version of XML that is being used, optionally identify use of the character encoding used, and optionally provide a hint to an XML parser that an external schema file is needed to validate the XML instance.

Conformant XML parsers recognize both UTF-8 (defined in [RFC3629]) and UTF-16 (defined in [RFC2781]); per [RFC2277] UTF-8 is the RECOMMENDED character encoding for use with SPPF.

Character encodings other than UTF-8 and UTF-16 are allowed by XML. UTF-8 is the default encoding assumed by XML in the absence of an "encoding" attribute or a byte order mark (BOM); thus, the "encoding" attribute in the XML declaration is OPTIONAL if UTF-8 encoding is used. SPPF clients and servers MUST accept a UTF-8 BOM if present, though emitting a UTF-8 BOM is NOT RECOMMENDED.

Example XML declarations:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

9. Security Considerations

Many SPPF implementations manage data that is considered confidential and critical. Furthermore, SPPF implementations can support provisioning activities for multiple Registrars and Registrants. As a result any SPPF implementation must address the requirements for confidentiality, authentication, and authorization.

9.1. Confidentiality and Authentication

With respect to confidentiality and authentication, the transport protocol requirements section of this document contains security properties that the transport protocol must provide so that authenticated endpoints can exchange data confidentially and with integrity protection. Refer to that section and the resulting transport protocol specification document for the specific solutions to authentication and confidentiality.

9.2. Authorization

With respect to authorization, the SPPF server implementation must define and implement a set of authorization rules that precisely address (1) which Registrars will be authorized to create/modify/delete each SPPF object type for given Registrant(s) and (2) which Registrars will be authorized to view/get each SPPF object type for given Registrant(s). These authorization rules are a matter of policy and are not specified within the context of SPPF. However, any SPPF implementation must specify these authorization rules in order to function in a reliable and safe manner.

9.3. Denial of Service

Guidance on Denial-of-Service (DoS) issues in general is given in [RFC4732], "Internet Denial of Service Considerations", which also gives a general vocabulary for describing the DoS issue.

SPPF is a high-level client-server protocol that can be implemented on lower-level mechanisms such as remote procedure call and web-service API protocols. As such, it inherits any Denial-of-Service issues inherent to the specific lower-level mechanism used for any implementation of SPPF. SPPF also has its own set of higher-level exposures that are likely to be independent of lower-layer mechanism choices.

9.3.1. DoS Issues Inherited from Transport Mechanism

SPPF implementation is in general dependent on the selection and implementation of a lower-level transport protocol and a binding between that protocol and SPPF. The archetypal SPPF implementation uses XML (http://www.w3.org/TR/xml/) representation in a SOAP (http://www.w3.org/TR/soap/) request/response framework over HTTP ([RFC2616]), and probably also uses TLS ([RFC5246]) for on-the wire data integrity and participant authentication, and might use HTTP Digest authentication ([RFC2609]).

The typical deployment scenario for SPPF is to have servers in a managed facility, and therefore techniques such as Network Ingress Filtering ([RFC2609]) are generally applicable. In short, any DoS mechanism affecting a typical HTTP implementation would affect such an SPPF implementation, and the mitigation tools for HTTP in general also therefore apply to SPPF.

SPPF does not directly specify an authentication mechanism, instead relying on the lower-level transport protocol to provide for authentication. In general, authentication is an expensive operation, and one apparent attack vector is to flood an SPPF server with repeated requests for authentication, thereby exhausting its resources. SPPF implementations SHOULD therefore be prepared to handle authentication floods, perhaps by noting repeated failed login requests from a given source address and blocking that source address.

9.3.2. DoS Issues Specific to SPPF

The primary defense mechanism against DoS within SPPF is authentication. Implementations MUST tightly control access to the SPPF service, SHOULD implement DoS and other policy control screening, and MAY employ a variety of policy violation reporting and response measures such as automatic blocking of specific users and alerting of operations personnel. In short, the primary SPPF response to DoS-like activity by a user is to block that user or subject their actions to additional review.

SPPF allows a client to submit multiple-element or "batch" requests that may insert or otherwise affect a large amount of data with a single request. In the simplest case, the server progresses sequentially through each element in a batch, completing one and before starting the next. Mid-batch failures are handled by stopping the batch and rolling-back the data store to its pre-request state. This "stop and roll-back" design provides a DoS opportunity. A hostile client could repeatedly issue large batch requests with one or more failing elements, causing the server to repeatedly stop and roll-back large transactions. The suggested response is to monitor clients for such failures, and take administrative action (such as blocking the user) when an excessive number of roll-backs is reported.

An additional suggested response is for an implementer to set their maximum allowable XML message size, and their maximum allowable batch size at a level that they feel protects their operational instance, given the hardware sizing they have in place and the expected load and size needs that their users expect.

9.4. Information Disclosure

It is not uncommon for the logging systems to document on-the-wire messages for various purposes, such as, debug, audit, and tracking. At the minimum, the various support and administration staff will have access to these logs. Also, if an unprivileged user gains access to the SPPF deployments and/or support systems, it will have access to the information that is potentially deemed confidential. To manage information disclosure concerns beyond the transport level, SPPF implementations MAY provide support for encryption at the SPPF object level.

9.5. Non Repudiation

In some situations, it may be required to protect against denial of involvement (see [RFC4949]) and tackle non-repudiation concerns in regards to SPPF messages. This type of protection is useful to satisfy authenticity concerns related to SPPF messages beyond the end-to-end connection integrity, confidentiality, and authentication protection that the transport layer provides. This is an optional feature and some SPPF implementations MAY provide support for it.

9.6. Replay Attacks

Anti-replay protection ensures that a given SPPF object replayed at a later time doesn't affect the integrity of the system. SPPF provides at least one mechanism to fight against replay attacks. Use of the optional client transaction identifier allows the SPPF client to correlate the request message with the response and to be sure that it is not a replay of a server response from earlier exchanges. Use of unique values for the client transaction identifier is highly encouraged to avoid chance matches to a potential replay message.

9.7. Man in the Middle

The SPPF client or Registrar can be a separate entity acting on behalf of the Registrant in facilitating provisioning transactions to the Registry. Further, the transport layer provides end-to-end connection protection between SPPF client and the SPPF server. Therefore, man-in-the-middle attack is a possibility that may affect the integrity of the data that belongs to the Registrant and/or expose peer data to unintended actors in case well-established peering relationships already exist.

10. Internationalization Considerations

Character encodings to be used for SPPF elements are described in Section 8.2. The use of time elements in the protocol is specified in Section 3.2. Where human-readable languages are used in the protocol, those messages SHOULD be tagged according to [RFC5646], and the transport protocol MUST support a respective mechanism to transmit such tags together with those human-readable messages. If tags are absent, the language of the message defaults to "en" (English).

11. IANA Considerations

11.1. URN Assignments

This document uses URNs to describe XML namespaces and XML schemas conforming to a Registry mechanism described in [RFC3688].

Two URI assignments are requested.

Registration request for the SPPF XML namespace:
urn:ietf:params:xml:ns:sppf:base:1
Registrant Contact: IESG
XML: None. Namespace URIs do not represent an XML specification.

Registration request for the XML schema:
URI: urn:ietf:params:xml:schema:sppf:1
Registrant Contact: IESG
XML: See the "Formal Specification" section of this document (Section 12).

11.2. Organization Identifier Namespace Registry

IANA is requested to create and maintain a Registry entitled "SPPF OrgIdType Namespaces". Strings used as OrgIdType Namespace identifiers MUST conform to the following syntax in the Augmented Backus-Naur Form (ABNF) [RFC5234]

      namespace = ALPHA * (ALPHA/DIGIT/"-")

Assignments consist of the OrgIdType namespace string, and the definition of the associated namespace. This document makes the following initial assignment for the OrgIdType Namespaces:

      OrgIdType namespace string                       Namespace
      --------------------------                       ---------
      IANA Enterprise Numbers                          iana-en

Future assignments are to be made through the well known IANA Policy "RFC Required" (see section 4.1 of [RFC5226])

12. Formal Specification

This section provides the draft XML Schema Definition for SPPF Protocol.

<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:sppfb="urn:ietf:params:xml:ns:sppf:base:1" 
xmlns="http://www.w3.org/2001/XMLSchema" 
targetNamespace="urn:ietf:params:xml:ns:sppf:base:1" 
elementFormDefault="qualified" xml:lang="EN">
 <annotation>
  <documentation>
   ---- Generic Object key types to be defined by specific
        Transport/Architecture.  The types defined here can 
        be extended by the specific architecture to 
        define the Object Identifiers ----
  </documentation>
 </annotation>
 <complexType name="ObjKeyType"
  abstract="true">
  <annotation>
   <documentation>
    ---- Generic type that represents the
         key for various objects in SPPF. ----
   </documentation>
  </annotation>
 </complexType>
 
 <complexType name="SedGrpOfferKeyType" abstract="true">
  <complexContent>
   <extension base="sppfb:ObjKeyType">
    <annotation>
     <documentation>
     ---- Generic type that represents
          the key for a SED group offer. ----
     </documentation>
    </annotation>
   </extension>
  </complexContent>
 </complexType>
 
 <complexType name="PubIdKeyType" abstract="true">
  <complexContent>
   <extension base="sppfb:ObjKeyType">
    <annotation>
     <documentation>
      ----Generic type that 
      represents the key 
      for a Pub Id. ----
     </documentation>
    </annotation>
   </extension>
  </complexContent>
 </complexType>
 
 <annotation>
  <documentation> 
    ---- Object Type Definitions ----
  </documentation>
 </annotation>
 
 <complexType name="SedGrpType">
  <complexContent>
   <extension base="sppfb:BasicObjType">
    <sequence>
     <element name="sedGrpName" type="sppfb:ObjNameType"/>
     <element name="sedRecRef" type="sppfb:SedRecRefType"
              minOccurs="0" maxOccurs="unbounded"/>
     <element name="dgName" type="sppfb:ObjNameType"
              minOccurs="0" maxOccurs="unbounded"/>
     <element name="peeringOrg" type="sppfb:OrgIdType"
              minOccurs="0" maxOccurs="unbounded"/>
     <element name="sourceIdent" type="sppfb:SourceIdentType" 
              minOccurs="0" maxOccurs="unbounded"/>
     <element name="isInSvc" type="boolean"/>
     <element name="priority" type="unsignedShort"/>
     <element name="ext" 
     type="sppfb:ExtAnyType" minOccurs="0"/>
    </sequence>
   </extension>
  </complexContent>
 </complexType>
 <complexType name="DestGrpType">
  <complexContent>
   <extension base="sppfb:BasicObjType">
    <sequence>
     <element name="dgName" 
     type="sppfb:ObjNameType"/>
    </sequence>
   </extension>
  </complexContent>
 </complexType>
 <complexType name="PubIdType" abstract="true">
  <complexContent>
   <extension base="sppfb:BasicObjType">
    <sequence>
     <element name="dgName" type="sppfb:ObjNameType" 
              minOccurs="0" maxOccurs="unbounded"/>
    </sequence>
   </extension>
  </complexContent>
 </complexType>
 <complexType name="TNType">
  <complexContent>
   <extension base="sppfb:PubIdType">
    <sequence>
     <element name="tn" type="sppfb:NumberValType"/>
     <element name="corInfo" type="sppfb:CORInfoType" minOccurs="0"/>
     <element name="sedRecRef" type="sppfb:SedRecRefType" 
              minOccurs="0" maxOccurs="unbounded"/>
    </sequence>
   </extension>
  </complexContent>
 </complexType>
 <complexType name="TNRType">
  <complexContent>
   <extension base="sppfb:PubIdType">
    <sequence>
     <element name="range" type="sppfb:NumberRangeType"/>
     <element name="corInfo" type="sppfb:CORInfoType" minOccurs="0"/>
    </sequence>
   </extension>
  </complexContent>
 </complexType>
 <complexType name="TNPType">
  <complexContent>
   <extension base="sppfb:PubIdType">
    <sequence>
     <element name="tnPrefix" type="sppfb:NumberValType"/>
     <element name="corInfo" type="sppfb:CORInfoType" minOccurs="0"/>
    </sequence>
   </extension>
  </complexContent>
 </complexType>
 <complexType name="RNType">
  <complexContent>
   <extension base="sppfb:PubIdType">
    <sequence>
     <element name="rn" type="sppfb:NumberValType"/>
     <element name="corInfo" type="sppfb:CORInfoType" minOccurs="0"/>
    </sequence>
   </extension>
  </complexContent>
 </complexType>
  <complexType name="URIPubIdType">
  <complexContent>
   <extension base="sppfb:PubIdType">
    <sequence>
     <element name="uri" type="anyURI"/>
     <element name="ext" type="sppfb:ExtAnyType" minOccurs="0"/>
    </sequence>
   </extension>
  </complexContent>
 </complexType>
 <complexType name="SedRecType" abstract="true">
  <complexContent>
   <extension base="sppfb:BasicObjType">
    <sequence>
     <element name="sedName" type="sppfb:ObjNameType"/>
     <element name="sedFunction" type="sppfb:SedFunctionType"
              minOccurs="0"/>
     <element name="isInSvc" type="boolean"/>
     <element name="ttl" type="positiveInteger" minOccurs="0"/>
    </sequence>
   </extension>
  </complexContent>
 </complexType>
 <complexType name="NAPTRType">
  <complexContent>
   <extension base="sppfb:SedRecType">
    <sequence>
     <element name="order" type="unsignedShort"/>
     <element name="flags" type="sppfb:FlagsType" minOccurs="0"/>
     <element name="svcs" type="sppfb:SvcType"/>
     <element name="regx" type="sppfb:RegexParamType" minOccurs="0"/>
     <element name="repl" type="sppfb:ReplType" minOccurs="0"/>
     <element name="ext" type="sppfb:ExtAnyType" minOccurs="0"/>
    </sequence>
   </extension>
  </complexContent>
 </complexType>
 <complexType name="NSType">
  <complexContent>
   <extension base="sppfb:SedRecType">
    <sequence>
     <element name="hostName" type="token"/>
     <element name="ipAddr" type="sppfb:IPAddrType" 
              minOccurs="0" maxOccurs="unbounded"/>
     <element name="ext" type="sppfb:ExtAnyType" minOccurs="0"/>
    </sequence>
   </extension>
  </complexContent>
 </complexType>
 <complexType name="URIType">
  <complexContent>
   <extension base="sppfb:SedRecType">
    <sequence>
     <element name="ere" type="token" default="^(.*)$"/>
     <element name="uri" type="anyURI"/>
     <element name="ext" type="sppfb:ExtAnyType" minOccurs="0"/>
    </sequence>
   </extension>
  </complexContent>
 </complexType>
 <complexType name="SedGrpOfferType">
  <complexContent>
   <extension base="sppfb:BasicObjType">
    <sequence>
     <element name="sedGrpOfferKey" type="sppfb:SedGrpOfferKeyType"/>
     <element name="status" type="sppfb:SedGrpOfferStatusType"/>
     <element name="offerDateTime" type="dateTime"/>
     <element name="acceptDateTime" type="dateTime" minOccurs="0"/>
     <element name="ext" type="sppfb:ExtAnyType" minOccurs="0"/>
    </sequence>
   </extension>
  </complexContent>
 </complexType>
 <complexType name="EgrRteType">
  <complexContent>
   <extension base="sppfb:BasicObjType">
    <sequence>
     <element name="egrRteName" type="sppfb:ObjNameType"/>
     <element name="pref" type="unsignedShort"/>
     <element name="regxRewriteRule" type="sppfb:RegexParamType"/>
     <element name="ingrSedGrp" type="sppfb:ObjKeyType"
              minOccurs="0" maxOccurs="unbounded"/>
     <element name="svcs" type="sppfb:SvcType" minOccurs="0"/>
     <element name="ext" type="sppfb:ExtAnyType" minOccurs="0"/>
    </sequence>
   </extension>
  </complexContent>
 </complexType>
 <annotation>
  <documentation>
   ---- Abstract Object and Element Type Definitions ----
  </documentation>
 </annotation>
 <complexType name="BasicObjType" abstract="true">
  <sequence>
   <element name="rant" type="sppfb:OrgIdType"/>
   <element name="rar" type="sppfb:OrgIdType"/>
   <element name="cDate" type="dateTime" minOccurs="0"/>
   <element name="mDate" type="dateTime" minOccurs="0"/>
   <element name="ext" type="sppfb:ExtAnyType" minOccurs="0"/>
  </sequence>
 </complexType>
 <complexType name="RegexParamType">
  <sequence>
   <element name="ere" type="sppfb:RegexType" default="^(.*)$"/>
   <element name="repl" type="sppfb:ReplType"/>
  </sequence>
 </complexType>
 <complexType name="IPAddrType">
  <sequence>
   <element name="addr" type="sppfb:AddrStringType"/>
   <element name="ext" type="sppfb:ExtAnyType" minOccurs="0"/>
  </sequence>
  <attribute name="type" type="sppfb:IPType" default="v4"/>
 </complexType>
 <complexType name="SedRecRefType">
  <sequence>
   <element name="sedKey" type="sppfb:ObjKeyType"/>
   <element name="priority" type="unsignedShort"/>
   <element name="ext" type="sppfb:ExtAnyType" minOccurs="0"/>
  </sequence>
 </complexType>
 <complexType name="SourceIdentType">
  <sequence>
   <element name="sourceIdentRegex" type="sppfb:RegexType"/>
   <element name="sourceIdentScheme" 
            type="sppfb:SourceIdentSchemeType"/>
   <element name="ext" type="sppfb:ExtAnyType" minOccurs="0"/>
  </sequence>
 </complexType>
 <complexType name="CORInfoType">
  <sequence>
   <element name="corClaim" type="boolean" default="true"/>
   <element name="cor" type="boolean" default="false" minOccurs="0"/>
   <element name="corDate" type="dateTime" minOccurs="0"/>
  </sequence>
 </complexType>
 <complexType name="SvcMenuType">
  <sequence>
   <element name="serverStatus" type="sppfb:ServerStatusType"/>
   <element name="majMinVersion" type="token" maxOccurs="unbounded"/>
   <element name="objURI" type="anyURI" maxOccurs="unbounded"/>
   <element name="extURI" type="anyURI" 
            minOccurs="0" maxOccurs="unbounded"/>
  </sequence>
 </complexType>
 <complexType name="ExtAnyType">
  <sequence>
   <any namespace="##other" maxOccurs="unbounded"/>
  </sequence>
 </complexType>
 <simpleType name="FlagsType">
  <restriction base="token">
   <length value="1"/>
   <pattern value="[A-Z]|[a-z]|[0-9]"/>
  </restriction>
 </simpleType>
 <simpleType name="SvcType">
  <restriction base="token">
   <minLength value="1"/>
  </restriction>
 </simpleType>
 <simpleType name="RegexType">
  <restriction base="token">
   <minLength value="1"/>
  </restriction>
 </simpleType>
 <simpleType name="ReplType">
  <restriction base="token">
   <minLength value="1"/>
   <maxLength value="255"/>
  </restriction>
 </simpleType>
 <simpleType name="OrgIdType">
  <restriction base="token"/>
 </simpleType>
 <simpleType name="ObjNameType">
  <restriction base="token">
   <minLength value="3"/>
   <maxLength value="80"/>
  </restriction>
 </simpleType>
 <simpleType name="TransIdType">
  <restriction base="token">
   <minLength value="3"/>
   <maxLength value="120"/>
  </restriction>
 </simpleType>
 <simpleType name="MinorVerType">
  <restriction base="unsignedLong"/>
 </simpleType>
 <simpleType name="AddrStringType">
  <restriction base="token">
   <minLength value="3"/>
   <maxLength value="45"/>
  </restriction>
 </simpleType>
 <simpleType name="IPType">
  <restriction base="token">
   <enumeration value="v4"/>
   <enumeration value="v6"/>
  </restriction>
 </simpleType>
 <simpleType name="SourceIdentSchemeType">
  <restriction base="token">
   <enumeration value="uri"/>
   <enumeration value="ip"/>
   <enumeration value="rootDomain"/>
  </restriction>
 </simpleType>
 <simpleType name="ServerStatusType">
  <restriction base="token">
   <enumeration value="inService"/>
   <enumeration value="outOfService"/>
  </restriction>
 </simpleType>
 <simpleType name="SedGrpOfferStatusType">
  <restriction base="token">
   <enumeration value="offered"/>
   <enumeration value="accepted"/>
  </restriction>
 </simpleType>
 <simpleType name="NumberValType">
  <restriction base="token">
   <maxLength value="20"/>
   <pattern value="\+?\d\d*"/>
  </restriction>
 </simpleType>
 <simpleType name="NumberTypeEnum">
  <restriction base="token">
   <enumeration value="TN"/>
   <enumeration value="TNPrefix"/>
   <enumeration value="RN"/>
  </restriction>
 </simpleType>
 <simpleType name="SedFunctionType">
  <restriction base="token">
   <enumeration value="routing"/>
   <enumeration value="lookup"/>
  </restriction>
 </simpleType>
 <complexType name="NumberType">
  <sequence>
   <element name="value" type="sppfb:NumberValType"/>
   <element name="type" type="sppfb:NumberTypeEnum"/>
  </sequence>
 </complexType>
 <complexType name="NumberRangeType">
  <sequence>
   <element name="startRange" type="sppfb:NumberValType"/>
   <element name="endRange" type="sppfb:NumberValType"/>
  </sequence>
 </complexType>
</schema>
            

13. Acknowledgments

This document is a result of various discussions held in the DRINKS working group and within the DRINKS protocol design team, with contributions from the following individuals, in alphabetical order: Alexander Mayrhofer, David Schwartz, Deborah A Guyton, Lisa Dusseault, Manjul Maharishi, Mickael Marrache, Otmar Lendl, Richard Shockey, Samuel Melloul, Sumanth Channabasappa, Syed Ali, Vikas Bhatia, and Jeremy Barkan

14. References

14.1. Normative References

[RFC2119]	Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC2277]	Alvestrand, H.T., "IETF Policy on Character Sets and Languages", BCP 18, RFC 2277, January 1998.
[RFC3629]	Yergeau, F., "UTF-8, a transformation format of ISO 10646", STD 63, RFC 3629, November 2003.
[RFC3688]	Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, January 2004.
[RFC3986]	Berners-Lee, T., Fielding, R. and L. Masinter, "Uniform Resource Identifier (URI): Generic Syntax", STD 66, RFC 3986, January 2005.
[RFC5234]	Crocker, D. and P. Overell, "Augmented BNF for Syntax Specifications: ABNF", STD 68, RFC 5234, January 2008.
[RFC5067]	Lind, S. and P. Pfautz, "Infrastructure ENUM Requirements", RFC 5067, November 2007.
[RFC4949]	Shirey, R., "Internet Security Glossary, Version 2", RFC 4949, August 2007.
[RFC5226]	Narten, T. and H. Alvestrand, "Guidelines for Writing an IANA Considerations Section in RFCs", BCP 26, RFC 5226, May 2008.

14.2. Informative References

[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.
[RFC4732]	Handley, M., Rescorla, E., IAB, "Internet Denial-of-Service Considerations", RFC 4732, December 2006.
[RFC5246]	Dierks, T. and E. Rescorla, "The Transport Layer Security (TLS) Protocol Version 1.2", RFC 5246, August 2008.
[RFC2609]	Guttman, E., Perkins, C. and J. Kempf, "Service Templates and Service: Schemes", RFC 2609, June 1999.
[RFC6461]	Channabasappa, S., "Data for Reachability of Inter-/Intra-NetworK SIP (DRINKS) Use Cases and Protocol Requirements", RFC 6461, January 2012.
[RFC5321]	Klensin, J., "Simple Mail Transfer Protocol", RFC 5321, October 2008.
[RFC3261]	Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, A., Peterson, J., Sparks, R., Handley, M. and E. Schooler, "SIP: Session Initiation Protocol", RFC 3261, June 2002.
[RFC6116]	Bradner, S., Conroy, L. and K. Fujiwara, "The E.164 to Uniform Resource Identifiers (URI) Dynamic Delegation Discovery System (DDDS) Application (ENUM)", RFC 6116, March 2011.
[RFC4725]	Mayrhofer, A. and B. Hoeneisen, "ENUM Validation Architecture", RFC 4725, November 2006.
[RFC5486]	Malas, D. and D. Meyer, "Session Peering for Multimedia Interconnect (SPEERMINT) Terminology", RFC 5486, March 2009.
[RFC2781]	Hoffman, P. and F. Yergeau, "UTF-16, an encoding of ISO 10646", RFC 2781, February 2000.
[RFC5646]	Phillips, A. and M. Davis, "Tags for Identifying Languages", BCP 47, RFC 5646, September 2009.
[RFC3761]	Faltstrom, P. and M. Mealling, "The E.164 to Uniform Resource Identifiers (URI) Dynamic Delegation Discovery System (DDDS) Application (ENUM)", RFC 3761, April 2004.
[RFC3403]	Mealling, M., "Dynamic Delegation Discovery System (DDDS) Part Three: The Domain Name System (DNS) Database", RFC 3403, October 2002.
[Unicode6.1]	The Unicode Consortium, "The Unicode Standard - Version 6.1", Unicode 6.1, January 2012.

Authors' Addresses