Merge pull request #2032 from internetee/2030-support-multiple-schema-file-versions

2030 support multiple schema file versions

lib/epp_constraint.rb

@@ -1,6 +1,9 @@
 class EppConstraint
   OBJECT_TYPES = {
-    domain: { domain: Xsd::Schema.filename(for_prefix: 'domain-eis') },
+    domain: [
+      { domain: Xsd::Schema.filename(for_prefix: 'domain-ee') },
+      { domain: Xsd::Schema.filename(for_prefix: 'domain-eis') },
+    ],
     contact: { contact: Xsd::Schema.filename(for_prefix: 'contact-ee') },
   }.freeze
 
@@ -11,16 +14,45 @@ class EppConstraint
   # creates parsed_frame, detects epp request object
   def matches?(request)
     # TODO: Maybe move this to controller to keep params clean
-    request.params[:raw_frame] = request.params[:raw_frame].gsub!(/(?<=>)(.*?)(?=<)/) { |s| s.strip} if request.params[:raw_frame]
-    request.params[:nokogiri_frame] ||= Nokogiri::XML(request.params[:raw_frame] || request.params[:frame])
-    request.params[:parsed_frame]   ||= request.params[:nokogiri_frame].dup.remove_namespaces!
+    return redirect_to_error_controller(request) if request.params[:action] == 'wrong_schema'
+
+    request = parse_raw_frame(request) if request.params[:raw_frame]
+
+    request = parse_params(request)
 
     unless %i[poll session].include?(@type)
       element = "//#{@type}:#{request.params[:action]}"
-      return false if request.params[:nokogiri_frame].xpath("#{element}", OBJECT_TYPES[@type]).none?
+
+      return enumerate_domain_object(request, element) if @type == :domain
+
+      return false if request.params[:nokogiri_frame].xpath(element.to_s, OBJECT_TYPES[@type]).none?
     end
 
     request.params[:epp_object_type] = @type
     true
   end
+
+  def parse_raw_frame(request)
+    request.params[:raw_frame] = request.params[:raw_frame].gsub!(/(?<=>)(.*?)(?=<)/, &:strip)
+    request
+  end
+
+  def enumerate_domain_object(request, element)
+    OBJECT_TYPES[@type].each do |obj|
+      return true unless request.params[:nokogiri_frame].xpath(element.to_s, obj).none?
+    end
+    false
+  end
+
+  def parse_params(request)
+    request.params[:nokogiri_frame] ||= Nokogiri::XML(request.params[:raw_frame] || request.params[:frame])
+    request.params[:parsed_frame] ||= request.params[:nokogiri_frame].dup.remove_namespaces!
+
+    request
+  end
+
+  def redirect_to_error_controller(request)
+    request.params[:epp_object_type] = @error
+    true
+  end
 end

lib/schemas/all-ee-1.2.xsd

@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+  <!--
+  This schema imports other schemas used for Estonian ccTLD
+  .ee EPP queries and responses.
+  -->
+  <schema targetNamespace="https://epp.tld.ee/schema/all-ee-1.2"
+          xmlns:all="https://epp.tld.ee/schema/all-ee-1.2"
+          xmlns="http://www.w3.org/2001/XMLSchema"
+          elementFormDefault="qualified">
+
+    <!--
+    Import all schemas related to .ee EPP protocol.
+    Anytime the version of any imported schema is raised, the version of
+    'all' schema is also raised.
+    eppcom and epp schemas never change the version. This would result
+    in incompatibility with EPP standard.
+    -->
+    <import namespace="urn:ietf:params:xml:ns:eppcom-1.0"
+      schemaLocation="lib/schemas/eppcom-1.0.xsd"/>
+    <import namespace="https://epp.tld.ee/schema/epp-ee-1.0.xsd"
+      schemaLocation="lib/schemas/epp-ee-1.0.xsd"/>
+    <!-- EPP protocol extension: DNSSEC -->
+    <import namespace="urn:ietf:params:xml:ns:secDNS-1.1"
+      schemaLocation="lib/schemas/secDNS-1.1.xsd"/>
+    <import namespace="urn:ietf:params:xml:ns:host-1.0"
+      schemaLocation="lib/schemas/host-1.0.xsd"/>
+    <!-- EPP protocol extension: .ee specific -->
+    <import namespace="https://epp.tld.ee/schema/eis-1.0"
+      schemaLocation="lib/schemas/eis-1.0.xsd"/>
+    <import namespace="https://epp.tld.ee/schema/contact-ee-1.1"
+      schemaLocation="lib/schemas/contact-ee-1.1.xsd"/>
+    <import namespace="https://epp.tld.ee/schema/domain-ee-1.1"
+      schemaLocation="lib/schemas/domain-ee-1.1.xsd"/>
+
+    <annotation>
+      <documentation>
+        Extensible Provisioning Protocol v1.0
+        all schema's grouped together
+      </documentation>
+    </annotation>
+
+  </schema>

