idnits 2.17.1 draft-ietf-regext-epp-fees-17.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 : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (September 5, 2019) is 1694 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (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 (~~), 1 warning (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Registration Protocols Extensions R. Carney 3 Internet-Draft GoDaddy Inc. 4 Intended status: Standards Track G. Brown 5 Expires: March 8, 2020 CentralNic Group plc 6 J. Frakes 7 September 5, 2019 9 Registry Fee Extension for the Extensible Provisioning Protocol (EPP) 10 draft-ietf-regext-epp-fees-17 12 Abstract 14 Given the expansion of the DNS namespace, and the proliferation of 15 novel business models, it is desirable to provide a method for 16 Extensible Provisioning Protocol (EPP) clients to query EPP servers 17 for the fees and credits and provide expected fees and credits for 18 certain commands and objects. This document describes an EPP 19 extension mapping for registry fees. 21 Status of This Memo 23 This Internet-Draft is submitted in full conformance with the 24 provisions of BCP 78 and BCP 79. 26 Internet-Drafts are working documents of the Internet Engineering 27 Task Force (IETF). Note that other groups may also distribute 28 working documents as Internet-Drafts. The list of current Internet- 29 Drafts is at https://datatracker.ietf.org/drafts/current/. 31 Internet-Drafts are draft documents valid for a maximum of six months 32 and may be updated, replaced, or obsoleted by other documents at any 33 time. It is inappropriate to use Internet-Drafts as reference 34 material or to cite them other than as "work in progress." 36 This Internet-Draft will expire on March 8, 2020. 38 Copyright Notice 40 Copyright (c) 2019 IETF Trust and the persons identified as the 41 document authors. All rights reserved. 43 This document is subject to BCP 78 and the IETF Trust's Legal 44 Provisions Relating to IETF Documents 45 (https://trustee.ietf.org/license-info) in effect on the date of 46 publication of this document. Please review these documents 47 carefully, as they describe your rights and restrictions with respect 48 to this document. Code Components extracted from this document must 49 include Simplified BSD License text as described in Section 4.e of 50 the Trust Legal Provisions and are provided without warranty as 51 described in the Simplified BSD License. 53 Table of Contents 55 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 56 1.1. Conventions Used in This Document . . . . . . . . . . . . 3 57 2. Migrating to Newer Versions of This Extension . . . . . . . . 4 58 3. Extension Elements . . . . . . . . . . . . . . . . . . . . . 4 59 3.1. Client Commands . . . . . . . . . . . . . . . . . . . . . 4 60 3.2. Currency Codes . . . . . . . . . . . . . . . . . . . . . 5 61 3.3. Validity Periods . . . . . . . . . . . . . . . . . . . . 5 62 3.4. Fees and Credits . . . . . . . . . . . . . . . . . . . . 6 63 3.4.1. Refunds . . . . . . . . . . . . . . . . . . . . . . . 7 64 3.4.2. Grace Periods . . . . . . . . . . . . . . . . . . . . 7 65 3.4.3. Correlation between Refundability and Grace Periods . 7 66 3.4.4. Applicability . . . . . . . . . . . . . . . . . . . . 7 67 3.5. Account Balance . . . . . . . . . . . . . . . . . . . . . 8 68 3.6. Credit Limit . . . . . . . . . . . . . . . . . . . . . . 8 69 3.7. Classification of Objects . . . . . . . . . . . . . . . . 8 70 3.8. Phase and Subphase Attributes . . . . . . . . . . . . . . 9 71 3.9. Reason . . . . . . . . . . . . . . . . . . . . . . . . . 10 72 4. Server Handling of Fee Information . . . . . . . . . . . . . 11 73 5. EPP Command Mapping . . . . . . . . . . . . . . . . . . . . . 12 74 5.1. EPP Query Commands . . . . . . . . . . . . . . . . . . . 12 75 5.1.1. EPP Command . . . . . . . . . . . . . . . . . 12 76 5.1.2. EPP Transfer Query Command . . . . . . . . . . . . . 16 77 5.2. EPP Transform Commands . . . . . . . . . . . . . . . . . 18 78 5.2.1. EPP Command . . . . . . . . . . . . . . . . 18 79 5.2.2. EPP Command . . . . . . . . . . . . . . . . 20 80 5.2.3. EPP Command . . . . . . . . . . . . . . . . . 21 81 5.2.4. EPP Command . . . . . . . . . . . . . . . 23 82 5.2.5. EPP Command . . . . . . . . . . . . . . . . 25 83 6. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 27 84 6.1. Fee Extension Schema . . . . . . . . . . . . . . . . . . 27 85 7. Security Considerations . . . . . . . . . . . . . . . . . . . 32 86 8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 32 87 8.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 32 88 8.2. EPP Extension Registry . . . . . . . . . . . . . . . . . 32 89 9. Implementation Status . . . . . . . . . . . . . . . . . . . . 33 90 9.1. RegistryEngine EPP Service . . . . . . . . . . . . . . . 33 91 10. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 34 92 11. Change History . . . . . . . . . . . . . . . . . . . . . . . 34 93 11.1. Change from 16 to 17 . . . . . . . . . . . . . . . . . . 34 94 11.2. Change from 15 to 16 . . . . . . . . . . . . . . . . . . 34 95 11.3. Change from 14 to 15 . . . . . . . . . . . . . . . . . . 35 96 11.4. Change from 13 to 14 . . . . . . . . . . . . . . . . . . 35 97 11.5. Change from 12 to 13 . . . . . . . . . . . . . . . . . . 35 98 11.6. Change from 11 to 12 . . . . . . . . . . . . . . . . . . 35 99 11.7. Change from 10 to 11 . . . . . . . . . . . . . . . . . . 35 100 11.8. Change from 09 to 10 . . . . . . . . . . . . . . . . . . 35 101 11.9. Change from 08 to 09 . . . . . . . . . . . . . . . . . . 35 102 11.10. Change from 07 to 08 . . . . . . . . . . . . . . . . . . 36 103 11.11. Change from 06 to 07 . . . . . . . . . . . . . . . . . . 36 104 11.12. Change from 05 to 06 . . . . . . . . . . . . . . . . . . 36 105 11.13. Change from 04 to 05 . . . . . . . . . . . . . . . . . . 36 106 11.14. Change from 03 to 04 . . . . . . . . . . . . . . . . . . 36 107 11.15. Change from 02 to 03 . . . . . . . . . . . . . . . . . . 36 108 11.16. Change from 01 to 02 . . . . . . . . . . . . . . . . . . 37 109 11.17. Change from 00 to 01 . . . . . . . . . . . . . . . . . . 37 110 11.18. Change from draft-brown-00 to draft-ietf-regext-fees-00 37 111 12. References . . . . . . . . . . . . . . . . . . . . . . . . . 37 112 12.1. Normative References . . . . . . . . . . . . . . . . . . 37 113 12.2. Informative References . . . . . . . . . . . . . . . . . 38 114 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 38 116 1. Introduction 118 Historically, domain name registries have applied a simple fee 119 structure for billable transactions, namely a basic unit price 120 applied to domain , , and RGP [RFC3915] 121 restore commands. Given the relatively small number of EPP servers 122 to which EPP clients have been required to connect, it has generally 123 been the case that client operators have been able to obtain details 124 of these fees out-of-band by contacting the server operators. 126 Given the expansion of the DNS namespace, and the proliferation of 127 novel business models, it is desirable to provide a method for EPP 128 clients to query EPP servers for the fees and credits associated with 129 certain commands and specific objects. 131 This document describes an extension mapping for version 1.0 of the 132 Extensible Provisioning Protocol (EPP) [RFC5730]. This EPP mapping 133 provides a mechanism by which EPP clients may query the fees and 134 credits associated with various billable transactions, and obtain 135 their current account balance. 137 1.1. Conventions Used in This Document 139 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 140 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 141 "OPTIONAL" in this document are to be interpreted as described in BCP 142 14 [RFC2119] [RFC8174] when, and only when, they appear in all 143 capitals, as shown here. 145 XML is case sensitive. Unless stated otherwise, XML specifications 146 and examples provided in this document MUST be interpreted in the 147 character case presented in order to develop a conforming 148 implementation. 150 "fee" is used as an abbreviation for "urn:ietf:params:xml:ns:epp:fee- 151 1.0". The XML namespace prefix "fee" is used, but implementations 152 MUST NOT depend on it and instead employ a proper namespace-aware XML 153 parser and serializer to interpret and output the XML documents. 155 In examples, "C:" represents lines sent by a protocol client and "S:" 156 represents lines returned by a protocol server. Indentation and 157 white space in examples are provided only to illustrate element 158 relationships and are not a required feature of this protocol. 160 2. Migrating to Newer Versions of This Extension 162 Servers which implement this extension SHOULD provide a way for 163 clients to progressively update their implementations when a new 164 version of the extension is deployed. 166 Servers SHOULD (for a temporary migration period) provide support for 167 older versions of the extension in parallel to the newest version, 168 and allow clients to select their preferred version via the 169 element of the command. 171 If a client requests multiple versions of the extension at login, 172 then, when preparing responses to commands which do not include 173 extension elements, the server SHOULD only include extension elements 174 in the namespace of the newest version of the extension requested by 175 the client. 177 When preparing responses to commands which do include extension 178 elements, the server SHOULD only include extension elements for the 179 extension versions present in the command. 181 3. Extension Elements 183 3.1. Client Commands 185 The element is used in the EPP command to 186 determine the fee that is applicable to the given command. 188 The use of the keys off the use of the "name" attribute 189 to define which transform fees the client is requesting information 190 about. Here is the list of possible values for the "name" attribute: 192 o "create" indicating a command as defined in [RFC5730]; 193 o "delete" indicating a command as defined in [RFC5730]; 194 o "renew" indicating a command as defined in [RFC5730]; 195 o "update" indicating a command as defined in [RFC5730]; 196 o "transfer" indicating a command as defined in 197 [RFC5730]; 198 o If the server supports the Registry Grace Period Mapping 199 [RFC3915], then the server MUST also support the "restore" value 200 as defined in [RFC3915]; 201 o "custom" indicating a custom command that uses the "customName" 202 attribute to define the custom operation. 204 The element MAY have an OPTIONAL "phase" attribute 205 specifying a launch phase as described in [RFC8334]. It may also 206 contain an OPTIONAL "subphase" attribute identifying the custom or 207 sub-phase as described in [RFC8334]. 209 3.2. Currency Codes 211 The element is used to indicate which currency fees 212 are charged in. This value of this element MUST be a three-character 213 currency code from [ISO4217:2015]. 215 Note that ISO 4217:2015 provides the special "XXX" code, which MAY be 216 used if the server uses a non-currency based system for assessing 217 fees, such as a system of credits. 219 The use of elements in client commands is OPTIONAL: if 220 a element is not present in a command, the server MUST 221 determine the currency based on the server default currency or based 222 on the client's account settings which are agreed to by the client 223 and server via an out-of-band channel. However, the 224 element MUST be present in responses. 226 Servers SHOULD NOT perform a currency conversion if a client uses an 227 incorrect currency code. Servers SHOULD return a 2004 "Parameter 228 value range" error instead. 230 3.3. Validity Periods 232 When querying for fee information using the command, the 233 element is used to indicate the units to be added to the 234 registration period of objects by the , and 235 commands. This element is derived from the 236 element described in [RFC5731]. 238 The element is OPTIONAL in commands, if omitted, 239 the server MUST determine the fee(s) using the server default period. 240 The element MUST be present in responses. 242 3.4. Fees and Credits 244 Servers which implement this extension will include elements in 245 responses which provide information about the fees and/or credits 246 associated with a given billable transaction. A fee will result in 247 subtracting from the Account Balance (described in Section 3.5) and a 248 credit will result in adding to the Account Balance (described in 249 Section 3.5). 251 The and elements are used to provide this 252 information. The presence of a element in a response 253 indicates a debit against the client's account balance; a 254 element indicates a credit. A element MUST 255 have a zero or non-negative value. A element MUST have 256 a zero or negative value. 258 A server MAY respond with multiple and 259 elements in the same response. In such cases, the net fee or credit 260 applicable to the transaction is the arithmetic sum of the values of 261 each of the and/or elements. This amount 262 applies to the total additional validity period applied to the object 263 (where applicable) rather than to any incremental unit. 265 The following attributes are defined for the element. 266 These are described in detail below: 268 description: an OPTIONAL attribute which provides a human-readable 269 description of the fee. Servers should provide documentation on the 270 possible values of this attribute, and their meanings. An OPTIONAL 271 "lang" attribute MAY be present to identify the language of the 272 returned text and has a default value of "en" (English). 274 refundable: an OPTIONAL boolean attribute indicating whether the fee 275 is refundable if the object is deleted. 277 grace-period: an OPTIONAL attribute which provides the time period 278 during which the fee is refundable. 280 applied: an OPTIONAL attribute indicating when the fee will be 281 deducted from the client's account. 283 The element can take a "description" attribute as 284 described above. An OPTIONAL "lang" attribute MAY be present to 285 identify the language of the returned text and has a default value of 286 "en" (English). 288 3.4.1. Refunds 290 elements MAY have an OPTIONAL "refundable" attribute which 291 takes a boolean value. Fees may be refunded under certain 292 circumstances, such as when a domain application is rejected (as 293 described in [RFC8334]) or when an object is deleted during the 294 relevant Grace Period (see below). 296 If the "refundable" attribute is omitted, then clients SHOULD NOT 297 make any assumption about the refundability of the fee. 299 3.4.2. Grace Periods 301 [RFC3915] describes a system of "grace periods", which are time 302 periods following a billable transaction during which, if an object 303 is deleted, the client receives a refund. 305 The "grace-period" attribute MAY be used to indicate the relevant 306 grace period for a fee. If a server implements the Registry Grace 307 Period extension [RFC3915], it MUST specify the grace period for all 308 relevant transactions. 310 If the "grace-period" attribute is omitted, then clients SHOULD NOT 311 make any assumption about the grace period of the fee. 313 3.4.3. Correlation between Refundability and Grace Periods 315 If a element has a "grace-period" attribute then it MUST 316 also be refundable and the "refundable" attribute MUST be true. If 317 the "refundable" attribute of a element is false then it 318 MUST NOT have a "grace-period" attribute. 320 3.4.4. Applicability 322 Fees may be applied immediately upon receipt of a command from a 323 client, or may only be applied once an out-of-band process (such as 324 the processing of applications at the end of a launch phase) has 325 taken place. 327 The "applied" attribute of the element allows servers to 328 indicate whether a fee will be applied immediately, or whether it 329 will be applied at some point in the future. This attribute takes 330 two possible values: "immediate" or "delayed". 332 3.5. Account Balance 334 The element is an OPTIONAL element which MAY be 335 included in server responses to transform commands. If present, it 336 can be used by the client to determine the remaining credit at the 337 server. 339 Whether or not the is included in responses is a matter 340 of server policy. However, if a server chooses to offer support for 341 this element, it MUST be included in responses to all "transform" or 342 billable commands (e.g. , , , , 343 ). 345 The value of the MAY be negative. A negative balance 346 indicates that the server has extended a line of credit to the client 347 (see below). 349 If a server includes a element in response to transform 350 commands, the value of the element MUST reflect the client's account 351 balance after any fees or credits associated with that command have 352 been applied. If the "applied" attribute of the element is 353 "delayed", then the MUST reflect the client's account 354 balance without any fees or credits associated with that command. 356 3.6. Credit Limit 358 As described above, if a server returns a response containing a 359 with a negative value, then the server has extended a 360 line of credit to the client. A server MAY also include a 361 element in responses that indicates the maximum 362 credit available to a client. A server MAY reject certain 363 transactions if the absolute value of the is equal to 364 or exceeds the value of the element. 366 Whether or not the is included in responses is a 367 matter of server policy. However, if a server chooses to offer 368 support for this element, it MUST be included in responses to all 369 "transform" commands (e.g. , , , , 370 ). 372 3.7. Classification of Objects 374 Objects may be assigned to a particular class, category, or tier, 375 each of which has a particular fee or set of fees associated with it. 376 The element, which MAY appear in and transform 377 responses, is used to indicate the classification of an object. 379 If a server makes use of this element, it should provide clients with 380 a list of all the values that the element may take via an out-of-band 381 channel. Servers MUST NOT use values which do not appear on this 382 list. 384 Servers that make use of this element MUST use a element 385 with the value "standard" for all objects that are subject to the 386 standard or default fee. 388 3.8. Phase and Subphase Attributes 390 The element has two attributes, phase and subphase, 391 that provide additional information related to a specific launch 392 phase as described in [RFC8334]. These attributes are used as 393 filters that should refine the server processing. 395 If the client contains a server supported combination 396 of phase/subphase the server MUST return fee data (including the 397 phase/subphase attribute(s)) for the specific combination. 399 If the client contains no phase/subphase attributes and 400 the server has only one active phase/subphase combination the server 401 MUST return data (including the phase/subphase attribute(s)) of the 402 currently active phase/subphase. 404 If the client contains no phase/subphase attributes and 405 the server has more than one active phase/subphase combination the 406 server MUST respond with a 2003 "Required parameter missing" error. 408 If the client contains no phase/subphase attributes and 409 the server is currently in a "quiet period" (e.g. not accepting 410 registrations or applications) the server MUST return data consistent 411 with the default general availability phase (e.g. "open" or "claims") 412 including the appropriate phase/subphase attribute(s). 414 If the client contains a phase attribute with no 415 subphase and the server has only one active subphase (or no subphase) 416 of this phase, the server MUST return data (including the phase/ 417 subphase attribute(s)) of the provided phase and currently active 418 subphase. 420 If the client contains a phase attribute with no 421 subphase and the server has more than one active subphase combination 422 of this phase, the server MUST respond with a 2003 "Required 423 parameter missing" error. 425 If the client contains a subphase with no phase 426 attribute the server MUST respond with a 2003 "Required parameter 427 missing" error. 429 If the client contains a phase attribute not defined in 430 [RFC8334] or not supported by server the server MUST respond with a 431 2004 "Parameter value range" error. 433 If the client contains a subphase attribute (or phase/ 434 subphase combination) not supported by server the server MUST respond 435 with a 2004 "Parameter value range" error. 437 3.9. Reason 439 The element is used to provide server specific text in 440 an effort to better explain why a command did not complete as 441 the client expected. An OPTIONAL "lang" attribute MAY be present to 442 identify the language of the returned text and has a default value of 443 "en" (English). 445 The element can be used within the server response 446 element or within the element. 448 If the server cannot calculate the relevant fees, because the object, 449 command, currency, period, class or some combination is invalid per 450 server policy, the server has two ways of handling error processing 451 of element(s): 453 1. Fast-fail - The server, upon error identification, MAY stop 454 processing elements and return to the client a 455 containing the and a element 456 detailing the reason for failure. 458 S: 459 S: example.xyz 460 S: Only 1 year registration periods are 461 S: valid. 462 S: 464 2. Partial-fail - The server, upon error identification, MAY 465 continue processing elements and return to the 466 client a containing successfully processed 467 elements and failed elements. All returned failed 468 elements MUST have a element detailing 469 the reason for failure, and the server MAY additionally include a 470 element at the level. 472 S: 473 S: example.xyz 474 S: 475 S: 2 476 S: Only 1 year registration periods are 477 S: valid. 478 S: 479 S: 481 In either failure scenario the server MUST set the avail 482 attribute to false (0) and the server MUST process all objects in the 483 client request. 485 4. Server Handling of Fee Information 487 Depending on server policy, a client MAY be required to include the 488 extension elements described in this document for certain transform 489 commands. Servers must provide clear documentation to clients about 490 the circumstances in which this extension must be used. 492 The server MUST return avail="0" in its response to a command 493 for any object in the command that does not include the 494 extension for which the server would likewise fail a 495 domain command when no extension is provided for that 496 same object. 498 If a server receives a command from a client, which results 499 in no possible fee combination but where a fee is required, the 500 server MUST set the "avail" attribute of the element to 501 false and provide a . 503 If a server receives a command from a client, which results 504 in an ambiguous result (i.e. multiple possible fee combinations) the 505 server MUST reject the command with a 2003 "Required parameter 506 missing" error. 508 If a server receives a command from a client, which does not include 509 the fee extension data elements required by the server for that 510 command, then the server MUST respond with a 2003 "Required parameter 511 missing" error. 513 If the currency or total fee provided by the client is less than the 514 server's own calculation of the fee for that command, then the server 515 MUST reject the command with a 2004 "Parameter value range" error. 517 5. EPP Command Mapping 519 A detailed description of the EPP syntax and semantics can be found 520 in [RFC5730]. 522 5.1. EPP Query Commands 524 This extension does not add any elements to the EPP or 525 commands or responses. 527 5.1.1. EPP Command 529 This extension defines a new command called the Fee Check Command 530 that defines additional elements for the EPP command to 531 provide fee information along with the availability information of 532 the EPP command. 534 The command MAY contain an element which MAY contain a 535 element. The element MAY contain one 536 element and MUST contain one or more 537 elements. 539 The element(s) contain(s) a "name" attribute (see 540 Section 3.1), an OPTIONAL "phase" attribute, and an OPTIONAL 541 "subphase" attribute (see Section 3.8). The element(s) 542 MAY have the following child elements: 544 o An OPTIONAL element (as described in Section 3.3). 546 Example command: 548 C: 549 C: 550 C: 551 C: 552 C: 554 C: example.com 555 C: example.net 556 C: example.xyz 557 C: 558 C: 559 C: 560 C: 561 C: USD 562 C: 563 C: 2 564 C: 565 C: 566 C: 567 C: 568 C: 569 C: 570 C: ABC-12345 571 C: 572 C: 574 When the server receives a command that includes the 575 extension elements described above, its response MUST contain an 576 element, which MUST contain a child 577 element. The element MUST contain a 578 element and a for each element referenced in the client 579 command. 581 Each element MUST contain the following child elements: 583 o A element, which MUST match an element referenced in 584 the client command. 585 o An OPTIONAL element (as described in Section 3.7). 586 o A element matching each (unless the 587 "avail" attribute of the if false) that appeared in the 588 corresponding of the client command. This element MAY 589 have the OPTIONAL "standard" attribute, with a default value of 590 "0" (or "false"), which indicates whether the fee matches the fee 591 of the "standard" classification (see section 3.7). This element 592 MAY have the OPTIONAL "phase" and "subphase" attributes, which 593 SHOULD match the same attributes in the corresponding 594 element of the client command if sent by the client. 596 The element also has an OPTIONAL "avail" attribute which is 597 a boolean. If the value of this attribute evaluates to false, this 598 indicates that the server cannot calculate the relevant fees, because 599 the object, command, currency, period, class or some combination is 600 invalid per server policy. If "avail" is false then the or 601 the element MUST contain a element (as 602 described in Section 3.9) and the server MAY eliminate some or all of 603 the element(s). 605 The element(s) MAY have the following child elements: 607 o An OPTIONAL element (as described in Section 3.3), 608 which contains the same unit that appeared in the 609 element of the command. If the value of the preceding 610 element is "restore", this element MUST NOT be 611 included, otherwise it MUST be included. If no 612 appeared in the client command (and the command is not "restore") 613 then the server MUST return its default period value. 614 o Zero or more elements (as described in Section 3.4). 615 o Zero or more elements (as described in Section 3.4). 616 o An OPTIONAL element (as described in Section 3.9). 618 If the "avail" attribute of the element is true and if no 619 elements are present in a element, this 620 indicates that no fee will be assessed by the server for this 621 command. 623 If the "avail" attribute is true, then the element MUST 624 NOT contain a element. 626 Example response: 628 S: 629 S: 630 S: 631 S: 632 S: Command completed successfully 633 S: 634 S: 635 S: 637 S: 638 S: example.com 639 S: 640 S: 641 S: example.net 642 S: 643 S: 644 S: example.xyz 645 S: 646 S: 647 S: 648 S: 649 S: 651 S: USD 652 S: 653 S: example.com 654 S: Premium 655 S: 656 S: 2 657 S: 10.00 661 S: 662 S: 663 S: 1 664 S: 10.00 668 S: 669 S: 670 S: 1 671 S: 10.00 675 S: 676 S: 677 S: 15.00 679 S: 680 S: 681 S: 682 S: example.net 683 S: standard 684 S: 685 S: 2 686 S: 5.00 690 S: 691 S: 692 S: 1 693 S: 5.00 697 S: 698 S: 699 S: 1 700 S: 5.00 704 S: 705 S: 706 S: 5.00 708 S: 709 S: 710 S: 711 S: example.xyz 712 S: 713 S: 2 714 S: Only 1 year registration periods are 715 S: valid. 716 S: 717 S: 718 S: 719 S: 720 S: 721 S: ABC-12345 722 S: 54322-XYZ 723 S: 724 S: 725 S: 727 5.1.2. EPP Transfer Query Command 729 This extension does not add any elements to the EPP query 730 command, but does include elements in the response, when the 731 extension is included in the command service extensions. 733 When the query command has been processed successfully, if 734 the client has included the extension in the command service 735 element, and if the client is authorized by the server 736 to view information about the transfer, then the server MAY include 737 in the section of the EPP response a 738 element, which contains the following child elements: 740 o A element (as described in Section 3.2). 741 o A element (as described in Section 3.3). 742 o Zero or more elements (as described in Section 3.4) 743 containing the fees that will be charged to the gaining client. 744 o Zero or more elements (as described in Section 3.4) 745 containing the credits that will be refunded to the losing client. 747 Servers SHOULD omit when returning a response to the 748 gaining client, and omit elements when returning a response 749 to the losing client. 751 If no element is included in the response, then no fee 752 will be assessed by the server for the transfer. 754 Example query response: 756 S: 757 S: 758 S: 759 S: 760 S: Command completed successfully; action pending 761 S: 762 S: 763 S: 765 S: example.com 766 S: pending 767 S: ClientX 768 S: 2000-06-08T22:00:00.0Z 769 S: ClientY 770 S: 2000-06-13T22:00:00.0Z 771 S: 2002-09-08T22:00:00.0Z 772 S: 773 S: 774 S: 775 S: 776 S: USD 777 S: 1 778 S: 5.00 779 S: 780 S: 781 S: 782 S: ABC-12345 783 S: 54322-XYZ 784 S: 785 S: 786 S: 788 5.2. EPP Transform Commands 790 5.2.1. EPP Command 792 This extension adds elements to both the EPP command and 793 response, when the extension is included in the command 794 service extensions. 796 When submitting a command to the server, the client MAY 797 include in the element a element which 798 includes the following child elements: 800 o An OPTIONAL element (as described in Section 3.2); 801 o One or more elements (as described in Section 3.4). 803 The server MUST fail the command if the provided 804 by the client is less than the server fee. 806 When the command has been processed successfully, and the 807 client included the extension in the command service 808 extensions, and a fee was assessed by the server for the transaction, 809 the server MUST include in the section of the EPP 810 response a element, which contains the following child 811 elements: 813 o A element (as described in Section 3.2); 814 o Zero or more elements (as described in Section 3.4); 815 o Zero or more elements (as described in Section 3.4); 816 o An OPTIONAL element (as described in Section 3.5); 817 o An OPTIONAL element (as described in 818 Section 3.6). 820 Example command: 822 C: 823 C: 824 C: 825 C: 826 C: 828 C: example.com 829 C: 2 830 C: 831 C: ns1.example.net 832 C: ns2.example.net 833 C: 834 C: jd1234 835 C: sh8013 836 C: sh8013 837 C: 838 C: 2fooBAR 839 C: 840 C: 841 C: 842 C: 843 C: 844 C: USD 845 C: 5.00 846 C: 847 C: 848 C: ABC-12345 849 C: 850 C: 851 Example response: 853 S: 854 S: 855 S: 856 S: 857 S: Command completed successfully 858 S: 859 S: 860 S: 862 S: example.com 863 S: 1999-04-03T22:00:00.0Z 864 S: 2001-04-03T22:00:00.0Z 865 S: 866 S: 867 S: 868 S: 869 S: USD 870 S: 5.00 875 S: -5.00 876 S: 1000.00 877 S: 878 S: 879 S: 880 S: ABC-12345 881 S: 54321-XYZ 882 S: 883 S: 884 S: 886 5.2.2. EPP Command 888 This extension does not add any elements to the EPP command, 889 but does include elements in the response, when the extension is 890 included in the command service extensions. 892 When the command has been processed successfully, and the 893 client included the extension in the command service 894 extensions, the server MAY include in the section of the 895 EPP response a element, which contains the following 896 child elements: 898 o A element (as described in Section 3.2); 899 o Zero or more elements (as described in Section 3.4); 900 o Zero or more elements (as described in Section 3.4); 901 o An OPTIONAL element (as described in Section 3.5); 902 o An OPTIONAL element (as described in 903 Section 3.6). 905 Example response: 907 S: 908 S: 909 S: 910 S: 911 S: Command completed successfully 912 S: 913 S: 914 S: 916 S: USD 917 S: -5.00 920 S: 1005.00 921 S: 922 S: 923 S: 924 S: ABC-12345 925 S: 54321-XYZ 926 S: 927 S: 928 S: 930 5.2.3. EPP Command 932 This extension adds elements to both the EPP command and 933 response, when the extension is included in the command 934 service extensions. 936 When submitting a command to the server, the client MAY 937 include in the element a element which 938 includes the following child elements: 940 o An OPTIONAL element (as described in Section 3.2); 941 o One or more elements (as described in Section 3.4). 943 When the command has been processed successfully, and the 944 client included the extension in the command service 945 extensions, the server MAY include in the section of the 946 EPP response a element, which contains the following 947 child elements: 949 o A element (as described in Section 3.2); 950 o Zero or more elements (as described in Section 3.4); 951 o Zero or more elements (as described in Section 3.4); 952 o An OPTIONAL element (as described in Section 3.5); 953 o An OPTIONAL element (as described in 954 Section 3.6). 956 Example command: 958 C: 959 C: 960 C: 961 C: 962 C: 964 C: example.com 965 C: 2000-04-03 966 C: 5 967 C: 968 C: 969 C: 970 C: 971 C: USD 972 C: 5.00 973 C: 974 C: 975 C: ABC-12345 976 C: 977 C: 978 Example response: 980 S: 981 S: 982 S: 983 S: 984 S: Command completed successfully 985 S: 986 S: 987 S: 989 S: example.com 990 S: 2005-04-03T22:00:00.0Z 991 S: 992 S: 993 S: 994 S: 995 S: USD 996 S: 5.00 999 S: 1000.00 1000 S: 1001 S: 1002 S: 1003 S: ABC-12345 1004 S: 54322-XYZ 1005 S: 1006 S: 1007 S: 1009 5.2.4. EPP Command 1011 This extension adds elements to both the EPP command and 1012 response, when the value of the "op" attribute of the 1013 command element is "request", and the extension is included in the 1014 command service extensions. 1016 When submitting a command to the server, the client MAY 1017 include in the element a element which 1018 includes the following child elements: 1020 o An OPTIONAL element (as described in Section 3.2); 1021 o One or more elements (as described in Section 3.4). 1023 When the command has been processed successfully, and the 1024 client included the extension in the command service 1025 extensions, the server MAY include in the section of the 1026 EPP response a element, which contains the following 1027 child elements: 1029 o A element (as described in Section 3.2); 1030 o Zero or more elements (as described in Section 3.4); 1031 o Zero or more elements (as described in Section 3.4); 1032 o An OPTIONAL element (as described in Section 3.5); 1033 o An OPTIONAL element (as described in 1034 Section 3.6). 1036 Example command: 1038 C: 1039 C: 1040 C: 1041 C: 1042 C: 1044 C: example.com 1045 C: 1 1046 C: 1047 C: 2fooBAR 1048 C: 1049 C: 1050 C: 1051 C: 1052 C: 1053 C: USD 1054 C: 5.00 1055 C: 1056 C: 1057 C: ABC-12345 1058 C: 1059 C: 1060 Example response: 1062 S: 1063 S: 1064 S: 1065 S: 1066 S: Command completed successfully; action pending 1067 S: 1068 S: 1069 S: 1071 S: example.com 1072 S: pending 1073 S: ClientX 1074 S: 2000-06-08T22:00:00.0Z 1075 S: ClientY 1076 S: 2000-06-13T22:00:00.0Z 1077 S: 2002-09-08T22:00:00.0Z 1078 S: 1079 S: 1080 S: 1081 S: 1082 S: USD 1083 S: 5.00 1086 S: 1087 S: 1088 S: 1089 S: ABC-12345 1090 S: 54322-XYZ 1091 S: 1092 S: 1093 S: 1095 5.2.5. EPP Command 1097 This extension adds elements to both the EPP command and 1098 response, when the extension is included in the command 1099 service extensions. 1101 When submitting a command to the server, the client MAY 1102 include in the element a element which 1103 includes the following child elements: 1105 o An OPTIONAL element (as described in Section 3.2); 1106 o One or more elements (as described in Section 3.4). 1108 When the command has been processed successfully, and the 1109 client included the extension in the command service 1110 extensions, the server MAY include in the section of the 1111 EPP response a element, which contains the following 1112 child elements: 1114 o A element (as described in Section 3.2); 1115 o Zero or more elements (as described in Section 3.4); 1116 o Zero or more elements (as described in Section 3.4); 1117 o An OPTIONAL element (as described in Section 3.5); 1118 o An OPTIONAL element (as described in 1119 Section 3.6). 1121 Example command: 1123 C: 1124 C: 1125 C: 1126 C: 1127 C: 1129 C: example.com 1130 C: 1131 C: sh8013 1132 C: 1133 C: 1134 C: 1135 C: 1136 C: 1137 C: USD 1138 C: 5.00 1139 C: 1140 C: 1141 C: ABC-12345 1142 C: 1143 C: 1144 Example response: 1146 S: 1147 S: 1148 S: 1149 S: 1150 S: Command completed successfully 1151 S: 1152 S: 1153 S: 1154 S: USD 1155 S: 5.00 1156 S: 1157 S: 1158 S: 1159 S: ABC-12345 1160 S: 54321-XYZ 1161 S: 1162 S: 1163 S: 1165 6. Formal Syntax 1167 One schema is presented here that is the EPP Fee Extension schema. 1169 The formal syntax presented here is a complete schema representation 1170 of the object mapping suitable for automated validation of EPP XML 1171 instances. The BEGIN and END tags are not part of the schema; they 1172 are used to note the beginning and ending of the schema for URI 1173 registration purposes. 1175 6.1. Fee Extension Schema 1177 The formal syntax presented here is a complete schema representation 1178 of the object mapping suitable for automated validation of EPP XML 1179 instances. The BEGIN and END tags are not part of the schema; they 1180 are used to note the beginning and ending of the schema for URI 1181 registration purposes. 1183 BEGIN 1184 1185 1191 1192 1194 1195 1196 Extensible Provisioning Protocol v1.0 Fee Extension 1197 1198 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1213 1214 1215 1216 1218 1220 1221 1223 1224 1225 1226 1228 1229 1230 1232 1233 1234 1235 1236 1238 1240 1242 1243 1244 1245 1246 1248 1249 1250 1251 1253 1254 1255 1256 1258 1260 1262 1263 1265 1266 1267 1268 1270 1272 1274 1276 1278 1280 1281 1283 1284 1285 1286 1287 1289 1291 1292 1293 1295 1296 1297 1298 1299 1300 1302 1303 1304 1305 1306 1308 1310 1312 1313 1314 1315 1316 1318 1319 1320 1321 1322 1323 1324 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1343 1344 1345 1346 1347 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1368 1369 1370 1371 1372 1373 1374 1375 1377 1378 1379 1381 1382 1383 1385 1386 END 1388 7. Security Considerations 1390 The mapping extensions described in this document do not provide any 1391 security services beyond those described by EPP [RFC5730], the EPP 1392 domain name mapping [RFC5731], and protocol layers used by EPP. The 1393 security considerations described in these other specifications apply 1394 to this specification as well. This extension passes financial 1395 information using the EPP protocol, so confidentiality and integrity 1396 protection must be provided by the transport mechanism. All 1397 transports compliant with [RFC5730] provide the needed level of 1398 confidentiality and integrity protections. 1400 8. IANA Considerations 1402 8.1. XML Namespace 1404 This document uses URNs to describe XML namespaces and XML schemas 1405 conforming to a registry mechanism described in [RFC3688]. 1407 Registration request for the fee namespace: 1409 URI: urn:ietf:params:xml:ns:epp:fee-1.0 1411 Registrant Contact: IESG 1413 XML: None. Namespace URIs do not represent an XML specification. 1415 Registration request for the fee schema: 1417 URI: urn:ietf:params:xml:schema:epp:fee-1.0 1419 Registrant Contact: IESG 1421 XML: See the "Formal Syntax" section of this document. 1423 8.2. EPP Extension Registry 1425 The EPP extension described in this document should be registered by 1426 the IANA in the EPP Extension Registry described in [RFC7451]. The 1427 details of the registration are as follows: 1429 Name of Extension: Registry Fee Extension for the Extensible 1430 Provisioning Protocol (EPP) 1432 Document status: Standards Track 1433 Reference: (insert reference to RFC version of this document) 1435 Registrant Name and Email Address: IESG, 1437 TLDs: Any 1439 IPR Disclosure: None 1441 Status: Active 1443 Notes: None 1445 9. Implementation Status 1447 Note to RFC Editor: Please remove this section and the reference to 1448 [RFC7942] before publication. 1450 This section records the status of known implementations of the 1451 protocol defined by this specification at the time of posting of this 1452 Internet-Draft, and is based on a proposal described in [RFC7942]. 1453 The description of implementations in this section is intended to 1454 assist the IETF in its decision processes in progressing drafts to 1455 RFCs. Please note that the listing of any individual implementation 1456 here does not imply endorsement by the IETF. Furthermore, no effort 1457 has been spent to verify the information presented here that was 1458 supplied by IETF contributors. This is not intended as, and must not 1459 be construed to be, a catalog of available implementations or their 1460 features. Readers are advised to note that other implementations may 1461 exist. 1463 According to [RFC7942], "this will allow reviewers and working groups 1464 to assign due consideration to documents that have the benefit of 1465 running code, which may serve as evidence of valuable experimentation 1466 and feedback that have made the implemented protocols more mature. 1467 It is up to the individual working groups to use this information as 1468 they see fit". 1470 9.1. RegistryEngine EPP Service 1472 Organization: CentralNic 1474 Name: RegistryEngine EPP Service 1476 Description: Generic high-volume EPP service for gTLDs, ccTLDs and 1477 SLDs 1478 Level of maturity: Deployed in CentralNic's production environment as 1479 well as two other gTLD registry systems, and two ccTLD registry 1480 systems. 1482 Coverage: All aspects of the protocol are implemented. 1484 Licensing: Proprietary In-House software 1486 Contact: epp@centralnic.com 1488 URL: https://www.centralnic.com 1490 10. Acknowledgements 1492 The authors wish to thank the following persons for their feedback 1493 and suggestions: 1495 o James Gould of Verisign Inc 1496 o Luis Munoz of ISC 1497 o Michael Young of Architelos 1498 o Ben Levac and Jeff Eckhaus of Demand Media 1499 o Seth Goldman of Google 1500 o Klaus Malorny and Michael Bauland of Knipp 1501 o Jody Kolker, Joe Snitker and Kevin Allendorf of Go Daddy 1502 o Michael Holloway of Com Laude 1503 o Santosh Kalsangrah of Impetus Infotech 1504 o Alex Mayrhofer of Nic.at 1505 o Thomas Corte of Knipp Medien und Kommunikation GmbH 1507 11. Change History 1509 11.1. Change from 16 to 17 1511 Updated per AD review, all updates were just textual for clarity and 1512 correctness. 1514 11.2. Change from 15 to 16 1516 Updated per AD review and list comments: several grammar corrections; 1517 clarification text added to section 3.4.3 and 3.5; and a schema 1518 update for consistency by providing a "lang" attribute to the 1519 and "description" attribute detailed in 1520 section 3.4. 1522 11.3. Change from 14 to 15 1524 Updated schema, moving the "standard" attribute of the 1525 "commandDataType" inside the block. 1527 11.4. Change from 13 to 14 1529 Moved RFC 7451 reference from Normative to Informative section. 1531 11.5. Change from 12 to 13 1533 Updated XML namespace and schema registration to be "epp" scoped - 1534 global replace of XML namespace from urn:ietf:params:xml:ns:fee-1.0 1535 to urn:ietf:params:xml:ns:epp:fee-1.0 and the XML schema registration 1536 from urn:ietf:params:xml:schema:fee-1.0 to 1537 urn:ietf:params:xml:schema:epp:fee-1.0. 1539 11.6. Change from 11 to 12 1541 Updated references to current version of documents and moved the 1542 "standard" attribute from the check command (commandType) to the 1543 check response (commandDataType). 1545 11.7. Change from 10 to 11 1547 Updated document per Working Group Last Call comments. Made minor 1548 textual changes throughout for enhanced clarity per WGLC comments. 1550 11.8. Change from 09 to 10 1552 Updated document per Working Group Last Call comments. Updated 1553 schema to version 1.0 in anticipation of standardization, no changes 1554 were made to the latest, 0.25, schema. Made minor textual changes 1555 throughout for enhanced clarity per WGLC comments. 1557 11.9. Change from 08 to 09 1559 Updated scheme to version 0.25 to allow tighter checking on 1560 by splitting the client and server definitions, moved 1561 the class element from the command to the object level and added an 1562 optional standard attribute to the command element. Also updated 1563 section 3.1 for clarity on name attribute; updated section 3.9 for 1564 clarity on uses of ; removed second paragraph in section 1565 5.2.1 as it was duplicative of second to last paragraph in 4.0; and 1566 updated section 5.1.1 to add section references. 1568 11.10. Change from 07 to 08 1570 Updated section 3.8 and 5.1.1 to provide clarity on server processing 1571 and response of various scenarios (i.e. "quiet" period processing). 1573 11.11. Change from 06 to 07 1575 Updated section 3.8 and 4.0 to provide clarity on server processing 1576 and response of various scenarios. 1578 11.12. Change from 05 to 06 1580 Updated scheme to version 0.23 to allow the return of no 1581 element(s) if an error situation occurs. Edited 1582 section 3.8 extensively after input from interim meeting and REGEXT 1583 F2F meeting at IETF-99. Added normative reference for draft-ietf- 1584 eppext-launchphase. 1586 11.13. Change from 04 to 05 1588 Updated scheme to version 0.21 to support the lang attribute for the 1589 reason element of the objectCDType and the commandType types as well 1590 as to add the update command to the commandEnum type. Updated 1591 section 3.1 to include language for the custom command. Added 1592 section 3.9 to provide a description of the element. 1593 Fixed typos and added clarification text on when client fee is less 1594 than server fee in section 4. Additionally, I added description 1595 pointers to appropriate Section 3 definitions for element clarity 1596 throughout the document. 1598 11.14. Change from 03 to 04 1600 Updated scheme to version 0.19 to correct typos and to replace the 1601 commandTypeValue type with the commandEnum type and customName 1602 attribute for stricter validation. Updated various text for grammar 1603 and clarity. Added text to section 4 clarifying the response 1604 when the client provided no fee extension but the server was 1605 expecting the extension. 1607 11.15. Change from 02 to 03 1609 Updated scheme to version 0.17 to simplify the check command syntax. 1610 Moved fee avail to objectCDType to allow fast failing on error 1611 situations. Removed the objectCheckType as it was no longer being 1612 used. Updated examples to reflect these scheme changes. Added 1613 language for server failing a if the passed by the 1614 client is less than the server fee. 1616 11.16. Change from 01 to 02 1618 Updated scheme to version 0.15 to fix errors in CommandType, 1619 objectCDType, transformCommandType and transformResultType 1620 definitions. 1622 11.17. Change from 00 to 01 1624 Added Roger Carney as author to finish draft. Moved Formal Syntax 1625 section to main level numbering. Various grammar, typos, and 1626 administrative edits for clarity. Removed default value for the 1627 "applied" attribute of so that it can truly be optional. 1628 Added support for the command to return a element 1629 as well. Modified default response on the command for the 1630 optional when it was not provided in the command, 1631 leaving it to the server to provide the default period value. 1632 Extensive edits were done to the command, the 1633 response and to the fee extension schema (checkType, objectCheckType, 1634 objectIdentifierType, objectCDType, commandType) to support 1635 requesting and returning multiple transformation fees in a single 1636 call. Added section on Phase/Subphase to provide more context on the 1637 uses. 1639 11.18. Change from draft-brown-00 to draft-ietf-regext-fees-00 1641 Updated to be REGEXT WG document. 1643 12. References 1645 12.1. Normative References 1647 [ISO4217:2015] 1648 International Organization for Standardization, "Codes for 1649 the representation of currencies", August 2015, 1650 . 1652 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1653 Requirement Levels", BCP 14, RFC 2119, 1654 DOI 10.17487/RFC2119, March 1997, 1655 . 1657 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 1658 DOI 10.17487/RFC3688, January 2004, 1659 . 1661 [RFC3915] Hollenbeck, S., "Domain Registry Grace Period Mapping for 1662 the Extensible Provisioning Protocol (EPP)", RFC 3915, 1663 DOI 10.17487/RFC3915, September 2004, 1664 . 1666 [RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", 1667 STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009, 1668 . 1670 [RFC5731] Hollenbeck, S., "Extensible Provisioning Protocol (EPP) 1671 Domain Name Mapping", STD 69, RFC 5731, 1672 DOI 10.17487/RFC5731, August 2009, 1673 . 1675 [RFC7942] Sheffer, Y. and A. Farrel, "Improving Awareness of Running 1676 Code: The Implementation Status Section", BCP 205, 1677 RFC 7942, DOI 10.17487/RFC7942, July 2016, 1678 . 1680 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 1681 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 1682 May 2017, . 1684 [RFC8334] Gould, J., Tan, W., and G. Brown, "Launch Phase Mapping 1685 for the Extensible Provisioning Protocol (EPP)", RFC 8334, 1686 DOI 10.17487/RFC8334, March 2018, 1687 . 1689 12.2. Informative References 1691 [RFC7451] Hollenbeck, S., "Extension Registry for the Extensible 1692 Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451, 1693 February 2015, . 1695 Authors' Addresses 1697 Roger Carney 1698 GoDaddy Inc. 1699 14455 N. Hayden Rd. #219 1700 Scottsdale, AZ 85260 1701 US 1703 Email: rcarney@godaddy.com 1704 URI: http://www.godaddy.com 1705 Gavin Brown 1706 CentralNic Group plc 1707 35-39 Moorgate 1708 London, England EC2R 6AR 1709 GB 1711 Phone: +44 20 33 88 0600 1712 Email: gavin.brown@centralnic.com 1713 URI: http://www.centralnic.com 1715 Jothan Frakes 1717 Email: jothan@jothan.com 1718 URI: http://jothan.com