Extensible_Provisioning_Protocol

Extensible Provisioning Protocol

Extensible Provisioning Protocol

Computer network protocol


The Extensible Provisioning Protocol (EPP) is a flexible protocol designed for allocating objects within registries over the Internet. The motivation for the creation of EPP was to create a robust and flexible protocol that could provide communication between domain name registries and domain name registrars. These transactions are required whenever a domain name is registered or renewed, thereby also preventing domain hijacking. Prior to its introduction, registries had no uniform approach, and many different proprietary interfaces existed. While its use for domain names was the initial driver, the protocol is designed to be usable for any kind of ordering and fulfilment system.[1]

Quick Facts Abbreviation, Purpose ...

EPP is based on XML - a structured, text-based format. The underlying network transport is not fixed, although the only currently specified method is over TCP. The protocol has been designed with the flexibility to allow it to use other transports such as BEEP, SMTP, SOAP or HTTPS.[1] However only HTTPS has seen some usage while the vast majority uses TCP.

History

The first protocol drafts were published as IETF individual submission Internet Draft documents by Scott Hollenbeck of Verisign in November 2000.[2] The individual submission documents were adopted by the IETF Provisioning Registry (provreg) working group, which was created after a BoF session was held at IETF-49 in December 2000.[3] Proposed Standard documents (RFCs 3730 - 3734) were published by the RFC Editor in March 2004.[4] Draft Standard documents (RFCs 4930 - 4934) were published in May 2007.[5]

In August 2009 IETF granted EPP the status of full standard as STD 69.[6]

The first EPP extension that became a proposed standard was the redemption grace period extension from RFC 3915 in September 2004.[7] Since then a number of different proposed standard extensions followed.[8]

Adoption

The protocol has been adopted by a number of ccTLD domain name registries, such as: .ac, .ag, .ai, .as, .ar, .at, .au, .be, .br, .bz, .ca, .cat, .cc, .ch, .cl, .cn, .co, .cr, .cx, .cz, .dk, .dm, .ee, .es (over HTTPS), .eu, .fi, .fm, .fr, .gg, .gr (over HTTPS), .gs, .hn, .ht, .il, .im, .in, .io, .it (over HTTPS), .je, .ke, .ki, .ky, .kz, .la, .lc, .li, .lt, .lu, .lv, .md, .me, .mk, .mn, .ms, .mu, .mx, .na, .nf, .ng, .nl, .no, .nu, .nz, .pe, .pk, .pl (over HTTPS), .ps, .pt, .ru, .ro, .sc, .se, .sh, .si, .su, .tl, .tm .tv, .tw, .ua, .uk, .us, .vc, .ve and .za as well as ENUM registries such as those operating the +31, +41, +43, +44 and +48 country codes.[9]

ICANN has made it a condition in their base registry contract to offer an EPP service, therefore every gTLD has adopted the protocol.[10]

There are multiple open source implementations of EPP server software. The Council of Country Code Administrators (CoCCA) maintain an EPP server software that is used by around 59 ccTLDs and 6 gTLDs.[11] Another open source software is FRED (maintained by CZ.NIC) which counts 11 ccTLDs as its users.[12]

Protocol commands

There are 3 classes of commands: Session management, query and object transform. These commands can then be mapped onto objects which specifies their exact functionality more.[1] The most common standardized objects are hosts,[13] contacts[14] and domains.[15] There are also other standardized objects like organizations,[16] however they are rarely used.

When the client connects to a server, the server immediately sends a "greeting" message to the client. This message contains information about the server that the client needs to connect. This contains the name of the server, the servers current date and time in UTC, the supported features and a privacy policy. The supported features include EPP versions, languages, objects and extensions.[1]

The session management commands are:[1]

More information Command, Usage ...

The query commands are:[1]

More information Command, Usage ...

The object transform commands are:[1]

More information Command, Usage ...

Example

An example command to create a domain could look like this:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
  <command>
    <create>
      <domain:create
       xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
        <domain:name>example.com</domain:name>
        <domain:period unit="y">1</domain:period>
        <domain:ns>
          <domain:hostObj>ns1.example.net</domain:hostObj>
          <domain:hostObj>ns2.example.net</domain:hostObj>
        </domain:ns>
        <domain:registrant>REG-1738</domain:registrant>
        <domain:contact type="admin">ADM-9374</domain:contact>
        <domain:contact type="tech">OTH-2567</domain:contact>
        <domain:contact type="billing">OTH-2567</domain:contact>
        <domain:authInfo>
          <domain:pw>y85NS%FJ4zeKuHXo</domain:pw>
        </domain:authInfo>
      </domain:create>
    </create>
    <clTRID>uu28qbb2wo6o5bpk</clTRID>
  </command>
