pki_express 1.0.0

data/lib/pki_express/pades_visual_manual_positioning.rb

@@ -0,0 +1,17 @@
+module PkiExpress
+  class PadesVisualManualPositioning < PadesVisualPositioning
+    attr_accessor :signature_rectangle
+
+    def initialize(page_number=nil, measurement_units=nil, signature_rectangle=nil)
+      super(page_number, measurement_units)
+      @signature_rectangle = signature_rectangle
+    end
+
+    def to_model
+      model = super
+      model['manual'] = @signature_rectangle&.to_model
+      model
+    end
+
+  end
+end

data/lib/pki_express/pades_visual_positioning.rb

@@ -0,0 +1,28 @@
+module PkiExpress
+  class PadesVisualPositioning
+    attr_reader :measurement_units
+    attr_accessor :page_number, :page_optimization
+
+    def initialize(page_number=nil, measurement_units=nil)
+      @page_number = page_number
+      @measurement_units = measurement_units
+      @page_optimization = nil
+    end
+
+    def measurement_units=(value)
+      unless PadesMeasurementUnits.contains?(value)
+        raise 'The provided "measurement_units" is not valid. Try using PadesMeasurementUnits constants'
+      end
+
+      @measurement_units = value
+    end
+
+    def to_model
+      {
+          'pageNumber': @page_number,
+          'measurementUnits': @measurement_units,
+          'pageOptimization': @page_optimization&.to_model
+      }
+    end
+  end
+end

data/lib/pki_express/pades_visual_rectangle.rb

@@ -0,0 +1,74 @@
+module PkiExpress
+  class PadesVisualRectangle
+    attr_accessor :left, :top, :right, :bottom, :width, :height
+
+    def initialize
+      @left = nil
+      @top = nil
+      @right = nil
+      @bottom = nil
+      @width = nil
+      @height = nil
+    end
+
+    def set_width_centered(width)
+      @width = width
+      @left = nil
+      @right = nil
+    end
+
+    def set_width_left_anchored(width, left)
+      @width = width
+      @left = left
+      @right = nil
+    end
+
+    def set_width_right_anchored(width, right)
+      @width = width
+      @left = nil
+      @right = right
+    end
+
+    def set_horizontal_stretch(left, right)
+      @width = nil
+      @left = left
+      @right = right
+    end
+
+    def set_height_centered(height)
+      @height = height
+      @top = nil
+      @bottom = nil
+    end
+
+    def set_height_top_anchored(height, top)
+      @height = height
+      @top = top
+      @bottom = nil
+    end
+
+    def set_height_bottom_anchored(height, bottom)
+      @height = height
+      @top = nil
+      @bottom = bottom
+    end
+
+    def set_vertical_stretch(top, bottom)
+      @height = nil
+      @top = top
+      @bottom = bottom
+    end
+
+    def to_model
+      {
+          left: @left,
+          top: @top,
+          right: @right,
+          bottom: @bottom,
+          width: @width,
+          height: @height,
+      }
+    end
+
+  end
+end

data/lib/pki_express/pades_visual_representation.rb

@@ -0,0 +1,22 @@
+module PkiExpress
+  class PadesVisualRepresentation
+    attr_accessor :text, :image, :position
+
+    def initialize(text=nil, image=nil, position=nil)
+      @text = text
+      @image = image
+      @position = position
+    end
+
+    def to_model
+      unless @position
+        raise new 'The visual representation position was not set'
+      end
+      {
+          position: @position&.to_model,
+          text: @text&.to_model,
+          image: @image&.to_model,
+      }
+    end
+  end
+end

data/lib/pki_express/pades_visual_text.rb

@@ -0,0 +1,35 @@
+module PkiExpress
+  class PadesVisualText
+    attr_reader :horizontal_align
+    attr_accessor :text, :include_signing_time, :font_size,
+                  :container, :signing_time_format
+
+    def initialize(text=nil, include_signing_time=nil, font_size=nil)
+      @horizontal_align = :left
+      @text = text
+      @include_signing_time = include_signing_time
+      @font_size = font_size
+      @container = nil
+      @signing_time_format = nil
+    end
+
+    def horizontal_align=(value)
+      unless PadesTextHorizontalAlign.contains?(value)
+        raise 'The provided "horizontal_align" is not valid. Try using PadesTextHorizontalAlign constants'
+      end
+
+      @horizontal_align = value
+    end
+
+    def to_model
+      {
+          'fontSize': @font_size,
+          'text': @text,
+          'includeSigningTime': @include_signing_time,
+          'signingTimeFormat': @signing_time_format,
+          'container': @container&.to_model,
+          'horizontalAlign': @horizontal_align
+      }
+    end
+  end
+end