lib/schemas/domain-ee-1.1.xsd

@@ -0,0 +1,472 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<schema targetNamespace="https://epp.tld.ee/schema/domain-ee-1.1.xsd"
+     xmlns:domain="https://epp.tld.ee/schema/domain-ee-1.1.xsd"
+     xmlns:host="urn:ietf:params:xml:ns:host-1.0"
+     xmlns:epp="https://epp.tld.ee/schema/epp-ee-1.0.xsd"
+     xmlns:eppcom="urn:ietf:params:xml:ns:eppcom-1.0"
+     xmlns="http://www.w3.org/2001/XMLSchema"
+     elementFormDefault="qualified">
+
+<!--
+Import common element types.
+-->
+<import namespace="urn:ietf:params:xml:ns:eppcom-1.0"/>
+<import namespace="https://epp.tld.ee/schema/epp-ee-1.0.xsd"/>
+<import namespace="urn:ietf:params:xml:ns:host-1.0"/>
+<import namespace="urn:ietf:params:xml:ns:secDNS-1.1"/>
+<import namespace="https://epp.tld.ee/schema/eis-1.0.xsd"/>
+
+<annotation>
+  <documentation>
+    Extensible Provisioning Protocol v1.0
+    domain provisioning schema.
+  </documentation>
+</annotation>
+
+<!--
+Child elements found in EPP commands.
+-->
+<element name="check" type="domain:mNameType"/>
+<element name="create" type="domain:createType"/>
+<element name="delete" type="domain:deleteType"/>
+<element name="info" type="domain:infoType"/>
+<element name="renew" type="domain:renewType"/>
+<element name="transfer" type="domain:transferType"/>
+<element name="update" type="domain:updateType"/>
+
+<!--
+Child elements of the <create> command.
+-->
+<complexType name="createType">
+  <sequence>
+    <element name="name" type="eppcom:labelType"/>
+    <element name="period" type="domain:periodType"
+     minOccurs="0"/>
+    <element name="ns" type="domain:nsType"
+     minOccurs="0"/>
+    <element name="registrant" type="eppcom:clIDType"
+     minOccurs="0"/>
+    <element name="contact" type="domain:contactType"
+     minOccurs="0" maxOccurs="unbounded"/>
+    <element name="authInfo" type="domain:authInfoType" minOccurs="0"/>
+  </sequence>
+</complexType>
+
+<complexType name="periodType">
+  <simpleContent>
+    <extension base="domain:pLimitType">
+      <attribute name="unit" type="domain:pUnitType"
+       use="required"/>
+    </extension>
+  </simpleContent>
+</complexType>
+
+<simpleType name="pLimitType">
+  <restriction base="unsignedShort">
+    <minInclusive value="1"/>
+    <maxInclusive value="1095"/>
+  </restriction>
+</simpleType>
+
+<simpleType name="pUnitType">
+  <restriction base="token">
+    <enumeration value="y"/>
+    <enumeration value="m"/>
+    <enumeration value="d"/>
+  </restriction>
+</simpleType>
+
+<complexType name="nsType">
+  <choice>
+    <element name="hostObj" type="eppcom:labelType"
+     maxOccurs="unbounded"/>
+    <element name="hostAttr" type="domain:hostAttrType"
+     maxOccurs="unbounded"/>
+  </choice>
+</complexType>
+<!--
+Name servers are either host objects or attributes.
+-->
+
+<complexType name="hostAttrType">
+  <sequence>
+    <element name="hostName" type="eppcom:labelType"/>
+    <element name="hostAddr" type="host:addrType"
+     minOccurs="0" maxOccurs="unbounded"/>
+  </sequence>
+</complexType>
+<!--
+If attributes, addresses are optional and follow the
+structure defined in the host mapping.
+-->
+
+<complexType name="contactType">
+  <simpleContent>
+    <extension base="eppcom:clIDType">
+      <attribute name="type" type="domain:contactAttrType"/>
+    </extension>
+  </simpleContent>
+</complexType>
+
+<simpleType name="contactAttrType">
+  <restriction base="token">
+    <enumeration value="admin"/>
+    <enumeration value="billing"/>
+    <enumeration value="tech"/>
+  </restriction>
+</simpleType>
+
+<complexType name="authInfoType">
+  <choice>
+    <element name="pw" type="eppcom:pwAuthInfoType"/>
+    <element name="ext" type="eppcom:extAuthInfoType"/>
+  </choice>
+</complexType>
+
+<!--
+Child element of commands that require a single name.
+-->
+<complexType name="sNameType">
+  <sequence>
+    <element name="name" type="eppcom:labelType"/>
+  </sequence>
+</complexType>
+<!--
+Child element of commands that accept multiple names.
+-->
+<complexType name="mNameType">
+  <sequence>
+    <element name="name" type="eppcom:labelType"
+     maxOccurs="unbounded"/>
+  </sequence>
+</complexType>
+
+<!--
+Child element of the <delete> command - .ee specific (verified)
+-->
+<complexType name="deleteType">
+  <sequence>
+    <element name="name" type="eppcom:labelType"/>
+  </sequence>
+  <attribute name="verified" type="domain:verifiedType"
+   use="optional"/>
+</complexType>
+
+<!--
+Child elements of the <info> command.
+-->
+<complexType name="infoType">
+  <sequence>
+    <element name="name" type="domain:infoNameType"/>
+    <element name="authInfo" type="domain:authInfoType"
+     minOccurs="0"/>
+  </sequence>
+</complexType>
+
+<complexType name="infoNameType">
+  <simpleContent>
+    <extension base = "eppcom:labelType">
+      <attribute name="hosts" type="domain:hostsType"
+       default="all"/>
+    </extension>
+  </simpleContent>
+</complexType>
+
+<simpleType name="hostsType">
+  <restriction base="token">
+    <enumeration value="all"/>
+    <enumeration value="del"/>
+    <enumeration value="none"/>
+    <enumeration value="sub"/>
+  </restriction>
+</simpleType>
+
+<!--
+Child elements of the <renew> command.
+-->
+<complexType name="renewType">
+  <sequence>
+    <element name="name" type="eppcom:labelType"/>
+    <element name="curExpDate" type="date"/>
+    <element name="period" type="domain:periodType"
+     minOccurs="0"/>
+  </sequence>
+ </complexType>
+
+<!--
+Child elements of the <transfer> command.
+-->
+<complexType name="transferType">
+  <sequence>
+    <element name="name" type="eppcom:labelType"/>
+    <element name="period" type="domain:periodType"
+     minOccurs="0"/>
+    <element name="authInfo" type="domain:authInfoType"
+     minOccurs="0"/>
+  </sequence>
+</complexType>
+
+<!--
+Child elements of the <update> command.
+-->
+<complexType name="updateType">
+  <sequence>
+    <element name="name" type="eppcom:labelType"/>
+    <element name="add" type="domain:addRemType"
+     minOccurs="0"/>
+    <element name="rem" type="domain:addRemType"
+     minOccurs="0"/>
+    <element name="chg" type="domain:chgType"
+     minOccurs="0"/>
+  </sequence>
+</complexType>
+
+<!--
+Data elements that can be added or removed.
+-->
+<complexType name="addRemType">
+  <sequence>
+    <element name="ns" type="domain:nsType"
+     minOccurs="0"/>
+    <element name="contact" type="domain:contactType"
+     minOccurs="0" maxOccurs="unbounded"/>
+    <element name="status" type="domain:statusType"
+     minOccurs="0" maxOccurs="11"/>
+  </sequence>
+</complexType>
+
+<!--
+Data elements that can be changed.
+-->
+<complexType name="chgType">
+  <sequence>
+    <element name="registrant" type="domain:clIDChgType"
+     minOccurs="0"/>
+    <element name="authInfo" type="domain:authInfoChgType"
+     minOccurs="0"/>
+  </sequence>
+</complexType>
+
+<!--
+Allow the registrant value to be nullified by changing the
+minLength restriction to "0".
+-->
+
+<complexType name="clIDChgType">
+  <simpleContent>
+    <extension base="domain:clIDChgSimpleType">
+      <attribute name="verified" type="domain:verifiedType"/>
+    </extension>
+  </simpleContent>
+</complexType>
+
+<simpleType name="clIDChgSimpleType">
+  <restriction base="token">
+    <minLength value="0"/>
+  </restriction>
+</simpleType>
+
+<simpleType name="verifiedType">
+  <restriction base="token">
+    <enumeration value="yes"/>
+    <enumeration value="no"/>
+  </restriction>
+</simpleType>
+
+<!--
+Allow the authInfo value to be nullified by including an
+empty element within the choice.
+-->
+<complexType name="authInfoChgType">
+  <choice>
+    <element name="pw" type="eppcom:pwAuthInfoType"/>
+    <element name="ext" type="eppcom:extAuthInfoType"/>
+    <element name="null"/>
+  </choice>
+</complexType>
+
+<!--
+Child response elements.
+-->
+<element name="chkData" type="domain:chkDataType"/>
+<element name="creData" type="domain:creDataType"/>
+<element name="infData" type="domain:infDataType"/>
+<element name="panData" type="domain:panDataType"/>
+<element name="renData" type="domain:renDataType"/>
+<element name="trnData" type="domain:trnDataType"/>
+
+<!--
+<check> response elements.
+-->
+<complexType name="chkDataType">
+  <sequence>
+    <element name="cd" type="domain:checkType"
+     maxOccurs="unbounded"/>
+  </sequence>
+ </complexType>
+
+<complexType name="checkType">
+  <sequence>
+    <element name="name" type="domain:checkNameType"/>
+    <element name="reason" type="eppcom:reasonType"
+     minOccurs="0"/>
+  </sequence>
+</complexType>
+
+<complexType name="checkNameType">
+  <simpleContent>
+    <extension base="eppcom:labelType">
+      <attribute name="avail" type="boolean"
+       use="required"/>
+    </extension>
+  </simpleContent>
+</complexType>
+
+<!--
+<create> response elements.
+-->
+<complexType name="creDataType">
+  <sequence>
+    <element name="name" type="eppcom:labelType"/>
+    <element name="crDate" type="dateTime"/>
+    <element name="exDate" type="dateTime"
+     minOccurs="0"/>
+  </sequence>
+</complexType>
+
+<!--
+<info> response elements.
+-->
+
+<complexType name="infDataType">
+  <sequence>
+    <element name="name" type="eppcom:labelType"/>
+    <element name="roid" type="eppcom:roidType"/>
+    <element name="status" type="domain:statusType"
+     minOccurs="0" maxOccurs="11"/>
+    <element name="registrant" type="eppcom:clIDType"
+     minOccurs="0"/>
+    <element name="contact" type="domain:contactType"
+     minOccurs="0" maxOccurs="unbounded"/>
+    <element name="ns" type="domain:nsType"
+     minOccurs="0"/>
+    <element name="host" type="eppcom:labelType"
+     minOccurs="0" maxOccurs="unbounded"/>
+    <element name="clID" type="eppcom:clIDType"/>
+    <element name="crID" type="eppcom:clIDType"
+     minOccurs="0"/>
+    <element name="crDate" type="dateTime"
+     minOccurs="0"/>
+    <element name="upID" type="eppcom:clIDType"
+     minOccurs="0"/>
+    <element name="upDate" type="dateTime"
+     minOccurs="0"/>
+    <element name="exDate" type="dateTime"
+     minOccurs="0"/>
+    <element name="trDate" type="dateTime"
+     minOccurs="0"/>
+    <element name="authInfo" type="domain:authInfoType"
+     minOccurs="0"/>
+  </sequence>
+</complexType>
+
+<!--
+Status is a combination of attributes and an optional
+human-readable message that may be expressed in languages other
+than English.
+-->
+<complexType name="statusType">
+  <simpleContent>
+    <extension base="normalizedString">
+      <attribute name="s" type="domain:statusValueType"
+       use="required"/>
+      <attribute name="lang" type="language"
+       default="en"/>
+    </extension>
+  </simpleContent>
+</complexType>
+
+<simpleType name="statusValueType">
+  <restriction base="token">
+    <enumeration value="clientDeleteProhibited"/>
+    <enumeration value="clientHold"/>
+    <enumeration value="clientRenewProhibited"/>
+    <enumeration value="clientTransferProhibited"/>
+    <enumeration value="clientUpdateProhibited"/>
+    <enumeration value="inactive"/>
+    <enumeration value="ok"/>
+    <enumeration value="expired"/>
+    <enumeration value="pendingCreate"/>
+    <enumeration value="pendingDelete"/>
+    <enumeration value="pendingRenew"/>
+    <enumeration value="pendingTransfer"/>
+    <enumeration value="pendingUpdate"/>
+    <enumeration value="pendingDeleteConfirmation"/>
+    <enumeration value="serverDeleteProhibited"/>
+    <enumeration value="serverHold"/>
+    <enumeration value="serverRenewProhibited"/>
+    <enumeration value="serverTransferProhibited"/>
+    <enumeration value="serverUpdateProhibited"/>
+    <enumeration value="serverForceDelete"/>
+    <enumeration value="serverManualInzone"/>
+    <enumeration value="serverRegistrantChangeProhibited"/>
+    <enumeration value="serverAdminChangeProhibited"/>
+    <enumeration value="serverTechChangeProhibited"/>
+    <enumeration value="deleteCandidate"/>
+    <enumeration value="disputed"/>
+    <enumeration value="serverReleaseProhibited"/>
+  </restriction>
+</simpleType>
+
+<!--
+Pending action notification response elements.
+-->
+<complexType name="panDataType">
+  <sequence>
+    <element name="name" type="domain:paNameType"/>
+    <element name="paTRID" type="epp:trIDType"/>
+    <element name="paDate" type="dateTime"/>
+  </sequence>
+</complexType>
+
+<complexType name="paNameType">
+  <simpleContent>
+    <extension base="eppcom:labelType">
+      <attribute name="paResult" type="boolean"
+       use="required"/>
+    </extension>
+  </simpleContent>
+</complexType>
+
+<!--
+<renew> response elements.
+-->
+<complexType name="renDataType">
+  <sequence>
+    <element name="name" type="eppcom:labelType"/>
+    <element name="exDate" type="dateTime"
+     minOccurs="0"/>
+  </sequence>
+</complexType>
+
+<!--
+<transfer> response elements.
+-->
+<complexType name="trnDataType">
+  <sequence>
+    <element name="name" type="eppcom:labelType"/>
+    <element name="trStatus" type="eppcom:trStatusType"/>
+    <element name="reID" type="eppcom:clIDType"/>
+    <element name="reDate" type="dateTime"/>
+    <element name="acID" type="eppcom:clIDType"/>
+    <element name="acDate" type="dateTime"/>
+    <element name="exDate" type="dateTime"
+     minOccurs="0"/>
+  </sequence>
+</complexType>
+
+<!--
+End of schema.
+ -->
+</schema>

lib/xsd/schema.rb

@@ -3,6 +3,22 @@ module Xsd
     SCHEMA_PATH = 'lib/schemas/'.freeze
     BASE_URL = 'https://epp.tld.ee/schema/'.freeze
 
+    PREFIXES = %w[
+      domain-ee
+      domain-eis
+      all-ee
+      changePoll
+      contact
+      contact-ee
+      contact-eis
+      eis
+      epp
+      epp-ee
+      eppcom
+      host
+      secDNS
+    ].freeze
+
     attr_reader :xsd_schemas, :for_prefix
 
     def initialize(params)