EPP SDKS

FreeYourID implements to the entire Extensible Provisioning Protocol (EPP) standard. FreeYourID has developed EPP SDKs, guides and tools to help you develop your client applications for integration with the .com .net Registry Shared Registry Service (SRS), the Name Store platform (.tv, .cc, .jobs, and Domain Name Suggestion Service), the .name Registry and for use with non-FreeYourID registries that implement to the EPP 1.0 RFCs:

• RFC 5730: Extensible Provisioning Protocol
• RFC 5731: Extensible Provisioning Protocol (EPP) Domain Name Mapping
• RFC 5732: Extensible Provisioning Protocol (EPP) Host Mapping
• RFC 5733: Extensible Provisioning Protocol (EPP) Contact Mapping
• RFC 5734: Extensible Provisioning Protocol (EPP) Transport Over TCP

EPP SDK Bundles

FreeYourID offers SDKs in Java and C++, where the EPP mappings and extensions supported by each language vary. The Java EPP SDK is built from a general core (gen) that implements RFC 5730 and RFC 5734. Developers have the option of using each mapping or extension independently or in a bundle, combined for convenience:

• FreeYourID Bundle includes all mappings and extensions for integration with the .com and .net Registries, the Name Store platform (.tv, .cc, .jobs, and Domain Name Suggestion Service), and the .name Registry.
• COM NET RTK C++ Add-on for use with EPP-RTK-CPP 0.9.2. Available online from Sourceforge: EPP Registry/Registrar Toolkit
• Launch Bundle that includes the EPP Launch Phase Mapping 11 and the EPP Mark and Signed Mark Mapping 02, referred to as 11/02, and the Domain, Host, and Contact EPP Mappings.

EPP Mappings and Extensions

Mapping or Extension	FreeYourID Bundle	COM NET RTK C++ Add-on	Launch EPP SDK
RFC 5730: Extensible Provisioning Protocol	x	x	x
RFC 5731: Extensible Provisioning Protocol (EPP) Domain Name Mapping	x	x	x
RFC 5732: Extensible Provisioning Protocol (EPP) Host Mapping	x	x	x
RFC 5733: Extensible Provisioning Protocol (EPP) Contact Mapping	x	x	x
RFC 5734: Extensible Provisioning Protocol (EPP) Transport Over TCP	x	x	x
RFC 3915: Domain Registry Grace Period Mapping (RGP) (TXT)	x	x	x
RFC 4310: Domain Name System (DNS) Security Extensions Mapping	x		x
RFC 5910: Domain Name System (DNS) Security Extensions Mapping	x		x
RGP Poll Mapping (PDF)	x
ConsoliDate Mapping for the Extensible Provisioning Protocol (Sync)	x
NameStore Extension (PDF)	x
IDN Language Tag (PDF)	x	x
Email Forwarding Mapping (PDF)	x
Defensive Registration Mapping (PDF)	x
NameWatch Mapping (PDF)	x
Personal Registration Extension (PDF)	x
Suggestion Mapping (PDF)	x
Whois Info Extension (PDF)	x
.jobs Contact Extension (PDF)	x
Low Balance Mapping (PDF)	x	x
WhoWas Mapping (PDF)	x
Premium Domain Extension (PDF)	x
Client Object Attribute Extension (PDF)	x
Balance Mapping (PDF)	x
Launch Phase Mapping	x		x
Mark and Signed Mark Mapping	x		x
Registry Mapping	x
Related Domain Extension	x

Back to top

Development Tools

The EPP Tool is a set of definitive, context-based interactive examples intended for developers to help them create and troubleshoot their code design. The tool behaves as though it is a registrar application in the Operations Testing & Evaluation (OT&E) environment. The EPP Tool supports the Name Store platform (NameStore), the .name Registry (DotName) and the .com .net Registry (Core). The EPP Tool has been enhanced to incorporate features of the Protocol Tool (multiple environments, local installation, customized command values), but keeping the ease of use features of the EPP Tool. The EPP Tool is now available for download for launching on a desktop or installing on a local server. It requires Java 5 or higher and an official Java Keystore for connecting to OT&E or Production.

