liberic 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e7deb7e6297685fa161f7503076497a044838f97a7eb7cc0152e4569919217e
-  data.tar.gz: 5be4c0aa504af885535e022ea797fadafbba322da364ad49bb79f2aa37096489
+  metadata.gz: 6348962b78e06d7c6d3bcbf5a88dc4769bff77e8ce5fb58b7abb6d5bc9f6e798
+  data.tar.gz: c392458f17282493fb5ac485c9d53e429f35a913589ad45431c4504b3c61e215
 SHA512:
-  metadata.gz: 127d45ca76db8a8a5478836983762aa7acf69aeee68a2e37a660c3d4c8eae95de1dae6a14375805bfae35ff6e9f9d3c03fe341c31e37e70bda4571b2a75c68d7
-  data.tar.gz: 51a34f281440d87d4e7863b057fc472f41293c7b80311780d691dd6bcb44891107ae2ad4bb521e9b52d23cbbf0ccc218b5262dfbfae61edac24f60f8f692f0e8
+  metadata.gz: 702ca9b85f8078adf43b4e93d5985ee3101a7aee90f46133b3355ddc528567836aab7a33722e887c7e38346a2016c175d6e9df9b4faeb1ae34d7373b2b9ffd72
+  data.tar.gz: 35039a0225ef54ec6e5d6730f798e3702d7bb8f6fdcedfdb0bf70fd18b41178212a3b56318fb42132f5792622775bd7ebd6642e9534b967fbb01c93a8b2ff8e5

data/CHANGELOG.md

@@ -5,6 +5,27 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.2.0]
+
+Add support to sign a submission with a POZ (Portalzertifikat)
+
+Usage:
+
+```ruby
+# Uses the example Einkommensteuer & Zertifikat that comes with the ERIC SDK
+tax_filing = File.read(File.expand_path('Beispiel/ericdemo-java/ESt_2020.xml', Liberic.eric_home))
+cert_path = File.expand_path('Beispiel/ericdemo-java/test-softidnr-pse.pfx', Liberic.eric_home)
+cert = Liberic::Certificate.new(cert_path, '123456')
+
+submission = Liberic::Process.new(tax_filing, 'ESt_2020')
+result = submission.execute({action: :submit, encryption: cert.encryption_params})
+cert.release_handle!
+```
+
+### Added
+
+- Added `Liberic::Certificate` class
+
 ## [1.1.0]
 
 Eric now requires a call to an initialization function. This happens

data/README.md

