Skip to content

Commit

Permalink
Merge pull request #16 from DK-Hostmaster/3.2-candidate
Browse files Browse the repository at this point in the history
4.0 candidate
  • Loading branch information
jonasbn authored Oct 9, 2020
2 parents 7c592da + b49133f commit 4c6df6b
Show file tree
Hide file tree
Showing 11 changed files with 216 additions and 91 deletions.
4 changes: 4 additions & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,7 @@ xsd
XYZ
delDate
autoRenew
VeriSign
verisign
authorizations
xmlsoft
63 changes: 47 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
- [XSD file references](#xsd-file-references)
- [XSD files](#xsd-files)
- [XSD History](#xsd-history)
- [3.2](#32)
- [4.0](#40)
- [3.1](#31)
- [3.0](#30)
- [2.6](#26)
Expand All @@ -30,24 +30,26 @@
- [1.2](#12)
- [1.1](#11)
- [1.0](#10)
- [Resources and References](#references_and_resources)

<!-- /MarkdownTOC -->

:exclamation: The current actively used XSD file is indicated in the [EPP service specification](https://github.com/DK-Hostmaster/epp-service-specification), this repository might contain changes not actively used by the service. Please see the [EPP Service Specification Wiki](https://github.com/DK-Hostmaster/epp-service-specification/wiki) for exact details.
:exclamation: The current actively used XSD file is indicated in the [EPP service specification][DKHMEPPSPEC], this repository might contain changes not actively used by the service. Please see the [EPP Service Specification Wiki][DKHMEPPWIKI] for exact details.

<a id="xsd-file-references"></a>
## XSD file references

Please note that the following files have been lifted from their respective RFCs. These files are copyrighted
by their respective authors, please refer to the RFCs for more information.

- `contact-1.0.xsd` [RFC 5733](http://datatracker.ietf.org/doc/rfc5733/)
- `domain-1.0.xsd` [RFC 5731](http://datatracker.ietf.org/doc/rfc5731/)
- `epp-1.0.xsd` [RFC 5730](http://datatracker.ietf.org/doc/rfc5730/)
- `eppcom-1.0.xsd` [RFC 5730](http://datatracker.ietf.org/doc/rfc5730/)
- `host-1.0.xsd` [RFC 5732](http://datatracker.ietf.org/doc/rfc5732/)
- `secDNS-1.0.xsd` [RFC 4310](http://datatracker.ietf.org/doc/rfc4310/)
- `secDNS-1.1.xsd` [RFC 5910](http://datatracker.ietf.org/doc/rfc5910/)
- `contact-1.0.xsd` [RFC:5733][RFC5733]
- `domain-1.0.xsd` [RFC:5731][RFC5731]
- `epp-1.0.xsd` [RFC:5730][RFC5730]
- `eppcom-1.0.xsd` [RFC:5730][RFC5730]
- `host-1.0.xsd` [RFC:5732][RFC5732]
- `secDNS-1.0.xsd` [RFC:4310][RFC4310]
- `secDNS-1.1.xsd` [RFC:5910][RFC5910]
- `verisign-epp-balance` [VeriSign EPP Balance][VeriSignEPPBalance]

The following files are owned and copyright by DK Hostmaster A/S under the MIT License, please see the LICENSE file.

Expand All @@ -70,12 +72,13 @@ The following files are owned and copyright by DK Hostmaster A/S under the MIT L
- `dkhm-2.6.xsd`, DK Hostmaster EPP extensions version 2.6
- `dkhm-3.0.xsd`, DK Hostmaster EPP extensions version 3.0
- `dkhm-3.1.xsd`, DK Hostmaster EPP extensions version 3.1 (_pre-release_)
- `dkhm-3.2.xsd`, DK Hostmaster EPP extensions version 3.2 (_pre-release_)
- `dkhm-4.0.xsd`, DK Hostmaster EPP extensions version 4.0 (_pre-release_)
- `dkhm-domain-4.0.xsd`, DK Hostmaster EPP Domain extension version 4.0 (_pre-release_)
- `epp.xsd` (a collection files for easier test, validation and maintenance, see below)

The DK Hostmaster [EPP service specification](https://github.com/DK-Hostmaster/epp-service-specification) describes the use and contents of the files in more detail.
The DK Hostmaster [EPP service specification][DKHMEPPSPEC] describes the use and contents of the files in more detail.

The file `epp.xsd` is just for easier test and validation as mentioned, it can be used together with [`xmllint`](http://xmlsoft.org/xmllint.html):
The file `epp.xsd` is just for easier test and validation as mentioned, it can be used together with [`xmllint`][xmllint]:

```bash
$ xmllint --schema epp.xsd your_file.xml
Expand All @@ -87,18 +90,21 @@ It will then either omit an error message or the success message: `your_file.xml
<a id="xsd-history"></a>
## XSD History

<a id="32"></a>
### 3.2 _pre-release_
<a id="40"></a>
### 4.0 _pre-release_

- EPP Service version 4.0.0
- Introducing DK Hostmaster optional extension for EPP delete domain command request: `dkhm:delDate`
- Introducing DK Hostmaster optional extension for automatic renewal: `dkhm:autoRenew`
- Introducing DK Hostmaster optional command extension for transfer back to DK Hostmaster: `withdraw`
- Introducing use of the VeriSign EPP Balance: `info balance`
- Added proper Resources and References chapter

<a id="31"></a>
### 3.1 _pre-release_

- EPP Service version 3.5.X
- Introducing DK Hostmaster AuthInfo extension for EPP info domain command response
- Introducing DK Hostmaster AuthInfo expiration: `dkhm:authInfoExDate` extension for EPP info domain command response and authorizations for AuthInfo

<a id="30"></a>
### 3.0
Expand Down Expand Up @@ -145,7 +151,7 @@ It will then either omit an error message or the success message: `your_file.xml
### 2.1

- EPP Service version 2.3.X
- **Warning!** This release includes a change to the standard XSD from [RFC:5730](https://tools.ietf.org/html/rfc5730), aligning the values for the password type. It has not been possible to get the patch applied using the XML Schema feature: `redefine` or `overwrite`. When this succeeds this change will have to be rolled-back. The change has been applied so the schema file conforms with the schema file used at DK Hostmaster A/S.
- **Warning!** This release includes a change to the standard XSD from [RFC:5730][RFC5730], aligning the values for the password type. It has not been possible to get the patch applied using the XML Schema feature: `redefine` or `overwrite`. When this succeeds this change will have to be rolled-back. The change has been applied so the schema file conforms with the schema file used at DK Hostmaster A/S.

- The DKHM Schema file has been updated to revision 2.1, the file does not contain any changes apart from the import, this file was created for a uniform communication in regard to revision numbers etc.

Expand Down Expand Up @@ -198,3 +204,28 @@ It will then either omit an error message or the success message: `your_file.xml

- EPP Service version 1.0.0
- Released 2014-02-25

<a id="references_and_resources"></a>
## References and Resources

- [RFC:4310: "Domain Name System (DNS) Security Extensions Mapping for the Extensible Provisioning Protocol (EPP)"][RFC4310]
- [RFC:5730: Extensible Provisioning Protocol (EPP)][RFC5730]
- [RFC:5731: "Extensible Provisioning Protocol (EPP) Domain Name Mapping"][RFC5731]
- [RFC:5732: "Extensible Provisioning Protocol (EPP) Host Mapping"][RFC5732]
- [RFC:5733: "Extensible Provisioning Protocol (EPP) Contact Mapping"][RFC5733]
- [RFC:5910: "Domain Name System (DNS) Security Extensions Mapping for the Extensible Provisioning Protocol (EPP)"][RFC5910]
- [VeriSign: "Balance Mapping for the Extensible Provisioning Protocol (EPP)"][VeriSignEppBalance]
- [xmlsoft.org: xmllint][xmllint]
- [DK Hostmaster EPP Service Specification][DKHMEPPSPEC]
- [DK Hostmaster EPP Service Wiki][DKHMEPPWIKI]

[RFC4310]: https://tools.ietf.org/html/rfc4310
[RFC5730]: https://tools.ietf.org/html/rfc5730
[RFC5731]: https://tools.ietf.org/html/rfc5731
[RFC5732]: https://tools.ietf.org/html/rfc5732
[RFC5733]: https://tools.ietf.org/html/rfc5733
[RFC5910]: https://tools.ietf.org/html/rfc5910
[VeriSignEppBalance]: https://www.verisign.com/assets/epp-sdk/verisign_epp-extension_balance_v01.html
[xmllint]: http://xmlsoft.org/xmllint.html
[DKHMEPPSPEC]: https://github.com/DK-Hostmaster/epp-service-specification
[DKHMEPPWIKI]: https://github.com/DK-Hostmaster/epp-service-specification/wiki
8 changes: 4 additions & 4 deletions dkhm-3.2.xsd → dkhm-4.0.xsd
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<schema targetNamespace="urn:dkhm:params:xml:ns:dkhm-3.2"
xmlns:dkhm="urn:dkhm:params:xml:ns:dkhm-3.2"
<schema targetNamespace="urn:dkhm:params:xml:ns:dkhm-4.0"
xmlns:dkhm="urn:dkhm:params:xml:ns:dkhm-4.0"
xmlns:epp="urn:ietf:params:xml:ns:epp-1.0"
xmlns:eppcom="urn:ietf:params:xml:ns:eppcom-1.0"
xmlns:contact="urn:ietf:params:xml:ns:contact-1.0"
Expand All @@ -14,10 +14,10 @@
<import namespace="urn:ietf:params:xml:ns:eppcom-1.0" schemaLocation="eppcom-1.0.xsd"/>
<import namespace="urn:ietf:params:xml:ns:contact-1.0" schemaLocation="contact-1.0.xsd"/>
<import namespace="urn:ietf:params:xml:ns:domain-1.0" schemaLocation="domain-1.0.xsd"/>
<import namespace="urn:ietf:params:xml:ns:dkhm-domain-3.2" schemaLocation="dkhm-domain-3.2.xsd"/>
<import namespace="urn:ietf:params:xml:ns:dkhm-domain-4.0" schemaLocation="dkhm-domain-4.0.xsd"/>

<annotation>
<documentation>Extensible Provisioning Protocol v1.0 provisioning schema. DKHM extension v3.2</documentation>
<documentation>Extensible Provisioning Protocol v1.0 provisioning schema. DKHM extension v4.0</documentation>
</annotation>

<!--
Expand Down
6 changes: 3 additions & 3 deletions dkhm-domain-3.2.xsd → dkhm-domain-4.0.xsd
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>

<schema targetNamespace="urn:dkhm:params:xml:ns:dkhm-domain-3.2"
xmlns:dkhm-domain="urn:dkhm:params:xml:ns:dkhm-domain-3.2"
<schema targetNamespace="urn:dkhm:params:xml:ns:dkhm-domain-4.0"
xmlns:dkhm-domain="urn:dkhm:params:xml:ns:dkhm-domain-4.0"
xmlns:epp="urn:ietf:params:xml:ns:epp-1.0"
xmlns:eppcom="urn:ietf:params:xml:ns:eppcom-1.0"
xmlns="http://www.w3.org/2001/XMLSchema"
Expand All @@ -13,7 +13,7 @@
schemaLocation="epp-1.0.xsd"/>

<annotation>
<documentation>Extensible Provisioning Protocol v1.0 provisioning schema. DKHM extension v3.2 for domain</documentation>
<documentation>Extensible Provisioning Protocol v1.0 provisioning schema. DKHM extension v4.0 for domain</documentation>
</annotation>

<element name="withdraw" type="dkhm-domain:withdrawType"/>
Expand Down
5 changes: 3 additions & 2 deletions epp.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,9 @@
<import namespace="urn:ietf:params:xml:ns:secDNS-1.1" schemaLocation="secDNS-1.1.xsd" />

<!-- import DKHM XSD files -->
<import namespace="urn:dkhm:params:xml:ns:dkhm-3.2" schemaLocation="dkhm-3.2.xsd" />
<import namespace="urn:dkhm:params:xml:ns:dkhm-domain-3.2" schemaLocation="dkhm-domain-3.2.xsd" />
<import namespace="urn:dkhm:params:xml:ns:dkhm-4.0" schemaLocation="dkhm-4.0.xsd" />
<import namespace="urn:dkhm:params:xml:ns:dkhm-domain-4.0" schemaLocation="dkhm-domain-4.0.xsd" />
<import namespace="http://www.verisign.com/epp/balance-1.0" schemaLocation="verisign-epp-balance-1.0.xsd" />

<!--
End of schema.
Expand Down
58 changes: 58 additions & 0 deletions verisign-epp-balance-1.0.xsd
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
<?xml version="1.0" encoding="UTF-8"?>

<schema
targetNamespace="http://www.verisign.com/epp/balance-1.0"
xmlns:balance="http://www.verisign.com/epp/balance-1.0"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">

<annotation>
<documentation>
Extensible Provisioning Protocol v1.0
Verisign mapping for getting account balance and
other financial information.
</documentation>
</annotation>

<!--
Child elements found in EPP commands.
-->
<!-- Empty balance:info command element -->
<element name="info"/>

<!--
Child response elements.
-->
<element name="infData" type="balance:infDataType"/>

<!--Child elements of the balance:infData element -->
<complexType name="infDataType">
<sequence>
<element name="creditLimit"
type="balance:currencyValueType"/>
<element name="balance"
type="balance:currencyValueType"/>
<element name="availableCredit"
type="balance:currencyValueType"/>
<element name="creditThreshold"
type="balance:thresholdType"/>
</sequence>
</complexType>

<complexType name="thresholdType">
<choice>
<element name="fixed"
type="balance:currencyValueType"/>
<element name="percent"
type="integer"/>
</choice>
</complexType>

<simpleType name="currencyValueType">
<restriction base="decimal">
<fractionDigits value="2"/>
</restriction>
</simpleType>

<!-- End of schema.-->
</schema>
9 changes: 9 additions & 0 deletions xml/balance_request.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
<command>
<info>
<balance:info xmlns:balance="http://www.verisign.com/epp/balance-1.0"/>
</info>
<clTRID>ABC-12345</clTRID>
</command>
</epp>
22 changes: 22 additions & 0 deletions xml/balance_response.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<?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>
<balance:infData xmlns:balance="http://www.verisign.com/epp/balance-1.0">
<balance:creditLimit>0</balance:creditLimit>
<balance:balance>2000.00</balance:balance>
<balance:availableCredit>2000.00</balance:availableCredit>
<balance:creditThreshold>
<balance:fixed>0</balance:fixed>
</balance:creditThreshold>
</balance:infData>
</resData>
<trID>
<clTRID>ABC-12345</clTRID>
<svTRID>54322-XYZ</svTRID>
</trID>
</response>
</epp>
46 changes: 23 additions & 23 deletions xml/create_domain_with_orderconfirmation_token.xml
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
<?xml version="1.0" encoding="utf-8"?>
<epp xmlns="urn:ietf:params:xml:ns:epp-1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0 epp-1.0.xsd">
<command>
<create>
<domain:create xmlns:domain="urn:ietf:params:xml:ns:domain-1.0" xsi:schemaLocation="urn:ietf:params:xml:ns:domain-1.0 domain-1.0.xsd">
<domain:name>dk-hostmaster-test-906.dk</domain:name>
<domain:period unit="y">1</domain:period>
<domain:ns>
<domain:hostObj>ns1.dk-hostmaster.dk</domain:hostObj>
<domain:hostObj>ns2.dk-hostmaster.dk</domain:hostObj>
</domain:ns>
<domain:registrant>DKHM1-DK</domain:registrant>
<domain:authInfo>
<domain:pw />
</domain:authInfo>
</domain:create>
</create>
<extension>
<dkhm:orderconfirmationToken xmlns:dkhm="urn:dkhm:params:xml:ns:dkhm-3.2">testtoken</dkhm:orderconfirmationToken>
</extension>
<clTRID>92724843f12a3e958588679551aa988d</clTRID>
</command>
</epp>
<?xml version="1.0" encoding="utf-8"?>
<epp xmlns="urn:ietf:params:xml:ns:epp-1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0 epp-1.0.xsd">
<command>
<create>
<domain:create xmlns:domain="urn:ietf:params:xml:ns:domain-1.0" xsi:schemaLocation="urn:ietf:params:xml:ns:domain-1.0 domain-1.0.xsd">
<domain:name>dk-hostmaster-test-906.dk</domain:name>
<domain:period unit="y">1</domain:period>
<domain:ns>
<domain:hostObj>ns1.dk-hostmaster.dk</domain:hostObj>
<domain:hostObj>ns2.dk-hostmaster.dk</domain:hostObj>
</domain:ns>
<domain:registrant>DKHM1-DK</domain:registrant>
<domain:authInfo>
<domain:pw />
</domain:authInfo>
</domain:create>
</create>
<extension>
<dkhm:orderconfirmationToken xmlns:dkhm="urn:dkhm:params:xml:ns:dkhm-4.0">testtoken</dkhm:orderconfirmationToken>
</extension>
<clTRID>92724843f12a3e958588679551aa988d</clTRID>
</command>
</epp>
Loading

0 comments on commit 4c6df6b

Please sign in to comment.