idnits 2.17.1 draft-brown-epp-fees-05.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 (August 12, 2015) is 3180 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) -- Possible downref: Non-RFC (?) normative reference: ref. 'ISO4217' ** Obsolete normative reference: RFC 6982 (Obsoleted by RFC 7942) ** Downref: Normative reference to an Informational RFC: RFC 7451 Summary: 2 errors (**), 0 flaws (~~), 1 warning (==), 2 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Internet Engineering Task Force G. Brown 3 Internet-Draft CentralNic Group plc 4 Intended status: Standards Track August 12, 2015 5 Expires: February 13, 2016 7 Registry Fee Extension for the Extensible Provisioning Protocol (EPP) 8 draft-brown-epp-fees-05 10 Abstract 12 This document describes an Extensible Provisioning Protocol (EPP) 13 extension mapping for registry fees. 15 Status of this Memo 17 This Internet-Draft is submitted in full conformance with the 18 provisions of BCP 78 and BCP 79. 20 Internet-Drafts are working documents of the Internet Engineering 21 Task Force (IETF). Note that other groups may also distribute 22 working documents as Internet-Drafts. The list of current Internet- 23 Drafts is at http://datatracker.ietf.org/drafts/current/. 25 Internet-Drafts are draft documents valid for a maximum of six months 26 and may be updated, replaced, or obsoleted by other documents at any 27 time. It is inappropriate to use Internet-Drafts as reference 28 material or to cite them other than as "work in progress." 30 This Internet-Draft will expire on February 13, 2016. 32 Copyright Notice 34 Copyright (c) 2015 IETF Trust and the persons identified as the 35 document authors. All rights reserved. 37 This document is subject to BCP 78 and the IETF Trust's Legal 38 Provisions Relating to IETF Documents 39 (http://trustee.ietf.org/license-info) in effect on the date of 40 publication of this document. Please review these documents 41 carefully, as they describe your rights and restrictions with respect 42 to this document. Code Components extracted from this document must 43 include Simplified BSD License text as described in Section 4.e of 44 the Trust Legal Provisions and are provided without warranty as 45 described in the Simplified BSD License. 47 Table of Contents 49 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 50 1.1. Conventions Used in This Document . . . . . . . . . . . . 3 51 2. Migrating to Newer Versions of This Extension . . . . . . . . 4 52 3. Extension Elements . . . . . . . . . . . . . . . . . . . . . . 4 53 3.1. Client Commands . . . . . . . . . . . . . . . . . . . . . 4 54 3.2. Currency Codes . . . . . . . . . . . . . . . . . . . . . . 5 55 3.3. Validity Periods . . . . . . . . . . . . . . . . . . . . . 5 56 3.4. Fees and Credits . . . . . . . . . . . . . . . . . . . . . 5 57 3.4.1. Refunds . . . . . . . . . . . . . . . . . . . . . . . 6 58 3.4.2. Grace Periods . . . . . . . . . . . . . . . . . . . . 6 59 3.4.3. Applicability . . . . . . . . . . . . . . . . . . . . 7 60 3.5. Account Balance . . . . . . . . . . . . . . . . . . . . . 7 61 3.6. Credit Limit . . . . . . . . . . . . . . . . . . . . . . . 7 62 3.7. Classification of Domain Names . . . . . . . . . . . . . . 8 63 4. Server Handling of Fee Information . . . . . . . . . . . . . . 8 64 5. EPP Command Mapping . . . . . . . . . . . . . . . . . . . . . 8 65 5.1. EPP Query Commands . . . . . . . . . . . . . . . . . . . . 8 66 5.1.1. EPP Command . . . . . . . . . . . . . . . . . 9 67 5.1.2. EPP Transfer Query Command . . . . . . . . . . . . . . 13 68 5.2. EPP Transform Commands . . . . . . . . . . . . . . . . . . 14 69 5.2.1. EPP Command . . . . . . . . . . . . . . . . . 14 70 5.2.2. EPP Command . . . . . . . . . . . . . . . . . 17 71 5.2.3. EPP Command . . . . . . . . . . . . . . . . . 18 72 5.2.4. EPP Command . . . . . . . . . . . . . . . . 20 73 5.2.5. EPP Command . . . . . . . . . . . . . . . . . 22 74 5.3. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . 24 75 6. Security Considerations . . . . . . . . . . . . . . . . . . . 29 76 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 30 77 7.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 30 78 7.2. EPP Extension Registry . . . . . . . . . . . . . . . . . . 30 79 8. Implementation Status . . . . . . . . . . . . . . . . . . . . 30 80 8.1. RegistryEngine EPP Service . . . . . . . . . . . . . . . . 31 81 9. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 31 82 10. Change History . . . . . . . . . . . . . . . . . . . . . . . . 32 83 10.1. Changes from 00 to 01 . . . . . . . . . . . . . . . . . . 32 84 10.2. Changes from 01 to 02 . . . . . . . . . . . . . . . . . . 32 85 10.3. Changes from 02 to 03 . . . . . . . . . . . . . . . . . . 33 86 10.4. Changes from 03 to 04 . . . . . . . . . . . . . . . . . . 33 87 10.5. Changes from 04 to 05 . . . . . . . . . . . . . . . . . . 34 88 11. TODO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 89 12. Normative References . . . . . . . . . . . . . . . . . . . . . 34 90 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 35 92 1. Introduction 94 Historically, domain name registries have applied a simple fee 95 structure for billable transactions, namely a basic unit price 96 applied to domain , , and RGP [RFC3915] 97 restore commands. Given the relatively small number of EPP servers 98 to which EPP clients have been required to connect, it has generally 99 been the case that client operators have been able to obtain details 100 of these fees out-of-band by contacting the server operators. 102 Given the recent expansion of the DNS namespace, and the 103 proliferation of novel business models, it is now desirable to 104 provide a method for EPP clients to query EPP servers for the fees 105 and credits associated with certain commands and specific objects. 107 This document describes an extension mapping for version 1.0 of the 108 Extensible Provisioning Protocol (EPP) [RFC5730]. This EPP mapping 109 provides a mechanism by which EPP clients may query the fees and 110 credits associated with various billable transactions, and also 111 obtain their current account balance. 113 1.1. Conventions Used in This Document 115 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 116 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 117 document are to be interpreted as described in RFC 2119 [RFC2119]. 119 XML is case sensitive. Unless stated otherwise, XML specifications 120 and examples provided in this document MUST be interpreted in the 121 character case presented in order to develop a conforming 122 implementation. 124 "fee" is used as an abbreviation for 125 "urn:ietf:params:xml:ns:fee-0.8". The XML namespace prefix "fee" is 126 used, but implementations MUST NOT depend on it and instead employ a 127 proper namespace-aware XML parser and serializer to interpret and 128 output the XML documents. 130 (Note to RFC Editor: remove the following paragraph before 131 publication as an RFC.) 133 The XML namespace prefix above contains a version number, 134 specifically "0.8". This version number will increment with 135 successive versions of this document, and will reach 1.0 if and when 136 this document is published as an RFC. This permits clients to 137 distinguish which version of the extension a server has implemented. 139 2. Migrating to Newer Versions of This Extension 141 (Note to RFC Editor: remove this section before publication as an 142 RFC.) 144 Servers which implement this extension SHOULD provide a way for 145 clients to progressively update their implementations when a new 146 version of the extension is deployed. 148 Servers SHOULD (for a temporary migration period) provide support for 149 older versions of the extension in parallel to the newest version, 150 and allow clients to select their preferred version via the 151 element of the command. 153 If a client requests multiple versions of the extension at login, 154 then, when preparing responses to commands which do not include 155 extension elements, the server SHOULD only include extension elements 156 in the namespace of the newest version of the extension requested by 157 the client. 159 When preparing responses to commands which do include extension 160 elements, the server SHOULD only include extension elements for the 161 extension versions present in the command. 163 3. Extension Elements 165 3.1. Client Commands 167 The element is used in EPP and commands 168 to determine the fee which is applicable to the given command. 170 The element values permitted by the server is a matter of repository 171 policy, but MUST include as a minimum the following values: 173 o "create" indicating a command; 175 o "renew" indicating a command; 177 o "transfer" indicating a command; 179 If the server supports the Registry Grace Period Mapping [RFC3915], 180 then the server MUST also support the "restore" value. 182 The element MAY have an OPTIONAL "phase" attribute 183 specifying a launch phase as described in 184 [draft-ietf-eppext-launchphase]. It may also contain an OPTIONAL 185 "subphase" attribute identifying the custom or sub-phase as described 186 in [draft-ietf-eppext-launchphase]. 188 3.2. Currency Codes 190 The element is used to indicate which currency fees 191 are charged in. This value of this element MUST be a three-character 192 currency code from [ISO4217]. 194 Note that ISO 4217 provides the special "XXX" code, which MAY be used 195 if the server uses a non-currency based system for assessing fees, 196 such as a system of credits. 198 The use of elements in commands is OPTIONAL: if a 199 element is not present in a command, the server MUST 200 determine the currency based on the client's account settings which 201 MUST be agreed by the client and server via an out-of-band channel. 202 However, element MUST be present in responses. 204 Servers SHOULD NOT perform a currency conversion if a client uses an 205 incorrect currency code. Servers SHOULD return a 2004 error instead. 207 3.3. Validity Periods 209 When querying for fee information using the or 210 commands, the element is used to indicate the units to 211 be added to the registration period of domain names by the , 212 and commands. This element is derived from the 213 element described in [RFC5731]. 215 The element is OPTIONAL in and commands: 216 if omitted, the server MUST determine the fee(s) using a validity 217 period of 1 year. The element MUST be present in 218 and responses. 220 3.4. Fees and Credits 222 Servers which implement this extension will include elements in 223 responses which provide information about the fees and/or credits 224 associated with a given billable transaction. 226 The and elements are used to provide this 227 information. The presence of a element in a response 228 indicates a debit against the client's account balance; a element indicates a credit. A element MUST have a 230 non-negative value. A element MUST have a negative 231 value. 233 A server MAY respond with multiple and 234 elements in the same response. In such cases, the net fee or credit 235 applicable to the transaction is the arithmetic sum of the values of 236 each of the and/or elements. This amount 237 applies to the total additional validity period applied to the domain 238 (where applicable) rather than to any incremental unit. 240 The following attributes are defined for the element. 241 These are described in detail below: 243 description: an OPTIONAL attribute which provides a human-readable 244 description of the fee. Servers SHOULD provide documentation on 245 the possible values of this attribute, and their meanings. 247 refundable: an OPTIONAL boolean attribute indicating whether the fee 248 is refundable if the domain name is deleted. 250 grace-period: an OPTIONAL attribute which provides the time period 251 during which the fee is refundable. 253 applied: an OPTIONAL attribute indicating when the fee will be 254 deducted from the client's account. 256 The element can take a "description" attribute as 257 described above. No other attributes are defined for this element. 259 3.4.1. Refunds 261 elements MAY have an OPTIONAL "refundable" attribute which 262 takes a boolean value. Fees may be refunded under certain 263 circumstances, such as when a domain application is rejected (as 264 described in [draft-ietf-eppext-launchphase]) or when a domain name 265 is deleted during the relevant Grace Period (see below). If the 266 "refundable" attribute is omitted, then the default value of "1" 267 should be assumed (i.e. the fee is refundable). 269 3.4.2. Grace Periods 271 [RFC3915] describes a system of "grace periods", which are time 272 periods following a billable transaction during which, if a domain 273 name is deleted, the client receives a refund. 275 The "grace-period" attribute MAY be used to indicate the relevant 276 grace period for a fee. If a server implements the Registry Grace 277 Period extension, it MUST specify the grace period for all relevant 278 transactions. If no "grace-period" attribute value is provided, then 279 no grace period is applicable. 281 If a element has a "grace-period" attribute then it MUST 282 also be refundable. If the "refundable" attribute of a 283 element is false then it MUST NOT have a "grace-period" attribute. 285 3.4.3. Applicability 287 Fees may be applied immediately upon receipt of a command from a 288 client, or may only be applied once an out-of-band process (such as 289 the processing of applications at the end of a launch phase) has 290 taken place. 292 The "applied" attribute of the element allows servers to 293 indicate whether a fee will be applied immediately, or whether it 294 will be applied at some point in the future. This attribute takes 295 two possible values: "immediate" (which is the default) or "delayed". 297 3.5. Account Balance 299 The element is an OPTIONAL element which MAY be 300 included in server responses to transform commands. If present, it 301 can be used by the client to determine the remaining credit at the 302 server. 304 Whether or not the is included in responses is a matter 305 of server policy. However, if a server chooses to offer support for 306 this element, it MUST be included in responses to all domain 307 "transform" commands (ie , , , , 308 ). 310 The value of the MAY be negative. A negative balance 311 indicates that the server has extended a line of credit to the client 312 (see below). 314 When a server includes a element in response to 315 transform commands, the value of the element MUST reflect the 316 client's account balance after any fees or credits associated with 317 that command have been applied. 319 3.6. Credit Limit 321 As described above, if a server returns a response containing a with a negative value, then the server has extended a line 323 of credit to the client. A server MAY also include a element in responses which indicates the maximum credit 325 available to a client. A server MAY reject certain transactions if 326 the absolute value of the is equal to or exceeds the 327 value of the element. 329 Whether or not the is included in responses is a 330 matter of server policy. However, if a server chooses to offer 331 support for this element, it MUST be included in responses to all 332 domain "transform" commands (ie , , , 333 , ). 335 3.7. Classification of Domain Names 337 Domain names may be assigned to a particular class, category, or 338 tier, each of which has a particular fee or set of fees associated 339 with it. The element which appears in and 340 responses is used to indicate the classification of a domain name. 342 If a server makes use of this element, it MUST provide clients with a 343 list of all the values that the element may take via an out-of-band 344 channel. Servers MUST NOT use values which do not appear on this 345 list. 347 Servers which make use of this element MUST use a element 348 with the value "standard" for all domains that are subject to the 349 standard or default price. 351 4. Server Handling of Fee Information 353 Depending on server policy, a client MAY be required to include the 354 extension elements described in this document for certain transform 355 commands. Servers MUST provide clear documentation to clients about 356 the circumstances in which this extension must be used. 358 If a server receives a command from a client which does not include 359 the extension elements required by the server for that command, then 360 it MUST respond with a 2003 "Required parameter missing" error. 362 If the currency or total fee provided by the client do not agree with 363 the server's own calculation of the fee for that command, then the 364 server MUST reject the command with a 2004 "Parameter value range" 365 error. 367 5. EPP Command Mapping 369 A detailed description of the EPP syntax and semantics can be found 370 in [RFC5730]. 372 5.1. EPP Query Commands 374 This extension does not add any elements to the EPP or 375 commands or responses. 377 5.1.1. EPP Command 379 This extension defines additional elements for the EPP 380 command. 382 The command MAY contain an element which MAY contain a 383 element. The element MUST contain at least 384 one element, with the following child elements: 386 o A element. The domain name need not correspond to a 387 element that appears in the element 388 of the main body of the frame. 390 o An OPTIONAL element; 392 o A element; 394 o An OPTIONAL element. 396 Example command: 398 C: 399 C: 400 C: 401 C: 402 C: 404 C: example.com 405 C: example.net 406 C: example.org 407 C: 408 C: 409 C: 410 C: 412 C: 413 C: example.com 414 C: USD 415 C: create 416 C: 1 417 C: 418 C: 419 C: example.net 420 C: EUR 421 C: 422 C: create 423 C: 2 424 C: 425 C: 426 C: example.org 427 C: EUR 428 C: transfer 429 C: 430 C: 431 C: example.xyz 432 C: restore 433 C: 434 C: 435 C: 436 C: ABC-12345 437 C: 438 C: 440 When the server receives a command that includes the 441 extension elements described above, its response MUST (subject to the 442 exception described below) contain an element, which MUST 443 contain a child element. The element 444 MUST contain a element for each element 445 contained in the command. The MUST contain the following 446 child elements: 448 o A element that contains a domain name which matches the 449 name in the corresponding element. 451 o A element that contains same currency code that 452 appeared in the corresponding element. If no element appeared in the corresponding 454 element, then the client's default billing currency should be 455 used. 457 o A element that contains same command that appeared 458 in the corresponding element. This element MAY have 459 the OPTIONAL "phase" and "subphase" elements, which MUST match the 460 same attributes in the corresponding element. 462 o An OPTIONAL element that contains same unit that 463 appeared in the corresponding element. If the value 464 of the preceding element is "restore", this element 465 MUST NOT be included. Otherwise it MUST be included. If no appeared in the corresponding element (and 467 the command is not "restore") then this element MUST have a value 468 of 1 year. 470 o Zero or more elements. 472 o Zero or more elements. 474 o An OPTIONAL element. 476 If no elements are present in a element, this 477 indicates that the requested command is not permitted by server 478 policy. 480 The presence of one or more and elements with 481 a total value of "0.00" (ie a zero amount) in a element 482 indicates that no fee will be assessed by the server for this 483 command. 485 Example response: 487 S: 488 S: 489 S: 490 S: 491 S: Command completed successfully 492 S: 493 S: 494 S: 496 S: 497 S: example.com 498 S: 499 S: 500 S: example.net 501 S: In use 502 S: 503 S: 504 S: example.org 505 S: In use 506 S: 507 S: 508 S: 509 S: 510 S: 512 S: 513 S: example.com 514 S: USD 515 S: create 516 S: 1 517 S: 5.00 519 S: 5.00 522 S: 523 S: 524 S: example.net 525 S: EUR 526 S: 527 S: create 528 S: 2 529 S: 5.00 530 S: 531 S: 532 S: example.org 533 S: EUR 534 S: transfer 535 S: 2 536 S: 2.50 538 S: 10.00 541 S: 542 S: 543 S: example.xyz 544 S: GBP 545 S: restore 546 S: 25 548 S: premium-tier1 549 S: 550 S: 551 S: 552 S: 553 S: ABC-12345 554 S: 54322-XYZ 555 S: 556 S: 557 S: 559 5.1.2. EPP Transfer Query Command 561 This extension does not add any elements to the EPP query 562 command, but does include elements in the response, when the 563 extension has been selected during a command. 565 When the query command has been processed successfully, 566 the client selected the extension when it logged in, and the client 567 is authorised by the server to view information about the transfer, 568 the server MAY include in the section of the EPP response 569 a element that contains the following child elements: 571 o A element. 573 o A element. 575 o Zero or more elements containing the fees that will be 576 charged to the gaining client. 578 o Zero or more elements containing the credits that 579 will be refunded to the losing client. 581 Servers SHOULD omit when returning a response to the 582 gaining client, and omit elements when returning a response 583 to the losing client. 585 If no element is included in the response, then no fee 586 will be assessed by the server for the transfer. 588 Example query response: 590 S: 591 S: 592 S: 593 S: 594 S: Command completed successfully; action pending 595 S: 596 S: 597 S: 599 S: example.com 600 S: pending 601 S: ClientX 602 S: 2000-06-08T22:00:00.0Z 603 S: ClientY 604 S: 2000-06-13T22:00:00.0Z 605 S: 2002-09-08T22:00:00.0Z 606 S: 607 S: 608 S: 609 S: 610 S: USD 611 S: 1 612 S: 5.00 613 S: 614 S: 615 S: 616 S: ABC-12345 617 S: 54322-XYZ 618 S: 619 S: 620 S: 622 5.2. EPP Transform Commands 624 5.2.1. EPP Command 626 This extension adds elements to both the EPP command and 627 response, when the extension has been selected during a 628 command. 630 When submitting a command to the server, the client MAY 631 include in the element a element which 632 includes the following child elements: 634 o An OPTIONAL element; 636 o One or more elements. 638 When the command has been processed successfully, and the 639 client selected the extension when it logged in, and a fee was 640 assessed by the server for the transaction, the server MUST include 641 in the section of the EPP response a 642 element that contains the following child elements: 644 o A element; 646 o Zero or more elements; 648 o Zero or more elements; 650 o An OPTIONAL element; 652 o An OPTIONAL element. 654 If no fee or credit has been assessed by the server for this 655 transaction, a element MUST NOT be included in the 656 response. 658 Example command: 660 C: 661 C: 662 C: 663 C: 664 C: 666 C: example.com 667 C: 2 668 C: 669 C: ns1.example.net 670 C: ns2.example.net 671 C: 672 C: jd1234 673 C: sh8013 674 C: sh8013 675 C: 676 C: 2fooBAR 677 C: 678 C: 679 C: 680 C: 681 C: 682 C: USD 683 C: 5.00 684 C: 685 C: 686 C: ABC-12345 687 C: 688 C: 690 Example response: 692 S: 693 S: 694 S: 695 S: 696 S: Command completed successfully 697 S: 698 S: 699 S: 701 S: example.com 702 S: 1999-04-03T22:00:00.0Z 703 S: 2001-04-03T22:00:00.0Z 704 S: 705 S: 706 S: 707 S: 708 S: USD 709 S: 5.00 710 S: -5.00 711 S: 1000.00 712 S: 713 S: 714 S: 715 S: ABC-12345 716 S: 54321-XYZ 717 S: 718 S: 719 S: 721 5.2.2. EPP Command 723 This extension does not add any elements to the EPP command, 724 but does include elements in the response, when the extension has 725 been selected during the command. 727 When the command has been processed successfully, and the 728 client selected the extension when it logged in, the server MAY 729 include in the section of the EPP response a element that contains the following child elements: 732 o A element; 734 o Zero or more elements; 736 o An OPTIONAL element; 738 o An OPTIONAL element. 740 If no credit has been assessed by the server for this transaction, a 741 element MUST NOT be included in the response. 743 Example response: 745 S: 746 S: 747 S: 748 S: 749 S: Command completed successfully 750 S: 751 S: 752 S: 754 S: USD 755 S: -5.00 756 S: 1005.00 757 S: 758 S: 759 S: 760 S: ABC-12345 761 S: 54321-XYZ 762 S: 763 S: 764 S: 766 5.2.3. EPP Command 768 This extension adds elements to both the EPP command and 769 response, when the extension has been selected during a 770 command. 772 When submitting a command to the server, the client MAY 773 include in the element a element which 774 includes the following child elements: 776 o An OPTIONAL element; 778 o One or more elements. 780 When the command has been processed successfully, and the 781 client selected the extension when it logged in, the server MAY 782 include in the section of the EPP response a element that contains the following child elements: 785 o A element; 786 o Zero or more elements; 788 o Zero or more elements; 790 o An OPTIONAL element; 792 o An OPTIONAL element. 794 If no fee or credit has been assessed by the server for this 795 transaction, a element MUST NOT be included in the 796 response. 798 Example command: 800 C: 801 C: 802 C: 803 C: 804 C: 806 C: example.com 807 C: 2000-04-03 808 C: 5 809 C: 810 C: 811 C: 812 C: 813 C: USD 814 C: 5.00 815 C: 816 C: 817 C: ABC-12345 818 C: 819 C: 821 Example response: 823 S: 824 S: 825 S: 826 S: 827 S: Command completed successfully 828 S: 829 S: 830 S: 832 S: example.com 833 S: 2005-04-03T22:00:00.0Z 834 S: 835 S: 836 S: 837 S: 838 S: USD 839 S: 5.00 840 S: 1000.00 841 S: 842 S: 843 S: 844 S: ABC-12345 845 S: 54322-XYZ 846 S: 847 S: 848 S: 850 5.2.4. EPP Command 852 This extension adds elements to both the EPP command and 853 response, when the value of the "op" attribute of the 854 command element is "request", and the extension has been selected 855 during the command. 857 When submitting a command to the server, the client MAY 858 include in the element a element which 859 includes the following child elements: 861 o An OPTIONAL element; 863 o One or more elements. 865 When the command has been processed successfully, and the 866 client selected the extension when it logged in, the server MAY 867 include in the section of the EPP response a element that contains the following child elements: 870 o A element; 872 o Zero or more elements; 874 o Zero or more elements; 876 o An OPTIONAL element; 878 o An OPTIONAL element. 880 If no fee or credit has been assessed by the server for this 881 transaction, a element MUST NOT be included in the 882 response. 884 Example command: 886 C: 887 C: 888 C: 889 C: 890 C: 892 C: example.com 893 C: 1 894 C: 895 C: 2fooBAR 896 C: 897 C: 898 C: 899 C: 900 C: 901 C: USD 902 C: 5.00 903 C: 904 C: 905 C: ABC-12345 906 C: 907 C: 909 Example response: 911 S: 912 S: 913 S: 914 S: 915 S: Command completed successfully; action pending 916 S: 917 S: 918 S: 920 S: example.com 921 S: pending 922 S: ClientX 923 S: 2000-06-08T22:00:00.0Z 924 S: ClientY 925 S: 2000-06-13T22:00:00.0Z 926 S: 2002-09-08T22:00:00.0Z 927 S: 928 S: 929 S: 930 S: 931 S: USD 932 S: 5.00 933 S: 934 S: 935 S: 936 S: ABC-12345 937 S: 54322-XYZ 938 S: 939 S: 940 S: 942 5.2.5. EPP Command 944 This extension adds elements to both the EPP command and 945 response, when the extension has been selected during a has 946 been selected during the command. 948 When submitting a command to the server, the client MAY 949 include in the element a element which 950 includes the following child elements: 952 o An OPTIONAL element; 954 o One or more elements. 956 When the command has been processed successfully, and the 957 client selected the extension when it logged in, the server MAY 958 include in the section of the EPP response a 959 element that contains the following child elements: 961 o A element; 963 o Zero or more elements; 965 o Zero or more elements; 967 o An OPTIONAL element; 969 o An OPTIONAL element. 971 If no fee or credit has been assessed by the server for this 972 transaction, a element MUST NOT be included in the 973 response. 975 Example command: 977 C: 978 C: 979 C: 980 C: 981 C: 983 C: example.com 984 C: 985 C: sh8013 986 C: 987 C: 988 C: 989 C: 990 C: 991 C: USD 992 C: 5.00 993 C: 994 C: 995 C: ABC-12345 996 C: 997 C: 999 Example response: 1001 S: 1002 S: 1003 S: 1004 S: 1005 S: Command completed successfully 1006 S: 1007 S: 1008 S: 1009 S: USD 1010 S: 5.00 1011 S: 1012 S: 1013 S: 1014 S: ABC-12345 1015 S: 54321-XYZ 1016 S: 1017 S: 1018 S: 1020 5.3. Formal Syntax 1022 An EPP object mapping is specified in XML Schema notation. The 1023 formal syntax presented here is a complete schema representation of 1024 the object mapping suitable for automated validation of EPP XML 1025 instances. 1027 Copyright (c) 2014 IETF Trust and the persons identified as authors 1028 of the code. All rights reserved. 1030 Redistribution and use in source and binary forms, with or without 1031 modification, are permitted provided that the following conditions 1032 are met: 1034 o Redistributions of source code must retain the above copyright 1035 notice, this list of conditions and the following disclaimer. 1037 o Redistributions in binary form must reproduce the above copyright 1038 notice, this list of conditions and the following disclaimer in 1039 the documentation and/or other materials provided with the 1040 distribution. 1042 o Neither the name of Internet Society, IETF or IETF Trust, nor the 1043 names of specific contributors, may be used to endorse or promote 1044 products derived from this software without specific prior written 1045 permission. 1047 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1048 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1049 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1050 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 1051 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 1052 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 1053 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 1054 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 1055 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 1056 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 1057 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 1059 BEGIN 1060 1061 1068 1069 1071 1072 Extensible Provisioning Protocol 1073 v1.0 domain name extension schema for 1074 fee information. 1075 1077 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1092 1095 1096 1097 1099 1100 1102 1103 1104 1105 1107 1108 1110 1111 1113 1116 1117 1118 1120 1121 1123 1124 1125 1126 1127 1128 1130 1132 1134 1135 1136 1138 1141 1142 1143 1145 1147 1149 1150 1152 1155 1156 1157 1158 1160 1162 1164 1166 1167 1169 1172 1173 1174 1176 1177 1180 1182 1184 1185 1187 1190 1191 1192 1193 1195 1197 1199 1200 1202 1205 1206 1207 1208 1209 1211 1212 1213 1214 1215 1216 1217 1218 1220 1221 1222 1223 1224 1225 1227 1228 1229 1230 1231 1233 1234 1235 1236 1237 1239 1240 1241 1242 1243 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1258 1259 1260 1261 1262 1263 1264 1266 1267 1268 1270 1271 1272 1274 1276 END 1278 6. Security Considerations 1280 The mapping extensions described in this document do not provide any 1281 security services beyond those described by EPP [RFC5730], the EPP 1282 domain name mapping [RFC5731], and protocol layers used by EPP. The 1283 security considerations described in these other specifications apply 1284 to this specification as well. 1286 7. IANA Considerations 1288 7.1. XML Namespace 1290 This document uses URNs to describe XML namespaces and XML schemas 1291 conforming to a registry mechanism described in [RFC3688]. The 1292 following URI assignment is requested of IANA: 1294 URI: urn:ietf:params:xml:ns:fee-0.8 1296 Registrant Contact: See the "Author's Address" section of this 1297 document. 1299 XML: See the "Formal Syntax" section of this document. 1301 7.2. EPP Extension Registry 1303 The EPP extension described in this document should be registered by 1304 the IANA in the EPP Extension Registry described in [RFC7451]. The 1305 details of the registration are as follows: 1307 Name of Extension: EPP Fee Extension 1309 Document status: Standards Track 1311 Reference: (insert reference to RFC version of this document) 1313 Registrant Name and Email Address: See the "Author's Address" section 1314 of this document. 1316 TLDs: any 1318 IPR Disclosure: none 1320 Status: active 1322 Notes: none 1324 8. Implementation Status 1326 Note to RFC Editor: Please remove this section and the reference to 1327 [RFC6982] before publication. 1329 This section records the status of known implementations of the 1330 protocol defined by this specification at the time of posting of this 1331 Internet-Draft, and is based on a proposal described in [RFC6982]. 1332 The description of implementations in this section is intended to 1333 assist the IETF in its decision processes in progressing drafts to 1334 RFCs. Please note that the listing of any individual implementation 1335 here does not imply endorsement by the IETF. Furthermore, no effort 1336 has been spent to verify the information presented here that was 1337 supplied by IETF contributors. This is not intended as, and must not 1338 be construed to be, a catalog of available implementations or their 1339 features. Readers are advised to note that other implementations may 1340 exist. 1342 According to [RFC6982], "this will allow reviewers and working groups 1343 to assign due consideration to documents that have the benefit of 1344 running code, which may serve as evidence of valuable experimentation 1345 and feedback that have made the implemented protocols more mature. 1346 It is up to the individual working groups to use this information as 1347 they see fit". 1349 8.1. RegistryEngine EPP Service 1351 Organization: CentralNic 1353 Name: RegistryEngine EPP Service 1355 Description: Generic high-volume EPP service for gTLDs, ccTLDs and 1356 SLDs 1358 Level of maturity: Deployed in CentralNic's production environment as 1359 well as two other gTLD registry systems, and two ccTLD registry 1360 systems. 1362 Coverage: All aspects of the protocol are implemented. 1364 Licensing: Proprietary In-House software 1366 Contact: epp@centralnic.com 1368 URL: https://www.centralnic.com 1370 9. Acknowledgements 1372 The author wishes to thank the following persons for their feedback 1373 and suggestions: 1375 o James Gould of Verisign 1377 o Luis Munoz of ISC 1378 o Michael Young of Architelos 1380 o Ben Levac and Jeff Eckhaus of Demand Media 1382 o Seth Goldman of Google 1384 o Klaus Malorny and Michael Bauland of Knipp 1386 o Jody Kolker and Roger Carney of Go Daddy 1388 o Michael Holloway of Com Laude 1390 o Santosh Kalsangrah of Impetus Infotech 1392 10. Change History 1394 10.1. Changes from 00 to 01 1396 1. Restore the command extension; either or 1397 can be used. 1399 2. added extension elements for , , and 1400 so that the server can reject the command if the fee is 1401 incorrect. 1403 10.2. Changes from 01 to 02 1405 1. Use Internet-Draft version number rather than XML namespace 1406 version number in this section. 1408 2. Support for multiple and elements. 1410 3. Added the "description" attribute to and 1411 elements. 1413 4. Added the element. 1415 5. Added the element. 1417 6. Updated reference to [draft-ietf-eppext-launchphase]. 1419 7. Use instead of . 1421 8. Use a single child element of instead of multiple 1422 elements for each domain. This also requires using a different 1423 name () for the domain name. 1425 9. Added the "refundable" attribute to elements. 1427 10. Added the "grace-period" attribute to elements. 1429 10.3. Changes from 02 to 03 1431 1. Added the "applied" attribute to to elements. 1433 2. Simplified the wording in relation to when a server can return an 1434 error for extended commands. 1436 3. Added the element to transfer query responses. 1438 4. Removed wording about how servers behave when receiving incorrect 1439 fee information from transform commands, and put it into a single 1440 section at the top of the document. 1442 5. Allow servers to omit elements from elements 1443 if the command specified by the client is forbidden. 1445 10.4. Changes from 03 to 04 1447 1. Changed Intended Status to Standards Track. 1449 2. As per suggestion from Michael Bauland, the element 1450 is no longer included in and responses for 1451 "restore" commands. It's still mandatory for all other commands. 1453 3. Added summary of the attributes for the element. 1455 4. Clarified that the "refundable" and "grace-period" attributes of 1456 the elements are dependant on each other and cannot 1457 appear on their own. 1459 5. Removed the option of returning a 1001 response when the fee is 1460 incorrect. 1462 6. Forbidden the inclusion of extension elements in transform 1463 responses if no fee/credit has been assessed. 1465 7. Made the element optional in transform commands. 1467 8. Amended XML Namespace section of IANA Considerations, added EPP 1468 Extension Registry section. 1470 10.5. Changes from 04 to 05 1472 1. Removed the extended command. The command is the 1473 only command that can be used now. 1475 2. Introduced a mandatory-to-implement "standard" class for non- 1476 premium domains. 1478 3. The decision was made to keep availability info in 1479 responses as registrars have indicated that it is very useful as 1480 it avoids unnecessary round trips to the server. 1482 4. Allow elements to be present in responses. 1484 5. Allow the number of which can appear in transform 1485 responses to be zero. 1487 6. Removed the and elements from 1488 transfer query responses. The reason is that these elements are 1489 defined as containing the values after the transform command has 1490 taken place - which means that it is not appropriate to include 1491 them in a query response. 1493 7. Added Implementation Status section. 1495 11. TODO 1497 (Note to RFC Editor: remove this section before publication as an 1498 RFC.) 1500 1. Make the extension object-agnostic so it can be used with other 1501 objects, not just vanilla domains. 1503 12. Normative References 1505 [ISO4217] International Organization for Standardization, "ISO 4217: 1506 2008, Codes for the representation of currencies and 1507 funds", 2008. 1509 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1510 Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/ 1511 RFC2119, March 1997, 1512 . 1514 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 1515 DOI 10.17487/RFC3688, January 2004, 1516 . 1518 [RFC3915] Hollenbeck, S., "Domain Registry Grace Period Mapping for 1519 the Extensible Provisioning Protocol (EPP)", RFC 3915, 1520 DOI 10.17487/RFC3915, September 2004, 1521 . 1523 [RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", 1524 STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009, 1525 . 1527 [RFC5731] Hollenbeck, S., "Extensible Provisioning Protocol (EPP) 1528 Domain Name Mapping", STD 69, RFC 5731, DOI 10.17487/ 1529 RFC5731, August 2009, 1530 . 1532 [RFC6982] Sheffer, Y. and A. Farrel, "Improving Awareness of Running 1533 Code: The Implementation Status Section", RFC 6982, 1534 DOI 10.17487/RFC6982, July 2013, 1535 . 1537 [RFC7451] Hollenbeck, S., "Extension Registry for the Extensible 1538 Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451, 1539 February 2015, . 1541 [draft-ietf-eppext-launchphase] 1542 Gould, J., Tan, W., and G. Brown, "Launch Phase Mapping 1543 for the Extensible Provisioning Protocol (EPP)", 2014. 1545 Author's Address 1547 Gavin Brown 1548 CentralNic Group plc 1549 35-39 Moorgate 1550 London, England EC2R 6AR 1551 GB 1553 Phone: +44 20 33 88 0600 1554 Email: gavin.brown@centralnic.com 1555 URI: https://www.centralnic.com