idnits 2.17.1 draft-mcpherson-sattler-transaction-report-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 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 (April 15, 2019) is 1836 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 Transaction Report 7 draft-mcpherson-sattler-transaction-report-02 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 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 . . . . . . . . . . . . . . . . . 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 Appendix B. Acknowledgements . . . . . . . . . . . . . . . . . . 9 78 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 9 80 1. Introduction 82 Modern top-level domain registries provide many detailed reports and 83 documents that their registrars require on a daily, weekly and 84 monthly basis. These most commonly include transaction reports, as 85 well as lists containing currently unavailable domains and current 86 premium domain fees. These reports are critical for registrars' 87 businesses and play an important role in accounting and operations 88 processes as well as in sales and marketing activities. In the 89 current set-up, registrars must download these reports from each 90 registry's intranet differently according to each registry's document 91 management set up. 93 This document describes the content of a Transaction Report based on 94 the [I-D.mcpherson-sattler-report-structure] and delivered 95 by the [I-D.mcpherson-sattler-reporting-repository]. 97 2. Terminology and Definitions 99 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 100 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 101 document are to be interpreted as described in [RFC2119] when 102 specified in their uppercase forms. 104 2.1. Internationalized Domain Names 106 MUST be as defined in 107 [I-D.mcpherson-sattler-report-structure]. 109 2.2. Dates and Times 111 MUST be as defined in 112 [I-D.mcpherson-sattler-report-structure]. 114 2.3. Character Encoding 116 MUST be as defined in 117 [I-D.mcpherson-sattler-report-structure]. 119 2.4. Currency 121 MUST be as defined in 122 [I-D.mcpherson-sattler-report-structure]. 124 3. Report Headings 126 The first row MUST be the column headings in the following order: 128 SVTRID Server transaction identifier MUST be assigned 129 by and MUST be unique to the server. 131 TLD It MUST contain the top-level domain name formatted 132 according to section 2.1 of this document. 134 DOMAIN It MUST contain the domain name formatted according 135 to section 2.1 of this document. 137 TIMESTAMP It MUST contain the timestamp of the successful 138 transaction formatted according to section 2.2 of 139 this document. 141 TRANSACTIONTYPE It MUST contain the type of the successful 142 transaction according to section 4 of this 143 document. 145 PERIOD It MUST either contain the Period of the successful 146 transaction according to section 5 of this document 147 or MUST be empty if no Period is assigned to the 148 operation. 150 TERM It MUST contain the unit of the Period noted 151 according to section 5 of this document. 153 FEE It MUST contain the fee of the successful 154 transaction according to section 6 of this 155 document. 157 CURRENCY It MUST contain the currency of the successful 158 transaction according to section 2.4 of this 159 document. 161 REGISTRARID It MUST contain the registrar ID of the succesful 162 transaction according to section 7 of this 163 document. 165 DESCRIPTION It MAY contain a free description of the successful 166 transaction. 168 4. Transaction Types 170 Each transaction MUST be assigned to a type. There are Standard 171 Transactions and Non-Standard Transactions. 173 A successful transaction is also a completed transaction. Therefore, 174 transactions MUST NOT be deleted. If a operation MUST be cleared, a 175 corresponding counter transaction MUST be made. 177 4.1. Standard Transaction Types 179 Standard transactions are considered to be CREATE, RENEWAL, 180 AUTORENEW, TRANSFER, TRADE, UPDATE, RESTORE and REGISTRYLOCK. 182 CREATE A successful domain create within the reporting period. 184 RENEWAL A successful explicit domain name renewal executed by 185 the domain name registrar within the reporting period. 187 AUTORENEW A successful domain name auto-renewal by the domain 188 name registry within the reporting period. 190 TRANSFER A successful domain name transfer within the reporting 191 period. 193 TRADE A successful domain name trade within the reporting 194 period. 196 UPDATE A successful billable domain name update within the 197 reporting period. 199 RESTORE A successful domain name restore within the reporting 200 period. 201 This event MUST only include the restore fee. Any 202 additional renewal fee MUST be independently listed. 204 REGISTRYLOCK A successful billable registry lock applied to the 205 domain name within the reporting period. 207 4.2. Non-Standard Transaction Types 209 Non-Standard Transactions MAY be listed in the report and MAY receive 210 a custom type, but it MUST have a corresponding description in the 211 description column. 213 5. Transaction Periods 215 Transaction Types usually occur in Periods of 1 to 10 years, and 216 sometimes there are monthly periods. Therefore, each transaction 217 MUST either have a Period associated or it MUST be empty if no Period 218 is assigned to the operation. 220 The Period format MUST be in the format , where 221 MUST be unsigned and between 1 and 65535, without any 222 leading zero 224 The Term format MUST be in the format and MUST be either 225 'y' for years or 'm' for months. 227 If the number of months results in a full year, then the year MUST be 228 used, e.g. instead of 12,m or 24,m, it should be 1,y respectively 229 2,y. 231 6. Transaction Fees 233 All transactions MUST have a Fee associated. The fee amount, the 234 currency and the period MUST be listed separately. 236 Fees MUST either be whole numbers or rounded to two decimal places. 237 The dividing point is a period (.). 239 6.1. Deviating Fees 241 If a domain name incurs a premium fee, that is not the standard price 242 for the TLD, a description of the price category SHOULD be given. 244 7. Registrar ID 246 A unique registrar ID MUST be listed, with each transaction. Those 247 IDs MUST be according to the IANA registrar IDs 248 (https://www.iana.org/assignments/registrar-ids/registrar-ids.xhtml) 249 where applicable, otherwise, another unique registrar ID MUST be 250 used. 252 8. Example 254 8.1. Single TLD File Example 255 This is an example of a transaction report for a single top-level 256 domain .example. 258 Filename: example_transactions_2018-11.csv.gz 260 SVTRID,TLD,DOMAIN,TIMESTAMP,TRANSACTIONTYPE,PERIOD,TERM,FEE,CURRENCY, 261 REGISTRARID,DESCRIPTION 262 54321-XYZ,example,nic.example,2018-11-08T08:01:01Z,AUTORENEW,1,y,10, 263 USD,1, 264 54322-XYZ,example,foo.example,2018-11-09T08:00:00Z,CREATE,3,y,10,USD, 265 1, 266 54323-XYZ,example,bar.example,2018-11-09T08:01:01Z,CREATE,1,y,1000, 267 USD,1,PREMIUM A 268 54324-XYZ,example,foobar.example,2018-11-10T07:00:00Z,RESTORE,,,40, 269 USD,1, 270 54325-XYZ,example,foobar.example,2018-11-10T07:00:01Z,RENEWAL,,,10, 271 USD,1, 272 54326-XYZ,example,xn--r8jz45g.example,2018-11-11T06:30:00Z,TRANSFER, 273 1,y,12.75,USD,1, 275 8.2. Multiple TLDs File Example 277 This is an example of a transaction report for multi top-level 278 domains by the example registry. 280 Filename: example_transactions_2018-11.csv.gz 282 SVTRID,TLD,DOMAIN,TIMESTAMP,TRANSACTIONTYPE,PERIOD,TERM,FEE,CURRENCY, 283 REGISTRARID,DESCRIPTION 284 54321-XYZ,example,nic.example,2018-11-08T08:01:01Z,AUTORENEW,1,y,10, 285 USD,1, 286 54322-XYZ,example1,foo.example1,2018-11-09T08:00:00Z,CREATE,6,m,9.90, 287 EUR,1, 288 54323-XYZ,example2,bar.example2,2018-11-09T08:01:01Z,CREATE,1,y,4000, 289 BRL,1,PREMIUM C 290 54324-XYZ,xn--0zwm56d,xn--fsqu00a.xn--0zwm56d,2018-11-10T07:00:00Z, 291 RESTORE,,275,CNY,1, 292 54325-XYZ,xn--0zwm56d,xn--fsqu00a.xn--0zwm56d,2018-11-10T07:00:01Z, 293 RENEWAL,,70,CNY,1, 294 54326-XYZ,xn--zckzah,xn--r8jz45g.xn--zckzah,2018-11-11T06:30:00Z, 295 TRANSFER,1,y,1200,JPY,1, 297 9. IANA Considerations 299 This document has no IANA actions. 301 10. Security Considerations 303 The registry transaction report described in this document does not 304 provide any security services. 306 11. Implementation Status 308 Note to RFC Editor: Please remove this section and the reference to 310 [RFC7942] before publication. 312 This section records the status of known implementations of the 313 protocol defined by this specification at the time of posting of this 314 Internet-Draft, and is based on a proposal described in [RFC7942]. 315 The description of implementations in this section is intended to 316 assist the IETF in its decision processes in progressing drafts to 317 RFCs. Please note that the listing of any individual implementation 318 here does not imply endorsement by the IETF. Furthermore, no effort 319 has been spent to verify the information presented here that was 320 supplied by IETF contributors. This is not intended as, and must not 321 be construed to be, a catalog of available implementations or their 322 features. Readers are advised to note that other implementations may 323 exist. 325 According to [RFC7942], "this will allow reviewers and working groups 326 to assign due consideration to documents that have the benefit of 327 running code, which may serve as evidence of valuable experimentation 328 and feedback that have made the implemented protocols more mature. It 329 is up to the individual working groups to use this information as 330 they see fit". 332 11.1. united-domains Reselling 334 Organization: united-domains Reselling GmbH 336 Name: Reseller Reporting System 338 Description: Domain Reseller Platform 340 Level of maturity: Deployed in production. 342 Version compatibility: Version TXN 02 is implemented. 344 Coverage: All aspects of this document are implemented. 346 Licensing: Proprietary In-House software 348 Contact: Tim Ettel 350 URL: https://www.ud-reselling.com/en/ 352 12. References 354 12.1. Normative References 356 [I-D.mcpherson-sattler-report-structure] 357 McPherson, N. and Sattler, T., "Report Strucutre", 358 (work in progress), January 2019 361 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 362 Requirement Levels", BCP 14, RFC 2119, March 1997, 363 . 365 12.2. Informative References 367 [I-D.mcpherson-sattler-reporting-repository] 368 McPherson, N. and Sattler, T., "Reporting Repository", 369 (work in progress), January 2019 372 [RFC7942] Sheffer, Y. and Farrel, A., "Improving Awareness of 373 Running Code: The Implementation Status Section", RFC 374 7942, July 2016, 375 . 377 Appendix A. Change History 379 A.1. Change from 00 to 01 381 Added acknowledgements. Changed Y to lowercase. Fixed csv examples. 382 Changed security considerations. Added SRTRID to identify 383 transactions. Clarified successful transaction. 385 A.2. Change from 01 to 02 387 Clarified the Period. Fixed numerous typos. Changed limit for Period 388 from 1-99 to unsigned 16 bit integer. 390 A.3. Change from 02 to TXN 00 391 Changed draft name. Added Term column to further clarify Period. 392 Defined Standard Transaction Types. Added Non-Standard Transaction 393 Types. Changed Column order so that DESCRIPTION is at end. 395 A.4. Change from TXN 00 to TXN 01 397 Editorial changes. 399 A.5. Change from TXN 01 to TXN 02 401 Added implementation reference. 403 Appendix B. Acknowledgements 405 The authors wish to thank the following persons for their feedback 406 and suggestions (sorted alphabetically by company): 408 o Jeff Yeh, Brandma 409 o Elaine Pruis, Domain Research 410 o Gaurav Vedi, Dominion Registries 411 o Jody Kolker, GoDaddy 412 o Roger Carney, GoDaddy 413 o Tim Ettel, united-domains 415 Authors' Addresses 417 Neal McPherson 418 1&1 IONOS SE 419 Ernst-Frey-Str. 5 420 76135 Karlsruhe 421 DE 423 Email: neal.mcpherson@ionos.com 424 URI: https://www.ionos.com 426 Tobias Sattler 428 Email: tobias.sattler@me.com 429 URI: https://tobiassattler.com