epics 2.10.0 → 3.0.0.rc1

data/lib/epics/crypt/aes.rb

@@ -0,0 +1,56 @@
+class Epics::Crypt::Aes
+  attr_writer :key, :key_length
+
+  def initialize
+    @cipher = {}
+  end
+
+  def decrypt(encrypted)
+    cipher = use_cipher(:decrypt)
+    unpad(cipher.update(encrypted) + cipher.final)
+  end
+
+  def encrypt(plaintext)
+    cipher = use_cipher(:encrypt)
+    cipher.update(pad(cipher, plaintext)) + cipher.final
+  end
+
+  def key
+    @key ||= create_cipher.random_key
+  end
+
+  def key_length
+    @key_length ||= 128
+  end
+
+  private
+
+  def create_cipher
+    @cipher[key_length] ||= OpenSSL::Cipher::AES.new(key_length, :CBC).tap do |cipher|
+      cipher.padding = 0
+      cipher.iv = 0.chr * cipher.iv_len
+    end
+  end
+
+  def use_cipher(method)
+    create_cipher.tap do |cipher|
+      cipher.reset
+      cipher.send(method)
+      cipher.key = key
+    end
+  end
+
+  def pad(cipher, text)
+    len = cipher.block_size * ((text.size / cipher.block_size) + 1)
+
+    text.ljust(len, [0].pack('C*')).tap do |padded|
+      padded[-1] = [len - text.size].pack('C*')
+    end
+  end
+
+  def unpad(text)
+    len = text[-1].unpack('C*').first
+
+    text[0...-len]
+  end
+end

data/lib/epics/crypt/x_509.rb

@@ -0,0 +1,52 @@
+class Epics::Crypt::X509
+  extend Forwardable
+
+  # Swiss market practice guidelines §6.1 name 9999-12-31 as the "unlimited" validity
+  # date. An expired certificate means re-initialising with the bank.
+  UNLIMITED = Time.utc(9999, 12, 31, 23, 59, 59).freeze
+
+  KEY_USAGE = 'digitalSignature,nonRepudiation,keyEncipherment'.freeze
+
+  attr_reader :certificate
+
+  def_delegators :certificate, :issuer, :serial, :version, :to_der, :to_pem
+
+  # Self-signed certificate for `key`, which may be an OpenSSL::PKey::RSA or an
+  # Epics::SignatureAlgorithm wrapping one. `subject` takes an OpenSSL::X509::Name or
+  # any string OpenSSL::X509::Name.parse accepts.
+  def self.generate(key, subject:, not_before: nil, not_after: UNLIMITED, serial: nil)
+    key = key.key if key.respond_to?(:key)
+    name = subject.is_a?(OpenSSL::X509::Name) ? subject : OpenSSL::X509::Name.parse(subject)
+
+    certificate = OpenSSL::X509::Certificate.new
+    certificate.version = 2
+    certificate.serial = serial || SecureRandom.random_number(2**64)
+    certificate.subject = name
+    certificate.issuer = name
+    certificate.public_key = key.public_key
+    certificate.not_before = not_before || Time.now.utc
+    certificate.not_after = not_after
+
+    factory = OpenSSL::X509::ExtensionFactory.new
+    factory.subject_certificate = certificate
+    factory.issuer_certificate = certificate
+    certificate.add_extension(factory.create_extension('basicConstraints', 'CA:FALSE', true))
+    certificate.add_extension(factory.create_extension('keyUsage', KEY_USAGE, true))
+
+    certificate.sign(key, OpenSSL::Digest.new('SHA256'))
+
+    new(certificate.to_pem)
+  end
+
+  def initialize(content)
+    @certificate = OpenSSL::X509::Certificate.new(content)
+  end
+
+  def data
+    Base64.strict_encode64(certificate.to_der)
+  end
+
+  def fingerprint
+    Digest::SHA256.hexdigest(certificate.to_der).upcase
+  end
+end

data/lib/epics/crypt.rb

@@ -0,0 +1,5 @@
+module Epics::Crypt
+end
+
+require 'epics/crypt/aes'
+require 'epics/crypt/x_509'