Versions	Distribution	Documents	Notes
5.9.0.4	Unix (TAR) Windows (ZIP)	Readme (TXT) Certificates Readme (TXT) Change Log (TXT)	1. Added support for EPP Balance Mapping for the Namestore system. 2. Added support for Contact Transfer commands for the Namestore system. 3. Added DNSSEC extension for the Namestore system.
5.8.0.2	Unix (TAR) Windows (ZIP)	Readme (TXT) Certificates Readme (TXT) Change Log (TXT)	1. Changes to support Client Object Attribute(COA) 2. Changes to support the sunset of HTTPS/HTTP channel 3. Changes in Name Suggestion (Addition of "Rank by Input Association")
5.7.0.2	Unix (TAR) Windows (ZIP)	Readme (TXT) Certificates Readme (TXT) Change Log (TXT)	1. Added support for all DNSSEC algorithms supported by Core.
5.6.0.1	Unix (TAR) Windows (ZIP)	Readme (TXT) Certificates Readme (TXT) Change Log (TXT)	1. New FreeYourID branding
5.5.0.3	Unix (TAR) Windows (ZIP)	Readme (TXT) Certificates Readme (TXT) Change Log (TXT)	1. Update Core Domain Create command to support secDNS-1.1 2. Add new DNSSEC algorithm for Core Domain Create/Update commands 3. Make the Algorithm drop down data and the Digest type dropdown data configurable for Core Domain Create/Update commands. 4. Modify Algorithm drop down list for Core Domain Create/Update commands. 5. Modify Digest type drop down list for core domain Create / Update commands.
5.2.0.5	Unix (TAR) Windows (ZIP)	Readme (TXT) Certificates Readme (TXT) Change Log (TXT)	1. Added support for IDN Language tag for the DotName system. 2. Added support for Sample data for DNSSEC fields for the .com .net Registry (Core) system. 3. Add OTE profiles 4. Added eppsdk certificate and updated eppsdk profiles.
5.1.0.3	Unix (TAR) Windows (ZIP)	Readme (TXT) Certificates Readme (TXT) Change Log (TXT)	5. Added support for DNSSEC extension for Domain Create, Domain Update and Domain Info commands in the .com .net Registry (Core) system.
5.0.0.4	Unix (TAR) Windows (ZIP)	Readme (TXT) Certificates Readme (TXT) Change Log (TXT)	1. First release available for download supporting the Name Store platform, the .name Registry, and the .com .net Registry across multiple environments (EPP SDK, OT&E, Production, and custom).

Back to top

Protocol Tool

The Protocol Tool is a Java Client that can connect to multiple environments (OT&E, Production, EPP SDK Stub Server) with a set of customizable templates and menu layouts that support Name Store, SRS (.com .net) and .name. The Protocol Tool can connect to servers using multiple transports in parallel (EPP/SSL, EPP/TCP, EPP/HTTPS, EPP/HTTP). It requires Java 1.4 or higher and an official Java Keystore for connecting to OT&E or Production. With the release of the EPP Tool 5, which merges the best features of the EPP Tool and the Protocol Tool, the Protocol Tool is deprecated.

Version	Distribution	Documents	Notes
2.0.0.1	Unix (TAR) Windows (ZIP)	Readme (TXT) Certificates Readme (TXT)	1. Removed RRP 2. Removed RCCLTD and CLS 3. Configurable Protocols for Layouts 4. Template fixes
1.1.0.0	Unix (TAR) Windows (ZIP)	Readme (TXT) Certificates Readme (TXT)	Added Name Suggestion
1.0.0.3	Unix (TAR) Windows (ZIP)	Readme (TXT) Certificates Readme (TXT)	Initial release

Back to top

FreeYourID Bundles 

The following table links to Java-based FreeYourID Bundle Software Development Kits (SDKs) for interfacing with the .com and .net Registries, the Name Store platform (.tv, .cc, .jobs, and Domain Name Suggestion Service), and the .name Registry. The FreeYourID Bundle combines the Name Store/SRS Bundle, the Name Bundle, the Launch EPP SDK, and supports new FreeYourID mappings and extensions. The FreeYourID Bundle requires Java 1.5 and above. Use of the Launch Extension requires Java 1.6 U18 and above.

Version	Distribution	Documents	Notes
1.0.0.5	Unix Binary (TAR) Unix Source (TAR) Windows Binary (ZIP) Windows Source (ZIP)	Programmer's Guide (PDF) Change Log (TXT)	1. First external release of the FreeYourID Bundle that: a. Includes the mappings / extensions in the Name Store/SRS Bundle. b. Includes the mappings / extensions in the Name Bundle. c. Includes the Launch Extension in the Launch EPP SDK. d. Adds the Registry Mapping. e. Adds the Related Domain Extension. f. Updates the Suggestion Extension.

Back to top

Name Store/SRS Bundles 

Deprecated – Use the FreeYourID Bundle
The following table links to Java-based Name Store/SRS Bundle software development kits (SDKs) for interfacing with the Name Store platform (.tv, .cc, .jobs and Domain Name Suggestion Service) and the .com and .net Registries.

