pki_express 1.3.0 → 1.3.2

data/lib/pki_express/cades_signature.rb

@@ -1,89 +1,89 @@
-module PkiExpress
-  class CadesSignature
-    attr_accessor :encapsulated_content_type, :has_encapsulated_content, :signers
-
-    def initialize(model)
-      @encapsulated_content_type = nil
-      @has_encapsulated_content = nil
-      @signers = []
-
-      unless model.nil?
-        @encapsulated_content_type = model.fetch(:encapsulatedContentType)
-        @has_encapsulated_content = model.fetch(:hasEncapsulatedContent)
-
-        signers = model.fetch(:signers)
-        if signers
-          @signers = signers.map { |s| CadesSignerInfo.new(s) }
-        end
-      end
-    end
-  end
-
-
-  class CadesTimestamp < CadesSignature
-    attr_accessor :gen_time, :serial_number, :message_imprint
-
-    def initialize(model)
-      super(model)
-      @gen_time = nil
-      @serial_number = nil
-      @message_imprint = nil
-      @gen_time = model.fetch(:genTime)
-      @serial_number = model.fetch(:serialNumber)
-      @message_imprint = model.fetch(:messageImprint)
-    end
-  end
-
-
-  class CadesSignerInfo
-    attr_accessor :signing_time, :certified_date_reference, :message_digest
-    attr_accessor :signature, :certificate, :signature_policy, :timestamps
-    attr_accessor :validation_results
-
-    def initialize(model)
-      @signing_time = nil
-      @certified_date_reference = nil
-      @message_digest = nil
-      @signature = nil
-      @certificate = nil
-      @signature_policy = nil
-      @timestamps = []
-      @validation_results = nil
-
-      unless model.nil?
-        @certified_date_reference = model.fetch(:certifiedDateReference)
-        @signing_time =  model.fetch(:signingTime)
-
-        message_digest =  model.fetch(:messageDigest)
-        if message_digest
-          @message_digest = DigestAlgorithmAndValue.new(message_digest)
-        end
-
-        signature =  model.fetch(:signature)
-        if signature
-          @signature = SignatureAlgorithmAndValue.new(signature)
-        end
-
-        certificate =  model.fetch(:certificate)
-        if certificate
-          @certificate = PKCertificate.new(certificate)
-        end
-
-        signature_policy =  model.fetch(:signaturePolicy)
-        if signature_policy
-          @signature_policy = SignaturePolicyIdentifier.new(signature_policy)
-        end
-
-        timestamps =  model.fetch(:timestamps)
-        if timestamps
-          @timestamps = timestamps.map { |t| CadesTimestamp.new(t) }
-        end
-
-        validation_results =  model.fetch(:validationResults)
-        if validation_results
-            @validation_results = ValidationResults.new(validation_results)
-        end
-      end
-    end
-  end
-end
+module PkiExpress
+  class CadesSignature
+    attr_accessor :encapsulated_content_type, :has_encapsulated_content, :signers
+
+    def initialize(model)
+      @encapsulated_content_type = nil
+      @has_encapsulated_content = nil
+      @signers = []
+
+      unless model.nil?
+        @encapsulated_content_type = model.fetch(:encapsulatedContentType)
+        @has_encapsulated_content = model.fetch(:hasEncapsulatedContent)
+
+        signers = model.fetch(:signers)
+        if signers
+          @signers = signers.map { |s| CadesSignerInfo.new(s) }
+        end
+      end
+    end
+  end
+
+
+  class CadesTimestamp < CadesSignature
+    attr_accessor :gen_time, :serial_number, :message_imprint
+
+    def initialize(model)
+      super(model)
+      @gen_time = nil
+      @serial_number = nil
+      @message_imprint = nil
+      @gen_time = model.fetch(:genTime)
+      @serial_number = model.fetch(:serialNumber)
+      @message_imprint = model.fetch(:messageImprint)
+    end
+  end
+
+
+  class CadesSignerInfo
+    attr_accessor :signing_time, :certified_date_reference, :message_digest
+    attr_accessor :signature, :certificate, :signature_policy, :timestamps
+    attr_accessor :validation_results
+
+    def initialize(model)
+      @signing_time = nil
+      @certified_date_reference = nil
+      @message_digest = nil
+      @signature = nil
+      @certificate = nil
+      @signature_policy = nil
+      @timestamps = []
+      @validation_results = nil
+
+      unless model.nil?
+        @certified_date_reference = model.fetch(:certifiedDateReference)
+        @signing_time =  model.fetch(:signingTime)
+
+        message_digest =  model.fetch(:messageDigest)
+        if message_digest
+          @message_digest = DigestAlgorithmAndValue.new(message_digest)
+        end
+
+        signature =  model.fetch(:signature)
+        if signature
+          @signature = SignatureAlgorithmAndValue.new(signature)
+        end
+
+        certificate =  model.fetch(:certificate)
+        if certificate
+          @certificate = PKCertificate.new(certificate)
+        end
+
+        signature_policy =  model.fetch(:signaturePolicy)
+        if signature_policy
+          @signature_policy = SignaturePolicyIdentifier.new(signature_policy)
+        end
+
+        timestamps =  model.fetch(:timestamps)
+        if timestamps
+          @timestamps = timestamps.map { |t| CadesTimestamp.new(t) }
+        end
+
+        validation_results =  model.fetch(:validationResults)
+        if validation_results
+            @validation_results = ValidationResults.new(validation_results)
+        end
+      end
+    end
+  end
+end

