epics 3.0.0.rc2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d81d3bda7eef2d4468cba9327d5e72ad7222eec73e76bfe82c609765a212075
-  data.tar.gz: b49bcb37a43532a0f9d5074478e22cfa126c4b3e7bf594894f8be27e60aeca37
+  metadata.gz: 5f9d505e87c6753d7e10cf2092fa02e9ec4fff0c93476fb47c32e8aabd834012
+  data.tar.gz: 0da7d015ff42a77a23e3ee3f91d6a26a353dba9e107cd6275e73a9b5132fef13
 SHA512:
-  metadata.gz: '09ce2c4c8afa08bf91a00112d8a1078b388a76b40276006706f0c821a1aab7924655a9de56032956d1e74975dda1be8438e42d11211fae95b2d4aa4634b7f7f5'
-  data.tar.gz: fe3a33f8d19057cbe437189ae98b18e32eafbedde991bb12b1cf0c10a63384a5910f254272f4d9d43f972951d50fa18601bd2b521253603b2f3893e6a81c9e13
+  metadata.gz: cfd418610ca95b6ff2d29b407a5699721391e7b1197dffd271f52b7cb71e7c219629110c74ff77732a03a83ebf7f1d8696de9496eda636b6e4b2ddfd86d0c239
+  data.tar.gz: 21f19dee4287bca68b4b055148735445fb6893002a51dc73ebcc44ea3de597debae3b1397cbcdc8e8e129a7fa84908f0b70852527d40f5c2c6b70e2507962270

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ### Unreleased
 
+### 3.0.0
+
+- [FIX] H005 uploads were sent without `SignatureFlag` in `BTUOrderParams`, although they
+  carry the user's ES (electronic signature), so banks treated them as orders
+  to be authorised outside EBICS and some rejected them with `EBICS_INVALID_ORDER_TYPE`.
+  `SignatureFlag` is now set by default, matching `OZHNN` on H004. Pass `request_eds: true`
+  to spool the order into the EDS (distributed electronic signature, German VEU)
+  when signatures are still missing, or `signature_flag: false` to omit the flag
+
+### 3.0.0.rc2
+
 - [FIX] A download spanning several segments returned only its first segment, so zipped
   downloads such as `C52` and `C53` raised `Zip::Error` and plain ones such as `STA` came
   back cut off without an error. The remaining segments are now requested in the transfer

data/README.md

@@ -307,6 +307,28 @@ practice requires it to be supplied (guidelines §5.2).
 When it is absent the bank assumes a global definition.
 On EBICS 2.4/2.5 these parameters have no equivalent and are ignored.
 
+### Signatures on uploads
+
+EBICS 3.0 replaces the order attribute (`OZHNN`, `DZHNN`) with `SignatureFlag`, which tells
+the bank whether an upload carries the user's ES (electronic signature). Uploads always
+include it and send `SignatureFlag` by default, the equivalent of `OZHNN`: the bank expects
+every required signature in the request and rejects the order otherwise.
+
+```ruby
+# spool into the EDS (distributed electronic signature, German VEU) when signatures are
+# still missing, e.g. for a user who needs a second signer
+e.CCT(document, request_eds: true)
+
+# no SignatureFlag: the order is authorised outside EBICS, e.g. by an accompanying slip
+# or in online banking
+e.CCT(document, signature_flag: false)
+```
+
+`signature_flag: false` only drops the flag; the user's signature is still sent.
+
+On EBICS 2.4/2.5 both options have no effect and are silently ignored: uploads keep
+their fixed order attribute (`OZHNN` for the payment uploads).
+
 ## Features
 
 ### Initialization

data/lib/epics/builders/order_details_builder/v3.rb

@@ -32,8 +32,22 @@ class Epics::Builders::OrderDetailsBuilder::V3 < Epics::Builders::OrderDetailsBu
   end
 
   def add_btu_order_params(
-    filename:, service_name:, msg_name:, scope: nil, service_option: nil, container_type: nil, msg_name_version: nil, msg_name_variant: nil, msg_name_format: nil
+    filename:,
+    service_name:,
+    msg_name:,
+    scope: nil,
+    service_option: nil,
+    container_type: nil,
+    msg_name_version: nil,
+    msg_name_variant: nil,
+    msg_name_format: nil,
+    signature_flag: true,
+    request_eds: false
   )
+    if request_eds && !signature_flag
+      raise ArgumentError, 'request_eds requires signature_flag'
+    end
+
     @xml.BTUOrderParams fileName: filename do |xml|
       xml.Service do
         xml.ServiceName service_name
@@ -46,6 +60,16 @@ class Epics::Builders::OrderDetailsBuilder::V3 < Epics::Builders::OrderDetailsBu
         msg_name_attributes[:format] = msg_name_format if msg_name_format
         xml.MsgName msg_name, msg_name_attributes
       end
