izokatu 0.1.1

data/lib/izokatu/importer/file_importer.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Izokatu
+  # Izokatu importer for importing data from some file
+  class FileImporter
+    extend Callable
+
+    include Contracts
+    include Izokatu::Helpers
+
+    # @return [String] name of file to import from
+    attr_reader :filename
+    # @return [TrueClass, FalseClass] status of ability to delete file after import
+    attr_reader :delete_imported
+    # @return [TrueClass || FalseClass] status of ability to decode imported data
+    attr_reader :decode
+
+    Contract Contracts::HashOf[Symbol, Or[String, Bool]] => Any
+    # Initializing options for import
+    #
+    # @param filename (#filename)
+    # @param delete_imported (#delete_imported)
+    # @param decode (#decode)
+    #
+    # @since 0.1.0
+    def initialize(filename:, delete_imported:, decode:)
+      @filename = filename
+      @delete_imported = delete_imported
+      @decode = decode
+    end
+
+    Contract None => Contracts::HashOf[Symbol, String]
+    # Performing import of data
+    #
+    # @return [Hash] imported data
+    #
+    # @since 0.1.0
+    def perform
+      raise 'No data file!' unless File.exist?(filename)
+
+      encoded = File.readlines(filename, chomp: true)
+      File.delete(filename) if delete_imported
+      data = { data: encoded.length == 1 ? encoded[0] : encoded.join("\n") }
+      decode ? decode_data(data) : data
+    end
+  end
+end

data/lib/izokatu/importer/function_importer.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Izokatu
+  # Izokatu importer for importing data from some function, via :data param
+  class FunctionImporter
+    extend Callable
+
+    include Contracts
+    include Izokatu::Helpers
+
+    # @return [String] data for import
+    attr_reader :data
+
+    Contract Contracts::HashOf[Symbol, Or[Contracts::HashOf[Symbol, Maybe[String]], String, Bool]] =>
+             Or[Contracts::HashOf[Symbol, Maybe[String]], String]
+    # Initializing options for import
+    #
+    # @param data (#data)
+    # @param decode [TrueClass || FalseClass] Enable/disable decoding of imported data
+    #
+    # @since 0.1.0
+    def initialize(data:, decode:)
+      @data = decode ? decode_data(data) : data
+    end
+
+    Contract None => Or[Contracts::HashOf[Symbol, Maybe[String]], String]
+    # Performing import of data
+    #
+    # @return [Hash] imported data
+    #
+    # @since 0.1.0
+    def perform
+      data
+    end
+  end
+end

data/lib/izokatu/izokatu_elements_requires.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative 'callable'
+require_relative 'ciphers'
+require_relative 'helpers'
+
+require_relative 'exporter'
+require_relative 'exporter/function_exporter'
+require_relative 'exporter/file_exporter'
+require_relative 'exporter/stdout_exporter'
+
+require_relative 'importer/function_importer'
+require_relative 'importer/file_importer'
+
+require_relative 'keys_generator'
+require_relative 'encrypter'
+require_relative 'decrypter'
+
+require_relative 'openssl/private_key/default/encrypter'
+require_relative 'openssl/private_key/auth/encrypter'
+require_relative 'openssl/private_key/auth/ccm/encrypter'
+
+require_relative 'openssl/private_key/default/decrypter'
+require_relative 'openssl/private_key/auth/decrypter'
+require_relative 'openssl/private_key/auth/ccm/decrypter'
+
+require_relative 'openssl/public_key/rsa/keys_generator'
+require_relative 'openssl/public_key/rsa/encrypter'
+require_relative 'openssl/public_key/rsa/decrypter'
+
+require_relative 'openssl/public_key/ec/keys_generator'
+require_relative 'openssl/public_key/ec/encrypter'
+require_relative 'openssl/public_key/ec/decrypter'
+
+require_relative 'rbnacl/encrypter'
+require_relative 'rbnacl/decrypter'
+
+require_relative 'rbnacl/private_key/encrypter'
+require_relative 'rbnacl/private_key/decrypter'
+
+require_relative 'rbnacl/public_key/keys_generator'
+require_relative 'rbnacl/public_key/encrypter'
+require_relative 'rbnacl/public_key/decrypter'
+
+require_relative 'action_call_selector'
+require_relative 'action_call_options_selector'

