idnits 2.17.1 draft-brown-epp-fees-07.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 (April 8, 2016) is 2939 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 J. Frakes 5 Expires: October 10, 2016 April 8, 2016 7 Registry Fee Extension for the Extensible Provisioning Protocol (EPP) 8 draft-brown-epp-fees-07 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 October 10, 2016. 32 Copyright Notice 34 Copyright (c) 2016 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. Correlation between Refundability and Grace Periods . 7 60 3.4.4. Applicability . . . . . . . . . . . . . . . . . . . . 7 61 3.5. Account Balance . . . . . . . . . . . . . . . . . . . . . 7 62 3.6. Credit Limit . . . . . . . . . . . . . . . . . . . . . . . 7 63 3.7. Classification of Objects . . . . . . . . . . . . . . . . 8 64 4. Server Handling of Fee Information . . . . . . . . . . . . . . 8 65 5. EPP Command Mapping . . . . . . . . . . . . . . . . . . . . . 8 66 5.1. EPP Query Commands . . . . . . . . . . . . . . . . . . . . 9 67 5.1.1. EPP Command . . . . . . . . . . . . . . . . . 9 68 5.1.1.1. Server Handling of Elements . . . . . 12 69 5.1.2. EPP Transfer Query Command . . . . . . . . . . . . . . 13 70 5.2. EPP Transform Commands . . . . . . . . . . . . . . . . . . 14 71 5.2.1. EPP Command . . . . . . . . . . . . . . . . . 14 72 5.2.2. EPP Command . . . . . . . . . . . . . . . . . 17 73 5.2.3. EPP Command . . . . . . . . . . . . . . . . . 18 74 5.2.4. EPP Command . . . . . . . . . . . . . . . . 20 75 5.2.5. EPP Command . . . . . . . . . . . . . . . . . 22 76 5.3. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . 24 77 6. Security Considerations . . . . . . . . . . . . . . . . . . . 29 78 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 30 79 7.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 30 80 7.2. EPP Extension Registry . . . . . . . . . . . . . . . . . . 30 81 8. Implementation Status . . . . . . . . . . . . . . . . . . . . 30 82 8.1. RegistryEngine EPP Service . . . . . . . . . . . . . . . . 31 83 9. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 31 84 10. Change History . . . . . . . . . . . . . . . . . . . . . . . . 32 85 10.1. Changes from 00 to 01 . . . . . . . . . . . . . . . . . . 32 86 10.2. Changes from 01 to 02 . . . . . . . . . . . . . . . . . . 32 87 10.3. Changes from 02 to 03 . . . . . . . . . . . . . . . . . . 33 88 10.4. Changes from 03 to 04 . . . . . . . . . . . . . . . . . . 33 89 10.5. Changes from 04 to 05 . . . . . . . . . . . . . . . . . . 34 90 10.6. Changes from 05 to 06 . . . . . . . . . . . . . . . . . . 34 91 10.7. Changes from 06 to 07 . . . . . . . . . . . . . . . . . . 35 92 11. Normative References . . . . . . . . . . . . . . . . . . . . . 35 93 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 36 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 128 "urn:ietf:params:xml:ns:fee-0.11". The XML namespace prefix "fee" is 129 used, but implementations MUST NOT depend on it and instead employ a 130 proper namespace-aware XML parser and serializer to interpret and 131 output the XML documents. 133 (Note to RFC Editor: remove the following paragraph before 134 publication as an RFC.) 136 The XML namespace prefix above contains a version number, 137 specifically "0.11". This version number will increment with 138 successive versions of this document, and will reach 1.0 if and when 139 this document is published as an RFC. This permits clients to 140 distinguish which version of the extension a server has implemented. 142 2. Migrating to Newer Versions of This Extension 144 (Note to RFC Editor: remove this section before publication as an 145 RFC.) 147 Servers which implement this extension SHOULD provide a way for 148 clients to progressively update their implementations when a new 149 version of the extension is deployed. 151 Servers SHOULD (for a temporary migration period) provide support for 152 older versions of the extension in parallel to the newest version, 153 and allow clients to select their preferred version via the 154 element of the command. 156 If a client requests multiple versions of the extension at login, 157 then, when preparing responses to commands which do not include 158 extension elements, the server SHOULD only include extension elements 159 in the namespace of the newest version of the extension requested by 160 the client. 162 When preparing responses to commands which do include extension 163 elements, the server SHOULD only include extension elements for the 164 extension versions present in the command. 166 3. Extension Elements 168 3.1. Client Commands 170 The element is used in the EPP command to 171 determine the fee which is applicable to the given command. 173 The element values permitted by the server is a matter of repository 174 policy, but MUST include as a minimum the following values: 176 o "create" indicating a command; 178 o "renew" indicating a command; 180 o "transfer" indicating a command; 182 If the server supports the Registry Grace Period Mapping [RFC3915], 183 then the server MUST also support the "restore" value. 185 The element MAY have an OPTIONAL "phase" attribute 186 specifying a launch phase as described in 187 [draft-ietf-eppext-launchphase]. It may also contain an OPTIONAL 188 "subphase" attribute identifying the custom or sub-phase as described 189 in [draft-ietf-eppext-launchphase]. 191 3.2. Currency Codes 193 The element is used to indicate which currency fees 194 are charged in. This value of this element MUST be a three-character 195 currency code from [ISO4217]. 197 Note that ISO 4217 provides the special "XXX" code, which MAY be used 198 if the server uses a non-currency based system for assessing fees, 199 such as a system of credits. 201 The use of elements in commands is OPTIONAL: if a 202 element is not present in a command, the server MUST 203 determine the currency based on the client's account settings which 204 MUST be agreed by the client and server via an out-of-band channel. 205 However, the element MUST be present in responses. 207 Servers SHOULD NOT perform a currency conversion if a client uses an 208 incorrect currency code. Servers SHOULD return a 2004 error instead. 210 3.3. Validity Periods 212 When querying for fee information using the command, the 213 element is used to indicate the units to be added to the 214 registration period of objects by the , and 215 commands. This element is derived from the element described in [RFC5731]. 218 The element is OPTIONAL in commands: if omitted, 219 the server MUST determine the fee(s) using a validity period of 1 220 year. The element MUST be present in responses. 222 3.4. Fees and Credits 224 Servers which implement this extension will include elements in 225 responses which provide information about the fees and/or credits 226 associated with a given billable transaction. 228 The and elements are used to provide this 229 information. The presence of a element in a response 230 indicates a debit against the client's account balance; a element indicates a credit. A element MUST have a 232 non-negative value. A element MUST have a negative 233 value. 235 A server MAY respond with multiple and 236 elements in the same response. In such cases, the net fee or credit 237 applicable to the transaction is the arithmetic sum of the values of 238 each of the and/or elements. This amount 239 applies to the total additional validity period applied to the object 240 (where applicable) rather than to any incremental unit. 242 The following attributes are defined for the element. 243 These are described in detail below: 245 description: an OPTIONAL attribute which provides a human-readable 246 description of the fee. Servers should provide documentation on 247 the possible values of this attribute, and their meanings. 249 refundable: an OPTIONAL boolean attribute indicating whether the fee 250 is refundable if the object is deleted. 252 grace-period: an OPTIONAL attribute which provides the time period 253 during which the fee is refundable. 255 applied: an OPTIONAL attribute indicating when the fee will be 256 deducted from the client's account. 258 The element can take a "description" attribute as 259 described above. No other attributes are defined for this element. 261 3.4.1. Refunds 263 elements MAY have an OPTIONAL "refundable" attribute which 264 takes a boolean value. Fees may be refunded under certain 265 circumstances, such as when a domain application is rejected (as 266 described in [draft-ietf-eppext-launchphase]) or when an object is 267 deleted during the relevant Grace Period (see below). 269 If the "refundable" attribute is omitted, then clients SHOULD NOT 270 make any assumption about the refundability of the fee. 272 3.4.2. Grace Periods 274 [RFC3915] describes a system of "grace periods", which are time 275 periods following a billable transaction during which, if an object 276 is deleted, the client receives a refund. 278 The "grace-period" attribute MAY be used to indicate the relevant 279 grace period for a fee. If a server implements the Registry Grace 280 Period extension, it MUST specify the grace period for all relevant 281 transactions. 283 If the "grace-period" attribute is omitted, then clients SHOULD NOT 284 make any assumption about the grace period of the fee. 286 3.4.3. Correlation between Refundability and Grace Periods 288 If a element has a "grace-period" attribute then it MUST 289 also be refundable. If the "refundable" attribute of a 290 element is false then it MUST NOT have a "grace-period" attribute. 292 3.4.4. Applicability 294 Fees may be applied immediately upon receipt of a command from a 295 client, or may only be applied once an out-of-band process (such as 296 the processing of applications at the end of a launch phase) has 297 taken place. 299 The "applied" attribute of the element allows servers to 300 indicate whether a fee will be applied immediately, or whether it 301 will be applied at some point in the future. This attribute takes 302 two possible values: "immediate" (which is the default) or "delayed". 304 3.5. Account Balance 306 The element is an OPTIONAL element which MAY be 307 included in server responses to transform commands. If present, it 308 can be used by the client to determine the remaining credit at the 309 server. 311 Whether or not the is included in responses is a matter 312 of server policy. However, if a server chooses to offer support for 313 this element, it MUST be included in responses to all "transform" 314 commands (ie , , , , ). 317 The value of the MAY be negative. A negative balance 318 indicates that the server has extended a line of credit to the client 319 (see below). 321 If a server includes a element in response to transform 322 commands, the value of the element MUST reflect the client's account 323 balance after any fees or credits associated with that command have 324 been applied. 326 3.6. Credit Limit 328 As described above, if a server returns a response containing a with a negative value, then the server has extended a line 330 of credit to the client. A server MAY also include a element in responses which indicates the maximum credit 332 available to a client. A server MAY reject certain transactions if 333 the absolute value of the is equal to or exceeds the 334 value of the element. 336 Whether or not the is included in responses is a 337 matter of server policy. However, if a server chooses to offer 338 support for this element, it MUST be included in responses to all 339 "transform" commands (ie , , , , 340 ). 342 3.7. Classification of Objects 344 Objects may be assigned to a particular class, category, or tier, 345 each of which has a particular fee or set of fees associated with it. 346 The element which appears in responses is used to 347 indicate the classification of an object. 349 If a server makes use of this element, it should provide clients with 350 a list of all the values that the element may take via an out-of-band 351 channel. Servers MUST NOT use values which do not appear on this 352 list. 354 Servers which make use of this element MUST use a element 355 with the value "standard" for all objects that are subject to the 356 standard or default fee. 358 4. Server Handling of Fee Information 360 Depending on server policy, a client MAY be required to include the 361 extension elements described in this document for certain transform 362 commands. Servers must provide clear documentation to clients about 363 the circumstances in which this extension must be used. 365 If a server receives a command from a client which does not include 366 the extension elements required by the server for that command, then 367 it MUST respond with a 2003 "Required parameter missing" error. 369 If the currency or total fee provided by the client do not agree with 370 the server's own calculation of the fee for that command, then the 371 server MUST reject the command with a 2004 "Parameter value range" 372 error. 374 5. EPP Command Mapping 376 A detailed description of the EPP syntax and semantics can be found 377 in [RFC5730]. 379 5.1. EPP Query Commands 381 This extension does not add any elements to the EPP or 382 commands or responses. 384 5.1.1. EPP Command 386 This extension defines additional elements for the EPP 387 command. 389 The command MAY contain an element which MAY contain a 390 element. The element contains the following 391 child elements: 393 o A element; 395 o An OPTIONAL element; 397 o An OPTIONAL element. 399 o An OPTIONAL element. 401 Example command: 403 C: 404 C: 405 C: 406 C: 407 C: 409 C: example.com 410 C: example.net 411 C: example.xyz 412 C: 413 C: 414 C: 415 C: 416 C: create 417 C: USD 418 C: 419 C: 420 C: ABC-12345 421 C: 422 C: 424 When the server receives a command that includes the 425 extension elements described above, its response MUST (subject to the 426 exception described below) contain an element, which MUST 427 contain a child element. The element 428 MUST contain a element for each object referenced in the 429 element in the command. 431 The element has an OPTIONAL "avail" atribute which is a 432 boolean. If the value of this attribute evalutes to false, this 433 indicates that the server cannot calculate the relevant fees, because 434 the object, command, currency, period or class is invalid according 435 to server policy. 437 The contains the following child elements: 439 o A element, which contains a copy of the child element 440 of the element of the command, to which the fee 441 information relates. 443 o A element, which contains the same command that 444 appeared in the corresponding element. This element 445 MAY have the OPTIONAL "phase" and "subphase" elements, which MUST 446 match the same attributes in the corresponding 447 element. 449 o A element, which contains the same currency code 450 that appeared in the element of the command. If no 451 element appeared in the command, then the client's 452 default billing currency should be used. 454 o An OPTIONAL element, which contains the same unit 455 that appeared in the element of the command. If 456 the value of the preceding element is "restore", 457 this element MUST NOT be included. Otherwise it MUST be included. 458 If no appeared in command (and the command is not 459 "restore") then this element MUST have a value of 1 year. 461 o Zero or more elements. 463 o Zero or more elements. 465 o An OPTIONAL element. 467 o An OPTIONAL element. 469 If no elements are present in a element, this 470 indicates that no fee will be assessed by the server for this 471 command. 473 If the "avail" attribute of the element is false, then the 474 element MUST NOT contain any or child 475 elements. If the "avail" attribute is true, then the 476 element MUST NOT contain a element. 478 Example response: 480 S: 481 S: 482 S: 483 S: 484 S: Command completed successfully 485 S: 486 S: 487 S: 489 S: 490 S: example.com 491 S: 492 S: 493 S: example.net 494 S: 495 S: 496 S: example.xyz 497 S: 498 S: 499 S: 500 S: 501 S: 504 S: 505 S: 506 S: example.com 507 S: 508 S: create 509 S: USD 510 S: 1 511 S: 5.00 515 S: 516 S: 517 S: 518 S: example.com 519 S: 520 S: create 521 S: USD 522 S: 1 523 S: 5.00 527 S: 528 S: 529 S: 530 S: example.com 531 S: 532 S: create 533 S: USD 534 S: 1 535 S: 536 S: minimum period is 2 years. 537 S: 538 S: 539 S: 540 S: 541 S: 542 S: ABC-12345 543 S: 54322-XYZ 544 S: 545 S: 546 S: 548 5.1.1.1. Server Handling of Elements 550 Clients MAY include a in the element. There 551 are three ways in which servers may handle this element: 553 1. If the server supports the concept of tiers or classes of 554 objects, then the value of this element MUST be validated. If 555 incorrect for the specified object, the "avail" attribute of the 556 corresponding element MUST be false. 558 2. If the server supports different "types" of object registrations 559 (such as a "blocking" registration which does not resolve, or 560 where a registry provides a value-added service that requires an 561 opt-out to disable), then, as with the first model, the server 562 MUST valudate the value of the element. If the value is 563 incorrect, the "avail" attribute of the corresponding 564 element MUST be false. 566 3. If the server supports neither of the above models, the element 567 MUST be ignored. 569 Server operators must provide clear documentation to client operators 570 which of the above models it supports. 572 5.1.2. EPP Transfer Query Command 574 This extension does not add any elements to the EPP query 575 command, but does include elements in the response, when the 576 extension has been selected during a command. 578 When the query command has been processed successfully, 579 the client selected the extension when it logged in, and the client 580 is authorised by the server to view information about the transfer, 581 the server MAY include in the section of the EPP response 582 a element, which contains the following child elements: 584 o A element. 586 o A element. 588 o Zero or more elements containing the fees that will be 589 charged to the gaining client. 591 o Zero or more elements containing the credits that 592 will be refunded to the losing client. 594 Servers SHOULD omit when returning a response to the 595 gaining client, and omit elements when returning a response 596 to the losing client. 598 If no element is included in the response, then no fee 599 will be assessed by the server for the transfer. 601 Example query response: 603 S: 604 S: 605 S: 606 S: 607 S: Command completed successfully; action pending 608 S: 609 S: 610 S: 612 S: example.com 613 S: pending 614 S: ClientX 615 S: 2000-06-08T22:00:00.0Z 616 S: ClientY 617 S: 2000-06-13T22:00:00.0Z 618 S: 2002-09-08T22:00:00.0Z 619 S: 620 S: 621 S: 622 S: 623 S: USD 624 S: 1 625 S: 5.00 626 S: 627 S: 628 S: 629 S: ABC-12345 630 S: 54322-XYZ 631 S: 632 S: 633 S: 635 5.2. EPP Transform Commands 637 5.2.1. EPP Command 639 This extension adds elements to both the EPP command and 640 response, when the extension has been selected during a 641 command. 643 When submitting a command to the server, the client MAY 644 include in the element a element which 645 includes the following child elements: 647 o An OPTIONAL element; 649 o One or more elements. 651 When the command has been processed successfully, and the 652 client selected the extension when it logged in, and a fee was 653 assessed by the server for the transaction, the server MUST include 654 in the section of the EPP response a 655 element, which contains the following child elements: 657 o A element; 659 o Zero or more elements; 661 o Zero or more elements; 663 o An OPTIONAL element; 665 o An OPTIONAL element. 667 If no fee or credit has been assessed by the server for this 668 transaction, a element MUST NOT be included in the 669 response. 671 Example command: 673 C: 674 C: 675 C: 676 C: 677 C: 679 C: example.com 680 C: 2 681 C: 682 C: ns1.example.net 683 C: ns2.example.net 684 C: 685 C: jd1234 686 C: sh8013 687 C: sh8013 688 C: 689 C: 2fooBAR 690 C: 691 C: 692 C: 693 C: 694 C: 695 C: USD 696 C: 5.00 697 C: 698 C: 699 C: ABC-12345 700 C: 701 C: 703 Example response: 705 S: 706 S: 707 S: 708 S: 709 S: Command completed successfully 710 S: 711 S: 712 S: 714 S: example.com 715 S: 1999-04-03T22:00:00.0Z 716 S: 2001-04-03T22:00:00.0Z 717 S: 718 S: 719 S: 720 S: 721 S: USD 722 S: 5.00 723 S: -5.00 724 S: 1000.00 725 S: 726 S: 727 S: 728 S: ABC-12345 729 S: 54321-XYZ 730 S: 731 S: 732 S: 734 5.2.2. EPP Command 736 This extension does not add any elements to the EPP command, 737 but does include elements in the response, when the extension has 738 been selected during the command. 740 When the command has been processed successfully, and the 741 client selected the extension when it logged in, the server MAY 742 include in the section of the EPP response a element, which contains the following child elements: 745 o A element; 747 o Zero or more elements; 749 o An OPTIONAL element; 751 o An OPTIONAL element. 753 If no credit has been assessed by the server for this transaction, a 754 element MUST NOT be included in the response. 756 Example response: 758 S: 759 S: 760 S: 761 S: 762 S: Command completed successfully 763 S: 764 S: 765 S: 767 S: USD 768 S: -5.00 769 S: 1005.00 770 S: 771 S: 772 S: 773 S: ABC-12345 774 S: 54321-XYZ 775 S: 776 S: 777 S: 779 5.2.3. EPP Command 781 This extension adds elements to both the EPP command and 782 response, when the extension has been selected during a 783 command. 785 When submitting a command to the server, the client MAY 786 include in the element a element which 787 includes the following child elements: 789 o An OPTIONAL element; 791 o One or more elements. 793 When the command has been processed successfully, and the 794 client selected the extension when it logged in, the server MAY 795 include in the section of the EPP response a element, which contains the following child elements: 798 o A element; 799 o Zero or more elements; 801 o Zero or more elements; 803 o An OPTIONAL element; 805 o An OPTIONAL element. 807 If no fee or credit has been assessed by the server for this 808 transaction, a element MUST NOT be included in the 809 response. 811 Example command: 813 C: 814 C: 815 C: 816 C: 817 C: 819 C: example.com 820 C: 2000-04-03 821 C: 5 822 C: 823 C: 824 C: 825 C: 826 C: USD 827 C: 5.00 828 C: 829 C: 830 C: ABC-12345 831 C: 832 C: 834 Example response: 836 S: 837 S: 838 S: 839 S: 840 S: Command completed successfully 841 S: 842 S: 843 S: 845 S: example.com 846 S: 2005-04-03T22:00:00.0Z 847 S: 848 S: 849 S: 850 S: 851 S: USD 852 S: 5.00 853 S: 1000.00 854 S: 855 S: 856 S: 857 S: ABC-12345 858 S: 54322-XYZ 859 S: 860 S: 861 S: 863 5.2.4. EPP Command 865 This extension adds elements to both the EPP command and 866 response, when the value of the "op" attribute of the 867 command element is "request", and the extension has been selected 868 during the command. 870 When submitting a command to the server, the client MAY 871 include in the element a element which 872 includes the following child elements: 874 o An OPTIONAL element; 876 o One or more elements. 878 When the command has been processed successfully, and the 879 client selected the extension when it logged in, the server MAY 880 include in the section of the EPP response a element, which contains the following child elements: 883 o A element; 885 o Zero or more elements; 887 o Zero or more elements; 889 o An OPTIONAL element; 891 o An OPTIONAL element. 893 If no fee or credit has been assessed by the server for this 894 transaction, a element MUST NOT be included in the 895 response. 897 Example command: 899 C: 900 C: 901 C: 902 C: 903 C: 905 C: example.com 906 C: 1 907 C: 908 C: 2fooBAR 909 C: 910 C: 911 C: 912 C: 913 C: 914 C: USD 915 C: 5.00 916 C: 917 C: 918 C: ABC-12345 919 C: 920 C: 922 Example response: 924 S: 925 S: 926 S: 927 S: 928 S: Command completed successfully; action pending 929 S: 930 S: 931 S: 933 S: example.com 934 S: pending 935 S: ClientX 936 S: 2000-06-08T22:00:00.0Z 937 S: ClientY 938 S: 2000-06-13T22:00:00.0Z 939 S: 2002-09-08T22:00:00.0Z 940 S: 941 S: 942 S: 943 S: 944 S: USD 945 S: 5.00 946 S: 947 S: 948 S: 949 S: ABC-12345 950 S: 54322-XYZ 951 S: 952 S: 953 S: 955 5.2.5. EPP Command 957 This extension adds elements to both the EPP command and 958 response, when the extension has been selected during a has 959 been selected during the command. 961 When submitting a command to the server, the client MAY 962 include in the element a element which 963 includes the following child elements: 965 o An OPTIONAL element; 967 o One or more elements. 969 When the command has been processed successfully, and the 970 client selected the extension when it logged in, the server MAY 971 include in the section of the EPP response a 972 element, which contains the following child elements: 974 o A element; 976 o Zero or more elements; 978 o Zero or more elements; 980 o An OPTIONAL element; 982 o An OPTIONAL element. 984 If no fee or credit has been assessed by the server for this 985 transaction, a element MUST NOT be included in the 986 response. 988 Example command: 990 C: 991 C: 992 C: 993 C: 994 C: 996 C: example.com 997 C: 998 C: sh8013 999 C: 1000 C: 1001 C: 1002 C: 1003 C: 1004 C: USD 1005 C: 5.00 1006 C: 1007 C: 1008 C: ABC-12345 1009 C: 1010 C: 1012 Example response: 1014 S: 1015 S: 1016 S: 1017 S: 1018 S: Command completed successfully 1019 S: 1020 S: 1021 S: 1022 S: USD 1023 S: 5.00 1024 S: 1025 S: 1026 S: 1027 S: ABC-12345 1028 S: 54321-XYZ 1029 S: 1030 S: 1031 S: 1033 5.3. Formal Syntax 1035 An EPP object mapping is specified in XML Schema notation. The 1036 formal syntax presented here is a complete schema representation of 1037 the object mapping suitable for automated validation of EPP XML 1038 instances. 1040 Copyright (c) 2014 IETF Trust and the persons identified as authors 1041 of the code. All rights reserved. 1043 Redistribution and use in source and binary forms, with or without 1044 modification, are permitted provided that the following conditions 1045 are met: 1047 o Redistributions of source code must retain the above copyright 1048 notice, this list of conditions and the following disclaimer. 1050 o Redistributions in binary form must reproduce the above copyright 1051 notice, this list of conditions and the following disclaimer in 1052 the documentation and/or other materials provided with the 1053 distribution. 1055 o Neither the name of Internet Society, IETF or IETF Trust, nor the 1056 names of specific contributors, may be used to endorse or promote 1057 products derived from this software without specific prior written 1058 permission. 1060 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1061 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1062 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1063 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 1064 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 1065 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 1066 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 1067 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 1068 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 1069 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 1070 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 1072 BEGIN 1073 1074 1081 1082 1084 1085 Extensible Provisioning Protocol 1086 v1.0 extension schema for fee 1087 information. 1088 1090 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1105 1108 1109 1110 1111 1113 1115 1117 1118 1120 1123 1124 1125 1127 1128 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1143 1145 1147 1148 1149 1150 1151 1153 1156 1157 1158 1160 1162 1164 1165 1167 1170 1171 1172 1173 1175 1177 1179 1181 1182 1184 1187 1188 1189 1191 1192 1195 1197 1199 1200 1202 1205 1206 1207 1208 1210 1212 1214 1215 1217 1220 1221 1222 1223 1224 1226 1227 1228 1229 1230 1231 1232 1233 1235 1236 1237 1238 1239 1240 1242 1243 1244 1245 1246 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1271 1272 1273 1274 1275 1276 1277 1279 1280 1281 1283 1284 1285 1287 1289 END 1291 6. Security Considerations 1293 The mapping extensions described in this document do not provide any 1294 security services beyond those described by EPP [RFC5730], the EPP 1295 domain name mapping [RFC5731], and protocol layers used by EPP. The 1296 security considerations described in these other specifications apply 1297 to this specification as well. 1299 7. IANA Considerations 1301 7.1. XML Namespace 1303 This document uses URNs to describe XML namespaces and XML schemas 1304 conforming to a registry mechanism described in [RFC3688]. The 1305 following URI assignment is requested of IANA: 1307 URI: urn:ietf:params:xml:ns:fee-0.11 1309 Registrant Contact: See the "Author's Address" section of this 1310 document. 1312 XML: See the "Formal Syntax" section of this document. 1314 7.2. EPP Extension Registry 1316 The EPP extension described in this document should be registered by 1317 the IANA in the EPP Extension Registry described in [RFC7451]. The 1318 details of the registration are as follows: 1320 Name of Extension: EPP Fee Extension 1322 Document status: Standards Track 1324 Reference: (insert reference to RFC version of this document) 1326 Registrant Name and Email Address: See the "Author's Address" section 1327 of this document. 1329 TLDs: any 1331 IPR Disclosure: none 1333 Status: active 1335 Notes: none 1337 8. Implementation Status 1339 Note to RFC Editor: Please remove this section and the reference to 1340 [RFC6982] before publication. 1342 This section records the status of known implementations of the 1343 protocol defined by this specification at the time of posting of this 1344 Internet-Draft, and is based on a proposal described in [RFC6982]. 1345 The description of implementations in this section is intended to 1346 assist the IETF in its decision processes in progressing drafts to 1347 RFCs. Please note that the listing of any individual implementation 1348 here does not imply endorsement by the IETF. Furthermore, no effort 1349 has been spent to verify the information presented here that was 1350 supplied by IETF contributors. This is not intended as, and must not 1351 be construed to be, a catalog of available implementations or their 1352 features. Readers are advised to note that other implementations may 1353 exist. 1355 According to [RFC6982], "this will allow reviewers and working groups 1356 to assign due consideration to documents that have the benefit of 1357 running code, which may serve as evidence of valuable experimentation 1358 and feedback that have made the implemented protocols more mature. 1359 It is up to the individual working groups to use this information as 1360 they see fit". 1362 8.1. RegistryEngine EPP Service 1364 Organization: CentralNic 1366 Name: RegistryEngine EPP Service 1368 Description: Generic high-volume EPP service for gTLDs, ccTLDs and 1369 SLDs 1371 Level of maturity: Deployed in CentralNic's production environment as 1372 well as two other gTLD registry systems, and two ccTLD registry 1373 systems. 1375 Coverage: All aspects of the protocol are implemented. 1377 Licensing: Proprietary In-House software 1379 Contact: epp@centralnic.com 1381 URL: https://www.centralnic.com 1383 9. Acknowledgements 1385 The authors wish to thank the following persons for their feedback 1386 and suggestions: 1388 o James Gould of Verisign 1390 o Luis Munoz of ISC 1391 o Michael Young of Architelos 1393 o Ben Levac and Jeff Eckhaus of Demand Media 1395 o Seth Goldman of Google 1397 o Klaus Malorny and Michael Bauland of Knipp 1399 o Jody Kolker and Roger Carney of Go Daddy 1401 o Michael Holloway of Com Laude 1403 o Santosh Kalsangrah of Impetus Infotech 1405 o Alex Mayrhofer of Nic.at 1407 10. Change History 1409 10.1. Changes from 00 to 01 1411 1. Restore the command extension; either or 1412 can be used. 1414 2. added extension elements for , , and 1415 so that the server can reject the command if the fee is 1416 incorrect. 1418 10.2. Changes from 01 to 02 1420 1. Use Internet-Draft version number rather than XML namespace 1421 version number in this section. 1423 2. Support for multiple and elements. 1425 3. Added the "description" attribute to and 1426 elements. 1428 4. Added the element. 1430 5. Added the element. 1432 6. Updated reference to [draft-ietf-eppext-launchphase]. 1434 7. Use instead of . 1436 8. Use a single child element of instead of multiple 1437 elements for each domain. This also requires using a different 1438 name () for the domain name. 1440 9. Added the "refundable" attribute to elements. 1442 10. Added the "grace-period" attribute to elements. 1444 10.3. Changes from 02 to 03 1446 1. Added the "applied" attribute to to elements. 1448 2. Simplified the wording in relation to when a server can return an 1449 error for extended commands. 1451 3. Added the element to transfer query responses. 1453 4. Removed wording about how servers behave when receiving incorrect 1454 fee information from transform commands, and put it into a single 1455 section at the top of the document. 1457 5. Allow servers to omit elements from elements 1458 if the command specified by the client is forbidden. 1460 10.4. Changes from 03 to 04 1462 1. Changed Intended Status to Standards Track. 1464 2. As per suggestion from Michael Bauland, the element 1465 is no longer included in and responses for 1466 "restore" commands. It's still mandatory for all other commands. 1468 3. Added summary of the attributes for the element. 1470 4. Clarified that the "refundable" and "grace-period" attributes of 1471 the elements are dependant on each other and cannot 1472 appear on their own. 1474 5. Removed the option of returning a 1001 response when the fee is 1475 incorrect. 1477 6. Forbidden the inclusion of extension elements in transform 1478 responses if no fee/credit has been assessed. 1480 7. Made the element optional in transform commands. 1482 8. Amended XML Namespace section of IANA Considerations, added EPP 1483 Extension Registry section. 1485 10.5. Changes from 04 to 05 1487 1. Removed the extended command. The command is the 1488 only command that can be used now. 1490 2. Introduced a mandatory-to-implement "standard" class for non- 1491 premium domains. 1493 3. The decision was made to keep availability info in 1494 responses as registrars have indicated that it is very useful as 1495 it avoids unnecessary round trips to the server. 1497 4. Allow elements to be present in responses. 1499 5. Allow the number of which can appear in transform 1500 responses to be zero. 1502 6. Removed the and elements from 1503 transfer query responses. The reason is that these elements are 1504 defined as containing the values after the transform command has 1505 taken place - which means that it is not appropriate to include 1506 them in a query response. 1508 7. Added Implementation Status section. 1510 10.6. Changes from 05 to 06 1512 1. The specification is now object-agnostic, but works with RFC5731 1513 [RFC5731] domains by default. 1515 2. Renamed the element to . Added the 1516 "objURI" attribute. 1518 3. Removed the default value for the "refundable" attribute of elements, and added text about how clients should handle 1520 such cases. Added similar text to the documentation of the 1521 "grace-period" attribute. 1523 4. Removed references to the defunct command syntax. 1525 5. "MUST" requirements regarding documentation have been changed to 1526 "must". 1528 6. Created separate "Correlation between Refundability and Grace 1529 Periods" section describing how the "refundable" and "grace- 1530 period" attributes work together. 1532 10.7. Changes from 06 to 07 1534 1. Changed the syntax of the form to be simpler: a single 1535 set of , etc elements is applied to 1536 the objects specified in the main body of the command. 1538 2. Simplified the object-agnosticism to simply copy the element from 1539 the command into the element. 1541 3. Added the "avail" attribute to the element and added 1542 commentary about its semantics. 1544 4. Added the element to the response so servers 1545 can indicate why fee information is not available. 1547 11. Normative References 1549 [ISO4217] International Organization for Standardization, "ISO 4217: 1550 2008, Codes for the representation of currencies and 1551 funds", 2008. 1553 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1554 Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/ 1555 RFC2119, March 1997, 1556 . 1558 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 1559 DOI 10.17487/RFC3688, January 2004, 1560 . 1562 [RFC3915] Hollenbeck, S., "Domain Registry Grace Period Mapping for 1563 the Extensible Provisioning Protocol (EPP)", RFC 3915, 1564 DOI 10.17487/RFC3915, September 2004, 1565 . 1567 [RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", 1568 STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009, 1569 . 1571 [RFC5731] Hollenbeck, S., "Extensible Provisioning Protocol (EPP) 1572 Domain Name Mapping", STD 69, RFC 5731, DOI 10.17487/ 1573 RFC5731, August 2009, 1574 . 1576 [RFC6982] Sheffer, Y. and A. Farrel, "Improving Awareness of Running 1577 Code: The Implementation Status Section", RFC 6982, 1578 DOI 10.17487/RFC6982, July 2013, 1579 . 1581 [RFC7451] Hollenbeck, S., "Extension Registry for the Extensible 1582 Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451, 1583 February 2015, . 1585 [draft-ietf-eppext-launchphase] 1586 Gould, J., Tan, W., and G. Brown, "Launch Phase Mapping 1587 for the Extensible Provisioning Protocol (EPP)", 2014. 1589 Authors' Addresses 1591 Gavin Brown 1592 CentralNic Group plc 1593 35-39 Moorgate 1594 London, England EC2R 6AR 1595 GB 1597 Phone: +44 20 33 88 0600 1598 Email: gavin.brown@centralnic.com 1599 URI: https://www.centralnic.com 1601 Jothan Frakes 1603 Email: jothan@jothan.com 1604 URI: http://jothan.com