idnits 2.17.1 draft-mcpherson-sattler-transaction-report-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 2 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 1653 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 Transaction Report 7 draft-mcpherson-sattler-transaction-report-03 9 Abstract 11 This document describes the content of a Transaction Report based on 12 the Report Structure and delivered by 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. Report Headings . . . . . . . . . . . . . . . . . . . . . . . 3 54 4. Transaction Types . . . . . . . . . . . . . . . . . . . . . . 4 55 4.1. Standard Transaction Types . . . . . . . . . . . . . . . 4 56 4.2. Non-Standard Transaction Types . . . . . . . . . . . . . 5 57 5. Transaction Periods . . . . . . . . . . . . . . . . . . . . . 5 58 6. Transaction Fees . . . . . . . . . . . . . . . . . . . . . . 5 59 6.1. Deviating Fees . . . . . . . . . . . . . . . . . . . . . 5 60 7. Registrar ID . . . . . . . . . . . . . . . . . . . . . . . . 5 61 8. Example . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 62 8.1. Single TLD File Example . . . . . . . . . . . . . . . . . 5 63 8.2. Multiple TLDs File Example . . . . . . . . . . . . . . . 6 64 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 6 65 10. Security Considerations . . . . . . . . . . . . . . . . . . . 6 66 11. Implementation Status . . . . . . . . . . . . . . . . . . . . 6 67 11.1. united-domains Reselling . . . . . . . . . . . . . . . 6 68 12. References . . . . . . . . . . . . . . . . . . . . . . . . . 8 69 12.1. Normative References . . . . . . . . . . . . . . . . . 8 70 12.2. Informative References . . . . . . . . . . . . . . . . 8 71 Appendix A. Change History . . . . . . . . . . . . . . . . . . . 8 72 A.1. Change from 00 to 01 . . . . . . . . . . . . . . . . . . 8 73 A.2. Change from 01 to 02 . . . . . . . . . . . . . . . . . . 8 74 A.3. Change from 02 to TXN 00 . . . . . . . . . . . . . . . . 8 75 A.4. Change from TXN 00 to TXN 01 . . . . . . . . . . . . . . 8 76 A.5. Change from TXN 01 to TXN 02 . . . . . . . . . . . . . . 8 77 A.6. Change from TXN 02 to TXN 03 . . . . . . . . . . . . . . 9 78 Appendix B. Acknowledgements . . . . . . . . . . . . . . . . . . 9 79 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 9 81 1. Introduction 83 Modern top-level domain registries provide many detailed reports and 84 documents that their registrars require on a daily, weekly and 85 monthly basis. These most commonly include transaction reports, as 86 well as lists containing currently unavailable domains and current 87 premium domain fees. These reports are critical for registrars' 88 businesses and play an important role in accounting and operations 89 processes as well as in sales and marketing activities. In the 90 current set-up, registrars must download these reports from each 91 registry's intranet differently according to each registry's document 92 management set up. 94 This document describes the content of a Transaction Report based on 95 the [I-D.mcpherson-sattler-report-structure] and delivered 96 by the [I-D.mcpherson-sattler-reporting-repository]. 98 2. Terminology and Definitions 100 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 101 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 102 document are to be interpreted as described in [RFC2119] when 103 specified in their uppercase forms. 105 2.1. Internationalized Domain Names 107 MUST be as defined in 108 [I-D.mcpherson-sattler-report-structure]. 110 2.2. Dates and Times 112 MUST be as defined in 113 [I-D.mcpherson-sattler-report-structure]. 115 2.3. Character Encoding 117 MUST be as defined in 118 [I-D.mcpherson-sattler-report-structure]. 120 2.4. Currency 122 MUST be as defined in 123 [I-D.mcpherson-sattler-report-structure]. 125 3. Report Headings 127 The first row MUST be the column headings in the following order: 129 SVTRID Server transaction identifier MUST be assigned 130 by and MUST be unique to the server. 132 TLD It MUST contain the top-level domain name formatted 133 according to section 2.1 of this document. 135 DOMAIN It MUST contain the domain name formatted according 136 to section 2.1 of this document. 138 TIMESTAMP It MUST contain the timestamp of the successful 139 transaction formatted according to section 2.2 of 140 this document. 142 TRANSACTIONTYPE It MUST contain the type of the successful 143 transaction according to section 4 of this 144 document. 146 PERIOD It MUST either contain the Period of the successful 147 transaction according to section 5 of this document 148 or MUST be empty if no Period is assigned to the 149 operation. 151 TERM It MUST contain the unit of the Period noted 152 according to section 5 of this document. 154 FEE It MUST contain the fee of the successful 155 transaction according to section 6 of this 156 document. 158 CURRENCY It MUST contain the currency of the successful 159 transaction according to section 2.4 of this 160 document. 162 REGISTRARID It MUST contain the registrar ID of the succesful 163 transaction according to section 7 of this 164 document. 166 DESCRIPTION It MAY contain a free description of the successful 167 transaction. 169 4. Transaction Types 171 Each transaction MUST be assigned to a type. There are Standard 172 Transactions and Non-Standard Transactions. 174 A successful transaction is also a completed transaction. Therefore, 175 transactions MUST NOT be deleted. If a operation MUST be cleared, a 176 corresponding counter transaction MUST be made. 178 4.1. Standard Transaction Types 180 Standard transactions are considered to be CREATE, RENEWAL, 181 AUTORENEW, TRANSFER, TRADE, UPDATE, RESTORE and REGISTRYLOCK. 183 CREATE A successful domain create within the reporting period. 185 RENEWAL A successful explicit domain name renewal executed by 186 the domain name registrar within the reporting period. 188 AUTORENEW A successful domain name auto-renewal by the domain 189 name registry within the reporting period. 191 TRANSFER A successful domain name transfer within the reporting 192 period. 194 TRADE A successful domain name trade within the reporting 195 period. 197 UPDATE A successful billable domain name update within the 198 reporting period. 200 RESTORE A successful domain name restore within the reporting 201 period. 202 This event MUST only include the restore fee. Any 203 additional renewal fee MUST be independently listed. 205 REGISTRYLOCK A successful billable registry lock applied to the 206 domain name within the reporting period. 208 4.2. Non-Standard Transaction Types 210 Non-Standard Transactions MAY be listed in the report and MAY receive 211 a custom type, but it MUST have a corresponding description in the 212 description column. 214 5. Transaction Periods 216 Transaction Types usually occur in Periods of 1 to 10 years, and 217 sometimes there are monthly periods. Therefore, each transaction 218 MUST either have a Period associated or it MUST be empty if no Period 219 is assigned to the operation. 221 The Period format MUST be in the format , where 222 MUST be unsigned and between 1 and 65535, without any 223 leading zero 225 The Term format MUST be in the format and MUST be either 226 'y' for years or 'm' for months. 228 If the number of months results in a full year, then the year MUST be 229 used, e.g. instead of 12,m or 24,m, it should be 1,y respectively 230 2,y. 232 6. Transaction Fees 234 All transactions MUST have a Fee associated. The fee amount, the 235 currency and the period MUST be listed separately. 237 Fees MUST either be whole numbers or rounded to two decimal places. 238 The dividing point is a period (.). 240 6.1. Deviating Fees 242 If a domain name incurs a premium fee, that is not the standard price 243 for the TLD, a description of the price category SHOULD be given. 245 7. Registrar ID 247 A unique registrar ID MUST be listed, with each transaction. Those 248 IDs MUST be according to the IANA registrar IDs 249 (https://www.iana.org/assignments/registrar-ids/registrar-ids.xhtml) 250 where applicable, otherwise, another unique registrar ID MUST be 251 used. 253 8. Example 255 8.1. Single TLD File Example 256 This is an example of a transaction report for a single top-level 257 domain .example. 259 Filename: example_transactions_2018-11.csv.gz 261 SVTRID,TLD,DOMAIN,TIMESTAMP,TRANSACTIONTYPE,PERIOD,TERM,FEE,CURRENCY, 262 REGISTRARID,DESCRIPTION 263 54321-XYZ,example,nic.example,2018-11-08T08:01:01Z,AUTORENEW,1,y,10, 264 USD,1, 265 54322-XYZ,example,foo.example,2018-11-09T08:00:00Z,CREATE,3,y,10,USD, 266 1, 267 54323-XYZ,example,bar.example,2018-11-09T08:01:01Z,CREATE,1,y,1000, 268 USD,1,PREMIUM A 269 54324-XYZ,example,foobar.example,2018-11-10T07:00:00Z,RESTORE,,,40, 270 USD,1, 271 54325-XYZ,example,foobar.example,2018-11-10T07:00:01Z,RENEWAL,,,10, 272 USD,1, 273 54326-XYZ,example,xn--r8jz45g.example,2018-11-11T06:30:00Z,TRANSFER, 274 1,y,12.75,USD,1, 276 8.2. Multiple TLDs File Example 278 This is an example of a transaction report for multi top-level 279 domains by the example registry. 281 Filename: example_transactions_2018-11.csv.gz 283 SVTRID,TLD,DOMAIN,TIMESTAMP,TRANSACTIONTYPE,PERIOD,TERM,FEE,CURRENCY, 284 REGISTRARID,DESCRIPTION 285 54321-XYZ,example,nic.example,2018-11-08T08:01:01Z,AUTORENEW,1,y,10, 286 USD,1, 287 54322-XYZ,example1,foo.example1,2018-11-09T08:00:00Z,CREATE,6,m,9.90, 288 EUR,1, 289 54323-XYZ,example2,bar.example2,2018-11-09T08:01:01Z,CREATE,1,y,4000, 290 BRL,1,PREMIUM C 291 54324-XYZ,xn--0zwm56d,xn--fsqu00a.xn--0zwm56d,2018-11-10T07:00:00Z, 292 RESTORE,,275,CNY,1, 293 54325-XYZ,xn--0zwm56d,xn--fsqu00a.xn--0zwm56d,2018-11-10T07:00:01Z, 294 RENEWAL,,70,CNY,1, 295 54326-XYZ,xn--zckzah,xn--r8jz45g.xn--zckzah,2018-11-11T06:30:00Z, 296 TRANSFER,1,y,1200,JPY,1, 298 9. IANA Considerations 300 This document has no IANA actions. 302 10. Security Considerations 304 The registry transaction report described in this document does not 305 provide any security services. 307 11. Implementation Status 309 Note to RFC Editor: Please remove this section and the reference to 311 [RFC7942] before publication. 313 This section records the status of known implementations of the 314 protocol defined by this specification at the time of posting of this 315 Internet-Draft, and is based on a proposal described in [RFC7942]. 316 The description of implementations in this section is intended to 317 assist the IETF in its decision processes in progressing drafts to 318 RFCs. Please note that the listing of any individual implementation 319 here does not imply endorsement by the IETF. Furthermore, no effort 320 has been spent to verify the information presented here that was 321 supplied by IETF contributors. This is not intended as, and must not 322 be construed to be, a catalog of available implementations or their 323 features. Readers are advised to note that other implementations may 324 exist. 326 According to [RFC7942], "this will allow reviewers and working groups 327 to assign due consideration to documents that have the benefit of 328 running code, which may serve as evidence of valuable experimentation 329 and feedback that have made the implemented protocols more mature. It 330 is up to the individual working groups to use this information as 331 they see fit". 333 11.1. united-domains Reselling 335 Organization: united-domains Reselling GmbH 337 Name: Reseller Reporting System 339 Description: Domain Reseller Platform 341 Level of maturity: Deployed in production. 343 Version compatibility: Version TXN 02 is implemented. 345 Coverage: All aspects of this document are implemented. 347 Licensing: Proprietary In-House software 349 Contact: Tim Ettel 351 URL: https://www.ud-reselling.com/en/ 353 12. References 355 12.1. Normative References 357 [I-D.mcpherson-sattler-report-structure] 358 McPherson, N. and Sattler, T., "Report Strucutre", 359 (work in progress), January 2019 362 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 363 Requirement Levels", BCP 14, RFC 2119, March 1997, 364 . 366 12.2. Informative References 368 [I-D.mcpherson-sattler-reporting-repository] 369 McPherson, N. and Sattler, T., "Reporting Repository", 370 (work in progress), January 2019 373 [RFC7942] Sheffer, Y. and Farrel, A., "Improving Awareness of 374 Running Code: The Implementation Status Section", RFC 375 7942, July 2016, 376 . 378 Appendix A. Change History 380 A.1. Change from 00 to 01 382 Added acknowledgements. Changed Y to lowercase. Fixed csv examples. 383 Changed security considerations. Added SRTRID to identify 384 transactions. Clarified successful transaction. 386 A.2. Change from 01 to 02 388 Clarified the Period. Fixed numerous typos. Changed limit for Period 389 from 1-99 to unsigned 16 bit integer. 391 A.3. Change from 02 to TXN 00 393 Changed draft name. Added Term column to further clarify Period. 394 Defined Standard Transaction Types. Added Non-Standard Transaction 395 Types. Changed Column order so that DESCRIPTION is at end. 397 A.4. Change from TXN 00 to TXN 01 399 Editorial changes. 401 A.5. Change from TXN 01 to TXN 02 403 Added implementation reference. 405 A.6. Change from TXN 02 to TXN 03 407 Editorial changes. 409 Appendix B. Acknowledgements 411 The authors wish to thank the following persons for their feedback 412 and suggestions (sorted alphabetically by company): 414 o Jeff Yeh, Brandma 415 o Elaine Pruis, Domain Research 416 o Gaurav Vedi, Dominion Registries 417 o Jody Kolker, GoDaddy 418 o Roger Carney, GoDaddy 419 o Tim Ettel, united-domains 421 Authors' Addresses 423 Neal McPherson 424 1&1 IONOS SE 425 Ernst-Frey-Str. 5 426 76135 Karlsruhe 427 DE 429 Email: neal.mcpherson@ionos.com 430 URI: https://www.ionos.com 432 Tobias Sattler 434 Email: tobias.sattler@me.com 435 URI: https://tobiassattler.com