[Docs] [txt|pdf] [Tracker] [Email] [Diff1] [Diff2] [Nits]

Versions: 00 01 02 03 04

Internet Engineering Task Force                             N. McPherson
Internet-Draft                                              1&1 IONOS SE
Intended status: Best Current Practice                        T. Sattler
Expires: May 9, 2019                                   November 10, 2018

                       Registry Report Structure
          draft-mcpherson-sattler-registry-report-structure-03

Abstract

   This document describes the structure for reports that a domain name
   registry can provide via the standardized registry reporting
   repository.

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 May 9, 2019.

Copyright Notice

   Copyright (c) 2018 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

   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 Simplified BSD License text as described in Section 4.e of
   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

McPherson & Sattler         Expires May 9, 2019                 [Page 1]


Internet-Draft            Registry Report Structure        November 2018

Table of Contents
   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   3
   2.  Terminology and Definitions . . . . . . . . . . . . . . . . .   3
     2.1.  Internationalized Domain Names  . . . . . . . . . . . . .   3
     2.2.  Dates and Times . . . . . . . . . . . . . . . . . . . . .   3
     2.3.  Character Encoding  . . . . . . . . . . . . . . . . . . .   3
     2.4.  Currency  . . . . . . . . . . . . . . . . . . . . . . . .   3
   3.  File Names  . . . . . . . . . . . . . . . . . . . . . . . . .   4
   4.  File Types  . . . . . . . . . . . . . . . . . . . . . . . . .   4
   5.  Delimiter . . . . . . . . . . . . . . . . . . . . . . . . . .   4
   6.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   4
   7.  Security Considerations . . . . . . . . . . . . . . . . . . .   5
   8.  Implementation Status . . . . . . . . . . . . . . . . . . . .   5
   9.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   5
     9.1.  Normative References  . . . . . . . . . . . . . . . . . .   5
     9.2.  Informative References  . . . . . . . . . . . . . . . . .   6
   Appendix A.  Change History . . . . . . . . . . . . . . . . . . .   6
     A.1.  Change from 00 to 01  . . . . . . . . . . . . . . . . . .   6
     A.2.  Change from 01 to 02  . . . . . . . . . . . . . . . . . .   6
     A.3.  Change from 02 to 03  . . . . . . . . . . . . . . . . . .   6
   Appendix B.  Acknowledgements . . . . . . . . . . . . . . . . . .   7
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .   7

McPherson & Sattler         Expires May 9, 2019                 [Page 2]


Internet-Draft            Registry Report Structure        November 2018

1.  Introduction

   Modern top-level domain registries provide a number of detailed
   reports and documents that their registrars require on a daily,
   weekly and monthly basis. These most commonly include transaction
   reports, as well as lists containing currently unavailable domains
   and current premium domains. These reports are critical for
   registrars' businesses and play an important role in accounting and
   operations processes as well as in sales and marketing activities.
   In the current set-up registrars must download these reports from
   each registry's intranet in a different manner according to each
   registry's own document management set up.

   This document describes the format for reports that a domain name
   registry can provide via the standardized
   [I-D.mcpherson-sattler-registry-reporting-repo].

2.  Terminology and Definitions

   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 [RFC2119] when
   specified in their uppercase forms.

2.1.  Internationalized Domain Names

   Top-Level Domains and Domain names contained in a file name or file
   MUST be written as A-LABEL according to [RFC5890].

2.2.  Dates and Times

   All dates and times attribute values MUST be expressed in Universal
   Coordinated Time (UTC) using the Gregorian calendar. The extended
   date-time form using upper case "T" and "Z" characters defined in ISO
   8601 [RFC3339] MUST be used to represent date-time values.

   One day is defined as one day in UTC+0. Therefore, months and years
   will also be calculated on this basis.

2.3.  Character Encoding

   Files and their content MUST be encoded in UTF-8 according to
   [RFC3629].

2.4.  Currency

   Currencies MUST be listed with the relevant 3 letter Currency
   Alphabetic Code according to ISO 4217 (https://www.iso.org/iso-4217-
   currency-codes.html).

McPherson & Sattler         Expires May 9, 2019                 [Page 3]


Internet-Draft            Registry Report Structure        November 2018

