sym 0.1.0 → 2.0.0

data/lib/sym/configuration.rb

@@ -0,0 +1,39 @@
+module Sym
+  # This class encapsulates application configuration, and exports
+  # a familiar method +#configure+ for defining configuration in a
+  # block.
+  #
+  # It's values are requested by the library upon encryption or
+  # decryption, or any other operation.
+  #
+  # == Example
+  #
+  # The following is an actual initialization from the code of this
+  # library. You may override any of the value defined below in your
+  # code, but _before_ you _use_ library's encryption methods.
+  #
+  #     Sym::Configuration.configure do |config|
+  #       config.password_cipher = 'AES-128-CBC'  #
+  #       config.data_cipher = 'AES-256-CBC'
+  #       config.private_key_cipher = config.data_cipher
+  #       config.compression_enabled = true
+  #       config.compression_level = Zlib::BEST_COMPRESSION
+  #     end
+  class Configuration
+    class << self
+      attr_accessor :config
+
+      def configure
+        self.config ||= Configuration.new
+        yield config if block_given?
+      end
+
+      def property(name)
+        self.config.send(name)
+      end
+    end
+
+    attr_accessor :data_cipher, :password_cipher, :private_key_cipher
+    attr_accessor :compression_enabled, :compression_level
+  end
+end

data/lib/sym/data.rb

@@ -0,0 +1,23 @@
+require_relative 'errors'
+require 'base64'
+require 'zlib'
+
+require_relative 'data/wrapper_struct'
+require_relative 'data/encoder'
+require_relative 'data/decoder'
+
+module Sym
+  # This module is responsible for taking arbitrary data of any format, and safely compressing
+  # the result of `Marshal.dump(data)` using Zlib, and then doing `#urlsafe_encode64` encoding
+  # to convert it to a string,
+  module Data
+    def encode(data, compress = true)
+      Encoder.new(data, compress).data_encoded
+    end
+
+    def decode(data_encoded, compress = nil)
+      Decoder.new(data_encoded, compress).data
+    end
+  end
+end
+

data/lib/sym/data/decoder.rb

@@ -0,0 +1,28 @@
+require_relative '../errors'
+require 'base64'
+require 'zlib'
+module Sym
+  module Data
+    class Decoder
+      attr_accessor :data, :data_encoded, :data
+
+      def initialize(data_encoded, compress)
+        self.data_encoded = data_encoded
+        self.data         = begin
+          Base64.urlsafe_decode64(data_encoded)
+        rescue
+          data_encoded
+        end
+
+        if compress.nil? || compress # auto-guess
+          self.data = begin
+            Zlib::Inflate.inflate(data)
+          rescue Zlib::Error => e
+            data
+          end
+        end
+        self.data = Marshal.load(data)
+      end
+    end
+  end
+end

data/lib/sym/data/encoder.rb

@@ -0,0 +1,24 @@
+require 'base64'
+require 'zlib'
+
+require 'sym/errors'
+require 'sym/configuration'
+
+module Sym
+  module Data
+    class Encoder
+      attr_accessor :data, :data_encoded
+
+      def initialize(data, compress)
+        self.data         = data
+        self.data_encoded = Marshal.dump(data)
+        self.data_encoded = Zlib::Deflate.deflate(data_encoded, compression_level) if compress
+        self.data_encoded = Base64.urlsafe_encode64(data_encoded)
+      end
+
+      def compression_level
+        Sym::Configuration.config.compression_level
+      end
+    end
+  end
+end

data/lib/sym/data/wrapper_struct.rb

@@ -0,0 +1,43 @@
+require_relative '../errors'
+module Sym
+  module Data
+    class WrapperStruct < Struct.new(
+      :encrypted_data,        # [Blob] Binary encrypted data (possibly compressed)
+      :iv,                    # [String] IV used to encrypt the data
+      :cipher_name,           # [String] Name of the cipher used
+      :salt,                  # [Integer] For password-encrypted data this is the salt
+      :version,               # [Integer] Version of the cipher used
+      :compress               # [Boolean] indicates if compression should be applied
+      )
+
+      VERSION = 1
+
+      attr_accessor :compressed
+
+      def initialize(
+        encrypted_data:, # [Blob] Binary encrypted data (possibly compressed)
+        iv:, # [String] IV used to encrypt the data
+        cipher_name:, # [String] Name of the cipher used
+        salt: nil, # [Integer] For password-encrypted data this is the salt
+        version: VERSION, # [Integer] Version of the cipher used
+        compress: Sym::Configuration.config.compression_enabled
+      )
+        super(encrypted_data, iv, cipher_name, salt, version, compress)
+      end
+
+      def config
+        Sym::Configuration.config
+      end
+
+      def serialize
+        Marshal.dump(self)
+      end
+
+      def self.deserialize(data)
+        Marshal.load(data)
+      end
+    end
+  end
+end
+
+

