icsp 0.1.0

data/lib/commands/create_hash.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ICSP
+  module Commands
+    class CreateHash < ::ICSP::Commands::BaseCommand
+      def cryptcp
+        @cryptcp ||= @config.cryptcp
+      end
+
+      def execute
+        input_file = arguments.first
+        result = ::ICSP::Shell.new("#{cryptcp} -hash -hex #{input_file}", convert_to_utf8: false).execute
+        exit(result.exit_code) unless result.ok
+
+        puts result
+      end
+    end
+  end
+end

data/lib/commands/create_signature.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ICSP
+  module Commands
+    class CreateSignature < ::ICSP::Commands::BaseCommand
+      def cryptcp
+        @cryptcp ||= @config.cryptcp
+      end
+
+      def execute
+        input_file = arguments.first
+        thumbprint = selected_certificate
+
+        result = ::ICSP::Shell.new("#{cryptcp} -signf -thumbprint '#{thumbprint}' #{input_file}",
+                                  convert_to_utf8: false, fork: false).execute
+        exit(result.exit_code) unless result.ok
+
+        puts result
+      end
+
+      def selected_certificate
+        ::ICSP::Commands::Certificate::List.new(config: config, options: options, arguments: arguments).select
+      end
+    end
+  end
+end

data/lib/commands/decrypt_file.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ICSP
+  module Commands
+    class DecryptFile < ::ICSP::Commands::BaseCommand
+      def cryptcp
+        @cryptcp ||= @config.cryptcp
+      end
+
+      def execute
+        input_file = arguments.first
+        output_file = arguments.last
+        result = ::ICSP::Shell.new(
+          "#{cryptcp} -decr -f '#{options[:certificate_file]}' -start #{input_file} #{output_file}", convert_to_utf8: false
+        ).execute
+        exit(result.exit_code) unless result.ok
+
+        puts result
+      end
+    end
+  end
+end

data/lib/commands/encrypt_file.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ICSP
+  module Commands
+    class EncryptFile < ::ICSP::Commands::BaseCommand
+      def cryptcp
+        @cryptcp ||= @config.cryptcp
+      end
+
+      def execute
+        input_file = arguments.first
+        output_file = arguments.last
+        result = ::ICSP::Shell.new(
+          "#{cryptcp} -encr -thumbprint '#{options[:certificate_file]}' #{input_file} #{output_file}", convert_to_utf8: false
+        ).execute
+        exit(result.exit_code) unless result.ok
+
+        puts result
+      end
+    end
+  end
+end

data/lib/commands/hardware/list.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ICSP
+  module Commands
+    module Hardware
+      class List < ::ICSP::Commands::BaseCommand
+        def cpconfig
+          @cpconfig ||= @config.cpconfig
+        end
+
+        def execute
+          type = options[:type] || 'reader'
+          result = ::ICSP::Shell.new("#{cpconfig} -hardware #{type} -view").execute
+          exit(result.exit_code) unless result.ok
+
+          puts result
+        end
+      end
+    end
+  end
+end

data/lib/commands/license/set.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ICSP
+  module Commands
+    module License
+      class Set < ::ICSP::Commands::BaseCommand
+        def cpconfig
+          @cpconfig ||= @config.cpconfig
+        end
+
+        def execute
+          result = ::ICSP::Shell.new("#{cpconfig} -license -set #{arguments.first}").execute
+          exit(result.exit_code) unless result.ok
+
+          puts result
+        end
+      end
+    end
+  end
+end

data/lib/commands/license/view.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ICSP
+  module Commands
+    module License
+      class View < ::ICSP::Commands::BaseCommand
+        def cpconfig
+          @cpconfig ||= @config.cpconfig
+        end
+
+        def execute
+          result = ::ICSP::Shell.new("#{cpconfig} -license -view").execute
+          exit(result.exit_code) unless result.ok
+
+          puts result
+        end
+      end
+    end
+  end
+end

data/lib/commands/verify_hash.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ICSP
+  module Commands
+    class VerifyHash < ::ICSP::Commands::BaseCommand
+      def cryptcp
+        @cryptcp ||= @config.cryptcp
+      end
+
+      def execute
+        input_file = arguments.first
+        result = ::ICSP::Shell.new("#{cryptcp} -vhash -hex #{input_file}", convert_to_utf8: false).execute
+        exit(result.exit_code) unless result.ok
+
+        puts result
+      end
+    end
+  end
+end

