idnits 2.17.1 draft-mcpherson-sattler-report-structure-02.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 (April 15, 2019) is 1809 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: October 14, 2019 April 15, 2019 6 Report Structure 7 draft-mcpherson-sattler-report-structure-02 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 October 14, 2019. 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 . . . . . . . . . . . . . . . . . 2 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 . . . . . . . . . . . . . . . . . . . . . . . . . 3 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 . . . . . . . . . . . . . . . . 4 60 9. References . . . . . . . . . . . . . . . . . . . . . . . . . 5 61 9.1. Normative References . . . . . . . . . . . . . . . . . . 5 62 9.2. Informative References . . . . . . . . . . . . . . . . . 5 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 . . . . . . . . . . . . . . . . . . 6 70 A.7. Change from 06 to 07 . . . . . . . . . . . . . . . . . . 6 71 A.8. Change from 07 to REPORT 00 . . . . . . . . . . . . . . . 6 72 A.9. Change from REPORT 00 to REPORT 01 . . . . . . . . . . . 6 73 A.10. Change from REPORT 01 to REPORT 02 . . . . . . . . . . . 7 74 Appendix B. Acknowledgements . . . . . . . . . . . . . . . . . . 7 75 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 7 77 1. Introduction 79 Modern top-level domain registries provide many detailed reports and 80 documents that their registrars require on a daily, weekly and 81 monthly basis. These most commonly include transaction reports, as 82 well as lists containing currently unavailable domains and current 83 premium domain fees. These reports are critical for registrars' 84 businesses and play an important role in accounting and operations 85 processes as well as in sales and marketing activities. In the 86 current set-up, registrars must download these reports from each 87 registry's intranet differently according to each registry's document 88 management set up. 90 This document describes the default Report Structure for Reports 91 which can be provide via the 92 [I-D.mcpherson-sattler-reporting-repository]. 94 2. Terminology and Definitions 96 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 97 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 98 document are to be interpreted as described in [RFC2119] when 99 specified in their uppercase forms. 101 2.1. Internationalized Domain Names 103 Top-level domains and domain names contained in a file name or file 104 MUST be written as A-LABEL according to [RFC5890]. 106 2.2. Dates and Times 108 All dates and times attribute values MUST be expressed in Universal 109 Coordinated Time (UTC) using the Gregorian calendar. The extended 110 date-time form using upper case "T" and "Z" characters defined in ISO 111 8601 [RFC3339] MUST be used to represent date-time values. 113 One day is defined as one day in UTC+0. Therefore, months and years 114 will also be calculated on this basis. 116 2.3. Character Encoding 118 Files and their content MUST be encoded in UTF-8 according to 119 [RFC3629]. 121 2.4. Currency 123 Currencies MUST be listed with the relevant three letter currency 124 alphabetic code according to ISO 4217 (https://www.iso.org/iso-4217- 125 currency-codes.html). 127 3. File Names 129 Files MUST be lowercase and follow this grammar: 131 PREFIX '_' TYPE '_' DATE '.' FILESUFFIX 133 PREFIX indicates if the file is either a report specific for 134 a TLD or a registry. A report of a registry MAY include 135 more than one TLD. 137 TYPE indicates the type of the file, the value MUST be either 138 'premium-domains', 'unavailable-domains' or 139 'transactions'. 141 DATE indicates the date of the file and MUST be 142 YYYY-MM-DD or YYYY-MM according to ISO 8601 [RFC3339] 144 FILESUFFIX identifier specified as a suffix to the name of the file 145 and indicated a characteristic of the file contents or 146 its intended use. The file suffix MUST be csv. 148 Example based on the above grammar: 150 Daily report of premium domain names for the TLD .example effective 151 on 2018-08-01: example_premium-domains_2018-08-01.csv.gz 153 Monthly report of transactions for the TLD .example effective on 154 2018-08: example_transactions_2018-08.csv.gz 156 Monthly report of premium domain names for the .example registry 157 effective on 2018-08: example-registry_premium-domains_2018-08.csv.gz 159 4. File Types 161 Files MUST be CSV files according to [RFC4180]. It is RECOMMENDED 162 to compress with gzip according to [RFC1952]. 164 5. Delimiter 166 The delimiter MUST be a comma. 168 6. IANA Considerations 170 This document has no IANA actions. 172 7. Security Considerations 174 The registry report structure described in this document does not 175 provide any security services. 177 8. Implementation Status 179 Note to RFC Editor: Please remove this section and the reference to 180 [RFC7942] before publication. 182 This section records the status of known implementations of the 183 protocol defined by this specification at the time of posting of this 184 Internet-Draft, and is based on a proposal described in [RFC7942]. 185 The description of implementations in this section is intended to 186 assist the IETF in its decision processes in progressing drafts to 187 RFCs. Please note that the listing of any individual implementation 188 here does not imply endorsement by the IETF. Furthermore, no effort 189 has been spent to verify the information presented here that was 190 supplied by IETF contributors. This is not intended as, and must not 191 be construed to be, a catalog of available implementations or their 192 features. Readers are advised to note that other implementations may 193 exist. 195 According to [RFC7942], "this will allow reviewers and working groups 196 to assign due consideration to documents that have the benefit of 197 running code, which may serve as evidence of valuable experimentation 198 and feedback that have made the implemented protocols more mature. It 199 is up to the individual working groups to use this information as 200 they see fit". 202 8.1. united-domains Reselling 204 Organization: united-domains Reselling GmbH 206 Name: Reseller Reporting System 208 Description: Domain Reseller Platform 210 Level of maturity: Deployed in production. 212 Version compatibility: Version REPO 01 is implemented. 214 Coverage: All aspects of this document are implemented. 216 Licensing: Proprietary In-House software 218 Contact: Tim Ettel 220 URL: https://www.ud-reselling.com/en/ 222 9. References 224 9.1. Normative References 226 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 227 Requirement Levels", BCP 14, RFC 2119, March 1997, 228 . 230 [RFC5890] Klensin, J., "Internationalized Domain Names for 231 Applications (IDNA): Definitions and Document Framework", 232 RFC 5890, August 2010, 233 . 235 9.2. Informative References 237 [I-D.mcpherson-sattler-reporting-repository] 238 McPherson, N. and Sattler, T., "Reporting Repository", 239 (work in progress), March 2019 242 [RFC1952] Deutsch, P., "GZIP file format specification version 4.3", 243 RFC 1952, May 1996, 244 . 246 [RFC3339] Klyne, G., Ed. and C. Newman, "Date and Time on the 247 Internet: Timestamps", RFC 3339, July 2002, 248 . 250 [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO 251 10646", RFC 3629, November 2003, 252 . 254 [RFC4180] Shafranovich, Y., "Common Format and MIME Type for 255 Comma-Separated Values (CSV) Files", RFC 4180, 256 October 2005 257 . 259 [RFC7942] Sheffer, Y. and Farrel, A., "Improving Awareness of 260 Running Code: The Implementation Status Section", RFC 261 7942, July 2016, 262 . 264 Appendix A. Change History 266 A.1. Change from 00 to 01 268 Fixed minor typos in section 3. Clarified usage of csv files suffix. 270 A.2. Change from 01 to 02 272 Updated Neal's author details. 274 A.3. Change from 02 to 03 276 Added definition of currency. Added monthly reports and changed 277 examples. 279 A.4. Change from 03 to 04 281 Added reference to RFC4180 for CSV files, and changed delimiter to 282 comma accordingly. 284 A.5. Change from 04 to 05 286 Added editor flag to author. Minor formatting changes. Changed 287 security considerations. 289 A.6. Change from 05 to 06 291 Clarified to compress the csv files with gzip. 293 A.7. Change from 06 to 07 295 Added reference to RFC1952 for gzip. 297 A.8. Change from 07 to REPORT 00 299 Changed draft name. 301 A.9. Change from REPORT 00 to REPORT 01 303 Added implementation reference and acknowledgement. Editorial 304 changes. 306 A.10. Change from REPORT 01 to REPORT 02 308 Changed implementation reference. Editorial changes. 310 Appendix B. Acknowledgements 312 The authors wish to thank the following persons for their feedback 313 and suggestions (sorted alphabetically by company): 315 o Thomas Keller, 1&1 IONOS 316 o James Galvin, Afilias 317 o Tim Ettel, united-domains 318 o Andreas Huber, united-domains 320 Authors' Addresses 322 Neal McPherson 323 1&1 IONOS SE 324 Ernst-Frey-Str. 5 325 76135 Karlsruhe 326 DE 328 Email: neal.mcpherson@ionos.com 329 URI: https://www.ionos.com 331 Tobias Sattler 333 Email: tobias.sattler@me.com 334 URI: https://tobiassattler.com