data/lib/sym/encrypted_file.rb

@@ -0,0 +1,34 @@
+require 'sym'
+require 'sym/application'
+require 'sym/app/args'
+
+module Sym
+  # This class provides a convenience wrapper for opening and reading
+  # encrypted files as they were regular files, and then possibly writing
+  # changes to them later.
+
+  class EncryptedFile
+
+    include Sym
+
+    attr_reader :application, :file, :key_id, :key_type, :app_args
+
+    def initialize(file:, key_id:, key_type:)
+      @file        = file
+      @key_id      = key_id
+      @key_type    = key_type.to_sym
+      @app_args    = { file: file, key_type => key_id, decrypt: true }
+      @application = Sym::Application.new(self.app_args)
+    end
+
+    def read
+      @content = application.execute! unless @content
+      @content
+    end
+
+    def write
+      Sym::Application.new(file: file, key_type => key_id, encrypt: true, output: file).execute
+    end
+  end
+end
+

data/lib/sym/errors.rb

@@ -0,0 +1,37 @@
+module Sym
+  # All public exceptions of this library are here.
+  module Errors
+    # Exceptions superclass for this library.
+    class Sym::Errors::Error < StandardError; end
+
+    # No secret has been provided for encryption or decryption
+    class InsufficientOptionsError < Sym::Errors::Error; end
+
+    class PasswordError < Sym::Errors::Error; end
+    class PasswordsDontMatch < Sym::Errors::PasswordError; end
+    class PasswordTooShort < Sym::Errors::PasswordError; end
+
+    class EditorExitedAbnormally < Sym::Errors::Error; end
+
+    class FileNotFound < Sym::Errors::Error; end
+
+    class DataEncodingVersionMismatch< Sym::Errors::Error; end
+
+    class KeyError < Sym::Errors::Error; end
+    class InvalidEncodingPrivateKey < Sym::Errors::KeyError; end
+    class InvalidPasswordPrivateKey < Sym::Errors::KeyError; end
+    class NoPrivateKeyFound < Sym::Errors::KeyError; end
+
+    class KeyChainCommandError < Sym::Errors::Error; end
+
+    # Method was called on an abstract class. Override such methods in
+    # subclasses, and use subclasses for instantiation of objects.
+    class AbstractMethodCalled < ArgumentError
+      def initialize(method, message = nil)
+        super("Abstract method call, on #{method}" + (message || ''))
+      end
+    end
+  end
+end
+
+

data/lib/sym/extensions/class_methods.rb

@@ -0,0 +1,12 @@
+require 'base64'
+require 'sym/cipher_handler'
+
+module Sym
+  module Extensions
+    module ClassMethods
+      def self.extended(klass)
+        klass.extend Sym::CipherHandler::ClassMethods
+      end
+    end
+  end
+end

data/lib/sym/extensions/instance_methods.rb