data/lib/commands/verify_signature.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ICSP
+  module Commands
+    class VerifySignature < ::ICSP::Commands::BaseCommand
+      def cryptcp
+        @cryptcp ||= @config.cryptcp
+      end
+
+      def execute
+        input_file = arguments.first
+        thumbprint = selected_certificate
+
+        result = ::ICSP::Shell.new("#{cryptcp} -vsignf -thumbprint '#{thumbprint}' #{input_file}",
+                                  convert_to_utf8: false, fork: false).execute
+        exit(result.exit_code) unless result.ok
+
+        puts result
+      end
+
+      def selected_certificate
+        ::ICSP::Commands::Certificate::List.new(config: config, options: options, arguments: arguments).select
+      end
+    end
+  end
+end

data/lib/csp/version.rb

@@ -0,0 +1,3 @@
+module ICSP
+  VERSION = "0.1.0"
+end

data/lib/csp.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'logger'
+require 'optionparser'
+require 'ostruct'
+require 'yaml'
+
+require 'os'
+require 'tty-prompt'
+
+require_relative '../config/config'
+require_relative '../config/environment'
+require_relative '../lib/csp_option_parser'
+require_relative '../lib/commands/base_command'
+require_relative '../lib/shell'
+require_relative '../lib/shell_result'
+
+require_relative '../lib/commands/certificate/delete'
+require_relative '../lib/commands/certificate/install'
+require_relative '../lib/commands/certificate/list'
+require_relative '../lib/commands/certificate/view'
+require_relative '../lib/commands/container/check'
+require_relative '../lib/commands/container/list'
+require_relative '../lib/commands/hardware/list'
+require_relative '../lib/commands/license/view'
+require_relative '../lib/commands/license/set'
+require_relative '../lib/commands/create_hash'
+require_relative '../lib/commands/verify_hash'
+require_relative '../lib/commands/encrypt_file'
+require_relative '../lib/commands/decrypt_file'
+require_relative '../lib/commands/create_signature'
+require_relative '../lib/commands/verify_signature'
+
+# CryptoPro CSP
+module ICSP
+  def self.to_camel_case(string)
+    string.to_s.split('_').map(&:capitalize).join
+  end
+
+  def self.run
+    parsed = ::ICSP::Services::OptionParserService.new.parse
+    command_parts = %w[::ICSP Commands]
+    command_parts << to_camel_case(parsed.command) if parsed.command
+    command_parts << to_camel_case(parsed.subcommand) if parsed.subcommand
+    command = Object.const_get(command_parts.join('::'))
+                    .new(config: config, options: parsed.options, arguments: parsed.arguments)
+    command.respond_to?(:print) ? command.print : command.execute
+  rescue StandardError => e
+    puts 'Application aborted with error:'
+    raise e
+  end
+
+  run
+end

data/lib/csp_option_parser.rb

