idnits 2.17.1 draft-ietf-regext-epp-fees-00.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 (June 28, 2016) is 2858 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: December 30, 2016 June 28, 2016 7 Registry Fee Extension for the Extensible Provisioning Protocol (EPP) 8 draft-ietf-regext-epp-fees-00 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 December 30, 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 . . . . . . . . . . . . . . . . . . . . . . . . . 4 50 1.1. Conventions Used in This Document . . . . . . . . . . . . 4 51 2. Migrating to Newer Versions of This Extension . . . . . . . . 5 52 3. Extension Elements . . . . . . . . . . . . . . . . . . . . . . 5 53 3.1. Client Commands . . . . . . . . . . . . . . . . . . . . . 5 54 3.2. Currency Codes . . . . . . . . . . . . . . . . . . . . . . 6 55 3.3. Validity Periods . . . . . . . . . . . . . . . . . . . . . 6 56 3.4. Fees and Credits . . . . . . . . . . . . . . . . . . . . . 6 57 3.4.1. Refunds . . . . . . . . . . . . . . . . . . . . . . . 7 58 3.4.2. Grace Periods . . . . . . . . . . . . . . . . . . . . 7 59 3.4.3. Correlation between Refundability and Grace Periods . 8 60 3.4.4. Applicability . . . . . . . . . . . . . . . . . . . . 8 61 3.5. Account Balance . . . . . . . . . . . . . . . . . . . . . 8 62 3.6. Credit Limit . . . . . . . . . . . . . . . . . . . . . . . 8 63 3.7. Classification of Objects . . . . . . . . . . . . . . . . 9 64 4. Server Handling of Fee Information . . . . . . . . . . . . . . 9 65 5. EPP Command Mapping . . . . . . . . . . . . . . . . . . . . . 9 66 5.1. EPP Query Commands . . . . . . . . . . . . . . . . . . . . 10 67 5.1.1. EPP Command . . . . . . . . . . . . . . . . . 10 68 5.1.1.1. Server Handling of Elements . . . . . 13 69 5.1.2. EPP Transfer Query Command . . . . . . . . . . . . . . 14 70 5.2. EPP Transform Commands . . . . . . . . . . . . . . . . . . 15 71 5.2.1. EPP Command . . . . . . . . . . . . . . . . . 15 72 5.2.2. EPP Command . . . . . . . . . . . . . . . . . 18 73 5.2.3. EPP Command . . . . . . . . . . . . . . . . . 19 74 5.2.4. EPP Command . . . . . . . . . . . . . . . . 21 75 5.2.5. EPP Command . . . . . . . . . . . . . . . . . 23 76 5.3. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . 25 77 6. Security Considerations . . . . . . . . . . . . . . . . . . . 30 78 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 31 79 7.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 31 80 7.2. EPP Extension Registry . . . . . . . . . . . . . . . . . . 31 81 8. Implementation Status . . . . . . . . . . . . . . . . . . . . 31 82 8.1. RegistryEngine EPP Service . . . . . . . . . . . . . . . . 32 83 9. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 32 84 10. Change History . . . . . . . . . . . . . . . . . . . . . . . . 33 85 10.1. Changes from 00 to 01 . . . . . . . . . . . . . . . . . . 33 86 10.2. Changes from 01 to 02 . . . . . . . . . . . . . . . . . . 33 87 10.3. Changes from 02 to 03 . . . . . . . . . . . . . . . . . . 34 88 10.4. Changes from 03 to 04 . . . . . . . . . . . . . . . . . . 34 89 10.5. Changes from 04 to 05 . . . . . . . . . . . . . . . . . . 35 90 10.6. Changes from 05 to 06 . . . . . . . . . . . . . . . . . . 35 91 10.7. Changes from 06 to 07 . . . . . . . . . . . . . . . . . . 36 92 10.8. Changes from draft-brown-epp-fees-00 to 93 draft-ietf-regext-epp-fees-00 . . . . . . . . . . . . . . 36 94 11. Normative References . . . . . . . . . . . . . . . . . . . . . 36 95 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 37 97 1. Introduction 99 Historically, domain name registries have applied a simple fee 100 structure for billable transactions, namely a basic unit price 101 applied to domain , , and RGP [RFC3915] 102 restore commands. Given the relatively small number of EPP servers 103 to which EPP clients have been required to connect, it has generally 104 been the case that client operators have been able to obtain details 105 of these fees out-of-band by contacting the server operators. 107 Given the recent expansion of the DNS namespace, and the 108 proliferation of novel business models, it is now desirable to 109 provide a method for EPP clients to query EPP servers for the fees 110 and credits associated with certain commands and specific objects. 112 This document describes an extension mapping for version 1.0 of the 113 Extensible Provisioning Protocol (EPP) [RFC5730]. This EPP mapping 114 provides a mechanism by which EPP clients may query the fees and 115 credits associated with various billable transactions, and also 116 obtain their current account balance. 118 1.1. Conventions Used in This Document 120 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 121 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 122 document are to be interpreted as described in RFC 2119 [RFC2119]. 124 XML is case sensitive. Unless stated otherwise, XML specifications 125 and examples provided in this document MUST be interpreted in the 126 character case presented in order to develop a conforming 127 implementation. 129 "fee" is used as an abbreviation for 130 "urn:ietf:params:xml:ns:fee-0.11". The XML namespace prefix "fee" is 131 used, but implementations MUST NOT depend on it and instead employ a 132 proper namespace-aware XML parser and serializer to interpret and 133 output the XML documents. 135 (Note to RFC Editor: remove the following paragraph before 136 publication as an RFC.) 138 The XML namespace prefix above contains a version number, 139 specifically "0.11". This version number will increment with 140 successive versions of this document, and will reach 1.0 if and when 141 this document is published as an RFC. This permits clients to 142 distinguish which version of the extension a server has implemented. 144 2. Migrating to Newer Versions of This Extension 146 (Note to RFC Editor: remove this section before publication as an 147 RFC.) 149 Servers which implement this extension SHOULD provide a way for 150 clients to progressively update their implementations when a new 151 version of the extension is deployed. 153 Servers SHOULD (for a temporary migration period) provide support for 154 older versions of the extension in parallel to the newest version, 155 and allow clients to select their preferred version via the 156 element of the command. 158 If a client requests multiple versions of the extension at login, 159 then, when preparing responses to commands which do not include 160 extension elements, the server SHOULD only include extension elements 161 in the namespace of the newest version of the extension requested by 162 the client. 164 When preparing responses to commands which do include extension 165 elements, the server SHOULD only include extension elements for the 166 extension versions present in the command. 168 3. Extension Elements 170 3.1. Client Commands 172 The element is used in the EPP command to 173 determine the fee which is applicable to the given command. 175 The element values permitted by the server is a matter of repository 176 policy, but MUST include as a minimum the following values: 178 o "create" indicating a command; 180 o "renew" indicating a command; 182 o "transfer" indicating a command; 184 If the server supports the Registry Grace Period Mapping [RFC3915], 185 then the server MUST also support the "restore" value. 187 The element MAY have an OPTIONAL "phase" attribute 188 specifying a launch phase as described in 189 [draft-ietf-eppext-launchphase]. It may also contain an OPTIONAL 190 "subphase" attribute identifying the custom or sub-phase as described 191 in [draft-ietf-eppext-launchphase]. 193 3.2. Currency Codes 195 The element is used to indicate which currency fees 196 are charged in. This value of this element MUST be a three-character 197 currency code from [ISO4217]. 199 Note that ISO 4217 provides the special "XXX" code, which MAY be used 200 if the server uses a non-currency based system for assessing fees, 201 such as a system of credits. 203 The use of elements in commands is OPTIONAL: if a 204 element is not present in a command, the server MUST 205 determine the currency based on the client's account settings which 206 MUST be agreed by the client and server via an out-of-band channel. 207 However, the element MUST be present in responses. 209 Servers SHOULD NOT perform a currency conversion if a client uses an 210 incorrect currency code. Servers SHOULD return a 2004 error instead. 212 3.3. Validity Periods 214 When querying for fee information using the command, the 215 element is used to indicate the units to be added to the 216 registration period of objects by the , and 217 commands. This element is derived from the element described in [RFC5731]. 220 The element is OPTIONAL in commands: if omitted, 221 the server MUST determine the fee(s) using a validity period of 1 222 year. The element MUST be present in responses. 224 3.4. Fees and Credits 226 Servers which implement this extension will include elements in 227 responses which provide information about the fees and/or credits 228 associated with a given billable transaction. 230 The and elements are used to provide this 231 information. The presence of a element in a response 232 indicates a debit against the client's account balance; a element indicates a credit. A element MUST have a 234 non-negative value. A element MUST have a negative 235 value. 237 A server MAY respond with multiple and 238 elements in the same response. In such cases, the net fee or credit 239 applicable to the transaction is the arithmetic sum of the values of 240 each of the and/or elements. This amount 241 applies to the total additional validity period applied to the object 242 (where applicable) rather than to any incremental unit. 244 The following attributes are defined for the element. 245 These are described in detail below: 247 description: an OPTIONAL attribute which provides a human-readable 248 description of the fee. Servers should provide documentation on 249 the possible values of this attribute, and their meanings. 251 refundable: an OPTIONAL boolean attribute indicating whether the fee 252 is refundable if the object is deleted. 254 grace-period: an OPTIONAL attribute which provides the time period 255 during which the fee is refundable. 257 applied: an OPTIONAL attribute indicating when the fee will be 258 deducted from the client's account. 260 The element can take a "description" attribute as 261 described above. No other attributes are defined for this element. 263 3.4.1. Refunds 265 elements MAY have an OPTIONAL "refundable" attribute which 266 takes a boolean value. Fees may be refunded under certain 267 circumstances, such as when a domain application is rejected (as 268 described in [draft-ietf-eppext-launchphase]) or when an object is 269 deleted during the relevant Grace Period (see below). 271 If the "refundable" attribute is omitted, then clients SHOULD NOT 272 make any assumption about the refundability of the fee. 274 3.4.2. Grace Periods 276 [RFC3915] describes a system of "grace periods", which are time 277 periods following a billable transaction during which, if an object 278 is deleted, the client receives a refund. 280 The "grace-period" attribute MAY be used to indicate the relevant 281 grace period for a fee. If a server implements the Registry Grace 282 Period extension, it MUST specify the grace period for all relevant 283 transactions. 285 If the "grace-period" attribute is omitted, then clients SHOULD NOT 286 make any assumption about the grace period of the fee. 288 3.4.3. Correlation between Refundability and Grace Periods 290 If a element has a "grace-period" attribute then it MUST 291 also be refundable. If the "refundable" attribute of a 292 element is false then it MUST NOT have a "grace-period" attribute. 294 3.4.4. Applicability 296 Fees may be applied immediately upon receipt of a command from a 297 client, or may only be applied once an out-of-band process (such as 298 the processing of applications at the end of a launch phase) has 299 taken place. 301 The "applied" attribute of the element allows servers to 302 indicate whether a fee will be applied immediately, or whether it 303 will be applied at some point in the future. This attribute takes 304 two possible values: "immediate" (which is the default) or "delayed". 306 3.5. Account Balance 308 The element is an OPTIONAL element which MAY be 309 included in server responses to transform commands. If present, it 310 can be used by the client to determine the remaining credit at the 311 server. 313 Whether or not the is included in responses is a matter 314 of server policy. However, if a server chooses to offer support for 315 this element, it MUST be included in responses to all "transform" 316 commands (ie , , , , ). 319 The value of the MAY be negative. A negative balance 320 indicates that the server has extended a line of credit to the client 321 (see below). 323 If a server includes a element in response to transform 324 commands, the value of the element MUST reflect the client's account 325 balance after any fees or credits associated with that command have 326 been applied. 328 3.6. Credit Limit 330 As described above, if a server returns a response containing a with a negative value, then the server has extended a line 332 of credit to the client. A server MAY also include a element in responses which indicates the maximum credit 334 available to a client. A server MAY reject certain transactions if 335 the absolute value of the is equal to or exceeds the 336 value of the element. 338 Whether or not the is included in responses is a 339 matter of server policy. However, if a server chooses to offer 340 support for this element, it MUST be included in responses to all 341 "transform" commands (ie , , , , 342 ). 344 3.7. Classification of Objects 346 Objects may be assigned to a particular class, category, or tier, 347 each of which has a particular fee or set of fees associated with it. 348 The element which appears in responses is used to 349 indicate the classification of an object. 351 If a server makes use of this element, it should provide clients with 352 a list of all the values that the element may take via an out-of-band 353 channel. Servers MUST NOT use values which do not appear on this 354 list. 356 Servers which make use of this element MUST use a element 357 with the value "standard" for all objects that are subject to the 358 standard or default fee. 360 4. Server Handling of Fee Information 362 Depending on server policy, a client MAY be required to include the 363 extension elements described in this document for certain transform 364 commands. Servers must provide clear documentation to clients about 365 the circumstances in which this extension must be used. 367 If a server receives a command from a client which does not include 368 the extension elements required by the server for that command, then 369 it MUST respond with a 2003 "Required parameter missing" error. 371 If the currency or total fee provided by the client do not agree with 372 the server's own calculation of the fee for that command, then the 373 server MUST reject the command with a 2004 "Parameter value range" 374 error. 376 5. EPP Command Mapping 378 A detailed description of the EPP syntax and semantics can be found 379 in [RFC5730]. 381 5.1. EPP Query Commands 383 This extension does not add any elements to the EPP or 384 commands or responses. 386 5.1.1. EPP Command 388 This extension defines additional elements for the EPP 389 command. 391 The command MAY contain an element which MAY contain a 392 element. The element contains the following 393 child elements: 395 o A element; 397 o An OPTIONAL element; 399 o An OPTIONAL element. 401 o An OPTIONAL element. 403 Example command: 405 C: 406 C: 407 C: 408 C: 409 C: 411 C: example.com 412 C: example.net 413 C: example.xyz 414 C: 415 C: 416 C: 417 C: 418 C: create 419 C: USD 420 C: 421 C: 422 C: ABC-12345 423 C: 424 C: 426 When the server receives a command that includes the 427 extension elements described above, its response MUST (subject to the 428 exception described below) contain an element, which MUST 429 contain a child element. The element 430 MUST contain a element for each object referenced in the 431 element in the command. 433 The element has an OPTIONAL "avail" atribute which is a 434 boolean. If the value of this attribute evalutes to false, this 435 indicates that the server cannot calculate the relevant fees, because 436 the object, command, currency, period or class is invalid according 437 to server policy. 439 The contains the following child elements: 441 o A element, which contains a copy of the child element 442 of the element of the command, to which the fee 443 information relates. 445 o A element, which contains the same command that 446 appeared in the corresponding element. This element 447 MAY have the OPTIONAL "phase" and "subphase" elements, which MUST 448 match the same attributes in the corresponding 449 element. 451 o A element, which contains the same currency code 452 that appeared in the element of the command. If no 453 element appeared in the command, then the client's 454 default billing currency should be used. 456 o An OPTIONAL element, which contains the same unit 457 that appeared in the element of the command. If 458 the value of the preceding element is "restore", 459 this element MUST NOT be included. Otherwise it MUST be included. 460 If no appeared in command (and the command is not 461 "restore") then this element MUST have a value of 1 year. 463 o Zero or more elements. 465 o Zero or more elements. 467 o An OPTIONAL element. 469 o An OPTIONAL element. 471 If no elements are present in a element, this 472 indicates that no fee will be assessed by the server for this 473 command. 475 If the "avail" attribute of the element is false, then the 476 element MUST NOT contain any or child 477 elements. If the "avail" attribute is true, then the 478 element MUST NOT contain a element. 480 Example response: 482 S: 483 S: 484 S: 485 S: 486 S: Command completed successfully 487 S: 488 S: 489 S: 491 S: 492 S: example.com 493 S: 494 S: 495 S: example.net 496 S: 497 S: 498 S: example.xyz 499 S: 500 S: 501 S: 502 S: 503 S: 506 S: 507 S: 508 S: example.com 509 S: 510 S: create 511 S: USD 512 S: 1 513 S: 5.00 517 S: 518 S: 519 S: 520 S: example.com 521 S: 522 S: create 523 S: USD 524 S: 1 525 S: 5.00 529 S: 530 S: 531 S: 532 S: example.com 533 S: 534 S: create 535 S: USD 536 S: 1 537 S: 538 S: minimum period is 2 years. 539 S: 540 S: 541 S: 542 S: 543 S: 544 S: ABC-12345 545 S: 54322-XYZ 546 S: 547 S: 548 S: 550 5.1.1.1. Server Handling of Elements 552 Clients MAY include a in the element. There 553 are three ways in which servers may handle this element: 555 1. If the server supports the concept of tiers or classes of 556 objects, then the value of this element MUST be validated. If 557 incorrect for the specified object, the "avail" attribute of the 558 corresponding element MUST be false. 560 2. If the server supports different "types" of object registrations 561 (such as a "blocking" registration which does not resolve, or 562 where a registry provides a value-added service that requires an 563 opt-out to disable), then, as with the first model, the server 564 MUST valudate the value of the element. If the value is 565 incorrect, the "avail" attribute of the corresponding 566 element MUST be false. 568 3. If the server supports neither of the above models, the element 569 MUST be ignored. 571 Server operators must provide clear documentation to client operators 572 which of the above models it supports. 574 5.1.2. EPP Transfer Query Command 576 This extension does not add any elements to the EPP query 577 command, but does include elements in the response, when the 578 extension has been selected during a command. 580 When the query command has been processed successfully, 581 the client selected the extension when it logged in, and the client 582 is authorised by the server to view information about the transfer, 583 the server MAY include in the section of the EPP response 584 a element, which contains the following child elements: 586 o A element. 588 o A element. 590 o Zero or more elements containing the fees that will be 591 charged to the gaining client. 593 o Zero or more elements containing the credits that 594 will be refunded to the losing client. 596 Servers SHOULD omit when returning a response to the 597 gaining client, and omit elements when returning a response 598 to the losing client. 600 If no element is included in the response, then no fee 601 will be assessed by the server for the transfer. 603 Example query response: 605 S: 606 S: 607 S: 608 S: 609 S: Command completed successfully; action pending 610 S: 611 S: 612 S: 614 S: example.com 615 S: pending 616 S: ClientX 617 S: 2000-06-08T22:00:00.0Z 618 S: ClientY 619 S: 2000-06-13T22:00:00.0Z 620 S: 2002-09-08T22:00:00.0Z 621 S: 622 S: 623 S: 624 S: 625 S: USD 626 S: 1 627 S: 5.00 628 S: 629 S: 630 S: 631 S: ABC-12345 632 S: 54322-XYZ 633 S: 634 S: 635 S: 637 5.2. EPP Transform Commands 639 5.2.1. EPP Command 641 This extension adds elements to both the EPP command and 642 response, when the extension has been selected during a 643 command. 645 When submitting a command to the server, the client MAY 646 include in the element a element which 647 includes the following child elements: 649 o An OPTIONAL element; 651 o One or more elements. 653 When the command has been processed successfully, and the 654 client selected the extension when it logged in, and a fee was 655 assessed by the server for the transaction, the server MUST include 656 in the section of the EPP response a 657 element, which contains the following child elements: 659 o A element; 661 o Zero or more elements; 663 o Zero or more elements; 665 o An OPTIONAL element; 667 o An OPTIONAL element. 669 If no fee or credit has been assessed by the server for this 670 transaction, a element MUST NOT be included in the 671 response. 673 Example command: 675 C: 676 C: 677 C: 678 C: 679 C: 681 C: example.com 682 C: 2 683 C: 684 C: ns1.example.net 685 C: ns2.example.net 686 C: 687 C: jd1234 688 C: sh8013 689 C: sh8013 690 C: 691 C: 2fooBAR 692 C: 693 C: 694 C: 695 C: 696 C: 697 C: USD 698 C: 5.00 699 C: 700 C: 701 C: ABC-12345 702 C: 703 C: 705 Example response: 707 S: 708 S: 709 S: 710 S: 711 S: Command completed successfully 712 S: 713 S: 714 S: 716 S: example.com 717 S: 1999-04-03T22:00:00.0Z 718 S: 2001-04-03T22:00:00.0Z 719 S: 720 S: 721 S: 722 S: 723 S: USD 724 S: 5.00 725 S: -5.00 726 S: 1000.00 727 S: 728 S: 729 S: 730 S: ABC-12345 731 S: 54321-XYZ 732 S: 733 S: 734 S: 736 5.2.2. EPP Command 738 This extension does not add any elements to the EPP command, 739 but does include elements in the response, when the extension has 740 been selected during the command. 742 When the command has been processed successfully, and the 743 client selected the extension when it logged in, the server MAY 744 include in the section of the EPP response a element, which contains the following child elements: 747 o A element; 749 o Zero or more elements; 751 o An OPTIONAL element; 753 o An OPTIONAL element. 755 If no credit has been assessed by the server for this transaction, a 756 element MUST NOT be included in the response. 758 Example response: 760 S: 761 S: 762 S: 763 S: 764 S: Command completed successfully 765 S: 766 S: 767 S: 769 S: USD 770 S: -5.00 771 S: 1005.00 772 S: 773 S: 774 S: 775 S: ABC-12345 776 S: 54321-XYZ 777 S: 778 S: 779 S: 781 5.2.3. EPP Command 783 This extension adds elements to both the EPP command and 784 response, when the extension has been selected during a 785 command. 787 When submitting a command to the server, the client MAY 788 include in the element a element which 789 includes the following child elements: 791 o An OPTIONAL element; 793 o One or more elements. 795 When the command has been processed successfully, and the 796 client selected the extension when it logged in, the server MAY 797 include in the section of the EPP response a element, which contains the following child elements: 800 o A element; 801 o Zero or more elements; 803 o Zero or more elements; 805 o An OPTIONAL element; 807 o An OPTIONAL element. 809 If no fee or credit has been assessed by the server for this 810 transaction, a element MUST NOT be included in the 811 response. 813 Example command: 815 C: 816 C: 817 C: 818 C: 819 C: 821 C: example.com 822 C: 2000-04-03 823 C: 5 824 C: 825 C: 826 C: 827 C: 828 C: USD 829 C: 5.00 830 C: 831 C: 832 C: ABC-12345 833 C: 834 C: 836 Example response: 838 S: 839 S: 840 S: 841 S: 842 S: Command completed successfully 843 S: 844 S: 845 S: 847 S: example.com 848 S: 2005-04-03T22:00:00.0Z 849 S: 850 S: 851 S: 852 S: 853 S: USD 854 S: 5.00 855 S: 1000.00 856 S: 857 S: 858 S: 859 S: ABC-12345 860 S: 54322-XYZ 861 S: 862 S: 863 S: 865 5.2.4. EPP Command 867 This extension adds elements to both the EPP command and 868 response, when the value of the "op" attribute of the 869 command element is "request", and the extension has been selected 870 during the command. 872 When submitting a command to the server, the client MAY 873 include in the element a element which 874 includes the following child elements: 876 o An OPTIONAL element; 878 o One or more elements. 880 When the command has been processed successfully, and the 881 client selected the extension when it logged in, the server MAY 882 include in the section of the EPP response a element, which contains the following child elements: 885 o A element; 887 o Zero or more elements; 889 o Zero or more elements; 891 o An OPTIONAL element; 893 o An OPTIONAL element. 895 If no fee or credit has been assessed by the server for this 896 transaction, a element MUST NOT be included in the 897 response. 899 Example command: 901 C: 902 C: 903 C: 904 C: 905 C: 907 C: example.com 908 C: 1 909 C: 910 C: 2fooBAR 911 C: 912 C: 913 C: 914 C: 915 C: 916 C: USD 917 C: 5.00 918 C: 919 C: 920 C: ABC-12345 921 C: 922 C: 924 Example response: 926 S: 927 S: 928 S: 929 S: 930 S: Command completed successfully; action pending 931 S: 932 S: 933 S: 935 S: example.com 936 S: pending 937 S: ClientX 938 S: 2000-06-08T22:00:00.0Z 939 S: ClientY 940 S: 2000-06-13T22:00:00.0Z 941 S: 2002-09-08T22:00:00.0Z 942 S: 943 S: 944 S: 945 S: 946 S: USD 947 S: 5.00 948 S: 949 S: 950 S: 951 S: ABC-12345 952 S: 54322-XYZ 953 S: 954 S: 955 S: 957 5.2.5. EPP Command 959 This extension adds elements to both the EPP command and 960 response, when the extension has been selected during a has 961 been selected during the command. 963 When submitting a command to the server, the client MAY 964 include in the element a element which 965 includes the following child elements: 967 o An OPTIONAL element; 969 o One or more elements. 971 When the command has been processed successfully, and the 972 client selected the extension when it logged in, the server MAY 973 include in the section of the EPP response a 974 element, which contains the following child elements: 976 o A element; 978 o Zero or more elements; 980 o Zero or more elements; 982 o An OPTIONAL element; 984 o An OPTIONAL element. 986 If no fee or credit has been assessed by the server for this 987 transaction, a element MUST NOT be included in the 988 response. 990 Example command: 992 C: 993 C: 994 C: 995 C: 996 C: 998 C: example.com 999 C: 1000 C: sh8013 1001 C: 1002 C: 1003 C: 1004 C: 1005 C: 1006 C: USD 1007 C: 5.00 1008 C: 1009 C: 1010 C: ABC-12345 1011 C: 1012 C: 1014 Example response: 1016 S: 1017 S: 1018 S: 1019 S: 1020 S: Command completed successfully 1021 S: 1022 S: 1023 S: 1024 S: USD 1025 S: 5.00 1026 S: 1027 S: 1028 S: 1029 S: ABC-12345 1030 S: 54321-XYZ 1031 S: 1032 S: 1033 S: 1035 5.3. Formal Syntax 1037 An EPP object mapping is specified in XML Schema notation. The 1038 formal syntax presented here is a complete schema representation of 1039 the object mapping suitable for automated validation of EPP XML 1040 instances. 1042 Copyright (c) 2014 IETF Trust and the persons identified as authors 1043 of the code. All rights reserved. 1045 Redistribution and use in source and binary forms, with or without 1046 modification, are permitted provided that the following conditions 1047 are met: 1049 o Redistributions of source code must retain the above copyright 1050 notice, this list of conditions and the following disclaimer. 1052 o Redistributions in binary form must reproduce the above copyright 1053 notice, this list of conditions and the following disclaimer in 1054 the documentation and/or other materials provided with the 1055 distribution. 1057 o Neither the name of Internet Society, IETF or IETF Trust, nor the 1058 names of specific contributors, may be used to endorse or promote 1059 products derived from this software without specific prior written 1060 permission. 1062 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1063 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1064 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1065 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 1066 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 1067 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 1068 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 1069 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 1070 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 1071 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 1072 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 1074 BEGIN 1075 1076 1083 1084 1086 1087 Extensible Provisioning Protocol 1088 v1.0 extension schema for fee 1089 information. 1090 1092 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1107 1110 1111 1112 1113 1115 1117 1119 1120 1122 1125 1126 1127 1129 1130 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1145 1147 1149 1150 1151 1152 1153 1155 1158 1159 1160 1162 1164 1166 1167 1169 1172 1173 1174 1175 1177 1179 1181 1183 1184 1186 1189 1190 1191 1193 1194 1197 1199 1201 1202 1204 1207 1208 1209 1210 1212 1214 1216 1217 1219 1222 1223 1224 1225 1226 1228 1229 1230 1231 1232 1233 1234 1235 1237 1238 1239 1240 1241 1242 1244 1245 1246 1247 1248 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1273 1274 1275 1276 1277 1278 1279 1281 1282 1283 1285 1286 1287 1289 1291 END 1293 6. Security Considerations 1295 The mapping extensions described in this document do not provide any 1296 security services beyond those described by EPP [RFC5730], the EPP 1297 domain name mapping [RFC5731], and protocol layers used by EPP. The 1298 security considerations described in these other specifications apply 1299 to this specification as well. 1301 7. IANA Considerations 1303 7.1. XML Namespace 1305 This document uses URNs to describe XML namespaces and XML schemas 1306 conforming to a registry mechanism described in [RFC3688]. The 1307 following URI assignment is requested of IANA: 1309 URI: urn:ietf:params:xml:ns:fee-0.11 1311 Registrant Contact: See the "Author's Address" section of this 1312 document. 1314 XML: See the "Formal Syntax" section of this document. 1316 7.2. EPP Extension Registry 1318 The EPP extension described in this document should be registered by 1319 the IANA in the EPP Extension Registry described in [RFC7451]. The 1320 details of the registration are as follows: 1322 Name of Extension: EPP Fee Extension 1324 Document status: Standards Track 1326 Reference: (insert reference to RFC version of this document) 1328 Registrant Name and Email Address: See the "Author's Address" section 1329 of this document. 1331 TLDs: any 1333 IPR Disclosure: none 1335 Status: active 1337 Notes: none 1339 8. Implementation Status 1341 Note to RFC Editor: Please remove this section and the reference to 1342 [RFC6982] before publication. 1344 This section records the status of known implementations of the 1345 protocol defined by this specification at the time of posting of this 1346 Internet-Draft, and is based on a proposal described in [RFC6982]. 1347 The description of implementations in this section is intended to 1348 assist the IETF in its decision processes in progressing drafts to 1349 RFCs. Please note that the listing of any individual implementation 1350 here does not imply endorsement by the IETF. Furthermore, no effort 1351 has been spent to verify the information presented here that was 1352 supplied by IETF contributors. This is not intended as, and must not 1353 be construed to be, a catalog of available implementations or their 1354 features. Readers are advised to note that other implementations may 1355 exist. 1357 According to [RFC6982], "this will allow reviewers and working groups 1358 to assign due consideration to documents that have the benefit of 1359 running code, which may serve as evidence of valuable experimentation 1360 and feedback that have made the implemented protocols more mature. 1361 It is up to the individual working groups to use this information as 1362 they see fit". 1364 8.1. RegistryEngine EPP Service 1366 Organization: CentralNic 1368 Name: RegistryEngine EPP Service 1370 Description: Generic high-volume EPP service for gTLDs, ccTLDs and 1371 SLDs 1373 Level of maturity: Deployed in CentralNic's production environment as 1374 well as two other gTLD registry systems, and two ccTLD registry 1375 systems. 1377 Coverage: All aspects of the protocol are implemented. 1379 Licensing: Proprietary In-House software 1381 Contact: epp@centralnic.com 1383 URL: https://www.centralnic.com 1385 9. Acknowledgements 1387 The authors wish to thank the following persons for their feedback 1388 and suggestions: 1390 o James Gould of Verisign 1392 o Luis Munoz of ISC 1393 o Michael Young of Architelos 1395 o Ben Levac and Jeff Eckhaus of Demand Media 1397 o Seth Goldman of Google 1399 o Klaus Malorny and Michael Bauland of Knipp 1401 o Jody Kolker and Roger Carney of Go Daddy 1403 o Michael Holloway of Com Laude 1405 o Santosh Kalsangrah of Impetus Infotech 1407 o Alex Mayrhofer of Nic.at 1409 10. Change History 1411 10.1. Changes from 00 to 01 1413 1. Restore the command extension; either or 1414 can be used. 1416 2. added extension elements for , , and 1417 so that the server can reject the command if the fee is 1418 incorrect. 1420 10.2. Changes from 01 to 02 1422 1. Use Internet-Draft version number rather than XML namespace 1423 version number in this section. 1425 2. Support for multiple and elements. 1427 3. Added the "description" attribute to and 1428 elements. 1430 4. Added the element. 1432 5. Added the element. 1434 6. Updated reference to [draft-ietf-eppext-launchphase]. 1436 7. Use instead of . 1438 8. Use a single child element of instead of multiple 1439 elements for each domain. This also requires using a different 1440 name () for the domain name. 1442 9. Added the "refundable" attribute to elements. 1444 10. Added the "grace-period" attribute to elements. 1446 10.3. Changes from 02 to 03 1448 1. Added the "applied" attribute to to elements. 1450 2. Simplified the wording in relation to when a server can return an 1451 error for extended commands. 1453 3. Added the element to transfer query responses. 1455 4. Removed wording about how servers behave when receiving incorrect 1456 fee information from transform commands, and put it into a single 1457 section at the top of the document. 1459 5. Allow servers to omit elements from elements 1460 if the command specified by the client is forbidden. 1462 10.4. Changes from 03 to 04 1464 1. Changed Intended Status to Standards Track. 1466 2. As per suggestion from Michael Bauland, the element 1467 is no longer included in and responses for 1468 "restore" commands. It's still mandatory for all other commands. 1470 3. Added summary of the attributes for the element. 1472 4. Clarified that the "refundable" and "grace-period" attributes of 1473 the elements are dependant on each other and cannot 1474 appear on their own. 1476 5. Removed the option of returning a 1001 response when the fee is 1477 incorrect. 1479 6. Forbidden the inclusion of extension elements in transform 1480 responses if no fee/credit has been assessed. 1482 7. Made the element optional in transform commands. 1484 8. Amended XML Namespace section of IANA Considerations, added EPP 1485 Extension Registry section. 1487 10.5. Changes from 04 to 05 1489 1. Removed the extended command. The command is the 1490 only command that can be used now. 1492 2. Introduced a mandatory-to-implement "standard" class for non- 1493 premium domains. 1495 3. The decision was made to keep availability info in 1496 responses as registrars have indicated that it is very useful as 1497 it avoids unnecessary round trips to the server. 1499 4. Allow elements to be present in responses. 1501 5. Allow the number of which can appear in transform 1502 responses to be zero. 1504 6. Removed the and elements from 1505 transfer query responses. The reason is that these elements are 1506 defined as containing the values after the transform command has 1507 taken place - which means that it is not appropriate to include 1508 them in a query response. 1510 7. Added Implementation Status section. 1512 10.6. Changes from 05 to 06 1514 1. The specification is now object-agnostic, but works with RFC5731 1515 [RFC5731] domains by default. 1517 2. Renamed the element to . Added the 1518 "objURI" attribute. 1520 3. Removed the default value for the "refundable" attribute of elements, and added text about how clients should handle 1522 such cases. Added similar text to the documentation of the 1523 "grace-period" attribute. 1525 4. Removed references to the defunct command syntax. 1527 5. "MUST" requirements regarding documentation have been changed to 1528 "must". 1530 6. Created separate "Correlation between Refundability and Grace 1531 Periods" section describing how the "refundable" and "grace- 1532 period" attributes work together. 1534 10.7. Changes from 06 to 07 1536 1. Changed the syntax of the form to be simpler: a single 1537 set of , etc elements is applied to 1538 the objects specified in the main body of the command. 1540 2. Simplified the object-agnosticism to simply copy the element from 1541 the command into the element. 1543 3. Added the "avail" attribute to the element and added 1544 commentary about its semantics. 1546 4. Added the element to the response so servers 1547 can indicate why fee information is not available. 1549 10.8. Changes from draft-brown-epp-fees-00 to 1550 draft-ietf-regext-epp-fees-00 1552 1. Updated to be a WG document. 1554 11. Normative References 1556 [ISO4217] International Organization for Standardization, "ISO 4217: 1557 2008, Codes for the representation of currencies and 1558 funds", 2008. 1560 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1561 Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/ 1562 RFC2119, March 1997, 1563 . 1565 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 1566 DOI 10.17487/RFC3688, January 2004, 1567 . 1569 [RFC3915] Hollenbeck, S., "Domain Registry Grace Period Mapping for 1570 the Extensible Provisioning Protocol (EPP)", RFC 3915, 1571 DOI 10.17487/RFC3915, September 2004, 1572 . 1574 [RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", 1575 STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009, 1576 . 1578 [RFC5731] Hollenbeck, S., "Extensible Provisioning Protocol (EPP) 1579 Domain Name Mapping", STD 69, RFC 5731, DOI 10.17487/ 1580 RFC5731, August 2009, 1581 . 1583 [RFC6982] Sheffer, Y. and A. Farrel, "Improving Awareness of Running 1584 Code: The Implementation Status Section", RFC 6982, 1585 DOI 10.17487/RFC6982, July 2013, 1586 . 1588 [RFC7451] Hollenbeck, S., "Extension Registry for the Extensible 1589 Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451, 1590 February 2015, . 1592 [draft-ietf-eppext-launchphase] 1593 Gould, J., Tan, W., and G. Brown, "Launch Phase Mapping 1594 for the Extensible Provisioning Protocol (EPP)", 2014. 1596 Authors' Addresses 1598 Gavin Brown 1599 CentralNic Group plc 1600 35-39 Moorgate 1601 London, England EC2R 6AR 1602 GB 1604 Phone: +44 20 33 88 0600 1605 Email: gavin.brown@centralnic.com 1606 URI: https://www.centralnic.com 1608 Jothan Frakes 1610 Email: jothan@jothan.com 1611 URI: http://jothan.com