@@ -0,0 +1,114 @@
+require 'sym'
+require 'sym/data'
+require 'sym/cipher_handler'
+require 'openssl'
+module Sym
+  module Extensions
+    # This is the module that is really included in your class
+    # when you include +Sym+.
+    #
+    # The module provides easy access to the encryption configuration
+    # via the +#encryption_config+ method, as well as two key
+    # methods: +#encr+ and +#decr+.
+    #
+    # Methods +#encr_password+ and +#decr_password+ provide a good
+    # example of how this module can be extended to provide more uses
+    # of various ciphers, by calling into the private +_encr+ and +_decr+
+    # methods.f
+    module InstanceMethods
+      include Sym::Data
+      include Sym::CipherHandler
+
+      def encryption_config
+        Sym::Configuration.config
+      end
+
+      # Expects key to be a base64 encoded key
+      def encr(data, key, iv = nil)
+        raise Sym::Errors::NoPrivateKeyFound if key.nil?
+        _encr(data, encryption_config.data_cipher, iv) do |cipher_struct|
+          cipher_struct.cipher.key = decode_key(key)
+        end
+      end
+
+      # Expects key to be a base64 encoded key
+      def decr(encrypted_data, key, iv = nil)
+        raise Sym::Errors::NoPrivateKeyFound if key.nil?
+        _decr(encrypted_data, encryption_config.data_cipher, iv) do |cipher_struct|
+          cipher_struct.cipher.key = decode_key(key)
+        end
+      end
+
+      def encr_password(data, password, iv = nil)
+        _encr(data, encryption_config.password_cipher, iv) do |cipher_struct|
+          key, salt                = _key_from_password(cipher_struct.cipher, password)
+          cipher_struct.cipher.key = key
+          cipher_struct.salt       = salt
+        end
+      end
+
+      def decr_password(encrypted_data, password, iv = nil)
+        _decr(encrypted_data, encryption_config.password_cipher, iv) do |cipher_struct|
+          key,                     = _key_from_password(cipher_struct.cipher, password, cipher_struct.salt)
+          cipher_struct.cipher.key = key
+        end
+      end
+
+      private
+
+      def decode_key(encoded_key)
+        Base64.urlsafe_decode64(encoded_key)
+      rescue
+        encoded_key
+      end
+
+      def _key_from_password(cipher, password, salt = nil)
+        key_len = cipher.key_len
+        salt    ||= OpenSSL::Random.random_bytes 16
+        iter    = 20000
+        digest  = OpenSSL::Digest::SHA256.new
+        key     = OpenSSL::PKCS5.pbkdf2_hmac(password, salt, iter, key_len, digest)
+        return key, salt
+      end
+
+      # Expects key to be a base64 encoded key data
+      def _encr(data, cipher_name, iv = nil, &block)
+        data, compression_enabled = encode_incoming_data(data)
+        cipher_struct             = create_cipher(direction:   :encrypt,
+                                                  cipher_name: cipher_name,
+                                                  iv:          iv)
+
+        yield cipher_struct if block_given?
+
+        encrypted_data = update_cipher(cipher_struct.cipher, data)
+        wrapper_struct = WrapperStruct.new(
+          encrypted_data: encrypted_data,
+          iv:             cipher_struct.iv,
+          cipher_name:    cipher_struct.cipher.name,
+          salt:           cipher_struct.salt,
+          compress:       !compression_enabled)
+        encode(wrapper_struct, false)
+      end
+
+      # Expects key to be a base64 encoded key data
+      def _decr(encoded_data, cipher_name, iv = nil, &block)
+        wrapper_struct = decode(encoded_data)
+        cipher_struct  = create_cipher(cipher_name: cipher_name,
+                                       iv:          wrapper_struct.iv,
+                                       direction:   :decrypt,
+                                       salt:        wrapper_struct.salt)
+        yield cipher_struct if block_given?
+        decode(update_cipher(cipher_struct.cipher, wrapper_struct.encrypted_data))
+      end
+
+
+      def encode_incoming_data(data)
+        compression_enabled = !data.respond_to?(:size) || (data.size > 100 && encryption_config.compression_enabled)
+        data                = encode(data, compression_enabled)
+        [data, compression_enabled]
+      end
+
+    end
+  end
+end
+

data/lib/sym/version.rb

@@ -1,3 +1,3 @@
 module Sym
-  VERSION = "0.1.0"
+  VERSION = '2.0.0'
 end

data/sym.gemspec

@@ -2,25 +2,44 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'sym/version'
-
+BASH_COMPLETION = File.read("#{lib}/../bin/sym.bash-completion")
 Gem::Specification.new do |spec|
-  spec.name          = "sym"
+  spec.name          = 'sym'
   spec.version       = Sym::VERSION
-  spec.authors       = ["Konstantin Gredeskoul"]
-  spec.email         = ["kigster@gmail.com"]
+  spec.authors       = ['Konstantin Gredeskoul']
+  spec.email         = %w(kigster@gmail.com)
 
-  spec.summary       = %q{Sym encryption}
-  spec.description   = %q{Sym encryption}
-  spec.homepage      = "https://github.com/kigster/sym"
+  spec.summary       = %q{Simple tool to encrypt/decrypt data using symmetric aes-256-cbc encryption with a private key and an IV vector}
+  spec.description   = %q{Store sensitive data safely as encrypted strings or entire files, using symmetric aes-256-cbc encryption/decryption with a secret key and an IV vector, and YAML-friendly base64-encoded encrypted result.}
+  spec.homepage      = 'https://github.com/kigster/sym'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = "exe"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.2'
+  spec.post_install_message = "
+
+Please copy and paste the following BASH function into your ~/.bashrc or
+equivalent, in order to enable command completion:
+
+#{BASH_COMPLETION}
+
+Thank you for installing Sym!
+   -- KG (github.com/kigster)
+"
+
+  spec.add_dependency 'colored2', '~> 2.0'
+  spec.add_dependency 'slop', '~> 4.3'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'highline', '~> 1.7'
+  spec.add_dependency 'clipboard', '~> 1.1'
+  spec.add_dependency 'coin', '~> 0.1.8'
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'aruba'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'yard', '~> 0.9'
 end