@@ -0,0 +1,224 @@
+# frozen_string_literal: true
+
+module ICSP
+  module Services
+    # OptionParserService
+    class OptionParserService
+      APP_HELP = <<~HELP
+        Available commands are:
+           certificate      Manage certificates
+           container        Manage containers
+           hardware         Manage hardware
+           license          Manage license
+           -----
+           sign_file
+           verify_signature
+           encrypt_file
+           decrypt_file
+
+        See 'icsp COMMAND --help' for more information on a specific command.
+        For full documentation, see: https://github.com/denblackstache/cryptopro-cli#readme
+      HELP
+
+      def parse
+        command = parse_command
+        unless command
+          puts 'No command passed'
+          exit
+        end
+
+        subcommand_result = parse_subcommand(command)
+        OpenStruct.new(
+          command: command,
+          subcommand: subcommand_result[:subcommand],
+          arguments: subcommand_result[:arguments],
+          options: subcommand_result[:options]
+        )
+      end
+
+      private
+
+      def parse_command
+        global = OptionParser.new do |opts|
+          opts.banner = 'Usage: icsp [command] [subcommand] [options]'
+          opts.separator('')
+          opts.separator(APP_HELP)
+        end
+        global.order!
+        ARGV.shift.to_sym unless ARGV.empty?
+      end
+
+      def parse_subcommand(command)
+        options = {}
+        subcommands = {
+          encrypt_file: encrypt_file_option_parser(options),
+          decrypt_file: decrypt_file_option_parser(options),
+          create_hash: create_hash_option_parser(options),
+          verify_hash: verify_hash_option_parser(options),
+          create_signature: create_signature_option_parser(options),
+          verify_signature: verify_signature_option_parser(options),
+          certificate: {
+            delete: certificate_delete_option_parser(options),
+            install: certificate_install_option_parser(options),
+            list: certificate_list_option_parser(options),
+            view: certificate_list_option_parser(options)
+          },
+          container: {
+            check: container_check_option_parser(options),
+            list: container_list_option_parser(options)
+          },
+          hardware: {
+            list: hardware_list_option_parser(options)
+          },
+          license: {
+            view: license_view_option_parser(options),
+            set: license_set_option_parser(options)
+          }
+        }
+
+        is_management_command = subcommands[command].is_a?(Hash)
+        subcommand = ARGV.shift.to_sym if is_management_command && !ARGV.empty?
+
+        subcommand_option_parser = is_management_command ? subcommands[command][subcommand] : subcommands[command]
+        subcommand_option_parser.parse!
+
+        { subcommand: subcommand, arguments: ARGV.dup, options: options }
+      end
+
+      def encrypt_file_option_parser(options)
+        OptionParser.new do |opts|
+          opts.banner = 'Usage: icsp encrypt_file [options]'
+          opts.on('-f certificate_file', '--file certificate_file', String,
+                  'certificate file path') do |certificate_file|
+            options[:certificate_file] = certificate_file
+          end
+          opts.separator('')
+          opts.separator('description')
+        end
+      end
+
+      def decrypt_file_option_parser(options)
+        OptionParser.new do |opts|
+          opts.banner = 'Usage: icsp decrypt_file [options]'
+          opts.on('-f certificate_file', '--file certificate_file', String,
+                  'certificate file path') do |certificate_file|
+            options[:certificate_file] = certificate_file
+          end
+          opts.separator('')
+          opts.separator('description')
+        end
+      end
+
+      def create_hash_option_parser(_options)
+        OptionParser.new do |opts|
+          opts.banner = 'Usage: icsp create_hash [options]'
+          opts.separator('')
+          opts.separator('description')
+        end
+      end
+
+      def verify_hash_option_parser(_options)
+        OptionParser.new do |opts|
+          opts.banner = 'Usage: icsp verify_hash [options]'
+          opts.separator('')
+          opts.separator('description')
+        end
+      end
+
+      def create_signature_option_parser(_options)
+        OptionParser.new do |opts|
+          opts.banner = 'Usage: icsp create_signature [options]'
+          opts.separator('')
+          opts.separator('description')
+        end
+      end
+
+      def verify_signature_option_parser(_options)
+        OptionParser.new do |opts|
+          opts.banner = 'Usage: icsp verify_signature [options]'
+          opts.separator('')
+          opts.separator('description')
+        end
+      end
+
+      def certificate_delete_option_parser(_options)
+        OptionParser.new do |opts|
+          opts.banner = 'Usage: icsp certificate delete [options]'
+          opts.separator('')
+          opts.separator('description')
+        end
+      end
+
+      def certificate_install_option_parser(options)
+        OptionParser.new do |opts|
+          opts.banner = 'Usage: icsp certificate install [options]'
+          opts.on('-f file', '--file file', String, 'file path') do |file|
+            options[:file] = file
+          end
+          opts.separator('')
+          opts.separator('description')
+        end
+      end
+
+      def certificate_list_option_parser(_options)
+        OptionParser.new do |opts|
+          opts.banner = 'Usage: icsp certificate list [options]'
+          opts.separator('')
+          opts.separator('description')
+        end
+      end
+
+      def certificate_view_option_parser(_options)
+        OptionParser.new do |opts|
+          opts.banner = 'Usage: icsp certificate view [options]'
+          opts.separator('')
+          opts.separator('description')
+        end
+      end
+
+      def container_check_option_parser(_options)
+        OptionParser.new do |opts|
+          opts.banner = 'Usage: icsp container check [options]'
+          opts.separator('')
+          opts.separator('description')
+        end
+      end
+
+      def container_list_option_parser(_options)
+        OptionParser.new do |opts|
+          opts.banner = 'Usage: icsp container list [options]'
+          opts.separator('')
+          opts.separator('description')
+        end
+      end
+
+      def hardware_list_option_parser(options)
+        OptionParser.new do |opts|
+          opts.banner = 'Usage: icsp hardware list [options]'
+          opts.on('-t hardware_type', '--type hardware_type', String,
+                  'hardware_type - reader (default) | rndm | media') do |hardware_type|
+            options[:type] = hardware_type
+          end
+          opts.separator('')
+          opts.separator('Review of the installed readers, generators of random numbers and media')
+        end
+      end
+
+      def license_view_option_parser(_options)
+        OptionParser.new do |opts|
+          opts.banner = 'Usage: icsp license view'
+          opts.separator('')
+          opts.separator('description')
+        end
+      end
+
+      def license_set_option_parser(_options)
+        OptionParser.new do |opts|
+          opts.banner = 'Usage: icsp license set'
+          opts.separator('')
+          opts.separator('description')
+        end
+      end
+    end
+  end
+end