data/lib/epics/crz.rb

@@ -1,17 +1,6 @@
 class Epics::CRZ < Epics::GenericRequest
-  def header
-    client.header_request.build(
-      nonce: nonce,
-      timestamp: timestamp,
-      order_type: 'CRZ',
-      order_attribute: 'DZHNN',
-      order_params: !!options[:from] && !!options[:to] ? {
-        DateRange: {
-          Start: options[:from],
-          End: options[:to]
-        }
-      } : {},
-      mutable: { TransactionPhase: 'Initialisation' }
-    )
+  def to_xml
+    builder = request_factory.create_crz(options[:from], options[:to])
+    builder.to_xml
   end
 end

data/lib/epics/factories/crypt/aes_factory.rb

@@ -0,0 +1,5 @@
+class Epics::Factories::Crypt::AesFactory
+  def create
+    Epics::Crypt::Aes.new
+  end
+end

data/lib/epics/factories/crypt.rb

@@ -0,0 +1,4 @@
+module Epics::Factories::Crypt
+end
+
+require 'epics/factories/crypt/aes_factory'

data/lib/epics/factories/request_factory/base.rb

@@ -0,0 +1,236 @@
+class Epics::Factories::RequestFactory::Base
+  ORDER_TYPES = %w[
+    azv b2b btd btu bka
+    c2s c5n c52 c53 c54 ccs cct cd1 cdb cdd cds cdz cip crz
+    fdl ful h3k haa hac hev hia hkd hpb hpd htd ini ptk spr sta
+    vmk wss xct xds xe2 xe3 xek yct z01 z52 z53 z54 zsr
+  ].freeze
+
+  (ORDER_TYPES - %w[
+    b2b bka c2s c5n c52 c53 c54 ccs cct cd1 cdb cdd cds cdz cip crz
+    fdl ful h3k haa hac hev hia hkd hpb hpd htd ini ptk spr
+    sta vmk wss xds xe2 xe3 z01 z52 z53 z54
+  ]).each do |type|
+    define_method("create_#{type}") { |*| raise NotImplementedError }
+  end
+
+  def initialize(client)
+    @client = client
+  end
+
+  def add_order_type(order_details_builder, order_type, with_es = false)
+    raise NotImplementedError
+  end
+
+  def create_hev
+    request_builder.add_container_hev do |xml_builder|
+      xml_builder.add_host_id @client.host_id
+    end
+  end
+
+  def create_ini(order_data)
+    request_builder.add_container_unsecured do |xml_builder|
+      xml_builder.add_header do |header_builder|
+        header_builder.add_static do |static_builder|
+          static_builder.add_host_id @client.host_id
+          static_builder.add_partner_id @client.partner_id
+          static_builder.add_user_id @client.user_id
+          static_builder.add_product @client.product_name, @client.locale
+          static_builder.add_order_details do |order_details_builder|
+            add_order_type(order_details_builder, 'INI')
+          end
+          static_builder.add_security_medium Epics::Builders::StaticBuilder::SECURITY_MEDIUM_0000
+        end
+        header_builder.add_mutable
+      end
+      xml_builder.add_body do |body_builder|
+        body_builder.add_data_transfer do |data_transfer_builder|
+          data_transfer_builder.add_order_data order_data
+        end
+      end
+    end
+  end
+
+  def create_hia(order_data)
+    request_builder.add_container_unsecured do |xml_builder|
+      xml_builder.add_header do |header_builder|
+        header_builder.add_static do |static_builder|
+          static_builder.add_host_id @client.host_id
+          static_builder.add_partner_id @client.partner_id
+          static_builder.add_user_id @client.user_id
+          static_builder.add_product @client.product_name, @client.locale
+          static_builder.add_order_details do |order_details_builder|
+            add_order_type(order_details_builder, 'HIA')
+          end
+          static_builder.add_security_medium Epics::Builders::StaticBuilder::SECURITY_MEDIUM_0000
+        end
+        header_builder.add_mutable
+      end
+      xml_builder.add_body do |body_builder|
+        body_builder.add_data_transfer do |data_transfer_builder|
+          data_transfer_builder.add_order_data order_data
+        end
+      end
+    end
+  end
+
+  def create_h3k(*, **)
+    raise NotImplementedError
+  end
+
+  def create_hpb
+    auth_signature_handler = Epics::Handlers::AuthSignatureHandler.new(@client.keyring)
+    request_builder.add_container_secured_no_pubkey_digests do |xml_builder|
+      xml_builder.add_header do |header_builder|
+        header_builder.add_static do |static_builder|
+          static_builder.add_host_id @client.host_id
+          static_builder.add_random_nonce
+          static_builder.add_timestamp Time.now.utc
+          static_builder.add_partner_id @client.partner_id
+          static_builder.add_user_id @client.user_id
+          static_builder.add_product @client.product_name, @client.locale
+          static_builder.add_order_details do |order_details_builder|
+            add_order_type(order_details_builder, 'HPB')
+          end
+          static_builder.add_security_medium Epics::Builders::StaticBuilder::SECURITY_MEDIUM_0000
+        end
+        header_builder.add_mutable
+      end
+      xml_builder.add_body
+      auth_signature_handler.handle(xml_builder)
+    end
+  end
+
+  def create_spr(*, **)
+    raise NotImplementedError
+  end
+
+  def create_hpd
+    build_standard_request('HPD')
+  end
+
+  def create_hkd
+    build_standard_request('HKD')
+  end
+
+  def create_htd
+    build_standard_request('HTD')
+  end
+
+  def create_haa
+    build_standard_request('HAA')
+  end
+
+  def create_hac(start_date, end_date)
+    build_standard_request('HAC', start_date: start_date, end_date: end_date)
+  end
+
+  def create_ptk(start_date, end_date)
+    build_standard_request('PTK', start_date: start_date, end_date: end_date)
+  end
+
+  def create_fdl(format, start_date, end_date)
+    build_standard_request('FDL') do |order_details_builder|
+      order_details_builder.add_fdl_order_params(format, start_date, end_date)
+    end
+  end
+
+  def create_ful(digest, transaction_key, file_format:)
+    raise NotImplementedError
+  end
+
+  def create_transfer_receipt(transaction_id, acknowledged)
+    auth_signature_handler = Epics::Handlers::AuthSignatureHandler.new(@client.keyring)
+    request_builder.add_container_secured do |xml_builder|
+      xml_builder.add_header do |header_builder|
+        header_builder.add_static do |static_builder|
+          static_builder.add_host_id @client.host_id
+          static_builder.add_transaction_id transaction_id
+        end
+        header_builder.add_mutable do |mutable_builder|
+          mutable_builder.add_transaction_phase Epics::Builders::MutableBuilder::PHASE_RECEIPT
+        end
+      end
+      xml_builder.add_body do |body_builder|
+        body_builder.add_transfer_receipt do |transfer_receipt_builder|
+          transfer_receipt_builder.add_receipt_code acknowledged
+        end
+      end
+      auth_signature_handler.handle(xml_builder)
+    end
+  end
+
+  def create_transfer_upload(transaction_id, transaction_key, order_data, segment_number, is_last_segment = false)
+    auth_signature_handler = Epics::Handlers::AuthSignatureHandler.new(@client.keyring)
+    request_builder.add_container_secured do |xml_builder|
+      xml_builder.add_header do |header_builder|
+        header_builder.add_static do |static_builder|
+          static_builder.add_host_id @client.host_id
+          static_builder.add_transaction_id transaction_id
+        end
+        header_builder.add_mutable do |mutable_builder|
+          mutable_builder.add_transaction_phase Epics::Builders::MutableBuilder::PHASE_TRANSFER
+          mutable_builder.add_segment_number segment_number, is_last_segment
+        end
+      end
+      xml_builder.add_body do |body_builder|
+        body_builder.add_data_transfer do |data_transfer_builder|
+          data_transfer_builder.add_order_data(order_data, transaction_key)
+        end if order_data
+      end
+      auth_signature_handler.handle(xml_builder)
+    end
+  end
+
+  def create_transfer_download(transaction_id, segment_number, is_last_segment = false)
+    create_transfer_upload(transaction_id, nil, nil, segment_number, is_last_segment)
+  end
+
+  protected
+
+  def xml_builder
+    raise NotImplementedError
+  end
+
+  def request_builder
+    Epics::Builders::RequestBuilder.new(xml_builder)
+  end
+
+  private
+
+  def build_standard_request(order_type, start_date: nil, end_date: nil, with_es: false)
+    auth_signature_handler = Epics::Handlers::AuthSignatureHandler.new(@client.keyring)
+    request_builder.add_container_secured do |xml_builder|
+      xml_builder.add_header do |header_builder|
+        header_builder.add_static do |static_builder|
+          static_builder.add_host_id @client.host_id
+          static_builder.add_random_nonce
+          static_builder.add_timestamp Time.now.utc
+          static_builder.add_partner_id @client.partner_id
+          static_builder.add_user_id @client.user_id
+          static_builder.add_product @client.product_name, @client.locale
+          static_builder.add_order_details do |order_details_builder|
+            add_order_type(order_details_builder, order_type, with_es)
+            if block_given?
+              yield order_details_builder
+            else
+              order_details_builder.add_standard_order_params start_date, end_date
+            end
+          end
+          static_builder.add_bank_pubbey_digests(
+            @client.keyring.bank_authentication.version,
+            @digest_resolver.sign_digest(@client.keyring.bank_authentication),
+            @client.keyring.bank_encryption.version,
+            @digest_resolver.sign_digest(@client.keyring.bank_encryption)
+          )
+          static_builder.add_security_medium Epics::Builders::StaticBuilder::SECURITY_MEDIUM_0000
+        end
+        header_builder.add_mutable do |mutable_builder|
+          mutable_builder.add_transaction_phase Epics::Builders::MutableBuilder::PHASE_INITIALIZATION
+        end
+      end
+      xml_builder.add_body
+      auth_signature_handler.handle(xml_builder)
+    end
+  end
+end