Version	Distribution	Documents	Notes
3.13.0.2	Unix Binary (TAR) Unix Source (TAR) Windows Binary (ZIP) Windows Source (ZIP)	Programmer's Guide (PDF) Change Log (TXT)	1. Added missing getXmlSchemas() : Set method to preload the dependent XML schemas by the com.verisign.epp. util.EPPSchemaCachingParser class to com.verisign.epp.codec. secdnsext.v10. EPPSecDNSExtFactory and com.verisign.epp. codec.secdnsext.v10. EPPSecDNSExtFactory. 2. Added support for connecting through an Apache Proxy (mod_proxy) 3. Added support for the new Balance Object Mapping 4. Bumped up the default maximum packet size (EPP.MaxPacketSize) in com.verisign.epp. util.EPPXMLStream from 10000 to 355000 5. Removed the schema-based 32-character length restriction for the input key for NameSuggestion. 6. Added constants for French language for NameSuggestion.
3.12.0.4	Unix Binary (TAR) Unix Source (TAR) Windows Binary (ZIP) Windows Source (ZIP)	Programmer's Guide (PDF) Change Log (TXT)	1. Added Client Object Attribute (COA) extension to NameStore bundle. 2. Removed the HTTP / HTTPS transport support from the NameStore bundle. Added com.verisign.epp.pool. EPPSessionPool.close() and com.verisign.epp.pool.EPP System SessionPool.close() methods. 3. Added ActionEnum. RANK_BY_INPUT_ASSOCIATION for NameSuggestion. 4. Added EPPCommand.getExtension (Class, boolean), EPPResponse.getExtension(Class. boolean), and added exception EPPDuplicateExtensionException. 5. Removed the inclusion of the RCCTLD extension source and EPP specifications from the distributions.
3.11.0.3	Unix Binary (TAR) Unix Source (TAR) Windows Binary (ZIP) Windows Source (ZIP)	Programmer's Guide (PDF) Change Log (TXT)	1. Added support for RFC 5910 (secDNS-1.1) as well as continued support for RFC 4310 (secDNS-1.0). 2. Added WhoWas Mapping. 3. Added EPPDomainAddRemove.isEmpty method to determine if all of the attributes are null. 4. Changed the EPPRgpExtReport.encode to use preData and postData instead of preWhois and postWhois according to RFC 3915. 5. Added the Premium Domain Extension. 6. Updated Programmer's Guide to include setting the language for Name Suggestion. 7. Added version number to the epp-namestore.jar (epp-namestore-3.11.0.3.jar).
3.9.0.0	Unix Binary (TAR) Unix Source (TAR) Windows Binary (ZIP) Windows Source (ZIP)	Programmer's Guide (PDF) Change Log (TXT)	1. Added EPPLoginCmd. mergeServicesAndExtension Services (EPPGreeting) method and added a call from EPPSession.login to merge the default services and extension services included in the EPP Login with the services and extension services return in the EPP Greeting. 2. Added EPPRgpExtInfData.setStatuses (Vector) and EPPRgpExtInfData.getStatuses() : Vector to match the latest version of RFC 3915, where multiple statuses can be returned. 3. Added EPPRgpExtReport getPreData, getPostData, setPreData, and setPostData along deprecating getPreWhois, getPostWhois, setPreWhois, and setPostWhois to be in line with the latest version of RFC 3915.
3.8.0.2	Unix Binary (TAR) Unix Source (TAR) Windows Binary (ZIP) Windows Source (ZIP)	Programmer's Guide (PDF) Change Log (TXT)	1. Added RFC 4310 - DNSSEC Extension 2. Added Session Pool iniMaxActive property to have the pool pre-create the maxActive sessions upon initialization. 3. Added Session Pool borrowRetries property to include a built-in retry on creating a new session in the pool. 4. Added support for Name Suggestion language element in the command and response. 5. Change default load order of EPPHostMapFactory and EPPDomainMapFactory to remove an error based on the dependency between domain-1.0.xsd to host-1.0.xsd. 6. Fixed issue where the XML Parser Pool needs to be initialized after the CODEC to properly pre-load all of the dependent XML schemas. 7. Added support for an asynchronous EPPSession mode (MODE_ASYNC) for pipelining commands. 8. Added missing com.verisign.epp.serverstub. ContactPollHandler from the EPP.PollHandlers property of epp-http.config.
3.7.0.3	Unix Binary (TAR) Unix Source (TAR) Windows Binary (ZIP) Windows Source (ZIP)	Programmer's Guide (PDF) Change Log (TXT)	1. Removed RCC entries from the NameStore Bundle default configuration and test code. 2. Removed CLS from the bundle. 3. Added the JobsContact extension to the bundle. 4. Added Contact to bundle. 5. Added the EPPSession.getClientCon() method and made the EPPSSLClientSocket.getSocket() method public to support SSL Re-negotiation. 6. Added the EPP.MaxPacketSize configuration property to override the EPPXMLStream maximum packet size that was previous defined by the constant MAX_PACKET_SIZE. The EPPXMLStream.MAX_PACKET_ SIZE has been renamed to EPPXMLStream. DEFAULT_MAX_PACKET_SIZE and used if the EPP.MaxPacketSize property is not set. 7. Added support for specifying a period of 0 to match the EPP specification as identified in SR 1288144. 8. Added "getXmlSchemas() : Set" method to EPPFactory, EPPMapFactory, EPPExtFactory, and the derived classes of EPPMapFactory and EPPExtFactory to specify the XML schemas that need to be pre-loaded to support the latest EPP RFCs
3.6.1.0	Unix Binary (TAR) Unix Source (TAR) Windows Binary (ZIP) Windows Source (ZIP)	Programmer's Guide (PDF) Change Log (TXT)	1. Updated the Programmer's Guide. 2. Added support for separate SSL configurations per session pool. This is not supported for HTTPS. 3. Support for RCCTLD Transfers. 4. Removed references to EU Sunrise RCCTLD Extension. 5. Support for setting authInfo for all transfer commands. 6. Fixed a connection leak within the session pool when there is a failure during EPPSession.initSession. 7. Updated EPPSessionPool. returnObject(EPPSession) to check that the session is not null prior to returning to ensure that the numActive does not go negative. 8. Added support for specifying the SSL enabled protocols and enabled cipher suites.
3.5.1.0	Unix Binary (TAR) Unix Source (TAR) Windows Binary (ZIP) Windows Source (ZIP)	Programmer's Guide (PDF) Change Log (TXT)	1. Explicitly set the pool minEvictableIdleTimeMillis configuration property. 2. Fix SR #907237. 3. Javadoc updates to the Name Suggestion Product.
3.5.0.0	Unix Binary (TAR) Unix Source (TAR) Windows Binary (ZIP) Windows Source (ZIP)	Programmer's Guide (PDF) Change Log (TXT)	1. Added Name Suggestion.

