idnits 2.17.1 draft-mcpherson-sattler-report-structure-00.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 (January 29, 2019) is 1913 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: July 28, 2019 January 29, 2019 6 Report Structure 7 draft-mcpherson-sattler-report-structure-00 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 July 28, 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 9. References . . . . . . . . . . . . . . . . . . . . . . . . . 5 60 9.1. Normative References . . . . . . . . . . . . . . . . . . 5 61 9.2. Informative References . . . . . . . . . . . . . . . . . 5 62 Appendix A. Change History . . . . . . . . . . . . . . . . . . . 5 63 A.1. Change from 00 to 01 . . . . . . . . . . . . . . . . . . 5 64 A.2. Change from 01 to 02 . . . . . . . . . . . . . . . . . . 5 65 A.3. Change from 02 to 03 . . . . . . . . . . . . . . . . . . 5 66 A.4. Change from 03 to 04 . . . . . . . . . . . . . . . . . . 6 67 A.5. Change from 04 to 05 . . . . . . . . . . . . . . . . . . 6 68 A.6. Change from 05 to 06 . . . . . . . . . . . . . . . . . . 6 69 A.7. Change from 06 to 07 . . . . . . . . . . . . . . . . . . 6 70 A.8. Change from 07 to REPORT 00 . . . . . . . . . . . . . . . 6 71 Appendix B. Acknowledgements . . . . . . . . . . . . . . . . . . 6 72 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 6 74 1. Introduction 76 Modern top-level domain registries provide a number of detailed 77 reports and documents that their registrars require on a daily, 78 weekly and monthly basis. These most commonly include transaction 79 reports, as well as lists containing currently unavailable domains 80 and current premium domains. These reports are critical for 81 registrars' businesses and play an important role in accounting and 82 operations processes as well as in sales and marketing activities. 83 In the current set-up registrars must download these reports from 84 each registry's intranet in a different manner according to each 85 registry's own document management set up. 87 This document describes the default Report Structure for Reports 88 which can be provide via the 89 [I-D.mcpherson-sattler-reporting-repository]. 91 2. Terminology and Definitions 93 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 94 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 95 document are to be interpreted as described in [RFC2119] when 96 specified in their uppercase forms. 98 2.1. Internationalized Domain Names 100 Top-level domains and domain names contained in a file name or file 101 MUST be written as A-LABEL according to [RFC5890]. 103 2.2. Dates and Times 105 All dates and times attribute values MUST be expressed in Universal 106 Coordinated Time (UTC) using the Gregorian calendar. The extended 107 date-time form using upper case "T" and "Z" characters defined in ISO 108 8601 [RFC3339] MUST be used to represent date-time values. 110 One day is defined as one day in UTC+0. Therefore, months and years 111 will also be calculated on this basis. 113 2.3. Character Encoding 115 Files and their content MUST be encoded in UTF-8 according to 116 [RFC3629]. 118 2.4. Currency 120 Currencies MUST be listed with the relevant 3 letter currency 121 alphabetic code according to ISO 4217 (https://www.iso.org/iso-4217- 122 currency-codes.html). 124 3. File Names 126 Files MUST be lowercase and follow this grammar: 128 PREFIX "_" TYPE "_" DATE "." FILESUFFIX 130 PREFIX indicates if the file is either a report specific for 131 a TLD or a registry. A report of a registry MAY include 132 more than one TLD. 134 TYPE indicates the type of the file, value MUST be either 135 'premium-domains', 'unavailable-domains' or 136 'transactions'. 138 DATE indicates the date of the file and MUST be 139 YYYY-MM-DD or YYYY-MM according to ISO 8601 [RFC3339] 141 FILESUFFIX identifier specified as a suffix to the name of the file 142 and indicates a characteristic of the file contents or 143 its intended use. The file suffix MUST be csv. 145 Example based on the above grammar: 147 Daily report of premium domain names for the TLD .example effective 148 on 2018-08-01: example_premium-domains_2018-08-01.csv.gz 150 Monthly report of transactions for the TLD .example effective on 151 2018-08: example_transactions_2018-08.csv.gz 153 Monthly report of premium domain names for the .example registry 154 effective on 2018-08: example-registry_premium-domains_2018-08.csv.gz 156 4. File Types 158 Files MUST be CSV files according to [RFC4180]. It is RECOMMENDED 159 to compress with gzip according to [RFC1952]. 161 5. Delimiter 163 The delimiter MUST be comma. 165 6. IANA Considerations 167 This document has no IANA actions. 169 7. Security Considerations 171 The registry report structure described in this document does not 172 provide any security services. 174 8. Implementation Status 176 Note to RFC Editor: Please remove this section and the reference to 177 [RFC7942] before publication. 179 This section records the status of known implementations of the 180 protocol defined by this specification at the time of posting of this 181 Internet-Draft, and is based on a proposal described in [RFC7942]. 182 The description of implementations in this section is intended to 183 assist the IETF in its decision processes in progressing drafts to 184 RFCs. Please note that the listing of any individual implementation 185 here does not imply endorsement by the IETF. Furthermore, no effort 186 has been spent to verify the information presented here that was 187 supplied by IETF contributors. This is not intended as, and must not 188 be construed to be, a catalog of available implementations or their 189 features. Readers are advised to note that other implementations may 190 exist. 192 According to [RFC7942], "this will allow reviewers and working groups 193 to assign due consideration to documents that have the benefit of 194 running code, which may serve as evidence of valuable experimentation 195 and feedback that have made the implemented protocols more mature. It 196 is up to the individual working groups to use this information as 197 they see fit". 199 Add implementation details once available. 201 9. References 203 9.1. Normative References 205 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 206 Requirement Levels", BCP 14, RFC 2119, March 1997, 207 . 209 [RFC5890] Klensin, J., "Internationalized Domain Names for 210 Applications (IDNA): Definitions and Document Framework", 211 RFC 5890, August 2010, 212 . 214 9.2. Informative References 216 [I-D.mcpherson-sattler-reporting-repository] 217 McPherson, N. and Sattler, T., "Reporting Repository", 218 (work in progress), January 2019 221 [RFC1952] Deutsch, P., "GZIP file format specification version 4.3", 222 RFC 1952, May 1996, 223 . 225 [RFC3339] Klyne, G., Ed. and C. Newman, "Date and Time on the 226 Internet: Timestamps", RFC 3339, July 2002, 227 . 229 [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO 230 10646", RFC 3629, November 2003, 231 . 233 [RFC4180] Shafranovich, Y., "Common Format and MIME Type for 234 Comma-Separated Values (CSV) Files", RFC 4180, 235 October 2005 236 . 238 [RFC7942] Sheffer, Y. and Farrel, A., "Improving Awareness of 239 Running Code: The Implementation Status Section", RFC 240 7942, July 2016, 241 . 243 Appendix A. Change History 245 A.1. Change from 00 to 01 247 Fixed minor typos in section 3. Clarified usage of csv files suffix. 249 A.2. Change from 01 to 02 251 Updated Neal's author details. 253 A.3. Change from 02 to 03 255 Added definition of currency. Added monthly reports and changed 256 examples. 258 A.4. Change from 03 to 04 260 Added reference to RFC4180 for CSV files, and changed delimiter to 261 comma accordingly. 263 A.5. Change from 04 to 05 265 Added editor flag to author. Minor formatting changes. Changed 266 security considerations. 268 A.6. Change from 05 to 06 270 Clarified to compress the csv files with gzip. 272 A.7. Change from 06 to 07 274 Added reference to RFC1952 for gzip. 276 A.8. Change from 07 to REPORT 00 278 Changed draft name. 280 Appendix B. Acknowledgements 282 The authors wish to thank the following persons for their feedback 283 and suggestions (sorted alphabetically by company): 285 o Thomas Keller, 1&1 IONOS 286 o James Galvin, Afilias 287 o Andreas Huber, united-domains 289 Authors' Addresses 291 Neal McPherson 292 1&1 IONOS SE 293 Ernst-Frey-Str. 5 294 76135 Karlsruhe 295 DE 297 Email: neal.mcpherson@ionos.com 298 URI: https://www.ionos.com 300 Tobias Sattler 302 Email: tobias.sattler@me.com 303 URI: https://tobiassattler.com