idnits 2.17.1 draft-ietf-regext-epp-fees-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 : ---------------------------------------------------------------------------- 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 (March 8, 2017) is 2599 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 199, but not defined ** Obsolete normative reference: RFC 6982 (Obsoleted by RFC 7942) ** Downref: Normative reference to an Informational RFC: RFC 7451 Summary: 2 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 9, 2017 CentralNic Group plc 6 J. Frakes 7 March 8, 2017 9 Registry Fee Extension for the Extensible Provisioning Protocol (EPP) 10 draft-ietf-regext-epp-fees-02 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 9, 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 . . . . . . . . . . . . . . . . . . . . . 30 83 8.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 30 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 . . . . . . . . . . . . . . . . . . . . . . . 32 89 11.1. Change from 01 to 02 . . . . . . . . . . . . . . . . . . 32 90 11.2. Change from 00 to 01 . . . . . . . . . . . . . . . . . . 33 91 11.3. Change from draft-brown-00 to draft-ietf-regext-fees-00 33 92 12. Normative References . . . . . . . . . . . . . . . . . . . . 33 93 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 34 95 1. Introduction 97 Historically, domain name registries have applied a simple fee 98 structure for billable transactions, namely a basic unit price 99 applied to domain , , and RGP [RFC3915] 100 restore commands. Given the relatively small number of EPP servers 101 to which EPP clients have been required to connect, it has generally 102 been the case that client operators have been able to obtain details 103 of these fees out-of-band by contacting the server operators. 105 Given the recent expansion of the DNS namespace, and the 106 proliferation of novel business models, it is now desirable to 107 provide a method for EPP clients to query EPP servers for the fees 108 and credits associated with certain commands and specific objects. 110 This document describes an extension mapping for version 1.0 of the 111 Extensible Provisioning Protocol (EPP) [RFC5730]. This EPP mapping 112 provides a mechanism by which EPP clients may query the fees and 113 credits associated with various billable transactions, and also 114 obtain their current account balance. 116 1.1. Conventions Used in This Document 118 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 119 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 120 document are to be interpreted as described in RFC 2119 [RFC2119]. 122 XML is case sensitive. Unless stated otherwise, XML specifications 123 and examples provided in this document MUST be interpreted in the 124 character case presented in order to develop a conforming 125 implementation. 127 "fee" is used as an abbreviation for "urn:ietf:params:xml:ns:fee- 128 0.15". The XML namespace prefix "fee" is used, but implementations 129 MUST NOT depend on it and instead employ a proper namespace-aware XML 130 parser and serializer to interpret and output the XML documents. 132 In examples, "C:" represents lines sent by a protocol client and "S:" 133 represents lines returned by a protocol server. Indentation and 134 white space in examples are provided only to illustrate element 135 relationships and are not a REQUIRED feature of this protocol. 137 (Note to RFC Editor: remove the following paragraph before 138 publication as an RFC.) 140 The XML namespace prefix above contains a version number, 141 specifically "0.15". This version number will increment with 142 successive versions of this document, and will reach 1.0 if and when 143 this document is published as an RFC. This permits clients to 144 distinguish which version of the extension a server has implemented. 146 2. Migrating to Newer Versions of This Extension 148 (Note to RFC Editor: remove this section before publication as an 149 RFC.) 151 Servers which implement this extension SHOULD provide a way for 152 clients to progressively update their implementations when a new 153 version of the extension is deployed. 155 Servers SHOULD (for a temporary migration period) provide support for 156 older versions of the extension in parallel to the newest version, 157 and allow clients to select their preferred version via the 158 element of the command. 160 If a client requests multiple versions of the extension at login, 161 then, when preparing responses to commands which do not include 162 extension elements, the server SHOULD only include extension elements 163 in the namespace of the newest version of the extension requested by 164 the client. 166 When preparing responses to commands which do include extension 167 elements, the server SHOULD only include extension elements for the 168 extension versions present in the command. 170 3. Extension Elements 172 3.1. Client Commands 174 The element is used in the EPP command to 175 determine the fee which is applicable to the given command. 177 The list of values include: 179 o "create" indicating a command as defined in [RFC5730]; 180 o "delete" indicating a command as defined in [RFC5730]; 181 o "renew" indicating a command as defined in [RFC5730]; 182 o "update" indicating a command as defined in [RFC5730]; 183 o "transfer" indicating a command as defined in 184 [RFC5730]; 185 o If the server supports the Registry Grace Period Mapping 186 [RFC3915], then the server MUST also support the "restore" value 187 as defined in [RFC3915]. 189 The element MAY have an OPTIONAL "phase" attribute 190 specifying a launch phase as described in [draft-ietf-eppext- 191 launchphase]. It may also contain an OPTIONAL "subphase" attribute 192 identifying the custom or sub-phase as described in [draft-ietf- 193 eppext-launchphase]. 195 3.2. Currency Codes 197 The element is used to indicate which currency fees 198 are charged in. This value of this element MUST be a three-character 199 currency code from [ISO4217]. 201 Note that ISO 4217 provides the special "XXX" code, which MAY be used 202 if the server uses a non-currency based system for assessing fees, 203 such as a system of credits. 205 The use of elements in commands is OPTIONAL: if a 206 element is not present in a command, the server MUST 207 determine the currency based on the client's account settings which 208 MUST be agreed by the client and server via an out-of-band channel. 209 However, the element MUST be present in responses. 211 Servers SHOULD NOT perform a currency conversion if a client uses an 212 incorrect currency code. Servers SHOULD return a 2004 "Parameter 213 value range" error instead. 215 3.3. Validity Periods 217 When querying for fee information using the command, the 218 element is used to indicate the units to be added to the 219 registration period of objects by the , and 220 commands. This element is derived from the 221 element described in [RFC5731]. 223 The element is OPTIONAL in commands: if omitted, 224 the server MUST determine the fee(s) using a validity period of 1 225 year. The element MUST be present in responses. 227 3.4. Fees and Credits 229 Servers which implement this extension will include elements in 230 responses which provide information about the fees and/or credits 231 associated with a given billable transaction. 233 The and elements are used to provide this 234 information. The presence of a element in a response 235 indicates a debit against the client's account balance; a 236 element indicates a credit. A element MUST 237 have a non-negative value. A element MUST have a 238 negative value. 240 A server MAY respond with multiple and 241 elements in the same response. In such cases, the net fee or credit 242 applicable to the transaction is the arithmetic sum of the values of 243 each of the and/or elements. This amount 244 applies to the total additional validity period applied to the object 245 (where applicable) rather than to any incremental unit. 247 The following attributes are defined for the element. 248 These are described in detail below: 250 description: an OPTIONAL attribute which provides a human-readable 251 description of the fee. Servers should provide documentation on the 252 possible values of this attribute, and their meanings. 254 refundable: an OPTIONAL boolean attribute indicating whether the fee 255 is refundable if the object is deleted. 257 grace-period: an OPTIONAL attribute which provides the time period 258 during which the fee is refundable. 260 applied: an OPTIONAL attribute indicating when the fee will be 261 deducted from the client's account. 263 The element can take a "description" attribute as 264 described above. No other attributes are defined for this element. 266 3.4.1. Refunds 268 elements MAY have an OPTIONAL "refundable" attribute which 269 takes a boolean value. Fees may be refunded under certain 270 circumstances, such as when a domain application is rejected (as 271 described in [draft-ietf-eppext-launchphase]) or when an object is 272 deleted during the relevant Grace Period (see below). 274 If the "refundable" attribute is omitted, then clients SHOULD NOT 275 make any assumption about the refundability of the fee. 277 3.4.2. Grace Periods 279 [RFC3915] describes a system of "grace periods", which are time 280 periods following a billable transaction during which, if an object 281 is deleted, the client receives a refund. 283 The "grace-period" attribute MAY be used to indicate the relevant 284 grace period for a fee. If a server implements the Registry Grace 285 Period extension, it MUST specify the grace period for all relevant 286 transactions. 288 If the "grace-period" attribute is omitted, then clients SHOULD NOT 289 make any assumption about the grace period of the fee. 291 3.4.3. Correlation between Refundability and Grace Periods 293 If a element has a "grace-period" attribute then it MUST 294 also be refundable. If the "refundable" attribute of a 295 element is false then it MUST NOT have a "grace-period" attribute. 297 3.4.4. Applicability 299 Fees may be applied immediately upon receipt of a command from a 300 client, or may only be applied once an out-of-band process (such as 301 the processing of applications at the end of a launch phase) has 302 taken place. 304 The "applied" attribute of the element allows servers to 305 indicate whether a fee will be applied immediately, or whether it 306 will be applied at some point in the future. This attribute takes 307 two possible values: "immediate" or "delayed". 309 3.5. Account Balance 311 The element is an OPTIONAL element which MAY be 312 included in server responses to transform commands. If present, it 313 can be used by the client to determine the remaining credit at the 314 server. 316 Whether or not the is included in responses is a matter 317 of server policy. However, if a server chooses to offer support for 318 this element, it MUST be included in responses to all "transform" or 319 billable commands (ie , , , , 320 ). 322 The value of the MAY be negative. A negative balance 323 indicates that the server has extended a line of credit to the client 324 (see below). 326 If a server includes a element in response to transform 327 commands, the value of the element MUST reflect the client's account 328 balance after any fees or credits associated with that command have 329 been applied. 331 3.6. Credit Limit 333 As described above, if a server returns a response containing a 334 with a negative value, then the server has extended a 335 line of credit to the client. A server MAY also include a 336 element in responses which indicates the maximum 337 credit available to a client. A server MAY reject certain 338 transactions if the absolute value of the is equal to 339 or exceeds the value of the element. 341 Whether or not the is included in responses is a 342 matter of server policy. However, if a server chooses to offer 343 support for this element, it MUST be included in responses to all 344 "transform" commands (ie , , , , 345 ). 347 3.7. Classification of Objects 349 Objects may be assigned to a particular class, category, or tier, 350 each of which has a particular fee or set of fees associated with it. 351 The element which appears in responses is used to 352 indicate the classification of an object. 354 If a server makes use of this element, it should provide clients with 355 a list of all the values that the element may take via an out-of-band 356 channel. Servers MUST NOT use values which do not appear on this 357 list. 359 Servers which make use of this element MUST use a element 360 with the value "standard" for all objects that are subject to the 361 standard or default fee. 363 3.8. Phase and Subphase Attributes 365 The element has two attributes, phase and subphase, 366 that provide additional information related to a specific launch 367 phase as described in [draft-ietf-eppext-launchphase]. 369 If the client contains no phase attribute the server 370 SHOULD return data (including the phase/subphase attribute(s)) for 371 all valid server combinations of currently active phase(s) and active 372 subphase(s). 374 If the client contains a server supported combination 375 of phase/subphase the server MUST return fee data (including the 376 phase/subphase attribute(s)) for the specific combination(s). 378 If the client contains a phase attribute with no 379 subphase, the server SHOULD return data (including the phase/subphase 380 attribute(s)) for all valid server combinations of provided phase and 381 available subphase(s). 383 If the client contains a subphase with no phase 384 attribute the server MUST respond with a 2003 "Required parameter 385 missing" error. 387 If the client contains a phase attribute not defined in 388 [draft-ietf-eppext-launchphase] or not supported by server the server 389 MUST respond with a 2004 "Parameter value range" error. 391 If the client contains a subphase attribute (or phase/ 392 subphase combination) not supported by server the server MUST respond 393 with a 2004 "Parameter value range" error. 395 4. Server Handling of Fee Information 397 Depending on server policy, a client MAY be required to include the 398 extension elements described in this document for certain transform 399 commands. Servers must provide clear documentation to clients about 400 the circumstances in which this extension must be used. 402 If a server receives a command from a client which does not include 403 the extension elements required by the server for that command, then 404 it MUST respond with a 2003 "Required parameter missing" error. 406 If the currency or total fee provided by the client do not agree with 407 the server's own calculation of the fee for that command, then the 408 server MUST reject the command with a 2004 "Parameter value range" 409 error. 411 5. EPP Command Mapping 413 A detailed description of the EPP syntax and semantics can be found 414 in [RFC5730]. 416 5.1. EPP Query Commands 418 This extension does not add any elements to the EPP or 419 commands or responses. 421 5.1.1. EPP Command 423 This extension defines additional elements for the EPP 424 command. 426 The command MAY contain an element which MAY contain a 427 element. The element MUST contain one or 428 more elements containing the following child elements: 430 o A element that MUST match one and only one of the 431 domain names in the ; 432 o An OPTIONAL element. If the server does not 433 support value, it MUST return a 2306 error 434 response; 435 o One or more element(s) with a "name" attribute, an 436 OPTIONAL "phase" attribute, and an OPTIONAL "subphase" attribute. 438 The element(s) MAY have the following child elements: 440 o An OPTIONAL element. 441 o An OPTIONAL element. 443 Example command: 445 C: 446 C: 447 C: 448 C: 449 C: 451 C: example.com 452 C: example.net 453 C: example.xyz 454 C: 455 C: 456 C: 457 C: 458 C: 459 C: example.com 460 C: USD 461 C: 462 C: 2 463 C: 464 C: 465 C: 466 C: 467 C: 468 C: 469 C: example.net 470 C: USD 471 C: 472 C: 11 473 C: 474 C: 475 C: 476 C: 477 C: 478 C: ABC-12345 479 C: 480 C: 482 When the server receives a command that includes the 483 extension elements described above, its response MUST contain an 484 element, which MUST contain a child 485 element. The element MUST contain a element 486 for each object element referenced in the 487 element of the client command. 489 Each element MUST contain the following child elements: 491 o A element, which MUST match a from the 492 client command. 493 o A element, which contains the same currency code 494 that appeared in the element of the command. If no 495 element appeared in the command, then the client's 496 default billing currency should be used. 497 o A element matching each that appeared 498 in the corresponding of the command. If a 499 element in the client command contains no 500 element the server SHOULD return a 501 element for each server billable transaction combination of the 502 . This element MAY have the OPTIONAL "phase" and 503 "subphase" attributes, which MUST match the same attributes in the 504 corresponding element of the client command. 506 The element also has an OPTIONAL "avail" attribute 507 which is a boolean. If the value of this attribute evaluates to 508 false, this indicates that the server cannot calculate the relevant 509 fees, because the object, command, currency, period or class is 510 invalid according to server policy. 512 The element(s) MAY have the following child elements: 514 o An OPTIONAL element, which contains the same unit 515 that appeared in the element of the command. If the 516 value of the preceding element is "restore", this 517 element MUST NOT be included. Otherwise it MUST be included. If 518 no appeared in command (and the command is not 519 "restore") then the server MUST return its default period value. 520 o Zero or more elements. 521 o Zero or more elements. 522 o An OPTIONAL element. 523 o An OPTIONAL element. 525 If no elements are present in a element, this 526 indicates that no fee will be assessed by the server for this 527 command. 529 If the "avail" attribute of the element is false, then 530 the element MUST NOT contain any or 531 child elements. If the "avail" attribute is true, then 532 the element MUST NOT contain a element. 534 Example response: 536 S: 537 S: 538 S: 539 S: 540 S: Command completed successfully 541 S: 542 S: 543 S: 545 S: 546 S: example.com 547 S: 548 S: 549 S: example.net 550 S: 551 S: 552 S: example.xyz 553 S: 554 S: 555 S: 556 S: 557 S: 560 S: 561 S: example.com 562 S: USD 563 S: 564 S: 2 565 S: 10.00 569 S: 570 S: 571 S: 1 572 S: 5.00 576 S: 577 S: 578 S: 1 579 S: 5.00 583 S: 584 S: 585 S: 5.00 587 S: 588 S: 589 S: 590 S: example.net 591 S: USD 592 S: 593 S: Maximum period is 10 years 594 S: 595 S: 596 S: 1 597 S: 5.00 601 S: 602 S: 603 S: 604 S: 605 S: 606 S: ABC-12345 607 S: 54322-XYZ 608 S: 609 S: 610 S: 612 5.1.1.1. Server Handling of Elements 614 Clients MAY include a in the element. 615 There are three ways in which servers may handle this element: 617 1. If the server supports the concept of tiers or classes of 618 objects, then the value of this element MUST be validated. If 619 incorrect for the specified object, the "avail" attribute of the 620 corresponding element MUST be false. 621 2. If the server supports different "types" of object registrations 622 (such as a "blocking" registration which does not resolve, or 623 where a registry provides a value-added service that requires an 624 opt-out to disable), then, as with the first model, the server 625 MUST validate the value of the element. If the value is 626 incorrect, the "avail" attribute of the corresponding 627 element MUST be false. 628 3. If the server supports neither of the above models, the element 629 MUST be ignored. 631 Server operators must provide clear documentation to client operators 632 which of the above models it supports. 634 5.1.2. EPP Transfer Query Command 636 This extension does not add any elements to the EPP query 637 command, but does include elements in the response, when the 638 extension has been selected during a command. 640 When the query command has been processed successfully, 641 the client selected the extension when it logged in, and the client 642 is authorised by the server to view information about the transfer, 643 the server MAY include in the section of the EPP response 644 a element, which contains the following child elements: 646 o A element. 647 o A element. 648 o Zero or more elements containing the fees that will be 649 charged to the gaining client. 650 o Zero or more elements containing the credits that 651 will be refunded to the losing client. 653 Servers SHOULD omit when returning a response to the 654 gaining client, and omit elements when returning a response 655 to the losing client. 657 If no element is included in the response, then no fee 658 will be assessed by the server for the transfer. 660 Example query response: 662 S: 663 S: 664 S: 665 S: 666 S: Command completed successfully; action pending 667 S: 668 S: 669 S: 671 S: example.com 672 S: pending 673 S: ClientX 674 S: 2000-06-08T22:00:00.0Z 675 S: ClientY 676 S: 2000-06-13T22:00:00.0Z 677 S: 2002-09-08T22:00:00.0Z 678 S: 679 S: 680 S: 681 S: 682 S: USD 683 S: 1 684 S: 5.00 685 S: 686 S: 687 S: 688 S: ABC-12345 689 S: 54322-XYZ 690 S: 691 S: 692 S: 694 5.2. EPP Transform Commands 696 5.2.1. EPP Command 698 This extension adds elements to both the EPP command and 699 response, when the extension has been selected during a 700 command. 702 If a command is received with no extension and 703 the server requires a extension for the 704 the server MUST respond with a 2003 "Required parameter missing" 705 error. 707 When submitting a command to the server, the client MAY 708 include in the element a element which 709 includes the following child elements: 711 o An OPTIONAL element; 712 o One or more elements. 714 When the command has been processed successfully, and the 715 client selected the extension when it logged in, and a fee was 716 assessed by the server for the transaction, the server MUST include 717 in the section of the EPP response a 718 element, which contains the following child elements: 720 o A element; 721 o Zero or more elements; 722 o Zero or more elements; 723 o An OPTIONAL element; 724 o An OPTIONAL element. 726 Example command: 728 C: 729 C: 730 C: 731 C: 732 C: 734 C: example.com 735 C: 2 736 C: 737 C: ns1.example.net 738 C: ns2.example.net 739 C: 740 C: jd1234 741 C: sh8013 742 C: sh8013 743 C: 744 C: 2fooBAR 745 C: 746 C: 747 C: 748 C: 749 C: 750 C: USD 751 C: 5.00 752 C: 753 C: 754 C: ABC-12345 755 C: 756 C: 757 Example response: 759 S: 760 S: 761 S: 762 S: 763 S: Command completed successfully 764 S: 765 S: 766 S: 768 S: example.com 769 S: 1999-04-03T22:00:00.0Z 770 S: 2001-04-03T22:00:00.0Z 771 S: 772 S: 773 S: 774 S: 775 S: USD 776 S: 5.00 780 S: -5.00 781 S: 1000.00 782 S: 783 S: 784 S: 785 S: ABC-12345 786 S: 54321-XYZ 787 S: 788 S: 789 S: 791 5.2.2. EPP Command 793 This extension does not add any elements to the EPP command, 794 but does include elements in the response, when the extension has 795 been selected during the command. 797 When the command has been processed successfully, and the 798 client selected the extension when it logged in, the server MAY 799 include in the section of the EPP response a 800 element, which contains the following child elements: 802 o A element; 803 o Zero or more elements; 804 o Zero or more elements; 805 o An OPTIONAL element; 806 o An OPTIONAL element. 808 Example response: 810 S: 811 S: 812 S: 813 S: 814 S: Command completed successfully 815 S: 816 S: 817 S: 819 S: USD 820 S: -5.00 821 S: 1005.00 822 S: 823 S: 824 S: 825 S: ABC-12345 826 S: 54321-XYZ 827 S: 828 S: 829 S: 831 5.2.3. EPP Command 833 This extension adds elements to both the EPP command and 834 response, when the extension has been selected during a 835 command. 837 When submitting a command to the server, the client MAY 838 include in the element a element which 839 includes the following child elements: 841 o An OPTIONAL element; 842 o One or more elements. 844 When the command has been processed successfully, and the 845 client selected the extension when it logged in, the server MAY 846 include in the section of the EPP response a 847 element, which contains the following child elements: 849 o A element; 850 o Zero or more elements; 851 o Zero or more elements; 852 o An OPTIONAL element; 853 o An OPTIONAL element. 855 Example command: 857 C: 858 C: 859 C: 860 C: 861 C: 863 C: example.com 864 C: 2000-04-03 865 C: 5 866 C: 867 C: 868 C: 869 C: 870 C: USD 871 C: 5.00 872 C: 873 C: 874 C: ABC-12345 875 C: 876 C: 877 Example response: 879 S: 880 S: 881 S: 882 S: 883 S: Command completed successfully 884 S: 885 S: 886 S: 888 S: example.com 889 S: 2005-04-03T22:00:00.0Z 890 S: 891 S: 892 S: 893 S: 894 S: USD 895 S: 5.00 898 S: 1000.00 899 S: 900 S: 901 S: 902 S: ABC-12345 903 S: 54322-XYZ 904 S: 905 S: 906 S: 908 5.2.4. EPP Command 910 This extension adds elements to both the EPP command and 911 response, when the value of the "op" attribute of the 912 command element is "request", and the extension has been selected 913 during the command. 915 When submitting a command to the server, the client MAY 916 include in the element a element which 917 includes the following child elements: 919 o An OPTIONAL element; 920 o One or more elements. 922 When the command has been processed successfully, and the 923 client selected the extension when it logged in, the server MAY 924 include in the section of the EPP response a 925 element, which contains the following child elements: 927 o A element; 928 o Zero or more elements; 929 o Zero or more elements; 930 o An OPTIONAL element; 931 o An OPTIONAL element. 933 Example command: 935 C: 936 C: 937 C: 938 C: 939 C: 941 C: example.com 942 C: 1 943 C: 944 C: 2fooBAR 945 C: 946 C: 947 C: 948 C: 949 C: 950 C: USD 951 C: 5.00 952 C: 953 C: 954 C: ABC-12345 955 C: 956 C: 957 Example response: 959 S: 960 S: 961 S: 962 S: 963 S: Command completed successfully; action pending 964 S: 965 S: 966 S: 968 S: example.com 969 S: pending 970 S: ClientX 971 S: 2000-06-08T22:00:00.0Z 972 S: ClientY 973 S: 2000-06-13T22:00:00.0Z 974 S: 2002-09-08T22:00:00.0Z 975 S: 976 S: 977 S: 978 S: 979 S: USD 980 S: 5.00 983 S: 984 S: 985 S: 986 S: ABC-12345 987 S: 54322-XYZ 988 S: 989 S: 990 S: 992 5.2.5. EPP Command 994 This extension adds elements to both the EPP command and 995 response, when the extension has been selected during the 996 command. 998 When submitting a command to the server, the client MAY 999 include in the element a element which 1000 includes the following child elements: 1002 o An OPTIONAL element; 1003 o One or more elements. 1005 When the command has been processed successfully, and the 1006 client selected the extension when it logged in, the server MAY 1007 include in the section of the EPP response a 1008 element, which contains the following child elements: 1010 o A element; 1011 o Zero or more elements; 1012 o Zero or more elements; 1013 o An OPTIONAL element; 1014 o An OPTIONAL element. 1016 Example command: 1018 C: 1019 C: 1020 C: 1021 C: 1022 C: 1024 C: example.com 1025 C: 1026 C: sh8013 1027 C: 1028 C: 1029 C: 1030 C: 1031 C: 1032 C: USD 1033 C: 5.00 1034 C: 1035 C: 1036 C: ABC-12345 1037 C: 1038 C: 1039 Example response: 1041 S: 1042 S: 1043 S: 1044 S: 1045 S: Command completed successfully 1046 S: 1047 S: 1048 S: 1049 S: USD 1050 S: 5.00 1051 S: 1052 S: 1053 S: 1054 S: ABC-12345 1055 S: 54321-XYZ 1056 S: 1057 S: 1058 S: 1060 6. Formal Syntax 1062 One schema is presented here that is the EPP Fee Extension schema. 1064 The formal syntax presented here is a complete schema representation 1065 of the object mapping suitable for automated validation of EPP XML 1066 instances. The BEGIN and END tags are not part of the schema; they 1067 are used to note the beginning and ending of the schema for URI 1068 registration purposes. 1070 6.1. Fee Extension Schema 1072 BEGIN 1073 1074 1081 1082 1084 1085 1086 Extensible Provisioning Protocol v1.0 Fee Extension 1088 1089 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1104 1105 1106 1107 1109 1110 1112 1113 1114 1115 1117 1119 1120 1122 1123 1124 1125 1127 1128 1129 1131 1132 1133 1134 1137 1138 1140 1141 1142 1143 1144 1146 1147 1149 1150 1151 1152 1154 1156 1158 1159 1161 1162 1163 1164 1166 1168 1170 1172 1174 1176 1177 1179 1180 1181 1182 1183 1184 1185 1186 1187 1189 1191 1193 1194 1195 1196 1197 1198 1199 1200 1202 1203 1204 1205 1206 1207 1209 1210 1211 1212 1213 1215 1216 1217 1218 1219 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1234 1235 1236 1237 1238 1240 1241 1242 1243 1244 1245 1246 1248 1249 1250 1252 1253 1254 1256 1257 END 1259 7. Security Considerations 1261 The mapping extensions described in this document do not provide any 1262 security services beyond those described by EPP [RFC5730], the EPP 1263 domain name mapping [RFC5731], and protocol layers used by EPP. The 1264 security considerations described in these other specifications apply 1265 to this specification as well. 1267 8. IANA Considerations 1269 8.1. XML Namespace 1271 This document uses URNs to describe XML namespaces and XML schemas 1272 conforming to a registry mechanism described in [RFC3688]. The 1273 following URI assignment is requested of IANA: 1275 URI: ietf:params:xml:ns:fee-0.15 1277 Registrant Contact: See the "Author's Address" section of this 1278 document. 1280 XML: See the "Formal Syntax" section of this document. 1282 8.2. EPP Extension Registry 1284 The EPP extension described in this document should be registered by 1285 the IANA in the EPP Extension Registry described in [RFC7451]. The 1286 details of the registration are as follows: 1288 Name of Extension: EPP Fee Extension 1290 Document status: Standards Track 1292 Reference: (insert reference to RFC version of this document) 1294 Registrant Name and Email Address: See the "Author's Address" section 1295 of this document. 1297 TLDs: any 1299 IPR Disclosure: none 1301 Status: active 1303 Notes: none 1305 9. Implemntation Status 1307 Note to RFC Editor: Please remove this section and the reference to 1308 [RFC6982] before publication. 1310 This section records the status of known implementations of the 1311 protocol defined by this specification at the time of posting of this 1312 Internet-Draft, and is based on a proposal described in [RFC6982]. 1313 The description of implementations in this section is intended to 1314 assist the IETF in its decision processes in progressing drafts to 1315 RFCs. Please note that the listing of any individual implementation 1316 here does not imply endorsement by the IETF. Furthermore, no effort 1317 has been spent to verify the information presented here that was 1318 supplied by IETF contributors. This is not intended as, and must not 1319 be construed to be, a catalog of available implementations or their 1320 features. Readers are advised to note that other implementations may 1321 exist. 1323 According to [RFC6982], "this will allow reviewers and working groups 1324 to assign due consideration to documents that have the benefit of 1325 running code, which may serve as evidence of valuable experimentation 1326 and feedback that have made the implemented protocols more mature. 1327 It is up to the individual working groups to use this information as 1328 they see fit". 1330 9.1. RegistryEngine EPP Service 1332 Organization: CentralNic 1334 Name: RegistryEngine EPP Service 1336 Description: Generic high-volume EPP service for gTLDs, ccTLDs and 1337 SLDs 1339 Level of maturity: Deployed in CentralNic's production environment as 1340 well as two other gTLD registry systems, and two ccTLD registry 1341 systems. 1343 Coverage: All aspects of the protocol are implemented. 1345 Licensing: Proprietary In-House software 1347 Contact: epp@centralnic.com 1349 URL: https://www.centralnic.com 1351 10. Acknowledgements 1353 The authors wish to thank the following persons for their feedback 1354 and suggestions: 1356 o James Gould of Verisign Inc 1357 o Luis Munoz of ISC 1358 o Michael Young of Architelos 1359 o Ben Levac and Jeff Eckhaus of Demand Media 1360 o Seth Goldman of Google 1361 o Klaus Malorny and Michael Bauland of Knipp 1362 o Jody Kolker, Joe Snitker and Kevin Allendorf of Go Daddy 1363 o Michael Holloway of Com Laude 1364 o Santosh Kalsangrah of Impetus Infotech 1365 o Alex Mayrhofer of Nic.at 1367 11. Change History 1369 11.1. Change from 01 to 02 1371 Updated scheme to version 0.15 to fix errors in CommandType, 1372 objectCDType, transformCommandType and transformResultType 1373 definitions. 1375 11.2. Change from 00 to 01 1377 Added Roger Carney as author to finish draft. Moved Formal Syntax 1378 section to main level numbering. Various grammar, typos, and 1379 administrative edits for clarity. Removed default value for the 1380 "applied" attribute of so that it can truly be optional. 1381 Added support for the command to return a element 1382 as well. Modified default response on the command for the 1383 optional when it was not provided in the command, 1384 leaving it to the server to provide the default period value. 1385 Extensive edits were done to the command, the 1386 response and to the fee extension schema (checkType, objectCheckType, 1387 objectIdentifierType, objectCDType, commandType) to support 1388 requesting and returning multiple transformation fees in a single 1389 call. Added section on Phase/Subphase to provide more context on the 1390 uses. 1392 11.3. Change from draft-brown-00 to draft-ietf-regext-fees-00 1394 Updated to be REGEXT WG document. 1396 12. Normative References 1398 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1399 Requirement Levels", BCP 14, RFC 2119, 1400 DOI 10.17487/RFC2119, March 1997, 1401 . 1403 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 1404 DOI 10.17487/RFC3688, January 2004, 1405 . 1407 [RFC3915] Hollenbeck, S., "Domain Registry Grace Period Mapping for 1408 the Extensible Provisioning Protocol (EPP)", RFC 3915, 1409 DOI 10.17487/RFC3915, September 2004, 1410 . 1412 [RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", 1413 STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009, 1414 . 1416 [RFC5731] Hollenbeck, S., "Extensible Provisioning Protocol (EPP) 1417 Domain Name Mapping", STD 69, RFC 5731, 1418 DOI 10.17487/RFC5731, August 2009, 1419 . 1421 [RFC6982] Sheffer, Y. and A. Farrel, "Improving Awareness of Running 1422 Code: The Implementation Status Section", RFC 6982, 1423 DOI 10.17487/RFC6982, July 2013, 1424 . 1426 [RFC7451] Hollenbeck, S., "Extension Registry for the Extensible 1427 Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451, 1428 February 2015, . 1430 Authors' Addresses 1432 Roger Carney 1433 GoDaddy Inc. 1434 14455 N. Hayden Rd. #219 1435 Scottsdale, AZ 85260 1436 US 1438 Email: rcarney@godaddy.com 1439 URI: http://www.godaddy.com 1441 Gavin Brown 1442 CentralNic Group plc 1443 35-39 Moorgate 1444 London, England EC2R 6AR 1445 GB 1447 Phone: +44 20 33 88 0600 1448 Email: gavin.brown@centralnic.com 1449 URI: http://www.centralnic.com 1451 Jothan Frakes 1453 Email: jothan@jothan.com 1454 URI: http://jothan.com