idnits 2.17.1 draft-mcpherson-sattler-report-structure-03.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 : ---------------------------------------------------------------------------- == There are 3 instances of lines with non-RFC2606-compliant FQDNs in the document. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (October 15, 2019) is 1655 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 (~~), 2 warnings (==), 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 IONOS SE 3 Intended status: Best Current Practice T. Sattler, Editor 4 Expires: April 15, 2020 October 15, 2019 6 Report Structure 7 draft-mcpherson-sattler-report-structure-03 9 Abstract 11 This document describes the default Report Structure for Reports 12 which can be provide via the Reporting Repository. 14 Status of This Memo 16 This Internet-Draft is submitted in full conformance with the 17 provisions of BCP 78 and BCP 79. 19 Internet-Drafts are working documents of the Internet Engineering 20 Task Force (IETF). Note that other groups may also distribute 21 working documents as Internet-Drafts. The list of current Internet- 22 Drafts is at https://datatracker.ietf.org/drafts/current/. 24 Internet-Drafts are draft documents valid for a maximum of six months 25 and may be updated, replaced, or obsoleted by other documents at any 26 time. It is inappropriate to use Internet-Drafts as reference 27 material or to cite them other than as "work in progress". 29 This Internet-Draft will expire on April 15, 2020. 31 Copyright Notice 33 Copyright (c) 2019 IETF Trust and the persons identified as the 34 document authors. All rights reserved. 36 This document is subject to BCP 78 and the IETF Trust's Legal 37 Provisions Relating to IETF Documents 38 (https://trustee.ietf.org/license-info) in effect on the date of 39 publication of this document. Please review these documents 40 carefully, as they describe your rights and restrictions with respect 41 to this document. Code Components extracted from this document must 42 include Simplified BSD License text as described in Section 4.e of 43 the Trust Legal Provisions and are provided without warranty as 44 described in the Simplified BSD License. 46 Table of Contents 47 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 48 2. Terminology and Definitions . . . . . . . . . . . . . . . . . 3 49 2.1. Internationalized Domain Names . . . . . . . . . . . . . 3 50 2.2. Dates and Times . . . . . . . . . . . . . . . . . . . . . 3 51 2.3. Character Encoding . . . . . . . . . . . . . . . . . . . 3 52 2.4. Currency . . . . . . . . . . . . . . . . . . . . . . . . 3 53 3. File Names . . . . . . . . . . . . . . . . . . . . . . . . . 4 54 4. File Types . . . . . . . . . . . . . . . . . . . . . . . . . 4 55 5. Delimiter . . . . . . . . . . . . . . . . . . . . . . . . . . 4 56 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 4 57 7. Security Considerations . . . . . . . . . . . . . . . . . . . 4 58 8. Implementation Status . . . . . . . . . . . . . . . . . . . . 4 59 8.1. united-domains Reselling . . . . . . . . . . . . . . . . 5 60 9. References . . . . . . . . . . . . . . . . . . . . . . . . . 5 61 9.1. Normative References . . . . . . . . . . . . . . . . . . 5 62 9.2. Informative References . . . . . . . . . . . . . . . . . 6 63 Appendix A. Change History . . . . . . . . . . . . . . . . . . . 6 64 A.1. Change from 00 to 01 . . . . . . . . . . . . . . . . . . 6 65 A.2. Change from 01 to 02 . . . . . . . . . . . . . . . . . . 6 66 A.3. Change from 02 to 03 . . . . . . . . . . . . . . . . . . 6 67 A.4. Change from 03 to 04 . . . . . . . . . . . . . . . . . . 6 68 A.5. Change from 04 to 05 . . . . . . . . . . . . . . . . . . 6 69 A.6. Change from 05 to 06 . . . . . . . . . . . . . . . . . . 7 70 A.7. Change from 06 to 07 . . . . . . . . . . . . . . . . . . 7 71 A.8. Change from 07 to REPORT 00 . . . . . . . . . . . . . . . 7 72 A.9. Change from REPORT 00 to REPORT 01 . . . . . . . . . . . 7 73 A.10. Change from REPORT 01 to REPORT 02 . . . . . . . . . . . 7 74 A.11. Change from REPORT 02 to REPORT 03 . . . . . . . . . . . 7 75 Appendix B. Acknowledgements . . . . . . . . . . . . . . . . . . 7 76 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 7 78 1. Introduction 80 Modern top-level domain registries provide many detailed reports and 81 documents that their registrars require on a daily, weekly and 82 monthly basis. These most commonly include transaction reports, as 83 well as lists containing currently unavailable domains and current 84 premium domain fees. These reports are critical for registrars' 85 businesses and play an important role in accounting and operations 86 processes as well as in sales and marketing activities. In the 87 current set-up, registrars must download these reports from each 88 registry's intranet differently according to each registry's document 89 management set up. 91 This document describes the default Report Structure for Reports 92 which can be provide via the 93 [I-D.mcpherson-sattler-reporting-repository]. 95 2. Terminology and Definitions 97 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 98 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 99 document are to be interpreted as described in [RFC2119] when 100 specified in their uppercase forms. 102 2.1. Internationalized Domain Names 104 Top-level domains and domain names contained in a file name or file 105 MUST be written as A-LABEL according to [RFC5890]. 107 2.2. Dates and Times 109 All dates and times attribute values MUST be expressed in Universal 110 Coordinated Time (UTC) using the Gregorian calendar. The extended 111 date-time form using upper case "T" and "Z" characters defined in ISO 112 8601 [RFC3339] MUST be used to represent date-time values. 114 One day is defined as one day in UTC+0. Therefore, months and years 115 will also be calculated on this basis. 117 2.3. Character Encoding 119 Files and their content MUST be encoded in UTF-8 according to 120 [RFC3629]. 122 2.4. Currency 124 Currencies MUST be listed with the relevant three letter currency 125 alphabetic code according to ISO 4217 (https://www.iso.org/iso-4217- 126 currency-codes.html). 128 3. File Names 130 Files MUST be lowercase and follow this grammar: 132 PREFIX '_' TYPE '_' DATE '.' FILESUFFIX 134 PREFIX indicates if the file is either a report specific for 135 a TLD or a registry. A report of a registry MAY include 136 more than one TLD. 138 TYPE indicates the type of the file, the value MUST be either 139 'premium-domains', 'unavailable-domains' or 140 'transactions'. 142 DATE indicates the date of the file and MUST be 143 YYYY-MM-DD or YYYY-MM according to ISO 8601 [RFC3339] 145 FILESUFFIX identifier specified as a suffix to the name of the file 146 and indicated a characteristic of the file contents or 147 its intended use. The file suffix MUST be csv. 149 Example based on the above grammar: 151 Daily report of premium domain names for the TLD .example effective 152 on 2018-08-01: example_premium-domains_2018-08-01.csv.gz 154 Monthly report of transactions for the TLD .example effective on 155 2018-08: example_transactions_2018-08.csv.gz 157 Monthly report of premium domain names for the .example registry 158 effective on 2018-08: example-registry_premium-domains_2018-08.csv.gz 160 4. File Types 162 Files MUST be CSV files according to [RFC4180]. It is RECOMMENDED 163 to compress with gzip according to [RFC1952]. 165 5. Delimiter 167 The delimiter MUST be a comma. 169 6. IANA Considerations 171 This document has no IANA actions. 173 7. Security Considerations 175 The registry report structure described in this document does not 176 provide any security services. 178 8. Implementation Status 180 Note to RFC Editor: Please remove this section and the reference to 181 [RFC7942] before publication. 183 This section records the status of known implementations of the 184 protocol defined by this specification at the time of posting of this 185 Internet-Draft, and is based on a proposal described in [RFC7942]. 186 The description of implementations in this section is intended to 187 assist the IETF in its decision processes in progressing drafts to 188 RFCs. Please note that the listing of any individual implementation 189 here does not imply endorsement by the IETF. Furthermore, no effort 190 has been spent to verify the information presented here that was 191 supplied by IETF contributors. This is not intended as, and must not 192 be construed to be, a catalog of available implementations or their 193 features. Readers are advised to note that other implementations may 194 exist. 196 According to [RFC7942], "this will allow reviewers and working groups 197 to assign due consideration to documents that have the benefit of 198 running code, which may serve as evidence of valuable experimentation 199 and feedback that have made the implemented protocols more mature. It 200 is up to the individual working groups to use this information as 201 they see fit". 203 8.1. united-domains Reselling 205 Organization: united-domains Reselling GmbH 207 Name: Reseller Reporting System 209 Description: Domain Reseller Platform 211 Level of maturity: Deployed in production. 213 Version compatibility: Version REPO 01 is implemented. 215 Coverage: All aspects of this document are implemented. 217 Licensing: Proprietary In-House software 219 Contact: Tim Ettel 221 URL: https://www.ud-reselling.com/en/ 223 9. References 225 9.1. Normative References 227 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 228 Requirement Levels", BCP 14, RFC 2119, March 1997, 229 . 231 [RFC5890] Klensin, J., "Internationalized Domain Names for 232 Applications (IDNA): Definitions and Document Framework", 233 RFC 5890, August 2010, 234 . 236 9.2. Informative References 238 [I-D.mcpherson-sattler-reporting-repository] 239 McPherson, N. and Sattler, T., "Reporting Repository", 240 (work in progress), March 2019 243 [RFC1952] Deutsch, P., "GZIP file format specification version 4.3", 244 RFC 1952, May 1996, 245 . 247 [RFC3339] Klyne, G., Ed. and C. Newman, "Date and Time on the 248 Internet: Timestamps", RFC 3339, July 2002, 249 . 251 [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO 252 10646", RFC 3629, November 2003, 253 . 255 [RFC4180] Shafranovich, Y., "Common Format and MIME Type for 256 Comma-Separated Values (CSV) Files", RFC 4180, 257 October 2005 258 . 260 [RFC7942] Sheffer, Y. and Farrel, A., "Improving Awareness of 261 Running Code: The Implementation Status Section", RFC 262 7942, July 2016, 263 . 265 Appendix A. Change History 267 A.1. Change from 00 to 01 269 Fixed minor typos in section 3. Clarified usage of csv files suffix. 271 A.2. Change from 01 to 02 273 Updated Neal's author details. 275 A.3. Change from 02 to 03 277 Added definition of currency. Added monthly reports and changed 278 examples. 280 A.4. Change from 03 to 04 282 Added reference to RFC4180 for CSV files, and changed delimiter to 283 comma accordingly. 285 A.5. Change from 04 to 05 287 Added editor flag to author. Minor formatting changes. Changed 288 security considerations. 290 A.6. Change from 05 to 06 292 Clarified to compress the csv files with gzip. 294 A.7. Change from 06 to 07 296 Added reference to RFC1952 for gzip. 298 A.8. Change from 07 to REPORT 00 300 Changed draft name. 302 A.9. Change from REPORT 00 to REPORT 01 304 Added implementation reference and acknowledgement. Editorial 305 changes. 307 A.10. Change from REPORT 01 to REPORT 02 309 Changed implementation reference. Editorial changes. 311 A.11. Change from REPORT 02 to REPORT 03 313 Editorial changes. 315 Appendix B. Acknowledgements 317 The authors wish to thank the following persons for their feedback 318 and suggestions (sorted alphabetically by company): 320 o Thomas Keller, 1&1 IONOS 321 o James Galvin, Afilias 322 o Tim Ettel, united-domains 323 o Andreas Huber, united-domains 325 Authors' Addresses 327 Neal McPherson 328 1&1 IONOS SE 329 Ernst-Frey-Str. 5 330 76135 Karlsruhe 331 DE 333 Email: neal.mcpherson@ionos.com 334 URI: https://www.ionos.com 336 Tobias Sattler 338 Email: tobias.sattler@me.com 339 URI: https://tobiassattler.com