obfus 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 51e71e8417dd0832c1324a8d6cfcb8139d3862a1353e81bfb25ffd30cf89019d
+  data.tar.gz: 13ec0652fc092f92e922ea22454fdb2f4477fa93151ea74ca35ef9f10e5c814c
+SHA512:
+  metadata.gz: 309c4004e6c09cfe4b37a5706c0f2abd02d321d6f079950d9a1c9a6f3a8446a80ab50cd80728f9838b92cea5fce8fa188d2b4402a792e76cabe7622ae2e713e2
+  data.tar.gz: a14c98fc22b8b722af6a0f45e7d075dc7868e9b0c5edb2909016371512967c3f17e1d35a82f4c85c4b19253541205f367eb2255b7b82d957723d3956bfbb56e8

data/.gitignore

@@ -0,0 +1,85 @@
+# example folder
+example/
+
+
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+# build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/_yardoc/
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+# TODO: ignore rspec last status?
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in obfus.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    obfus (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  obfus!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.2

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler/gem_tasks'
+
+task :default => :test
+
+desc 'Run the tests'
+task :test do
+  sh 'rspec spec'
+end
+
+task :standalone do
+  mkdir_p 'build'
+  File.open('build/obfus', 'w') do |f|
+    f.puts '#!/usr/bin/env ruby'
+    f.puts ''
+    f.puts File.read('bin/obfus').split("require 'obfus/main'\n")[1].prepend(File.read('lib/obfus/main.rb'))
+  end
+  
+  sh 'chmod +x build/obfus'
+end
+
+desc 'Install standalone script and man page.'
+task :install => :standalone do
+  prefix = ENV['PREFIX'] || ENV['prefix'] || '/usr/local'
+
+  mkdir_p "#{prefix}/bin"
+  ln_s "build/obfus", "#{prefix}/bin/obfus"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'obfus'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/obfus

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'obfus/main'
+
+Obfus.exec(ARGV)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/build/obfus

@@ -0,0 +1,257 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'ostruct'
+require 'fileutils'
+require 'open3'
+require 'yaml'
+
+module Obfus
+  class << self
+    CONFIG_LOCATIONS = [
+      File.join(ENV['HOME'], '.config', 'obfus', '{.,}config*'),
+      File.join(ENV['HOME'], '.config', 'obfus', '.obfus{config*,rc}'),
+      File.join(ENV['HOME'], '.obfus{config*,rc}')
+    ].freeze
+
+    OPTIONS = {
+      mode: :compress,
+      preset: nil,
+      level: 9,
+      keep: true,
+      recipients: [],
+      verbosity: :normal
+    }.freeze
+
+    def find_config
+      list = []
+      CONFIG_LOCATIONS.each do |pattern|
+        list += Dir.glob pattern
+      end
+
+      if list.count < 1
+        # no config file detected
+        nil
+      elsif list.count > 1
+        # TODO: print warning (multiple config files: <list...>, reading from <path>)
+        puts 'error: encountered multiple configuration files:'
+        list.each do |l|
+          puts File.expand_path l
+        end
+        puts "reading from: #{File.expand_path list[0]}"
+        nil
+      else
+        list[0]
+      end
+    end
+
+    def parse_config(file)
+      parsed = nil
+      File.open(file, 'r') do |f|
+        parsed = YAML.safe_load f.read
+      end
+      parsed
+    end
+
+    def apply_config(options)
+      file = find_config
+      opts = OpenStruct.new OPTIONS
+      config = nil
+      unless file.nil?
+        config = parse_config(file)
+        if options.preset.nil?
+          if config['default'].nil?
+            # use native defaults
+          else
+            # use config file
+            opts = OpenStruct.new config['default']
+            opts.preset = 'default'
+          end
+        else
+          # use preset
+          opts = OpenStruct.new config[options.preset]
+        end
+      end
+
+      # override
+      options.each_pair do |k, v|
+        opts[k] = v
+      end
+
+      opts['keep'] = true if opts['keep'].nil?
+
+      opts['config'] = file
+
+      opts
+    end
+
+    def ensure_file(name)
+      path = File.expand_path name
+      File.exist? path
+    end
+
+    def compress(files, options)
+      archive_name = 'Archive'
+      if files.count < 1
+        puts 'error: no files specified'
+        puts 'try `obfus --help`'
+        exit 1
+      elsif files.count == 1
+        # call it the name of the file
+        archive_name = File.basename files[0], '.*'
+      end
+
+      unless options.output.nil?
+        archive_name = options.output.strip
+        archive_name.gsub!(/^.*(\\|\/)/, '')
+      end
+
+      unless options.force
+        if ensure_file(archive_name)
+          # file already exists
+          puts "error: file #{archive_name} already exists"
+          puts 'to overwrite the file use `--force`'
+          exit 1
+        end
+      end
+
+      files.each do |file|
+        next if ensure_file(file)
+        # TODO: file <file> does not exist!
+        puts "error: #{file} does not exist"
+        exit 1
+      end
+
+      if options.recipients.count < 1
+        # TODO: throw error! no recipients specified
+        puts 'error: no recipients specified'
+        puts 'try `obfus --help`'
+        exit 1
+      end
+
+      if options.verbosity == :verbose
+        unless options.verbosity == :quiet
+          puts 'using config file: ' + options.config
+          puts 'using preset: ' + options.preset
+          puts 'keeping original files: ' + options.keep.to_s
+          puts 'compression quality: ' + options.level.to_s
+          puts 'compressing:'
+          files.each { |f| puts '- ' + f }
+          puts
+          puts 'recipients:'
+          options.recipients.each { |r| puts '- ' + r }
+          puts
+        end
+      end
+
+      File.open archive_name, 'w' do |f|
+        # add recipients `-r <recipient>`
+        recipients = []
+
+        options.recipients.each do |r|
+          recipients << '-r'
+          recipients << r
+        end
+
+        Open3.pipeline_r(
+          ['tar', 'cf', '-', *files],
+          ['brotli', '-cq', options.level.to_s],
+          ['gpg', '-eq', *recipients]
+        ) do |o, _ts|
+          # ts.each { |t| puts t.pid, t.status }
+          f.write o.read
+        end
+      end
+    end
+
+    def decompress(file)
+      # TODO: iterate over files
+      unless ensure_file(file)
+        puts "error: file #{file} does not exist"
+        exit 1
+      end
+
+      Open3.pipeline_r(
+        ['gpg', '-dq', file],
+        ['brotli', '-dc'],
+        ['tar', '-x']
+      ) do |o, ts|
+        # ts.each { |t| puts t.pid, t.status }
+      end
+    end
+
+    def exec(args)
+      options = OpenStruct.new
+
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = "\nUsage: obfus [options] <file...>"
+        opts.separator ''
+        opts.separator 'Operation Modes:'
+        opts.on('-z', '--compress', 'Compress operation mode (default)') do
+          options.mode = :compress
+        end
+        opts.on('-d', '--decompress', 'Decompress operation mode') do
+          options.mode = :decompress
+        end
+
+        opts.separator ''
+        opts.separator 'Options:'
+        opts.on('-o', '--output NAME', 'Specify the output file name') do |name|
+          options.output = name
+        end
+        opts.on('-f', '--force', 'Overwrites output file if conflicts with an existing one') do |v|
+          options.force = v
+        end
+        opts.on('-p', '--preset NAME', 'Use a configuration preset') do |name|
+          options.preset = name
+        end
+        opts.on('-l', '--level [0..9]', Integer, 'Specify compression level (defaults to 9)') do |v|
+          options.level = v
+        end
+        opts.on('-k', '--[no-]keep', 'Keep the original files') do |keep|
+          options.keep = keep
+        end
+        opts.on('-r', '--recipients x,y,z', Array, 'Add recipients list') do |list|
+          options.recipients = [] if options.recipient.nil?
+          options.recipients += list
+        end
+
+        opts.on('-v', '--verbose', 'Run verbosely') do
+          options.verbosity = :verbose
+        end
+        opts.on('-q', '--quiet', 'Suppress any output') do
+          options.verbosity = :quiet
+        end
+
+        opts.separator ''
+        opts.separator 'Other options:'
+        opts.on_tail('--version', 'Show the version number') do
+          puts Obfus::VERSION
+          exit
+        end
+
+        opts.on_tail('-h', '--help', 'Show this message') do
+          puts opts
+          exit
+        end
+      end
+
+      opt_parser.parse!(args)
+
+      options = apply_config(options)
+
+      if options.mode == :decompress
+        # decompress archive
+        decompress(ARGV[0])
+      else
+        # compress
+        compress(ARGV, options)
+      end
+
+      # puts options
+      # puts ARGV
+    end # exec()
+  end # class << self
+end # module Obfus
+
+Obfus.exec(ARGV)

data/lib/obfus/main.rb

@@ -0,0 +1,253 @@
+require 'optparse'
+require 'ostruct'
+require 'fileutils'
+require 'open3'
+require 'yaml'
+
+module Obfus
+  class << self
+    CONFIG_LOCATIONS = [
+      File.join(ENV['HOME'], '.config', 'obfus', '{.,}config*'),
+      File.join(ENV['HOME'], '.config', 'obfus', '.obfus{config*,rc}'),
+      File.join(ENV['HOME'], '.obfus{config*,rc}')
+    ].freeze
+
+    OPTIONS = {
+      mode: :compress,
+      preset: nil,
+      level: 9,
+      keep: true,
+      recipients: [],
+      verbosity: :normal
+    }.freeze
+
+    def find_config
+      list = []
+      CONFIG_LOCATIONS.each do |pattern|
+        list += Dir.glob pattern
+      end
+
+      if list.count < 1
+        # no config file detected
+        nil
+      elsif list.count > 1
+        # TODO: print warning (multiple config files: <list...>, reading from <path>)
+        puts 'error: encountered multiple configuration files:'
+        list.each do |l|
+          puts File.expand_path l
+        end
+        puts "reading from: #{File.expand_path list[0]}"
+        nil
+      else
+        list[0]
+      end
+    end
+
+    def parse_config(file)
+      parsed = nil
+      File.open(file, 'r') do |f|
+        parsed = YAML.safe_load f.read
+      end
+      parsed
+    end
+
+    def apply_config(options)
+      file = find_config
+      opts = OpenStruct.new OPTIONS
+      config = nil
+      unless file.nil?
+        config = parse_config(file)
+        if options.preset.nil?
+          if config['default'].nil?
+            # use native defaults
+          else
+            # use config file
+            opts = OpenStruct.new config['default']
+            opts.preset = 'default'
+          end
+        else
+          # use preset
+          opts = OpenStruct.new config[options.preset]
+        end
+      end
+
+      # override
+      options.each_pair do |k, v|
+        opts[k] = v
+      end
+
+      opts['keep'] = true if opts['keep'].nil?
+
+      opts['config'] = file
+
+      opts
+    end
+
+    def ensure_file(name)
+      path = File.expand_path name
+      File.exist? path
+    end
+
+    def compress(files, options)
+      archive_name = 'Archive'
+      if files.count < 1
+        puts 'error: no files specified'
+        puts 'try `obfus --help`'
+        exit 1
+      elsif files.count == 1
+        # call it the name of the file
+        archive_name = File.basename files[0], '.*'
+      end
+
+      unless options.output.nil?
+        archive_name = options.output.strip
+        archive_name.gsub!(/^.*(\\|\/)/, '')
+      end
+
+      unless options.force
+        if ensure_file(archive_name)
+          # file already exists
+          puts "error: file #{archive_name} already exists"
+          puts 'to overwrite the file use `--force`'
+          exit 1
+        end
+      end
+
+      files.each do |file|
+        next if ensure_file(file)
+        # TODO: file <file> does not exist!
+        puts "error: #{file} does not exist"
+        exit 1
+      end
+
+      if options.recipients.count < 1
+        # TODO: throw error! no recipients specified
+        puts 'error: no recipients specified'
+        puts 'try `obfus --help`'
+        exit 1
+      end
+
+      if options.verbosity == :verbose
+        unless options.verbosity == :quiet
+          puts 'using config file: ' + options.config
+          puts 'using preset: ' + options.preset
+          puts 'keeping original files: ' + options.keep.to_s
+          puts 'compression quality: ' + options.level.to_s
+          puts 'compressing:'
+          files.each { |f| puts '- ' + f }
+          puts
+          puts 'recipients:'
+          options.recipients.each { |r| puts '- ' + r }
+          puts
+        end
+      end
+
+      File.open archive_name, 'w' do |f|
+        # add recipients `-r <recipient>`
+        recipients = []
+
+        options.recipients.each do |r|
+          recipients << '-r'
+          recipients << r
+        end
+
+        Open3.pipeline_r(
+          ['tar', 'cf', '-', *files],
+          ['brotli', '-cq', options.level.to_s],
+          ['gpg', '-eq', *recipients]
+        ) do |o, _ts|
+          # ts.each { |t| puts t.pid, t.status }
+          f.write o.read
+        end
+      end
+    end
+
+    def decompress(file)
+      # TODO: iterate over files
+      unless ensure_file(file)
+        puts "error: file #{file} does not exist"
+        exit 1
+      end
+
+      Open3.pipeline_r(
+        ['gpg', '-dq', file],
+        ['brotli', '-dc'],
+        ['tar', '-x']
+      ) do |o, ts|
+        # ts.each { |t| puts t.pid, t.status }
+      end
+    end
+
+    def exec(args)
+      options = OpenStruct.new
+
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = "\nUsage: obfus [options] <file...>"
+        opts.separator ''
+        opts.separator 'Operation Modes:'
+        opts.on('-z', '--compress', 'Compress operation mode (default)') do
+          options.mode = :compress
+        end
+        opts.on('-d', '--decompress', 'Decompress operation mode') do
+          options.mode = :decompress
+        end
+
+        opts.separator ''
+        opts.separator 'Options:'
+        opts.on('-o', '--output NAME', 'Specify the output file name') do |name|
+          options.output = name
+        end
+        opts.on('-f', '--force', 'Overwrites output file if conflicts with an existing one') do |v|
+          options.force = v
+        end
+        opts.on('-p', '--preset NAME', 'Use a configuration preset') do |name|
+          options.preset = name
+        end
+        opts.on('-l', '--level [0..9]', Integer, 'Specify compression level (defaults to 9)') do |v|
+          options.level = v
+        end
+        opts.on('-k', '--[no-]keep', 'Keep the original files') do |keep|
+          options.keep = keep
+        end
+        opts.on('-r', '--recipients x,y,z', Array, 'Add recipients list') do |list|
+          options.recipients = [] if options.recipient.nil?
+          options.recipients += list
+        end
+
+        opts.on('-v', '--verbose', 'Run verbosely') do
+          options.verbosity = :verbose
+        end
+        opts.on('-q', '--quiet', 'Suppress any output') do
+          options.verbosity = :quiet
+        end
+
+        opts.separator ''
+        opts.separator 'Other options:'
+        opts.on_tail('--version', 'Show the version number') do
+          puts Obfus::VERSION
+          exit
+        end
+
+        opts.on_tail('-h', '--help', 'Show this message') do
+          puts opts
+          exit
+        end
+      end
+
+      opt_parser.parse!(args)
+
+      options = apply_config(options)
+
+      if options.mode == :decompress
+        # decompress archive
+        decompress(ARGV[0])
+      else
+        # compress
+        compress(ARGV, options)
+      end
+
+      # puts options
+      # puts ARGV
+    end # exec()
+  end # class << self
+end # module Obfus

data/lib/obfus/version.rb

@@ -0,0 +1,3 @@
+module Obfus
+  VERSION = '0.1.2'.freeze
+end

data/lib/obfus.rb

@@ -0,0 +1,5 @@
+require 'obfus/version'
+require 'obfus/main'
+
+module Obfus
+end

data/license.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 everdrone
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/obfus.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'obfus/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'obfus'
+  spec.version       = Obfus::VERSION
+  spec.authors       = ['everdrone']
+  spec.email         = ['giorgiotropiano@gmail.com']
+
+  spec.summary       = 'File compression and encryption tool'
+  spec.description   = 'With the top notch of both compression and encryption technology, `obfus` makes it easy to pack and back up sensitive data in a few keystrokes.'
+  spec.homepage      = 'https://github.com/everdrone/obfus'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = 'obfus'
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/readme.md

@@ -0,0 +1,104 @@
+# obfus
+> File compression and encryption tool
+
+## Under development!
+
+With the top notch of both compression and encryption technology, `obfus` makes it easy to pack and back up sensitive data in a few keystrokes.
+
+### Requirements
+- [Brotli](https://github.com/google/brotli)
+- [GnuPG](https://github.com/gpg/gnupg)
+
+## Install
+
+```bash
+brew install obfus
+```
+
+## Usage
+
+#### Archive
+```bash
+obfus readme.md src/**/*.rb -o backup.obfus
+```
+
+#### Unarchive
+```bash
+obfus -d backup.obfus
+```
+
+## Features
+
+### Configuration file
+Before each operation, `obfus` searches for a configuration file, usually located in `~/.config/obfus/` or in your home directory.
+
+The config file can be both in `json` or `yaml` format.
+
+Inside the configuration file you can define a list of presets that can be used when `obfus` archives data.
+
+Example configuration file:
+```yaml
+# ~/.config/obfus/config.yml
+
+default:
+  recipients:
+    - myself@mail.com
+  level: 9
+  keep: false
+
+work:
+  recipients:
+    - coworker@company.com
+    - boss@company.com
+  level: 3
+  keep: true
+  verbosity: verbose
+
+backup:
+  recipients:
+    - myself@mail.com
+  level: 11
+  verbosity: verbose
+```
+
+By default `obfus` uses the `default` preset if present, otherwise it will operate with the program's native defaults.
+
+To specify a preset use the `-p` option:
+
+```bash
+obfus -p work ~/Documents/work/
+```
+
+The configuration file's sole purpose is to make it easier to pick the settings and apply them on the fly every time you need.
+To ovveride the current preset settings or the default settings just pass more options as arguments.
+
+For example, to add a recipient to the archive without altering the config file use the `-r` option:
+
+```bash
+obfus -p work ~/Documents/work/ -r mommy@mail.com,daddy@mail.com
+```
+
+#### Configuration file location
+- `~/.config/obfus/config{,.json,.yaml,.yml}`
+- `~/.obfus{rc,config}`
+
+### Options
+
+|Name|Shorthand|Functionality|Default|
+|-|-|-|-|
+|`--compress`|`-z`|Compress operation mode|yes|
+|`--decompress`|`-d`|Decompress operation mode|no|
+|`--output FILE`|`-o`|Specify the output file name||
+|`--force`|`-f`|Force overwrite the output file if it already exists|`false`|
+|`--preset NAME`|`-p`|Use a preset configuration from the config file|`default`|
+|`--level [0..9]`|`-l`|Specify the compression level (as in brotli)|`9`|
+|`--keep`|`-k`|Keep the original files|`true`|
+|`--recipients X,Y,Z`|`-r`|Add recipients||
+|`--verbose`|`-v`|Prints more stuff||
+|`--quiet`|`-q`|Prints nothing but errors, if any||
+|`--version`||Print the version and exit||
+|`--help`|`-h`|Print the help message and exit||
+
+> Options can be concatenated, like in many unix programs:
+>
+> `obfus files/* -zvr some@mail.com -fko output.obfus`

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: obfus
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- everdrone
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: With the top notch of both compression and encryption technology, `obfus`
+  makes it easy to pack and back up sensitive data in a few keystrokes.
+email:
+- giorgiotropiano@gmail.com
+executables:
+- obfus
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/.gitkeep"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- bin/console
+- bin/obfus
+- bin/setup
+- build/obfus
+- lib/obfus.rb
+- lib/obfus/main.rb
+- lib/obfus/version.rb
+- license.txt
+- obfus.gemspec
+- readme.md
+homepage: https://github.com/everdrone/obfus
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.7
+signing_key: 
+specification_version: 4
+summary: File compression and encryption tool
+test_files: []