idnits 2.17.1 draft-ietf-regext-epp-fees-01.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 too long lines in the document, the longest one being 5 characters in excess of 72. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (March 3, 2017) is 2610 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) == Missing Reference: 'ISO4217' is mentioned on line 198, but not defined ** Obsolete normative reference: RFC 6982 (Obsoleted by RFC 7942) ** Downref: Normative reference to an Informational RFC: RFC 7451 Summary: 3 errors (**), 0 flaws (~~), 2 warnings (==), 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: September 4, 2017 CentralNic Group plc 6 J. Frakes 7 March 3, 2017 9 Registry Fee Extension for the Extensible Provisioning Protocol (EPP) 10 draft-ietf-regext-epp-fees-01 12 Abstract 14 This document describes an Extensible Provisioning Protocol (EPP) 15 extension mapping for registry fees. 17 Status of This Memo 19 This Internet-Draft is submitted in full conformance with the 20 provisions of BCP 78 and BCP 79. 22 Internet-Drafts are working documents of the Internet Engineering 23 Task Force (IETF). Note that other groups may also distribute 24 working documents as Internet-Drafts. The list of current Internet- 25 Drafts is at http://datatracker.ietf.org/drafts/current/. 27 Internet-Drafts are draft documents valid for a maximum of six months 28 and may be updated, replaced, or obsoleted by other documents at any 29 time. It is inappropriate to use Internet-Drafts as reference 30 material or to cite them other than as "work in progress." 32 This Internet-Draft will expire on September 4, 2017. 34 Copyright Notice 36 Copyright (c) 2017 IETF Trust and the persons identified as the 37 document authors. All rights reserved. 39 This document is subject to BCP 78 and the IETF Trust's Legal 40 Provisions Relating to IETF Documents 41 (http://trustee.ietf.org/license-info) in effect on the date of 42 publication of this document. Please review these documents 43 carefully, as they describe your rights and restrictions with respect 44 to this document. Code Components extracted from this document must 45 include Simplified BSD License text as described in Section 4.e of 46 the Trust Legal Provisions and are provided without warranty as 47 described in the Simplified BSD License. 49 Table of Contents 51 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 52 1.1. Conventions Used in This Document . . . . . . . . . . . . 3 53 2. Migrating to Newer Versions of This Extension . . . . . . . . 4 54 3. Extension Elements . . . . . . . . . . . . . . . . . . . . . 4 55 3.1. Client Commands . . . . . . . . . . . . . . . . . . . . . 4 56 3.2. Currency Codes . . . . . . . . . . . . . . . . . . . . . 5 57 3.3. Validity Periods . . . . . . . . . . . . . . . . . . . . 5 58 3.4. Fees and Credits . . . . . . . . . . . . . . . . . . . . 5 59 3.4.1. Refunds . . . . . . . . . . . . . . . . . . . . . . . 6 60 3.4.2. Grace Periods . . . . . . . . . . . . . . . . . . . . 6 61 3.4.3. Correlation between Refundability and Grace Periods . 7 62 3.4.4. Applicability . . . . . . . . . . . . . . . . . . . . 7 63 3.5. Account Balance . . . . . . . . . . . . . . . . . . . . . 7 64 3.6. Credit Limit . . . . . . . . . . . . . . . . . . . . . . 7 65 3.7. Classification of Objects . . . . . . . . . . . . . . . . 8 66 3.8. Phase and Subphase Attributes . . . . . . . . . . . . . . 8 67 4. Server Handling of Fee Information . . . . . . . . . . . . . 9 68 5. EPP Command Mapping . . . . . . . . . . . . . . . . . . . . . 9 69 5.1. EPP Query Commands . . . . . . . . . . . . . . . . . . . 9 70 5.1.1. EPP Command . . . . . . . . . . . . . . . . . 9 71 5.1.1.1. Server Handling of Elements . . . . . . . . . . . 14 72 5.1.2. EPP Transfer Query Command . . . . . . . . . . . . . 15 73 5.2. EPP Transform Commands . . . . . . . . . . . . . . . . . 16 74 5.2.1. EPP Command . . . . . . . . . . . . . . . . 16 75 5.2.2. EPP Command . . . . . . . . . . . . . . . . 19 76 5.2.3. EPP Command . . . . . . . . . . . . . . . . . 20 77 5.2.4. EPP Command . . . . . . . . . . . . . . . 22 78 5.2.5. EPP Command . . . . . . . . . . . . . . . . 24 79 6. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 26 80 6.1. Fee Extension Schema . . . . . . . . . . . . . . . . . . 26 81 7. Security Considerations . . . . . . . . . . . . . . . . . . . 30 82 8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 31 83 8.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 31 84 8.2. EPP Extension Registry . . . . . . . . . . . . . . . . . 31 85 9. Implemntation Status . . . . . . . . . . . . . . . . . . . . 31 86 9.1. RegistryEngine EPP Service . . . . . . . . . . . . . . . 32 87 10. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 32 88 11. Change History . . . . . . . . . . . . . . . . . . . . . . . 33 89 11.1. Change from 00 to 01 . . . . . . . . . . . . . . . . . . 33 90 11.2. Change from draft-brown-00 to draft-ietf-regext-fees-00 33 91 12. Normative References . . . . . . . . . . . . . . . . . . . . 33 92 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 34 94 1. Introduction 96 Historically, domain name registries have applied a simple fee 97 structure for billable transactions, namely a basic unit price 98 applied to domain , , and RGP [RFC3915] 99 restore commands. Given the relatively small number of EPP servers 100 to which EPP clients have been required to connect, it has generally 101 been the case that client operators have been able to obtain details 102 of these fees out-of-band by contacting the server operators. 104 Given the recent expansion of the DNS namespace, and the 105 proliferation of novel business models, it is now desirable to 106 provide a method for EPP clients to query EPP servers for the fees 107 and credits associated with certain commands and specific objects. 109 This document describes an extension mapping for version 1.0 of the 110 Extensible Provisioning Protocol (EPP) [RFC5730]. This EPP mapping 111 provides a mechanism by which EPP clients may query the fees and 112 credits associated with various billable transactions, and also 113 obtain their current account balance. 115 1.1. Conventions Used in This Document 117 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 118 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 119 document are to be interpreted as described in RFC 2119 [RFC2119]. 121 XML is case sensitive. Unless stated otherwise, XML specifications 122 and examples provided in this document MUST be interpreted in the 123 character case presented in order to develop a conforming 124 implementation. 126 "fee" is used as an abbreviation for "urn:ietf:params:xml:ns:fee- 127 0.13". The XML namespace prefix "fee" is used, but implementations 128 MUST NOT depend on it and instead employ a proper namespace-aware XML 129 parser and serializer to interpret and output the XML documents. 131 In examples, "C:" represents lines sent by a protocol client and "S:" 132 represents lines returned by a protocol server. Indentation and 133 white space in examples are provided only to illustrate element 134 relationships and are not a REQUIRED feature of this protocol. 136 (Note to RFC Editor: remove the following paragraph before 137 publication as an RFC.) 139 The XML namespace prefix above contains a version number, 140 specifically "0.1". This version number will increment with 141 successive versions of this document, and will reach 1.0 if and when 142 this document is published as an RFC. This permits clients to 143 distinguish which version of the extension a server has implemented. 145 2. Migrating to Newer Versions of This Extension 147 (Note to RFC Editor: remove this section before publication as an 148 RFC.) 150 Servers which implement this extension SHOULD provide a way for 151 clients to progressively update their implementations when a new 152 version of the extension is deployed. 154 Servers SHOULD (for a temporary migration period) provide support for 155 older versions of the extension in parallel to the newest version, 156 and allow clients to select their preferred version via the 157 element of the command. 159 If a client requests multiple versions of the extension at login, 160 then, when preparing responses to commands which do not include 161 extension elements, the server SHOULD only include extension elements 162 in the namespace of the newest version of the extension requested by 163 the client. 165 When preparing responses to commands which do include extension 166 elements, the server SHOULD only include extension elements for the 167 extension versions present in the command. 169 3. Extension Elements 171 3.1. Client Commands 173 The element is used in the EPP command to 174 determine the fee which is applicable to the given command. 176 The list of values include: 178 o "create" indicating a command as defined in [RFC5730]; 179 o "delete" indicating a command as defined in [RFC5730]; 180 o "renew" indicating a command as defined in [RFC5730]; 181 o "update" indicating a command as defined in [RFC5730]; 182 o "transfer" indicating a command as defined in 183 [RFC5730]; 184 o If the server supports the Registry Grace Period Mapping 185 [RFC3915], then the server MUST also support the "restore" value 186 as defined in [RFC3915]. 188 The element MAY have an OPTIONAL "phase" attribute 189 specifying a launch phase as described in [draft-ietf-eppext- 190 launchphase]. It may also contain an OPTIONAL "subphase" attribute 191 identifying the custom or sub-phase as described in [draft-ietf- 192 eppext-launchphase]. 194 3.2. Currency Codes 196 The element is used to indicate which currency fees 197 are charged in. This value of this element MUST be a three-character 198 currency code from [ISO4217]. 200 Note that ISO 4217 provides the special "XXX" code, which MAY be used 201 if the server uses a non-currency based system for assessing fees, 202 such as a system of credits. 204 The use of elements in commands is OPTIONAL: if a 205 element is not present in a command, the server MUST 206 determine the currency based on the client's account settings which 207 MUST be agreed by the client and server via an out-of-band channel. 208 However, the element MUST be present in responses. 210 Servers SHOULD NOT perform a currency conversion if a client uses an 211 incorrect currency code. Servers SHOULD return a 2004 "Parameter 212 value range" error instead. 214 3.3. Validity Periods 216 When querying for fee information using the command, the 217 element is used to indicate the units to be added to the 218 registration period of objects by the , and 219 commands. This element is derived from the 220 element described in [RFC5731]. 222 The element is OPTIONAL in commands: if omitted, 223 the server MUST determine the fee(s) using a validity period of 1 224 year. The element MUST be present in responses. 226 3.4. Fees and Credits 228 Servers which implement this extension will include elements in 229 responses which provide information about the fees and/or credits 230 associated with a given billable transaction. 232 The and elements are used to provide this 233 information. The presence of a element in a response 234 indicates a debit against the client's account balance; a 235 element indicates a credit. A element MUST 236 have a non-negative value. A element MUST have a 237 negative value. 239 A server MAY respond with multiple and 240 elements in the same response. In such cases, the net fee or credit 241 applicable to the transaction is the arithmetic sum of the values of 242 each of the and/or elements. This amount 243 applies to the total additional validity period applied to the object 244 (where applicable) rather than to any incremental unit. 246 The following attributes are defined for the element. 247 These are described in detail below: 249 description: an OPTIONAL attribute which provides a human-readable 250 description of the fee. Servers should provide documentation on the 251 possible values of this attribute, and their meanings. 253 refundable: an OPTIONAL boolean attribute indicating whether the fee 254 is refundable if the object is deleted. 256 grace-period: an OPTIONAL attribute which provides the time period 257 during which the fee is refundable. 259 applied: an OPTIONAL attribute indicating when the fee will be 260 deducted from the client's account. 262 The element can take a "description" attribute as 263 described above. No other attributes are defined for this element. 265 3.4.1. Refunds 267 elements MAY have an OPTIONAL "refundable" attribute which 268 takes a boolean value. Fees may be refunded under certain 269 circumstances, such as when a domain application is rejected (as 270 described in [draft-ietf-eppext-launchphase]) or when an object is 271 deleted during the relevant Grace Period (see below). 273 If the "refundable" attribute is omitted, then clients SHOULD NOT 274 make any assumption about the refundability of the fee. 276 3.4.2. Grace Periods 278 [RFC3915] describes a system of "grace periods", which are time 279 periods following a billable transaction during which, if an object 280 is deleted, the client receives a refund. 282 The "grace-period" attribute MAY be used to indicate the relevant 283 grace period for a fee. If a server implements the Registry Grace 284 Period extension, it MUST specify the grace period for all relevant 285 transactions. 287 If the "grace-period" attribute is omitted, then clients SHOULD NOT 288 make any assumption about the grace period of the fee. 290 3.4.3. Correlation between Refundability and Grace Periods 292 If a element has a "grace-period" attribute then it MUST 293 also be refundable. If the "refundable" attribute of a 294 element is false then it MUST NOT have a "grace-period" attribute. 296 3.4.4. Applicability 298 Fees may be applied immediately upon receipt of a command from a 299 client, or may only be applied once an out-of-band process (such as 300 the processing of applications at the end of a launch phase) has 301 taken place. 303 The "applied" attribute of the element allows servers to 304 indicate whether a fee will be applied immediately, or whether it 305 will be applied at some point in the future. This attribute takes 306 two possible values: "immediate" or "delayed". 308 3.5. Account Balance 310 The element is an OPTIONAL element which MAY be 311 included in server responses to transform commands. If present, it 312 can be used by the client to determine the remaining credit at the 313 server. 315 Whether or not the is included in responses is a matter 316 of server policy. However, if a server chooses to offer support for 317 this element, it MUST be included in responses to all "transform" or 318 billable commands (ie , , , , 319 ). 321 The value of the MAY be negative. A negative balance 322 indicates that the server has extended a line of credit to the client 323 (see below). 325 If a server includes a element in response to transform 326 commands, the value of the element MUST reflect the client's account 327 balance after any fees or credits associated with that command have 328 been applied. 330 3.6. Credit Limit 332 As described above, if a server returns a response containing a 333 with a negative value, then the server has extended a 334 line of credit to the client. A server MAY also include a 335 element in responses which indicates the maximum 336 credit available to a client. A server MAY reject certain 337 transactions if the absolute value of the is equal to 338 or exceeds the value of the element. 340 Whether or not the is included in responses is a 341 matter of server policy. However, if a server chooses to offer 342 support for this element, it MUST be included in responses to all 343 "transform" commands (ie , , , , 344 ). 346 3.7. Classification of Objects 348 Objects may be assigned to a particular class, category, or tier, 349 each of which has a particular fee or set of fees associated with it. 350 The element which appears in responses is used to 351 indicate the classification of an object. 353 If a server makes use of this element, it should provide clients with 354 a list of all the values that the element may take via an out-of-band 355 channel. Servers MUST NOT use values which do not appear on this 356 list. 358 Servers which make use of this element MUST use a element 359 with the value "standard" for all objects that are subject to the 360 standard or default fee. 362 3.8. Phase and Subphase Attributes 364 The element has two attributes, phase and subphase, 365 that provide additional information related to a specific launch 366 phase as described in [draft-ietf-eppext-launchphase]. 368 If the client contains no phase attribute the server 369 SHOULD return data (including the phase/subphase attribute(s)) for 370 all valid server combinations of currently active phase(s) and active 371 subphase(s). 373 If the client contains a server supported combination 374 of phase/subphase the server MUST return fee data (including the 375 phase/subphase attribute(s)) for the specific combination(s). 377 If the client contains a phase attribute with no 378 subphase, the server SHOULD return data (including the phase/subphase 379 attribute(s)) for all valid server combinations of provided phase and 380 available subphase(s). 382 If the client contains a subphase with no phase 383 attribute the server MUST respond with a 2003 "Required parameter 384 missing" error. 386 If the client contains a phase attribute not defined in 387 [draft-ietf-eppext-launchphase] or not supported by server the server 388 MUST respond with a 2004 "Parameter value range" error. 390 If the client contains a subphase attribute (or phase/ 391 subphase combination) not supported by server the server MUST respond 392 with a 2004 "Parameter value range" error. 394 4. Server Handling of Fee Information 396 Depending on server policy, a client MAY be required to include the 397 extension elements described in this document for certain transform 398 commands. Servers must provide clear documentation to clients about 399 the circumstances in which this extension must be used. 401 If a server receives a command from a client which does not include 402 the extension elements required by the server for that command, then 403 it MUST respond with a 2003 "Required parameter missing" error. 405 If the currency or total fee provided by the client do not agree with 406 the server's own calculation of the fee for that command, then the 407 server MUST reject the command with a 2004 "Parameter value range" 408 error. 410 5. EPP Command Mapping 412 A detailed description of the EPP syntax and semantics can be found 413 in [RFC5730]. 415 5.1. EPP Query Commands 417 This extension does not add any elements to the EPP or 418 commands or responses. 420 5.1.1. EPP Command 422 This extension defines additional elements for the EPP 423 command. 425 The command MAY contain an element which MAY contain a 426 element. The element MUST contain one or 427 more elements containing the following child elements: 429 o A element that MUST match one and only one of the 430 domain names in the ; 431 o An OPTIONAL element. If the server does not 432 support value, it MUST return a 2306 error 433 response; 434 o One or more element(s) with a "name" attribute, an 435 OPTIONAL "phase" attribute, and an OPTIONAL "subphase" attribute. 437 The element(s) MAY have the following child elements: 439 o An OPTIONAL element. 440 o An OPTIONAL element. 442 Example command: 444 C: 445 C: 446 C: 447 C: 448 C: 450 C: example.com 451 C: example.net 452 C: example.xyz 453 C: 454 C: 455 C: 456 C: 457 C: 458 C: example.com 459 C: USD 460 C: 461 C: 2 462 C: 463 C: 464 C: 465 C: 466 C: 467 C: 468 C: example.net 469 C: USD 470 C: 471 C: 11 472 C: 473 C: 474 C: 475 C: 476 C: 477 C: ABC-12345 478 C: 479 C: 481 When the server receives a command that includes the 482 extension elements described above, its response MUST contain an 483 element, which MUST contain a child 484 element. The element MUST contain a element 485 for each object element referenced in the 486 element of the client command. 488 Each element MUST contain the following child elements: 490 o A element, which MUST match a from the 491 client command. 492 o A element, which contains the same currency code 493 that appeared in the element of the command. If no 494 element appeared in the command, then the client's 495 default billing currency should be used. 496 o A element matching each that appeared 497 in the corresponding of the command. If a 498 element in the client command contains no 499 element the server SHOULD return a 500 element for each server billable transaction combination of the 501 . This element MAY have the OPTIONAL "phase" and 502 "subphase" attributes, which MUST match the same attributes in the 503 corresponding element of the client command. 505 The element also has an OPTIONAL "avail" attribute 506 which is a boolean. If the value of this attribute evaluates to 507 false, this indicates that the server cannot calculate the relevant 508 fees, because the object, command, currency, period or class is 509 invalid according to server policy. 511 The element(s) MAY have the following child elements: 513 o An OPTIONAL element, which contains the same unit 514 that appeared in the element of the command. If the 515 value of the preceding element is "restore", this 516 element MUST NOT be included. Otherwise it MUST be included. If 517 no appeared in command (and the command is not 518 "restore") then the server MUST return its default period value. 519 o Zero or more elements. 520 o Zero or more elements. 521 o An OPTIONAL element. 522 o An OPTIONAL element. 524 If no elements are present in a element, this 525 indicates that no fee will be assessed by the server for this 526 command. 528 If the "avail" attribute of the element is false, then 529 the element MUST NOT contain any or 530 child elements. If the "avail" attribute is true, then 531 the element MUST NOT contain a element. 533 Example response: 535 S: 536 S: 537 S: 538 S: 539 S: Command completed successfully 540 S: 541 S: 542 S: 544 S: 545 S: example.com 546 S: 547 S: 548 S: example.net 549 S: 550 S: 551 S: example.xyz 552 S: 553 S: 554 S: 555 S: 556 S: 559 S: 560 S: example.com 561 S: USD 562 S: 563 S: 2 564 S: 10.00 568 S: 569 S: 570 S: 1 571 S: 5.00 575 S: 576 S: 577 S: 1 578 S: 5.00 582 S: 583 S: 584 S: 5.00 586 S: 587 S: 588 S: 589 S: example.net 590 S: USD 591 S: 592 S: Maximum period is 10 years 593 S: 594 S: 595 S: 1 596 S: 5.00 600 S: 601 S: 602 S: 603 S: 604 S: 605 S: ABC-12345 606 S: 54322-XYZ 607 S: 608 S: 609 S: 611 5.1.1.1. Server Handling of Elements 613 Clients MAY include a in the element. 614 There are three ways in which servers may handle this element: 616 1. If the server supports the concept of tiers or classes of 617 objects, then the value of this element MUST be validated. If 618 incorrect for the specified object, the "avail" attribute of the 619 corresponding element MUST be false. 620 2. If the server supports different "types" of object registrations 621 (such as a "blocking" registration which does not resolve, or 622 where a registry provides a value-added service that requires an 623 opt-out to disable), then, as with the first model, the server 624 MUST validate the value of the element. If the value is 625 incorrect, the "avail" attribute of the corresponding 626 element MUST be false. 627 3. If the server supports neither of the above models, the element 628 MUST be ignored. 630 Server operators must provide clear documentation to client operators 631 which of the above models it supports. 633 5.1.2. EPP Transfer Query Command 635 This extension does not add any elements to the EPP query 636 command, but does include elements in the response, when the 637 extension has been selected during a command. 639 When the query command has been processed successfully, 640 the client selected the extension when it logged in, and the client 641 is authorised by the server to view information about the transfer, 642 the server MAY include in the section of the EPP response 643 a element, which contains the following child elements: 645 o A element. 646 o A element. 647 o Zero or more elements containing the fees that will be 648 charged to the gaining client. 649 o Zero or more elements containing the credits that 650 will be refunded to the losing client. 652 Servers SHOULD omit when returning a response to the 653 gaining client, and omit elements when returning a response 654 to the losing client. 656 If no element is included in the response, then no fee 657 will be assessed by the server for the transfer. 659 Example query response: 661 S: 662 S: 663 S: 664 S: 665 S: Command completed successfully; action pending 666 S: 667 S: 668 S: 670 S: example.com 671 S: pending 672 S: ClientX 673 S: 2000-06-08T22:00:00.0Z 674 S: ClientY 675 S: 2000-06-13T22:00:00.0Z 676 S: 2002-09-08T22:00:00.0Z 677 S: 678 S: 679 S: 680 S: 681 S: USD 682 S: 1 683 S: 5.00 684 S: 685 S: 686 S: 687 S: ABC-12345 688 S: 54322-XYZ 689 S: 690 S: 691 S: 693 5.2. EPP Transform Commands 695 5.2.1. EPP Command 697 This extension adds elements to both the EPP command and 698 response, when the extension has been selected during a 699 command. 701 If a command is received with no extension and 702 the server requires a extension for the 703 the server MUST respond with a 2003 "Required parameter missing" 704 error. 706 When submitting a command to the server, the client MAY 707 include in the element a element which 708 includes the following child elements: 710 o An OPTIONAL element; 711 o One or more elements. 713 When the command has been processed successfully, and the 714 client selected the extension when it logged in, and a fee was 715 assessed by the server for the transaction, the server MUST include 716 in the section of the EPP response a 717 element, which contains the following child elements: 719 o A element; 720 o Zero or more elements; 721 o Zero or more elements; 722 o An OPTIONAL element; 723 o An OPTIONAL element. 725 Example command: 727 C: 728 C: 729 C: 730 C: 731 C: 733 C: example.com 734 C: 2 735 C: 736 C: ns1.example.net 737 C: ns2.example.net 738 C: 739 C: jd1234 740 C: sh8013 741 C: sh8013 742 C: 743 C: 2fooBAR 744 C: 745 C: 746 C: 747 C: 748 C: 749 C: USD 750 C: 5.00 751 C: 752 C: 753 C: ABC-12345 754 C: 755 C: 756 Example response: 758 S: 759 S: 760 S: 761 S: 762 S: Command completed successfully 763 S: 764 S: 765 S: 767 S: example.com 768 S: 1999-04-03T22:00:00.0Z 769 S: 2001-04-03T22:00:00.0Z 770 S: 771 S: 772 S: 773 S: 774 S: USD 775 S: 5.00 779 S: -5.00 780 S: 1000.00 781 S: 782 S: 783 S: 784 S: ABC-12345 785 S: 54321-XYZ 786 S: 787 S: 788 S: 790 5.2.2. EPP Command 792 This extension does not add any elements to the EPP command, 793 but does include elements in the response, when the extension has 794 been selected during the command. 796 When the command has been processed successfully, and the 797 client selected the extension when it logged in, the server MAY 798 include in the section of the EPP response a 799 element, which contains the following child elements: 801 o A element; 802 o Zero or more elements; 803 o Zero or more elements; 804 o An OPTIONAL element; 805 o An OPTIONAL element. 807 Example response: 809 S: 810 S: 811 S: 812 S: 813 S: Command completed successfully 814 S: 815 S: 816 S: 818 S: USD 819 S: -5.00 820 S: 1005.00 821 S: 822 S: 823 S: 824 S: ABC-12345 825 S: 54321-XYZ 826 S: 827 S: 828 S: 830 5.2.3. EPP Command 832 This extension adds elements to both the EPP command and 833 response, when the extension has been selected during a 834 command. 836 When submitting a command to the server, the client MAY 837 include in the element a element which 838 includes the following child elements: 840 o An OPTIONAL element; 841 o One or more elements. 843 When the command has been processed successfully, and the 844 client selected the extension when it logged in, the server MAY 845 include in the section of the EPP response a 846 element, which contains the following child elements: 848 o A element; 849 o Zero or more elements; 850 o Zero or more elements; 851 o An OPTIONAL element; 852 o An OPTIONAL element. 854 Example command: 856 C: 857 C: 858 C: 859 C: 860 C: 862 C: example.com 863 C: 2000-04-03 864 C: 5 865 C: 866 C: 867 C: 868 C: 869 C: USD 870 C: 5.00 871 C: 872 C: 873 C: ABC-12345 874 C: 875 C: 876 Example response: 878 S: 879 S: 880 S: 881 S: 882 S: Command completed successfully 883 S: 884 S: 885 S: 887 S: example.com 888 S: 2005-04-03T22:00:00.0Z 889 S: 890 S: 891 S: 892 S: 893 S: USD 894 S: 5.00 897 S: 1000.00 898 S: 899 S: 900 S: 901 S: ABC-12345 902 S: 54322-XYZ 903 S: 904 S: 905 S: 907 5.2.4. EPP Command 909 This extension adds elements to both the EPP command and 910 response, when the value of the "op" attribute of the 911 command element is "request", and the extension has been selected 912 during the command. 914 When submitting a command to the server, the client MAY 915 include in the element a element which 916 includes the following child elements: 918 o An OPTIONAL element; 919 o One or more elements. 921 When the command has been processed successfully, and the 922 client selected the extension when it logged in, the server MAY 923 include in the section of the EPP response a 924 element, which contains the following child elements: 926 o A element; 927 o Zero or more elements; 928 o Zero or more elements; 929 o An OPTIONAL element; 930 o An OPTIONAL element. 932 Example command: 934 C: 935 C: 936 C: 937 C: 938 C: 940 C: example.com 941 C: 1 942 C: 943 C: 2fooBAR 944 C: 945 C: 946 C: 947 C: 948 C: 949 C: USD 950 C: 5.00 951 C: 952 C: 953 C: ABC-12345 954 C: 955 C: 956 Example response: 958 S: 959 S: 960 S: 961 S: 962 S: Command completed successfully; action pending 963 S: 964 S: 965 S: 967 S: example.com 968 S: pending 969 S: ClientX 970 S: 2000-06-08T22:00:00.0Z 971 S: ClientY 972 S: 2000-06-13T22:00:00.0Z 973 S: 2002-09-08T22:00:00.0Z 974 S: 975 S: 976 S: 977 S: 978 S: USD 979 S: 5.00 982 S: 983 S: 984 S: 985 S: ABC-12345 986 S: 54322-XYZ 987 S: 988 S: 989 S: 991 5.2.5. EPP Command 993 This extension adds elements to both the EPP command and 994 response, when the extension has been selected during the 995 command. 997 When submitting a command to the server, the client MAY 998 include in the element a element which 999 includes the following child elements: 1001 o An OPTIONAL element; 1002 o One or more elements. 1004 When the command has been processed successfully, and the 1005 client selected the extension when it logged in, the server MAY 1006 include in the section of the EPP response a 1007 element, which contains the following child elements: 1009 o A element; 1010 o Zero or more elements; 1011 o Zero or more elements; 1012 o An OPTIONAL element; 1013 o An OPTIONAL element. 1015 Example command: 1017 C: 1018 C: 1019 C: 1020 C: 1021 C: 1023 C: example.com 1024 C: 1025 C: sh8013 1026 C: 1027 C: 1028 C: 1029 C: 1030 C: 1031 C: USD 1032 C: 5.00 1033 C: 1034 C: 1035 C: ABC-12345 1036 C: 1037 C: 1038 Example response: 1040 S: 1041 S: 1042 S: 1043 S: 1044 S: Command completed successfully 1045 S: 1046 S: 1047 S: 1048 S: USD 1049 S: 5.00 1050 S: 1051 S: 1052 S: 1053 S: ABC-12345 1054 S: 54321-XYZ 1055 S: 1056 S: 1057 S: 1059 6. Formal Syntax 1061 One schema is presented here that is the EPP Fee Extension schema. 1063 The formal syntax presented here is a complete schema representation 1064 of the object mapping suitable for automated validation of EPP XML 1065 instances. The BEGIN and END tags are not part of the schema; they 1066 are used to note the beginning and ending of the schema for URI 1067 registration purposes. 1069 6.1. Fee Extension Schema 1071 BEGIN 1072 1073 1080 1081 1083 1084 1085 Extensible Provisioning Protocol v1.0 Fee Extension 1087 1088 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1103 1104 1105 1106 1108 1109 1111 1112 1113 1114 1116 1117 1118 1120 1121 1122 1123 1125 1126 1127 1129 1130 1131 1132 1134 1136 1138 1139 1140 1141 1142 1143 1144 1146 1147 1148 1149 1151 1153 1154 1156 1157 1158 1159 1161 1163 1165 1167 1168 1170 1171 1172 1173 1175 1176 1179 1181 1183 1185 1187 1188 1189 1190 1191 1192 1194 1195 1196 1197 1199 1201 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1215 1216 1217 1218 1219 1220 1222 1223 1224 1225 1226 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1251 1252 1253 1254 1255 1256 1257 1259 1260 1261 1263 1264 1265 1267 1268 END 1270 7. Security Considerations 1272 The mapping extensions described in this document do not provide any 1273 security services beyond those described by EPP [RFC5730], the EPP 1274 domain name mapping [RFC5731], and protocol layers used by EPP. The 1275 security considerations described in these other specifications apply 1276 to this specification as well. 1278 8. IANA Considerations 1280 8.1. XML Namespace 1282 This document uses URNs to describe XML namespaces and XML schemas 1283 conforming to a registry mechanism described in [RFC3688]. The 1284 following URI assignment is requested of IANA: 1286 URI: ietf:params:xml:ns:fee-0.13 1288 Registrant Contact: See the "Author's Address" section of this 1289 document. 1291 XML: See the "Formal Syntax" section of this document. 1293 8.2. EPP Extension Registry 1295 The EPP extension described in this document should be registered by 1296 the IANA in the EPP Extension Registry described in [RFC7451]. The 1297 details of the registration are as follows: 1299 Name of Extension: EPP Fee Extension 1301 Document status: Standards Track 1303 Reference: (insert reference to RFC version of this document) 1305 Registrant Name and Email Address: See the "Author's Address" section 1306 of this document. 1308 TLDs: any 1310 IPR Disclosure: none 1312 Status: active 1314 Notes: none 1316 9. Implemntation Status 1318 Note to RFC Editor: Please remove this section and the reference to 1319 [RFC6982] before publication. 1321 This section records the status of known implementations of the 1322 protocol defined by this specification at the time of posting of this 1323 Internet-Draft, and is based on a proposal described in [RFC6982]. 1324 The description of implementations in this section is intended to 1325 assist the IETF in its decision processes in progressing drafts to 1326 RFCs. Please note that the listing of any individual implementation 1327 here does not imply endorsement by the IETF. Furthermore, no effort 1328 has been spent to verify the information presented here that was 1329 supplied by IETF contributors. This is not intended as, and must not 1330 be construed to be, a catalog of available implementations or their 1331 features. Readers are advised to note that other implementations may 1332 exist. 1334 According to [RFC6982], "this will allow reviewers and working groups 1335 to assign due consideration to documents that have the benefit of 1336 running code, which may serve as evidence of valuable experimentation 1337 and feedback that have made the implemented protocols more mature. 1338 It is up to the individual working groups to use this information as 1339 they see fit". 1341 9.1. RegistryEngine EPP Service 1343 Organization: CentralNic 1345 Name: RegistryEngine EPP Service 1347 Description: Generic high-volume EPP service for gTLDs, ccTLDs and 1348 SLDs 1350 Level of maturity: Deployed in CentralNic's production environment as 1351 well as two other gTLD registry systems, and two ccTLD registry 1352 systems. 1354 Coverage: All aspects of the protocol are implemented. 1356 Licensing: Proprietary In-House software 1358 Contact: epp@centralnic.com 1360 URL: https://www.centralnic.com 1362 10. Acknowledgements 1364 The authors wish to thank the following persons for their feedback 1365 and suggestions: 1367 o James Gould of Verisign Inc 1368 o Luis Munoz of ISC 1369 o Michael Young of Architelos 1370 o Ben Levac and Jeff Eckhaus of Demand Media 1371 o Seth Goldman of Google 1372 o Klaus Malorny and Michael Bauland of Knipp 1373 o Jody Kolker, Joe Snitker and Kevin Allendorf of Go Daddy 1374 o Michael Holloway of Com Laude 1375 o Santosh Kalsangrah of Impetus Infotech 1376 o Alex Mayrhofer of Nic.at 1378 11. Change History 1380 11.1. Change from 00 to 01 1382 Added Roger Carney as author to finish draft. Moved Formal Syntax 1383 section to main level numbering. Various grammar, typos, and 1384 administrative edits for clarity. Removed default value for the 1385 "applied" attribute of so that it can truly be optional. 1386 Added support for the command to return a element 1387 as well. Modified default response on the command for the 1388 optional when it was not provided in the command, 1389 leaving it to the server to provide the default period value. 1390 Extensive edits were done to the command, the 1391 response and to the fee extension schema (checkType, objectCheckType, 1392 objectIdentifierType, objectCDType, commandType) to support 1393 requesting and returning multiple transformation fees in a single 1394 call. Added section on Phase/Subphase to provide more context on the 1395 uses. 1397 11.2. Change from draft-brown-00 to draft-ietf-regext-fees-00 1399 Updated to be REGEXT WG document. 1401 12. Normative References 1403 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1404 Requirement Levels", BCP 14, RFC 2119, 1405 DOI 10.17487/RFC2119, March 1997, 1406 . 1408 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 1409 DOI 10.17487/RFC3688, January 2004, 1410 . 1412 [RFC3915] Hollenbeck, S., "Domain Registry Grace Period Mapping for 1413 the Extensible Provisioning Protocol (EPP)", RFC 3915, 1414 DOI 10.17487/RFC3915, September 2004, 1415 . 1417 [RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", 1418 STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009, 1419 . 1421 [RFC5731] Hollenbeck, S., "Extensible Provisioning Protocol (EPP) 1422 Domain Name Mapping", STD 69, RFC 5731, 1423 DOI 10.17487/RFC5731, August 2009, 1424 . 1426 [RFC6982] Sheffer, Y. and A. Farrel, "Improving Awareness of Running 1427 Code: The Implementation Status Section", RFC 6982, 1428 DOI 10.17487/RFC6982, July 2013, 1429 . 1431 [RFC7451] Hollenbeck, S., "Extension Registry for the Extensible 1432 Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451, 1433 February 2015, . 1435 Authors' Addresses 1437 Roger Carney 1438 GoDaddy Inc. 1439 14455 N. Hayden Rd. #219 1440 Scottsdale, AZ 85260 1441 US 1443 Email: rcarney@godaddy.com 1444 URI: http://www.godaddy.com 1446 Gavin Brown 1447 CentralNic Group plc 1448 35-39 Moorgate 1449 London, England EC2R 6AR 1450 GB 1452 Phone: +44 20 33 88 0600 1453 Email: gavin.brown@centralnic.com 1454 URI: http://www.centralnic.com 1456 Jothan Frakes 1458 Email: jothan@jothan.com 1459 URI: http://jothan.com