liberic 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e7deb7e6297685fa161f7503076497a044838f97a7eb7cc0152e4569919217e
-  data.tar.gz: 5be4c0aa504af885535e022ea797fadafbba322da364ad49bb79f2aa37096489
+  metadata.gz: 036f583f24d5fee5d7347517bd3a2424c6155ff9a4fecc6f8241e6cc7710570a
+  data.tar.gz: e6d5801322f6e2a06dee3d72ffebf2455114c29722de46e89dce242c87c60695
 SHA512:
-  metadata.gz: 127d45ca76db8a8a5478836983762aa7acf69aeee68a2e37a660c3d4c8eae95de1dae6a14375805bfae35ff6e9f9d3c03fe341c31e37e70bda4571b2a75c68d7
-  data.tar.gz: 51a34f281440d87d4e7863b057fc472f41293c7b80311780d691dd6bcb44891107ae2ad4bb521e9b52d23cbbf0ccc218b5262dfbfae61edac24f60f8f692f0e8
+  metadata.gz: ab255189575cf06a9a5f391a270de090db67e342c745f493c10c40ce2afad633faf5e3cd700d04ed6fa8070cd7b19171c31d1ca8163d28b9bf227733ba893c2f
+  data.tar.gz: 4f0cca686bf98eb4e82dcce6bda52f2fc7b99dbdcbf7e137eb78c82d186014d22bbcd06cc293478efb46ad17b60f6e7429dcbfa13e96f8442caa28d24a52c67a

data/CHANGELOG.md

@@ -5,6 +5,38 @@ 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.3.0]
+
+Support for ERIC 40.
+
+### Deprecated
+
+These features were removed from the ERIC SDK.
+
+- `abrufCode` in `encryption_params`
+- `cover_page` (`ersteSeite`) in `print_params`
+
+## [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

@@ -40,15 +40,21 @@ include/
 lib/
 ```
 
-Currently, the environment variable `ERIC_HOME_39` needs to be set to this
+Currently, the environment variable `ERIC_HOME_40` needs to be set to this
 folder or the gem will not find the library files.
 
 For example:
 
 ```sh
-$ export ERIC_HOME_39=/opt/ERiC-39.3.2.0/Linux-x86_64
+$ export ERIC_HOME_40=/opt/ERiC-40.3.4.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/boot.rb

@@ -19,7 +19,7 @@ module Liberic
     File.expand_path("libericapi.#{suffix}", ERIC_LIB_FOLDER)
   end
 
-  ERIC_HOME = ENV['ERIC_HOME_39'] || raise(InitializationError.new('ERIC_HOME_39 environment variable not found (set it to the path to the ERiC libraries)'))
+  ERIC_HOME = ENV['ERIC_HOME_40'] || raise(InitializationError.new('ERIC_HOME_40 environment variable not found (set it to the path to the ERiC libraries)'))
   ERIC_LIB_FOLDER = File.expand_path('lib', ERIC_HOME)
 
   def check_eric_version!

data/lib/liberic/certificate.rb

@@ -0,0 +1,68 @@
+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] = 3
+      params[:zertifikatHandle] = @handle
+      params[:pin] = FFI::MemoryPointer.from_string(@pin).address
+
+      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

@@ -37,7 +37,6 @@ module Liberic
     #   * +:filename+     (set a filename including path where to store the PDF file)
     #   * +:draft+        (set to +false+ to remove the the text "*** ENTWURF ***" on every page)
     #   * +:footer+       (set a string that will be printed on ever page footer)
-    #   * +:cover_page+   (set to +true+ to include a cover page)
     #   * +:duplex+       (set to +true+ to generate pages for duplex printing (alternating margin left and right)
     #
     # Other options
@@ -59,6 +58,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 +66,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,10 +89,10 @@ 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
-      params[:ersteSeite]  = options[:cover_page] ? 1 : 0
+      params[:version]     = 4
       params[:duplexDruck] = options[:duplex] ? 1 : 0
       params[:vorschau]    = options.has_key?(:draft) ? (options[:draft] ? 1 : 0) : 1
       {pdfName: :filename,

data/lib/liberic/sdk/types.rb

@@ -4,9 +4,8 @@ module Liberic
       extend FFI::Library
 
       class DruckParameter < FFI::Struct
-        layout :version,     :uint, # Set version to 2
+        layout :version,     :uint, # Set version to 4
                :vorschau,    :uint,
-               :ersteSeite,  :uint,
                :duplexDruck, :uint,
                :pdfName,     :pointer,
                :fussText,    :pointer,
@@ -14,10 +13,9 @@ module Liberic
       end
 
       class VerschluesselungsParameter < FFI::Struct
-        layout :version,     :uint, # Set version to 2
+        layout :version,     :uint, # Set version to 3
                :zertifikatHandle, :uint,
-               :pin,         :pointer,
-               :abrufCode,   :pointer
+               :pin,         :pointer
       end
 
       class ZertifikatParameter < FFI::Struct
@@ -33,9 +31,11 @@ module Liberic
       end
 
       BearbeitungFlag = enum(
-        :validiere, (1 << 1),
-        :sende,     (1 << 2),
-        :drucke,    (1 << 5),
+        :validiere,                       (1 << 1),
+        :sende,                           (1 << 2),
+        :drucke,                          (1 << 5),
+        :pruefe_hinweise,                 (1 << 7),
+        :validiere_ohne_freigabedatum,    (1 << 8),
         :sende_auth,  ('00100110'.to_i(2)) # triggers all three: valiediere, sende and drucke
       )
 

data/lib/liberic/version.rb

@@ -1,3 +1,3 @@
 module Liberic
-  VERSION = '1.1.0'
+  VERSION = '1.3.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.3.0
 platform: ruby
 authors:
 - Malte Münchert
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-20 00:00:00.000000000 Z
+date: 2024-11-19 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
@@ -123,7 +124,7 @@ homepage: https://www.github.com/mpm/liberic-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -139,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Ruby bindings for ELSTER/ERiC (German Tax Authority Service)
 test_files: []