pki_express 1.3.0 → 1.3.2

data/lib/pki_express/signature_start_result.rb

@@ -1,13 +1,13 @@
-module PkiExpress
-  class SignatureStartResult
-    attr_accessor :to_sign_hash, :digest_algorithm_name, :digest_algorithm_oid,
-                  :transfer_file_id
-
-    def initialize(model, transfer_file_id)
-      @to_sign_hash = model.fetch(:toSignHash)
-      @digest_algorithm_name = model.fetch(:digestAlgorithmName)
-      @digest_algorithm_oid = model.fetch(:digestAlgorithmOid)
-      @transfer_file_id = transfer_file_id
-    end
-  end
+module PkiExpress
+  class SignatureStartResult
+    attr_accessor :to_sign_hash, :digest_algorithm_name, :digest_algorithm_oid,
+                  :transfer_file_id
+
+    def initialize(model, transfer_file_id)
+      @to_sign_hash = model.fetch(:toSignHash)
+      @digest_algorithm_name = model.fetch(:digestAlgorithmName)
+      @digest_algorithm_oid = model.fetch(:digestAlgorithmOid)
+      @transfer_file_id = transfer_file_id
+    end
+  end
 end

data/lib/pki_express/signature_starter.rb

@@ -1,116 +1,116 @@
-module PkiExpress
-
-  class SignatureStarter < BaseSigner
-
-    def initialize(config=PkiExpressConfig.new)
-      super(config)
-      @certificate_path = nil
-    end
-
-    # region The "certificate" accessors
-
-    def certificate
-      _get_certificate
-    end
-
-    def _get_certificate
-      unless @certificate_path
-        return nil
-      end
-
-      File.read(@certificate_path)
-    end
-    private :_get_certificate
-
-    def certificate=(content_raw)
-      _set_certificate(content_raw)
-    end
-
-    def _set_certificate(content_raw)
-      unless content_raw
-        raise 'The provided "certificate" is not valid'
-      end
-
-      temp_file_path = self.create_temp_file
-      File.open(temp_file_path, 'wb') do |f|
-        f.write(content_raw)
-      end
-      @certificate_path = temp_file_path
-    end
-    private :_set_certificate
-
-    def certificate_base64
-      _get_certificate_base64
-    end
-
-    def _get_certificate_base64
-      unless @certificate_path
-        return nil
-      end
-
-      content = File.read(@certificate_path)
-      Base64.encode64(content)
-    end
-    private :_get_certificate_base64
-
-    def certificate_base64=(content_base64)
-      _set_certificate_base64(content_base64)
-    end
-
-    def _set_certificate_base64(content_base64)
-      unless content_base64
-        raise 'The provided "certificate_base64" is not valid'
-      end
-
-      begin
-        content_raw = Base64.decode64(content_base64)
-      rescue Error
-        raise 'The provided "certificate_base64" is not Base64-encoded'
-      end
-
-      _set_certificate(content_raw)
-    end
-    private :_set_certificate_base64
-
-    def certificate_path
-      _get_certificate_path
-    end
-
-    def _get_certificate_path
-      @certificate_path
-    end
-    private :_get_certificate_path
-
-    def certificate_path=(path)
-      _set_certificate_path(path)
-    end
-
-    def _set_certificate_path(path)
-      unless path
-        raise 'The provided "certificate_path" is not valid'
-      end
-      unless File.exists?(path)
-        raise 'The provided "certificate_path" does not exist'
-      end
-
-      @certificate_path = path
-    end
-    private :_set_certificate_path
-
-    # endregion
-
-    def self.get_result(response, transfer_file)
-      {
-          toSignHash: response[0],
-          digestAlgorithmName: response[1],
-          digestAlgorithmOid: response[2],
-          transferFile: transfer_file
-      }
-    end
-
-    def start
-      raise NotImplementedError.new('This method is not implemented')
-    end
-  end
-
-end
+module PkiExpress
+
+  class SignatureStarter < BaseSigner
+
+    def initialize(config=PkiExpressConfig.new)
+      super(config)
+      @certificate_path = nil
+    end
+
+    # region The "certificate" accessors
+
+    def certificate
+      _get_certificate
+    end
+
+    def _get_certificate
+      unless @certificate_path
+        return nil
+      end
+
+      File.read(@certificate_path)
+    end
+    private :_get_certificate
+
+    def certificate=(content_raw)
+      _set_certificate(content_raw)
+    end
+
+    def _set_certificate(content_raw)
+      unless content_raw
+        raise 'The provided "certificate" is not valid'
+      end
+
+      temp_file_path = self.create_temp_file
+      File.open(temp_file_path, 'wb') do |f|
+        f.write(content_raw)
+      end
+      @certificate_path = temp_file_path
+    end
+    private :_set_certificate
+
+    def certificate_base64
+      _get_certificate_base64
+    end
+
+    def _get_certificate_base64
+      unless @certificate_path
+        return nil
+      end
+
+      content = File.read(@certificate_path)
+      Base64.encode64(content)
+    end
+    private :_get_certificate_base64
+
+    def certificate_base64=(content_base64)
+      _set_certificate_base64(content_base64)
+    end
+
+    def _set_certificate_base64(content_base64)
+      unless content_base64
+        raise 'The provided "certificate_base64" is not valid'
+      end
+
+      begin
+        content_raw = Base64.decode64(content_base64)
+      rescue Error
+        raise 'The provided "certificate_base64" is not Base64-encoded'
+      end
+
+      _set_certificate(content_raw)
+    end
+    private :_set_certificate_base64
+
+    def certificate_path
+      _get_certificate_path
+    end
+
+    def _get_certificate_path
+      @certificate_path
+    end
+    private :_get_certificate_path
+
+    def certificate_path=(path)
+      _set_certificate_path(path)
+    end
+
+    def _set_certificate_path(path)
+      unless path
+        raise 'The provided "certificate_path" is not valid'
+      end
+      unless File.exists?(path)
+        raise 'The provided "certificate_path" does not exist'
+      end
+
+      @certificate_path = path
+    end
+    private :_set_certificate_path
+
+    # endregion
+
+    def self.get_result(response, transfer_file)
+      {
+          toSignHash: response[0],
+          digestAlgorithmName: response[1],
+          digestAlgorithmOid: response[2],
+          transferFile: transfer_file
+      }
+    end
+
+    def start
+      raise NotImplementedError.new('This method is not implemented')
+    end
+  end
+
+end