data/lib/izokatu/keys_generator.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Izokatu
+  # Abstract class for keys generators
+  #
+  # @abstract Subclasses are containing implementation of {#generate_private_key} and {#generate_public_key}
+  class KeysGenerator
+    extend Callable
+
+    include Contracts
+
+    # Default key symbols for RbNaCl and OpenSSL keys
+    KEYS_SYMBOLS = %i[private_key public_key].freeze
+    # Classes of RbNaCl and OpenSSL keys
+    KEY_CLASSES = [
+      RbNaCl::Boxes::Curve25519XSalsa20Poly1305::PrivateKey,
+      RbNaCl::Boxes::Curve25519XSalsa20Poly1305::PublicKey,
+      OpenSSL::PKey::RSA,
+      OpenSSL::PKey::EC
+    ].freeze
+
+    Contract None => Contracts::HashOf[Or[*KEYS_SYMBOLS], Or[*KEY_CLASSES]]
+    # Performing generation of private and public keys
+    #
+    # @return [Hash] public and private keys
+    #
+    # @since 0.1.0
+    def perform
+      generate_private_key
+        .then { |private_key| { private_key: private_key, public_key: generate_public_key(private_key) } }
+    end
+
+    private
+
+    # Performing generation of private key
+    #
+    # @raise RuntimeError
+    #
+    # @since 0.1.0
+    def generate_private_key
+      raise 'Not implemented!'
+    end
+
+    # Performing generation of public key
+    #
+    # @raise RuntimeError
+    #
+    # @since 0.1.0
+    def generate_public_key(_private_key)
+      raise 'Not implemented!'
+    end
+  end
+end

data/lib/izokatu/openssl/private_key/auth/ccm/decrypter.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Izokatu
+  module Openssl
+    module PrivateKey
+      module Auth
+        # Namespace for OpenSSL private key authenticated CCM classes
+        module CCM
+          # OpenSSL private key decrypter for authenticated ciphers in CCM mode
+          class Decrypter < Izokatu::Openssl::PrivateKey::Auth::Decrypter
+            # Default iv (nonce) length for ciphers in CCM mode
+            DEFAULT_CCM_IV_LENGTH = 7
+            # Default authentication tag length for ciphers in CCM mode
+            DEFAULT_CCM_AUTH_TAG_LENGTH = 8
+
+            private
+
+            Contract None => Any
+            # Initializing decrypter params
+            #
+            # @since 0.1.0
+            def initialize_decrypter_params!
+              initialize_auth_ccm_decrypter_params!
+              super
+            end
+
+            Contract None => Any
+            # Set length for iv and auth_tag before their initialization
+            #
+            # @since 0.1.0
+            def initialize_auth_ccm_decrypter_params!
+              decrypter.iv_len = DEFAULT_CCM_IV_LENGTH
+              decrypter.auth_tag_len = DEFAULT_CCM_AUTH_TAG_LENGTH
+            end
+
+            Contract None => Any
+            # Initializing decrypter auth params
+            #
+            # @since 0.1.0
+            def initialize_auth_decrypter_params!
+              initialize_static_message_length!
+              super
+            end
+
+            Contract None => Any
+            # Initializing message length for cipher in CCM mode
+            #
+            # @since 0.1.0
+            def initialize_static_message_length!
+              decrypter.ccm_data_len = encrypted_data.length unless cipher.include?('ARIA')
+            end
+
+            # Raising exception if auth tag is truncated
+            # @note Redefined to use local auth tag length
+            #
+            # @raise RuntimeError
+            #
+            # @since 0.1.0
+            def verify_tag_size!
+              raise 'tag is truncated!' unless auth_tag.bytesize == DEFAULT_CCM_AUTH_TAG_LENGTH
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/izokatu/openssl/private_key/auth/ccm/encrypter.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Izokatu
+  module Openssl
+    module PrivateKey
+      module Auth
+        module CCM
+          # OpenSSL private key encrypter for authenticated ciphers in CCM mode
+          class Encrypter < Izokatu::Openssl::PrivateKey::Auth::Encrypter
+            # Default iv (nonce) length for ciphers in CCM mode
+            DEFAULT_CCM_IV_LENGTH = 7
+            # Default authentication tag length for ciphers in CCM mode
+            DEFAULT_CCM_AUTH_TAG_LENGTH = 8
+
+            private
+
+            Contract None => Any
+            # Initializing encrypter params
+            #
+            # @since 0.1.0
+            def initialize_encrypter_params!
+              initialize_auth_ccm_encrypter_params!
+              super
+            end
+
+            Contract None => Any
+            # Set length for iv and auth_tag before their initialization
+            #
+            # @since 0.1.0
+            def initialize_auth_ccm_encrypter_params!
+              encrypter.iv_len = DEFAULT_CCM_IV_LENGTH
+              encrypter.auth_tag_len = DEFAULT_CCM_AUTH_TAG_LENGTH
+            end
+
+            Contract Maybe[String] => Any
+            # Initializing encrypter auth params
+            #
+            # @since 0.1.0
+            def initialize_auth_encrypter_params!(auth_data)
+              initialize_static_message_length!
+              super
+            end
+
+            Contract None => Any
+            # Initializing message length for cipher in CCM mode
+            #
+            # @since 0.1.0
+            def initialize_static_message_length!
+              encrypter.ccm_data_len = clear_data.length unless cipher.include?('ARIA')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/izokatu/openssl/private_key/auth/decrypter.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Izokatu
+  module Openssl
+    module PrivateKey
+      # Namespace for OpenSSL private key authenticated classes
+      module Auth
+        # OpenSSL private key decrypter for authenticated ciphers
+        class Decrypter < Izokatu::Openssl::PrivateKey::Default::Decrypter
+          # @return [String] authenticated data
+          attr_reader :auth_data
+          # @return [String] authentication tag
+          attr_reader :auth_tag
+
+          # Default Openssl::PrivateKey::Auth::Decrypter option
+          DEFAULT_AUTH_TAG_LENGTH = 16
+
+          Contract Contracts::HashOf[Symbol, Maybe[String]] => Any
+          # Initializing options for OpenSSL EC decryption
+          #
+          # @param encrypted_data (#encrypted_data)
+          # @param cipher (#cipher)
+          # @param key (#key)
+          # @param nonce (#nonce)
+          # @param auth_data (#auth_data)
+          # @param auth_tag (#auth_tag)
+          #
+          # @since 0.1.0
+          def initialize(auth_data:, auth_tag:, cipher:, encrypted_data:, key:, nonce:)
+            @auth_data = auth_data
+            @auth_tag = auth_tag
+            super(cipher: cipher, encrypted_data: encrypted_data, key: key, nonce: nonce)
+          end
+
+          Contract None => Contracts::HashOf[Symbol, String]
+          # Initializing decrypter
+          #
+          # @return [OpenSSL::Cipher] decrypter instance
+          #
+          # @since 0.1.0
+          def perform
+            verify_tag_size!
+            super
+          end
+
+          private
+
+          Contract None => Any
+          # Initializing decrypter params
+          #
+          # @since 0.1.0
+          def initialize_decrypter_params!
+            super
+            initialize_auth_decrypter_params!
+          end
+
+          Contract None => Any
+          # Initializing decrypter auth params
+          #
+          # @since 0.1.0
+          def initialize_auth_decrypter_params!
+            # unless added just for ARIA-***-CCM ciphers
+            decrypter.auth_data = auth_data unless cipher.include?('ARIA')
+            decrypter.auth_tag = auth_tag
+          end
+
+          # Raising exception if auth tag is truncated
+          #
+          # @raise RuntimeError
+          #
+          # @since 0.1.0
+          def verify_tag_size!
+            raise 'tag is truncated!' unless auth_tag.bytesize == DEFAULT_AUTH_TAG_LENGTH
+          end
+        end
+      end
+    end
+  end
+end