data/lib/epics/factories/request_factory/v2.rb

@@ -0,0 +1,194 @@
+class Epics::Factories::RequestFactory::V2 < Epics::Factories::RequestFactory::Base
+  %w[btd btu].each do |type|
+    define_method("create_#{type}") { |*| raise Epics::VersionSupportError, 3.0 }
+  end
+
+  def initialize(client)
+    @digest_resolver = Epics::Services::DigestResolver::V2.new
+    @user_signature_handle = Epics::Handlers::UserSignatureHandler::V2.new(client)
+    super
+  end
+
+  def create_bka(start_date, end_date)
+    build_download_request('BKA', start_date: start_date, end_date: end_date)
+  end
+
+  def create_z01(start_date, end_date, **)
+    build_download_request('Z01', start_date: start_date, end_date: end_date)
+  end
+
+  def create_c52(start_date, end_date, **)
+    build_download_request('C52', start_date: start_date, end_date: end_date)
+  end
+
+  def create_c53(start_date, end_date, **)
+    build_download_request('C53', start_date: start_date, end_date: end_date)
+  end
+
+  def create_c54(start_date, end_date, **)
+    build_download_request('C54', start_date: start_date, end_date: end_date)
+  end
+
+  def create_c5n(start_date, end_date)
+    build_download_request('C5N', start_date: start_date, end_date: end_date)
+  end
+
+  def create_cdz(start_date, end_date)
+    build_download_request('CDZ', start_date: start_date, end_date: end_date)
+  end
+
+  def create_crz(start_date, end_date)
+    build_download_request('CRZ', start_date: start_date, end_date: end_date)
+  end
+
+  def create_sta(start_date, end_date)
+    build_download_request('STA', start_date: start_date, end_date: end_date)
+  end
+
+  def create_vmk(start_date, end_date)
+    build_download_request('VMK', start_date: start_date, end_date: end_date)
+  end
+
+  def create_wss
+    build_download_request('WSS')
+  end
+
+  def create_z52(start_date, end_date, **)
+    build_download_request('Z52', start_date: start_date, end_date: end_date)
+  end
+
+  def create_z53(start_date, end_date, **)
+    build_download_request('Z53', start_date: start_date, end_date: end_date)
+  end
+
+  def create_z54(start_date, end_date, **)
+    build_download_request('Z54', start_date: start_date, end_date: end_date)
+  end
+
+  def create_b2b(digest, transaction_key, **)
+    signature_data = @user_signature_handle.handle(digest).to_xml
+    build_upload_request('B2B', transaction_key, signature_data, 1, true)
+  end
+
+  def create_c2s(digest, transaction_key, **)
+    signature_data = @user_signature_handle.handle(digest).to_xml
+    build_upload_request('C2S', transaction_key, signature_data, 1, false)
+  end
+
+  def create_ccs(digest, transaction_key, **)
+    signature_data = @user_signature_handle.handle(digest).to_xml
+    build_upload_request('CCS', transaction_key, signature_data, 1, false)
+  end
+
+  def create_cct(digest, transaction_key, **)
+    signature_data = @user_signature_handle.handle(digest).to_xml
+    build_upload_request('CCT', transaction_key, signature_data, 1, true)
+  end
+
+  def create_cds(digest, transaction_key, **)
+    signature_data = @user_signature_handle.handle(digest).to_xml
+    build_upload_request('CDS', transaction_key, signature_data, 1, false)
+  end
+
+  def create_azv(digest, transaction_key, **)
+    create_cd1(digest, transaction_key)
+  end
+
+  def create_cd1(digest, transaction_key, **)
+    signature_data = @user_signature_handle.handle(digest).to_xml
+    build_upload_request('CD1', transaction_key, signature_data, 1, true)
+  end
+
+  def create_cdd(digest, transaction_key, **)
+    signature_data = @user_signature_handle.handle(digest).to_xml
+    build_upload_request('CDD', transaction_key, signature_data, 1, true)
+  end
+
+  def create_cdb(digest, transaction_key, **)
+    signature_data = @user_signature_handle.handle(digest).to_xml
+    build_upload_request('CDB', transaction_key, signature_data, 1, true)
+  end
+
+  def create_cip(digest, transaction_key, **)
+    signature_data = @user_signature_handle.handle(digest).to_xml
+    build_upload_request('CIP', transaction_key, signature_data, 1, true)
+  end
+
+  def create_xct(digest, transaction_key, **)
+    signature_data = @user_signature_handle.handle(digest).to_xml
+    build_upload_request('XCT', transaction_key, signature_data, 1, true)
+  end
+
+  def create_xds(digest, transaction_key, **)
+    signature_data = @user_signature_handle.handle(digest).to_xml
+    build_upload_request('XDS', transaction_key, signature_data, 1, true)
+  end
+
+  def create_xe2(digest, transaction_key, **)
+    signature_data = @user_signature_handle.handle(digest).to_xml
+    build_upload_request('XE2', transaction_key, signature_data, 1, true)
+  end
+
+  def create_xe3(digest, transaction_key, **)
+    signature_data = @user_signature_handle.handle(digest).to_xml
+    build_upload_request('XE3', transaction_key, signature_data, 1, true)
+  end
+
+  def create_ful(digest, transaction_key, file_format:)
+    signature_data = @user_signature_handle.handle(digest).to_xml
+    build_upload_request('FUL', transaction_key, signature_data, 1) do |order_details_builder|
+      order_details_builder.add_ful_order_params(file_format)
+    end
+  end
+
+  private
+
+  def build_download_request(order_type, start_date: nil, end_date: nil, &)
+    build_standard_request(order_type, start_date: start_date, end_date: end_date, &)
+  end
+
+  def build_upload_request(order_type, transaction_key, signature_data, num_segments, with_es = false)
+    auth_signature_handler = Epics::Handlers::AuthSignatureHandler.new(@client.keyring)
+    request_builder.add_container_secured do |xml_builder|
+      xml_builder.add_header do |header_builder|
+        header_builder.add_static do |static_builder|
+          static_builder.add_host_id @client.host_id
+          static_builder.add_random_nonce
+          static_builder.add_timestamp Time.now.utc
+          static_builder.add_partner_id @client.partner_id
+          static_builder.add_user_id @client.user_id
+          static_builder.add_product @client.product_name, @client.locale
+          static_builder.add_order_details do |order_details_builder|
+            add_order_type(order_details_builder, order_type, with_es)
+            if block_given?
+              yield order_details_builder
+            else
+              order_details_builder.add_standard_order_params
+            end
+          end
+          static_builder.add_bank_pubbey_digests(
+            @client.keyring.bank_authentication.version,
+            @digest_resolver.sign_digest(@client.keyring.bank_authentication),
+            @client.keyring.bank_encryption.version,
+            @digest_resolver.sign_digest(@client.keyring.bank_encryption)
+          )
+          static_builder.add_security_medium Epics::Builders::StaticBuilder::SECURITY_MEDIUM_0000
+          static_builder.add_num_segments num_segments
+        end
+        header_builder.add_mutable do |mutable_builder|
+          mutable_builder.add_transaction_phase Epics::Builders::MutableBuilder::PHASE_INITIALIZATION
+        end
+      end
+      xml_builder.add_body do |body_builder|
+        body_builder.add_data_transfer do |data_transfer_builder|
+          data_transfer_builder.add_data_encryption_info do |data_encryption_info_builder|
+            data_encryption_info_builder.add_encryption_pubkey_digest @client.keyring
+            data_encryption_info_builder.add_transaction_key transaction_key, @client.keyring
+          end
+          data_transfer_builder.add_signature_data signature_data, transaction_key
+        end
+      end
+      auth_signature_handler.handle(xml_builder)
+    end
+  end
+end

