idnits 2.17.1 draft-mcpherson-sattler-registry-report-structure-01.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (September 10, 2018) is 2027 days in the past. Is this intentional? Checking references for intended status: Best Current Practice ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) No issues found here. Summary: 0 errors (**), 0 flaws (~~), 1 warning (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 1 Internet Engineering Task Force N. McPherson 2 Internet-Draft 1&1 Internet SE 3 Intended status: Best Current Practice T. Sattler 4 Expires: March 9, 2019 September 10, 2018 6 Registry Report Structure 7 draft-mcpherson-sattler-registry-report-structure-01 9 Abstract 11 This document describes the structure for reports that a domain name 12 registry can provide via the standardized registry reporting 13 repository. 15 Status of This Memo 17 This Internet-Draft is submitted in full conformance with the 18 provisions of BCP 78 and BCP 79. 20 Internet-Drafts are working documents of the Internet Engineering 21 Task Force (IETF). Note that other groups may also distribute 22 working documents as Internet-Drafts. The list of current Internet- 23 Drafts is at https://datatracker.ietf.org/drafts/current/. 25 Internet-Drafts are draft documents valid for a maximum of six months 26 and may be updated, replaced, or obsoleted by other documents at any 27 time. It is inappropriate to use Internet-Drafts as reference 28 material or to cite them other than as "work in progress". 30 This Internet-Draft will expire on March 9, 2019. 32 Copyright Notice 34 Copyright (c) 2018 IETF Trust and the persons identified as the 35 document authors. All rights reserved. 37 This document is subject to BCP 78 and the IETF Trust's Legal 38 Provisions Relating to IETF Documents 39 (https://trustee.ietf.org/license-info) in effect on the date of 40 publication of this document. Please review these documents 41 carefully, as they describe your rights and restrictions with respect 42 to this document. Code Components extracted from this document must 43 include Simplified BSD License text as described in Section 4.e of 44 the Trust Legal Provisions and are provided without warranty as 45 described in the Simplified BSD License. 47 Table of Contents 48 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 49 2. Terminology and Definitions . . . . . . . . . . . . . . . . . 3 50 2.1. Internationalized Domain Names . . . . . . . . . . . . . 3 51 2.2. Dates and Times . . . . . . . . . . . . . . . . . . . . . 3 52 2.3. Character Encoding . . . . . . . . . . . . . . . . . . . 3 53 3. File Names . . . . . . . . . . . . . . . . . . . . . . . . . 4 54 4. File Types . . . . . . . . . . . . . . . . . . . . . . . . . 4 55 5. Delimiter . . . . . . . . . . . . . . . . . . . . . . . . . . 4 56 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 4 57 7. Security Considerations . . . . . . . . . . . . . . . . . . . 5 58 8. Implementation Status . . . . . . . . . . . . . . . . . . . . 5 59 9. References . . . . . . . . . . . . . . . . . . . . . . . . . 5 60 9.1. Normative References . . . . . . . . . . . . . . . . . . 5 61 9.2. Informative References . . . . . . . . . . . . . . . . . 6 62 Appendix A. Change History . . . . . . . . . . . . . . . . . . . 6 63 A.1. Change from 00 to 01 . . . . . . . . . . . . . . . . . . 6 64 Appendix B. Acknowledgements . . . . . . . . . . . . . . . . . . 6 65 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 6 67 1. Introduction 69 Modern top-level domain registries provide a number of detailed 70 reports and documents that their registrars require on a daily, 71 weekly and monthly basis. These most commonly include transaction 72 reports, as well as lists containing currently unavailable domains 73 and current premium domains. These reports are critical for 74 registrars' businesses and play an important role in accounting and 75 operations processes as well as in sales and marketing activities. 76 In the current set-up registrars must download these reports from 77 each registry's intranet in a different manner according to each 78 registry's own document management set up. 80 This document describes the format for reports that a domain name 81 registry can provide via the standardized 82 [I-D.mcpherson-sattler-registry-reporting-repo]. 84 2. Terminology and Definitions 86 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 87 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 88 document are to be interpreted as described in [RFC2119] when 89 specified in their uppercase forms. 91 2.1. Internationalized Domain Names 93 Top-Level Domains and Domain names contained in a file name or file 94 MUST be written as A-LABEL according to [RFC5890]. 96 2.2. Dates and Times 98 All dates and times attribute values MUST be expressed in Universal 99 Coordinated Time (UTC) using the Gregorian calendar. The extended 100 date-time form using upper case "T" and "Z" characters defined in ISO 101 8601 [RFC3339] MUST be used to represent date-time values. 103 One day is defined as one day in UTC+0. Therefore, months and years 104 will also be calculated on this basis. 106 2.3. Character Encoding 108 Files and their content MUST be encoded in UTF-8 according to 109 [RFC3629]. 111 3. File Names 113 Files MUST be lowercase and follow this grammar: 115 PREFIX "_" TYPE "_" DATE "." FILESUFFIX 117 PREFIX indicates if the file is either a report specific for 118 a TLD or a registry. A report of a registry MAY include 119 more than one TLD. 121 TYPE indicates the type of the file, value MUST be either 122 'premium-domains', 'unavailable-domains' or 123 'transactions'. 125 DATE indicates the date of the file and MUST be 126 YYYY-MM-DD according to ISO 8601 [RFC3339] 128 FILESUFFIX identifier specified as a suffix to the name of the file 129 and indicates a characteristic of the file contents or 130 its intended use. The file suffix MUST be csv. 132 Example based on the above grammar: 134 Report of premium domain names for the TLD .example effective on 135 2018-08-01: example_premium-domains_2018-08-01.csv 137 Report of transactions for the TLD .example effective on 138 2018-08-02: example_transactions_2018-08-02.csv 140 Report of premium domain names for the .example Registry effective on 141 2018-08-01: example-registry_premium-domains_2018-08-01.csv 143 4. File Types 145 Files MUST be CSV files. 147 5. Delimiter 149 The delimiter MUST be semicolon. 151 6. IANA Considerations 153 This document has no IANA actions. 155 7. Security Considerations 157 The registry reporting reports described in this document do not 158 provide any security services. 160 8. Implementation Status 162 Note to RFC Editor: Please remove this section and the reference to 163 [RFC7942] before publication. 165 This section records the status of known implementations of the 166 protocol defined by this specification at the time of posting of this 167 Internet-Draft, and is based on a proposal described in [RFC7942]. 168 The description of implementations in this section is intended to 169 assist the IETF in its decision processes in progressing drafts to 170 RFCs. Please note that the listing of any individual implementation 171 here does not imply endorsement by the IETF. Furthermore, no effort 172 has been spent to verify the information presented here that was 173 supplied by IETF contributors. This is not intended as, and must not 174 be construed to be, a catalog of available implementations or their 175 features. Readers are advised to note that other implementations may 176 exist. 178 According to [RFC7942], "this will allow reviewers and working groups 179 to assign due consideration to documents that have the benefit of 180 running code, which may serve as evidence of valuable experimentation 181 and feedback that have made the implemented protocols more mature. It 182 is up to the individual working groups to use this information as 183 they see fit". 185 Add implementation details once available. 187 9. References 189 9.1. Normative References 191 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 192 Requirement Levels", BCP 14, RFC 2119, March 1997, 193 . 195 [RFC5890] Klensin, J., "Internationalized Domain Names for 196 Applications (IDNA): Definitions and Document Framework", 197 RFC 5890, August 2010, 198 . 200 9.2. Informative References 202 [I-D.mcpherson-sattler-registry-reporting-repo] 203 McPherson, N. and Sattler, T., "Registry Reporting 204 Repository", (work in 206 progress), July 2018 208 [RFC3339] Klyne, G., Ed. and C. Newman, "Date and Time on the 209 Internet: Timestamps", RFC 3339, July 2002, 210 . 212 [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO 213 10646", RFC 3629, November 2003, 214 . 216 [RFC7942] Sheffer, Y. and Farrel, A., "Improving Awareness of 217 Running Code: The Implementation Status Section", RFC 218 7942, July 2016, 219 . 221 Appendix A. Change History 223 A.1. Change from 00 to 01 225 Fixed minor typos in section 3. Clarified usage of csv files suffix. 227 Appendix B. Acknowledgements 229 The authors wish to thank the following persons for their feedback 230 and suggestions (sorted alphabetically by company): 232 * Thomas Keller, 1&1 Internet 233 * James Galvin, Afilias 234 * Andreas Huber, united-domains 236 Authors' Addresses 238 Neal McPherson 239 1&1 Internet SE 240 Ernst-Frey-Str. 5 241 76135 Karlsruhe 242 DE 244 Email: neal.mcpherson@1und1.de 245 URI: https://www.1und1.de 247 Tobias Sattler 249 Email: tobias.sattler@me.com 250 URI: https://tobiassattler.com