</epp>

Note that the two host objects and 3 different contact objects had to be created beforehand to use them and the client had to be logged in already. The authInfo pw is a secret that is required in the transfer between registrars. The clTRID is a unique transaction id for each command that is generated by the client. A server response to the command above could look like this:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
  <response>
    <result code="1000">
      <msg>Command completed successfully</msg>
    </result>
    <resData>
      <domain:creData
       xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
        <domain:name>example.com</domain:name>
        <domain:crDate>2023-03-12T12:00:00.0Z</domain:crDate>
        <domain:exDate>2024-03-12T12:00:00.0Z</domain:exDate>
      </domain:creData>
    </resData>
    <trID>
      <clTRID>uu28qbb2wo6o5bpk</clTRID>
      <svTRID>ma3fuaeuh7bzpgv9</svTRID>
    </trID>
  </response>
</epp>

The clTRID is the same as the client sent, while the svTRID is a unique transaction id generated by the server. The server returns a result code, message and additional result data like the expiration date of the newly created domain.

Extensions

The protocol offers the ability to send an extension object on almost every possible command to enable registries to add new functionality without changing the base commands.[1]

There are a few standardized extensions that are used by a lot of registries. These include extensions for DNSSEC,[17] IDN,[18] premium domain names,[19] domain restoration (RGP)[7] and extensions to handle the launch of new TLDs[20] among other things.[8]

Some registries also developed extensions that are specific for their TLDs. A common use case for non-standardized extensions is the collection of extra data that is needed to create a domain, for example a VAT identification number.[8]

Result Codes

All responses from the server have to follow a specified format. Each response code is corresponding to a human readable message. Codes in the format 1xxx are successful operations, while codes in the format 2xxx are errors. The errors are again divided into protocol syntax errors in the format 20xx, implementation specific rules as 21xx, security as 22xx, data management as 23xx, server system as 24xx and connection management as 25xx. Most results can include additional data in the resData object, for example which required parameter is specifically missing.[1]

The response code 1001 enables offline processing, an example for this can be that a domain name registry wants to validate a registrant before the domain is registered. In this case the domain is blocked for other clients until the process is complete and the client will be notified via a poll message that can be fetched by the client via the poll command. The codes 1300 and 1301 are for the poll command specifically and signal whether there is a message or not.[1]

The complete list of standardized result codes and result messages is:[1]

More information Code, Message ...

EPP object status codes

There are 2 types of status codes: server and client. The difference is that all server status codes can only be set and removed by the registry, while the client status codes can also be set and removed by the registrar, unless a server status code prohibits it.[15]

The server status codes are commonly used to handle domain abuse cases, mark the domain lifecycle stage or offer extra security against unauthorized tampering, a service often referred to as Registry-Lock.

The client status codes are commonly used to also handle abuse cases, non-payment, invalid contact data or for a Registrar-Lock feature.

The currently standardized server status codes are:[15][7]

More information Server Status, Description ...

The currently standardized client status codes are:[15]

More information Client Status, Description ...

Security considerations

EPP only offers plain text passwords, additionally the EPP login password type is specified to be a string of 6-16 character length[1] which might be considered very low for today's standards. Connections over TCP therefore must use TLS and use of client certificates as well as correct identity confirmation of the client and server is strongly encouraged.[21]

Additionally a lot of domain name registries offer to set up a IP whitelist for connecting to their EPP servers.

EPP offers some protection against replay attacks via the client generated clTRID, however this element is optional and is therefore not used by every server software. Therefore additional anti-replay mechanisms should be implemented by the used transport mechanism.[1]

  • RFC 3375, Generic Registry-Registrar Protocol Requirements
  • RFC 5730, Extensible Provisioning Protocol (EPP) (obsoletes RFC 4930, which obsoleted RFC 3730)
  • RFC 5734, Extensible Provisioning Protocol (EPP) Transport over TCP (obsoletes RFC 4934)

EPP Objects RFCs

  • RFC 5731, Extensible Provisioning Protocol (EPP) Domain Name Mapping (obsoletes RFC 4931)
  • RFC 5732, Extensible Provisioning Protocol (EPP) Host Mapping (obsoletes RFC 4932)
  • RFC 5733, Extensible Provisioning Protocol (EPP) Contact Mapping (obsoletes RFC 4933)
  • RFC 8543, Extensible Provisioning Protocol (EPP) Organization Mapping

