Request for Comments: 4414 VeriSign, Inc.
Category: Standards Track February 2006
An ENUM Registry Type
for the Internet Registry Information Service (IRIS)
Status of This Memo
This document specifies an Internet standards track protocol for the
Internet community, and requests discussion and suggestions for
improvements. Please refer to the current edition of the "Internet
Official Protocol Standards" (STD 1) for the standardization state
and status of this protocol. Distribution of this memo is unlimited.
Copyright Notice
Copyright (C) The Internet Society (2006).
Abstract
This document describes an Internet Registry Information Service
(IRIS) registry schema for registered ENUM information. The schema
extends the necessary query and result operations of IRIS to provide
the functional information service needs for syntaxes and results
used by ENUM registries.
Table of Contents
1. Introduction ....................................................3
2. Document Terminology ............................................3
3. Schema Description ..............................................3
3.1. Query Derivatives ..........................................3
3.1.1. <findEnumsByE164> Query .............................3
3.1.2. <findEnumsByContact> Query ..........................4
3.1.3. <findContacts> Query ................................4
3.1.4. <findEnumsByHost> Query .............................4
3.1.5. Contact Search Group ................................5
3.2. Result Derivatives .........................................5
3.2.1. Privacy Labels ......................................5
3.2.2. Contact Group .......................................7
3.2.3. <enum> Result .......................................8
3.2.4. <host> Result ......................................12
3.2.5. <contact> Result ...................................13
3.2.6. <registrationAuthority> Result .....................15
3.2.7. <validationEntity> Result ..........................16
3.2.8. <communicationServiceProvider> Result ..............17
3.2.9. <validationEvent> Result ...........................18
3.3. Generic Code Derivatives ..................................19
3.3.1. <searchTooWide> ....................................19
3.3.2. <languageNotSupported> .............................19
3.4. Support for <iris:lookupEntity> ...........................19
4. Formal XML Syntax ..............................................21
5. Blocks Extensible Exchange Protocol (BEEP) Transport
Compliance .....................................................46
5.1. Message Pattern ...........................................46
5.2. Server Authentication .....................................46
6. URI Resolution .................................................46
6.1. Application Service Label .................................46
7. Internationalization Considerations ............................46
8. IANA Considerations ............................................47
8.1. XML Namespace URN Registration ............................47
8.2. S-NAPTR Registration ......................................48
8.3. BEEP Registration .........................................48
9. Security Considerations ........................................48
10. Normative References ..........................................48
A. Contributions and Acknowledgements ............................50
1. Introduction
This document describes an IRIS registry schema for registries of
ENUM data using an XML Schema [4] derived from and using the IRIS [5]
schema.
The schema given is this document is specified using the Extensible
Markup Language (XML) 1.0 as described in XML [1], XML Schema
notation as described in XML_SD [3] and XML_SS [4], and XML
Namespaces as described in XML_NS [2].
2. Document 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 RFC 2119 [10].
This document uses the term "ENUM" as the fully qualified domain name
following the conventions of ENUM [17].
3. Schema Description
IRIS requires the derivation of both query and result elements by a
registry schema. These descriptions follow.
References to XML elements with no namespace qualifier are from the
schema defined in Section 4. References to elements and attributes
with the "iris" XML namespace qualifier are from the schema defined
in IRIS [5].
The descriptions contained within this section refer to XML elements
and attributes and their relation to the exchange of data within the
protocol. These descriptions also contain specifications outside the
scope of the formal XML syntax. Therefore, this section will use
terms defined by RFC 2119 [10] to describe the specification outside
the scope of the formal XML syntax. While reading this section,
please reference Section 4 for needed details on the formal XML
syntax.
3.1. Query Derivatives
3.1.1. <findEnumsByE164> Query
<findEnumsByE164> finds ENUM domains by searching on prefixes of
E.164 numbers and returns <enum> (Section 3.2.3) results.
The E.164 prefix is specified using the <e164Prefix> child of
<findEnumsByE164>. An optional child element of <findEnumsByE164>,
<specificity>, can narrow the search to ENUM domains associated with
E.164 numbers that are either more specific or less specific. If the
<specificity> element is present and has the content ’less’, then the
search is to be narrowed to E.164 numbers that are less specific
(i.e., have fewer digits). If the <specificity> element is present
and has the content ’more’, then the search is to be narrowed to
E.164 numbers that are more specific (i.e., have more digits).
3.1.2. <findEnumsByContact> Query
<findEnumsByContact> finds ENUM domains by searches on fields
associated with an ENUM domain’s contact.
The allowable search fields are handled with either the
<contactHandle> element or one of the elements in the
"contactSearchGroup" (see Section 3.1.5). The <contactHandle>
element allows for the ENUM domains to be selected based on the
contact having the specified contact handle.
The query MAY also be constrained further using the optional <role>
element. The contents of this element signify the role the contact
has with the ENUM domain.
This query also provides optional <language> elements containing
language tags. Clients MAY use these elements to give a hint about
the natural language(s) of the affected element. Servers MAY use
this information in processing the query, such as tailoring
normalization routines to aid in more effective searches.
3.1.3. <findContacts> Query
<findContacts> searches for contacts given search constraints.
The allowable search fields are handled by one of the elements in the
"contactSearchGroup" (see Section 3.1.5).
This query also provides optional <language> elements containing
language tags. Clients MAY use these elements to give a hint about
the natural language(s) of the affected element. Servers MAY use
this information in processing the query, such as tailoring
normalization routines to aid in more effective searches.
3.1.4. <findEnumsByHost> Query
This query does a simple search for the ENUM domains being hosted by
a name server. The search is constrained using either the host name
[12], host handle, IPv4 address, or IPv6 address of the name server.
3.1.5. Contact Search Group
Some of the queries above have similar query constraints for
searching on contacts. This section describes those common
parameters.
<commonName> allows the query to be constrained based on the common
name of the contact. The constraint can either constrain the query
by an exact match using the <exactMatch> element, or it may constrain
the query by a subset of the common name using the <beginsWith> and
<endsWith> elements.
<organization> allows the query to be constrained based on the
organization name of the contact. It has the same semantics as the
<commonName> element.
<eMail> constrains the query based on the e-mail address of the
contact. This may be done by an exact e-mail address using the
<exactMatch> element or by any e-mail address in a domain using the
<inDomain> element. The <inDomain> MUST only contain a valid domain
name (i.e., no ’@’ symbol), and the matching SHOULD take place only
on the domain given (i.e., no partial matches with respect to
substrings or parent domains). If either the contents of the
<inDomain> element or domain part of the contents of the <exactMatch>
element contain a name with non-ASCII characters, they MUST be
normalized according to the processes of RFC 3491 [15].
The <city>, <region>, and <postalCode> elements restrict the scope of
the query based on the city, region, or postal code of the contact,
respectively. Each one must only contain an <exactMatch> element
containing the exact city, region, or postal code (i.e., no substring
searches).
3.2. Result Derivatives
3.2.1. Privacy Labels
Several of the results in this registry type have values that cannot
be given but must be specified as present or must be flagged so that
clients do not divulge them. In order to achieve this, some of the
results use the following element types:
o "dateTimePrivacyType" - contains the XML Schema [3] data type
"dateTime". The contents of this element MUST be specified using
the ’Z’ indicator for Coordinated Universal Time (UTC).
o "stringPrivacyType" - contains the XML Schema [3] data type
"string".
o "normalizedStringPrivacyType" - contains the XML Schema [3] data
type "normalizedString".
o "tokenPrivacyType" - contains the XML Schema [3] data type
"token".
o "enumStatusType" - describes a state for an ENUM domain. This
element has the following optional attributes:
* ’scope’ - indicates the scope or origin of the status value.
* ’disposition’ - contains either the value "pending", meaning
that initial processing for this status has begun and is not
yet complete, or the value "prohibited", meaning this ENUM
domain cannot achieve this status according to either the
registry or registrar of this ENUM domain.
* ’actor’ - contains either the value "registry", meaning this
status value has been associated with this ENUM domain by the
registry, or the value "registrar", meaning this status value
has been associated with this ENUM domain by the registrar.
This element has the following optional child elements:
* <appliedDate> - indicates the date and time the status was
applied.
* <description> - provides a textual description of the status.
This element has a required ’language’ attribute.
* <subStatus> - indicates a jurisdictional-dependent reason for
this status value. This element has a required ’authority’
attribute to indicate the jurisdictional authority associated
with this sub-status.
o "contactTypeType" - contains an optional <description> child
elements. Each <description> child element requires a ’language’
attribute.
As specified, they are nillable and therefore may be present with
empty content or present with their specified content. The use of
these elements is also optional.
If present without content, each of these element types MUST have one
or more of the following boolean attributes:
o ’private’ - if true, this specifies that the content is absent
because it may never be published.
o ’denied’ - if true, this specifies that the content is absent
because policy does not allow it to be given under the current
level of access.
If present with content, each of these element types MAY have one or
more of the following boolean attributes:
o ’doNotRedistribute’ - if true, this specifies that the content is
not to be redistributed.
o ’specialAccess’ - if true, this specifies that the content has
been provided due to special access rights.
These boolean attributes SHOULD be used in accordance with the level
of access being granted the recipient of the data. For example,
marking data as ’private’ or ’denied’ is to be expected if the user
is anonymous or has some other low level of access that does not
warrant viewing of that particular data. Likewise, data marked with
’doNotRedistribute’ or ’specialAccess’ is to be expected if the user
is authenticated and has a high level of access.
3.2.2. Contact Group
Many of the results share a set of references to contacts regarding
an associated role. These are represented by the following elements:
o <billingContact>
o <technicalContact>
o <administrativeContact>
o <legalContact>
o <zoneContact>
o <abuseContact>
o <securityContact>
o <otherContact>
Each of these elements contains an entity reference. The referent of
each MUST be a <contact> (Section 3.2.5).
3.2.3. <enum> Result
An example of a <enum> result:
<enum
authority="3.0.7.1.e164.arpa" registryType="ereg1"
entityClass="enum-handle" entityName="555-1234.001" >
<e164Number>+1 703 555 1234</e164Number>
<nameServer
iris:referentType="ereg:host"
authority="3.0.7.1.e164.arpa" registryType="ereg1"
entityClass="host-handle" entityName="ns1.001" />
<nameServer
iris:referentType="ereg:host"
authority="3.0.7.1.e164.arpa" registryType="ereg1"
entityClass="host-handle" entityName="ns2.001" />
<registrant
iris:referentType="ereg:contact"
authority="3.0.7.1.e164.arpa" registryType="ereg1"
entityClass="contact-handle" entityName="beb140">
<iris:displayName language="en">
Bill Eckels
</iris:displayName>
</registrant>
<technicalContact
iris:referentType="ereg:contact"
authority="3.0.7.1.e164.arpa" registryType="ereg1"
entityClass="contact-handle" entityName="mak21">
<iris:displayName language="en">
Mark Kosters
</iris:displayName>
</technicalContact>
<status>
<create/>
<active/>
<delete
actor="registrar"
disposition="prohibited">
<subStatus
authority="regr.example">
AUTO-LOCK
</subStatus>
</delete>
<update
actor="registrar"
disposition="prohibited">
<subStatus
authority="regr.example">
AUTO-LOCK
</subStatus>
</update>
<transfer
actor="registrar"
disposition="prohibited">
<subStatus
authority="registrar.example">
AUTO-LOCK
</subStatus>
</transfer>
<redemptionPeriod
actor="registry"
disposition="pending">
<subStatus
authority="policy-body.example">
STANDARD RGP
</subStatus>
</redemptionPeriod>
</status>
</enum>
The <enum> result represents an instance of an ENUM domain
assignment. The children of the <enum> element are as follows:
o <e164Number> - the E.164 number for this ENUM domain as defined by
[13]. It is RECOMMENDED that only space characters be used
between the digits of these E.164 numbers, as of the international
number format defined in [14].
o <enumHandle> - a registry-unique assigned identifier to an ENUM
domain.
o <nameServer> - MUST contain an entity reference to a referent of
type <host> (Section 3.2.4).
o <registrant> - elements containing an entity reference to the
registrant of this ENUM domain. The referent MUST be a <contact>
(Section 3.2.5) result.
o ENUM domain contacts - see Section 3.2.2.
o <status> - may contain at least one of the following elements of
type ’enumStatusType’ (see Section 3.2.1).
* <reserved> - this ENUM domain falls outside the normal
registration rules and/or processes for registration
* <create> - assigned to a registrant
* <active> - available via DNS (either via delegation or direct
publication)
* <inactive> - unavailable via DNS
* <dispute> - registrant assignment is in dispute
* <delete> - registrant assignment removed
* <transfer> - change of authority
* <update> - modification of this ENUM domain
* <renew> - renewal of ENUM domain registration
* <addPeriod> - period at the creation or activation of this ENUM
domain (see RFC 3915 [18])
* <renewPeriod> - period at the renewal of this ENUM domain (see
RFC 3915 [18])
* <autoRenewPeriod> - period at the automatic renewal of this
ENUM domain (see RFC 3915 [18])
* <transferPeriod> - period at the transfer of this ENUM domain
(see RFC 3915 [18])
* <redemptionPeriod> - period at the redemption of this ENUM
domain (see RFC 3915 [18])
* <restore> - change to previous status of this ENUM domain
* <other> - a status only defined by its <subStatus> child
element
As stated in Section 3.2.1, each status value may have flags to
indicate the entity responsible for assigning the status (e.g.,
actor=’registrar’) and the nature of the status (e.g.,
disposition="prohibited"). Any one status value MUST NOT imply
other status values. For instance, <reserved> is just an
indication that the ENUM domain is given special reserved
status; the <create disposition="prohibited"/> status value must
also be present to indicate that the ENUM domain cannot be
registered.
o <registrationReference> - an element containing an entity
reference, the referent of which MUST be an <enum>
(Section 3.2.3). The intention of this element is to point to the
downstream registration reference. Therefore, if this is a result
given back by an ENUM domain registry, it should point to the ENUM
domain in the ENUM domain registrar or registrant service.
o <registry> - contains an entity reference specifying the ENUM
domain registry operator for this ENUM domain that MUST be a
<registrationAuthority> (Section 3.2.6).
o <registrar> - contains an entity reference specifying the ENUM
domain registrar operator for this ENUM domain that MUST be a
<registrationAuthority> (Section 3.2.6).
o <validationEntity> - contains an entity reference specifying the
validation entity for this ENUM domain that MUST be a
<validationEntity> (Section 3.2.7).
o communication service providers - the following elements contain
an entity reference with a relationship to the ENUM domain. The
referent of each MUST be a <communicationServiceProvider>
(Section 3.2.8).
* <lineCSP>
* <signalCSP>
* <dataCSP>
* <voiceCSP>
* <otherCSP>
o <validationEvent> -- elements containing an entity reference to
validation events related to this ENUM domain. The referent MUST
be a <validationEvent> (Section 3.2.9).
o <initialDelegationDateTime> - an element containing the date and
time of the initial delegation of this ENUM domain.
o <lastRenewalDateTime> - an element containing the date and time of
last renewal of this ENUM domain.
o <expirationDateTime> - an element containing the date and time of
the expiration of this ENUM domain.
o <lastContactModificationDateTime> - specifies the last time a
contact for the ENUM domain was added or removed.
o <lastContactModificationBy> - an element containing an entity
reference. The referent MUST be a <contact> (Section 3.2.5)
responsible for the last addition or removal of a contact for this
ENUM domain.
o <lastDelegationModificationDateTime> - an element containing the
date and time of the last time one of the nameservers was added or
removed for the delegation of this ENUM domain.
o <lastDelegationModificationBy> - an element containing an entity
reference. The referent MUST be a <contact> (Section 3.2.5)
result and be responsible for the last addition or removal of a
nameserver for this ENUM domain.
o <lastVerificationDateTime> - an element containing the date and
time of the last time the data for this domain was verified by the
responsible registration authority.
o <iris:seeAlso> - an element containing an entity reference
specifying a referent that is indirectly associated with this
domain.
3.2.4. <host> Result
An example of a <host> result:
<host
authority="iana.org" registryType="ereg1"
entityClass="host-handle" entityName="nsol184" >
<hostHandle>nsol184</hostHandle>
<hostName>a.iana-servers.net</hostName>
<ipV4Address>192.0.2.43</ipV4Address>
<hostContact
iris:referentType="ereg:contact"
authority="iana.org" registryType="ereg1"
entityClass="contact-handle" entityName="dbarton" />
</host>
The <host> element represents an instance of a host registration.
The children of the <host> element are as follows:
o <hostHandle> - a registry-unique assigned identifier for the host.
o <hostName> - the fully qualified domain name of the host. The
contents of this element are a host name and MUST conform to RFC
1123 [19].
o <ipV4Address> - the content of which MUST conform to a valid
IP version 4 host address as specified by RFC 791 [8].
o <ipV6Address> - the content of which MUST conform to a valid
IP version 6 host address as specified by RFC 3513 [7].
o <hostContact> - an element containing an entity reference
specifying a contact associated with this host. The referent MUST
be <contact> (Section 3.2.5) results.
o <createdDateTime> - an element containing the date and time this
host was created.
o <lastModificationDateTime> - an element containing the date and
time this host was last modified.
o <lastVerificationDateTime> - an element containing the date and
time this data for this host was last verified to be correct by