data/lib/pki_express/signer.rb

@@ -1,151 +1,151 @@
-module PkiExpress
-
-  class Signer < BaseSigner
-
-    attr_accessor :output_file_path, :cert_thumb, :cert_password, :trust_service_session
-
-    def initialize(config=PkiExpressConfig.new)
-      super(config)
-      @output_file_path = nil
-      @pkcs12_path = nil
-      @cert_thumb = nil
-      @cert_password = nil
-      @use_machine = false
-      @trust_service_session = nil
-    end
-
-    # region The "pkcs12" accessors
-
-    def pkcs12
-      _get_pkcs12
-    end
-
-    def _get_pkcs12
-      unless @pkcs12_path
-        return nil
-      end
-
-      File.read(@pkcs12_path)
-    end
-    private :_get_pkcs12
-
-    def pkcs12=(content_raw)
-      _set_pkcs12(content_raw)
-    end
-
-    def _set_pkcs12(content_raw)
-      unless content_raw
-        raise 'The provided "pkcs12" is not valid'
-      end
-
-      temp_file_path = self.create_temp_file
-      File.open(temp_file_path, 'wb') do |f|
-        f.write(content_raw)
-      end
-      @pkcs12_path = temp_file_path
-    end
-    private :_set_pkcs12
-
-    def pkcs12_base64
-      _get_pkcs12_base64
-    end
-
-    def _get_pkcs12_base64
-      unless @pkcs12_path
-        return nil
-      end
-
-      content = File.read(@pkcs12_path)
-      Base64.encode64(content)
-    end
-    private :_get_pkcs12_base64
-
-    def pkcs12_base64=(pkcs12_base64)
-      _set_pkcs12_base64(pkcs12_base64)
-    end
-
-    def _set_pkcs12_base64(pkcs12_base64)
-      unless pkcs12_base64
-        raise 'The provided "pkcs12_base64" is not valid'
-      end
-
-      begin
-        content_raw = Base64.decode64(pkcs12_base64)
-      rescue Error
-        raise 'The provided "pkcs12_base64" is not Base64-encoded'
-      end
-
-      _set_pkcs12(content_raw)
-    end
-    private :_set_pkcs12_base64
-
-    def pkcs12_path
-      _get_pkcs12_path
-    end
-
-    def _get_pkcs12_path
-      @pkcs12_path
-    end
-    private :_get_pkcs12_path
-
-    def pkcs12_path=(pkcs12_path)
-      _set_pkcs12_path(pkcs12_path)
-    end
-
-    def _set_pkcs12_path(pkcs12_path)
-      unless pkcs12_path
-        raise 'The provided "pkcs12_path" is not valid'
-      end
-      unless File.exists?(pkcs12_path)
-        raise 'The provided "pkcs12_path" does not exist'
-      end
-
-      @pkcs12_path = pkcs12_path
-    end
-    private :_set_pkcs12_path
-
-    # endregion
-
-    def verify_and_add_common_options(args)
-      # Verify and add common option between signers and signature starters.
-      super(args)
-
-      if !@cert_thumb && !@pkcs12_path && !@trust_service_session
-        raise 'Neither the PKCS #12 file, the certificate\'s thumbprint nor the trust service session was provided'
-      end
-
-      if @cert_thumb
-        args.append('--thumbprint')
-        args.append(@cert_thumb)
-        @version_manager.require_version('1.3')
-      end
-
-      if @pkcs12_path
-        args.append('--pkcs12')
-        args.append(@pkcs12_path)
-        @version_manager.require_version('1.3')
-      end
-
-      if @cert_password
-        args.append('--password')
-        args.append(@cert_password)
-        @version_manager.require_version('1.3')
-      end
-
-      if @use_machine
-        args.append('--machine')
-        @version_manager.require_version('1.3')
-      end
-
-      if @trust_service_session
-        args.append('--trust-service-session')
-        args.append(@trust_service_session)
-        # This option can only be used on versions greater than 1.18 of 
-        # the PKI Express.
-        @version_manager.require_version('1.18')
-      end
-    end
-    protected :verify_and_add_common_options
-  end
-
-end
+module PkiExpress
+
+  class Signer < BaseSigner
+
+    attr_accessor :output_file_path, :cert_thumb, :cert_password, :trust_service_session
+
+    def initialize(config=PkiExpressConfig.new)
+      super(config)
+      @output_file_path = nil
+      @pkcs12_path = nil
+      @cert_thumb = nil
+      @cert_password = nil
+      @use_machine = false
+      @trust_service_session = nil
+    end
+
+    # region The "pkcs12" accessors
+
+    def pkcs12
+      _get_pkcs12
+    end
+
+    def _get_pkcs12
+      unless @pkcs12_path
+        return nil
+      end
+
+      File.read(@pkcs12_path)
+    end
+    private :_get_pkcs12
+
+    def pkcs12=(content_raw)
+      _set_pkcs12(content_raw)
+    end
+
+    def _set_pkcs12(content_raw)
+      unless content_raw
+        raise 'The provided "pkcs12" is not valid'
+      end
+
+      temp_file_path = self.create_temp_file
+      File.open(temp_file_path, 'wb') do |f|
+        f.write(content_raw)
+      end
+      @pkcs12_path = temp_file_path
+    end
+    private :_set_pkcs12
+
+    def pkcs12_base64
+      _get_pkcs12_base64
+    end
+
+    def _get_pkcs12_base64
+      unless @pkcs12_path
+        return nil
+      end
+
+      content = File.read(@pkcs12_path)
+      Base64.encode64(content)
+    end
+    private :_get_pkcs12_base64
+
+    def pkcs12_base64=(pkcs12_base64)
+      _set_pkcs12_base64(pkcs12_base64)
+    end
+
+    def _set_pkcs12_base64(pkcs12_base64)
+      unless pkcs12_base64
+        raise 'The provided "pkcs12_base64" is not valid'
+      end
+
+      begin
+        content_raw = Base64.decode64(pkcs12_base64)
+      rescue Error
+        raise 'The provided "pkcs12_base64" is not Base64-encoded'
+      end
+
+      _set_pkcs12(content_raw)
+    end
+    private :_set_pkcs12_base64
+
+    def pkcs12_path
+      _get_pkcs12_path
+    end
+
+    def _get_pkcs12_path
+      @pkcs12_path
+    end
+    private :_get_pkcs12_path
+
+    def pkcs12_path=(pkcs12_path)
+      _set_pkcs12_path(pkcs12_path)
+    end
+
+    def _set_pkcs12_path(pkcs12_path)
+      unless pkcs12_path
+        raise 'The provided "pkcs12_path" is not valid'
+      end
+      unless File.exists?(pkcs12_path)
+        raise 'The provided "pkcs12_path" does not exist'
+      end
+
+      @pkcs12_path = pkcs12_path
+    end
+    private :_set_pkcs12_path
+
+    # endregion
+
+    def verify_and_add_common_options(args)
+      # Verify and add common option between signers and signature starters.
+      super(args)
+
+      if !@cert_thumb && !@pkcs12_path && !@trust_service_session
+        raise 'Neither the PKCS #12 file, the certificate\'s thumbprint nor the trust service session was provided'
+      end
+
+      if @cert_thumb
+        args.append('--thumbprint')
+        args.append(@cert_thumb)
+        @version_manager.require_version('1.3')
+      end
+
+      if @pkcs12_path
+        args.append('--pkcs12')
+        args.append(@pkcs12_path)
+        @version_manager.require_version('1.3')
+      end
+
+      if @cert_password
+        args.append('--password')
+        args.append(@cert_password)
+        @version_manager.require_version('1.3')
+      end
+
+      if @use_machine
+        args.append('--machine')
+        @version_manager.require_version('1.3')
+      end
+
+      if @trust_service_session
+        args.append('--trust-service-session')
+        args.append(@trust_service_session)
+        # This option can only be used on versions greater than 1.18 of 
+        # the PKI Express.
+        @version_manager.require_version('1.18')
+      end
+    end
+    protected :verify_and_add_common_options
+  end
+
+end