data/lib/pki_express/pk_certificate.rb

@@ -0,0 +1,62 @@
+module PkiExpress
+
+  class PKCertificate
+
+    attr_accessor :subject_name, :email_address, :issuer_name, :serial_number,
+                  :validity_start, :validity_end, :pki_brazil, :pki_italy,
+                  :issuer, :binary_thumbprint_sha256, :thumbprint
+
+    def initialize(model)
+      @subject_name = nil
+      @email_address = nil
+      @issuer_name = nil
+      @serial_number = nil
+      @validity_start = nil
+      @validity_end = nil
+      @pki_brazil = nil
+      @pki_italy = nil
+      @issuer = nil
+      @binary_thumbprint_sha256 = nil
+      @thumbprint = nil
+
+      unless model.nil?
+        @email_address = model.fetch(:emailAddress)
+        @serial_number = model.fetch(:serialNumber)
+        @validity_start = model.fetch(:validityStart)
+        @validity_end = model.fetch(:validityEnd)
+        @thumbprint = model.fetch(:thumbprint)
+
+        subject_name = model.fetch(:subjectName)
+        if subject_name
+          @subject_name = Name.new(subject_name)
+        end
+
+        issuer_name = model.fetch(:issuerName)
+        if issuer_name
+          @issuer_name = Name.new(issuer_name)
+        end
+
+        pki_brazil = model.fetch(:pkiBrazil)
+        if pki_brazil
+          @pki_brazil = PkiBrazilCertificateFields.new(pki_brazil)
+        end
+
+        pki_italy = model.fetch(:pkiItaly)
+        if pki_italy
+          @pki_italy = PkiItalyCertificateFields.new(pki_italy)
+        end
+
+        issuer = model.fetch(:issuer)
+        if issuer
+          @issuer = PKCertificate.new(issuer)
+        end
+
+        binary_thumbprint_sha256 = model.fetch(:binaryThumbprintSHA256)
+        if binary_thumbprint_sha256
+          @binary_thumbprint_sha256 = Base64.decode64(binary_thumbprint_sha256)
+        end
+      end
+    end
+  end
+
+end

data/lib/pki_express/pki_brazil_certificate_fields.rb

@@ -0,0 +1,58 @@
+module PkiExpress
+
+  class PkiBrazilCertificateFields
+
+    attr_accessor :rg_emissor_uf, :cnpj, :rg_numero, :oab_numero, :company_name,
+                  :rg_emissor, :certificate_type, :cpf, :responsavel,
+                  :date_of_birth, :oab_uf
+
+    def initialize(model)
+      @certificate_type = nil
+      @cpf = nil
+      @cnpj = nil
+      @responsavel = nil
+      @date_of_birth = nil
+      @company_name = nil
+      @rg_numero = nil
+      @rg_emissor = nil
+      @rg_emissor_uf = nil
+      @oab_numero = nil
+      @oab_uf = nil
+
+      unless model.nil?
+        @certificate_type = model.fetch(:certificateType)
+        @cpf = model.fetch(:cpf)
+        @cnpj = model.fetch(:cnpj)
+        @responsavel = model.fetch(:responsavel)
+        @date_of_birth = model.fetch(:dateOfBirth)
+        @company_name = model.fetch(:companyName)
+        @rg_numero = model.fetch(:rgNumero)
+        @rg_emissor = model.fetch(:rgEmissor)
+        @rg_emissor_uf = model.fetch(:rgEmissorUF)
+        @oab_numero = model.fetch(:oabNumero)
+        @oab_uf = model.fetch(:oabUF)
+      end
+    end
+
+    def cpf_formatted
+      unless @cpf
+        return nil
+      end
+      unless /^\d{11}$/.match(@cpf)
+        return @cpf
+      end
+      "#{@cpf[0..2]}.#{@cpf[3..5]}.#{@cpf[6..8]}-#{@cpf[9..-1]}"
+    end
+
+    def cnpj_formatted
+      unless @cnpj
+        return nil
+      end
+      unless /^\d{14}$/.match(@cnpj)
+        return @cnpj
+      end
+      "#{@cnpj[0..1]}.#{@cnpj[2..4]}.#{@cnpj[5..7]}/#{@cnpj[8..11]}-#{@cnpj[12..-1]}"
+    end
+  end
+
+end