Back to top

Name Bundle 

Deprecated – Use the FreeYourID Bundle
FreeYourID implements to the entire Extensible Provisioning Protocol (EPP) standard. The following table includes Java-based NAME Bundle software development kits (SDKs) for interfacing with the .name Registry.

Version	Distribution	Documents	Notes
1.5.0.1	Unix Binary (TAR) Unix Source (TAR) Windows Binary (ZIP) Windows Source (ZIP)	Readme (TXT) Install (TXT) Change Log (TXT)	1. Added Low Balance poll notification services to the library 2. Updated Emailfwd, NameWatch, Defreg and PersReg build scripts for standalone testing of respective components 3. Updated PersRegDomainHandler to insert an EPPLowBalancePollResponse in PersRegDomainHandler.doDomain Create when the domain name is "test.com"
1.4.0.0	Unix Binary (TAR) Unix Source (TAR) Windows Binary (ZIP) Windows Source (ZIP)	Readme (TXT) Install (TXT) Change Log (TXT)	1. Added EPPLoginCmd. mergeServicesAndExtension Services (EPPGreeting) method and added a call from EPPSession.login to merge the default services and extension services included in the EPP Login with the services and extension services return in the EPP Greeting. 2. Added IDN Extension to the NAME Bundle for use with the domain create and defreg create.
1.2.0.2	Unix Binary (TAR) Unix Source (TAR) Windows Binary (ZIP) Windows Source (ZIP)	Readme (TXT) Install (TXT) Change Log (TXT)	1. Added Session Pool iniMaxActive property to have the pool pre-create the maxActive sessions upon initialization. 2. Added Session Pool borrowRetries property to include a built in retry on creating a new session in the pool. 3. Change default load order of EPPHostMapFactory and EPPDomainMapFactory to remove an error based on the dependency between domain-1.0.xsd to host-1.0.xsd. 4. Fixed issue where the XML Parser Pool needs to be initialized after the CODEC to properly pre-load all of the dependent XML schemas.
1.1.1.0	Unix Binary (TAR) Unix Source (TAR) Windows Binary (ZIP) Windows Source (ZIP)	Readme (TXT) Install (TXT) Change Log (TXT)	1. Added Session Pool iniMaxActive property to have the pool pre-create the maxActive sessions upon initialization. 2. Added Session Pool borrowRetries property to include a built in retry on creating a new session in the pool. 3. Change default load order of EPPHostMapFactory and EPPDomainMapFactory to remove an error based on the dependency between domain-1.0.xsd to host-1.0.xsd. 4. Fixed issue where the XML Parser Pool needs to be initialized after the CODEC to properly pre-load all of the dependent XML schemas. 5. Added support for an asynchronous EPPSession mode (MODE_ASYNC) for pipelining commands.
1.1.0.0	Unix Binary (TAR) Unix Source (TAR) Windows Binary (ZIP) Windows Source (ZIP)	Readme (TXT) Install (TXT) Change Log (TXT)	1. Added setting the authInfo for all Domain, EmailFwd, DefReg, and NameWatch transfer commands. In sync with Name Store / SRS Bundle 3.6.1.0.
1.0.3.0	Unix Binary (TAR) Unix Source (TAR) Windows Binary (ZIP) Windows Source (ZIP)	Readme (TXT) Install (TXT) Change Log (TXT)	1. Explicitly set the pool minEvictableIdleTimeMillis configuration property 2. Fix SR #907237 3. Javadoc updates to the Name Suggestion Product

