Internet DRAFT - draft-ietf-regext-simple-registration-reporting
draft-ietf-regext-simple-registration-reporting
Internet Engineering Task Force J. Yee, Ed.
Internet-Draft J. Galvin
Intended status: Informational Donuts
Expires: 10 December 2022 8 June 2022
Simple Registration Reporting
draft-ietf-regext-simple-registration-reporting-07
Abstract
Domain name registries (the producer) and registrars (the consumer)
report to each other by sharing bulk information through files. This
document creates two IANA registries to establish a standard
reporting mechanism between domain name registries and registrars.
The first IANA registry lists standard data elements and their syntax
for inclusion in the files. The second IANA registry lists standard
reports based on the standard data elements. Each report is a file
formatted as a CSV file. The advantage of this reporting mechanism
is that a report, each file, can be imported by recipients without
any prior knowledge of their contents, although reporting is enhanced
with a minimum of knowledge about the files. The mechanism for the
distribution of and access of the files is a matter of local policy.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on 10 December 2022.
Copyright Notice
Copyright (c) 2022 IETF Trust and the persons identified as the
document authors. All rights reserved.
Yee & Galvin Expires 10 December 2022 [Page 1]
Internet-Draft Abbreviated Title June 2022
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents (https://trustee.ietf.org/
license-info) in effect on the date of publication of this document.
Please review these documents carefully, as they describe your rights
and restrictions with respect to this document. Code Components
extracted from this document must include Revised BSD License text as
described in Section 4.e of the Trust Legal Provisions and are
provided without warranty as described in the Revised BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Requirements Language . . . . . . . . . . . . . . . . . . 4
2. Data Element Specification . . . . . . . . . . . . . . . . . 4
2.1. General Information Data Elements . . . . . . . . . . . . 5
2.1.1. TLD . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.1.2. Server_TRID . . . . . . . . . . . . . . . . . . . . . 5
2.1.3. Domain . . . . . . . . . . . . . . . . . . . . . . . 5
2.1.4. Transaction_Type . . . . . . . . . . . . . . . . . . 5
2.1.5. Object_Type . . . . . . . . . . . . . . . . . . . . . 5
2.1.6. Date_Time . . . . . . . . . . . . . . . . . . . . . . 5
2.1.7. Period . . . . . . . . . . . . . . . . . . . . . . . 5
2.1.8. Fee . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.1.9. Currency . . . . . . . . . . . . . . . . . . . . . . 6
2.1.10. Status . . . . . . . . . . . . . . . . . . . . . . . 6
2.1.11. Registrar . . . . . . . . . . . . . . . . . . . . . . 6
2.1.12. Period_Unit . . . . . . . . . . . . . . . . . . . . . 6
2.1.13. Description . . . . . . . . . . . . . . . . . . . . . 6
2.2. Domain Price Data Elements . . . . . . . . . . . . . . . 6
2.2.1. Price_Domain_Create . . . . . . . . . . . . . . . . . 6
2.2.2. Price_Domain_Renew . . . . . . . . . . . . . . . . . 7
2.2.3. Price_Domain_Transfer . . . . . . . . . . . . . . . . 7
2.2.4. Price_Domain_Restore . . . . . . . . . . . . . . . . 7
2.2.5. Price_Domain_Trade . . . . . . . . . . . . . . . . . 7
2.3. Timestamp Data Elements . . . . . . . . . . . . . . . . . 7
2.3.1. Available_Date . . . . . . . . . . . . . . . . . . . 7
2.3.2. Deleted_Date . . . . . . . . . . . . . . . . . . . . 7
2.3.3. Redemption_End_Date . . . . . . . . . . . . . . . . . 7
2.3.4. Pending_Delete_Date . . . . . . . . . . . . . . . . . 7
2.3.5. Updated_Date . . . . . . . . . . . . . . . . . . . . 8
2.3.6. Created_Date . . . . . . . . . . . . . . . . . . . . 8
2.3.7. Expiration_Date . . . . . . . . . . . . . . . . . . . 8
2.4. Registration Information Data Elements . . . . . . . . . 8
2.4.1. Registrar_ID . . . . . . . . . . . . . . . . . . . . 8
2.4.2. Registrant_ID . . . . . . . . . . . . . . . . . . . . 8
2.4.3. DNSSEC . . . . . . . . . . . . . . . . . . . . . . . 8
2.4.4. Server_Contact_ID . . . . . . . . . . . . . . . . . . 8
2.4.5. Contact_Type . . . . . . . . . . . . . . . . . . . . 8
Yee & Galvin Expires 10 December 2022 [Page 2]
Internet-Draft Abbreviated Title June 2022
2.4.6. Contact_Name . . . . . . . . . . . . . . . . . . . . 9
2.4.7. Linked . . . . . . . . . . . . . . . . . . . . . . . 9
2.4.8. Host_Name . . . . . . . . . . . . . . . . . . . . . . 9
2.4.9. Host_IP . . . . . . . . . . . . . . . . . . . . . . . 9
2.4.10. Client_Contact_ID . . . . . . . . . . . . . . . . . . 9
3. Report Definition Specification . . . . . . . . . . . . . . . 9
3.1. Domain Transaction . . . . . . . . . . . . . . . . . . . 10
3.2. Premium Name . . . . . . . . . . . . . . . . . . . . . . 11
3.3. Domain RGP . . . . . . . . . . . . . . . . . . . . . . . 12
3.4. Reserved Domain . . . . . . . . . . . . . . . . . . . . . 13
3.5. Domain Inventory . . . . . . . . . . . . . . . . . . . . 13
3.6. Contact Inventory . . . . . . . . . . . . . . . . . . . . 14
3.7. Host Inventory . . . . . . . . . . . . . . . . . . . . . 15
4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 15
4.1. Report Specification . . . . . . . . . . . . . . . . . . 16
4.1.1. Designated Expert Evaluation Criteria . . . . . . . . 16
4.1.2. Registration Procedure . . . . . . . . . . . . . . . 17
4.1.2.1. Required Information . . . . . . . . . . . . . . 17
4.1.2.2. Registration Processing . . . . . . . . . . . . . 18
4.1.2.3. Updating Report Definition Registry Entries . . . 18
4.2. Initial assignments . . . . . . . . . . . . . . . . . . . 19
4.2.1. Data Element Definition in IANA Registry . . . . . . 19
4.2.2. Report Definition in IANA Registry . . . . . . . . . 30
5. Security Considerations . . . . . . . . . . . . . . . . . . . 33
6. Privacy Considerations . . . . . . . . . . . . . . . . . . . 33
7. Internationalization Considerations . . . . . . . . . . . . . 33
8. References . . . . . . . . . . . . . . . . . . . . . . . . . 33
8.1. Normative References . . . . . . . . . . . . . . . . . . 33
8.2. Informative References . . . . . . . . . . . . . . . . . 34
Appendix A. Acknowledgements . . . . . . . . . . . . . . . . . . 35
Appendix B. File Naming Convention . . . . . . . . . . . . . . . 35
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 35
1. Introduction
Currently, domain name registry operators (the producer) create and
set their own domain name registration reports for use by their
registrars (the consumer). Among the distinctions that vary by
producer is the syntax of the data provided, e.g., date formats, and
the format of the collection of the data provided, e.g., the report
may be a CSV file that tends to allow for straightforward importation
or a PDF file that can be problematic to import. In addition,
although there are a number of best practices that have evolved,
these are not currently documented as such, which results in a fair
amount of customization on the part of the consumers to import data.
Yee & Galvin Expires 10 December 2022 [Page 3]
Internet-Draft Abbreviated Title June 2022
This document standardizes the name and syntax of the data elements
to be used across all existing domain name registration reports and
creates an IANA registry of them to facilitate their evolution,
including adding additional data elements as needed. In addition, a
known set of existing standard reports using the aforementioned data
elements is specified in another IANA registry to facilitate the
evolution of the reports and adding additional report definitions as
needed.
Each report definition MUST use only the data elements defined in the
data element aforementioned data element registry, including all
future reports. Note that a produced report MAY include data
elements that are not registered, as specified below. Future reports
and future data elements may be specified in their own individual
documents, updating the IANA registries as needed.
The mechanism for the distribution of and access to the files is a
matter of local policy.
1.1. Requirements Language
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 [RFC2119].
2. Data Element Specification
Data elements are grouped into categories for convenience. There is
no other significance to the groupings.
Each data element conceptually represents the column heading in a
printed report. It is a single unit of information that can be
passed from the producer to the consumer. The primary purposes of
the IANA registry of data elements are to ensure that each data
element is assigned a unique name and that the syntax of each data
element is specified.
The name of the data element MUST be unique and this characteristic
MUST be enforced by the registry. The name is used in the report
definition (in the next section) to alert the consumer as to what to
expect in the file and how to import the data element. Character
encoding recommendation for data elements is specified in Section 7.
The data elements adopt the same naming convention, where all the
leading character of each word use upper-case and the rest in lower-
case, and each word join with symobl underbars as a word separator.
Yee & Galvin Expires 10 December 2022 [Page 4]
Internet-Draft Abbreviated Title June 2022
The subsections below comprise an initial list of known data elements
commonly being used between producers and consumers as of the date of
publication of this document. The title of the subsection is the
data element name for the data element. Data element names in the
IANA registry MUST be unique and MUST be processed as case
insensitive.
2.1. General Information Data Elements
2.1.1. TLD
The string of the top level domain involved that MUST be in A-label
format as defined by RFC 5890 [RFC5890].
2.1.2. Server_TRID
The transaction identifier issued by an EPP Server. The format MUST
conform to "type:trIDStringType" as specified in RFC 5730 [RFC5730].
2.1.3. Domain
This is the domain name in an EPP RFC 5731 [RFC5731] domain object
and it MUST be in A-Label format.
2.1.4. Transaction_Type
The type of transform action made to the domain object (e.g., create,
delete, update, transfer, renew) as specified in RFC 5730 [RFC5730]
Section 2.9.3.
2.1.5. Object_Type
The object type involved in the report. In the EPP environment, an
object could be domain RFC 5731 [RFC5731], contact RFC 5733
[RFC5733], or host RFC 5732 [RFC5732].
2.1.6. Date_Time
The timestamp of the transaction recorded in the system. Dates and
Times MUST be expressed as defined in RFC 5731 [RFC5731] Section 2.4.
2.1.7. Period
The number of units added to the domain registration period in
<domain:period> RFC 5731 [RFC5731] in create, renew or transfer
transforms. If there is no <domain:period>, the default value set
out-of-band by the registry should be used.
Yee & Galvin Expires 10 December 2022 [Page 5]
Internet-Draft Abbreviated Title June 2022
2.1.8. Fee
The amount of money charged or returned (shown as a negative value)
to the registrar. The numeric format MUST conform to the currency
specified below in Section 2.1.9. The format must conform to
"balanceType" as defined in RFC 8748 [RFC8748].
2.1.9. Currency
The currency used in the money charged as documented above in
Section 2.1.8. The currency code should follow the ISO 4217
[ISO4217] standard.
2.1.10. Status
The status or statuses of the domain object. It MUST be one of the
values specified in RFC 5731 [RFC5731] Section 2.3. If there are
multiple statuses, each must be separated by symbol commma, with the
whole string under double quotes as specified in RFC 4180 [RFC4180]
2.1.11. Registrar
The name of the registrar. This data element is text/string with no
naming convention enforced. The string must be under double quotes
if it contains comma symbol as specified in RFC 4180 [RFC4180]
2.1.12. Period_Unit
The type of time (year, month) in 'Period' described above in
Section 2.1.7. The value of 'year' and 'month' are referenced to
pUnitType value 'y' and 'm' respectively. pUnitType is specified in
RFC 5731 [RFC5731].
2.1.13. Description
Additional information regarding the current entry in the report. It
is provided by the producer and its actual value is a matter of local
policy. This data element is text/string with no naming convention
enforced.
2.2. Domain Price Data Elements
2.2.1. Price_Domain_Create
The fee charged to create the domain. The format must conform to
"balanceType" as defined in RFC 8748 [RFC8748].
Yee & Galvin Expires 10 December 2022 [Page 6]
Internet-Draft Abbreviated Title June 2022
2.2.2. Price_Domain_Renew
The fee charged to renew the domain. The format must conform to
"balanceType" as defined in RFC 8748 [RFC8748].
2.2.3. Price_Domain_Transfer
The fee charged to transfer the domain. The format must conform to
"balanceType" as defined in RFC 8748 [RFC8748].
2.2.4. Price_Domain_Restore
The fee charged to restore the domain. The format must conform to
"balanceType" as defined in RFC 8748 [RFC8748].
2.2.5. Price_Domain_Trade
The fee charged to trade the domain. The format must conform to
"balanceType" as defined in RFC 8748 [RFC8748].
2.3. Timestamp Data Elements
2.3.1. Available_Date
The timestamp of when the domain object becomes available. The date
and time format follows the "type=dateTime" specification as defined
in RFC 5731 [RFC5731].
2.3.2. Deleted_Date
The timestamp of when the domain was deleted. The date and time
format follows the "type=dateTime" specification as defined in RFC
5731 [RFC5731].
2.3.3. Redemption_End_Date
The timestamp of when the domain will complete its redemption grace
period. The date and time format follows the "type=dateTime"
specification as defined in RFC 5731 [RFC5731].
2.3.4. Pending_Delete_Date
The timestamp of when the domain will be purged and become available
again. The date and time format follows the "type=dateTime"
specification as defined in RFC 5731 [RFC5731].
Yee & Galvin Expires 10 December 2022 [Page 7]
Internet-Draft Abbreviated Title June 2022
2.3.5. Updated_Date
The timestamp of the last time the domain object was updated. The
date and time format follows the "type=dateTime" specification as
defined in RFC 5731 [RFC5731].
2.3.6. Created_Date
The timestamp of when the domain object was allocated. The date and
time format follows the "type=dateTime" specification as defined in
RFC 5731 [RFC5731].
2.3.7. Expiration_Date
The timestamp of when the domain object will expire. The date and
time format follows the "type=dateTime" specification as defined in
RFC 5731 [RFC5731].
2.4. Registration Information Data Elements
2.4.1. Registrar_ID
The identifier assigned to the registrar. If the registrar is
accredited under ICANN, it MUST be the registrar's IANA ID
[IANA_Registrar_IDs]. Otherwise it is a value known between the
producer and the consumer, set via an out-of-band mechanism and
unique within all reports of the producer.
2.4.2. Registrant_ID
The identifier, issued by EPP server, assigned to the contact object
that is associated as registrant of the domain name that MUST conform
to "clIDType" specified in RFC 5730 [RFC5730].
2.4.3. DNSSEC
The value MUST be either 'YES' or 'NO' to indicate whether the domain
is DNSSEC signed.
2.4.4. Server_Contact_ID
The identifier of the contact object assigned by the registry system
and MUST conform to "clIDType" specified in RFC 5730 [RFC5730].
2.4.5. Contact_Type
The value MUST be one of value as defined by "contactAttrType" in RFC
5731 [RFC5731].
Yee & Galvin Expires 10 December 2022 [Page 8]
Internet-Draft Abbreviated Title June 2022
2.4.6. Contact_Name
The name of the contact object. Usually it is the name of an
individual or an organization as described in RFC 5733 [RFC5733]
Section 2.3.
2.4.7. Linked
The value MUST be either "YES" or "NO" to indicate whether the
contact object is associated with a domain object.
2.4.8. Host_Name
The full domain name of the host object as defined in RFC 5732
[RFC5732] Section 2.1. The name MUST be in A-label format as defined
by RFC5890 [RFC5890].
2.4.9. Host_IP
The IP address of the host object. The syntax of the IPv4 address
MUST conform to RFC 791 [RFC0791]. The syntax of the IPv6 address
MUST conform to RFC 4291 [RFC4291]. If it contains mutliple IP
addresses, each must be separated by symbol comma with the whole
string under double quotes as specified in RFC 4180 [RFC4180]
2.4.10. Client_Contact_ID
The identifier of the contact object assigned by the registrar and
MUST conform to "clIDType" specified in RFC 5730 [RFC5730].
3. Report Definition Specification
Each report specification conceptually represents a file of comma
separated values [RFC4180] (commonly called a CSV file) where the
values are selected from the data elements specified above. The
first row of the file is a comma separated list of data element names
as specified in the data element registry. The remaining rows of the
file are the unordered sets of data elements, one set per row, where
each row is one record in the report.
Each data element in a set conceptually represents the column heading
in a report.
A consumer MUST be able to receive data elements that are not
recognized and MAY skip them accordingly, both in the header row and
in the record rows.
Yee & Galvin Expires 10 December 2022 [Page 9]
Internet-Draft Abbreviated Title June 2022
A report is specified in the report registry with two pieces of
information. First is the name of the report. This can be whatever
is appropriate as defined by the producer of the report. The name of
the report MUST be unique and this characteristic MUST be enforced by
registry.
Second is the ordered list of data element names of what is included
in the report. The data element names MUST be listed in the data
element registry specified above. The data element names and the
data MUST appear in the report in the order listed in the report
registry.
The subsections below comprise an initial list of standard reports
commonly being used between producers and consumers as of the date of
publication of this document. The title of the subsection is the
report name. The report name in the IANA registry MUST be unique and
MUST be processed as case insensitive.
3.1. Domain Transaction
Name of report: domain_transaction
Description: This report keeps records of actions taken by registrar
or the registry system on the domain under registrar's management
that changed the domain's status, charge or refund fee to registrar.
Yee & Galvin Expires 10 December 2022 [Page 10]
Internet-Draft Abbreviated Title June 2022
+==================+========================+
| Data Element | Reference |
+==================+========================+
| TLD | RFC XXXX Section 2.1.1 |
+------------------+------------------------+
| Server_TRID | Section 2.1.2 |
+------------------+------------------------+
| Domain | Section 2.1.3 |
+------------------+------------------------+
| Date_Time | Section 2.1.6 |
+------------------+------------------------+
| Registrar_ID | Section 2.4.1 |
+------------------+------------------------+
| Registrar | Section 2.1.11 |
+------------------+------------------------+
| Transaction_Type | Section 2.1.4 |
+------------------+------------------------+
| Period_Unit | Section 2.1.12 |
+------------------+------------------------+
| Period | Section 2.1.7 |
+------------------+------------------------+
| Fee | Section 2.1.8 |
+------------------+------------------------+
| Currency | Section 2.1.9 |
+------------------+------------------------+
| Description | Section 2.1.13 |
+------------------+------------------------+
Table 1: Transaction Report Definition Table
3.2. Premium Name
Name of report: premium_name
Description: This report list the domain and its price that is
different, ususally higher, from the regular price
Yee & Galvin Expires 10 December 2022 [Page 11]
Internet-Draft Abbreviated Title June 2022
+=======================+========================+
| Data Element | Reference |
+=======================+========================+
| TLD | RFC XXXX Section 2.1.1 |
+-----------------------+------------------------+
| Domain | Section 2.1.3 |
+-----------------------+------------------------+
| Status | Section 2.1.10 |
+-----------------------+------------------------+
| Description | Section 2.1.13 |
+-----------------------+------------------------+
| Currency | Section 2.1.9 |
+-----------------------+------------------------+
| Price_Domain_Create | Section 2.2.1 |
+-----------------------+------------------------+
| Price_Domain_Renew | Section 2.2.2 |
+-----------------------+------------------------+
| Price_Domain_Transfer | Section 2.2.3 |
+-----------------------+------------------------+
| Price_Domain_Restore | Section 2.2.4 |
+-----------------------+------------------------+
| Available_Date | Section 2.3.1 |
+-----------------------+------------------------+
Table 2: Premium Name Report Definition Table
3.3. Domain RGP
Name of report: domain_rgp
Description: This report tracks the domains under registrar's
management that are deleted and in the Redemption Grace Period (RGP).
+=====================+========================+
| Data Element | Reference |
+=====================+========================+
| TLD | RFC XXXX Section 2.1.1 |
+---------------------+------------------------+
| Domain | Section 2.1.3 |
+---------------------+------------------------+
| Deleted_Date | Section 2.3.2 |
+---------------------+------------------------+
| Redemption_End_Date | Section 2.3.3 |
+---------------------+------------------------+
| Pending_Delete_Date | Section 2.3.4 |
+---------------------+------------------------+
Table 3: Domain RGP Report Definition Table
Yee & Galvin Expires 10 December 2022 [Page 12]
Internet-Draft Abbreviated Title June 2022
3.4. Reserved Domain
Name of report: reserved_domain
Description: This report lists name that are reserved by the registry
system and the domain's current status.
+==============+========================+
| Data Element | Reference |
+==============+========================+
| TLD | RFC XXXX Section 2.1.1 |
+--------------+------------------------+
| Domain | Section 2.1.3 |
+--------------+------------------------+
| Status | Section 2.1.10 |
+--------------+------------------------+
Table 4: Reserved Domain Report
Definition Table
3.5. Domain Inventory
Name of report: domain_inventory
Description: This report lists all domain currently under the
registrar's management and its related attributes.
Yee & Galvin Expires 10 December 2022 [Page 13]
Internet-Draft Abbreviated Title June 2022
+=================+========================+
| Data Element | Reference |
+=================+========================+
| TLD | RFC XXXX Section 2.1.1 |
+-----------------+------------------------+
| Domain | Section 2.1.3 |
+-----------------+------------------------+
| Updated_Date | Section 2.3.5 |
+-----------------+------------------------+
| Registrar_ID | Section 2.4.1 |
+-----------------+------------------------+
| Created_Date | Section 2.3.6 |
+-----------------+------------------------+
| Expiration_Date | Section 2.3.7 |
+-----------------+------------------------+
| Registrant_ID | Section 2.4.2 |
+-----------------+------------------------+
| DNSSEC | Section 2.4.3 |
+-----------------+------------------------+
| Status | Section 2.1.10 |
+-----------------+------------------------+
Table 5: Domain Inventory Report
Definition Table
3.6. Contact Inventory
Name of report: contact_inventory
Description: This report lists all contact created by the registrar
and any assocations it has to any domains.
Yee & Galvin Expires 10 December 2022 [Page 14]
Internet-Draft Abbreviated Title June 2022
+===================+================+
| Data Element | Reference |
+===================+================+
| Server_Contact_ID | Section 2.4.4 |
+-------------------+----------------+
| Client_Contact_ID | Section 2.4.10 |
+-------------------+----------------+
| TLD | Section 2.1.1 |
+-------------------+----------------+
| Domain | Section 2.1.3 |
+-------------------+----------------+
| Contact_Type | Section 2.4.5 |
+-------------------+----------------+
| Contact_Name | Section 2.4.6 |
+-------------------+----------------+
| Updated_Date | Section 2.3.5 |
+-------------------+----------------+
| Linked | Section 2.4.7 |
+-------------------+----------------+
Table 6: Contact Inventory Report
Definition Table
3.7. Host Inventory
Name of report: host_inventory
Description: This reports list all the host objects and its
attributes under registrar's management.
+==============+=======================+
| Data Element | Reference |
+==============+=======================+
| TLD | RFCXXXX Section 2.1.1 |
+--------------+-----------------------+
| Host_Name | Section 2.4.8 |
+--------------+-----------------------+
| Host_IP | Section 2.4.9 |
+--------------+-----------------------+
Table 7: Host Inventory Report
Definition Table
4. IANA Considerations
This section describes the format of the IANA Registration Report
Registry, which has two tables described below, and the procedures
used to populate and manage the registry entries.
Yee & Galvin Expires 10 December 2022 [Page 15]
Internet-Draft Abbreviated Title June 2022
4.1. Report Specification
This registry uses the "Specification Required" policy described in
RFC 8126 [RFC8126]. An English language version of the extension
specification is required in the registry, though non-English
versions of the specification may also be provided.
The "Specification Required" policy implies review by a "designated
expert". Section 5.2 of RFC 8126 [RFC8126] describes the role of
designated experts and the function they perform.
4.1.1. Designated Expert Evaluation Criteria
A high-level description of the role of the designated expert is
described in Section 5.2 of RFC 8126 [RFC8126]. Specific guidelines
for the appointment of designated experts and the evaluation of a
Registration Report is provided here.
The IESG SHOULD appoint a small pool of individuals (perhaps 3 - 5)
to serve as designated experts, as described in Section 5.2 of RFC
8126 [RFC8126]. The pool should have a single administrative chair
who is appointed by the IESG. The designated experts should use the
existing regext mailing list (regext@ietf.org) for public discussion
of registration requests. This implies that the mailing list should
remain open after the work of the REGEXT working group has concluded.
The results of the evaluation should be shared via email with the
registrant and the regext mailing list. Issues discovered during the
evaluation can be corrected by the registrant, and those corrections
can be submitted to the designated experts until the designated
experts explicitly decide to accept or reject the registration
request. The designated experts must make an explicit decision and
that decision must be shared via email with the registrant and the
regext mailing list. If the specification for a data element or
report is an IETF Standards Track document, no review is required by
the designated expert.
Designated experts should be permissive in their evaluation of
requests for data elements and reports that have been implemented and
deployed by at least one registry. This implies that it may indeed
be possible to register multiple data elements or reports that
provide the same functionality. Requests to register data elements
or reports that have not been deployed should be evaluated with a
goal of reducing duplication. A potential registrant who submits a
request to register a new data element or report that includes
similar functionality to existing data elements or reports should be
made aware of the existing data elements and reports. The registrant
should be asked to reconsider their request given the existence of
Yee & Galvin Expires 10 December 2022 [Page 16]
Internet-Draft Abbreviated Title June 2022
similar data elements or reports. Should they decline to do so,
perceived similarity should not be a sufficient reason for rejection
as long as all other requirements are met.
4.1.2. Registration Procedure
The registry contains information describing each registered data
element or report. Registry entries are created and managed by
sending forms to IANA that describe the data element or report for
the registry entry.
4.1.2.1. Required Information
The required information must be formatted consistently using the
following registration form. Form field names and values may appear
on the same line.
4.1.2.1.1. Data Element Definition
Name of data element
MUST be unique within the registry, enforced to be unique,
and MUST be processed as case insensitive
Reference document
MUST define the data element, SHOULD be a URL to a RFC, and
SHOULD include the section number (or other detailed internal
document reference), MAY be a URL to any document available
under equivalent terms
Registrant
Will be IESG for initial entries and all Standards Track
specifications; otherwise as specified by the registran
Status
MUST be one of active, inactive, or unknown
4.1.2.1.2. Report Definition
Name of Report
MUST be unique within the registry, enforced to be unique,
and MUST be processed as case insensitive
Document Status
MUST be one of active, inactive, or unknown
Yee & Galvin Expires 10 December 2022 [Page 17]
Internet-Draft Abbreviated Title June 2022
Reference document
MUST define the report, SHOULD be a URL to a RFC and SHOULD
include the section number (or other detailed internal
document reference), MAY be a URL to any document available
under equivalent terms
Registrant
Will be IESG for initial entries and all Standards Track
specifications; otherwise as specified by the registrant
TLD
MUST be "ANY" if the report is intended to be generally
applicable or MAY be any top level domain formatted as
defined by RFC 5890 [RFC5890] (or comma separated list of
domains) and each MUST be an A-LABEL if the report is
intended to have that scope
Status:active
4.1.2.2. Registration Processing
Registrants should send each registration form to IANA with a single
record for incorporation into the registry. Send the form via email
to iana@iana.org or complete the online form found on the IANA web
site. The subject line should indicate whether the enclosed form
represents an insertion of a new record (indicated by the word
"INSERT" in the subject line) or a replacement of an existing record
(indicated by the word "MODIFY" in the subject line). At no time can
a record be deleted from the registry. On receipt of the
registration request, IANA will initiate review by the designated
expert(s) if appropriate, who will evaluate the request using the
criteria in Section 4.1.1 in consultation with the regext mailing
list.
4.1.2.3. Updating Report Definition Registry Entries
When submitting changes to existing registry entries, include text in
the "Notes" field of the registration form describing the change.
Under normal circumstances, registry entries are only to be updated
by the registrant. If the registrant becomes unavailable or
otherwise unresponsive, the designated expert can submit a
registration form to IANA to update the registrant information.
Entries can change state from "Active" to "Inactive" and back again
as long as state-change requests conform to the processing
requirements identified in this document. In addition to entries
that become "Inactive" due to a lack of implementation, entries for
which a specification becomes consistently unavailable over time
should be marked "Inactive" by the designated expert until the
Yee & Galvin Expires 10 December 2022 [Page 18]
Internet-Draft Abbreviated Title June 2022
specification again becomes reliably available.
4.2. Initial assignments
4.2.1. Data Element Definition in IANA Registry
---- BEGIN FORM ----
Name of data element:
TLD
Reference:
This RFC Section 2.1.1
Registrant:
IESG, iesg@ietf.org
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Server_TRID
Reference:
This RFC Section 2.1.2
Registrant:
IESG, iesg@ietf.org
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Domain
Reference:
This RFC Section 2.1.3
Registrant:
IESG, iesg@ietf.org
Yee & Galvin Expires 10 December 2022 [Page 19]
Internet-Draft Abbreviated Title June 2022
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Transaction_Type
Reference:
This RFC Section 2.1.4
Registrant:
IESG, iesg@ietf.org
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Ojbect_Type
Reference:
This RFC Section 2.1.5
Registrant:
IESG, iesg@ietf.org
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Date_Time
Reference:
This RFC Section 2.1.6
Registrant:
IESG, iesg@ietf.org
Yee & Galvin Expires 10 December 2022 [Page 20]
Internet-Draft Abbreviated Title June 2022
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Period
Reference:
This RFC Section 2.1.7
Registrant:
IESG, iesg@ietf.org
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Currency
Reference:
This RFC Section 2.1.9
Registrant:
IESG, iesg@ietf.org
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Status
Reference:
This RFC Section 2.1.10
Registrant:
IESG, iesg@ietf.org
Yee & Galvin Expires 10 December 2022 [Page 21]
Internet-Draft Abbreviated Title June 2022
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Registrar
Reference:
This RFC Section 2.1.11
Registrant:
IESG, iesg@ietf.org
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Period_Unit
Reference:
This RFC Section 2.1.12
Registrant:
IESG, iesg@ietf.org
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Description
Reference:
This RFC Section 2.1.13
Registrant:
IESG, iesg@ietf.org
Yee & Galvin Expires 10 December 2022 [Page 22]
Internet-Draft Abbreviated Title June 2022
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Price_Domain_Create
Reference:
This RFC Section 2.2.1
Registrant:
IESG, iesg@ietf.org
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Price_Domain_Renew
Reference:
This RFC Section 2.2.2
Registrant:
IESG, iesg@ietf.org
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Price_Domain_Transfer
Reference:
This RFC Section 2.2.3
Registrant:
IESG, iesg@ietf.org
Yee & Galvin Expires 10 December 2022 [Page 23]
Internet-Draft Abbreviated Title June 2022
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Price_Domain_Restore
Reference:
This RFC Section 2.2.4
Registrant:
IESG, iesg@ietf.org
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Available_Date
Reference:
This RFC Section 2.3.1
Registrant:
IESG, iesg@ietf.org
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Deleted_Date
Reference:
This RFC Section 2.3.2
Registrant:
IESG, iesg@ietf.org
Yee & Galvin Expires 10 December 2022 [Page 24]
Internet-Draft Abbreviated Title June 2022
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Redemption_End_Date
Reference:
This RFC Section 2.3.3
Registrant:
IESG, iesg@ietf.org
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Pending_Delete_Date
Reference:
This RFC Section 2.3.4
Registrant:
IESG, iesg@ietf.org
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Updated_Date
Reference:
This RFC Section 2.3.5
Registrant:
IESG, iesg@ietf.org
Yee & Galvin Expires 10 December 2022 [Page 25]
Internet-Draft Abbreviated Title June 2022
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Created_Date
Reference:
This RFC Section 2.3.6
Registrant:
IESG, iesg@ietf.org
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Expiration_Date
Reference:
This RFC Section 2.3.7
Registrant:
IESG, iesg@ietf.org
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Registrar_ID
Reference:
This RFC Section 2.4.1
Registrant:
IESG, iesg@ietf.org
Yee & Galvin Expires 10 December 2022 [Page 26]
Internet-Draft Abbreviated Title June 2022
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Registrant_ID
Reference:
This RFC Section 2.4.2
Registrant:
IESG, iesg@ietf.org
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
DNSSEC
Reference:
This RFC Section 2.4.3
Registrant:
IESG, iesg@ietf.org
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Server_Contact_ID
Reference:
This RFC Section 2.4.4
Registrant:
IESG, iesg@ietf.org
Yee & Galvin Expires 10 December 2022 [Page 27]
Internet-Draft Abbreviated Title June 2022
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Contact_Type
Reference:
This RFC Section 2.4.5
Registrant:
IESG, iesg@ietf.org
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Contact_Name
Reference:
This RFC Section 2.4.6
Registrant:
IESG, iesg@ietf.org
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Linked
Reference:
This RFC Section 2.4.7
Registrant:
IESG, iesg@ietf.org
Yee & Galvin Expires 10 December 2022 [Page 28]
Internet-Draft Abbreviated Title June 2022
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Host_Name
Reference:
This RFC Section 2.4.8
Registrant:
IESG, iesg@ietf.org
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Host_IP
Reference:
This RFC Section 2.4.9
Registrant:
IESG, iesg@ietf.org
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of data element:
Client_Contact_ID
Reference:
This RFC Section 2.4.10
Registrant:
IESG, iesg@ietf.org
Yee & Galvin Expires 10 December 2022 [Page 29]
Internet-Draft Abbreviated Title June 2022
Status:
Active
---- END FORM ----
4.2.2. Report Definition in IANA Registry
---- BEGIN FORM ----
Name of report:
domain_transaction
Reference:
This RFC Table 1
Registrant:
IESG, iesg@ietf.org
TLD:
any
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of report:
premium_name
Reference:
This RFC Section 3.2
Registrant:
IESG, iesg@ietf.org
TLD:
any
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Yee & Galvin Expires 10 December 2022 [Page 30]
Internet-Draft Abbreviated Title June 2022
Name of report:
domain_rgp
Reference:
This RFC Section 3.3
Registrant:
IESG, iesg@ietf.org
TLD:
any
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of report:
reserved_domain
Reference:
This RFC Section 3.4
Registrant:
IESG, iesg@ietf.org
TLD:
any
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of report:
domain_inventory
Reference:
This RFC Section 3.5
Registrant:
IESG, iesg@ietf.org
Yee & Galvin Expires 10 December 2022 [Page 31]
Internet-Draft Abbreviated Title June 2022
TLD:
any
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of report:
contact_inventory
Reference:
This RFC Section 3.6
Registrant:
IESG, iesg@ietf.org
TLD:
any
Status:
Active
---- END FORM ----
---- BEGIN FORM ----
Name of report:
host_inventory
Reference:
This RFC Section 3.7
Registrant:
IESG, iesg@ietf.org
TLD:
any
Status:
Active
---- END FORM ----
Yee & Galvin Expires 10 December 2022 [Page 32]
Internet-Draft Abbreviated Title June 2022
5. Security Considerations
This specification does not consider the issues of distribution or
access to the reports that are created and thus does not introduce
any new security security concerns that are not already present in
the local environment in which the report is created.
A security principle to keep in mind as new reports are developed is
that it is considered a bad practice to report or disclose security
information. In the case of the registration system upon which this
reporting mechanism is based, the authInfo code is a specific example
of a data element that SHOULD NOT be included in a report.
6. Privacy Considerations
This specification defines a mechanism for creating reports based on
data in a registration system. Some of that data is likely to be
considered personally identifiable information (PII) and thus would
be subject to privacy protection according to an applicable privacy
regulation. It is outside the scope of this specification to address
those specific concerns. Implementors are urged to consider these
issues with their local legal authority and develop appropriate
requirements for their work.
As expressly noted in the Introduction, distribution of and access to
the reports created by this specification is expressly outside the
scope of this specification. However, to the extent a report
contains PII, implementors are urged to consider these issues with
their local legal authority and develop appropriate requirements for
their work.
7. Internationalization Considerations
The character encoding for the file contents MUST use UTF-8.
Throughout this document A-LABEL is indicated as a SHOULD and that
MUST be interpreted as follows. All domain name labels MUST be in
A-LABEL format if it is possible to represent it as an A-LABEL,
otherwise U-LABEL MAY be used.
8. References
8.1. Normative References
[ISO4217] International Organization for Standardization, "ISO 4217
Currency Codes", 2018, <https://www.currency-
iso.org/dam/downloads/lists/list_one.xml>.
Yee & Galvin Expires 10 December 2022 [Page 33]
Internet-Draft Abbreviated Title June 2022
[RFC0791] Postel, J., "Internet Protocol", September 1981,
<https://www.rfc-editor.org/info/rfc791>.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[RFC4180] Shafranovich, Y., "IP Version 6 Addressing Architecture",
February 2006, <https://www.rfc-editor.org/info/rfc4180>.
[RFC4291] Hinden, R. and S. Deering, "IP Version 6 Addressing
Architecture", February 2006,
<https://www.rfc-editor.org/info/rfc4291>.
[RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)",
August 2009, <https://www.rfc-editor.org/info/rfc5730>.
[RFC5731] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)
Domain Name Mapping", August 2009,
<https://www.rfc-editor.org/info/rfc5731>.
[RFC5732] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)
Host Mapping", August 2009,
<https://www.rfc-editor.org/info/rfc5732>.
[RFC5733] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)
Contact Mapping", August 2009,
<https://www.rfc-editor.org/info/rfc5733>.
[RFC5890] Klensin, J., "Extensible Provisioning Protocol (EPP)
Contact Mapping", August 2009,
<https://www.rfc-editor.org/info/rfc5890>.
[RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for
Writing an IANA Considerations Section in RFCs", June
2017, <https://www.rfc-editor.org/info/rfc8126>.
[RFC8748] Carney, R. and J. Frakes, "Registry Fee Extension for the
Extensible Provisioning Protocol", March 2021,
<https://www.rfc-editor.org/info/rfc8748>.
8.2. Informative References
[IANA_Registrar_IDs]
Internet Assigned Numbers Authority, "IANA Assignments -
Registrar IDs", 2020, <https://www.iana.org/assignments/
registrar-ids/registrar-ids.xhtml>.
Yee & Galvin Expires 10 December 2022 [Page 34]
Internet-Draft Abbreviated Title June 2022
Appendix A. Acknowledgements
The authors would like to thank Roger Carney, Jody Kolker, Tobias
Sattler, and bestpractice.domains for their reviews and suggestions.
Appendix B. File Naming Convention
TBD on file naming convention suggestion
Authors' Addresses
Joseph Yee (editor)
Donuts
Toronto
Canada
Email: jyee@afilias.info
James Galvin
Donuts
Horsham, PA
United States
Email: jgalvin@donuts.email
Yee & Galvin Expires 10 December 2022 [Page 35]