data/lib/pki_express/pki_brazil_certificate_types.rb

@@ -0,0 +1,19 @@
+module PkiExpress
+  class PkiBrazilCertificateTypes < Enum
+    UNKNOWN = 'Unknown'
+    A1 = 'A1'
+    A2 = 'A2'
+    A3 = 'A3'
+    A4 = 'A4'
+    S1 = 'S1'
+    S2 = 'S2'
+    S3 = 'S3'
+    S4 = 'S4'
+    T3 = 'T3'
+    T4 = 'T4'
+
+    VALUES = [
+        UNKNOWN, A1, A2, A3, A4, S1, S2, S3, S4, T3, T4
+    ]
+  end
+end

data/lib/pki_express/pki_express_config.rb

@@ -0,0 +1,26 @@
+module PkiExpress
+
+  class PkiExpressConfig
+    attr_accessor :pki_express_home, :temp_folder, :transfer_data_folder
+    @@single_temp_folder = nil
+
+    def initialize(pki_express_home = nil, temp_folder = nil, transfer_data_folder = nil)
+      if not temp_folder.nil? and Pathname.exist?(temp_folder)
+        @temp_folder = temp_folder
+      else
+        if @@single_temp_folder.nil?
+          @@single_temp_folder = Dir.mktmpdir('pkie')
+        end
+        @temp_folder = @@single_temp_folder
+      end
+
+      if not transfer_data_folder.nil? and Pathname.exist?(transfer_data_folder)
+        @transfer_data_folder = transfer_data_folder
+      else
+        @transfer_data_folder = @temp_folder
+      end
+
+      @pki_express_home = pki_express_home
+    end
+  end
+end

data/lib/pki_express/pki_express_operator.rb