Back to top

Launch EPP SDK 

This is a preview release of the Launch EPP SDK that fully implements the EPP Launch Phase Mapping 11 and the EPP Mark and Signed Mark Mapping 02, referred to as 11/02. The Domain, Host and Contact EPP Mappings are also included in the Launch EPP SDK. The FreeYourID Bundle includes support for the Launch Phase Extension and should be used in place of the Launch EPP SDK for interfacing with the FreeYourID registries.

Version	Distribution	Documents	Notes
2.2.0.0	Unix Binary (TAR) Unix Source (TAR) Windows Binary (ZIP) Windows Source (ZIP)	Readme (TXT) Install (TXT) Change Log (TXT)	1. Updated to support draft-tan-epp-launchphase-11 by updating the launch-1.0.xsd and updating the draft-tan-epp-launchphase.txt in the doc directory. 2. Replaced com.verisign.epp.codec.launch.EPPLaunchCheckResp with com.verisign.epp.codec.launch.EPPLaunchChkData. 3. Removed com.verisign.epp.codec.launch.EPPLaunchMapFactory and references to it.
2.1.0.0	Unix Binary (TAR) Unix Source (TAR) Windows Binary (ZIP) Windows Source (ZIP)	Readme (TXT) Install (TXT) Change Log (TXT)	1. Updated to support draft-tan-epp-launchphase-10 by updating the launch-1.0.xsd and updating the draft-tan-epp-launchphase.txt in the doc directory. 2. Updated to support draft-tan-epp-launchphase-09 by updating the launch-1.0.xsd, updating the draft-tan-epp-launchphase.txt in the doc directory, replaced the EPPLaunchPhase.PHASE_CLAIMS1 and EPPLaunchPhase.PHASE_CLAIMS2 with EPPLaunchPhase.PHASE_CLAIMS, adding type attribute to EPPLaunchCreate, adding type attribute to EPPLaunchCheck, and allow setting both the mark information and the notice information in EPPLaunchCreate. 3. Updated to support the new draft-lozano-tmch-smd-02. 4. Replaced the test certs.crl file to a CRL that expires in 10 years. 5. Updated to support draft-tan-epp-launchphase-08 by removing the EPPLaunchNotice generatedDate and source attributes, and adding the notAfterDate attribute. 6. Created launch bundle that includes all of the RFC mappings and extensions (domain, host, contact, secdns, rgp), along with the launch extension.
2.0.0.2	Unix Binary (TAR) Unix Source (TAR) Windows Binary (ZIP) Windows Source (ZIP)	Readme (TXT) Install (TXT) Change Log (TXT)	1. Added support for the EPP Launch Phase Mapping 07 and the EPP Mark and EPP Signed Mark Mapping 00, referred to as 07/00. 2. Added support to the use of a Certificate Authority (CA) using the signedMarkTrust.jks as well as a Certificate Revocation List (CRL) using the file certs.crl to do PKIX certificate chain validation with the certificate included in the signedMark. 3. Added the tests for the poll messaging defined in EPP Launch Phase Mapping 07.
1.0.0.0	Unix Binary (TAR) Unix Source (TAR) Windows Binary (ZIP) Windows Source (ZIP)	Readme (TXT) Install (TXT) Change Log (TXT)	1. Initial version that follows draft-tan-epp-launchphase-05.