idnits 2.17.1 draft-brown-epp-fees-06.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 (November 4, 2015) is 3090 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: May 7, 2016 November 4, 2015 7 Registry Fee Extension for the Extensible Provisioning Protocol (EPP) 8 draft-brown-epp-fees-06 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 May 7, 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. Supported Objects . . . . . . . . . . . . . . . . . . . . 4 54 3.2. Client Commands . . . . . . . . . . . . . . . . . . . . . 4 55 3.3. Currency Codes . . . . . . . . . . . . . . . . . . . . . 5 56 3.4. Validity Periods . . . . . . . . . . . . . . . . . . . . 5 57 3.5. Fees and Credits . . . . . . . . . . . . . . . . . . . . 5 58 3.5.1. Refunds . . . . . . . . . . . . . . . . . . . . . . . 6 59 3.5.2. Grace Periods . . . . . . . . . . . . . . . . . . . . 6 60 3.5.3. Correlation between Refundability and Grace Periods . 7 61 3.5.4. Applicability . . . . . . . . . . . . . . . . . . . . 7 62 3.6. Account Balance . . . . . . . . . . . . . . . . . . . . . 7 63 3.7. Credit Limit . . . . . . . . . . . . . . . . . . . . . . 8 64 3.8. Classification of Objects . . . . . . . . . . . . . . . . 8 65 4. Server Handling of Fee Information . . . . . . . . . . . . . 8 66 5. EPP Command Mapping . . . . . . . . . . . . . . . . . . . . . 9 67 5.1. EPP Query Commands . . . . . . . . . . . . . . . . . . . 9 68 5.1.1. EPP Command . . . . . . . . . . . . . . . . . 9 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 . . . . . . . . . . . . . . . . . . . 30 78 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 30 79 7.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 30 80 7.2. EPP Extension Registry . . . . . . . . . . . . . . . . . 30 81 8. Implementation Status . . . . . . . . . . . . . . . . . . . . 31 82 8.1. RegistryEngine EPP Service . . . . . . . . . . . . . . . 31 83 9. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 32 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 11. Normative References . . . . . . . . . . . . . . . . . . . . 35 92 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 36 94 1. Introduction 96 Historically, domain name registries have applied a simple fee 97 structure for billable transactions, namely a basic unit price 98 applied to domain , , and RGP [RFC3915] 99 restore commands. Given the relatively small number of EPP servers 100 to which EPP clients have been required to connect, it has generally 101 been the case that client operators have been able to obtain details 102 of these fees out-of-band by contacting the server operators. 104 Given the recent expansion of the DNS namespace, and the 105 proliferation of novel business models, it is now desirable to 106 provide a method for EPP clients to query EPP servers for the fees 107 and credits associated with certain commands and specific objects. 109 This document describes an extension mapping for version 1.0 of the 110 Extensible Provisioning Protocol (EPP) [RFC5730]. This EPP mapping 111 provides a mechanism by which EPP clients may query the fees and 112 credits associated with various billable transactions, and also 113 obtain their current account balance. 115 1.1. Conventions Used in This Document 117 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 118 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 119 document are to be interpreted as described in RFC 2119 [RFC2119]. 121 XML is case sensitive. Unless stated otherwise, XML specifications 122 and examples provided in this document MUST be interpreted in the 123 character case presented in order to develop a conforming 124 implementation. 126 "fee" is used as an abbreviation for "urn:ietf:params:xml:ns:fee- 127 0.9". The XML namespace prefix "fee" is used, but implementations 128 MUST NOT depend on it and instead employ a proper namespace-aware XML 129 parser and serializer to interpret and output the XML documents. 131 (Note to RFC Editor: remove the following paragraph before 132 publication as an RFC.) 134 The XML namespace prefix above contains a version number, 135 specifically "0.9". This version number will increment with 136 successive versions of this document, and will reach 1.0 if and when 137 this document is published as an RFC. This permits clients to 138 distinguish which version of the extension a server has implemented. 140 2. Migrating to Newer Versions of This Extension 142 (Note to RFC Editor: remove this section before publication as an 143 RFC.) 145 Servers which implement this extension SHOULD provide a way for 146 clients to progressively update their implementations when a new 147 version of the extension is deployed. 149 Servers SHOULD (for a temporary migration period) provide support for 150 older versions of the extension in parallel to the newest version, 151 and allow clients to select their preferred version via the 152 element of the command. 154 If a client requests multiple versions of the extension at login, 155 then, when preparing responses to commands which do not include 156 extension elements, the server SHOULD only include extension elements 157 in the namespace of the newest version of the extension requested by 158 the client. 160 When preparing responses to commands which do include extension 161 elements, the server SHOULD only include extension elements for the 162 extension versions present in the command. 164 3. Extension Elements 166 3.1. Supported Objects 168 By default, this specification assumes that fees and credits will 169 only be applied for transform commands on domain objects as described 170 in [RFC5731]. However, other object types are supported through the 171 use of OPTIONAL "objURI" and "element" attributes on the 172 and elements, respectively. 174 3.2. Client Commands 176 The element is used in the EPP command to 177 determine the fee which is applicable to the given command. 179 The element values permitted by the server is a matter of repository 180 policy, but MUST include as a minimum the following values: 182 o "create" indicating a command; 184 o "renew" indicating a command; 186 o "transfer" indicating a command; 187 If the server supports the Registry Grace Period Mapping [RFC3915], 188 then the server MUST also support the "restore" value. 190 The element MAY have an OPTIONAL "phase" attribute 191 specifying a launch phase as described in 192 [draft-ietf-eppext-launchphase]. It may also contain an OPTIONAL 193 "subphase" attribute identifying the custom or sub-phase as described 194 in [draft-ietf-eppext-launchphase]. 196 3.3. Currency Codes 198 The element is used to indicate which currency fees 199 are charged in. This value of this element MUST be a three-character 200 currency code from [ISO4217]. 202 Note that ISO 4217 provides the special "XXX" code, which MAY be used 203 if the server uses a non-currency based system for assessing fees, 204 such as a system of credits. 206 The use of elements in commands is OPTIONAL: if a 207 element is not present in a command, the server MUST 208 determine the currency based on the client's account settings which 209 MUST be agreed by the client and server via an out-of-band channel. 210 However, the element MUST be present in responses. 212 Servers SHOULD NOT perform a currency conversion if a client uses an 213 incorrect currency code. Servers SHOULD return a 2004 error instead. 215 3.4. 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.5. 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 252 the 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.5.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.5.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.5.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.5.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" (which is the default) or "delayed". 309 3.6. 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" 319 commands (ie , , , , ). 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.7. 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.8. 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 4. Server Handling of Fee Information 365 Depending on server policy, a client MAY be required to include the 366 extension elements described in this document for certain transform 367 commands. Servers must provide clear documentation to clients about 368 the circumstances in which this extension must be used. 370 If a server receives a command from a client which does not include 371 the extension elements required by the server for that command, then 372 it MUST respond with a 2003 "Required parameter missing" error. 374 If the currency or total fee provided by the client do not agree with 375 the server's own calculation of the fee for that command, then the 376 server MUST reject the command with a 2004 "Parameter value range" 377 error. 379 5. EPP Command Mapping 381 A detailed description of the EPP syntax and semantics can be found 382 in [RFC5730]. 384 5.1. EPP Query Commands 386 This extension does not add any elements to the EPP or 387 commands or responses. 389 5.1.1. EPP Command 391 This extension defines additional elements for the EPP 392 command. 394 The command MAY contain an element which MAY contain a 395 element. The element MUST contain at least 396 one element, which has the following child elements: 398 o A element. This element contains a string which 399 identifies the object. The element has an OPTIONAL 400 "element" attribute which identifies the local name of the object 401 attribute which is the unique identifier for the object. The 402 default value for this attribute is "name". 404 o An OPTIONAL element; 406 o A element; 408 o An OPTIONAL element. 410 The element has an OPTIONAL "objURI" attribute which is 411 used to identify the type of the object. The default value for this 412 element is "urn:ietf:params:xml:ns:domain-1.0". The value of this 413 attribute MUST match the contents of one of the elements 414 from the server 416 Example command: 418 C: 419 C: 420 C: 421 C: 422 C: 424 C: example.com 425 C: example.net 426 C: example.org 427 C: 428 C: 429 C: 430 C: 432 C: 434 C: example.com 435 C: USD 436 C: create 437 C: 1 438 C: 439 C: 440 C: example.net 441 C: EUR 442 C: 443 C: create 444 C: 2 445 C: 446 C: 447 C: example.org 448 C: EUR 449 C: transfer 450 C: 451 C: 452 C: example.xyz 453 C: restore 454 C: 455 C: 456 C: 457 C: ABC-12345 458 C: 459 C: 461 When the server receives a command that includes the 462 extension elements described above, its response MUST (subject to the 463 exception described below) contain an element, which MUST 464 contain a child element. The element 465 MUST contain a element for each element 466 contained in the command. The MUST contain the following 467 child elements: 469 o A element that contains an identifer which matches the 470 identifier in the corresponding element. 472 o A element that contains same currency code that 473 appeared in the corresponding element. If no 474 element appeared in the corresponding 475 element, then the client's default billing currency should be 476 used. 478 o A element that contains same command that appeared 479 in the corresponding element. This element MAY have 480 the OPTIONAL "phase" and "subphase" elements, which MUST match the 481 same attributes in the corresponding element. 483 o An OPTIONAL element that contains same unit that 484 appeared in the corresponding element. If the value 485 of the preceding element is "restore", this element 486 MUST NOT be included. Otherwise it MUST be included. If no 487 appeared in the corresponding element 488 (and the command is not "restore") then this element MUST have a 489 value of 1 year. 491 o Zero or more elements. 493 o Zero or more elements. 495 o An OPTIONAL element. 497 If no elements are present in a element, this 498 indicates that the requested command is not permitted by server 499 policy. 501 The presence of one or more and elements with 502 a total value of "0.00" (ie a zero amount) in a element 503 indicates that no fee will be assessed by the server for this 504 command. 506 Example response: 508 S: 509 S: 510 S: 511 S: 512 S: Command completed successfully 513 S: 514 S: 515 S: 517 S: 518 S: example.com 519 S: 520 S: 521 S: example.net 522 S: In use 523 S: 524 S: 525 S: example.org 526 S: In use 527 S: 528 S: 529 S: 530 S: 531 S: 533 S: 534 S: example.com 535 S: USD 536 S: create 537 S: 1 538 S: 5.00 540 S: 5.00 543 S: 544 S: 545 S: example.net 546 S: EUR 547 S: 548 S: create 549 S: 2 550 S: 5.00 551 S: 552 S: 553 S: example.org 554 S: EUR 555 S: transfer 556 S: 2 557 S: 2.50 559 S: 10.00 562 S: 563 S: 564 S: example.xyz 565 S: GBP 566 S: restore 567 S: 25 569 S: premium-tier1 570 S: 571 S: 572 S: 573 S: 574 S: ABC-12345 575 S: 54322-XYZ 576 S: 577 S: 578 S: 580 5.1.2. EPP Transfer Query Command 582 This extension does not add any elements to the EPP query 583 command, but does include elements in the response, when the 584 extension has been selected during a command. 586 When the query command has been processed successfully, 587 the client selected the extension when it logged in, and the client 588 is authorised by the server to view information about the transfer, 589 the server MAY include in the section of the EPP response 590 a element that contains the following child elements: 592 o A element. 594 o A element. 596 o Zero or more elements containing the fees that will be 597 charged to the gaining client. 599 o Zero or more elements containing the credits that 600 will be refunded to the losing client. 602 Servers SHOULD omit when returning a response to the 603 gaining client, and omit elements when returning a response 604 to the losing client. 606 If no element is included in the response, then no fee 607 will be assessed by the server for the transfer. 609 Example query response: 611 S: 612 S: 613 S: 614 S: 615 S: Command completed successfully; action pending 616 S: 617 S: 618 S: 620 S: example.com 621 S: pending 622 S: ClientX 623 S: 2000-06-08T22:00:00.0Z 624 S: ClientY 625 S: 2000-06-13T22:00:00.0Z 626 S: 2002-09-08T22:00:00.0Z 627 S: 628 S: 629 S: 630 S: 631 S: USD 632 S: 1 633 S: 5.00 634 S: 635 S: 636 S: 637 S: ABC-12345 638 S: 54322-XYZ 639 S: 640 S: 641 S: 643 5.2. EPP Transform Commands 645 5.2.1. EPP Command 647 This extension adds elements to both the EPP command and 648 response, when the extension has been selected during a 649 command. 651 When submitting a command to the server, the client MAY 652 include in the element a element which 653 includes the following child elements: 655 o An OPTIONAL element; 657 o One or more elements. 659 When the command has been processed successfully, and the 660 client selected the extension when it logged in, and a fee was 661 assessed by the server for the transaction, the server MUST include 662 in the section of the EPP response a 663 element that contains the following child elements: 665 o A element; 667 o Zero or more elements; 669 o Zero or more elements; 671 o An OPTIONAL element; 673 o An OPTIONAL element. 675 If no fee or credit has been assessed by the server for this 676 transaction, a element MUST NOT be included in the 677 response. 679 Example command: 681 C: 682 C: 683 C: 684 C: 685 C: 687 C: example.com 688 C: 2 689 C: 690 C: ns1.example.net 691 C: ns2.example.net 692 C: 693 C: jd1234 694 C: sh8013 695 C: sh8013 696 C: 697 C: 2fooBAR 698 C: 699 C: 700 C: 701 C: 702 C: 703 C: USD 704 C: 5.00 705 C: 706 C: 707 C: ABC-12345 708 C: 709 C: 711 Example response: 713 S: 714 S: 715 S: 716 S: 717 S: Command completed successfully 718 S: 719 S: 720 S: 722 S: example.com 723 S: 1999-04-03T22:00:00.0Z 724 S: 2001-04-03T22:00:00.0Z 725 S: 726 S: 727 S: 728 S: 729 S: USD 730 S: 5.00 731 S: -5.00 732 S: 1000.00 733 S: 734 S: 735 S: 736 S: ABC-12345 737 S: 54321-XYZ 738 S: 739 S: 740 S: 742 5.2.2. EPP Command 744 This extension does not add any elements to the EPP command, 745 but does include elements in the response, when the extension has 746 been selected during the command. 748 When the command has been processed successfully, and the 749 client selected the extension when it logged in, the server MAY 750 include in the section of the EPP response a 751 element that contains the following child elements: 753 o A element; 755 o Zero or more elements; 757 o An OPTIONAL element; 759 o An OPTIONAL element. 761 If no credit has been assessed by the server for this transaction, a 762 element MUST NOT be included in the response. 764 Example response: 766 S: 767 S: 768 S: 769 S: 770 S: Command completed successfully 771 S: 772 S: 773 S: 775 S: USD 776 S: -5.00 777 S: 1005.00 778 S: 779 S: 780 S: 781 S: ABC-12345 782 S: 54321-XYZ 783 S: 784 S: 785 S: 787 5.2.3. EPP Command 789 This extension adds elements to both the EPP command and 790 response, when the extension has been selected during a 791 command. 793 When submitting a command to the server, the client MAY 794 include in the element a element which 795 includes the following child elements: 797 o An OPTIONAL element; 799 o One or more elements. 801 When the command has been processed successfully, and the 802 client selected the extension when it logged in, the server MAY 803 include in the section of the EPP response a 804 element that contains the following child elements: 806 o A element; 808 o Zero or more elements; 809 o Zero or more elements; 811 o An OPTIONAL element; 813 o An OPTIONAL element. 815 If no fee or credit has been assessed by the server for this 816 transaction, a element MUST NOT be included in the 817 response. 819 Example command: 821 C: 822 C: 823 C: 824 C: 825 C: 827 C: example.com 828 C: 2000-04-03 829 C: 5 830 C: 831 C: 832 C: 833 C: 834 C: USD 835 C: 5.00 836 C: 837 C: 838 C: ABC-12345 839 C: 840 C: 842 Example response: 844 S: 845 S: 846 S: 847 S: 848 S: Command completed successfully 849 S: 850 S: 851 S: 853 S: example.com 854 S: 2005-04-03T22:00:00.0Z 855 S: 856 S: 857 S: 858 S: 859 S: USD 860 S: 5.00 861 S: 1000.00 862 S: 863 S: 864 S: 865 S: ABC-12345 866 S: 54322-XYZ 867 S: 868 S: 869 S: 871 5.2.4. EPP Command 873 This extension adds elements to both the EPP command and 874 response, when the value of the "op" attribute of the 875 command element is "request", and the extension has been selected 876 during the command. 878 When submitting a command to the server, the client MAY 879 include in the element a element which 880 includes the following child elements: 882 o An OPTIONAL element; 884 o One or more elements. 886 When the command has been processed successfully, and the 887 client selected the extension when it logged in, the server MAY 888 include in the section of the EPP response a 889 element that contains the following child elements: 891 o A element; 892 o Zero or more elements; 894 o Zero or more elements; 896 o An OPTIONAL element; 898 o An OPTIONAL element. 900 If no fee or credit has been assessed by the server for this 901 transaction, a element MUST NOT be included in the 902 response. 904 Example command: 906 C: 907 C: 908 C: 909 C: 910 C: 912 C: example.com 913 C: 1 914 C: 915 C: 2fooBAR 916 C: 917 C: 918 C: 919 C: 920 C: 921 C: USD 922 C: 5.00 923 C: 924 C: 925 C: ABC-12345 926 C: 927 C: 929 Example response: 931 S: 932 S: 933 S: 934 S: 935 S: Command completed successfully; action pending 936 S: 937 S: 938 S: 940 S: example.com 941 S: pending 942 S: ClientX 943 S: 2000-06-08T22:00:00.0Z 944 S: ClientY 945 S: 2000-06-13T22:00:00.0Z 946 S: 2002-09-08T22:00:00.0Z 947 S: 948 S: 949 S: 950 S: 951 S: USD 952 S: 5.00 953 S: 954 S: 955 S: 956 S: ABC-12345 957 S: 54322-XYZ 958 S: 959 S: 960 S: 962 5.2.5. EPP Command 964 This extension adds elements to both the EPP command and 965 response, when the extension has been selected during a has 966 been selected during the command. 968 When submitting a command to the server, the client MAY 969 include in the element a element which 970 includes the following child elements: 972 o An OPTIONAL element; 974 o One or more elements. 976 When the command has been processed successfully, and the 977 client selected the extension when it logged in, the server MAY 978 include in the section of the EPP response a 979 element that contains the following child elements: 981 o A element; 983 o Zero or more elements; 985 o Zero or more elements; 987 o An OPTIONAL element; 989 o An OPTIONAL element. 991 If no fee or credit has been assessed by the server for this 992 transaction, a element MUST NOT be included in the 993 response. 995 Example command: 997 C: 998 C: 999 C: 1000 C: 1001 C: 1003 C: example.com 1004 C: 1005 C: sh8013 1006 C: 1007 C: 1008 C: 1009 C: 1010 C: 1011 C: USD 1012 C: 5.00 1013 C: 1014 C: 1015 C: ABC-12345 1016 C: 1017 C: 1019 Example response: 1021 S: 1022 S: 1023 S: 1024 S: 1025 S: Command completed successfully 1026 S: 1027 S: 1028 S: 1029 S: USD 1030 S: 5.00 1031 S: 1032 S: 1033 S: 1034 S: ABC-12345 1035 S: 54321-XYZ 1036 S: 1037 S: 1038 S: 1040 5.3. Formal Syntax 1042 An EPP object mapping is specified in XML Schema notation. The 1043 formal syntax presented here is a complete schema representation of 1044 the object mapping suitable for automated validation of EPP XML 1045 instances. 1047 Copyright (c) 2014 IETF Trust and the persons identified as authors 1048 of the code. All rights reserved. 1050 Redistribution and use in source and binary forms, with or without 1051 modification, are permitted provided that the following conditions 1052 are met: 1054 o Redistributions of source code must retain the above copyright 1055 notice, this list of conditions and the following disclaimer. 1057 o Redistributions in binary form must reproduce the above copyright 1058 notice, this list of conditions and the following disclaimer in 1059 the documentation and/or other materials provided with the 1060 distribution. 1062 o Neither the name of Internet Society, IETF or IETF Trust, nor the 1063 names of specific contributors, may be used to endorse or promote 1064 products derived from this software without specific prior written 1065 permission. 1067 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1068 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1069 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1070 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 1071 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 1072 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 1073 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 1074 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 1075 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 1076 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 1077 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 1079 BEGIN 1080 1081 1088 1089 1091 1092 Extensible Provisioning Protocol 1093 v1.0 extension schema for fee 1094 information. 1095 1097 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1112 1115 1116 1117 1119 1120 1122 1123 1124 1125 1127 1128 1130 1131 1133 1135 1136 1137 1138 1140 1141 1142 1144 1147 1148 1149 1151 1152 1154 1155 1156 1157 1158 1159 1161 1163 1166 1167 1168 1170 1172 1175 1176 1177 1179 1181 1183 1184 1186 1189 1190 1191 1192 1194 1196 1198 1200 1201 1203 1206 1207 1208 1210 1211 1214 1216 1218 1219 1221 1224 1225 1226 1227 1229 1231 1233 1234 1236 1239 1240 1241 1242 1243 1245 1246 1247 1248 1249 1250 1251 1252 1254 1255 1256 1257 1258 1259 1261 1262 1263 1264 1265 1267 1268 1269 1270 1271 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1291 1292 1293 1294 1295 1296 1297 1299 1300 1301 1303 1304 1305 1307 1309 END 1311 6. Security Considerations 1313 The mapping extensions described in this document do not provide any 1314 security services beyond those described by EPP [RFC5730], the EPP 1315 domain name mapping [RFC5731], and protocol layers used by EPP. The 1316 security considerations described in these other specifications apply 1317 to this specification as well. 1319 7. IANA Considerations 1321 7.1. XML Namespace 1323 This document uses URNs to describe XML namespaces and XML schemas 1324 conforming to a registry mechanism described in [RFC3688]. The 1325 following URI assignment is requested of IANA: 1327 URI: urn:ietf:params:xml:ns:fee-0.9 1329 Registrant Contact: See the "Author's Address" section of this 1330 document. 1332 XML: See the "Formal Syntax" section of this document. 1334 7.2. EPP Extension Registry 1336 The EPP extension described in this document should be registered by 1337 the IANA in the EPP Extension Registry described in [RFC7451]. The 1338 details of the registration are as follows: 1340 Name of Extension: EPP Fee Extension 1342 Document status: Standards Track 1344 Reference: (insert reference to RFC version of this document) 1346 Registrant Name and Email Address: See the "Author's Address" section 1347 of this document. 1349 TLDs: any 1351 IPR Disclosure: none 1353 Status: active 1355 Notes: none 1357 8. Implementation Status 1359 Note to RFC Editor: Please remove this section and the reference to 1360 [RFC6982] before publication. 1362 This section records the status of known implementations of the 1363 protocol defined by this specification at the time of posting of this 1364 Internet-Draft, and is based on a proposal described in [RFC6982]. 1365 The description of implementations in this section is intended to 1366 assist the IETF in its decision processes in progressing drafts to 1367 RFCs. Please note that the listing of any individual implementation 1368 here does not imply endorsement by the IETF. Furthermore, no effort 1369 has been spent to verify the information presented here that was 1370 supplied by IETF contributors. This is not intended as, and must not 1371 be construed to be, a catalog of available implementations or their 1372 features. Readers are advised to note that other implementations may 1373 exist. 1375 According to [RFC6982], "this will allow reviewers and working groups 1376 to assign due consideration to documents that have the benefit of 1377 running code, which may serve as evidence of valuable experimentation 1378 and feedback that have made the implemented protocols more mature. 1379 It is up to the individual working groups to use this information as 1380 they see fit". 1382 8.1. RegistryEngine EPP Service 1384 Organization: CentralNic 1386 Name: RegistryEngine EPP Service 1388 Description: Generic high-volume EPP service for gTLDs, ccTLDs and 1389 SLDs 1391 Level of maturity: Deployed in CentralNic's production environment as 1392 well as two other gTLD registry systems, and two ccTLD registry 1393 systems. 1395 Coverage: All aspects of the protocol are implemented. 1397 Licensing: Proprietary In-House software 1399 Contact: epp@centralnic.com 1401 URL: https://www.centralnic.com 1403 9. Acknowledgements 1405 The authors wish to thank the following persons for their feedback 1406 and suggestions: 1408 o James Gould of Verisign 1410 o Luis Munoz of ISC 1412 o Michael Young of Architelos 1414 o Ben Levac and Jeff Eckhaus of Demand Media 1416 o Seth Goldman of Google 1418 o Klaus Malorny and Michael Bauland of Knipp 1420 o Jody Kolker and Roger Carney of Go Daddy 1422 o Michael Holloway of Com Laude 1424 o Santosh Kalsangrah of Impetus Infotech 1426 o Alex Mayrhofer of Nic.at 1428 10. Change History 1430 10.1. Changes from 00 to 01 1432 1. Restore the command extension; either or 1433 can be used. 1435 2. added extension elements for , , and 1436 so that the server can reject the command if the fee is 1437 incorrect. 1439 10.2. Changes from 01 to 02 1441 1. Use Internet-Draft version number rather than XML namespace 1442 version number in this section. 1444 2. Support for multiple and elements. 1446 3. Added the "description" attribute to and 1447 elements. 1449 4. Added the element. 1451 5. Added the element. 1453 6. Updated reference to [draft-ietf-eppext-launchphase]. 1455 7. Use instead of . 1457 8. Use a single child element of instead of multiple 1458 elements for each domain. This also requires using a different 1459 name () for the domain name. 1461 9. Added the "refundable" attribute to elements. 1463 10. Added the "grace-period" attribute to elements. 1465 10.3. Changes from 02 to 03 1467 1. Added the "applied" attribute to to elements. 1469 2. Simplified the wording in relation to when a server can return an 1470 error for extended commands. 1472 3. Added the element to transfer query responses. 1474 4. Removed wording about how servers behave when receiving incorrect 1475 fee information from transform commands, and put it into a single 1476 section at the top of the document. 1478 5. Allow servers to omit elements from elements 1479 if the command specified by the client is forbidden. 1481 10.4. Changes from 03 to 04 1483 1. Changed Intended Status to Standards Track. 1485 2. As per suggestion from Michael Bauland, the element 1486 is no longer included in and responses for 1487 "restore" commands. It's still mandatory for all other commands. 1489 3. Added summary of the attributes for the element. 1491 4. Clarified that the "refundable" and "grace-period" attributes of 1492 the elements are dependant on each other and cannot 1493 appear on their own. 1495 5. Removed the option of returning a 1001 response when the fee is 1496 incorrect. 1498 6. Forbidden the inclusion of extension elements in transform 1499 responses if no fee/credit has been assessed. 1501 7. Made the element optional in transform commands. 1503 8. Amended XML Namespace section of IANA Considerations, added EPP 1504 Extension Registry section. 1506 10.5. Changes from 04 to 05 1508 1. Removed the extended command. The command is the 1509 only command that can be used now. 1511 2. Introduced a mandatory-to-implement "standard" class for non- 1512 premium domains. 1514 3. The decision was made to keep availability info in 1515 responses as registrars have indicated that it is very useful as 1516 it avoids unnecessary round trips to the server. 1518 4. Allow elements to be present in responses. 1520 5. Allow the number of which can appear in transform 1521 responses to be zero. 1523 6. Removed the and elements from 1524 transfer query responses. The reason is that these elements are 1525 defined as containing the values after the transform command has 1526 taken place - which means that it is not appropriate to include 1527 them in a query response. 1529 7. Added Implementation Status section. 1531 10.6. Changes from 05 to 06 1533 1. The specification is now object-agnostic, but works with RFC5731 1534 [RFC5731] domains by default. 1536 2. Renamed the element to . Added the 1537 "objURI" attribute. 1539 3. Removed the default value for the "refundable" attribute of 1540 elements, and added text about how clients should 1541 handle such cases. Added similar text to the documentation of 1542 the "grace-period" attribute. 1544 4. Removed references to the defunct command syntax. 1546 5. "MUST" requirements regarding documentatio have been changed to 1547 "must". 1549 6. Created separate "Correlation between Refundability and Grace 1550 Periods" section describing how the "refundable" and "grace- 1551 period" attributes work together. 1553 11. Normative References 1555 [draft-ietf-eppext-launchphase] 1556 Gould, J., Tan, W., and G. Brown, "Launch Phase Mapping 1557 for the Extensible Provisioning Protocol (EPP)", 2014. 1559 [ISO4217] International Organization for Standardization, "ISO 1560 4217:2008, Codes for the representation of currencies and 1561 funds", 2008. 1563 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1564 Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/ 1565 RFC2119, March 1997, 1566 . 1568 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 1569 DOI 10.17487/RFC3688, January 2004, 1570 . 1572 [RFC3915] Hollenbeck, S., "Domain Registry Grace Period Mapping for 1573 the Extensible Provisioning Protocol (EPP)", RFC 3915, DOI 1574 10.17487/RFC3915, September 2004, 1575 . 1577 [RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", 1578 STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009, 1579 . 1581 [RFC5731] Hollenbeck, S., "Extensible Provisioning Protocol (EPP) 1582 Domain Name Mapping", STD 69, RFC 5731, DOI 10.17487/ 1583 RFC5731, August 2009, 1584 . 1586 [RFC6982] Sheffer, Y. and A. Farrel, "Improving Awareness of Running 1587 Code: The Implementation Status Section", RFC 6982, DOI 1588 10.17487/RFC6982, July 2013, 1589 . 1591 [RFC7451] Hollenbeck, S., "Extension Registry for the Extensible 1592 Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451, 1593 February 2015, . 1595 Authors' Addresses 1597 Gavin Brown 1598 CentralNic Group plc 1599 35-39 Moorgate 1600 London, England EC2R 6AR 1601 GB 1603 Phone: +44 20 33 88 0600 1604 Email: gavin.brown@centralnic.com 1605 URI: https://www.centralnic.com 1607 Jothan Frakes 1609 Email: jothan@jothan.com 1610 URI: http://jothan.com