data/lib/epics/factories/request_factory/v24.rb

@@ -0,0 +1,32 @@
+class Epics::Factories::RequestFactory::V24 < Epics::Factories::RequestFactory::V2
+  NOT_IMPLEMENTED_ORDER_TYPES = %w[
+    xek yct zsr
+  ].freeze
+
+  NOT_IMPLEMENTED_ORDER_TYPES.each do |type|
+    define_method("create_#{type}") { |*, **| raise Epics::VersionSupportError, 3.0 }
+  end
+
+  protected
+
+  def xml_builder
+    Epics::Builders::XmlBuilder::V24.new
+  end
+
+  def add_order_type(order_details_builder, order_type, with_es = false)
+    order_attribute = case order_type
+    when 'INI', 'HIA'
+      Epics::Builders::OrderDetailsBuilder::ORDER_ATTRIBUTE_DZNNN
+    else
+      if with_es
+        Epics::Builders::OrderDetailsBuilder::ORDER_ATTRIBUTE_OZHNN
+      else
+        Epics::Builders::OrderDetailsBuilder::ORDER_ATTRIBUTE_DZHNN
+      end
+    end
+
+    order_details_builder.add_order_type order_type
+    order_details_builder.add_order_id @client.next_order_id
+    order_details_builder.add_order_attribute order_attribute
+  end
+end

data/lib/epics/factories/request_factory/v25.rb

@@ -0,0 +1,31 @@
+class Epics::Factories::RequestFactory::V25 < Epics::Factories::RequestFactory::V2
+  NOT_IMPLEMENTED_ORDER_TYPES = %w[
+    xek yct zsr
+  ].freeze
+
+  NOT_IMPLEMENTED_ORDER_TYPES.each do |type|
+    define_method("create_#{type}") { |*, **| raise Epics::VersionSupportError, 3.0 }
+  end
+
+  protected
+
+  def xml_builder
+    Epics::Builders::XmlBuilder::V25.new
+  end
+
+  def add_order_type(order_details_builder, order_type, with_es = false)
+    order_attribute = case order_type
+    when 'INI', 'HIA'
+      Epics::Builders::OrderDetailsBuilder::ORDER_ATTRIBUTE_DZNNN
+    else
+      if with_es
+        Epics::Builders::OrderDetailsBuilder::ORDER_ATTRIBUTE_OZHNN
+      else
+        Epics::Builders::OrderDetailsBuilder::ORDER_ATTRIBUTE_DZHNN
+      end
+    end
+
+    order_details_builder.add_order_type order_type
+    order_details_builder.add_order_attribute order_attribute
+  end
+end