@@ -49,6 +49,12 @@ For example:
 $ export ERIC_HOME_39=/opt/ERiC-39.3.2.0/Linux-x86_64
 ```
 
+The gem will raise an `Liberic::InitializationError` if the environment variable is not set.
+In a Rails project this can interfere with running rake (for example
+when building the app in Docker). In this case, use `gem 'liberic', require: false` in your `Gemfile`.
+And require the gem later in your Rails code (for example a model) by
+calling `require 'liberic'`.
+
 ### Additional steps on OS X
 
 The following OS X specific information dates back to the first version of this

data/lib/liberic/certificate.rb

@@ -0,0 +1,69 @@
+module Liberic
+  # +Certificate+ encapsulates functionality regarding certificates (for signing).
+  # An instance of Certificate is passed on to +EricBearbeiteVorgang()+ where necessary.
+  class Certificate
+    attr_reader :features, :handle
+
+    # +cert_file+ path to a pfx file (Portal-Zertifikat)
+    # +pin+ the pin for the certificate (if applicable, string)
+    def initialize(cert_file, pin)
+      @pin = pin
+      ch = FFI::MemoryPointer.new(:uint32, 1)
+      cert_feature_flag_pointer = FFI::MemoryPointer.new(:uint32, 1)
+
+      Liberic::Helpers::Invocation.raise_on_error(
+        Liberic::SDK::API.get_handle_to_certificate(ch, cert_feature_flag_pointer, cert_file)
+      )
+
+      @handle = ch.get_uint32(0)
+
+      flags = cert_feature_flag_pointer.get_uint32(0)
+      @features = PinFeatures.new(
+        (flags & 0x00) != 0,
+        (flags & 0x01) != 0,
+        (flags & 0x02) != 0,
+        (flags & 0x04) != 0,
+        (flags & 0x10) != 0,
+        (flags & 0x20) != 0,
+        (flags & 0x40) != 0,
+        (flags & 0x80) != 0
+      )
+    end
+
+    # Returns the result of +EricHoleZertifikatEigenschaften()+
+    # This will be XML describing fields and properties associated with the certificate.
+    def properties
+      Helpers::Invocation.with_result_buffer do |buffer_handle|
+        SDK::API.hole_zertifikat_eigenschaften(@handle, @pin, buffer_handle)
+      end
+    end
+
+    # Returns a +SDK::Types::VerschluesselungsParameter+ data structure that can be passed on to
+    # Process.execute
+    def encryption_params
+      params = SDK::Types::VerschluesselungsParameter.new
+
+      params[:version] = 2
+      params[:zertifikatHandle] = @handle
+      params[:pin] = FFI::MemoryPointer.from_string(@pin).address
+      params[:abrufCode] = nil
+
+      params
+    end
+
+    def release_handle!
+      SDK::API.close_handle_to_certificate(@handle)
+    end
+  end
+
+  PinFeatures = Struct.new(
+    :no_pin,
+    :requires_pin_for_signature,
+    :requires_pin_for_decryption,
+    :requires_pin_for_cert_decryption,
+    :supports_pin_check,
+    :supports_last_attempt_failed,
+    :supports_pin_lock_on_next_fail,
+    :supports_pin_is_locked
+  )
+end

data/lib/liberic/process.rb

@@ -59,6 +59,7 @@ module Liberic
     def execute(options = {})
       action = options[:action] ||= :validate
       eric_action = ACTIONS[action] || (raise ExecutionError.new("Invalid action: #{action}. Valid actions are #{ACTIONS.keys.join(', ')}"))
+      is_printing = %w[submit print_and_submit print_and_submit_auth].include?(action.to_s)
       print_params = create_print_params(options)
       server_buffer = SDK::API.rueckgabepuffer_erzeugen
       result = Helpers::Invocation.with_result_buffer(false) do |local_buffer|
@@ -66,7 +67,7 @@ module Liberic
           eric_action,
           (action == :submit ? nil : print_params),
           options[:encryption],
-          (action == :submit ? FFI::MemoryPointer.new(:uint32, 1) : nil), # transferHandle
+          (is_printing ? FFI::MemoryPointer.new(:uint32, 1) : nil), # transferHandle
           local_buffer,
           server_buffer)
       end
@@ -89,6 +90,7 @@ module Liberic
       print_and_submit_auth: :sende_auth
     }
 
+    # TODO: check for updates regarding version
     def create_print_params(options)
       params = SDK::Types::DruckParameter.new
       params[:version]     = 2

data/lib/liberic/version.rb

@@ -1,3 +1,3 @@
 module Liberic
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/lib/liberic.rb

@@ -3,6 +3,7 @@ require 'nokogiri'
 require 'logger'
 require 'liberic/version'
 require 'liberic/boot'
+require 'liberic/certificate'
 require 'liberic/helpers'
 require 'liberic/response'
 require 'liberic/sdk'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: liberic
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Malte Münchert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-20 00:00:00.000000000 Z
+date: 2024-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -104,6 +104,7 @@ files:
 - examples/submit_ekst.rb
 - lib/liberic.rb
 - lib/liberic/boot.rb
+- lib/liberic/certificate.rb
 - lib/liberic/config.rb
 - lib/liberic/helpers.rb
 - lib/liberic/helpers/invocation.rb