data/lib/shell.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ICSP
+  # Shell
+  class Shell
+    def initialize(command, split: true, convert_to_utf8: true, fork: true)
+      @command = command
+      @split = split
+      @convert_to_utf8 = convert_to_utf8
+      @fork = fork
+    end
+
+    def execute
+      ::ICSP.logger.info("command: #{@command}")
+      unless @fork
+        exec(@command)
+        return
+      end
+
+      raw_output = `#{@command}`
+      exec_success = $CHILD_STATUS.success?
+      exit_code = $CHILD_STATUS.exitstatus
+
+      output = @convert_to_utf8 ? raw_output.force_encoding('cp1251').encode('utf-8', undef: :replace) : raw_output
+      csp_error_code = ''
+      output_lines = []
+
+      if @split
+        output_lines = output.split("\n")
+        csp_error_code_line = output_lines.find { |l| l.include?('ErrorCode') }
+        csp_error_code = /0x0*[1-9a-fA-F][0-9a-fA-F]*/.match(csp_error_code_line).to_s
+      end
+
+      shell_result = ::ICSP::ShellResult.new(
+        output: output,
+        output_lines: output_lines,
+        csp_error_code: csp_error_code,
+        ok: exec_success && csp_error_code == '',
+        exit_code: exit_code
+      )
+
+      ::ICSP.logger.debug("ok: #{shell_result.ok}")
+      shell_result
+    end
+  end
+end

data/lib/shell_result.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ICSP
+  # ShellResult
+  class ShellResult
+    def initialize(ok:, exit_code:, output:, output_lines:, csp_error_code:)
+      @ok = ok
+      @exit_code = exit_code
+      @output = output
+      @output_lines = output_lines
+      @csp_error_code = csp_error_code
+    end
+
+    attr_reader :ok, :exit_code, :output, :output_lines, :csp_error_code
+
+    def to_s
+      output
+    end
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: icsp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Denis Semenenko
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
+description: |-
+  An interactive CryptoPro CSP shell that tries to imitate its GUI counterpart on the Windows platform.
+  Built for macOS and Linux daily use by wrapping a set of CryptoPro CLI tools: cryptcp, certmgr, csptest, cpconfig, etc.
+email:
+- hypercoderx@gmail.com
+executables:
+- icsp
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/config.rb
+- config/environment.rb
+- exe/icsp
+- icsp.gemspec
+- lib/commands/base_command.rb
+- lib/commands/certificate/delete.rb
+- lib/commands/certificate/install.rb
+- lib/commands/certificate/list.rb
+- lib/commands/certificate/view.rb
+- lib/commands/container/change_pin_code.rb
+- lib/commands/container/check.rb
+- lib/commands/container/copy.rb
+- lib/commands/container/delete.rb
+- lib/commands/container/forget_all_pin_codes.rb
+- lib/commands/container/list.rb
+- lib/commands/container/view.rb
+- lib/commands/create_hash.rb
+- lib/commands/create_signature.rb
+- lib/commands/decrypt_file.rb
+- lib/commands/encrypt_file.rb
+- lib/commands/hardware/list.rb
+- lib/commands/license/set.rb
+- lib/commands/license/view.rb
+- lib/commands/verify_hash.rb
+- lib/commands/verify_signature.rb
+- lib/csp.rb
+- lib/csp/version.rb
+- lib/csp_option_parser.rb
+- lib/shell.rb
+- lib/shell_result.rb
+homepage: https://github.com/denblackstache/icsp
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/denblackstache/icsp
+  source_code_uri: https://github.com/denblackstache/icsp
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: An interactive CryptoPro CSP shell
+test_files: []