Internet-Draft | registryLock | June 2021 |
Wisser | Expires 20 December 2021 | [Page] |
This extensions defines an additional protective layer for changes to domain [RFC5731], host xref target="RFC5732" format="default"/> and contact [RFC5733] objects managed through EPP.¶
EPP allows changes to objects only by the sponsoring client. EPP objects are usually managed by the sponsoring client on behalf of the sponsoring clients customers. All of these interactions are ususally fully automated.¶
In case of a system breach, there is no protection in EPP to changes to any object by the intruder.¶
This extension defines a protective layer that aims to break automated changes and work flows by requiring manual intervention by the sponsoring client or it's customers.¶
xxx¶
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.¶
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.¶
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."¶
This Internet-Draft will expire on 20 December 2021.¶
Copyright (c) 2021 IETF Trust and the persons identified as the document authors. All rights reserved.¶
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.¶
This extensions defines an additional protective layer for changes to domain [RFC5731], host [RFC5732] and contact [RFC5733] objects managed through EPP.¶
EPP allows changes to objects only by the sponsoring client. EPP objects are usually managed by the sponsoring client on behalf of the sponsoring clients customers. All of these interactions are ususally fully automated.¶
In case of a system breach, there is no protection in EPP to changes to any object by the intruder.¶
This extension defines a protective layer that aims to break automated changes and work flows by requiring manual intervention by the sponsoring client or it's customers.¶
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 [RFC2119].¶
XML is case sensitive. Unless stated otherwise, XML specifications and examples provided in this document MUST be interpreted in the character case presented in order to develop a conforming implementation.¶
In examples, "C:" represents lines sent by a protocol client and "S:" represents lines returned by a protocol server. Indentation and white space in examples are provided only to illustrate element relationships and are not a REQUIRED feature of this protocol.¶
"regLock" is used as an abbreviation for "urn:ietf:params:xml:ns:epp:registryLock-1.0". The XML namespace prefix "reglock" is used, but implementations MUST NOT depend on it and instead employ a proper namespace-aware XML parser and serializer to interpret and output the XML documents.¶
This extension provides additional protection to objects managed by a sponsoring client on behalf of a registrant. This is achieved by requiring additional authorization for transform commands.¶
Solutions can be broadly categorized as in-band or out-of-band authorizations. Where in-band authorizations would provide authorization through EPP. Whereas out-of-band solutions provide authorization by some other means.¶
In-band authorization uses the authorization possibilities provided by EPP Standards [RFC5730], [RFC5731], [RFC5732] and [RFC5733].¶
registryLock aims to break automatic changes to registry objects. A registry implementing password authorization must make sure to secure authorization in a way that breaks automation and requires human interaction. One such scheme, although currently none is defined for EPP, could be one time passwords.¶
With password authorization temporary unlock MUST not be implemented. Every <update> command could be authorized by including the credentials in the command.¶
Out-of-band Authorization is not covered in this document. By definition out-of-band authorization will not use EPP and therefore is not subject of consideration here.¶
Registries must provide means for the registrar or registrant to temporarily unlock the domain, to remove registry lock or ro authorize changes submitted to the server through some means than EPP.¶
Any object that is locked with out-of-band authorization MUST reject password authorization with EPP response code 2201 "Authorization error" [RFC5730] section 3.¶
Any object that is locked with password authorization MUST reject out-of-band authorization with EPP response code 2201 "Authorization error" [RFC5730] section 3.¶
Once an object has Registry Lock enabled all transform commands except <renew> MUST only be executed if¶
Otherwise the command MUST be rejected with EPP result code 2201 "Authorization error" [RFC5730] section 3.¶
The following EPP flags [RFC5731], [RFC5732], [RFC5733] must be set.¶
If the object is unlocked the flags SHOULD be cleared and the server should answer to an <info> request with the according information. However, if the object is only temporarily unlocked, only the serverUpdateProhibited flag SHOULD be cleared, but in an <info> response the server should still indicate that the object is under registry lock.¶
OPEN QUESTION: If a domain is under registry lock, can a subordinate host be updated?¶
We need more input!¶
Locking Status information indicates if the additional protection of Registry Lock is enabled for an object.¶
Boolean values MUST be represented in the XML Schema format described in Part 2 of the W3C XML Schema recommendation [W3C.REC-xmlschema-2-20041028].¶
A detailed description of the EPP syntax and semantics can be found in the EPP core protocol specification [RFC5730].¶
This extension does not add any elements to the EPP <check> command or <check> response described in the EPP mappings [RFC5731], [RFC5732] or [RFC5733].¶
This extension does not add any elements to the EPP <info> command described in the EPP domain mapping [RFC5731], host mapping [RFC5732] or contact mapping [RFC5733] However, additional elements are defined for the <info> response.¶
When an <info> command has been processed successfully, the EPP <resData> element MUST contain child elements as described in the EPP object mappings.¶
In addition, the EPP <extension> element SHOULD contain a child <regLock:infData> element that identifies the extension namespace the epp client has indicated support for the extension in the <login> command.¶
The <regLock:infData> element contains the following child elements:¶
Example <domain:info> Response, domain not locked¶
S:<?xml version="1.0" encoding="UTF-8" standalone="no"?> S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0" S: xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> S: <response> S: <result code="1000"> S: <msg>Command completed successfully</msg> S: </result> S: <resData> S: <domain:infData ... S: </domain:infData> S: </resData> S: <extension> S: <regLock:infData S: xmlns:regLock="urn:ietf:params:xml:ns:epp:registryLock-1.0"> S: <regLock:locked>0</regLock:locked> S: </regLock:infData> S: </extension> S: <trID> S: <clTRID>ABC-12345</clTRID> S: <svTRID>54322-XYZ</svTRID> S: </trID> S: </response> S:</epp>¶
Example <domain:info> Response, domain locked¶
S:<?xml version="1.0" encoding="UTF-8" standalone="no"?> S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0" S: xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> S: <response> S: <result code="1000"> S: <msg>Command completed successfully</msg> S: </result> S: <resData> S: <domain:infData ... S: </domain:infData> S: </resData> S: <extension> S: <regLock:infData S: xmlns:regLock="urn:ietf:params:xml:ns:epp:registryLock-1.0"> S: <regLock:locked>1</regLock:locked> S: </regLock:infData> S: </extension> S: <trID> S: <clTRID>ABC-12345</clTRID> S: <svTRID>54322-XYZ</svTRID> S: </trID> S: </response> S:</epp>¶
Example <domain:info> Response, domain temporary unlocked¶
S:<?xml version="1.0" encoding="UTF-8" standalone="no"?> S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0" S: xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> S: <response> S: <result code="1000"> S: <msg>Command completed successfully</msg> S: </result> S: <resData> S: <domain:infData ... S: </domain:infData> S: </resData> S: <extension> S: <regLock:infData xmlns:regLock="urn:ietf:params:xml:ns:epp:registryLock-1.0"> S: <regLock:locked>1</regLock:locked> S: <regLock:unlockedUntil>20000101T000000+0000</regLock:unlockedUntil> S: </regLock:infData> S: </extension> S: <trID> S: <clTRID>ABC-12345</clTRID> S: <svTRID>54322-XYZ</svTRID> S: </trID> S: </response> S:</epp>¶
This extension is intended to be used within the scope of the object creation. It does not define a <create> command of its own.¶
This extension adds elements to both the EPP <create> command and response as described in the EPP [RFC5730].¶
When submitting a <create> command to the server, the client MAY include in the <extension> element a <registryLock:create> element to create the domain in a locked state. The extension includes the following child element:¶
When the <create> command has been processed successfully, and the client requested the creation of a locked domain, the server MUST include in the <extension> section of the EPP response a <regLock:creData> element that contains the following child element:¶
Example <host:create> command¶
C:<?xml version="1.0" encoding="UTF-8" standalone="no"?> C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> C: <command> C: <create> C: <host:create C: xmlns:host="urn:ietf:params:xml:ns:host-1.0"> C: <host:name>ns1.example.com</host:name> C: <host:addr ip="v4">192.0.2.2</host:addr> C: <host:addr ip="v4">192.0.2.29</host:addr> C: <host:addr ip="v6">1080:0:0:0:8:800:200C:417A</host:addr> C: </host:create> C: </create> C: <extension> C: <regLock:lock xmlns:regLock="urn:ietf:params:xml:ns:epp:registryLock-1.0"> C: <regLock:unlock>outofband</locked> C: </regLock:lock> C: </extension> C: <clTRID>ABC-12345</clTRID> C: </command> C:</epp>¶
Example <host:update> response¶
S:<?xml version="1.0" encoding="UTF-8" standalone="no"?> S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> S: <response> S: <result code="1000"> S: <msg>Command completed successfully</msg> S: </result> S: <extension> S: <regLock:infData xmlns:regLock="urn:ietf:params:xml:ns:epp:registryLock-1.0"> S: <regLock:locked>1</locked> S: </regLock:infData> S: </extension> S: <trID> S: <clTRID>ABC-12345</clTRID> S: <svTRID>54321-XYZ</svTRID> S: </trID> S: </response> S:</epp>¶
This extension does not add any elements to the EPP <delete> command or <delete> response described in the EPP mappings [RFC5731], [RFC5732] or [RFC5733].¶
If the object is locked, the EPP <delete> command MUST be rejected with EPP response code 2201 "Authorization error" [RFC5730] section 3. See Section 2.3¶
This extension does not add any elements to the EPP <renew> command or <renew> response described in the EPP mappings [RFC5731], [RFC5732] or [RFC5733].¶
Execution of the EPP <renew> command is not restricted by this extension.¶
This extension does not add any elements to the EPP <transfer> command or <transfer> response described in the EPP mappings [RFC5731], [RFC5732] or [RFC5733].¶
If the object is locked, the EPP <transfer> command MUST be rejected with EPP response code 2201 "Authorization error" [RFC5730] section 3. See Section 2.3¶
This extension adds elements to both the EPP <update> command and response as described in [RFC5730].¶
If the object is not locked, the <update> command can be used to lock the object, similarly to the <create> command.¶
If the object is locked, the server MUST NOT except any command to fully unlock the object. Only temporarily unlocking is acceptable.¶
If the object is locked the server can handle <update> commands in two ways¶
If the object is temporarily unlocked only <update> commands are allowed. <delete> and <transfer> are explicitly not allowed. For the time of the temporary unlock the serverUpdateProhibited status should be cleared.¶
Registries can narrow down allowed changes when a domain is locked. Registries could prohobit changes of registrant for doamins even if the domain is temporatily unlocked or password authorization is given.¶
When the <update>> command has been processed successfully, and the client included the regLock extension in the update request, the server MUST include in the <extension> section of the EPP response a <regLock:updData> element that contains the following child elements:¶
Example <domain:update> command, locking domain¶
C:<?xml version="1.0" encoding="UTF-8" standalone="no"?> C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> C: <command> C: <update> C: <domain:update C: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> C: <domain:name>example.com</domain:name> C: </domain:update> C: </update> C: <extension> C: <regLock:update xmlns:regLock="urn:ietf:params:xml:ns:epp:registryLock-1.0"> C: <regLock:unlock>outofband</locked> C: </regLock:lock> C: </extension> C: <clTRID>ABC-12345</clTRID> C: </command> C:</epp>¶
Example <domain:update> response¶
S:<?xml version="1.0" encoding="UTF-8" standalone="no"?> S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> S: <response> S: <result code="1000"> S: <msg>Command completed successfully</msg> S: </result> S: <extension> S: <regLock:updData xmlns:regLock="urn:ietf:params:xml:ns:epp:registryLock-1.0"> S: <regLock:locked>1</locked> S: </regLock:updData> S: </extension> S: <trID> S: <clTRID>ABC-12345</clTRID> S: <svTRID>54321-XYZ</svTRID> S: </trID> S: </response> S:</epp>¶
Example <domain:update> command, for temporary unlock of domain¶
C:<?xml version="1.0" encoding="UTF-8" standalone="no"?> C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> C: <command> C: <update> C: <domain:update C: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> C: <domain:name>example.com</domain:name> C: </domain:update> C: </update> C: <extension> C: <regLock:updData xmlns:regLock="urn:ietf:params:xml:ns:epp:registryLock-1.0"> C: <regLock:unlockUntil>20000101T000000+0000</regLock:unlockUntil> C: </regLock:updData> C: </extension> C: <clTRID>ABC-12345</clTRID> C: </command> C:</epp>¶
Example <domain:update> response, for temporary unlock of domain¶
S:<?xml version="1.0" encoding="UTF-8" standalone="no"?> S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> S: <response> S: <result code="1000"> S: <msg>Command completed successfully</msg> S: </result> S: <extension> S: <regLock:updData xmlns:regLock="urn:ietf:params:xml:ns:epp:registryLock-1.0"> S: <regLock:locked>1</locked> S: <regLock:unlockedUntil>20000101T000000+0000</regLock:unlockedUntil> S: </regLock:updData> S: </extension> S: <trID> S: <clTRID>ABC-12345</clTRID> S: <svTRID>54321-XYZ</svTRID> S: </trID> S: </response> S:</epp>¶
Example <domain:update> response, for failure of temporary unlock of domain¶
S:<?xml version="1.0" encoding="UTF-8" standalone="no"?> S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> S: <response> S: <result code="2201"> S: <msg>Authorization error</msg> S: </result> S: <extension> S: <regLock:updData xmlns:regLock="urn:ietf:params:xml:ns:epp:registryLock-1.0"> S: <regLock:locked>1</locked> S: </regLock:updData> S: </extension> S: <trID> S: <clTRID>ABC-12345</clTRID> S: <svTRID>54321-XYZ</svTRID> S: </trID> S: </response> S:</epp>¶
One schema is presented here that is the EPP Registry Lock Extension schema.¶
The formal syntax presented here is a complete schema representation of the object mapping suitable for automated validation of EPP XML instances. The BEGIN and END tags are not part of the schema; they are used to note the beginning and ending of the schema for URI registration purposes.¶
BEGIN <?xml version="1.0" encoding="UTF-8"?> <xs:schema targetNamespace="urn:ietf:params:xml:ns:epp:registryLock-1.00" xmlns:regLock="urn:ietf:params:xml:ns:epp:registryLock-1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"> <xs:annotation> <xs:documentation> Registry Lock Extension to the Extensible Provisioning Protocol v1.0 </xs:documentation> </xs:annotation> <!-- child elements found in EPP commands --> <xs:element name="create" type="regLock:createType"/> <xs:element name="update" type="regLock:updateType"/> <!-- child elements found in EPP responses --> <xs:element name="infData" type="regLock:respDataType"/> <xs:element name="creData" type="regLock:respDataType"/> <xs:element name="updData" type="regLock:respDataType"/> <!-- child element of the <create> command --> <xs:complexType name="createType"> <xs:sequence> <xs:element name="unlock" type="regLock:unlockType"/> <xs:element name="unlockUntil" type="xs:dateTime"/> </xs:sequence> </xs:complexType> <!-- child element of the <update> command --> <xs:complexType name="updateType"> <xs:choice> <xs:element name="unlock" type="regLock:unlockType"/> <xs:element name="unlockUntil" type="xs:dateTime"/> </xs:choice> </xs:complexType> <!-- child element of the response --> <xs:complexType name="respDataType"> <xs:sequence> <xs:element name="locked" type="xs:boolean"/> </xs:sequence> </xs:complexType> <!-- common types --> <xs:simpleType name="unlockType"> <xs:restriction base="xs:token"> <xs:enumeration value="outofband"/> <xs:enumeration value="password"/> </xs:restriction> </xs:simpleType> </xs:schema> END¶
This document uses URNs to describe XML namespaces and XML schemas conforming to a registry mechanism described in [RFC3688]. The following URI assignment is requested of IANA:¶
Registration request for the registryLock namespace:¶
Registration request for the registryLock XML schema:¶
The EPP extension described in this document should be registered by the IANA in the EPP Extension Registry described in [RFC7451]. The details of the registration are as follows:¶
Name of Extension: "Registry Lock Extension for the Extensible Provisioning Protocol (EPP)"¶
Document status: Standards Track¶
Reference: (insert reference to RFC version of this document)¶
Registrant Name and Email Address: IESG, <iesg@ietf.org>¶
TLDs: Any¶
IPR Disclosure: None¶
Status: Active¶
Notes: None¶
Note to RFC Editor: Please remove this section and the reference to RFC 7942 [RFC7942] before publication.¶
Implemented by .SE since 2019.¶
The security properties of EPP from [RFC5730] are preserved.¶
This extensions introduces an additional security layer for changes of objects managed through EPP. The overall security of these measures depends on policies and procedures not covered in this document.¶
Registry should whenevr possible NOT implement password authorization. Once the password is known to the EPP client and number of changes could be authorized with it. Therefore a registry implementing password authorization MUST take precautions so that every update needs human interaction.¶
The authors wish to thank the following persons for their feedback and suggestions:¶