data/lib/pki_express/cades_signature_starter.rb

@@ -1,242 +1,242 @@
-module PkiExpress
-
-  class CadesSignatureStarter < SignatureStarter
-
-    attr_accessor :encapsulated_content
-
-    def initialize(config=PkiExpressConfig.new)
-      super(config)
-      @file_to_sign_path = nil
-      @data_file_path = nil
-      @encapsulated_content = true
-    end
-
-    # region The "file_to_sign" accessors
-
-    def file_to_sign
-      _get_file_to_sign
-    end
-
-    def _get_file_to_sign
-      unless @file_to_sign_path
-        return nil
-      end
-
-      File.read(@file_to_sign_path)
-    end
-    private :_get_file_to_sign
-
-    def file_to_sign=(content_raw)
-      _set_file_to_sign(content_raw)
-    end
-
-    def _set_file_to_sign(content_raw)
-      unless content_raw
-        raise 'The provided "file_to_sign" is not valid'
-      end
-
-      temp_file_path = self.create_temp_file
-      File.open(temp_file_path, 'wb') do |f|
-        f.write(content_raw)
-      end
-      @file_to_sign_path = temp_file_path
-    end
-    private :_set_file_to_sign
-
-    def file_to_sign_base64
-      _get_file_to_sign_base64
-    end
-
-    def _get_file_to_sign_base64
-      unless @file_to_sign_path
-        return nil
-      end
-
-      content = File.read(@file_to_sign_path)
-      Base64.encode64(content)
-    end
-    private :_get_file_to_sign_base64
-
-    def file_to_sign_base64=(content_base64)
-      _set_file_to_sign_base64(content_base64)
-    end
-
-    def _set_file_to_sign_base64(content_base64)
-      unless content_base64
-        raise 'The provided "file_to_sign_base64" is not valid'
-      end
-
-      begin
-        content_raw = Base64.decode64(content_base64)
-      rescue Error
-        raise 'The provided "file_to_sign_base64" is not Base64-encoded'
-      end
-
-      _set_file_to_sign(content_raw)
-    end
-    private :_set_file_to_sign_base64
-
-    def file_to_sign_path
-      _get_file_to_sign_path
-    end
-
-    def _get_file_to_sign_path
-      @file_to_sign_path
-    end
-    private :_get_file_to_sign_path
-
-    def file_to_sign_path=(path)
-      _set_file_to_sign_path(path)
-    end
-
-    def _set_file_to_sign_path(path)
-      unless path
-        raise 'The provided "file_to_sign_path" is not valid'
-      end
-      unless File.exists?(path)
-        raise 'The provided "file_to_sign_path" does not exist'
-      end
-
-      @file_to_sign_path = path
-    end
-    private :_set_file_to_sign_path
-
-    # endregion
-
-    # region The "data_file" accessors
-
-    def data_file
-      _get_data_file
-    end
-
-    def _get_data_file
-      unless @data_file_path
-        return nil
-      end
-
-      File.read(@data_file_path)
-    end
-    private :_get_data_file
-
-    def data_file=(content_raw)
-      _set_data_file(content_raw)
-    end
-
-    def _set_data_file(content_raw)
-      unless content_raw
-        raise 'The provided "data_file" is not valid'
-      end
-
-      temp_file_path = self.create_temp_file
-      File.open(temp_file_path, 'wb') do |f|
-        f.write(content_raw)
-      end
-      @data_file_path = temp_file_path
-    end
-    private :_set_data_file
-
-    def data_file_base64
-      _get_data_file_base64
-    end
-
-    def _get_data_file_base64
-      unless @data_file_path
-        return nil
-      end
-
-      content = File.read(@data_file_path)
-      Base64.encode64(content)
-    end
-    private :_get_data_file_base64
-
-    def data_file_base64=(content_base64)
-      _set_data_file_base64(content_base64)
-    end
-
-    def _set_data_file_base64(content_base64)
-      unless content_base64
-        raise 'The provided "data_file_base64" is not valid'
-      end
-
-      begin
-        content_raw = Base64.decode64(content_base64)
-      rescue Error
-        raise 'The provided "data_file_base64" is not Base64-encoded'
-      end
-
-      _set_data_file(content_raw)
-    end
-    private :_set_data_file_base64
-
-    def data_file_path
-      _get_data_file_path
-    end
-
-    def _get_data_file_path
-      @data_file_path
-    end
-    private :_get_data_file_path
-
-    def data_file_path=(path)
-      _set_data_file_path(path)
-    end
-
-    def _set_data_file_path(path)
-      unless path
-        raise 'The provided "data_file_path" is not valid'
-      end
-      unless File.exists?(path)
-        raise 'The provided "data_file_path" does not exist'
-      end
-
-      @data_file_path = path
-    end
-    private :_set_data_file_path
-
-    # endregion
-
-    def start
-
-      unless @file_to_sign_path
-        raise 'The file to be signed was not set'
-      end
-
-      unless @certificate_path
-        raise 'The certificate was not set'
-      end
-
-      # Generate transfer file.
-      transfer_file_id = get_transfer_filename
-
-      args = [
-          @file_to_sign_path,
-          @certificate_path,
-          File.expand_path(transfer_file_id, @config.transfer_data_folder),
-      ]
-
-      # Verify and add common options between signers.
-      verify_and_add_common_options(args)
-
-      if @data_file_path
-        args.append('--data-file')
-        args.append(@data_file_path)
-      end
-
-      unless @encapsulated_content
-        args.append('--detached')
-      end
-
-      # This operation can only be used on version greater than 1.3 of the
-      # PKI Express.
-      @version_manager.require_version('1.3')
-
-      # Invoke command.
-      result = invoke(Commands::START_CADES, args)
-
-      # Parse output and return model.
-      model = parse_output(result)
-      SignatureStartResult.new(model, transfer_file_id)
-    end
-  end
-
-end
+module PkiExpress
+
+  class CadesSignatureStarter < SignatureStarter
+
+    attr_accessor :encapsulated_content
+
+    def initialize(config=PkiExpressConfig.new)
+      super(config)
+      @file_to_sign_path = nil
+      @data_file_path = nil
+      @encapsulated_content = true
+    end
+
+    # region The "file_to_sign" accessors
+
+    def file_to_sign
+      _get_file_to_sign
+    end
+
+    def _get_file_to_sign
+      unless @file_to_sign_path
+        return nil
+      end
+
+      File.read(@file_to_sign_path)
+    end
+    private :_get_file_to_sign
+
+    def file_to_sign=(content_raw)
+      _set_file_to_sign(content_raw)
+    end
+
+    def _set_file_to_sign(content_raw)
+      unless content_raw
+        raise 'The provided "file_to_sign" is not valid'
+      end
+
+      temp_file_path = self.create_temp_file
+      File.open(temp_file_path, 'wb') do |f|
+        f.write(content_raw)
+      end
+      @file_to_sign_path = temp_file_path
+    end
+    private :_set_file_to_sign
+
+    def file_to_sign_base64
+      _get_file_to_sign_base64
+    end
+
+    def _get_file_to_sign_base64
+      unless @file_to_sign_path
+        return nil
+      end
+
+      content = File.read(@file_to_sign_path)
+      Base64.encode64(content)
+    end
+    private :_get_file_to_sign_base64
+
+    def file_to_sign_base64=(content_base64)
+      _set_file_to_sign_base64(content_base64)
+    end
+
+    def _set_file_to_sign_base64(content_base64)
+      unless content_base64
+        raise 'The provided "file_to_sign_base64" is not valid'
+      end
+
+      begin
+        content_raw = Base64.decode64(content_base64)
+      rescue Error
+        raise 'The provided "file_to_sign_base64" is not Base64-encoded'
+      end
+
+      _set_file_to_sign(content_raw)
+    end
+    private :_set_file_to_sign_base64
+
+    def file_to_sign_path
+      _get_file_to_sign_path
+    end
+
+    def _get_file_to_sign_path
+      @file_to_sign_path
+    end
+    private :_get_file_to_sign_path
+
+    def file_to_sign_path=(path)
+      _set_file_to_sign_path(path)
+    end
+
+    def _set_file_to_sign_path(path)
+      unless path
+        raise 'The provided "file_to_sign_path" is not valid'
+      end
+      unless File.exists?(path)
+        raise 'The provided "file_to_sign_path" does not exist'
+      end
+
+      @file_to_sign_path = path
+    end
+    private :_set_file_to_sign_path
+
+    # endregion
+
+    # region The "data_file" accessors
+
+    def data_file
+      _get_data_file
+    end
+
+    def _get_data_file
+      unless @data_file_path
+        return nil
+      end
+
+      File.read(@data_file_path)
+    end
+    private :_get_data_file
+
+    def data_file=(content_raw)
+      _set_data_file(content_raw)
+    end
+
+    def _set_data_file(content_raw)
+      unless content_raw
+        raise 'The provided "data_file" is not valid'
+      end
+
+      temp_file_path = self.create_temp_file
+      File.open(temp_file_path, 'wb') do |f|
+        f.write(content_raw)
+      end
+      @data_file_path = temp_file_path
+    end
+    private :_set_data_file
+
+    def data_file_base64
+      _get_data_file_base64
+    end
+
+    def _get_data_file_base64
+      unless @data_file_path
+        return nil
+      end
+
+      content = File.read(@data_file_path)
+      Base64.encode64(content)
+    end
+    private :_get_data_file_base64
+
+    def data_file_base64=(content_base64)
+      _set_data_file_base64(content_base64)
+    end
+
+    def _set_data_file_base64(content_base64)
+      unless content_base64
+        raise 'The provided "data_file_base64" is not valid'
+      end
+
+      begin
+        content_raw = Base64.decode64(content_base64)
+      rescue Error
+        raise 'The provided "data_file_base64" is not Base64-encoded'
+      end
+
+      _set_data_file(content_raw)
+    end
+    private :_set_data_file_base64
+
+    def data_file_path
+      _get_data_file_path
+    end
+
+    def _get_data_file_path
+      @data_file_path
+    end
+    private :_get_data_file_path
+
+    def data_file_path=(path)
+      _set_data_file_path(path)
+    end
+
+    def _set_data_file_path(path)
+      unless path
+        raise 'The provided "data_file_path" is not valid'
+      end
+      unless File.exists?(path)
+        raise 'The provided "data_file_path" does not exist'
+      end
+
+      @data_file_path = path
+    end
+    private :_set_data_file_path
+
+    # endregion
+
+    def start
+
+      unless @file_to_sign_path
+        raise 'The file to be signed was not set'
+      end
+
+      unless @certificate_path
+        raise 'The certificate was not set'
+      end
+
+      # Generate transfer file.
+      transfer_file_id = get_transfer_filename
+
+      args = [
+          @file_to_sign_path,
+          @certificate_path,
+          File.expand_path(transfer_file_id, @config.transfer_data_folder),
+      ]
+
+      # Verify and add common options between signers.
+      verify_and_add_common_options(args)
+
+      if @data_file_path
+        args.append('--data-file')
+        args.append(@data_file_path)
+      end
+
+      unless @encapsulated_content
+        args.append('--detached')
+      end
+
+      # This operation can only be used on version greater than 1.3 of the
+      # PKI Express.
+      @version_manager.require_version('1.3')
+
+      # Invoke command.
+      result = invoke(Commands::START_CADES, args)
+
+      # Parse output and return model.
+      model = parse_output(result)
+      SignatureStartResult.new(model, transfer_file_id)
+    end
+  end
+
+end