data/lib/izokatu/openssl/private_key/auth/encrypter.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Izokatu
+  module Openssl
+    module PrivateKey
+      module Auth
+        # OpenSSL private key encrypter for authenticated ciphers
+        class Encrypter < Izokatu::Openssl::PrivateKey::Default::Encrypter
+          # @return [String] authenticated data
+          attr_reader :auth_data
+
+          # Default Openssl::PrivateKey::Auth::Encrypter option
+          DEFAULT_AUTH_OPTIONS = {
+            auth_data: ''
+          }.freeze
+
+          Contract Contracts::HashOf[Symbol, Maybe[String]] => Any
+          # Initializing options for OpenSSL EC encryption
+          #
+          # @param cipher (#cipher)
+          # @param clear_data (#clear_data)
+          # @param auth_data (#auth_data)
+          #
+          # @since 0.1.0
+          def initialize(cipher:, clear_data:, auth_data:)
+            super(cipher: cipher, clear_data: clear_data)
+            initialize_auth_encrypter_params!(auth_data)
+          end
+
+          private
+
+          Contract Maybe[String] => Maybe[String]
+          # Initializing encrypter auth param
+          #
+          # @return [String] authenticated data
+          #
+          # @since 0.1.0
+          def initialize_auth_encrypter_params!(auth_data)
+            @auth_data = auth_data || DEFAULT_AUTH_OPTIONS[:auth_data]
+            encrypter.auth_data = @auth_data
+          end
+
+          Contract None => Contracts::ArrayOf[Contracts::HashOf[Symbol, String]]
+          # Encrypting data
+          #
+          # @return [Array] encrypted data with decrypter params
+          #
+          # @since 0.1.0
+          def encrypt_data!
+            encrypted_data, decrypter_params = super
+            decrypter_params[:auth_data] = auth_data
+            decrypter_params.merge!(compute_auth_tag!)
+            [encrypted_data, decrypter_params]
+          end
+
+          Contract None => Contracts::HashOf[Symbol, String]
+          # Computing authentication tag
+          #
+          # @return [Hash] authentication tag
+          #
+          # @since 0.1.0
+          def compute_auth_tag!
+            { auth_tag: encrypter.auth_tag }
+          end
+        end
+      end
+    end
+  end
+end