data/lib/pki_express/standard_signature_policies.rb

@@ -1,59 +1,59 @@
-module PkiExpress
-
-  class StandardSignaturePolicies < Enum
-    PKI_BRAZIL_CADES_ADR_BASICA = 'adrb'
-    PKI_BRAZIL_CADES_ADR_BASICA_WITH_REVOCATION_VALUE = 'adrb-rv'
-    PKI_BRAZIL_CADES_ADR_TEMPO = 'adrt'
-    PKI_BRAZIL_CADES_ADR_COMPLETA = 'adrc'
-    CADES_BES = 'cades'
-    CADES_BES_WITH_REVOCATION_VALUES = 'cades-rv'
-    CADES_T = 'cades-t'
-
-    PADES_BASIC = 'pades'
-    PADES_BASIC_WITH_LTV = 'pades-ltv'
-    PADES_T = 'pades-t'
-    PKI_BRAZIL_PADES_ADR_BASICA = 'pades-ltv'
-    PKI_BRAZIL_PADES_ADR_BASICA_WITH_LTV = 'adrb-ltv'
-    PKI_BRAZIL_PADES_ADR_TEMPO = 'adrt'
-
-    NFE_PADRAO_NACIONAL = 'nfe'
-    XADES_BES = 'xades'
-    XML_DSIG_BASIC = 'basic'
-    PKI_BRAZIL_XML_ADR_BASIC = 'adrb'
-    PKI_BRAZIL_XML_ADR_TEMPO = 'adrt'
-    COD_WITH_SHA1 = 'cod-sha1'
-    COD_WITH_SHA256 = 'cod-sha256'
-
-    VALUES = [
-        PKI_BRAZIL_CADES_ADR_BASICA,
-        PKI_BRAZIL_CADES_ADR_BASICA_WITH_REVOCATION_VALUE,
-        PKI_BRAZIL_CADES_ADR_TEMPO,
-        PKI_BRAZIL_CADES_ADR_COMPLETA,
-        CADES_BES,
-        CADES_BES_WITH_REVOCATION_VALUES,
-        CADES_T,
-        PADES_BASIC,
-        PADES_BASIC_WITH_LTV,
-        PADES_T,
-        PKI_BRAZIL_PADES_ADR_BASICA,
-        PKI_BRAZIL_PADES_ADR_BASICA_WITH_LTV,
-        PKI_BRAZIL_PADES_ADR_TEMPO,
-        NFE_PADRAO_NACIONAL,
-        XADES_BES,
-        XML_DSIG_BASIC,
-        PKI_BRAZIL_XML_ADR_BASIC,
-        PKI_BRAZIL_XML_ADR_TEMPO,
-        COD_WITH_SHA1,
-        COD_WITH_SHA256
-    ]
-
-    def self.require_timestamp(policy)
-      if policy.nil?
-        return false
-      end
-
-      return policy == PKI_BRAZIL_CADES_ADR_TEMPO || policy == PKI_BRAZIL_CADES_ADR_COMPLETA || policy == CADES_T || policy == PADES_T || policy == PKI_BRAZIL_PADES_ADR_TEMPO || policy == PKI_BRAZIL_XML_ADR_TEMPO
-    end
-  end
-
+module PkiExpress
+
+  class StandardSignaturePolicies < Enum
+    PKI_BRAZIL_CADES_ADR_BASICA = 'adrb'
+    PKI_BRAZIL_CADES_ADR_BASICA_WITH_REVOCATION_VALUE = 'adrb-rv'
+    PKI_BRAZIL_CADES_ADR_TEMPO = 'adrt'
+    PKI_BRAZIL_CADES_ADR_COMPLETA = 'adrc'
+    CADES_BES = 'cades'
+    CADES_BES_WITH_REVOCATION_VALUES = 'cades-rv'
+    CADES_T = 'cades-t'
+
+    PADES_BASIC = 'pades'
+    PADES_BASIC_WITH_LTV = 'pades-ltv'
+    PADES_T = 'pades-t'
+    PKI_BRAZIL_PADES_ADR_BASICA = 'pades-ltv'
+    PKI_BRAZIL_PADES_ADR_BASICA_WITH_LTV = 'adrb-ltv'
+    PKI_BRAZIL_PADES_ADR_TEMPO = 'adrt'
+
+    NFE_PADRAO_NACIONAL = 'nfe'
+    XADES_BES = 'xades'
+    XML_DSIG_BASIC = 'basic'
+    PKI_BRAZIL_XML_ADR_BASIC = 'adrb'
+    PKI_BRAZIL_XML_ADR_TEMPO = 'adrt'
+    COD_WITH_SHA1 = 'cod-sha1'
+    COD_WITH_SHA256 = 'cod-sha256'
+
+    VALUES = [
+        PKI_BRAZIL_CADES_ADR_BASICA,
+        PKI_BRAZIL_CADES_ADR_BASICA_WITH_REVOCATION_VALUE,
+        PKI_BRAZIL_CADES_ADR_TEMPO,
+        PKI_BRAZIL_CADES_ADR_COMPLETA,
+        CADES_BES,
+        CADES_BES_WITH_REVOCATION_VALUES,
+        CADES_T,
+        PADES_BASIC,
+        PADES_BASIC_WITH_LTV,
+        PADES_T,
+        PKI_BRAZIL_PADES_ADR_BASICA,
+        PKI_BRAZIL_PADES_ADR_BASICA_WITH_LTV,
+        PKI_BRAZIL_PADES_ADR_TEMPO,
+        NFE_PADRAO_NACIONAL,
+        XADES_BES,
+        XML_DSIG_BASIC,
+        PKI_BRAZIL_XML_ADR_BASIC,
+        PKI_BRAZIL_XML_ADR_TEMPO,
+        COD_WITH_SHA1,
+        COD_WITH_SHA256
+    ]
+
+    def self.require_timestamp(policy)
+      if policy.nil?
+        return false
+      end
+
+      return policy == PKI_BRAZIL_CADES_ADR_TEMPO || policy == PKI_BRAZIL_CADES_ADR_COMPLETA || policy == CADES_T || policy == PADES_T || policy == PKI_BRAZIL_PADES_ADR_TEMPO || policy == PKI_BRAZIL_XML_ADR_TEMPO
+    end
+  end
+
 end