Use of Internationalized Email Addresses in EPP protocol
draft-belyavskiy-epp-eai-02
The information below is for an old version of the document.
| Document | Type |
This is an older version of an Internet-Draft whose latest revision state is "Replaced".
|
|
|---|---|---|---|
| Authors | Dmitry Belyavsky , James Gould | ||
| Last updated | 2020-11-19 (Latest revision 2020-10-11) | ||
| Replaced by | draft-ietf-regext-epp-eai, draft-ietf-regext-epp-eai | ||
| RFC stream | (None) | ||
| Formats | |||
| Stream | Stream state | (No stream defined) | |
| Consensus boilerplate | Unknown | ||
| RFC Editor Note | (None) | ||
| IESG | IESG state | I-D Exists | |
| Telechat date | (None) | ||
| Responsible AD | (None) | ||
| Send notices to | (None) |
draft-belyavskiy-epp-eai-02
Network Working Group D. Belyavskiy
Internet-Draft
Intended status: Standards Track J. Gould
Expires: 22 May 2021 VeriSign, Inc.
18 November 2020
Use of Internationalized Email Addresses in EPP protocol
draft-belyavskiy-epp-eai-02
Abstract
This document permits usage of Internationalized Email Addresses in
the EPP protocol. The Extensible Provisioning Protocol (EPP), being
developed before appearing the standards for Internationalized Email
Addresses (EAI), does not support such email addressed. This
document describes an EPP extension that allows EAI addresses to be
used with an EPP object mapping like the EPP contact mapping.
TO BE REMOVED on turning to RFC: The document is edited in the
dedicated github repo (https://github.com/beldmit/eppeai). Please
send your submissions via GitHub.
Status of This Memo
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 22 May 2021.
Copyright Notice
Copyright (c) 2020 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.
Belyavskiy & Gould Expires 22 May 2021 [Page 1]
Internet-Draft Use of EAI in EPP November 2020
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.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Conventions Used in This Document . . . . . . . . . . . . 3
2. Migrating to Newer Versions of This Extension . . . . . . . . 3
3. Object Attributes . . . . . . . . . . . . . . . . . . . . . . 4
3.1. <eai:eai> Extension Element . . . . . . . . . . . . . . . 4
3.2. [EAI-ADDRESS] Email Value . . . . . . . . . . . . . . . . 4
4. Email Address Specification . . . . . . . . . . . . . . . . . 4
5. EPP commands mapping . . . . . . . . . . . . . . . . . . . . 4
5.1. EPP Query Commands . . . . . . . . . . . . . . . . . . . 5
5.1.1. EPP <check> Command . . . . . . . . . . . . . . . . . 5
5.1.2. EPP <info> command . . . . . . . . . . . . . . . . . 5
5.1.3. EPP <transfer> Command . . . . . . . . . . . . . . . 6
5.2. EPP Transform Commands . . . . . . . . . . . . . . . . . 7
5.2.1. EPP <create> command . . . . . . . . . . . . . . . . 7
5.2.2. EPP <delete> Command . . . . . . . . . . . . . . . . 8
5.2.3. EPP <renew> Command . . . . . . . . . . . . . . . . . 9
5.2.4. EPP <transfer> Command . . . . . . . . . . . . . . . 9
5.2.5. EPP <update> command . . . . . . . . . . . . . . . . 9
6. Formal syntax . . . . . . . . . . . . . . . . . . . . . . . . 10
7. Security Considerations . . . . . . . . . . . . . . . . . . . 11
8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 11
8.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 11
8.2. EPP Extension Registry . . . . . . . . . . . . . . . . . 12
9. Implementation Considerations . . . . . . . . . . . . . . . . 12
10. References . . . . . . . . . . . . . . . . . . . . . . . . . 12
10.1. Normative References . . . . . . . . . . . . . . . . . . 12
10.2. Informative References . . . . . . . . . . . . . . . . . 13
Appendix A. Change History . . . . . . . . . . . . . . . . . . . 13
A.1. Change from 00 to 01 . . . . . . . . . . . . . . . . . . 13
A.2. Change from 01 to 02 . . . . . . . . . . . . . . . . . . 14
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 14
1. Introduction
RFC 6530 [RFC6530] introduced the framework for Internationalized
Email Addresses. To make such addresses more widely accepted, the
changes to various protocols need to be introduced.
Belyavskiy & Gould Expires 22 May 2021 [Page 2]
Internet-Draft Use of EAI in EPP November 2020
This document describes an Extensible Provisioning Protocol (EPP)
extension for using the Email Addresses Internationalized (EAI) in an
extension to EPP object mappings like the EPP contact mapping
[RFC5733]. The extension can be applied to any EPP object mapping
that uses an email address, where the EPP contact mapping [RFC5733]
is used in the examples.
The Extensible Provisioning Protocol (EPP) specified in RFC 5730
[RFC5730] is a base document for object management operations and an
extensible framework that maps protocol operations to objects. The
specifics of various objects managed via EPP is described in separate
documents. This document is only referring to an email address as a
property of a managed object, such as the <contact:email> element in
the EPP contact mapping [RFC5733] or the <org:email> element in the
EPP organization mapping [RFC8543].
RFC 3735 [RFC3735] provides a guideline to extend the EPP protocol
for various purposes. This extension represents a Command-Response
Extension.
1.1. Conventions Used in This Document
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP
14 [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here.
In examples, "C:" represents lines sent by a protocol client and "S:"
represents lines returned by a protocol server. In examples,
indentation and whitespace are provided only to illustrate element
relationships and are not a required feature of this protocol.
"eai-0.1" is used as an abbreviation for
"urn:ietf:params:xml:ns:epp:eai-0.1". The XML namespace prefix "eai"
is used, but implementations MUST NOT depend on it. Instead, they
are to employ a proper namespace-aware XML parser and serializer to
interpret and output the XML documents.
2. Migrating to Newer Versions of This Extension
Servers that implement this extension SHOULD provide a way for
clients to progressively update their implementations when a new
version of the extension is deployed. A newer version of the
extension is expected to use an XML namespace with a higher version
number than the prior versions.
Belyavskiy & Gould Expires 22 May 2021 [Page 3]
Internet-Draft Use of EAI in EPP November 2020
3. Object Attributes
This extension adds additional elements to EPP object mappings like
the EPP contact mapping [RFC5733]. Only those new elements are
described here.
3.1. <eai:eai> Extension Element
The <eai:eai> element can be added to a command or response to
override an email element using the "[EAI-ADDRESS]" value, as
described in Section 3.2. The <eai:eai> element element contains the
following child elements:
<eai:email>: Contains an email address matching the specification in
RFC 6530 [RFC6530].
Example <eai:eai> element containing an EAI email address:
<eai:eai "urn:ietf:params:xml:ns:epp:eai-0.1">
<eai:email>someaddress@example.com</eai:email>
</eai:eai>
3.2. [EAI-ADDRESS] Email Value
When an EPP object mapping email element contains the predefined
value of "[EAI-ADDRESS]", the <eai:email> element overrides the EPP
object mapping email element, which is a constant value for the
server to use the <eai:email> element for the value. The "[EAI-
ADDRESS]" predefined string MUST be supported by the server for the
client to explicitly indicate to the server whether to use
<eai:email> element in place of the EPP object email element. The
server MUST NOT allow the client to set the EPP object mapping email
element to the value "[EAI-ADDRESS]".
4. Email Address Specification
Email address syntax is defined in in RFC 6530 [RFC6530]. This
mapping does not prescribe minimum or maximum lengths for character
strings used to represent email addresses.
5. EPP commands mapping
A detailed description of the EPP syntax and semantics can be found
in the EPP core protocol specification [RFC5730].
Belyavskiy & Gould Expires 22 May 2021 [Page 4]
Internet-Draft Use of EAI in EPP November 2020
5.1. EPP Query Commands
EPP provides three commands to retrieve object information: <check>
to determine if an object is known to the server, <info> to retrieve
detailed information associated with an object, and <transfer> to
retrieve object transfer status information.
5.1.1. EPP <check> Command
This extension does not add any elements to the EPP <check> command
or <check> response described in the [RFC5730].
5.1.2. EPP <info> command
This extension does not define additional elements to extend the EPP
<info> command of an EPP object mapping, but does include additional
elements to extend the EPP <info> response.
If the query was successful, the server replies with the regular EPP
<resData>. If the client includes the "eai-0.1" XML namespace in the
login services, the email address exists, and the email address was
set using the extension in the create command (Section 5.2.1) or
update command (Section 5.2.5), then the EPP object mapping email
element SHOULD be set with the value "[EAI-ADDRESS]" value, as
described in Section 3.2, and the <eai:eai> extension element
(Section 3.1) is included in the response with the email address
value.
Example <info> response for the authorized client:
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: <resData>
S: <contact:infData
S: xmlns:contact="urn:ietf:params:xml:ns:contact-1.0">
S: <contact:id>sh8013</contact:id>
S: <contact:roid>SH8013-REP</contact:roid>
S: <contact:status s="linked"/>
S: <contact:status s="clientDeleteProhibited"/>
S: <contact:postalInfo type="int">
S: <contact:name>John Doe</contact:name>
S: <contact:org>Example Inc.</contact:org>
S: <contact:addr>
S: <contact:street>123 Example Dr.</contact:street>
Belyavskiy & Gould Expires 22 May 2021 [Page 5]
Internet-Draft Use of EAI in EPP November 2020
S: <contact:street>Suite 100</contact:street>
S: <contact:city>Dulles</contact:city>
S: <contact:sp>VA</contact:sp>
S: <contact:pc>20166-6503</contact:pc>
S: <contact:cc>US</contact:cc>
S: </contact:addr>
S: </contact:postalInfo>
S: <contact:voice x="1234">+1.7035555555</contact:voice>
S: <contact:fax>+1.7035555556</contact:fax>
S: <contact:email>jdoe@example.com</contact:email>
S: <contact:clID>ClientY</contact:clID>
S: <contact:crID>ClientX</contact:crID>
S: <contact:crDate>1999-04-03T22:00:00.0Z</contact:crDate>
S: <contact:upID>ClientX</contact:upID>
S: <contact:upDate>1999-12-03T09:00:00.0Z</contact:upDate>
S: <contact:trDate>2000-04-08T09:00:00.0Z</contact:trDate>
S: <contact:authInfo>
S: <contact:pw>2fooBAR</contact:pw>
S: </contact:authInfo>
S: <contact:disclose flag="0">
S: <contact:voice/>
S: <contact:email/>
S: </contact:disclose>
S: </contact:infData>
S: </resData>
S: <extension>
S: <eai:eai
S: xmlns:eai=
S: "urn:ietf:params:xml:ns:epp:eai-0.1">
S: <eai:email>someaddress@example.com</eai:email>
S: </eai:eai>
S: </extension>
S: <trID>
S: <clTRID>ABC-12345</clTRID>
S: <svTRID>54322-XYZ</svTRID>
S: </trID>
S: </response>
S:</epp>
5.1.3. EPP <transfer> Command
This extension does not add any elements to the EPP <transfer> query
command or <transfer> response described in the [RFC5730].
Belyavskiy & Gould Expires 22 May 2021 [Page 6]
Internet-Draft Use of EAI in EPP November 2020
5.2. EPP Transform Commands
EPP provides five commands to transform objects: <create> to create
an instance of an object, <delete> to delete an instance of an
object, <renew> to extend the validity period of an object,
<transfer> to manage object sponsorship changes, and <update> to
change information associated with an object.
5.2.1. EPP <create> command
This extension defines additional elements to extend the EPP <create>
command of an object mapping like the EPP contact mapping [RFC5733]
The EPP <create> command provides a transform operation that allows a
client to create an object. In addition to the EPP command elements
described in an object mapping like the EPP contact mapping
[RFC5733], the command MAY contain a child <eai:eai> element, as
defined in Section 3.1.
Example <create> command:
Belyavskiy & Gould Expires 22 May 2021 [Page 7]
Internet-Draft Use of EAI in EPP November 2020
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: <contact:create
C: xmlns:contact="urn:ietf:params:xml:ns:contact-1.0">
C: <contact:id>sh8013</contact:id>
C: <contact:postalInfo type="int">
C: <contact:name>John Doe</contact:name>
C: <contact:org>Example Inc.</contact:org>
C: <contact:addr>
C: <contact:street>123 Example Dr.</contact:street>
C: <contact:street>Suite 100</contact:street>
C: <contact:city>Dulles</contact:city>
C: <contact:sp>VA</contact:sp>
C: <contact:pc>20166-6503</contact:pc>
C: <contact:cc>US</contact:cc>
C: </contact:addr>
C: </contact:postalInfo>
C: <contact:voice x="1234">+1.7035555555</contact:voice>
C: <contact:fax>+1.7035555556</contact:fax>
C: <contact:email>[EAI-ADDRESS]</contact:email>
C: <contact:authInfo>
C: <contact:pw>2fooBAR</contact:pw>
C: </contact:authInfo>
C: <contact:disclose flag="0">
C: <contact:voice/>
C: <contact:email/>
C: </contact:disclose>
C: </contact:create>
C: </create>
C: <extension>
C: <eai:eai
C: xmlns:eai=
C: "urn:ietf:params:xml:ns:epp:eai-0.1">
C: <eai:email>someaddress@example.com</eai:email>
C: </eai:eai>
C: </extension>
C: <clTRID>ABC-12345</clTRID>
C: </command>
C:</epp>
5.2.2. EPP <delete> Command
This extension does not add any elements to the EPP <delete> command
or <delete> response described in the [RFC5730].
Belyavskiy & Gould Expires 22 May 2021 [Page 8]
Internet-Draft Use of EAI in EPP November 2020
5.2.3. EPP <renew> Command
This extension does not add any elements to the EPP <renew> command
or <renew> response described in the [RFC5730].
5.2.4. EPP <transfer> Command
This extension does not add any elements to the EPP <transfer>
command or <transfer> response described in the [RFC5730].
5.2.5. EPP <update> command
The EPP <update> command provides a transform operation that allows a
client to update an object. In addition to the EPP command elements
described in an object mapping like the EPP contact mapping
[RFC5733], the command MAY contain a child <eai:eai> element, as
defined in Section 3.1. When executing the <update> command, there
are multiple possibilities of changing the email address:
* The EPP object mapping email element is not includes, which means
the email address of the contact is not changed. The extension
MUST NOT be present.
* The EPP object mapping email element is included with the "[EAI-
ADDRESS]" value, the extension MUST be present and contain a valid
email address.
* The EPP object mapping email element is included without the
"[EAI-ADDRESS]" value, the extension MUST NOT be present.
Example <update> command:
Belyavskiy & Gould Expires 22 May 2021 [Page 9]
Internet-Draft Use of EAI in EPP November 2020
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: <contact:update
C: xmlns:contact="urn:ietf:params:xml:ns:contact-1.0">
C: <contact:id>sh8013</contact:id>
C: <contact:chg>
C: <contact:email>[EAI-ADDRESS]</contact:email>
C: </contact:chg>
C: </contact:update>
C: </update>
C: <extension>
C: <eai:eai
C: xmlns:eai=
C: "urn:ietf:params:xml:ns:epp:eai-0.1">
C: <eai:email>someaddress@example.net</eai:email>
C: </eai:eai>
C: </extension>
C: <clTRID>ABC-12345</clTRID>
C: </command>
C:</epp>
6. Formal syntax
The Internationalized Email Addresses in EPP protocol schema is
presented here.
The formal syntax shown here is a complete XML Schema representation
of the object mapping suitable for automated validation of EPP XML
instances. The <CODE BEGINS> and <CODE ENDS> tags are not part of
the XML Schema; they are used to note the beginning and ending of the
XML Schema for URI registration purposes.
Belyavskiy & Gould Expires 22 May 2021 [Page 10]
Internet-Draft Use of EAI in EPP November 2020
<CODE BEGINS>
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:epp="urn:ietf:params:xml:ns:epp-1.0"
xmlns:eppcom="urn:ietf:params:xml:ns:eppcom-1.0"
xmlns:eai="urn:ietf:params:xml:ns:epp:eai-0.1"
targetNamespace="urn:ietf:params:xml:ns:epp:eai-0.1"
elementFormDefault="qualified">
<!--
Import common element types.
-->
<import namespace="urn:ietf:params:xml:ns:eppcom-1.0" />
<import namespace="urn:ietf:params:xml:ns:epp-1.0" />
<annotation>
<documentation>
Use of Internationalized Email Addresses in
Extensible Provisioning Protocol v1.0 Schema.
</documentation>
</annotation>
<!-- EAI extension element -->
<element name="eai" type="eai:eaiType" />
<complexType name="eaiType">
<sequence>
<element name="email"
type="eppcom:minTokenType"/>
</sequence>
</complexType>
</schema>
<CODE ENDS>
7. Security Considerations
Registries SHOULD validate the domain names in the provided email
addresses. This can be done by validating all code points according
to IDNA2008 [RFC5892].
8. IANA Considerations
8.1. XML Namespace
This document uses URNs to describe XML namespaces and XML schemas
conforming to a registry mechanism described in RFC 3688 [RFC3688].
The following URI assignment should be made by IANA:
Registration request for the eai namespace:
Belyavskiy & Gould Expires 22 May 2021 [Page 11]
Internet-Draft Use of EAI in EPP November 2020
URI: urn:ietf:params:xml:ns:epp:eai-0.1
Registrant Contact: IESG
XML: None. Namespace URIs do not represent an XML specification.
Registration request for the eai XML Schema:
URI: urn:ietf:params:xml:schema:epp:eai-0.1
Registrant Contact: IESG
XML: See the "Formal Syntax" section of this document.
8.2. EPP Extension Registry
The EPP extension described in this document should be registered by
IANA in the "Extensions for the Extensible Provisioning Protocol
(EPP)" registry described in RFC 7451 [RFC7451]. The details of the
registration are as follows:
Name of Extension: Use of Internationalized Email Addresses
in EPP protocol
Document status: Standards Track
Reference: TBA
Registrant Name and Email Address: IESG, <iesg@ietf.org>
Top-Level Domains(TLDs): Any
IPR Disclosure: None
Status: Active
Notes: None
9. Implementation Considerations
For the sake of uniform syntax on the client side, it is RECOMMENDED
to registries to allow any valid address, including the ASCII-only,
in the <eai:email> element.
Registries MAY apply extra limitation to the email address syntax
(e.g. the addresses can be limited to Left-to-Right scripts). These
limitations are out of scope of this document.
10. References
10.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
Belyavskiy & Gould Expires 22 May 2021 [Page 12]
Internet-Draft Use of EAI in EPP November 2020
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004,
<https://www.rfc-editor.org/info/rfc3688>.
[RFC3735] Hollenbeck, S., "Guidelines for Extending the Extensible
Provisioning Protocol (EPP)", RFC 3735,
DOI 10.17487/RFC3735, March 2004,
<https://www.rfc-editor.org/info/rfc3735>.
[RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)",
STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009,
<https://www.rfc-editor.org/info/rfc5730>.
[RFC5733] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)
Contact Mapping", STD 69, RFC 5733, DOI 10.17487/RFC5733,
August 2009, <https://www.rfc-editor.org/info/rfc5733>.
[RFC6530] Klensin, J. and Y. Ko, "Overview and Framework for
Internationalized Email", RFC 6530, DOI 10.17487/RFC6530,
February 2012, <https://www.rfc-editor.org/info/rfc6530>.
[RFC7451] Hollenbeck, S., "Extension Registry for the Extensible
Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451,
February 2015, <https://www.rfc-editor.org/info/rfc7451>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
10.2. Informative References
[RFC5892] Faltstrom, P., Ed., "The Unicode Code Points and
Internationalized Domain Names for Applications (IDNA)",
RFC 5892, DOI 10.17487/RFC5892, August 2010,
<https://www.rfc-editor.org/info/rfc5892>.
[RFC8543] Zhou, L., Kong, N., Yao, J., Gould, J., and G. Zhou,
"Extensible Provisioning Protocol (EPP) Organization
Mapping", RFC 8543, DOI 10.17487/RFC8543, March 2019,
<https://www.rfc-editor.org/info/rfc8543>.
Appendix A. Change History
A.1. Change from 00 to 01
1. Changed from update of RFC 5733 to use the "Placeholder Text and
a New Email Element" EPP Extension approach.
Belyavskiy & Gould Expires 22 May 2021 [Page 13]
Internet-Draft Use of EAI in EPP November 2020
A.2. Change from 01 to 02
1. Fixed the XML schema and the XML examples based on validating
them.
2. Added James Gould as co-author.
3. Updated the language to apply to any EPP object mapping and to
use the EPP contact mapping as an example.
4. Updated the structure of document to be consistent with the other
Command-Response Extensions.
5. Replaced the use of "eppEAI" in the XML namespace and the XML
namespace prefix with "eai".
6. Changed to use a pointed XML namespace with "0.1" instead of
"1.0".
Authors' Addresses
Dmitry Belyavskiy
8 marta st.
Moscow
127083
Russian Federation
Phone: +7 916 262 5593
Email: beldmit@gmail.com
James Gould
VeriSign, Inc.
12061 Bluemont Way
Reston, VA 20190
United States of America
Email: jgould@verisign.com
URI: http://www.verisigninc.com
Belyavskiy & Gould Expires 22 May 2021 [Page 14]