@@ -0,0 +1,216 @@
+require 'shellwords'
+require 'open3'
+
+module PkiExpress
+
+  class PkiExpressOperator
+    attr_accessor :offline, :trust_lacuna_test_root, :signature_policy,
+                  :timestamp_authority
+
+    def initialize(config = PkiExpressConfig.new)
+      @temp_files = []
+      @file_references = {}
+
+      @config = config
+      @version_manager = VersionManager.new
+      @trusted_roots = []
+      @offline = false
+      @trust_lacuna_test_root = false
+      @signature_policy = nil
+      @timestamp_authority = nil
+
+      ObjectSpace.define_finalizer(self, self.class.method(:finalize))
+    end
+
+    def self.finalize
+      @temp_files.each do |file|
+        File.delete(file) if File.exist?(file)
+      end
+    end
+
+    def add_file_reference(key, reference_path)
+
+      if reference_path.nil?
+        raise ArgumentError.new('The provided reference path is not valid')
+      end
+
+      unless File.exists?(reference_path)
+        raise ArgumentError.new('The provided reference file was not found')
+      end
+
+      @file_references[key] = reference_path
+    end
+
+    def add_trusted_root(root_path)
+
+      if root_path.nil?
+        raise ArgumentError.new('The provided trusted root path is not valid')
+      end
+
+      unless File.exists?(root_path)
+        raise ArgumentError.new("The provided trusted root path doesn't exist: #{root_path}")
+      end
+
+      @trusted_roots.append(root_path)
+    end
+
+    protected
+    def invoke_plain(command, args = [])
+      invoke(command, args, true)
+    end
+
+    def invoke(command, args = [], plain_output = false)
+
+      # Add PKI Express invocation arguments.
+      cmd_args = []
+      get_pki_express_invocation.each do |arg|
+        cmd_args.append(arg)
+      end
+
+      # Add PKI Express command.
+      cmd_args.append(command)
+
+      # Add PKI Express arguments.
+      cmd_args.concat args
+
+      # Add file references if added.
+      unless @file_references.nil?
+        @file_references.each do |key, value|
+          cmd_args.append('--file_reference')
+          cmd_args.append("#{key}=#{value}")
+        end
+      end
+
+      # Add trusted roots if added.
+      unless @trusted_roots.nil?
+        @trusted_roots.each do |trusted_root|
+          cmd_args.append('--trust-root')
+          cmd_args.append(trusted_root)
+        end
+      end
+
+      # Add trust Lacuna test root if set.
+      if @trust_lacuna_test_root
+        cmd_args.append('--trust-test')
+      end
+
+      # Add offline option if provided.
+      if @offline
+        cmd_args.append('--offline')
+        # This option can only be used on versions greater than 1.2 of the
+        # PKI Express.
+        @version_manager.require_version('1.2')
+      end
+
+      # Add base64 output option
+      unless plain_output
+        cmd_args.append('--base64')
+      end
+
+      # Verify the necessity of using the --min-version flag.
+      if @version_manager.require_min_version_flag?
+        cmd_args.append('--min-version')
+        cmd_args.append(@version_manager.min_version.to_s)
+      end
+
+      # Escape command args
+      escaped = []
+      cmd_args.each do |arg|
+        escaped.append("\"#{arg}\"")
+        # escaped.append(Shellwords.escape(arg))
+      end
+
+      # Perform the "dotnet" command.
+      stdout, _stderr, status = Open3.capture3(escaped.join(' '))
+
+      if status != 0
+        if status === ErrorCodes::BAD_SYNTAX and @version_manager.min_version > '1.0'
+          raise CommandError.new(status, "#{stdout}  >>>>> TIP: This operation requires PKI Express #{@version_manager.min_version}, please check your PKI Express version.")
+        end
+        if status === ErrorCodes::VALIDATION_FAILED
+          raise ValidationError.new(stdout)
+        end
+        if status === ErrorCodes::COMMAND_NOT_FOUND
+          raise InstallationNotFoundError.new("Could not find PKI Express's installation.")
+        end
+
+        raise CommandError.new(status, stdout)
+      end
+
+      # Return stdout if the command executed with success.
+      stdout
+    end
+
+    def get_pki_express_invocation
+
+      # Identify OS.
+      if (/linux/ =~ RUBY_PLATFORM) != nil
+        system = :linux
+      elsif (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
+        system = :win
+      else
+        raise Error.new("Unsupported OS: #{RUBY_PLATFORM}")
+      end
+
+      # Verify if hte PKI Express home is set on configuration
+      home = @config.pki_express_home
+      if not home.nil?
+
+        if system == :linux
+          unless File.exists?(File.expand_path('pkie.dll', home))
+            raise InstallationNotFoundError.new("The file pkie.dll could not be found on directory #{home}")
+          end
+        elsif not File.exists?(File.expand_path('pkie.exe', home))
+          raise InstallationNotFoundError.new("The file pkie.exe could not be found on directory #{home}")
+        end
+
+      elsif system == :win
+
+        if File.exists?(File.join(ENV['ProgramW6432'], 'Lacuna Software', 'PKI Express', 'pkie.exe'))
+          home = File.join(ENV['ProgramW6432'], 'Lacuna Software', 'PKI Express')
+        elsif File.exists?(File.join(ENV['ProgramFiles(x86)'], 'Lacuna Software', 'PKI Express', 'pkie.exe'))
+          home = File.join(ENV['ProgramFiles(x86)'], 'Lacuna Software', 'PKI Express')
+        elsif File.exists?(File.join(ENV['LOCALAPPDATA'], 'Lacuna Software', 'PKI Express', 'pkie.exe'))
+          home = File.join(ENV['LOCALAPPDATA'], 'Lacuna Software', 'PKI Express')
+        elsif File.exists?(File.join(ENV['LOCALAPPDATA'], 'Lacuna Software (x86)', 'PKI Express', 'pkie.exe'))
+          home = File.join(ENV['LOCALAPPDATA'], 'Lacuna Software (x86)', 'PKI Express')
+        end
+
+        if home.nil?
+          raise InstallationNotFoundError.new('Could not determine the
+            installation folder of PKI Express. If you installed PKI Express on
+            a custom folder, make sure your chosen folder are specified on the
+            PkiExpressConfig object.')
+        end
+      end
+
+      if system == :linux
+        unless home.nil?
+          return ['dotnet', File.expand_path('pkie.dll', home)]
+        end
+
+        return ['pkie']
+      end
+      [File.expand_path('pkie.exe', home)]
+    end
+
+    def parse_output(data_base64)
+      json_buff = Base64.decode64(data_base64)
+      JSON.parse(json_buff, symbolize_names: true)
+    end
+
+    def create_temp_file
+      file = Tempfile.new('pkie', @config.temp_folder)
+      temp_path = file.path
+      file.close
+      @temp_files.append(temp_path)
+      temp_path
+    end
+
+    def get_transfer_filename
+      # Generate 16 random bytes. Return a string containing the hex decimals of
+      # this array.
+      SecureRandom.hex(16)
+    end
+  end
+end