metadata

@@ -1,29 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: sym
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-10 00:00:00.000000000 Z
+date: 2016-11-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: colored2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: clipboard
+  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: coin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,28 +164,130 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Sym encryption
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Store sensitive data safely as encrypted strings or entire files, using
+  symmetric aes-256-cbc encryption/decryption with a secret key and an IV vector,
+  and YAML-friendly base64-encoded encrypted result.
 email:
 - kigster@gmail.com
-executables: []
+executables:
+- keychain
+- sym
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
+- ".document"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
+- LICENSE
+- MANAGING-KEYS.md
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- bin/sym.bash-completion
+- exe/keychain
+- exe/sym
 - lib/sym.rb
+- lib/sym/app.rb
+- lib/sym/app/args.rb
+- lib/sym/app/cli.rb
+- lib/sym/app/commands.rb
+- lib/sym/app/commands/command.rb
+- lib/sym/app/commands/delete_keychain_item.rb
+- lib/sym/app/commands/encrypt_decrypt.rb
+- lib/sym/app/commands/generate_key.rb
+- lib/sym/app/commands/open_editor.rb
+- lib/sym/app/commands/print_key.rb
+- lib/sym/app/commands/show_examples.rb
+- lib/sym/app/commands/show_help.rb
+- lib/sym/app/commands/show_language_examples.rb
+- lib/sym/app/commands/show_version.rb
+- lib/sym/app/input/handler.rb
+- lib/sym/app/keychain.rb
+- lib/sym/app/nlp.rb
+- lib/sym/app/nlp/constants.rb
+- lib/sym/app/nlp/translator.rb
+- lib/sym/app/nlp/usage.rb
+- lib/sym/app/output.rb
+- lib/sym/app/output/base.rb
+- lib/sym/app/output/file.rb
+- lib/sym/app/output/noop.rb
+- lib/sym/app/output/stdout.rb
+- lib/sym/app/password/cache.rb
+- lib/sym/app/private_key/base64_decoder.rb
+- lib/sym/app/private_key/decryptor.rb
+- lib/sym/app/private_key/detector.rb
+- lib/sym/app/private_key/handler.rb
+- lib/sym/app/short_name.rb
+- lib/sym/application.rb
+- lib/sym/cipher_handler.rb
+- lib/sym/configuration.rb
+- lib/sym/data.rb
+- lib/sym/data/decoder.rb
+- lib/sym/data/encoder.rb
+- lib/sym/data/wrapper_struct.rb
+- lib/sym/encrypted_file.rb
+- lib/sym/errors.rb
+- lib/sym/extensions/class_methods.rb
+- lib/sym/extensions/instance_methods.rb
 - lib/sym/version.rb
 - sym.gemspec
 homepage: https://github.com/kigster/sym
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message: |2
+
+
+  Please copy and paste the following BASH function into your ~/.bashrc or
+  equivalent, in order to enable command completion:
+
+  #!/usr/bin/env bash
+  #
+  # Sym command line completion
+  #
+  # © 2015-2016, Konstantin Gredeskoul,  https://github.com/kigster/sym
+  # MIT LICENSE
+  #
+
+  _sym() {
+      local SYM_OPTS SYM_POINTS cur prev
+
+      cur="${COMP_WORDS[COMP_CWORD]}"
+      prev="${COMP_WORDS[COMP_CWORD-1]}"
+
+      COMPREPLY=()
+
+      SYM_COMP_OPTIONS=$(sym --dictionary)
+      [[ $COMP_CWORD == 1 ]] && SYM_COMP_OPTIONS="${SYM_COMP_OPTIONS} ${SYM_COMMANDS}"
+      COMPREPLY=( $(compgen -W "${SYM_COMP_OPTIONS}" -- ${cur}) )
+      return 0
+  }
+
+  complete -F _sym sym
+
+
+
+  Thank you for installing Sym!
+     -- KG (github.com/kigster)
 rdoc_options: []
 require_paths:
 - lib
@@ -81,7 +295,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -92,5 +306,6 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Sym encryption
+summary: Simple tool to encrypt/decrypt data using symmetric aes-256-cbc encryption
+  with a private key and an IV vector
 test_files: []