+      # Without SignatureFlag the bank treats the order as carrying no ES (electronic
+      # signature) and expects authorisation outside EBICS. requestEDS asks the bank to
+      # spool the order into the EDS (distributed electronic signature, German VEU,
+      # "Verteilte Elektronische Unterschrift") instead of rejecting it when signatures
+      # are still missing.
+      if signature_flag
+        signature_flag_attributes = {}
+        signature_flag_attributes[:requestEDS] = 'true' if request_eds
+        xml.SignatureFlag '', signature_flag_attributes
+      end
     end
   end
 end

data/lib/epics/client.rb

@@ -724,7 +724,7 @@ class Epics::Client
       data["#{host_id.upcase}.#{sig.version}"] = dump_signature(sig)
     end
 
-    JSON.pretty_generate(data, JSON.dump_default_options)
+    JSON.pretty_generate(data)
   end
 
   # Keys without a certificate keep the bare-string form so key files stay readable by

data/lib/epics/version.rb

@@ -2,6 +2,6 @@
 
 module Epics
 
-  VERSION = '3.0.0.rc2'
+  VERSION = '3.0.0'
 
 end

data/spec/builders_spec.rb

@@ -317,6 +317,60 @@ RSpec.describe 'Builders' do
           expect(container).not_to be_nil
           expect(container['containerType']).to eq('ZIP')
         end
+
+        it 'adds SignatureFlag after Service by default' do
+          instance = described_class::V3.new do |b|
+            b.add_btu_order_params(
+              filename: 'test.xml', service_name: 'MCT', msg_name: 'pain.001'
+            )
+          end
+          xml = parse_doc(instance)
+          params = xml.at('OrderDetails/BTUOrderParams')
+          expect(params.element_children.map(&:name)).to eq(%w[Service SignatureFlag])
+          expect(params.at('SignatureFlag')['requestEDS']).to be_nil
+        end
+
+        it 'sets requestEDS on SignatureFlag when request_eds is given' do
+          instance = described_class::V3.new do |b|
+            b.add_btu_order_params(
+              filename: 'test.xml',
+              service_name: 'MCT',
+              msg_name: 'pain.001',
+              request_eds: true
+            )
+          end
+          xml = parse_doc(instance)
+          params = xml.at('OrderDetails/BTUOrderParams')
+          expect(params.at('SignatureFlag')['requestEDS']).to eq('true')
+        end
+
+        it 'omits SignatureFlag when signature_flag is false' do
+          instance = described_class::V3.new do |b|
+            b.add_btu_order_params(
+              filename: 'test.xml',
+              service_name: 'MCT',
+              msg_name: 'pain.001',
+              signature_flag: false
+            )
+          end
+          xml = parse_doc(instance)
+          params = xml.at('OrderDetails/BTUOrderParams')
+          expect(params.at('SignatureFlag')).to be_nil
+        end
+
+        it 'rejects request_eds without signature_flag' do
+          expect do
+            described_class::V3.new do |b|
+              b.add_btu_order_params(
+                filename: 'test.xml',
+                service_name: 'MCT',
+                msg_name: 'pain.001',
+                signature_flag: false,
+                request_eds: true
+              )
+            end
+          end.to raise_error(ArgumentError, /request_eds/)
+        end
       end
     end
   end

data/spec/request_factory_spec.rb

@@ -439,6 +439,25 @@ RSpec.describe 'RequestFactory' do
         params = xml.at('//BTUOrderParams')
         expect(params['fileName']).to eq('custom.xml')
       end
+
+      it 'create_xe2 without override has SignatureFlag without requestEDS' do
+        xml = parse(factory.create_xe2(digest, transaction_key))
+        params = xml.at('//BTUOrderParams')
+        expect(params.at('SignatureFlag')).not_to be_nil
+        expect(params.at('SignatureFlag')['requestEDS']).to be_nil
+      end
+
+      it 'create_xe2 accepts request_eds override' do
+        xml = parse(factory.create_xe2(digest, transaction_key, request_eds: true))
+        params = xml.at('//BTUOrderParams')
+        expect(params.at('SignatureFlag')['requestEDS']).to eq('true')
+      end
+
+      it 'create_xe2 accepts signature_flag override' do
+        xml = parse(factory.create_xe2(digest, transaction_key, signature_flag: false))
+        params = xml.at('//BTUOrderParams')
+        expect(params.at('SignatureFlag')).to be_nil
+      end
     end
   end
 end

data/spec/support/ebics_shared_examples.rb

@@ -469,6 +469,10 @@ RSpec.shared_examples 'a valid ebicsRequest H005 upload' do |service_name:, msg_
     expect(service.at_xpath('e:MsgName', ns).text).to eq(msg_name)
   end
 
+  it 'has SignatureFlag' do
+    expect(xml.at_xpath('//e:header/e:static/e:OrderDetails/e:BTUOrderParams/e:SignatureFlag', ns)).not_to be_nil
+  end
+
   if scope
     it "has Scope #{scope}" do
       service = xml.at_xpath('//e:header/e:static/e:OrderDetails/e:BTUOrderParams/e:Service', ns)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: epics
 version: !ruby/object:Gem::Version
-  version: 3.0.0.rc2
+  version: 3.0.0
 platform: ruby
 authors:
 - Lars Brillert