3.  File Names

   Files MUST be lowercase and follow this grammar:

   PREFIX "_" TYPE "_" DATE "." FILESUFFIX

   PREFIX      indicates if the file is either a report specific for
               a TLD or a registry. A report of a registry MAY include
               more than one TLD.

   TYPE        indicates the type of the file, value MUST be either
               'premium-domains', 'unavailable-domains' or
               'transactions'.

   DATE        indicates the date of the file and MUST be
               YYYY-MM-DD or YYYY-MM according to ISO 8601 [RFC3339]

   FILESUFFIX  identifier specified as a suffix to the name of the file
               and indicates a characteristic of the file contents or
               its intended use. The file suffix MUST be csv.

   Example based on the above grammar:

   Daily report of premium domain names for the TLD .example effective
   on 2018-08-01: example_premium-domains_2018-08-01.csv

   Monthly report of transactions for the TLD .example effective on
   2018-08: example_transactions_2018-08.csv

   Monthly report of premium domain names for the .example registry
   effective on 2018-08: example-registry_premium-domains_2018-08.csv

4.  File Types

   Files MUST be CSV files.

5.  Delimiter

   The delimiter MUST be semicolon.

6.  IANA Considerations

   This document has no IANA actions.

McPherson & Sattler         Expires May 9, 2019                 [Page 4]


Internet-Draft            Registry Report Structure        November 2018

7.  Security Considerations

   The registry reporting reports described in this document do not
   provide any security services.

8.  Implementation Status

   Note to RFC Editor: Please remove this section and the reference to
   [RFC7942] before publication.

   This section records the status of known implementations of the
   protocol defined by this specification at the time of posting of this
   Internet-Draft, and is based on a proposal described in [RFC7942].
   The description of implementations in this section is intended to
   assist the IETF in its decision processes in progressing drafts to
   RFCs.  Please note that the listing of any individual implementation
   here does not imply endorsement by the IETF.  Furthermore, no effort
   has been spent to verify the information presented here that was
   supplied by IETF contributors.  This is not intended as, and must not
   be construed to be, a catalog of available implementations or their
   features.  Readers are advised to note that other implementations may
   exist.

   According to [RFC7942], "this will allow reviewers and working groups
   to assign due consideration to documents that have the benefit of
   running code, which may serve as evidence of valuable experimentation
   and feedback that have made the implemented protocols more mature. It
   is up to the individual working groups to use this information as
   they see fit".

   Add implementation details once available.

9.  References

9.1.  Normative References

   [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
              Requirement Levels", BCP 14, RFC 2119, March 1997,
              <https://www.rfc-editor.org/info/rfc2119>.

   [RFC5890]  Klensin, J., "Internationalized Domain Names for
              Applications (IDNA): Definitions and Document Framework",
              RFC 5890, August 2010,
              <https://www.rfc-editor.org/info/rfc5890>.

McPherson & Sattler         Expires May 9, 2019                 [Page 5]


Internet-Draft            Registry Report Structure        November 2018

9.2.  Informative References

   [I-D.mcpherson-sattler-registry-reporting-repo]
              McPherson, N. and Sattler, T., "Registry Reporting
              Repository", <https://datatracker.ietf.org/doc/draft-
              mcpherson-sattler-registry-reporting-repo/> (work in
              progress), July 2018

   [RFC3339]  Klyne, G., Ed. and C. Newman, "Date and Time on the
              Internet: Timestamps", RFC 3339, July 2002,
              <https://www.rfc-editor.org/info/rfc3339>.

   [RFC3629]  Yergeau, F., "UTF-8, a transformation format of ISO
              10646", RFC 3629, November 2003,
              <https://www.rfc-editor.org/info/rfc3629>.

   [RFC7942]  Sheffer, Y. and Farrel, A., "Improving Awareness of
              Running Code: The Implementation Status Section", RFC
              7942, July 2016,
              <https://www.rfc-editor.org/info/rfc7942>.

Appendix A.  Change History

A.1.  Change from 00 to 01

   Fixed minor typos in section 3. Clarified usage of csv files suffix.

A.2.  Change from 01 to 02

   Updated Neal's author details.

A.3.  Change from 02 to 03

   Added definition of currency. Added monthly reports and changed
   examples.

McPherson & Sattler         Expires May 9, 2019                 [Page 6]


Internet-Draft            Registry Report Structure        November 2018

Appendix B.  Acknowledgements

   The authors wish to thank the following persons for their feedback
   and suggestions (sorted alphabetically by company):

   * Thomas Keller, 1&1 IONOS
   * James Galvin, Afilias
   * Andreas Huber, united-domains

Authors' Addresses

   Neal McPherson
   1&1 IONOS SE
   Ernst-Frey-Str. 5
   76135 Karlsruhe
   DE

   Email: neal.mcpherson@ionos.com
   URI:   https://www.ionos.com

   Tobias Sattler

   Email: tobias.sattler@me.com
   URI:   https://tobiassattler.com

McPherson & Sattler         Expires May 9, 2019                 [Page 7]

Html markup produced by rfcmarkup 1.128b, available from https://tools.ietf.org/tools/rfcmarkup/