pki_express 1.0.0

data/lib/pki_express/signer.rb

@@ -0,0 +1,106 @@
+module PkiExpress
+
+  class Signer < BaseSigner
+
+    attr_accessor :output_file_path, :cert_thumb, :cert_password
+
+    def initialize(config=PkiExpressConfig.new)
+      super(config)
+      @output_file_path = nil
+      @pkcs12_path = nil
+      @cert_thumb = nil
+      @cert_password = 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=(content_base64)
+      _set_pkcs12_base64(content_base64)
+    end
+
+    def _set_pkcs12_base64(content_base64)
+      unless content_base64
+        raise 'The provided "content_base64" is not valid'
+      end
+
+      begin
+        content_raw = Base64.decode64(content_base64)
+      rescue Error
+        raise 'The provided "content_base64" is not Base64-encoded'
+      end
+
+      _set_pkcs12(content_raw)
+    end
+    private :_set_pkcs12_base64
+
+    def pkcs12_path
+      @pkcs12_path
+    end
+
+    def pkcs12_path=(path)
+      unless path
+        raise 'The provided "content_path" is not valid'
+      end
+      unless File.exists?(path)
+        raise 'The provided "content_path" does not exist'
+      end
+
+      @pkcs12_path = path
+    end
+
+    # endregion
+
+    protected
+    def verify_and_add_common_options(args)
+      # Verify and add common option between signers and signature starters.
+      super(args)
+
+      
+    end
+  end
+
+end

data/lib/pki_express/standard_signature_policies.rb

@@ -0,0 +1,36 @@
+module PkiExpress
+
+  class StandardSignaturePolicies
+    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'
+
+    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

data/lib/pki_express/timestamp_authority.rb

@@ -0,0 +1,51 @@
+module PkiExpress
+  class TimestampAuthority
+    attr_reader :url, :token, :ssl_thumbprint, :basic_auth, :auth_type
+
+    def initialize(url)
+      @url = url
+      @auth_type = :none
+      @token = nil
+      @ssl_thumbprint = nil
+      @basic_auth = nil
+    end
+
+    def set_oauth_token_authentication(token)
+      @token = token
+      @auth_type = :oauth_token
+    end
+
+    def set_basic_authentication(username, password)
+      @basic_auth = "#{username}:#{password}"
+      @auth_type = :basic_auth
+    end
+
+    def set_ssl_thumbprint(ssl_thumbprint)
+      @ssl_thumbprint = ssl_thumbprint
+      @auth_type = :ssl
+    end
+
+    def get_cmd_arguments
+      args = []
+      args.append('--tsa-url')
+      args.append(url)
+
+      case auth_type
+      when :none
+      when :basic_auth
+        args.append('--tsa-basic-auth')
+        args.append(@basic_auth)
+      when :ssl
+        args.append('--tsa-ssl-thumbprint')
+        args.append(@ssl_thumbprint)
+      when :oauth_token
+        args.append('--tsa-token')
+        args.append(token)
+      else
+        raise 'Unknown authentication type of the timestamp authority'
+      end
+
+      args
+    end
+  end
+end

data/lib/pki_express/validation_error.rb

@@ -0,0 +1,8 @@
+module PkiExpress
+  class ValidationError < CommandError
+
+    def initialize(validation_results, inner_error=nil)
+      super(ErrorCodes::VALIDATION_FAILED, validation_results, inner_error)
+    end
+  end
+end

data/lib/pki_express/validation_item.rb

@@ -0,0 +1,43 @@
+module PkiExpress
+
+  class ValidationItem
+    attr_accessor :type, :message, :detail, :inner_validation_results
+
+    def initialize(model)
+      @type = nil
+      @message = nil
+      @detail = nil
+      @inner_validation_results = nil
+
+      unless model.nil?
+        @type = model.fetch(:type)
+        @message = model.fetch(:message)
+        @detail = model.fetch(:detail)
+
+        inner_validation_results = model.fetch(:innerValidationResults)
+        unless inner_validation_results.nil?
+          @inner_validation_results = ValidationResults.new(inner_validation_results)
+        end
+      end
+    end
+
+    def to_str(indentation_level=0)
+      to_s(indentation_level)
+    end
+
+    def to_s(indentation_level=0)
+      text = @message
+      unless @detail.nil?
+        text += " (#{@detail})"
+      end
+
+      unless @inner_validation_results.nil?
+        text += '\n'
+        text += @inner_validation_results.to_s(indentation_level + 1)
+      end
+
+      text
+    end
+  end
+
+end

