RFC 3982
IRIS: A Domain Registry (dreg) Type for the Internet Registry Information Service (IRIS)
RFC 3982: IRIS: A Domain Registry (dreg) Type for the Internet Registry Information Service (IRIS) 🎀
Okay bestie, this one is from the Network Working Group and it's a Standards Track doc, dated January 2005 📅. It was written by A. Newton from VeriSign, Inc. and M. Sanz from DENIC eG 👩💻. The header doesn't list any RFC that it obsoletes or updates, so it's standing on its own 💅.
Status of This Memo ✨
Ok so this doc is an Internet standards track protocol for the Internet community, and the authors are literally asking for discussion and suggestions for improvements 🫶. If you want to know where this protocol stands, check the current edition of the "Internet Official Protocol Standards" (STD 1) 📚. Distribution of this memo is unlimited, so share away 🦋.
Copyright Notice ✨
Copyright (C) The Internet Society (2005). 💜
Abstract ✨
So the big idea here is an Internet Registry Information Service (IRIS) registry schema for registered DNS information 🌐. It extends the necessary query and result operations of IRIS so it can handle the information service needs for the syntaxes and results used by domain registries and registrars 💖. It's giving organized and useful 🧚.
Table of Contents 🌸
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Document Terminology . . . . . . . . . . . . . . . . . . . . . 3
3. Schema Description . . . . . . . . . . . . . . . . . . . . . . 3
3.1. Query Derivatives . . . . . . . . . . . . . . . . . . . 3
3.1.1. <findRegistrarsByName> Query . . . . . . . . . . 3
3.1.2. <findDomainsByContact> Query . . . . . . . . . . 4
3.1.3. <findDomainsByName> Query . . . . . . . . . . . 4
3.1.4. <findDomainsByIDN> Query . . . . . . . . . . . . 4
3.1.5. <findContacts> Query . . . . . . . . . . . . . . 5
3.1.6. <findDomainsByHost> Query . . . . . . . . . . . 5
3.1.7. Contact Search Group . . . . . . . . . . . . . . 5
3.2. Result Derivatives . . . . . . . . . . . . . . . . . . . 6
3.2.1. Privacy Labels . . . . . . . . . . . . . . . . . 6
3.2.2. <domain> Result . . . . . . . . . . . . . . . . 7
3.2.3. <host> Result . . . . . . . . . . . . . . . . . 10
3.2.4. <contact> Result . . . . . . . . . . . . . . . . 11
3.2.5. <registrationAuthority> . . . . . . . . . . . . 13
3.3. Generic Code Derivatives . . . . . . . . . . . . . . . . 13
3.3.1. <searchTooWide> . . . . . . . . . . . . . . . . 13
3.3.2. <languageNotSupported> . . . . . . . . . . . . . 14
3.4. Support for <iris:lookupEntity> . . . . . . . . . . . . 14
4. Formal XML Syntax . . . . . . . . . . . . . . . . . . . . . . 15
5. BEEP Transport Compliance . . . . . . . . . . . . . . . . . . 36
5.1. Message Pattern . . . . . . . . . . . . . . . . . . . . 36
5.2. Server Authentication . . . . . . . . . . . . . . . . . 36
6. URI Resolution . . . . . . . . . . . . . . . . . . . . . . . . 36
6.1. Application Service Label . . . . . . . . . . . . . . . 36
6.2. Bottom-Up Resolution . . . . . . . . . . . . . . . . . . 37
6.3. Top-Down Resolution . . . . . . . . . . . . . . . . . . 37
7. Internationalization Considerations . . . . . . . . . . . . . 38
8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 38
8.1. XML Namespace URN Registration . . . . . . . . . . . . . 38
8.2. S-NAPTR Registration . . . . . . . . . . . . . . . . . . 39
8.3. BEEP Registration . . . . . . . . . . . . . . . . . . . 39
9. Security Considerations . . . . . . . . . . . . . . . . . . . 39
10. References . . . . . . . . . . . . . . . . . . . . . . . . . . 39
10.1. Normative References . . . . . . . . . . . . . . . . . . 39
10.2. Informative References . . . . . . . . . . . . . . . . . 40
A. Examples of Requests and Responses . . . . . . . . . . . . . . 41
A.1. Example 1 . . . . . . . . . . . . . . . . . . . . . . . 41
A.2. Example 2 . . . . . . . . . . . . . . . . . . . . . . . 42
A.3. Example 3 . . . . . . . . . . . . . . . . . . . . . . . 43
B. An Example of Database Serialization . . . . . . . . . . . . . 47
C. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 48
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 49
Full Copyright Statement . . . . . . . . . . . . . . . . . . . . . 501. Introduction 💅
This doc describes an IRIS registry schema for Internet domain registries. It uses an XML Schema [4] that's derived from the IRIS [5] schema and builds on it 🧩. The query and result types here are based on the functional requirements described in CRISP [17] 🔥.
The schema given in this document is specified using the Extensible Markup Language (XML) 1.0, as described in XML [1] 📝. It also uses XML Schema notation, as described in XML_SD [3] and XML_SS [4] 💜, and XML Namespaces, as described in XML_NS [2] 🌈.
Examples of client/server XML exchanges with this registry type are in Appendix A 🎀.
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 BCP 14, RFC 2119 [10] 🔑. Those key words are the ones that matter, so read them carefully bestie 🫶.
3. Schema Description 🦋
IRIS needs both query and result elements to be derived by a registry schema, and that's what the next parts are about 🧚. The descriptions below follow.
References to XML elements without a 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 in this section refer to XML elements and attributes and how they relate to exchanging data in the protocol. They also include specifications that sit outside the scope of the formal XML syntax 💖. This section uses terms defined by RFC 2119 [10] to describe these. While you're reading, check Section 4 for the formal XML syntax details you need 👑.
3.1. Query Derivatives 🍓
3.1.1. <findRegistrarsByName> Query 🔍
<findRegistrarsByName> searches for a registration authority designated as a registrar for the registry of the server ✨.
If present, the <baseDomain> element MUST restrict the results of the search to registrars capable of registering subdomains in the domain signified by the content of this element 🎯.
The <namePart> element restricts the scope of the query with its child elements. The <beginsWith> element specifies the beginning of the registrar's name. The <endsWith> element specifies the end of the registrar's name. The <exactMatch> element specifies equivalence to the registrar's name 💅.
If the <namePart> element is not present, the query MUST return all registrars applicable (i.e., in consideration of <baseDomain>) 🌷.
This query MUST return a result set of zero or more <registrationAuthority> elements. See Section 3.2.5 🎀.
3.1.2. <findDomainsByContact> Query 💌
<findDomainsByContact> finds domains by searching on fields associated with a domain's contact 🕵️♀️. A search constraint of <baseDomain> MUST restrict the results to domains underneath the domain specified by its content, if it's present 💜.
The allowable search fields are handled with either the <contactHandle> element or one of the elements in the "contactSearchGroup" (see Section 3.1.7). The <contactHandle> element lets you select domains based on the contact that has the specified contact handle 🦄.
The query MAY also be constrained further by using the optional <role> element. The contents of this element signify the role the contact has with the domain 🎭.
This query also provides optional <language> elements containing language tags. Clients MAY use these elements to hint about the natural language(s) of the affected element. Servers MAY use this information in processing the query, such as in tailoring normalization routines to aid in more effective searches 🌍✨.
3.1.3. <findDomainsByName> Query 🌐
The <findDomainsByName> query finds domains by the name of a domain as it is known in DNS 🫧. The <namePart> element restricts the scope of the query with its child elements. The <beginsWith> element specifies the beginning of the domain name. The <endsWith> element specifies the end of the domain name 💖.
3.1.4. <findDomainsByIDN> Query 🌏
This query is different from the <findDomainsByName> query because it lets the scope take internationalized domain names into consideration 🌺. It returns the union of the desired domain and any associated variants. That's a big difference from a lookup in the "idn" entity class (Section 3.4), which only returns the domain or no results 😤.
The <namePart> element restricts the scope of the query with its child element. Its child, the <exactMatch> element, is designed to contain IDNs and not ACE labels. It MUST match only against equivalent IDNs, according to the notion of equivalence defined in RFC 3490 [14] 🧠.
This query also provides optional <language> elements containing language tags. Clients MAY use these elements to hint about the natural language(s) of the affected element. Servers MAY use this information in processing the query, such as in tailoring normalization routines to aid in more effective searches 💜.
3.1.5. <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.7) 🎀.
This query also provides optional <language> elements containing language tags. Clients MAY use these elements to hint about the natural language(s) of the affected element. Servers MAY use this information in processing the query, such as in tailoring normalization routines to aid in more effective searches 🌈.
3.1.6. <findDomainsByHost> Query 🏠
This query does a simple search for the domains being hosted by a name server. The search is constrained by using either the host name [12], host handle, IPv4 address, or IPv6 address of the name server 🧚♀️💫.
3.1.7. Contact Search Group ✨
okay so some of the queries above have similar constraints for searching on contacts, so this section is the group chat for those shared params 💬
<commonName> lets you constrain the query by the contact's common name 🫶. You can do an exact match with the <exactMatch> element, or grab a subset of the name with the <beginsWith> and <endsWith> elements.
<organization> lets you constrain the query by the contact's organization name 🏢. It has the exact same semantics as the <commonName> element, so no new rules to memorize, bestie 💅
<eMail> constrains the query by the contact's e-mail address 📧. You can match one exact address with <exactMatch>, or match any address in a domain with <inDomain>. The <inDomain> element MUST only contain a valid domain name (i.e., without an '@' symbol), and the matching SHOULD take place only on the domain given (i.e., no partial matches with respect to substrings or parent domains). Like, no sneaky substring or parent-domain matches 🙈 If either the contents of the <inDomain> element or the 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 by the city, region, or postal code of the contact 🏙️. Each one must only contain an <exactMatch> element holding the exact city, region, or postal code (i.e., no substring searches). Exact match only, no vibes-based searching 😭
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 🔒 To handle that, some of the results use the following element types:
- "dateTimePrivacyType" -- contains the XML Schema [3] data type "dateTime". The contents of this element MUST be specified by using the 'Z' indicator for Coordinated Universal Time (UTC).
- "stringPrivacyType" -- contains the XML Schema [3] data type "string".
- "normalizedStringPrivacyType" -- contains the XML Schema [3] data type "normalizedString".
- "tokenPrivacyType" -- contains the XML Schema [3] data type "token".
- "domainStatusType" -- contains the optional element of
<appliedDate>, indicating the date and time when the status was applied, and the optional element of<description>with the required attribute 'language', indicating a description of the status. This element also has the optional attribute 'scope', indicating the scope or origin of the status value. - "contactTypeType" -- contains optional
<description>child elements. Each<description>child element requires a 'language' attribute.
As specified, these elements can have nil values, so they may be present with empty content or present with their specified content ✨ The use of these elements is also optional, so no pressure 🫧
If present without content, each of these element types MUST have one or more of the following boolean attributes:
- 'private' -- If true, this specifies that the content is absent because it may never be published.
- 'denied' -- If true, this specifies that the content is absent because policy does not allow it to be given at the current level of access.
If present with content, each of these element types MAY have one or more of the following boolean attributes:
- 'doNotRedistribute' -- If true, this specifies that the content is not to be redistributed.
- '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 granted to 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 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. It's all about who's allowed in the VIP room 👑
3.2.2. <domain> Result 🌸
Here's an example of a <domain> result, and yes it's giving full XML main character energy 💅
<domain
authority="iana.org" registryType="dreg1"
entityClass="domain-handle" entityName="example-com-1">
<domainName>example.com</domainName>
<domainHandle>tcs-com-1</domainHandle>
<nameServer
iris:referentType="host"
authority="iana.org" registryType="dreg1"
entityClass="host-handle" entityName="research7" />
<nameServer
iris:referentType="host"
authority="iana.org" registryType="dreg1"
entityClass="host-handle" entityName="nsol184" />
<registry
iris:referentType="registrationAuthority"
authority="com"
registryType="dreg1"
entityClass="contact-handle"
entityName="VGRS" />
<registrar
iris:referentType="registrationAuthority"
authority="iana.org" registryType="dreg1"
entityClass="contact-handle" entityName="dbarton" />
<initialDelegationDateTime xsi:nil="true"/>
</domain>The <domain> result represents an instance of a domain assignment 🍓 The children of the <domain> element are as follows:
<domainName>-- the full name of the domain as it is in DNS. The contents of this element MUST be a domain name as specified by RFC 1035 [9].<idn>-- the name of the domain in nameprep form, if applicable. See RFC 3491 [15].<domainHandle>-- a registry unique assigned identifier for a domain.<nameServer>-- MUST contain an entity reference to a referent of type<host>(Section 3.2.3).<registrant>-- contains an entity reference to the registrant of this domain. The referent MUST be a<contact>result (Section 3.2.4).- Domain contacts -- the following elements contain an entity reference with a relationship to the domain. The referent of each MUST be a
<contact>(Section 3.2.4).<billingContacts><technicalContacts><administrativeContacts><legalContacts><zoneContacts><abuseContacts><securityContacts><otherContacts>
<status>-- This may contain at least one of the following elements of type 'domainStatusType' (see Section 3.2.1), but none of these elements may appear more than once.<reservedDelegation>-- permanently inactive<assignedAndActive>-- normal state<assignedAndInactive>-- registration assigned but delegation inactive<assignedAndOnHold>-- dispute<revoked>-- database purge pending<transferPending>-- change of authority pending<registryLock>-- on hold by registry<registrarLock>-- on hold by registrar
<domainVariant>-- contains an entity reference, the referent of which MUST be a<domain>(Section 3.2.2).<registrationReference>-- contains an entity reference, the referent of which MUST be a<domain>(Section 3.2.2). This element is intended to point to the downstream registration reference. Therefore, if this is a result given back by a domain registry, it should point to the domain in the domain registrar or registrant service.<registry>-- contains an entity reference specifying the domain registry operator for this domain, which MUST be a<registrationAuthority>(Section 3.2.5). This element has an optional boolean 'hosting' attribute. When the value of this attribute is positive, it indicates that the registry is responsible for authoritatively answering DNS queries for this domain.<registrar>-- contains an entity reference specifying the domain registrar operator for this domain, which MUST be a<registrationAuthority>(Section 3.2.5). This element has an optional boolean 'hosting' attribute. When the value of this attribute is positive, it indicates that the registrar is responsible for authoratively answering DNS queries for this domain.<initialDelegationDateTime>-- contains the date and time of the initial delegation of this domain.<lastRenewalDateTime>-- contains the date and time of last renewal of this domain.<expirationDateTime>-- contains the date and time of the expiration of this domain.<lastContactModificationDateTime>-- specifies the last time a contact for the domain was added or removed.<lastContactModificationBy>-- contains an entity reference. The referent MUST be a<contact>(Section 3.2.4) responsible for the last addition or removal of a contact for this domain.<lastDelegationModificationDateTime>-- contains the date and time of the last time one of the nameservers was added or removed for the delegation of this domain.<lastDelegationModificationBy>-- contains an entity reference. The referent MUST be a<contact>result (Section 3.2.4) and MUST be responsible for the last addition or removal of a nameserver for this domain.<lastVerificationDateTime>-- contains the date and time of the last time the data for this domain was verified by the responsible registration authority.<iris:seeAlso>-- contains an entity reference specifying a referent indirectly associated with this domain.
3.2.3. <host> Result 🧚
Here's an example of a <host> result 💜
<host
authority="iana.org" registryType="dreg1"
entityClass="host-handle" entityName="nsol184" >
<hostHandle>nsol184</hostHandle>
<hostName>a.iana-servers.net</hostName>
<ipV4Address>192.0.2.43</ipV4Address>
<hostContact
iris:referentType="contact"
authority="iana.org" registryType="dreg1"
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:
<hostHandle>-- a registry unique assigned identifier for the host.<hostName>-- the fully qualified domain name of the host. The contents of this element are a domain name and MUST conform to RFC 1035 [9].<ipV4Address>-- the content of this MUST conform to the a valid IP version 4 host address, as specified by RFC 791 [8].<ipV6Address>-- the content of this MUST conform to the a valid IP version 6 host address, as specified by RFC 3513 [7].<hostContact>-- contains an entity reference specifying a contact associated with this host. The referent MUST be<contact>(Section 3.2.4) results.<createdDateTime>-- contains the date and time when this host was created.<lastModificationDateTime>-- contains the date and time when this host was last modified.<lastVerificationDateTime>-- contains the date and time when this data for this host was last verified to be correct by the appropriate registration authority.<iris:seeAlso>-- contains an entity reference specifying a referent indirectly associated with this host.
3.2.4. <contact> Result 💌
okay bestie, here's what a <contact> result looks like 🎀
<contact
authority="iana.org" registryType="dreg1"
entityClass="contact-handle" entityName="dbarton" >
<contactHandle>dbarton</contactHandle>
<commonName>IANA Manager</commonName>
<organization>Internet Assigned Numbers Authority</organization>
<eMail>res-dom@iana.org</eMail>
<postalAddress>
<address>4676 Admiralty Way, Suite 330</address>
<city>Marina del Rey</city>
<region>CA</region>
<postalCode>92092</postalCode>
<country>US</country>
</postalAddress>
<phone>+1.3108239358</phone>
</contact>The <contact> element is an instance of a contact registration, and its children are the pieces that describe that contact 🧚
<contactHandle>is a registry unique assigned identifier for this contact. 🔑<commonName>is the name of the contact. 🫶<language>specifies the language code to use when localizing the data in this result. 🌸<type>contains one of the following child elements:<person>,<organization>,<role>, or<other>. Each of these elements is a "contactTypeType" as defined in Section 3.2.1. 💅<organization>contains the organization name of the contact. 🏢<eMail>contains an e-mail address for this contact. 📧<IDNeMail>contains an e-mail address within an internationalized domain name [14]. 🌍<sip>contains a SIP URI for this contact. 📞<postalAddress>contains children representing a postal address.<postalAddress>has the following children: 🏡<address>contains the street address for this contact.<city>contains the city for this contact.<region>contains the national region for this contact.<postalCode>contains the postal code for this contact.<country>contains the country for this contact. This SHOULD be a two-letter country code compliant with ISO 3166 [11]. 🗺️
<phone>contains a voice phone number for this contact. If it begins with a '+' (plus) character, it MUST be a number defined by E164 [13]. The format number defined in E164 [13] is RECOMMENDED. ☎️<fax>contains a facsimile phone number for this contact. If it begins with a '+' (plus) character, it MUST be a number defined by E164 [13]. The format number defined in E164 [13] is RECOMMENDED. 📠<createdDateTime>contains the date and time when this contact was created. 🐣<lastModificationDateTime>contains the date and time when this contact was last modified. ✏️<lastVerificationDateTime>contains the date and time when this data for this contact was last verified to be correct by the appropriate registration authority. ✅<translatedContacts>contains an entity reference specifying equivalents of this contact that have been translated into other languages. The referent MUST be<contact>results (Section 3.2.4). 🌐<iris:seeAlso>contains an entity reference specifying a referent indirectly associated with this contact. 🔗
3.2.5. <registrationAuthority> ✨
here's an example of a <registrationAuthority> result 👑
<registrationAuthority
authority="iana.org" registryType="dreg1"
entityClass="registration-authority" entityName="iana" >
<serviceInstance
iris:referentType="iris:serviceIdentification"
authority="iana.org" registryType="dreg1"
entityClass="iris" entityName="id" />
<organizationName>
Internet Assigned Numbers Authority
</organizationName>
<registrar />
</registrationAuthority>The <registrationAuthority> result is the entity that's capable of registering domains 🦋
The <serviceInstance> child element of <registrationAuthority> contains an entity reference pointing to the entity "id" in the entity class "iris". The authority areas found in the referent MUST be domains for which a given registration authority has control. 🗂️
The <organizationName> child element contains the name of the registration authority. 🏛️
The registration authority type child elements <registry>, <registrar>, and <other> decide the role this registration authority plays in the process of registering domains. This element is meant to explain the different roles a registration authority can have in the authority areas pointed to by the <serviceInstance> element. A client MAY understand the relationship of a registration authority with respect to a domain by the placement of the reference in the domain (e.g., <registry> or <registrar>). 🧠
The <domain> child elements each contain one domain name, signifying the domains for which this registration authority may register sub-domains. 🍓
3.3. Generic Code Derivatives 🌈
3.3.1. <searchTooWide> 🙈
Servers MAY use the <searchTooWide> error code when a query must be narrowed to yield a result set acceptable under the policies of the server operator. 🫣
3.3.2. <languageNotSupported> 🌍
the queries <findDomainsByRegistrant>, <findDomainsByIDNName>, and <findContacts> support optional language tags, so a client can suggest which languages the server should scope the queries to 💖 If a client passes a language that the server does not support, the server MAY use this error code to say that one of the languages isn't supported.
This element contains child elements named <unsupportedLanguage>. Each of these child elements specifies a language the server doesn't support. When a server returns this error, it MUST give the languages from the query which are not supported. 🚨
3.4. Support for <iris:lookupEntity> 🔍
these are the entity classes the <lookupEntity> query of IRIS recognizes for this registry 👀
- host-name -- The fully qualified domain name of a nameserver. It yields a
<host>(Section 3.2.3) in the response. 🖥️ - host-handle -- The registry unique identifier given a nameserver. It yields a
<host>(Section 3.2.3) in the response. 🆔 - domain-name -- The fully qualified name of a domain. This a domain name as specified by RFC 1035 [9]. It yields a
<domain>(Section 3.2.2) in the response. 🌷 - idn -- The fully qualified name of a domain in nameprep form (see RFC 3491 [15]). It yields a
<domain>(Section 3.2.2) in the response. 🌸 - domain-handle -- The registry unique identifier given a domain. It yields a
<domain>(Section 3.2.2) in the response. 🎫 - contact-handle -- The registry unique identifier given a contact. It yields a
<contact>(Section 3.2.4) in the response. 🧑🤝🧑 - ipv4-address -- The IPv4 address of a nameserver. It yields a
<host>(Section 3.2.3) in the response. 🔢 - ipv6-address -- The IPv6 address of a nameserver. It yields a
<host>(Section 3.2.3) in the response. 🔢 - registration-authority -- The name of a registration authority. It yields a
<registrationAuthority>(Section 3.2.5) in the response. 👑
All names in these entity classes are case insensitive. 🙌
4. Formal XML Syntax 🧩
This registry schema is specified in the XML Schema notation. The formal syntax presented here is a complete schema representation, suitable for automated validation of an XML instance when combined with the formal schema syntax of IRIS. 🎀
<?xml version="1.0"?>
<schema xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:dreg="urn:ietf:params:xml:ns:dreg1"
xmlns:iris="urn:ietf:params:xml:ns:iris1"
targetNamespace="urn:ietf:params:xml:ns:dreg1"
elementFormDefault="qualified" >
<import namespace="urn:ietf:params:xml:ns:iris1" />
<annotation>
<documentation>
Domain registry schema
derived from IRIS schema
</documentation>
</annotation>
<!-- ========================================= -->
<!-- -->
<!-- Query Types -->
<!-- -->
<!-- ========================================= -->
<!-- -->
<!-- Find Registrars By Name -->
<!-- -->
<complexType
name="findRegistrarsByNameType">
<complexContent>
<extension
base="iris:queryType">
<sequence>
<element
ref="dreg:baseDomain"
minOccurs="0"
maxOccurs="1" />
<element
name="namePart"
type="dreg:exactOrPartialMatchParameter"
minOccurs="0"
maxOccurs="1" />
</sequence>
</extension>
</complexContent>
</complexType>
<element
name="findRegistrarsByName"
type="dreg:findRegistrarsByNameType"
substitutionGroup="iris:query" />
<!-- -->
<!-- Find Domains By Contact -->
<!-- -->
<complexType
name="findDomainsByContactType">
<complexContent>
<extension
base="iris:queryType">
<sequence>
<element
ref="dreg:baseDomain"
minOccurs="0"
maxOccurs="1" />
<choice>
<group
ref="dreg:contactSearchGroup" />
<element
name="contactHandle"
type="dreg:exactMatchParameter" />
</choice>
<element
name="role"
minOccurs="0"
maxOccurs="1" >
<simpleType>
<restriction
base="string" >
<enumeration
value="registrant" />
<enumeration
value="billingContact" />
<enumeration
value="technicalContact" />
<enumeration
value="administrativeContact" />
<enumeration
value="legalContact" />
<enumeration
value="zoneContact" />
<enumeration
value="abuseContact" />
<enumeration
value="securityContact" />
<enumeration
value="otherContact" />
</restriction>
</simpleType>
</element>
<element
name="language"
type="language"
minOccurs="0"
maxOccurs="unbounded"/>
</sequence>
</extension>
</complexContent>
</complexType>
<element
name="findDomainsByContact"
type="dreg:findDomainsByContactType"
substitutionGroup="iris:query" />
<!-- -->
<!-- Find Domains By Name -->
<!-- -->
<complexType
name="findDomainsByNameType">
<complexContent>
<extension
base="iris:queryType">
<sequence>
<element
name="namePart"
type="dreg:partialMatchParameter" />
</sequence>
</extension>
</complexContent>
</complexType>
<element
name="findDomainsByName"
type="dreg:findDomainsByNameType"
substitutionGroup="iris:query" />okay bestie, the schema keeps going and the vibes are immaculate 💖✨
<!-- -->
<!-- Find Domains By Internationalized Name -->
<!-- -->
<complexType
name="findDomainsByIDNType">
<complexContent>
<extension
base="iris:queryType">
<sequence>
<element
name="namePart"
type="dreg:exactMatchParameter" />
<element
name="language"
type="language"
minOccurs="0"
maxOccurs="unbounded"/>
</sequence>
</extension>
</complexContent>
</complexType>
<element
name="findDomainsByIDN"
type="dreg:findDomainsByIDNType"
substitutionGroup="iris:query" />
<!-- -->
<!-- Find Contacts -->
<!-- -->
<complexType
name="findContactsType">
<complexContent>
<extension
base="iris:queryType">
<sequence>
<group
ref="dreg:contactSearchGroup" />
<element
name="language"
type="language"
minOccurs="0"
maxOccurs="unbounded"/>
</sequence>
</extension>
</complexContent>
</complexType>
<element
name="findContacts"
type="dreg:findContactsType"
substitutionGroup="iris:query" />
<!-- -->
<!-- Find Domains By Host -->
<!-- -->
<complexType
name="findDomainsByHostType">
<complexContent>
<extension
base="iris:queryType">
<sequence>
<element
ref="dreg:baseDomain"
minOccurs="0"
maxOccurs="1" />
<choice>
<element
name="hostName"
type="dreg:exactMatchParameter" />
<element
name="hostHandle"
type="dreg:exactMatchParameter" />
<element
name="ipV4Address"
type="dreg:exactMatchParameter" />
<element
name="ipV6Address"
type="dreg:exactMatchParameter" />
</choice>
</sequence>
</extension>
</complexContent>
</complexType>
<element
name="findDomainsByHost"
type="dreg:findDomainsByHostType"
substitutionGroup="iris:query" />
<!-- -->
<!-- Contact Search Group -->
<!-- -->
<group
name="contactSearchGroup">
<choice>
<element
name="commonName"
type="dreg:exactOrPartialMatchParameter" />
<element
name="organization"
type="dreg:exactOrPartialMatchParameter" />
<element
name="eMail"
type="dreg:domainResourceParameter" />
<element
name="city"
type="dreg:exactMatchParameter" />
<element
name="region"
type="dreg:exactMatchParameter" />
<element
name="postalCode"
type="dreg:exactMatchParameter" />
</choice>
</group>
<complexType
name="exactOrPartialMatchParameter">
<choice>
<group
ref="dreg:partialMatchGroup" />
<group
ref="dreg:exactMatchGroup" />
</choice>
</complexType>
<complexType
name="exactMatchParameter">
<group
ref="dreg:exactMatchGroup" />
</complexType>
<complexType
name="partialMatchParameter">
<sequence>
<group
ref="dreg:partialMatchGroup" />
</sequence>
</complexType>
<complexType
name="domainResourceParameter" >
<choice>
<group
ref="dreg:exactMatchGroup" />
<element
name="inDomain"
type="token" />
</choice>
</complexType>
<element
name="baseDomain"
type="normalizedString" />
<group
name="partialMatchGroup">
<choice>
<sequence>
<element
name="beginsWith">
<simpleType>
<restriction
base="token">
<minLength
value="1"/>
</restriction>
</simpleType>
</element>
<element
minOccurs="0"
name="endsWith">
<simpleType>
<restriction
base="token">
<minLength
value="1"/>
</restriction>
</simpleType>
</element>
</sequence>
<element
name="endsWith">
<simpleType>
<restriction
base="token">
<minLength
value="1"/>
</restriction>
</simpleType>
</element>
</choice>
</group>
<group
name="exactMatchGroup">
<sequence>
<element
name="exactMatch"
type="normalizedString" />
</sequence>
</group>
<!-- ========================================= -->
<!-- -->
<!-- Result Types -->
<!-- -->
<!-- ========================================= -->
<!-- -->
<!-- Domain -->
<!-- -->
Okay bestie, this part is all about the domain and host objects, plus the first bit of contact 💅 Each one is basically a little profile card with lots of optional fields, so take a peek at what each domainType can carry 🦋
<complexType
name="domainType">
<complexContent>
<extension
base="iris:resultType">
<sequence>
<element
name="domainName"
type="token" />
<element
name="idn"
type="token"
minOccurs="0"
maxOccurs="1" />
<element
name="domainHandle"
type="dreg:normalizedStringPrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="1" />
<element
name="nameServer"
type="iris:entityType"
minOccurs="0"
maxOccurs="unbounded" />
<element
name="registrant"
type="iris:entityType"
minOccurs="0"
maxOccurs="1" />
<element
name="billingContact"
type="iris:entityType"
minOccurs="0"
maxOccurs="unbounded" />
<element
name="technicalContact"
type="iris:entityType"
minOccurs="0"
maxOccurs="unbounded" />
<element
name="administrativeContact"
type="iris:entityType"
minOccurs="0"
maxOccurs="unbounded" />
<element
name="legalContact"
type="iris:entityType"
minOccurs="0"
maxOccurs="unbounded" />
<element
name="zoneContact"
type="iris:entityType"
minOccurs="0"
maxOccurs="unbounded" />
<element
name="abuseContact"
type="iris:entityType"
minOccurs="0"
maxOccurs="unbounded" />
<element
name="securityContact"
type="iris:entityType"
minOccurs="0"
maxOccurs="unbounded" />
<element
name="otherContact"
type="iris:entityType"
minOccurs="0"
maxOccurs="unbounded" />
<element
name="lastContactModificationDateTime"
type="dreg:dateTimePrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="1" />
<element
name="lastContactModificationBy"
type="iris:entityType"
minOccurs="0"
maxOccurs="1" />
<element
name="status"
minOccurs="0"
maxOccurs="1">
<complexType>
<all>
<element
name="reservedDelegation"
minOccurs="0"
maxOccurs="1"
type="dreg:domainStatusType" />
<element
name="assignedAndActive"
minOccurs="0"
maxOccurs="1"
type="dreg:domainStatusType" />
<element
name="assignedAndInactive"
minOccurs="0"
maxOccurs="1"
type="dreg:domainStatusType" />
<element
name="assignedAndOnHold"
minOccurs="0"
maxOccurs="1"
type="dreg:domainStatusType" />
<element
name="revoked"
minOccurs="0"
maxOccurs="1"
type="dreg:domainStatusType" />
<element
name="transferPending"
minOccurs="0"
maxOccurs="1"
type="dreg:domainStatusType" />
<element
name="registryLock"
minOccurs="0"
maxOccurs="1"
type="dreg:domainStatusType" />
<element
name="registrarLock"
minOccurs="0"
maxOccurs="1"
type="dreg:domainStatusType" />
<element
name="other"
minOccurs="0"
maxOccurs="1"
type="dreg:domainStatusType" />
</all>
</complexType>
</element>
<element
name="domainVariant"
type="iris:entityType"
minOccurs="0"
maxOccurs="unbounded" />
<element
name="registrationReference"
type="iris:entityType"
minOccurs="0"
maxOccurs="1" />
<element
name="registry"
minOccurs="0"
maxOccurs="1">
<complexType>
<complexContent>
<extension
base="iris:entityType">
<attribute
name="hosting"
type="boolean" />
</extension>
</complexContent>
</complexType>
</element>
<element
name="registrar"
minOccurs="0"
maxOccurs="1">
<complexType>
<complexContent>
<extension
base="iris:entityType">
<attribute
name="hosting"
type="boolean" />
</extension>
</complexContent>
</complexType>
</element>
<element
name="initialDelegationDateTime"
type="dreg:dateTimePrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="1" />
<element
name="lastRenewalDateTime"
type="dreg:dateTimePrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="1" />
<element
name="expirationDateTime"
type="dreg:dateTimePrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="1" />
<element
name="lastDelegationModificationDateTime"
type="dreg:dateTimePrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="1" />
<element
name="lastDelegationModificationBy"
type="iris:entityType"
minOccurs="0"
maxOccurs="1" />
<element
name="lastVerificationDateTime"
type="dreg:dateTimePrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="1" />
<element
ref="iris:seeAlso"
minOccurs="0"
maxOccurs="unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<element
name="domain"
type="dreg:domainType"
substitutionGroup="iris:result" />
<!-- -->
<!-- Host -->
<!-- -->
<complexType
name="hostType">
<complexContent>
<extension
base="iris:resultType">
<sequence>
<element
name="hostHandle"
type="dreg:normalizedStringPrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="1" />
<element
name="hostName"
type="normalizedString" />
<element
name="ipV4Address"
type="token"
minOccurs="0"
maxOccurs="unbounded" />
<element
name="ipV6Address"
type="token"
minOccurs="0"
maxOccurs="unbounded" />
<element
name="hostContact"
type="iris:entityType"
minOccurs="0"
maxOccurs="unbounded" />
<element
name="createdDateTime"
type="dreg:dateTimePrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="1" />
<element
name="lastModificationDateTime"
type="dreg:dateTimePrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="1" />
<element
name="lastVerificationDateTime"
type="dreg:dateTimePrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="1" />
<element
ref="iris:seeAlso"
minOccurs="0"
maxOccurs="unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<element
name="host"
type="dreg:hostType"
substitutionGroup="iris:result" />
<!-- -->
<!-- Contact -->
<!-- -->
<complexType
name="contactType">
<complexContent>
<extension
base="iris:resultType">
<sequence>
<element
name="contactHandle"
type="dreg:normalizedStringPrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="1" />
<elementOkay bestie, we're picking up right where the schema left off, so let's keep that vibe going 🧚💅
name="commonName"
type="dreg:normalizedStringPrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="1"/>
<element
name="language"
type="language"
minOccurs="0"
maxOccurs="1" />
<element
name="type"
minOccurs="0"
maxOccurs="1">
<complexType>
<choice>
<element
name="person"
type="dreg:contactTypeType" />
<element
name="organization"
type="dreg:contactTypeType" />
<element
name="role"
type="dreg:contactTypeType" />
<element
name="other"
type="dreg:contactTypeType" />
</choice>
</complexType>
</element>
<element
name="organization"
type="dreg:normalizedStringPrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="1" />
<element
name="eMail"
type="dreg:stringPrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="unbounded" />
<element
name="IDNeMail"
type="dreg:stringPrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="unbounded" />
<element
name="sip"
type="dreg:stringPrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="unbounded" />
<element
name="postalAddress"
minOccurs="0"
maxOccurs="unbounded" >
<complexType>
<sequence>
<element
name="address"
type="dreg:stringPrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="1" />
<element
name="city"
type="dreg:stringPrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="1" />
<element
name="region"
type="dreg:stringPrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="1" />
<element
name="postalCode"
type="dreg:normalizedStringPrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="1" />
<element
name="country"
type="dreg:tokenPrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="1" />
</sequence>
</complexType>
</element>
<element
name="phone"
type="dreg:normalizedStringPrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="unbounded" />
<element
name="fax"
type="dreg:normalizedStringPrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="unbounded" />
<element
name="createdDateTime"
type="dreg:dateTimePrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="1" />
<element
name="lastModificationDateTime"
type="dreg:dateTimePrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="1" />
<element
name="lastVerificationDateTime"
type="dreg:dateTimePrivacyType"
nillable="true"
minOccurs="0"
maxOccurs="1" />
<element
name="translatedContact"
type="iris:entityType"
minOccurs="0"
maxOccurs="unbounded" />
<element
ref="iris:seeAlso"
minOccurs="0"
maxOccurs="unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<element
name="contact"
type="dreg:contactType"
substitutionGroup="iris:result" />
<!-- -->
<!-- Registration Authority -->
<!-- -->
<complexType
name="registrationAuthorityType">
<complexContent>
<extension
base="iris:resultType">
<sequence>
<element
name="serviceInstance"
type="iris:entityType"
minOccurs="0"
maxOccurs="1" />
<element
name="organizationName"
type="string"
minOccurs="0"
maxOccurs="1" />
<choice
minOccurs="0"
maxOccurs="3">
<element
name="registry">
<complexType/>
</element>
<element
name="registrar">
<complexType/>
</element>
<element
name="other">
<complexType/>
</element>
</choice>
<element
name="domain"
type="token"
minOccurs="0"
maxOccurs="unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<element
name="registrationAuthority"
type="dreg:registrationAuthorityType"
substitutionGroup="iris:result" />
<!-- -->
<!-- Privacy Label Types -->
<!-- -->
<attributeGroup
name="privacyLabelAttributeGroup">
<attribute
name="private"
type="boolean" />
<attribute
name="denied"
type="boolean" />
<attribute
name="doNotRedistribute"
type="boolean" />
<attribute
name="specialAccess"
type="boolean" />
</attributeGroup>
<complexType
name="dateTimePrivacyType">
<simpleContent>
<extension
base="dateTime">
<attributeGroup
ref="dreg:privacyLabelAttributeGroup" />
</extension>
</simpleContent>
</complexType>
<complexType
name="stringPrivacyType">
<simpleContent>
<extension
base="string">
<attributeGroup
ref="dreg:privacyLabelAttributeGroup" />
</extension>
</simpleContent>
</complexType>
<complexType
name="normalizedStringPrivacyType">
<simpleContent>
<extension
base="normalizedString">
<attributeGroup
ref="dreg:privacyLabelAttributeGroup" />
</extension>
</simpleContent>
</complexType>
<complexType
name="tokenPrivacyType">
<simpleContent>
<extension
base="token">
<attributeGroup
ref="dreg:privacyLabelAttributeGroup" />
</extension>
</simpleContent>
</complexType>
<complexType
name="domainStatusType">
<sequence>
<element
name="appliedDate"
type="dateTime"
minOccurs="0"
maxOccurs="1" />
<element
name="description"
minOccurs="0"
maxOccurs="unbounded">
<complexType>
<simpleContent>
<extension
base="string">
<attribute
name="language"
type="language"
use="required" />
</extension>
</simpleContent>
</complexType>
</element>
</sequence>
<attributeGroup
ref="dreg:privacyLabelAttributeGroup" />
<attribute
name="scope"
type="string" />
</complexType>
<complexType
name="contactTypeType">
<sequence>
<element
name="description"
minOccurs="0"
maxOccurs="unbounded">
<complexType>
<simpleContent>
<extension
base="string">
<attribute
name="language"
type="language"
use="required" />
</extension>
</simpleContent>
</complexType>
</element>
</sequence>
<attributeGroup
ref="dreg:privacyLabelAttributeGroup" />
</complexType>
<!-- ========================================= -->
<!-- -->
<!-- Error Codes -->
<!-- -->
<!-- ========================================= -->
<!-- -->
<!-- Search Too Wide -->
<!-- -->
<element
name="searchTooWide"
type="iris:codeType"
substitutionGroup="iris:genericCode" />
<!-- -->
<!-- Language Not Supported -->
<!-- -->
<complexType
name="languageNotSupportedType">
<complexContent>
<extension
base="iris:codeType">
<sequence>
<element
name="unsupportedLanguage"
type="language"
minOccurs="1"
maxOccurs="unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<element
name="languageNotSupported"
type="dreg:languageNotSupportedType"
substitutionGroup="iris:genericCode" />
</schema>Figure 5: dreg.xsd 📎✨
5. BEEP Transport Compliance 🎀
okay so IRIS lets you add some extra stuff on top of its core capabilities, and this section is all about the extensions that IRIS-BEEP [6] says are allowed 🦋 main character energy for sure
5.1. Message Pattern 💌
this registry type just uses the default message pattern from IRIS-BEEP [6]. no extra drama, it's giving classic 💅
5.2. Server Authentication 🔐
so this registry type only uses the basic TLS server authentication method, which is described in IRIS-BEEP [6]. simple and iconic ✨
6. URI Resolution 🌸
6.1. Application Service Label 🧚
okay this one's important bestie 🫶 the application service label for this registry type MUST be "DREG1". that's the short version of the URN for this registry type, which is urn:ietf:params:xml:ns:dreg1 💜
6.2. Bottom-Up Resolution 🪜
Okay bestie, the bottom-up alternative resolution method MUST be identified as 'bottom' in IRIS URIs 🎀
It only works differently from direct-resolution when the authority is just a domain name, meaning there's no port number tacked on the end 🦋 Here's how that goes:
- The IRIS [5] direct-resolution process is tried on the domain name (e.g.,
"example.com"). - If direct-resolution yields no server that a connection can be made to, the leftmost label of the domain name gets removed, and step 1 gets repeated (e.g.,
"com") ✂️ - If all the labels of the domain name get removed and still no server connections have been made, the DNS is queried for the address records for the original domain name, and the port used is the well-known port for the default protocol of IRIS 🧚
6.3. Top-Down Resolution 🌳
The top-down alternative resolution method MUST be identified as 'top' in IRIS URIs 💜
Same deal as before: this only changes things when the authority is just a domain name, with no port number 🙈
- The domain name gets reduced to its rightmost label. This is always
'.'. - The IRIS [5] direct-resolution process is tried on the domain name.
- If direct-resolution yields no server that a connection can be made to, the original label to the left of the rightmost label of the domain name gets prepended, and step 2 gets repeated (e.g., if
".", then"com"; if"com", then"example.com") 🌈 - If all the labels of the original domain are present and still no server connections have been made, the DNS is queried for the address records for the original domain name, and the port used is the well-known port for the default protocol of IRIS 🫶
7. Internationalization Considerations 🌍
Implementers should be aware of the internationalization considerations in IRIS [5] 💅
This document covers looking up domain names, both the traditional ASCII form and the IDN form ✨ Also, the social data attached to contacts can be non-ASCII and might contain basically any Unicode character 🤯 That's why the <language> element exists in queries that could end up traversing that kind of data. Clients should use it to tell the server which target languages they want, and servers should use it to make normalization and search processes work better (see [18]) 🎀
For clients who need to localize the data tags in this protocol, here's the tea: localization is only needed for the names of XML elements and attributes, except for elements holding date and time information 📝 The schema for this registry was designed so clients don't need to interpret the content of elements or attributes for localization, other than elements with date and time info 🦋
Clients should also use the <language> elements that come with lots of the results. Results with data that might be in Unicode come with these elements to help present the data to the user nicely 🌸
The "dateTimePrivacyType" element type holds the XML Schema [3] data type "dateTime". The contents of this element MUST be specified by using the 'Z' indicator for Coordinated Universal Time (UTC) ⏰
8. IANA Considerations 📋
8.1. XML Namespace URN Registration
This document uses a proposed XML namespace and schema registry specified in XML_URN [16], so here's the registration info for IANA 💖
- URN/URI:
urn:ietf:params:xml:ns:dreg1
- Contact:
Andrew Newton <andy@hxr.us>Marcos Sanz <sanz@denic.de>
- XML:
- The XML Schema specified in Section 4
8.2. S-NAPTR Registration
The following S-NAPTR application service label got registered with IANA, following the IANA considerations defined in IRIS [5] ✨
DREG1
8.3. BEEP Registration
The following BEEP Profile URI got registered with IANA, on top of the registration already in IRIS-BEEP [6] 🎀
9. Security Considerations 🔐
This document lays out no new security considerations beyond what IRIS [5] already specifies. Full stop, no extra drama on this one 🙈 (Okay, maybe a little drama: go read IRIS [5] for the real security details, bestie 😭)
10. References
10.1. Normative References
- [1] World Wide Web Consortium, "Extensible Markup Language (XML) 1.0", W3C XML, February 1998,
<http://www.w3.org/TR/1998/REC-xml-19980210>. - [2] World Wide Web Consortium, "Namespaces in XML", W3C XML Namespaces, January 1999,
<http://www.w3.org/TR/1999/REC-xml-names-19990114>. - [3] World Wide Web Consortium, "XML Schema Part 2: Datatypes", W3C XML Schema, October 2000,
<http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/>. - [4] World Wide Web Consortium, "XML Schema Part 1: Structures", W3C XML Schema, October 2000,
<http://www.w3.org/TR/2001/REC-xmlschema-1-20010502/>. - [5] Newton, A. and M. Sanz, "IRIS: The Internet Registry Information Service (IRIS) Core Protocol", RFC 3981, December 2005.
- [6] Newton, A. and M. Sanz, "Using the Internet Registry Information Service (IRIS) over the Blocks Extensible Exchange Protocol (BEEP)", RFC 3983, December 2005.
- [7] Hinden, R. and S. Deering, "Internet Protocol Version 6 (IPv6) Addressing Architecture", RFC 3513, April 2003.
- [8] Postel, J., "Internet Protocol", STD 5, RFC 791, September 1981.
- [9] Mockapetris, P., "Domain names - implementation and specification", STD 13, RFC 1035, November 1987.
- [10] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997.
- [11] International Organization for Standardization, "Codes for the representation of names of countries, 3rd edition", ISO Standard 3166, August 1988.
- [12] Braden, R., "Requirements for Internet Hosts - Application and Support", STD 3, RFC 1123, October 1989.
- [13] International Telecommunications Union, "The International Public Telecommunication Numbering Plan", ITU-T Recommendation E.164, 1991.
- [14] Faltstrom, P., Hoffman, P., and A. Costello, "Internationalizing Domain Names in Applications (IDNA)", RFC 3490, March 2003.
- [15] Hoffman, P. and M. Blanchet, "Nameprep: A Stringprep Profile for Internationalized Domain Names (IDN)", RFC 3491, March 2003.
- [16] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, January 2004.
10.2. Informative References
- [17] Newton, A., "Cross Registry Internet Service Protocol (CRISP) Requirements", RFC 3707, February 2004.
URIs
Appendix A. Examples of Requests and Responses 🎀
The examples in this section use the string "C:" to denote data sent by a client to a server and the string "S:" to denote data sent by a server to a client 💕
A.1. Example 1
This one is an entity lookup in a dreg1 registry for the domain-name 'example.com'. The response shows how data can be marked as withheld because it's private 🕵️♀️
C: <?xml version="1.0"?>
C: <request xmlns="urn:ietf:params:xml:ns:iris1"
C: xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
C:
C: <searchSet>
C:
C: <lookupEntity
C: registryType="urn:ietf:params:xml:ns:dreg1"
C: entityClass="domain-name"
C: entityName="example.com" />
C:
C: </searchSet>
C:
C: </request>
S: <?xml version="1.0"?>
S: <iris:response xmlns:iris="urn:ietf:params:xml:ns:iris1"
S: xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
S:
S: <iris:resultSet>
S: <iris:answer>
S:
S: <domain xmlns="urn:ietf:params:xml:ns:dreg1"
S: authority="iana.org" registryType="dreg1"
S: entityClass="domain-handle" entityName="example-com-1">
S:
S: <domainName>example.com</domainName>
S: <domainHandle>tcs-com-1</domainHandle>
S:
S: <nameServer iris:referentType="host" authority="iana.org"
S: registryType="dreg1" entityClass="host-handle"
S: entityName="research7" />
S:
S: <nameServer iris:referentType="host" authority="iana.org"
S: registryType="dreg1" entityClass="host-handle"
S: entityName="nsol184" />
S:
S: <technicalContact iris:referentType="contact"
S: authority="iana.org" registryType="dreg1"
S: entityClass="contact-handle" entityName="dbarton" />
S:
S: <status>
S: <assignedAndActive denied="true" />
S: </status>
S:
S: <registry iris:referentType="registrationAuthority"
S: authority="com" registryType="dreg1"
S: entityClass="contact-handle" entityName="VGRS" />
S:
S: <initialDelegationDateTime xsi:nil="true"/>
S:
S: <iris:seeAlso iris:referentType="ANY" authority="iana.org"
S: registryType="dreg1" entityClass="local"
S: entityName="notice" />
S:
S: </domain>
S:
S: </iris:answer>
S: </iris:resultSet>
S: </iris:response>
Figure 6: Example 1A.2. Example 2
This one is an entity lookup in a dreg1 registry for the contact-handle of 'mak21'. The response shows how data can be marked as withheld because it's private 🙈
C: <?xml version="1.0"?>
C: <request xmlns="urn:ietf:params:xml:ns:iris1"
C: xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
C:
C: <searchSet>
C:
C: <lookupEntity
C: registryType="urn:ietf:params:xml:ns:dreg1"
C: entityClass="contact-handle"
C: entityName="mak21" />
C:
C: </searchSet>
C:
C: </request>
S: <?xml version="1.0"?>
S: <response xmlns="urn:ietf:params:xml:ns:iris1"
S: xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
S:
S: <resultSet>
S: <answer>
S:
S: <contact xmlns="urn:ietf:params:xml:ns:dreg1"
S: authority="com" registryType="dreg1"
S: entityClass="contact-handle" entityName="mak21" >
S:
S: <contactHandle>mak21</contactHandle>
S:
S: <commonName>
S: Mark Kosters
S: </commonName>
S:
S: <organization>
S: VeriSign, Inc.
S: </organization>
S:
S: <eMail>markk@verisignlabs.com</eMail>
S:
S: <phone private="true" xsi:nil="true" />
S:
S: </contact>
S:
S: </answer>
S: </resultSet>
S:
S: </response>
Figure 7: Example 2A.3. Example 3 🎀
okay so this one is a domain search for a registrant whose name starts with 'The Cobbler Shoppe' 👞✨ it's giving small business energy, and it also shows off bags 👜 which is so fun. the client asks for the domains, and the server answers with the matching domain, its contacts, status, and that little legal notice at the end. the technical contact's extra info gets tucked into a bag, referenced by bagRef="x1" 🧚
C: <?xml version="1.0"?>
C: <request xmlns="urn:ietf:params:xml:ns:iris1"
C: xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
C:
C: <searchSet>
C:
C: <findDomainsByContact
C: xmlns="urn:ietf:params:xml:ns:dreg1" >
C: <baseDomain>com</baseDomain>
C: <commonName>
C: <beginsWith>
C: The Cobbler Shoppe
C: </beginsWith>
C: </commonName>
C: <role>registrant</role>
C: </findDomainsByContact>
C:
C: </searchSet>
C:
C: </request>
S: <?xml version="1.0"?>
S: <response xmlns="urn:ietf:params:xml:ns:iris1"
S: xmlns:iris="urn:ietf:params:xml:ns:iris1"
S: xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
S:
S: <resultSet>
S: <answer>
S: <dreg:domain
S: xmlns="urn:ietf:params:xml:ns:dreg1"
S: xmlns:dreg="urn:ietf:params:xml:ns:dreg1"
S: authority="com" registryType="dreg1"
S: entityClass="domain-handle" entityName="tcs-com-1" >
S: <domainName>example.com</domainName>
S: <nameServer
S: iris:referentType="dreg:host"
S: authority="com" registryType="dreg1"
S: entityClass="host-handle" entityName="research7" />
S: <nameServer
S: iris:referentType="dreg:host"
S: authority="com" registryType="dreg1"
S: entityClass="host-handle" entityName="nsol184" />
S: <registrant
S: iris:referentType="dreg:contact"
S: authority="com" registryType="dreg1"
S: entityClass="contact-handle" entityName="beb140">
S: <iris:displayName language="en">
S: Bill Eckels
S: </iris:displayName>
S: </registrant>
S: <technicalContact
S: bagRef="x1"
S: iris:referentType="dreg:contact"
S: authority="com" registryType="dreg1"
S: entityClass="contact-handle" entityName="mak21">
S: <iris:displayName language="en">
S: Mark Kosters
S: </iris:displayName>
S: </technicalContact>
S: <status>
S: <transferPending denied="true" />
S: <assignedAndActive denied="true" />
S: </status>
S: <registry
S: iris:referentType="dreg:registrationAuthority"
S: authority="com" registryType="dreg1"
S: entityClass="local" entityName="VRSN"
S: hosting="false" />
S: <iris:seeAlso
S: iris:referentType="ANY"
S: authority="com" registryType="dreg1"
S: entityClass="local" entityName="notice" />
S: </dreg:domain>
S: </answer>
S: <additional>
S: <dreg:contact
S: xmlns="urn:ietf:params:xml:ns:dreg1"
S: xmlns:dreg="urn:ietf:params:xml:ns:dreg1"
S: authority="com" registryType="dreg1"
S: entityClass="contact-handle" entityName="beb140" >
S: <contactHandle>beb140</contactHandle>
S: <commonName>
S: Bill Eckels
S: </commonName>
S: <language>en</language>
S: <type>
S: <person>
S: <description language="en">
S: Bill sells shoes down by the sea shore.
S: </description>
S: <description language="de">
S: Rechnung verkauft Schuhe unten durch das Seeufer.
S: </description>
S: </person>
S: </type>
S: <organization>
S: The Cobbler Shoppe
S: </organization>
S: <eMail private="true" xsi:nil="true" />
S: <postalAddress>
S: <address>
S: 21 North Main Street
S: </address>
S: <city>
S: Britt
S: </city>
S: <region>
S: IA
S: </region>
S: <postalCode>
S: 50423
S: </postalCode>
S: <country>
S: US
S: </country>
S: </postalAddress>
S: <phone>
S: +1.5158433521
S: </phone>
S: </dreg:contact>
S: <simpleEntity
S: authority="com" registryType="dreg1"
S: entityClass="local" entityName="notice" >
S: <property name="legal" language="en">
S: It is illegal to use information from this service
S: for the purposes of sending unsolicited bulk email.
S: </property>
S: </simpleEntity>
S: </additional>
S: </resultSet>
S: <bags>
S: <bag id="x1">
S: <simpleBag xmlns="http://example.com/">
S: AAAAB3NzaC1yc2EAAAABIwAAAIEA0ddD+W3Agl0Lel98G1r77fZ
S: c3nBl8CHdkmKuVGUy/ijmvdO5QxuSlU0R4BoCLZk/Sob22RApTn
S: T+ROMbXFQBrxGH08daAOy98WqpfAutWJri61JLpubIbaqhGyB48
S: Qt69V6OhYfFsJjvoNEOh1k2dgzXhSlzP3OMVSKRlBzGcO8=
S: </simpleBag>
S: </bag>
S: </bags>
S:
S: </response>Figure 8: Example 3
Appendix B. An Example of Database Serialization 🧁
okay bestie, this one shows what serializing domain data looks like 💾 it packs up three things in one go: a domain, a host, and a referral. so basically it's a little snapshot of everything, all wrapped up neatly ✨
<iris:serialization
xmlns:iris="urn:ietf:params:xml:ns:iris1"
xmlns:dreg="urn:ietf:params:xml:ns:dreg1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<dreg:domain
xmlns="urn:ietf:params:xml:ns:dreg1"
authority="com" registryType="dreg1"
entityClass="domain-handle" entityName="tcs-com-1" >
<domainName>example.com</domainName>
<nameServer
iris:referentType="dreg:host"
authority="" registryType="dreg1"
entityClass="host-handle" entityName="research7" />
<nameServer
iris:referentType="dreg:host"
authority="" registryType="dreg1"
entityClass="host-handle" entityName="nsol184" />
<registrant
iris:referentType="dreg:contact"
authority="iana.org" registryType="dreg1"
entityClass="contact-handle" entityName="beb140" />
<technicalContact
iris:referentType="dreg:contact"
authority="net" registryType="dreg1"
entityClass="contact-handle"
entityName="mak21" >
<iris:displayName language="en">
IANA Administrator
</iris:displayName>
</technicalContact>
</dreg:domain>
<dreg:host
xmlns="urn:ietf:params:xml:ns:dreg1"
authority="com" registryType="dreg1"
entityClass="host-handle" entityName="nsol184" >
<hostHandle>nsol184</hostHandle>
<hostName>ns1.iana.org</hostName>
<ipV4Address>192.0.2.1</ipV4Address>
<hostContact
iris:referentType="dreg:contact"
authority="com" registryType="dreg1"
entityClass="contact-handle"
entityName="dbarton" >
<iris:displayName language="en">
IANA Techie
</iris:displayName>
</hostContact>
</dreg:host>
<iris:serializedReferral>
<iris:source
authority="com" registryType="dreg1"
entityClass="contact-handle"
entityName="dbarton" />
<iris:searchContinuation
authority="net">
<dreg:findRegistrarsByName>
<dreg:baseDomain>com</dreg:baseDomain>
</dreg:findRegistrarsByName>
</iris:searchContinuation>
</iris:serializedReferral>
</iris:serialization>Figure 9: dreg-serialization.xml
Appendix C. Acknowledgements 🫶
a big shoutout to everyone who made this possible 📣 the SRV-record approach for step-wise refinement toward finding authoritative servers, and a lot of the result object details, started out with Eric A. Hall and his memos about using LDAP to meet the CRISP requirements 🙌 those ideas really shaped this protocol.
David Blacka also made tons of technical contributions based on his work on the IRIS implementation and his experienced judgment 🧠 he also helped out with a ton of editorial clarifications ✍️
Authors' Addresses 🏡
Andrew L. Newton VeriSign, Inc. 21345 Ridgetop Circle Sterling, VA 20166 USA
Phone: +1 703 948 3382 EMail: anewton@verisignlabs.com; andy@hxr.us URI: http://www.verisignlabs.com/
Marcos Sanz DENIC eG Wiesenhuettenplatz 26 D-60329 Frankfurt Germany
EMail: sanz@denic.de URI: http://www.denic.de/
Full Copyright Statement ⚖️
Copyright (C) The Internet Society (2005).
This document is subject to the rights, licenses and restrictions contained in BCP 78, and except as set forth therein, the authors retain all their rights.
This document and the information contained herein are provided on an "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Intellectual Property 🔐
The IETF takes no position regarding the validity or scope of any Intellectual Property Rights or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; nor does it represent that it has made any independent effort to identify any such rights. Information on the IETF's procedures with respect to rights in IETF Documents can be found in BCP 78 and BCP 79.
Copies of IPR disclosures made to the IETF Secretariat and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this specification can be obtained from the IETF on-line IPR repository at http://www.ietf.org/ipr.
The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights that may cover technology that may be required to implement this standard. Please address the information to the IETF at ietf-ipr@ietf.org.
Acknowledgement 💜
Funding for the RFC Editor function is currently provided by the Internet Society. 🌈
📦 where this page comes from
- ietf: rfc3982 2005-01
- 💖 girlified by claude-haiku-5-5 on : a language model's rewrite of the original, under its terms