Request for Comments: 4698 RIPE NCC
Category: Standards Track A. Newton
VeriSign, Inc.
S. Kerr
RIPE NCC
October 2006
IRIS: An Address Registry (areg) Type
for the Internet Registry Information Service
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 IRIS registry schema for IP address and
Autonomous System Number 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
Internet Protocol address registries.
Table of Contents
1. Introduction ....................................................3
2. Document Terminology ............................................3
3. Schema Description ..............................................3
3.1. Query Derivatives ..........................................4
3.1.1. <findContacts> Query ................................4
3.1.2. <findOrganizations> .................................4
3.1.3. <findAutonomousSystemsByName> and
<findNetworksByName> ................................5
3.1.4. <findNetworksByAddress> .............................5
3.1.5. <findNetworksByHandle> ..............................6
3.1.6. <findASByNumber> ....................................6
3.1.7. <findByContact> .....................................7
3.1.8. <findNetworksByNameServer> ..........................7
3.1.9. Contact Search Group ................................8
3.1.10. Common Search Group ................................8
3.1.11. Match Parameters ...................................8
3.2. Result Derivatives .........................................9
3.2.1. <ipv4Network> and <ipv6Network> Results .............9
3.2.2. <autonomousSystem> Result ..........................10
3.2.3. <contact> Result ...................................11
3.2.4. <organization> Result ..............................12
3.2.5. Contact References .................................12
3.2.6. Common Result Child Elements .......................13
3.3. Support for <iris:lookupEntity> ...........................13
4. Terminology for Nesting of Networks ............................14
5. Formal XML Syntax ..............................................18
6. BEEP Transport Compliance ......................................31
6.1. Message Pattern ...........................................31
6.2. Server Authentication .....................................31
7. URI Resolution .................................................31
7.1. Application Service Label .................................31
7.2. Operational Considerations ................................31
7.3. Top-Down Resolution .......................................31
8. Internationalization Considerations ............................32
9. IANA Considerations ............................................32
10. Security Considerations .......................................32
11. References ....................................................33
11.1. Normative References .....................................33
11.2. Informative References ...................................33
Appendix A. Privacy Considerations ................................34
Appendix B. Example Requests and Responses ........................34
B.1. Example 1 .................................................34
B.2. Example 2 .................................................36
Appendix C. Specificity Examples ..................................39
Appendix D. Contributors ..........................................46
Appendix E. Acknowledgements ......................................46
1. Introduction
An Internet address registry stores information about:
o address ranges
o autonomous system number ranges
o associated contacts and organizations
o name servers
This information is interrelated, and Internet address registries
store this information and the information’s interrelationships in a
manner befitting the needs of each Internet address registry and its
constituents. This document specifies a method for accessing and
retrieving this information in a common XML format.
This document describes an IRIS namespace for Internet address
registries using an XML Schema [8] derived from and using the IRIS
[2] schema. This schema and registry type are provided to
demonstrate the extensibility of the IRIS framework beyond the use of
domains, a criteria defined in CRISP [4].
The schema given is this document is specified using the Extensible
Markup Language (XML) 1.0 as described in XML [5], XML Schema
notation as described in XML_SD [7] and XML_SS [8], and XML
Namespaces as described in XML_NS [6].
Examples of client/server XML exchanges with this registry type are
available in Appendix B.
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 [1].
3. Schema Description
IRIS requires the derivation of both query and result elements by a
registry schema. Descriptions for these follow.
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 [1] to describe the specification outside
the scope of the formal XML syntax. While reading this section,
please reference Section 5 for needed details on the formal XML
syntax.
3.1. Query Derivatives
3.1.1. <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.9) or the element
<organizationId>. The <organizationId> element constrains the query
based on the organization ID (handle) associated with contacts. This
element is an "exactMatchParameter" (see Section 3.1.11).
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.
The client SHOULD pass the names unchanged to the server, and the
implementation of the server decides if the search is case sensitive
or not.
3.1.2. <findOrganizations>
<findOrganizations> searches for organizations given search
constraints.
The allowable search fields are handled by one of the elements in the
"commonSearchGroup" (see Section 3.1.10) or the element
<organizationName>. This element is an
"exactOrPartialMatchParameter" (see Section 3.1.11).
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.
The client SHOULD pass the names unchanged to the server, and the
implementation of the server decides if the search is case sensitive
or not.
3.1.3. <findAutonomousSystemsByName> and <findNetworksByName>
The <findAutonomousSystemsByName> and <findNetworksByName> elements
allow searches by name of autonomous systems and networks,
respectively. Both have the same format.
The child element <name> is an "exactOrPartialMatchParameter" (see
Section 3.1.11).
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.
The client SHOULD pass the names unchanged to the server, and the
implementation of the server decides if the search is case sensitive
or not.
3.1.4. <findNetworksByAddress>
The <findNetworksByAddress> element is a query for a network given a
related IP address or IP address range. It has the following child
elements:
o <ipv4Address> - has a child <start> element containing the
starting IPv4 address of the network and an optional child of
<end> containing the ending IPv4 address of the network. Clients
MUST convert any short-form notation to the fully-qualified
notation.
o <ipv6Address> - same as <ipv4Address>, but the child addresses
contain IPv6 addresses. Clients MUST convert any short-form
notation to the fully-qualified notation.
o <specificity> - determines the network specificity for the search
(see Section 4). Valid values are "exact-match", "all-less-
specific", "one-level-less-specific", "all-more-specific", and
"one-level-more-specific". This element may have the optional
attribute ’allowEquivalences’. When it is set to "true", the
result set should include networks with equivalent starting and
ending addresses. The default value for ’allowEquivalences’ is
"false".
The results from this query MUST be either <ipv4Network> or
<ipv6Network> results. More than one network result MAY be returned.
3.1.5. <findNetworksByHandle>
The <findNetworksByHandle> element is a query for a network given a
the handle of a related network. It has the following child
elements:
o <networkHandle> - specifies the network handle.
o <specificity> - determines the network specificity for the search
(see Section 4). Valid values are "all-less-specifics", "one-
level-less-specifics", "all-more-specifics", and "one-level-more-
specifics".
The results from this query MUST be either <ipv4Network> or
<ipv6Network> results. More than one network result MAY be returned.
This query could be used to discover the parentage relationships
between networks that have the same starting and ending addresses.
The client SHOULD pass handles unchanged to the server, and the
implementation of the server decides if the search is case sensitive
or not.
3.1.6. <findASByNumber>
The <findASByNumber> element allows a search for autonomous systems
given an autonomous system number (ASN) range. It has the following
child elements:
o <asNumberStart> - specifies the start of the ASN range.
o <asNumberEnd> - specifies the end of the ASN range.
o <specificity> - determines the range specificity for the search
(see Section 4). Valid values are "exact-match", "all-less-
specific", "one-level-less-specific", "all-more-specific", and
"one-level-more-specific". This element may have the optional
attribute ’allowEquivalences’. When it is set to "true", the
result set should include ranges with equivalent starting and
ending numbers. The default value for ’allowEquivalences’ is
"false".
The results from this query MUST be <autonomousSystem> results. More
than one result MAY be returned.
3.1.7. <findByContact>
The <findByContact> element allows a search for autonomous systems,
IP networks, and organizations on fields associated with that
entity’s contact. The optional search element <returnedResultType>
MUST restrict the results to autonomous systems, IPv4 networks, IPv6
networks, or organizations using the values ’returnASs’,
’returnIPv4Networks’, ’returnIPv6Networks’, and
’returnOrganizations’, respectively.
The allowable search fields are handled with either the
<contactHandle> element or one of the elements in the
"contactSearchGroup" (see Section 3.1.9). The <contactHandle>
element allows for the entities to be selected based on the contact
having the specified contact handle, and it is an
"exactMatchParameter" type (see Section 3.1.11). The client SHOULD
pass these search fields unchanged to the server, and the
implementation of the server decides if the search is case sensitive
or not.
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 entity. The allowable values for this element are
"adminContact", "nocContact", "techContact", "abuseContact", and
"otherContact".
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.
The results from this query MUST be <ipv4Network> results,
<ipv6Network> results, <autonomousSystem> results, or <organization>
results. More than one result MAY be returned, and the results MAY
be of mixed types.
3.1.8. <findNetworksByNameServer>
The <findNetworksByNameServer> element allows a search for IP
networks based on their associated name servers. The <nameServer>
element contains the fully qualified domain name of the name server.
The optional search element <returnedResultType> MUST restrict the
results to IPv4 networks or IPv6 networks using the values
’returnIPv4Networks’ and ’returnIPv6Networks’, respectively.
The results from this query MUST be <ipv4Network> or <ipv6Network>
results. More than one result MAY be returned, and the results MAY
be of mixed types.
3.1.9. 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. This constraint is an
"exactOrPartialMatchParameter" (see Section 3.1.11).
This group also contains all the members of the "commonSearchGroup"
(see Section 3.1.10).
3.1.10. Common Search Group
Some of the queries above have similar query constraints for
searching on contacts. This section describes those common
parameters.
<eMail> constrains the query based on the e-mail address of the
contact. This constraint is a "domainResource" type (see
Section 3.1.11).
The <city>, <region>, <country>, and <postalCode> elements restrict
the scope of the query based on the city, region, country, or postal
code of the contact, respectively. These constraints are all
"exactMatchParameter" types (see Section 3.1.11). The contents of
<country> MUST be compliant with ISO 3166 [9] two-character country
codes.
3.1.11. Match Parameters
Some of the queries above have constraints that match strings using
matching parameters. This section describes those matching
parameters.
Elements of type "exactMatchParameter" will have one child element of
<exactMatch>. The contents of this child element are to match
exactly in the use of the constraint.
Elements of type "partialMatchParameter" will have either a
<beginsWith> child element with an optional <endsWith> child element
or an <endsWith> child element. The content of the <beginsWith>
element specifies the beginning character sequence for the
constraint. The content of the <endsWith> element specifies the
ending character sequence for the constraint.
Elements of type "exactOrPartialMatchParameter" can have either the
child element allowed with the "exactMatchParameter" type or the
child elements allowed with the "partialMatchParameter" type.
Elements of type "domainResource" can have either the child element
allowed with the "exactMatchParameter" type or a child element of
<inDomain>. This parameter type is meant to match email, SIP,
Extensible Messaging and Presence Protocol (XMPP), and other types of
"user@domain" addresses. When this parameter is specified with the
<exactMatch> child element, the constraint is based on the whole
email address. When this parameter is specified with the <inDomain>
child element, the constraint is based on any email address within
the domain given. 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).
3.2. Result Derivatives
3.2.1. <ipv4Network> and <ipv6Network> Results
The <ipv4Network> and <ipv6Network> share a common definition of
’ipNetworkType’. It has the following child elements:
o <networkHandle> contains the registry-unique assigned handle for
this network.
o <name> contains a human-friendly name for the network.
o <startAddress> contains the first IP address of the network.
o <endAddress> contains the last IP address of the network.
o <networkType> contains a string denoting the type of network.
o <networkTypeInfo> is an entity reference to a definition of the
values explained in a plain natural language. The referent MUST
be a <simpleEntity> as defined by [2].
o <nameServer> contains the domain name of a nameserver responsible
for reverse-DNS mapping for this network.
o <organization> contains an entity reference to the organization
assigned this network. The referent MUST be an <organization>
(Section 3.2.4) result.
o One of the following:
* <parent> contains an entity reference to the parent network of
this network. The referent MUST be an <ipv4Network>
(Section 3.2.1) result if this reference is a child of
<ipv4Network>. The referent MUST be an <ipv6Network>
(Section 3.2.1) result if this reference is a child of
<ipv6Network>.
* <noParent> signifies that this network has no parent network.
o Contact references (see Section 3.2.5).
o Common child elements (see Section 3.2.6).
3.2.2. <autonomousSystem> Result
The <autonomousSystem> element represents an assigned or allocated
autonomous system number range. It has the following children:
o <asHandle> contains a registry-unique assigned handle for this
autonomous system number range.
o <asNumberStart> contains an integer indicating the starting number
for the autonomous system number range.
o <asNumberEnd> contains an integer indicating the ending number for
the autonomous system number range.
o <name> contains a human-readable name for this autonomous system.
o <organization> contains an entity reference to the organization
assigned or allocated this autonomous system number range. The
referent MUST be an <organization> (Section 3.2.4) result.
o One of the following:
* <parent> contains an entity reference to the parent autonomous
system of this autonomous system. The referent MUST be an
<autonomousSystem> (Section 3.2.2) result.
* <noParent> signifies that this autonomous system has no parent
autonomous system.
o Contact references (see Section 3.2.5).
o Common child elements (see Section 3.2.6).
3.2.3. <contact> Result
The <contact> element represents the registration of a point of
contact. It has the following child elements:
o <contactHandle> contains the registry-unique assigned handle for
this contact.
o <commonName> specifies the name of the contact.
o <eMail> contains the email address for this contact.
o <sip> contains the sip address for this contact.
o <organization> contains an entity reference to the organization
associated with this contact. The referent MUST be an
<organization> (Section 3.2.4) result.
o <postalAddress> contains information for reaching the contact via
postal mail. It is composed of the following child elements:
* <address> contains the address for this contact.
* <city> contains the city where this contact is located.
* <region> contains the national region where this contact is
located.
* <postalCode> contains the postal code where this contact is
located.
* <country> contains the country code where this contact is
located. This MUST be compliant with ISO 3166 [9]
two-character country codes.
o <phone> contains child elements describing the phone number of the
contact. The child elements are <number>, <extension>, and
<type>.
o Common child elements (see Section 3.2.6).
3.2.4. <organization> Result
The <organization> element represents an organization. It has the
following child elements:
o <name> contains the name of the organization.
o <id> contains a registry-unique identifier for this organization.
o <eMail> contains the email address for this organization.
o <postalAddress> contains a information for reaching the
organization via postal mail. It is composed of the following
child elements:
* <address> contains the address for this organization.
* <city> contains the city where this organization is located.
* <region> contains the national region where this organization
is located.
* <postalCode> contains the postal code where this organization
is located.
* <country> contains the country code where this organization is
located. This MUST be compliant with ISO 3166 [9]
two-character country codes.
o <phone> contains child elements describing the phone number of the
contact. The child elements are <number>, <extension>, and
<type>.
o Contact references (see Section 3.2.5).
o Common child elements (see Section 3.2.6).
3.2.5. Contact References
The registry schema defined in Section 5 normalizes out a group of
elements used to reference contacts. This group is used by many of
the result types for this registry. The group has the following
elements, each of which may appear as many times as needed. The
referent of each MUST be <contact> (Section 3.2.3) results.
o <adminContact>
o <techContact>
o <nocContact>
o <abuseContact>
o <otherContact>
3.2.6. Common Result Child Elements
The registry schema defined in Section 5 normalizes out a group of
common elements that are used most among the result types. The group
has the following elements:
o <numberResourceRegistry> contains an entity reference to the
number resource registry of record. The referent MUST be an
<organization> (Section 3.2.4) result.
o <registrationDate> contains the date of first registration.
o <lastUpdatedDate> contains the date when the registration was last