data/lib/pki_express/validation_results.rb

@@ -0,0 +1,121 @@
+module PkiExpress
+
+  class ValidationResults
+    attr_accessor :errors, :warnings, :passed_checks
+
+    def initialize(model)
+      @errors = []
+      @warnings = []
+      @passed_checks = []
+
+      unless model.nil?
+        errors = model.fetch(:errors)
+        unless errors.nil?
+          @errors = convert_items(errors)
+        end
+
+        warnings = model.fetch(:warnings)
+        unless warnings.nil?
+          @warnings = convert_items(warnings)
+        end
+
+        passed_checks = model.fetch(:passedChecks)
+        unless passed_checks.nil?
+          @passed_checks = convert_items(passed_checks)
+        end
+      end
+    end
+
+    def to_str(indentation_level = 0)
+      to_s(indentation_level)
+    end
+
+    def to_s(indentation_level = 0)
+      item_indent = '\t' * indentation_level
+      text = ''
+
+      text += get_summary(indentation_level)
+      if has_errors
+        text += "\n#{item_indent}Errors:\n"
+        text += join_items(@errors, indentation_level)
+      end
+
+      if has_warnings
+        text += "\n#{item_indent}Warnings:\n"
+        text += join_items(@warnings, indentation_level)
+      end
+
+      if not @passed_checks.nil? and @passed_checks.length > 0
+        text += "\n#{item_indent}Passed Checks:\n"
+        text += join_items(@passed_checks, indentation_level)
+      end
+
+      text
+    end
+
+    def is_valid
+      not has_errors
+    end
+
+    def checks_performed
+      @errors.length + @warnings.length + @passed_checks.length
+    end
+
+    def has_errors
+      @errors.length > 0
+    end
+
+    def has_warnings
+      @errors.length > 0
+    end
+
+    def get_summary(indentation_level=0)
+      item_indent = '\t' * indentation_level
+      text = "#{item_indent}Validation Results: "
+
+      if checks_performed == 0
+        text += 'no checks performed'
+      else
+        text += "#{checks_performed} checks performed"
+        if has_errors
+          text += ", #{@errors.length} errors"
+        end
+        if has_warnings
+          text += ", #{@warnings.length} warnings"
+        end
+        if not @passed_checks.nil? and @passed_checks.length
+          if not has_errors and not has_warnings
+            text += ', all passed'
+          else
+            text += ", #{@passed_checks.length} passed"
+          end
+        end
+      end
+
+      text
+    end
+
+    def convert_items(items)
+      items.map { |i| ValidationItem.new(i) }
+    end
+
+    def join_items(items, indentation_level=0)
+      text = ''
+      is_first = true
+      item_indent = '\t' * indentation_level
+
+      items.each do |i|
+        if is_first
+          is_first = false
+        else
+          text += '\n'
+        end
+        text += item_indent + '- '
+        text += i.to_s(indentation_level)
+      end
+
+      text
+    end
+  end
+
+end

data/lib/pki_express/version.rb

@@ -0,0 +1,3 @@
+module PkiExpress
+  VERSION = '1.0.0'
+end

data/lib/pki_express/version_manager.rb

@@ -0,0 +1,21 @@
+module PkiExpress
+
+  class VersionManager
+    attr_reader :min_version
+
+    def initialize
+      @min_version = '0.0.0'
+    end
+
+    def require_version(candidate)
+      if Gem::Version.new(candidate) > Gem::Version.new(@min_version)
+        @min_version = candidate
+      end
+    end
+
+    def require_min_version_flag?
+      Gem::Version.new(@min_version) > Gem::Version.new('1.3')
+    end
+  end
+
+end