EPP Extension RFCs

  • RFC 3735, Guidelines for Extending EPP
  • RFC 3915, Domain Registry Grace Period Mapping (e.g. Add Grace Period, Redemption Grace Period)
  • RFC 4114, E.164 Number Mapping for the Extensible Provisioning Protocol (EPP)
  • RFC 5076, ENUM Validation Information Mapping for the Extensible Provisioning Protocol
  • RFC 5910, Domain Name System (DNS) Security Extensions Mapping for the Extensible Provisioning Protocol (EPP) (obsoletes RFC 4310, DNSSEC)
  • RFC 8334, Launch Phase Mapping for the Extensible Provisioning Protocol (EPP)
  • RFC 8495, Allocation Token Extension for the Extensible Provisioning Protocol (EPP)
  • RFC 8544, Organization Extension for the Extensible Provisioning Protocol (EPP)
  • RFC 8590, Change Poll Extension for the Extensible Provisioning Protocol (EPP)
  • RFC 8748, Registry Fee Extension for the Extensible Provisioning Protocol (EPP)
  • RFC 9038, Extensible Provisioning Protocol (EPP) Unhandled Namespaces

References

  1. Hollenbeck, S. (August 2009). "Extensible Provisioning Protocol (EPP)". doi:10.17487/RFC5730. ISSN 2070-1721. {{cite journal}}: Cite journal requires |journal= (help)
  2. "Extensible Provisioning Protocol". IETF Datatracker. Retrieved 2023-03-13.
  3. "IETF December 2000 Proceedings". www.ietf.org. Retrieved 2023-03-13.
  4. Hollenbeck, S. (March 2004). "Extensible Provisioning Protocol (EPP)". doi:10.17487/RFC3730. ISSN 2070-1721. {{cite journal}}: Cite journal requires |journal= (help)
  5. Hollenbeck, S. (May 2007). "Extensible Provisioning Protocol (EPP)". doi:10.17487/RFC4930. ISSN 2070-1721. {{cite journal}}: Cite journal requires |journal= (help)
  6. Hollenbeck, S. (August 2009). "Extensible Provisioning Protocol (EPP)". {{cite journal}}: Cite journal requires |journal= (help)
  7. "Implementation Report for RFCs 4930-4934 - Wayback Machine". 2012-01-15. Archived from the original on 2012-01-15. Retrieved 2023-03-12.{{cite web}}: CS1 maint: bot: original URL status unknown (link)
  8. "ICANN base registry contract". newgtlds.icann.org. Retrieved 2023-03-12.
  9. "Official CoCCA website". Retrieved 2023-03-12.
  10. "Introducing FRED - fred". fred.nic.cz. Retrieved 2023-03-12.
  11. Hollenbeck, S. (August 2009). "Extensible Provisioning Protocol (EPP) Host Mapping". doi:10.17487/RFC5732. ISSN 2070-1721. {{cite journal}}: Cite journal requires |journal= (help)
  12. Hollenbeck, S. (August 2009). "Extensible Provisioning Protocol (EPP) Contact Mapping". doi:10.17487/RFC5733. ISSN 2070-1721. {{cite journal}}: Cite journal requires |journal= (help)
  13. Hollenbeck, S. (August 2009). "Extensible Provisioning Protocol (EPP) Domain Name Mapping". doi:10.17487/RFC5731. ISSN 2070-1721. {{cite journal}}: Cite journal requires |journal= (help)
  14. Zhou, L.; Kong, N.; Yao, J.; Gould, J.; Zhou, G. (March 2019). "Extensible Provisioning Protocol (EPP) Organization Mapping". doi:10.17487/RFC8543. ISSN 2070-1721. S2CID 65065583. {{cite journal}}: Cite journal requires |journal= (help)
  15. Carney, Roger (March 2020). "RFC 8748: Registry Fee Extension for the Extensible Provisioning Protocol (EPP)". www.rfc-editor.org. Retrieved 2023-03-11.
  16. Gould, J.; Tan, W.; Brown, G. (March 2018). "Launch Phase Mapping for the Extensible Provisioning Protocol (EPP)". doi:10.17487/RFC8334. ISSN 2070-1721. {{cite journal}}: Cite journal requires |journal= (help)
  17. Hollenbeck, S. (August 2009). "Extensible Provisioning Protocol (EPP) Transport over TCP". doi:10.17487/RFC5734. ISSN 2070-1721. {{cite journal}}: Cite journal requires |journal= (help)

Share this article:

This article uses material from the Wikipedia article Extensible_Provisioning_Protocol, and is written by contributors. Text is available under a CC BY-SA 4.0 International License; additional terms may apply. Images, videos and audio are available under their respective licenses.