data/pki_express.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+require_relative 'lib/pki_express/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'pki_express'
+  spec.version = PkiExpress::VERSION
+  spec.license = 'MIT'
+  spec.authors = ['Ismael Medeiros']
+  spec.email = %w{ismaelm@lacunasoftware.com}
+  spec.homepage = 'http://docs.lacunasoftware.com/en-us/articles/pki-express'
+  spec.summary = 'Gem for using PKI Express on Ruby'
+  spec.description = 'Classes to use Lacuna Software\'s PKI Express'
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.metadata = {
+      'bug_tracker_uri'   => 'https://github.com/LacunaSoftware/PkiExpressRuby/issues',
+      'changelog_uri'     => 'https://github.com/LacunaSoftware/PkiExpressRuby/blob/develop/CHANGELOG.md',
+      'documentation_uri' => 'http://docs.lacunasoftware.com/en-us/articles/pki-express',
+      'source_code_uri'   => 'https://github.com/LacunaSoftware/PkiExpressRuby'
+  }
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: pki_express
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ismael Medeiros
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Classes to use Lacuna Software's PKI Express
+email:
+- ismaelm@lacunasoftware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitattributes"
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/pki_express.rb
+- lib/pki_express/auth_complete_result.rb
+- lib/pki_express/auth_start_result.rb
+- lib/pki_express/authentication.rb
+- lib/pki_express/base_signer.rb
+- lib/pki_express/cades_signature_starter.rb
+- lib/pki_express/command_error.rb
+- lib/pki_express/commands.rb
+- lib/pki_express/enum.rb
+- lib/pki_express/error_codes.rb
+- lib/pki_express/installation_not_found_error.rb
+- lib/pki_express/name.rb
+- lib/pki_express/pades_horizontal_align.rb
+- lib/pki_express/pades_measurement_units.rb
+- lib/pki_express/pades_page_optimization.rb
+- lib/pki_express/pades_page_orientation.rb
+- lib/pki_express/pades_paper_size.rb
+- lib/pki_express/pades_signature_starter.rb
+- lib/pki_express/pades_size.rb
+- lib/pki_express/pades_text_horizontal_align.rb
+- lib/pki_express/pades_vertical_align.rb
+- lib/pki_express/pades_visual_auto_positioning.rb
+- lib/pki_express/pades_visual_image.rb
+- lib/pki_express/pades_visual_manual_positioning.rb
+- lib/pki_express/pades_visual_positioning.rb
+- lib/pki_express/pades_visual_rectangle.rb
+- lib/pki_express/pades_visual_representation.rb
+- lib/pki_express/pades_visual_text.rb
+- lib/pki_express/pk_certificate.rb
+- lib/pki_express/pki_brazil_certificate_fields.rb
+- lib/pki_express/pki_brazil_certificate_types.rb
+- lib/pki_express/pki_express_config.rb
+- lib/pki_express/pki_express_operator.rb
+- lib/pki_express/pki_italy_certificate_fields.rb
+- lib/pki_express/pki_italy_certificate_types.rb
+- lib/pki_express/signature_finisher.rb
+- lib/pki_express/signature_start_result.rb
+- lib/pki_express/signature_starter.rb
+- lib/pki_express/signer.rb
+- lib/pki_express/standard_signature_policies.rb
+- lib/pki_express/timestamp_authority.rb
+- lib/pki_express/validation_error.rb
+- lib/pki_express/validation_item.rb
+- lib/pki_express/validation_results.rb
+- lib/pki_express/version.rb
+- lib/pki_express/version_manager.rb
+- pki_express.gemspec
+homepage: http://docs.lacunasoftware.com/en-us/articles/pki-express
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/LacunaSoftware/PkiExpressRuby/issues
+  changelog_uri: https://github.com/LacunaSoftware/PkiExpressRuby/blob/develop/CHANGELOG.md
+  documentation_uri: http://docs.lacunasoftware.com/en-us/articles/pki-express
+  source_code_uri: https://github.com/LacunaSoftware/PkiExpressRuby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Gem for using PKI Express on Ruby
+test_files: []